{"openapi":"3.0.1","info":{"title":"Omada Open API","description":"Omada Open API","version":"v0.1"},"externalDocs":{"description":"Omada Controller","url":"http://omada.tplink.com"},"servers":[{"url":"http://use1-omada-northbound.tplinkcloud.com","description":"Generated server url"}],"paths":{"/openapi/v2/{omadacId}/sites/{siteId}/setting/iot/devices/config/{id}":{"put":{"tags":["Bluetooth"],"summary":"Modify Bluetooth Advertising v2","description":"Modify Bluetooth Advertising v2. Note:The parameter [transmitPower] is deprecated.","operationId":"modifyBtIbeaconConfigV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Bluetooth Advertising entry ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigIotBtIbeaconV2OpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":22},"delete":{"tags":["Bluetooth"],"summary":"Delete Bluetooth Advertising v2","description":"Delete Bluetooth Advertising v2.","operationId":"deleteBtIbeaconConfigV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Bluetooth Advertising entry ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":21}},"/openapi/v2/{omadacId}/sites/{siteId}/aps/{apMac}/vlan":{"get":{"tags":["Ap"],"summary":"Get AP vlan config v2","description":"Get AP vlan config v2","operationId":"getApVlanConfigV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApVlanConfigV2OpenApiVO"}}}}},"x-order":65},"put":{"tags":["Ap"],"summary":"Modify AP vlan config","description":"Modify AP vlan config","operationId":"ModifyApVlanConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApVlanOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApVlanConfigV2OpenApiVO"}}}}},"x-order":64}},"/openapi/v2/{omadacId}/sites/{siteId}/aps/vlan":{"put":{"tags":["Ap"],"summary":"Batch modify AP vlan config","description":"Batch modify AP vlan config","operationId":"batchModifyApVlanConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchUpdateApVlanOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":63}},"/openapi/v1/{omadacId}/users/{userID}":{"get":{"tags":["User and Role"],"summary":"Get user info","description":"Get user info. This interface only supports the authorization code mode, not the client mode. Please call this interface in authorization code mode.","operationId":"getUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"User ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUserDetailVO"}}}}},"x-order":2},"put":{"tags":["User and Role"],"summary":"Modify an existing user","description":"Modify an existing user.","operationId":"modifyUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"User ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyUserVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":4},"delete":{"tags":["User and Role"],"summary":"Delete an existing user","description":"Delete an existing user. This interface only supports the authorization code mode, not the client mode. Please call this interface in authorization code mode.","operationId":"deleteUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"User ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUserVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sso/saml-idps/{idpId}":{"put":{"tags":["SSO"],"summary":"Modify an existing idp","description":"Modify an existing idp.","operationId":"modifyIdpMetadata","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"idpId","in":"path","description":"IdP id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdpMetadataOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3},"delete":{"tags":["SSO"],"summary":"Delete an existing idp","description":"Delete an existing idp.","operationId":"deleteIdpMetadata","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"idpId","in":"path","description":"IdP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sso/external-user-groups/{externalUserGroupId}":{"put":{"tags":["SSO"],"summary":"Modify an existing external user group","description":"Modify an existing external user group.","operationId":"modifyExternalUserGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"externalUserGroupId","in":"path","description":"External user group ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalUserGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7},"delete":{"tags":["SSO"],"summary":"Delete an existing external user group","description":"Delete an existing external user group.","operationId":"deleteExternalUserGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"externalUserGroupId","in":"path","description":"External user group ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}":{"get":{"tags":["Site Template"],"summary":"Get site template info","description":"Get site template info","operationId":"getSiteTemplateEntity","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteTemplateBriefOpenApiVO"}}}}},"x-order":6},"put":{"tags":["Site Template"],"summary":"Modify an existing site template","description":"Modify an existing site template","operationId":"updateSiteTemplateEntity","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSiteByTemplate"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8},"delete":{"tags":["Site Template"],"summary":"Delete an existing site template","description":"Delete an existing site template","operationId":"deleteSiteTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wired-networks/disable-nat/{disableNatId}":{"put":{"tags":["NAT (Template)"],"summary":"Modify an existing Disable Nat in siteTemplate","description":"Modify an existing Disable Nat in siteTemplate.","operationId":"modifyDisableNatTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"disableNatId","in":"path","description":"Disable Nat ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disable Nat"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10},"delete":{"tags":["NAT (Template)"],"summary":"Delete an existing Disable Nat in siteTemplate","description":"Delete an existing Disable Nat in siteTemplate.","operationId":"deleteDisableNat","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"disableNatId","in":"path","description":"Disable Nat ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/upnp":{"get":{"tags":["UPnP (Template)"],"summary":"Get UPnP template setting","description":"Get UPnP template setting","operationId":"getUpnpSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUpnpSettingOpenApiVO"}}}}},"x-order":17},"put":{"tags":["UPnP (Template)"],"summary":"Modify UPnP template setting","description":"Modify UPnP template setting","operationId":"updateUpnpSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpnpSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/time-range-profile/{profileId}":{"put":{"tags":["Profiles (Template)"],"summary":"Modify time range profile template","description":"Modify time range profile template","operationId":"modifyTimeRangeProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTimeRangeProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":28},"delete":{"tags":["Profiles (Template)"],"summary":"Delete time range profile template","description":"Delete time range profile template","operationId":"deleteTimeRangeProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":29}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/vrfs/{vrfId}":{"put":{"tags":["Switch (Template)"],"summary":"Modify vrf template","description":"Modify vrf template. This interface has been deprecated.","operationId":"modifyOswVrfTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswVrfConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":28},"delete":{"tags":["Switch (Template)"],"summary":"Delete vrf template","description":"Delete vrf template. This interface has been deprecated.","operationId":"deleteOswVrfTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":29}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/ports/{port}/status":{"put":{"tags":["Switch (Template)"],"summary":"Set port status for given switch template port","description":"Set port status for given switch template port. ","operationId":"setPortModeForGivenPort","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}},{"name":"port","in":"path","description":"Port","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchPortStatus"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/ports/{port}/profile":{"put":{"tags":["Switch (Template)"],"summary":"Set profile for given switch template port","description":"Set profile for given switch template port.","operationId":"setProfileForGivenPort","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}},{"name":"port","in":"path","description":"Port ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchProfileID"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/ports/{port}/profile-override":{"put":{"tags":["Switch (Template)"],"summary":"Set profile-override for given switch template port","description":"Set profile-override for given switch template port.","operationId":"setProfileOverrideForGivenPort","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}},{"name":"port","in":"path","description":"Port ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileOverride"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/ports/{port}/poe-mode":{"put":{"tags":["Switch (Template)"],"summary":"Set poe mode for given switch template port","description":"Set poe mode for given switch template port. Please enable profile override first to use this interface.","operationId":"setPoeModeForGivenPort","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}},{"name":"port","in":"path","description":"Port","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchPortPoe"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/ports/{port}/name":{"put":{"tags":["Switch (Template)"],"summary":"Set name for given switch template port","description":"Set name for given switch template port.","operationId":"setNameForGivenPort","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}},{"name":"port","in":"path","description":"Port ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchPortName"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/multi-ports/status":{"put":{"tags":["Switch (Template)"],"summary":"Batch set status for given switch template ports","description":"Batch set status for given switch template ports. ","operationId":"batchSetPortStatusForGivenPorts","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchPortsStatus"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/multi-ports/profile-override":{"put":{"tags":["Switch (Template)"],"summary":"Batch set profile-override for given switch template ports","description":"Batch set profile-override for given switch template ports.","operationId":"batchSetProfileOverrideForGivenPorts","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchProfileOverride"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/multi-ports/poe-mode":{"put":{"tags":["Switch (Template)"],"summary":"Batch set poe mode for given switch template ports","description":"Batch set poe mode for given switch template ports. Please enable profile override first to use this interface.","operationId":"batchSetPoeModeForGivenPorts","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchPortsPoe"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/multi-ports/name":{"put":{"tags":["Switch (Template)"],"summary":"Batch set name for given switch template ports","description":"Batch set name for given switch template ports.","operationId":"batchSetNameForGivenPorts","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortNameList"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switch-oui-rules/{ouiBasedVlanId}":{"put":{"tags":["OUI Based VLAN (Template)"],"summary":"Modify Switch oui based vlan template","description":"Modify Switch oui based vlan template.","operationId":"modifySwitchOuiBasedVlanTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ouiBasedVlanId","in":"path","description":"Oui Based Vlan ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OuiBasedVlanTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3},"delete":{"tags":["OUI Based VLAN (Template)"],"summary":"Delete Switch oui based vlan template","description":"Delete Switch oui based vlan template.","operationId":"deleteSwitchOuiBasedVlanTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ouiBasedVlanId","in":"path","description":"Oui Based Vlan ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/ssh":{"get":{"tags":["SSH (Template)"],"summary":"Get SSH template setting","description":"Get SSH template setting","operationId":"getSshSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSSHSetting"}}}}},"x-order":19},"put":{"tags":["SSH (Template)"],"summary":"Modify SSH template setting","description":"Modify SSH template setting","operationId":"updateSshSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SSHSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/service/port-schedules/{type}/{portScheduleId}":{"put":{"tags":["Schedule (Template)"],"summary":"Modify a Port Schedule Template","description":"Modify a Port Schedule Template with the given params.","operationId":"modifyPortScheduleTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","description":"Port Schedule Type. 0: POE schedule; 1: Enable Schedule.","required":true,"schema":{"type":"string"}},{"name":"portScheduleId","in":"path","description":"Port Schedule Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortOrPoeScheduleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":36},"delete":{"tags":["Schedule (Template)"],"summary":"Delete Port Schedule Template","description":"Delete Port Schedule Template with the given params.","operationId":"removePortScheduleTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","description":"Port Schedule Type. 0: POE schedule; 1: Enable Schedule.","required":true,"schema":{"type":"string"}},{"name":"portScheduleId","in":"path","description":"Port Schedule Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":37}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/service/iptv":{"get":{"tags":["IPTV (Template)"],"summary":"Get IPTV setting template","description":"Get IPTV setting template of the site with the given omadacId and siteTemplateId.","operationId":"getIptvTemplateServerSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseIptvSettingOpenApiVO"}}}}},"x-order":21},"put":{"tags":["IPTV (Template)"],"summary":"Modify IPTV setting template","description":"Modify IPTV setting template with the given omadacId and siteTemplateId. There should be a gateway template model preconfigured, or else you cannot modify IPTV template setting.","operationId":"modifyIptvTemplateServerSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IptvSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/service/iptv/iptv":{"get":{"tags":["IPTV (Template)"],"summary":"Get IPTV template setting","description":"Get IPTV template setting of the site with the given omadacId and siteId.","operationId":"getIptvTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseIptvOpenApiVO"}}}}},"x-order":25},"put":{"tags":["IPTV (Template)"],"summary":"Modify IPTV template setting","description":"Modify IPTV template setting info of the site with the given params.","operationId":"modifyIptvTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IptvConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":26}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/service/iptv/igmp":{"get":{"tags":["Service (Template)"],"summary":"Get IGMP template setting","description":"Get IGMP template setting of the site with the given omadacId and siteId.","operationId":"getIgmpTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseIgmpTemplateOpenApiVO"}}}}},"x-order":23},"put":{"tags":["Service (Template)"],"summary":"Modify IGMP template setting","description":"Modify IGMP template setting info of the site with the given params.","operationId":"modifyIgmpTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IgmpTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/service/dns-cache":{"put":{"tags":["DNS (Template)"],"summary":"Modify DNS cache setting","description":"Modify DNS cache setting","operationId":"modifyDnsCacheSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DnsCacheOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/iot/servers/{id}":{"put":{"tags":["Bluetooth(Template)"],"summary":"Modify IoT Transport Stream(Template)","description":"Modify IoT Transport Stream setting in site template.","operationId":"modifyIotServerTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"IoT Transport Stream template entry ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigIotServerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3},"delete":{"tags":["Bluetooth(Template)"],"summary":"Delete IoT Transport Stream(Template)","description":"Delete IoT Transport Stream setting in site template.","operationId":"deleteIotServerTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"IoT Transport Stream template entry ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/iot/aging-time":{"get":{"tags":["Bluetooth(Template)"],"summary":"Get Aging Time(Template)","description":"Get Aging Time setting in site template.","operationId":"getIotBlueToothAgingTimeTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/IotAgingTimeOpenApiVO"}}}}},"x-order":6},"put":{"tags":["Bluetooth(Template)"],"summary":"Modify Aging Time(Template)","description":"Modify Aging Time setting in site template.","operationId":"modifyIotBlueToothAgingTimeTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IotAgingTimeOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/rrm/config":{"get":{"tags":["Rrm"],"summary":"Get Rrm template setting","description":"Get RRM template setting","operationId":"getRrmSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseRrmSettingOpenApiVO"}}}}},"x-order":4},"put":{"tags":["Rrm"],"summary":"Modify Rrm template setting","description":"Modify Rrm template setting","operationId":"modifyRrmSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RrmSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/routing/static-routings/{staticRoutingId}":{"put":{"tags":["Routing (Template)"],"summary":"Modify site template's static routing","description":"Modify site template's static routing.","operationId":"modifyTemplateStaticRouting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"staticRoutingId","in":"path","description":"Static routing ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticRoutingConfigTemplate"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3},"delete":{"tags":["Routing (Template)"],"summary":"Delete site template's static routing","description":"Delete site template's static routing.","operationId":"deleteTemplateStaticRouting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"staticRoutingId","in":"path","description":"Static routing ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/routing/policy-routings/{policyRoutingId}":{"put":{"tags":["Routing (Template)"],"summary":"Modify site template's policy routing","description":"Modify site template's policy routing.","operationId":"modifyTemplatePolicyRouting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"policyRoutingId","in":"path","description":"Policy routing ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyRoutingConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7},"delete":{"tags":["Routing (Template)"],"summary":"Delete site template's policy routing","description":"Delete site template's policy routing.","operationId":"deleteTemplatePolicyRouting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"policyRoutingId","in":"path","description":"Policy routing ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/rfPlanning/config":{"get":{"tags":["WLAN Optimization"],"summary":"get Radio Frequency Planning Config Template","description":"get Radio Frequency Planning Config Template","operationId":"getRadioFrequencyPlanningConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePlanning History Detail"}}}}},"x-order":13},"put":{"tags":["WLAN Optimization"],"summary":"modify RF Planning Deploy Config Template","description":"modify RF Planning Deploy Config Template","operationId":"modifyRFPlanningDeployConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RF Planning Deploy Config"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/reboot-schedules/{id}":{"put":{"tags":["Schedule (Template)"],"summary":"Modify reboot schedule template","description":"Modify reboot schedule template","operationId":"modifyRebootSchedule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Reboot Schedule Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RebootScheduleTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3},"delete":{"tags":["Schedule (Template)"],"summary":"Delete reboot schedule template","description":"Delete reboot schedule template","operationId":"deleteRebootSchedule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Reboot Schedule Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/rate-limit-profile/{profileId}":{"put":{"tags":["Profiles (Template)"],"summary":"Modify rate limit profile template","description":"Modify rate limit profile template","operationId":"modifyRateLimitProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRateLimitProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":32},"delete":{"tags":["Profiles (Template)"],"summary":"Delete rate limit profile template","description":"Delete rate limit profile template","operationId":"deleteRateLimitProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":33}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/qos/gateway/voip-prioritization":{"get":{"tags":["Gateway QOS (Template)"],"summary":"Get siteTemplate's VoIP Prioritization info","description":"Get siteTemplate's VoIP Prioritization info.","operationId":"getTemplateVoip","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVoipOpenApiVO"}}}}},"x-order":10},"put":{"tags":["Gateway QOS (Template)"],"summary":"Modify siteTemplate's VoIP Prioritization info","description":"Modify siteTemplate's VoIP Prioritization info.","operationId":"modifyTemplateVoip","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoipOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/qos/gateway/tag-outbound-traffic":{"get":{"tags":["Gateway QOS (Template)"],"summary":"Get siteTemplate's Tag Outbound Traffic info","description":"Get siteTemplate's Tag Outbound Traffic info.","operationId":"getTemplateTagOut","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTagOutConfigOpenApiVO"}}}}},"x-order":12},"put":{"tags":["Gateway QOS (Template)"],"summary":"Modify siteTemplate's Tag Outbound Traffic info","description":"Modify siteTemplate's Tag Outbound Traffic info.","operationId":"modifyTemplateTagOut","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagOutConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/qos/gateway/class-rules/{id}":{"put":{"tags":["Gateway QOS (Template)"],"summary":"Modify an existing class rule in siteTemplate","description":"Modify an existing class rule in siteTemplate.","operationId":"modifyTemplateClassRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Class rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassRuleTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8},"delete":{"tags":["Gateway QOS (Template)"],"summary":"Delete an existing class rule in siteTemplate","description":"Delete an existing class rule in siteTemplate.","operationId":"deleteTemplateClassRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Class rule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/qos/gateway/bwcs/{id}":{"put":{"tags":["Gateway QOS (Template)"],"summary":"Modify an existing bandwidth control rule in siteTemplate","description":"Modify an existing bandwidth control rule in siteTemplate.","operationId":"modifyTemplateBwCtrl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Bandwidth control rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QosBwcEditOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"delete":{"tags":["Gateway QOS (Template)"],"summary":"Delete an existing bandwidth control rule in siteTemplate","description":"Delete an existing bandwidth control rule in siteTemplate.","operationId":"deleteTemplateBwCtrl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Bandwidth control rule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/profiles/service-type/{id}":{"put":{"tags":["Profiles (Template)"],"summary":"Modify an existing Gateway QoS Service in siteTemplate","description":"Modify an existing Gateway QoS Service in siteTemplate.","operationId":"modifyTemplateServiceType","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Gateway QoS Service ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayQosServiceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":93},"delete":{"tags":["Profiles (Template)"],"summary":"Delete an existing Gateway QoS Service in siteTemplate","description":"Delete an existing Gateway QoS Service in siteTemplate.","operationId":"deleteTemplateServiceType","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Gateway QoS Service ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":94}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/profiles/bonjour-service/{id}":{"put":{"tags":["Profiles (Template)"],"summary":"Modify an existing Bonjour Service Template","description":"Modify an existing Bonjour Service Template.","operationId":"modifyMdnsProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Bonjour Service Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BonjourServiceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":86},"delete":{"tags":["Profiles (Template)"],"summary":"Delete an existing Bonjour Service Template","description":"Delete an existing Bonjour Service Template.","operationId":"deleteMdnsProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Bonjour Service Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":87}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/profiles/apn/{profileId}":{"put":{"tags":["Profiles (Template)"],"summary":"Modify an exist APN profile template","description":"Modify an exist APN profile template with the given params.","operationId":"modifyApnProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"APN profile ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApnProfileConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":40},"delete":{"tags":["Profiles (Template)"],"summary":"Delete an exist APN profile template","description":"Delete an exist APN profile template with the given params.","operationId":"deleteApnProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"APN profile ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":41}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/oui-profiles/{ouiId}":{"put":{"tags":["Profiles (Template)"],"summary":"Modify OUI Profile template","description":"Modify OUI Profile template","operationId":"modifyOuiProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ouiId","in":"path","description":"OUI ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OuiProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9},"delete":{"tags":["Profiles (Template)"],"summary":"Delete OUI Profile template","description":"Delete OUI Profile template","operationId":"deleteOuiProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ouiId","in":"path","description":"OUI ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/networks/{networkId}/confirm":{"put":{"tags":["Wired Network (Template)"],"summary":"Confirm modify lan network template","description":"Confirm modify lan network template.","operationId":"confirmModifyVlanNetworkTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyVlanParamOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVlanNetworkIdListVO"}}}}},"x-order":55}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/network-security/wireless-ips":{"get":{"tags":["Wireless IDS/IPS (Template)"],"summary":"Get wireless IPS config template","description":"Get wireless IPS config template","operationId":"getWipsConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWipsConfigOpenApiVO"}}}}},"x-order":3},"put":{"tags":["Wireless IDS/IPS (Template)"],"summary":"Modify wireless IPS config template","description":"Modify wireless IPS config template","operationId":"modifyWipsConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWipsConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/network-security/wireless-ids":{"get":{"tags":["Wireless IDS/IPS (Template)"],"summary":"Get wireless IDS config template","description":"Get wireless IDS config template","operationId":"getWidsConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWidsConfigOpenApiVO"}}}}},"x-order":1},"put":{"tags":["Wireless IDS/IPS (Template)"],"summary":"Modify wireless IDS config template","description":"Modify wireless IDS config template","operationId":"modifyWidsConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWidsConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/nat/port-forwardings/{portForwardingId}":{"put":{"tags":["NAT (Template)"],"summary":"Modify site template's port forwarding","description":"Modify site template's port forwarding.","operationId":"modifyTemplatePortForwarding","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"portForwardingId","in":"path","description":"Port forwarding ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortForwardingTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3},"delete":{"tags":["NAT (Template)"],"summary":"Delete site template's port forwarding","description":"Delete site template's port forwarding.","operationId":"deleteTemplatePortForwarding","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"portForwardingId","in":"path","description":"Port forwarding ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/nat/alg":{"get":{"tags":["NAT (Template)"],"summary":"Get site template's ALG Info","description":"Get site template's ALG Info.","operationId":"getTemplateAlg","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGetAlgOpenApiVO"}}}}},"x-order":5},"put":{"tags":["NAT (Template)"],"summary":"Modify site template's ALG setting","description":"Modify site template's ALG setting.","operationId":"modifyTemplateAlg","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ALGSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/led":{"get":{"tags":["Site Template Configuration"],"summary":"Get site template led setting","description":"Get site template led setting","operationId":"getSiteTemplateLedSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteLedSetting"}}}}},"x-order":1},"put":{"tags":["Site Template Configuration"],"summary":"Modify site template led setting","description":"Modify site template led setting","operationId":"updateSiteTemplateLedSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteLedSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/lag-hash-alg":{"get":{"tags":["Site Template Configuration"],"summary":"Get site template lag hash alg setting","description":"Get site template lag hash alg setting","operationId":"getSiteTemplateLagHashAlgSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteLagHashAlgOpenApiVO"}}}}},"x-order":26},"put":{"tags":["Site Template Configuration"],"summary":"Modify site template lag hash alg setting","description":"Modify site template lag hash alg setting","operationId":"updateSiteTemplateLagHashAlgSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteLagHashAlgOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":27}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/jumbo":{"get":{"tags":["Site Template Configuration"],"summary":"Get site template jumbo setting","description":"Get site template jumbo setting","operationId":"getSiteTemplateJumboSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteJumboOpenApiVO"}}}}},"x-order":28},"put":{"tags":["Site Template Configuration"],"summary":"Modify site template jumbo setting","description":"Modify site template jumbo setting","operationId":"updateSiteTemplateJumboSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteJumboOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":29}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/internet/load-balance":{"get":{"tags":["Wired Network (Template)"],"summary":"Get site template internet load balance config","description":"Get site template internet load balance config.","operationId":"getInternetLoadBalance","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWanLoadBalanceOpenApiVO"}}}}},"x-order":15},"put":{"tags":["Wired Network (Template)"],"summary":"Modify site template internet load balance config","description":"Modify site template internet load balance config.","operationId":"modifyInternetLoadBalance","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WanLoadBalanceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/internet/basic-info":{"get":{"tags":["Wired Network (Template)"],"summary":"Get site template internet basic info","description":"Get site template basic info. All port and port-related configuration will take effect only the The parameter [preConfiguration] is true.","operationId":"getInternetBasicPortInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseInternetBaseInfoTemplateOpenApiVO"}}}}},"x-order":13},"put":{"tags":["Wired Network (Template)"],"summary":"Modify site template internet basic configuration","description":"Modify site template internet basic configuration.","operationId":"modifyInternetBasicPortInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternetBaseConfigTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/config/wlans":{"put":{"tags":["Gateway (Template)"],"summary":"Modify gateway template wlans config","description":"Modify gateway template wlans config","operationId":"modifyConfigWlansTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsgConfigWlansOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/config/services":{"put":{"tags":["Gateway (Template)"],"summary":"Modify gateway template services config","description":"Modify gateway template services config","operationId":"modifyConfigServicesTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsgConfigServicesOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/config/radios":{"put":{"tags":["Gateway (Template)"],"summary":"Modify gateway template radios config","description":"Modify gateway template radios config","operationId":"modifyConfigRadiosTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsgConfigRadiosopenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/config/general":{"put":{"tags":["Gateway (Template)"],"summary":"Modify gateway template general config","description":"Modify gateway template general config","operationId":"modifyConfigGeneralTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsgGeneralConfigOpenApiV2VO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/config/advanced":{"put":{"tags":["Gateway (Template)"],"summary":"Modify gateway template advanced config","description":"Modify gateway template advanced config","operationId":"modifyConfigAdvancedTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsgConfigAdvancedOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/config/advanced/wireless":{"put":{"tags":["Gateway (Template)"],"summary":"Modify gateway template wireless advanced config","description":"Modify gateway template wireless advanced config","operationId":"modifyConfigWirelessAdvancedTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsgConfigWirelessAdvancedOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/config/advanced/common":{"put":{"tags":["Gateway (Template)"],"summary":"Modify gateway template common advanced config","description":"Modify gateway template common advanced config","operationId":"modifyConfigCommonAdvancedTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsgConfigCommonAdvancedOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/applicationControl/status":{"get":{"tags":["Application Control"],"summary":"Get application control general settings","description":"Get application control general settings with the given omadacId, siteId.","operationId":"getApplicationControlStatusTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDpiSettings"}}}}},"x-order":18},"put":{"tags":["Application Control"],"summary":"Modify application control general settings","description":"Modify application control general settings.","operationId":"editApplicationControlStatusTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DpiSettings"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/applicationControl/rules/{ruleId}":{"put":{"tags":["Application Control"],"summary":"Modify an existing rule","description":"Modify an existing rule.","operationId":"editRulesTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditRuleEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":30},"delete":{"tags":["Application Control"],"summary":"Delete an existing rule","description":"Delete an existing rule.","operationId":"deleteRulesTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":31}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/applicationControl/restrictions/{restrictionId}":{"put":{"tags":["Application Control"],"summary":"Modify an existing restriction","description":"Modify an existing restriction.","operationId":"editAssignRestrictionsTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"restrictionId","in":"path","description":"Restriction ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":22},"delete":{"tags":["Application Control"],"summary":"Delete an existing restriction","description":"Delete an existing restriction.","operationId":"deleteAssignRestrictionsTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"restrictionId","in":"path","description":"Restriction ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/applicationControl/filters/{filterId}":{"put":{"tags":["Application Control"],"summary":"Modify an existing filter","description":"Modify an existing filter.","operationId":"editFiltersTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"filterId","in":"path","description":"Filter ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditFilterEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":26},"delete":{"tags":["Application Control"],"summary":"Delete an existing filter","description":"Delete an existing filter.","operationId":"deleteFiltersTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"filterId","in":"path","description":"Filter ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":27}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/ap-oui-rules/{ouiBasedVlanId}":{"put":{"tags":["OUI Based VLAN (Template)"],"summary":"Modify Ap oui based vlan template","description":"Modify Ap oui based vlan template.","operationId":"modifyApOuiBasedVlanTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ouiBasedVlanId","in":"path","description":"The id of oui profile.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OuiBasedVlanApOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7},"delete":{"tags":["OUI Based VLAN (Template)"],"summary":"Delete Ap oui based vlan template","description":"Delete Ap oui based vlan template.","operationId":"deleteApOuiBasedVlanTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ouiBasedVlanId","in":"path","description":"The id of oui profile.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/acls/osg-config-mode":{"get":{"tags":["ACL (Template)"],"summary":"Get gateway ACL config mode template","description":"Get gateway ACL config mode template","operationId":"getAclConfigTypeSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGateway ACL Config Mode Entity"}}}}},"x-order":11},"put":{"tags":["ACL (Template)"],"summary":"Modify gateway ACL config template mode","description":"Modify gateway ACL config template mode","operationId":"modifyAclConfigTypeSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Gateway ACL config mode entity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/acls/osg-acls/{aclId}":{"put":{"tags":["ACL (Template)"],"summary":"Modify a gateway template ACL","description":"Modify a gateway template ACL.","operationId":"modifyOsgAclTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"aclId","in":"path","description":"ACL ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayACLConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/acls/eap-acls/{aclId}":{"put":{"tags":["ACL (Template)"],"summary":"Modify an EAP template ACL","description":"Modify an EAP template ACL.","operationId":"modifyEapAclTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"aclId","in":"path","description":"ACL ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EapACLConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}":{"get":{"tags":["Site"],"summary":"Get site info","description":"Get site info","operationId":"getSiteEntity","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteEntity"}}}}},"x-order":2},"put":{"tags":["Site"],"summary":"Modify an existing site","description":"Modify an existing site","operationId":"updateSiteEntity","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSiteEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7},"delete":{"tags":["Site"],"summary":"Delete an existing site","description":"Delete an existing site","operationId":"deleteSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/wired-networks/disable-nat/{disableNatId}":{"put":{"tags":["Disable Nat"],"summary":"Modify Disable Nat","description":"Modify Disable Nat.","operationId":"modifyDisableNat","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"disableNatId","in":"path","description":"Disable Nat ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disable Nat"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2},"delete":{"tags":["Disable Nat"],"summary":"Delete Disable Nat","description":"Delete Disable Nat.","operationId":"deleteDisableNat_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"disableNatId","in":"path","description":"Disable Nat ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/wireguards/{id}":{"put":{"tags":["Wireguard VPN"],"summary":"Modify an existing wireguard","description":"Modify an existing wireguard. This interface has been deprecated. Please use the following interfaces instead: Modify site-to-site VPN by manual.","operationId":"modifyWireguard","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Wireguard ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WireguardOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":4},"delete":{"tags":["Wireguard VPN"],"summary":"Delete an existing wireguard","description":"Delete an existing wireguard. This interface has been deprecated. Please use the following interfaces instead: Delete VPN V2.","operationId":"deleteWireguard","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"WireGuard VPN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/wireguard-peers/{id}":{"put":{"tags":["Wireguard VPN"],"summary":"Modify an existing wireguard peer","description":"Modify an existing wireguard peer. This interface has been deprecated. Please use the following interfaces instead: Modify site-to-site VPN by manual.","operationId":"modifyPeer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Peer ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WireguardPeerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":9},"delete":{"tags":["Wireguard VPN"],"summary":"Delete an existing wireguard peer","description":"Delete an existing wireguard peer. This interface has been deprecated. Please use the following interfaces instead: Modify site-to-site VPN by manual.","operationId":"deletePeer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Peer ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ssl-vpn-server/users/{id}":{"put":{"tags":["SSL VPN"],"summary":"Modify SSL VPN user","description":"Modify SSL VPN user. This interface has been deprecated. Please use the following interfaces instead: Modify VPN user V3.","operationId":"modifySslVpnUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"User ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SslVpnUserModifyOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":17},"delete":{"tags":["SSL VPN"],"summary":"Delete SSL VPN user","description":"Delete SSL VPN user. This interface has been deprecated. Please use the following interfaces instead: Delete VPN user.","operationId":"deleteSslVpnUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"User ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ssl-vpn-server/user-groups/{id}":{"put":{"tags":["SSL VPN"],"summary":"Modify SSL VPN user group","description":"Modify SSL VPN user group.","operationId":"modifySslVpnUserGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"User group ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SslVpnUserGroupModifyOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":13},"delete":{"tags":["SSL VPN"],"summary":"Delete SSL VPN user group","description":"Delete SSL VPN user group.","operationId":"deleteSslVpnUserGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"User group ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ssl-vpn-server/setting":{"get":{"tags":["SSL VPN"],"summary":"Get SSL VPN server setting","description":"Get SSL VPN server setting.This interface has been deprecated. Please use the following interfaces instead: Get VPN Server summary list and Get client-to-site VPN server detail info.","operationId":"getSslVpnServerSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSslVpnServerSetting"}}}}},"deprecated":true,"x-order":1},"put":{"tags":["SSL VPN"],"summary":"Modify SSL VPN server setting","description":"Get SSL VPN server setting. This interface has been deprecated. Please use the following interfaces instead: Create client-to-site VPN server V2 or Modify client-to-site VPN server V2.","operationId":"modifySslVpnServerSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SslVpnServerConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ssl-vpn-server/resources/{id}":{"put":{"tags":["SSL VPN"],"summary":"Modify SSL VPN resource","description":"Modify SSL VPN tunnel resource.","operationId":"modifySslVpnResource","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Resource ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SslVpnResourceModifyOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5},"delete":{"tags":["SSL VPN"],"summary":"Delete SSL VPN resource","description":"Delete SSL VPN tunnel resource.","operationId":"deleteSslVpnResource","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Resource ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ssl-vpn-server/resource-groups/{id}":{"put":{"tags":["SSL VPN"],"summary":"Modify SSL VPN resource group","description":"Modify SSL VPN tunnel resource group.","operationId":"modifySslVpnResourceGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Resource group ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SslVpnResourceGroupModifyOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9},"delete":{"tags":["SSL VPN"],"summary":"Delete SSL VPN resource group","description":"Delete SSL VPN tunnel resource group.","operationId":"deleteSslVpnResourceGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Resource group ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ssl-vpn-server/locked-users/{id}":{"put":{"tags":["SSL VPN"],"summary":"Modify SSL VPN locked user","description":"Modify SSL VPN locked user.","operationId":"modifyLockedSslVpnUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Locked user ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SslVpnLockModifyOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":21},"delete":{"tags":["SSL VPN"],"summary":"Delete SSL VPN locked user","description":"Delete SSL VPN locked user.","operationId":"deleteLockedSslVpnUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Locked user ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ssl-vpn-server/locked-tunnels/{lockTunnelId}":{"put":{"tags":["SSL VPN"],"summary":"Modify locked SSL VPN tunnel","description":"Modify locked SSL VPN tunnel.","operationId":"modifyLockedSslVpnTunnuel","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"lockTunnelId","in":"path","description":"lock Tunnel Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SslVpnLockCreateAndModifyOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":30},"delete":{"tags":["SSL VPN"],"summary":"Delete SSL VPN locked tunnel","description":"Delete SSL VPN locked tunnel.","operationId":"deleteLockedSslVpnTunnel","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"lockTunnelId","in":"path","description":"Locked tunnel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":32}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/gre-tunnel":{"get":{"tags":["EoGRE Tunnel"],"summary":"Get EoGRE tunnel config","description":"Get EoGRE tunnel config","operationId":"getGreTunnelConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseEoGreTunnelSettingOpenApiVO"}}}}},"x-order":1},"put":{"tags":["EoGRE Tunnel"],"summary":"Modify EoGRE tunnel config","description":"Modify EoGRE tunnel config","operationId":"modifyGreTunnelConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEoGreTunnelSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/upnp":{"get":{"tags":["UPnP"],"summary":"Get UPnP setting","description":"Get UPnP setting","operationId":"getUpnpSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUpnpSettingOpenApiVO"}}}}},"x-order":19},"put":{"tags":["UPnP"],"summary":"Modify UPnP setting","description":"Modify UPnP setting","operationId":"updateUpnpSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpnpSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/upgrade-schedules/{id}":{"put":{"tags":["Schedule"],"summary":"Modify upgrade schedule","description":"Modify upgrade schedule","operationId":"modifyUpgradeSchedule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Upgrade Schedule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpgradeScheduleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":17},"delete":{"tags":["Schedule"],"summary":"Delete upgrade schedule","description":"Delete upgrade schedule","operationId":"deleteUpgradeSchedule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Upgrade Schedule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/time-range-profile/{profileId}":{"put":{"tags":["Profiles"],"summary":"Modify time range profile","description":"Modify time range profile","operationId":"modifyTimeRangeProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTimeRangeProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":28},"delete":{"tags":["Profiles"],"summary":"Delete time range profile","description":"Delete time range profile","operationId":"deleteTimeRangeProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":29}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/vrfs/{vrfId}":{"put":{"tags":["Switch"],"summary":"Modify vrf","description":"Modify vrf.","operationId":"modifyOswVrf","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswVrfConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":63},"delete":{"tags":["Switch"],"summary":"Delete vrf","description":"Delete vrf.","operationId":"deleteOswVrf","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":64}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/staticRoutings/{staticRoutingId}":{"put":{"tags":["Switch"],"summary":"Modify switch staticRouting","description":"Modify switch staticRouting.","operationId":"modifyStaticRouting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"staticRoutingId","in":"path","description":"Static routing ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswStaticRoutingConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":76},"delete":{"tags":["Switch"],"summary":"Delete switch staticRouting","description":"Delete switch staticRouting.","operationId":"deleteStaticRouting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"staticRoutingId","in":"path","description":"Static routing ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":77}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/ports/{port}/status":{"put":{"tags":["Switch"],"summary":"Set port status for given port","description":"Set port status for given port. ","operationId":"setPortModeForGivenPort_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"port","in":"path","description":"Port","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchPortStatus"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/ports/{port}/profile":{"put":{"tags":["Switch"],"summary":"Set profile for given port","description":"Set profile for given port.","operationId":"setProfileForGivenPort_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"port","in":"path","description":"Port ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchProfileID"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/ports/{port}/profile-override":{"put":{"tags":["Switch"],"summary":"Set profile-override for given port","description":"Set profile-override for given port.","operationId":"setProfileOverrideForGivenPort_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"port","in":"path","description":"Port ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfileOverride"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/ports/{port}/poe-mode":{"put":{"tags":["Switch"],"summary":"Set poe mode for given port","description":"Set poe mode for given port. Please enable profile override first to use this interface.","operationId":"setPoeModeForGivenPort_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"port","in":"path","description":"Port","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchPortPoe"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/ports/{port}/name":{"put":{"tags":["Switch"],"summary":"Set name for given port","description":"Set name for given port.","operationId":"setNameForGivenPort_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"port","in":"path","description":"Port ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchPortName"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/multi-ports/status":{"put":{"tags":["Switch"],"summary":"Batch set status for given ports","description":"Batch set status for given ports. ","operationId":"batchSetPortStatusForGivenPorts_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchPortsStatus"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/multi-ports/profile-override":{"put":{"tags":["Switch"],"summary":"Batch set profile-override for given ports","description":"Batch set profile-override for given ports.","operationId":"batchSetProfileOverrideForGivenPorts_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchProfileOverride"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/multi-ports/poe-mode":{"put":{"tags":["Switch"],"summary":"Batch set poe mode for given ports","description":"Batch set poe mode for given ports. Please enable profile override first to use this interface.","operationId":"batchSetPoeModeForGivenPorts_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchPortsPoe"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/multi-ports/name":{"put":{"tags":["Switch"],"summary":"Batch set name for given ports","description":"Batch set name for given ports.","operationId":"batchSetNameForGivenPorts_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortNameList"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/loopback-interface/{loopbackInterfaceId}":{"put":{"tags":["Switch"],"summary":"Modify Loopback Interface","description":"Modify Loopback Interface.","operationId":"modfiyLoopbackInterface","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"loopbackInterfaceId","in":"path","description":"Loopback Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswLoopbackInterfaceVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":69},"delete":{"tags":["Switch"],"summary":"Delete Loopback Interface","description":"Delete Loopback Interface.","operationId":"deleteLoopbackInterface","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"loopbackInterfaceId","in":"path","description":"Loopback Interface ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":70}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/config/loopback":{"put":{"tags":["Switch"],"summary":"Modify switch loopback control","description":"Modify switch loopback control.","operationId":"modifyLoopbackControl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchLoopbackControl"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/es/{switchMac}/config/loopback":{"put":{"tags":["Switch"],"summary":"Modify switch loopback control (Agile Series)","description":"Modify Agile Series switch loopback control.","operationId":"modifyESLoopbackControl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EasyManagedSwitchLoopbackControl"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-rule/{qosRuleId}":{"put":{"tags":["Switch QoS"],"summary":"Modify switch QoS rule.","description":"Modify switch QoS rule.","operationId":"modifyQosRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"qosRuleId","in":"path","description":"qosRuleId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswQosRuleVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswQosRuleResultVO"}}}}},"x-order":3},"delete":{"tags":["Switch QoS"],"summary":"Delete switch QoS rule.","description":"Delete switch QoS rule.","operationId":"deleteQosRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"qosRuleId","in":"path","description":"qosRuleId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswQosRuleResultVO"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-rule/status/{qosRuleId}":{"put":{"tags":["Switch QoS"],"summary":"Modify switch QoS rule's status.","description":"Modify switch QoS rule's status.","operationId":"modifyQosRuleStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"qosRuleId","in":"path","description":"qosRuleId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswQosRuleStatusVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswQosRuleResultVO"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-rule/scheduler-mapping":{"get":{"tags":["Switch QoS"],"summary":"Get switch QoS queue scheduling.","description":"Get switch QoS queue scheduling.","operationId":"getSchedulerMapping","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseQueueSchedulerMappingVO"}}}}},"x-order":7},"put":{"tags":["Switch QoS"],"summary":"Modify switch QoS queue scheduling.","description":"Modify switch QoS queue scheduling.","operationId":"modifySchedulerMapping","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueSchedulerMappingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-rule/dscp-mapping":{"get":{"tags":["Switch QoS"],"summary":"Get switch QoS dscp mapping.","description":"Get switch QoS dscp mapping.","operationId":"getDscpMapping","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDscpMappingVO"}}}}},"x-order":5},"put":{"tags":["Switch QoS"],"summary":"Modify switch QoS dscp mapping.","description":"Modify switch QoS dscp mapping.","operationId":"modifyDscpMapping","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DscpMappingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-mode":{"get":{"tags":["Switch QoS"],"summary":"Get switch QoS mode.","description":"Get switch QoS mode.","operationId":"getOswQosMode","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswQosModeVO"}}}}},"x-order":11},"put":{"tags":["Switch QoS"],"summary":"Modify switch QoS mode.","description":"Modify switch QoS mode.","operationId":"modifyOswQosMode","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswQosModeVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-qos/modify-index":{"put":{"tags":["Switch QoS"],"summary":"Drag and sort the QoS rules.","description":"Drag and sort the QoS rules.","operationId":"modifyRuleIndex","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DragSortIndexVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswQosRuleResultVO"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-oui-rules/{ouiBasedVlanId}":{"put":{"tags":["OUI Based VLAN"],"summary":"Modify Switch oui based vlan","description":"Modify Switch oui based vlan.","operationId":"modifySwitchOuiBasedVlan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ouiBasedVlanId","in":"path","description":"Oui Based Vlan ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OuiBasedVlanSwitchOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"delete":{"tags":["OUI Based VLAN"],"summary":"Delete Switch oui based vlan","description":"Delete Switch oui based vlan.","operationId":"deleteSwitchOuiBasedVlan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ouiBasedVlanId","in":"path","description":"Oui Based Vlan ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/{stackId}":{"get":{"tags":["Stack"],"summary":"Get stack detail","description":"Get stack detail.","operationId":"getOswStackDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswStackDetailVO"}}}}},"x-order":9},"put":{"tags":["Stack"],"summary":"Modify Switch Stack","description":"Modify Switch Stack.","operationId":"modifyOswStack","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswStackConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3},"delete":{"tags":["Stack"],"summary":"Delete Switch Stack","description":"Delete Switch Stack.","operationId":"deleteOswStack","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/{stackId}/vrfs/{vrfId}":{"put":{"tags":["Stack"],"summary":"Modify an existing stack vrf","description":"Modify an existing stack vrf","operationId":"modifyStackVrf","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyOswVrfOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":36},"delete":{"tags":["Stack"],"summary":"Delete an existing stack vrf","description":"Delete an existing stack vrf","operationId":"deleteStackVrf","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"vrfId","in":"path","description":"VRF ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":37}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/{stackId}/staticRoutings/{staticRoutingId}":{"put":{"tags":["Stack"],"summary":"Modify stack staticRouting","description":"Modify stack staticRouting.","operationId":"modifyStackStaticRouting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"staticRoutingId","in":"path","description":"Static routing ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswStaticRoutingConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7},"delete":{"tags":["Stack"],"summary":"Delete stack staticRouting","description":"Delete stack staticRouting.","operationId":"deleteStackStaticRouting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"staticRoutingId","in":"path","description":"Static routing ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/stack/{stackId}/loopback-interface/{loopbackInterfaceId}":{"put":{"tags":["Stack"],"summary":"Modify Stack Loopback Interface","description":"Modify Stack Loopback Interface.","operationId":"modfiyLoopbackInterface_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"loopbackInterfaceId","in":"path","description":"Loopback Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswLoopbackInterfaceVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":41},"delete":{"tags":["Stack"],"summary":"Delete Stack Loopback Interface","description":"Delete Stack Loopback Interface.","operationId":"deleteLoopbackInterface_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"loopbackInterfaceId","in":"path","description":"Loopback Interface ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":42}},"/openapi/v1/{omadacId}/sites/{siteId}/ssh":{"get":{"tags":["SSH"],"summary":"Get SSH setting","description":"Get SSH setting","operationId":"getSshSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSSHSetting"}}}}},"x-order":1},"put":{"tags":["SSH"],"summary":"Modify SSH setting","description":"Modify SSH setting","operationId":"updateSshSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SSHSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/settings/ui-setting":{"put":{"tags":["uisetting"],"summary":"modify site ui setting","description":"modify site ui setting","operationId":"modifySiteUiSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ui setting list request entity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":6},"post":{"tags":["uisetting"],"summary":"get site ui setting","description":"get site ui setting","operationId":"getSiteUiSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ui setting list request entity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/mld":{"get":{"tags":["IPTV"],"summary":"Get the MLD settings","description":"Get the MLD settings of the site with the given Omada ID and Site ID.","operationId":"getMld","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMldOpenApiVO"}}}}},"x-order":5},"put":{"tags":["IPTV"],"summary":"Modify the MLD settings","description":"Modify the MLD settings of the site with the given parameters.","operationId":"modifyMld","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MldOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/iptv":{"get":{"tags":["IPTV"],"summary":"Get IPTV setting","description":"Get IPTV setting of the site with the given omadacId and siteId.","operationId":"getIptv","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseIptvOpenApiVO"}}}}},"x-order":1},"put":{"tags":["IPTV"],"summary":"Modify IPTV setting","description":"Modify IPTV setting info of the site with the given params.","operationId":"modifyIptv","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IptvConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/igmp":{"get":{"tags":["IPTV"],"summary":"Get the IGMP settings","description":"Get the IGMP settings of the site with the given Omada ID and Site ID.","operationId":"getIgmp","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseIgmpOpenApiVO"}}}}},"x-order":3},"put":{"tags":["IPTV"],"summary":"Modify the IGMP settings","description":"Modify the IGMP settings of the site with the given parameters.","operationId":"modifyIgmp","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IgmpOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/dns-cache":{"get":{"tags":["DNS"],"summary":"Get DNS cache","description":"Get DNS cache setting of the site with the given omadacId and siteId.","operationId":"getDnsCacheSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDnsCacheOpenApiVO"}}}}},"x-order":10},"put":{"tags":["DNS"],"summary":"Modify DNS cache setting","description":"Modify DNS cache setting","operationId":"modifyDnsCacheSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DnsCacheOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/iot/servers/{id}":{"put":{"tags":["Bluetooth"],"summary":"Modify IoT Transport Steam","description":"Modify IoT Transport Steam.","operationId":"modifyIotServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"IoT Transport Stream entry ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigIotServerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3},"delete":{"tags":["Bluetooth"],"summary":"Delete IoT Transport Stream","description":"Delete IoT Transport Stream setting.","operationId":"deleteIotServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"IoT Transport Stream entry ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/iot/radio/transmit-power":{"get":{"tags":["Bluetooth"],"summary":"Get IoT devices with transmit power","description":"Get the list of Iot devices with transmit power information.","operationId":"getIotDeviceTransmitPowerInfoList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field Device Name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GridVOIotDeviceRadioInfoOpenApiVO"}}}}},"x-order":17},"put":{"tags":["Bluetooth"],"summary":"Batch Modify transmit power of IoT devices.","description":"Batch Modify transmit power of IoT devices.","operationId":"batchModifyIotDeviceTransmitPower","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchConfigIotTransmitPowerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/iot/devices/config/{id}":{"put":{"tags":["Bluetooth"],"summary":"Modify Bluetooth Advertising","description":"Modify Bluetooth Advertising. Note:The parameter [transmitPower] is deprecated, all devices with transmit power configured via this v1 interface will have their transmit power configuration set to override on the new radio setting page. If you want to configure Transmit Power in Bluetooth -> Radio Setting, configure Bluetooth Advertising using v2 interface.","operationId":"modifyBtIbeaconConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Bluetooth Advertising entry ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigIotBtIbeaconOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":9},"delete":{"tags":["Bluetooth"],"summary":"Delete Bluetooth Advertising","description":"Delete Bluetooth Advertising. Note:The parameter [transmitPower] is deprecated, all devices with transmit power configured via this v1 interface will have their transmit power configuration set to override on the new radio setting page. If you want to configure Transmit Power in Bluetooth -> Radio Setting, configure Bluetooth Advertising using v2 interface.","operationId":"deleteBtIbeaconConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Bluetooth Advertising entry ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/iot/aging-time":{"get":{"tags":["Bluetooth"],"summary":"Get Aging Time","description":"The system automatically removes a device's registry entry if no data reports are received within a predefined aging period.","operationId":"getIotBlueToothAgingTime","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/IotAgingTimeOpenApiVO"}}}}},"deprecated":true,"x-order":13},"put":{"tags":["Bluetooth"],"summary":"Modify Aging Time","description":"Modify Aging Time. Note: The modification of AgingTime now follows Bluetooth -> Radio Setting, please use the Radio Setting interface to configure AgingTime.","operationId":"modifyIotBlueToothAgingTime","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IotAgingTimeOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/rrm/config":{"get":{"tags":["Rrm"],"summary":"Get Rrm setting","description":"Get RRM setting","operationId":"getRrmSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseRrmSettingOpenApiVO"}}}}},"x-order":1},"put":{"tags":["Rrm"],"summary":"Modify Rrm setting","description":"Modify Rrm setting","operationId":"modifyRrmSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RrmSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/routing/static-routings/{staticRoutingId}":{"put":{"tags":["Routing"],"summary":"Modify static routing","description":"Modify static routing.","operationId":"modifyStaticRouting_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"staticRoutingId","in":"path","description":"Static routing ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticRoutingConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"delete":{"tags":["Routing"],"summary":"Delete static routing","description":"Delete static routing.","operationId":"deleteStaticRouting_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"staticRoutingId","in":"path","description":"Static routing ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/routing/policy-routings/{policyRoutingId}":{"put":{"tags":["Routing"],"summary":"Modify policy routing","description":"Modify policy routing.","operationId":"modifyPolicyRouting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"policyRoutingId","in":"path","description":"Policy routing ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyRoutingConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8},"delete":{"tags":["Routing"],"summary":"Delete policy routing","description":"Delete policy routing.","operationId":"deletePolicyRouting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"policyRoutingId","in":"path","description":"Policy routing ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/rfPlanning/schedule/config":{"put":{"tags":["WLAN Optimization"],"summary":"modify RF Planning Schedule Config","description":"modify RF Planning Schedule Config","operationId":"modifyRFPlanningScheduleConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RFPlanningScheduleConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/rfPlanning/excludeAps":{"get":{"tags":["WLAN Optimization"],"summary":"get ExcludeAps","description":"get ExcludeAps","operationId":"getExcludeAps","parameters":[{"name":"currentPage","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"currentPageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListExcludeApVO"}}}}},"x-order":19},"put":{"tags":["WLAN Optimization"],"summary":"modify Exclude Aps","description":"modify Exclude Aps","operationId":"modifyExcludeAps","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Excluded APs Config"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/rfPlanning/config":{"put":{"tags":["WLAN Optimization"],"summary":"modify RF Planning Deploy Config","description":"modify RF Planning Deploy Config","operationId":"modifyRFPlanningDeployConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RF Planning Deploy Config"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/report/tab":{"put":{"tags":["Report v2"],"summary":"Update tab","description":"Update the tab config","operationId":"updateTabNetworkReport","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportTab"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":4},"post":{"tags":["Report v2"],"summary":"Add new tab ","description":"Add a new tab by user","operationId":"addTabNetworkReport","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportTab"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/report/reorder":{"put":{"tags":["Report v2"],"summary":"Reorder the tab ","description":"Reorder the tab ","operationId":"recordTabNetworkReport","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReportTab"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/reboot-schedules/{id}":{"put":{"tags":["Schedule"],"summary":"Modify reboot schedule","description":"Modify reboot schedule","operationId":"modifyRebootSchedule_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Reboot Schedule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RebootScheduleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":13},"delete":{"tags":["Schedule"],"summary":"Delete reboot schedule","description":"Delete reboot schedule","operationId":"deleteRebootSchedule_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Reboot Schedule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/rate-limit-profile/{profileId}":{"put":{"tags":["Profiles"],"summary":"Modify rate limit profile","description":"Modify rate limit profile","operationId":"modifyRateLimitProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRateLimitProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":32},"delete":{"tags":["Profiles"],"summary":"Delete rate limit profile","description":"Delete rate limit profile","operationId":"deleteRateLimitProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":33}},"/openapi/v1/{omadacId}/sites/{siteId}/qos/gateway/voip-prioritization":{"get":{"tags":["Gateway QoS"],"summary":"Get VoIP Prioritization info","description":"Get VoIP Prioritization info.","operationId":"getVoip","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVoipOpenApiVO"}}}}},"x-order":10},"put":{"tags":["Gateway QoS"],"summary":"Modify VoIP Prioritization info","description":"Modify VoIP Prioritization info.","operationId":"modifyVoip","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoipOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/qos/gateway/tag-outbound-traffic":{"get":{"tags":["Gateway QoS"],"summary":"Get Tag Outbound Traffic info","description":"Get Tag Outbound Traffic info.","operationId":"getTagOut","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTagOutConfigOpenApiVO"}}}}},"x-order":12},"put":{"tags":["Gateway QoS"],"summary":"Modify Tag Outbound Traffic info","description":"Modify Tag Outbound Traffic info.","operationId":"modifyTagOut","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagOutConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/qos/gateway/class-rules/{id}":{"put":{"tags":["Gateway QoS"],"summary":"Modify an existing class rule","description":"Modify an existing class rule.","operationId":"modifyClassRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Class rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassRuleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8},"delete":{"tags":["Gateway QoS"],"summary":"Delete an existing class rule","description":"Delete an existing class rule.","operationId":"deleteClassRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Class rule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/qos/gateway/bwcs/{id}":{"put":{"tags":["Gateway QoS"],"summary":"Modify an existing bandwidth control rule","description":"Modify an existing bandwidth control rule.","operationId":"modifyBwCtrl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Bandwidth control rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QosBwcEditOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"delete":{"tags":["Gateway QoS"],"summary":"Delete an existing bandwidth control rule","description":"Delete an existing bandwidth control rule.","operationId":"deleteBwCtrl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Bandwidth control rule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/service-type/{id}":{"put":{"tags":["Profiles"],"summary":"Modify an existing Gateway QoS Service","description":"Modify an existing Gateway QoS Service.","operationId":"modifyServiceType","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Gateway QoS Service ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayQosServiceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":93},"delete":{"tags":["Profiles"],"summary":"Delete an existing Gateway QoS Service","description":"Delete an existing Gateway QoS Service.","operationId":"deleteServiceType","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Gateway QoS Service ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":94}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/ldap/google/{profileId}":{"put":{"tags":["Profiles"],"summary":"Modify an exist google LDAP profile","description":"Modify an exist google LDAP profile with the given params.","operationId":"modifyGoogleLdapProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"LDAP profile ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["config"],"type":"object","properties":{"config":{"$ref":"#/components/schemas/CreateGoogleLdapProfileOpenApiVO"},"file":{"type":"string","description":"Google LDAP certificate file.","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":44},"delete":{"tags":["Profiles"],"summary":"Delete an exist google LDAP profile","description":"Delete an exist google LDAP profile with the given params.","operationId":"deleteGoogleLdapProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"google LDAP profile ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":45}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/bonjour-service/{id}":{"put":{"tags":["Profiles"],"summary":"Modify an existing Bonjour Service","description":"Modify an existing Bonjour Service.","operationId":"modifyMdnsProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Bonjour Service ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BonjourServiceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":82},"delete":{"tags":["Profiles"],"summary":"Delete an existing Bonjour Service","description":"Delete an existing Bonjour Service.","operationId":"deleteMdnsProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Bonjour Service ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":83}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/apn/{profileId}":{"put":{"tags":["Profiles"],"summary":"Modify an exist APN profile","description":"Modify an exist APN profile with the given params.","operationId":"modifyApnProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"APN profile ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApnProfileConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":40},"delete":{"tags":["Profiles"],"summary":"Delete an exist APN profile","description":"Delete an exist APN profile with the given params.","operationId":"deleteApnProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"APN profile ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":41}},"/openapi/v1/{omadacId}/sites/{siteId}/portal-logout":{"get":{"tags":["Site Configuration"],"summary":"Get portal logout domain setting","description":"Get portal logout domain setting","operationId":"getPortalLogoutDomainSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePortalLogoutConfigOpenApiVO"}}}}},"x-order":28},"put":{"tags":["Site Configuration"],"summary":"Modify portal logout domain setting","description":"Modify portal logout domain setting","operationId":"updatePortalLogoutDomainSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalLogoutConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":29}},"/openapi/v1/{omadacId}/sites/{siteId}/port-schedules/{portScheduleId}":{"put":{"tags":["Schedule"],"summary":"Modify Port Schedule","description":"Modify Port Schedule","operationId":"modifyPortSchedule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"portScheduleId","in":"path","description":"Port Schedule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortScheduleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9},"delete":{"tags":["Schedule"],"summary":"Delete Port Schedule","description":"Delete Port Schedule","operationId":"deletePortSchedule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"portScheduleId","in":"path","description":"Port Schedule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/poe-schedules/{poeScheduleId}":{"put":{"tags":["Schedule"],"summary":"Modify PoE Schedule","description":"Modify Poe Schedule","operationId":"modifyPoeSchedule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"poeScheduleId","in":"path","description":"PoE Schedule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PoeScheduleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"delete":{"tags":["Schedule"],"summary":"Delete PoE Schedule","description":"Delete Poe Schedule","operationId":"deletePoeSchedule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"poeScheduleId","in":"path","description":"PoE Schedule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/oui-profiles/{ouiId}":{"put":{"tags":["Profiles"],"summary":"Modify OUI Profile","description":"Modify OUI Profile","operationId":"modifyOuiProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ouiId","in":"path","description":"OUI ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OuiProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9},"delete":{"tags":["Profiles"],"summary":"Delete OUI Profile","description":"Delete OUI Profile","operationId":"deleteOuiProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ouiId","in":"path","description":"OUI ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/osw-vrrp/{oswVrrpId}":{"put":{"tags":["VRRP"],"summary":"Modify Switch Vrrp","description":"Modify Switch Vrrp.","operationId":"modifyOswVrrp","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"oswVrrpId","in":"path","description":"Osw Vrrp ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswVrrpConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3},"delete":{"tags":["VRRP"],"summary":"Delete Switch Vrrp","description":"Delete Switch Vrrp.","operationId":"deleteOswVrrp","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"oswVrrpId","in":"path","description":"Osw Vrrp ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/ospf/process/{ospfProcessId}":{"put":{"tags":["OSPF"],"summary":"Modify Ospf Process","description":"Modify Ospf Process.","operationId":"modifyOspfProcess","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ospfProcessId","in":"path","description":"Ospf Process ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OspfProcessConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/ospf/interface/{ospfInterfaceId}":{"put":{"tags":["OSPF"],"summary":"Modify Ospf Interface","description":"Modify Ospf Interface.","operationId":"modifyOspfInterface","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ospfInterfaceId","in":"path","description":"Ospf Interface ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OspfInterfaceConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/confirm":{"put":{"tags":["Wired Network"],"summary":"Confirm modify lan network","description":"Confirm modify lan network.","operationId":"confirmModifyVlanNetwork","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyVlanParamOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVlanNetworkIdListVO"}}}}},"x-order":80}},"/openapi/v1/{omadacId}/sites/{siteId}/network-security/wireless-ips":{"get":{"tags":["Wireless IDS/IPS"],"summary":"Get wireless IPS config","description":"Get wireless IPS config. ","operationId":"getWipsConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWipsConfigOpenApiVO"}}}}},"x-order":3},"put":{"tags":["Wireless IDS/IPS"],"summary":"Modify wireless IPS config","description":"Modify wireless IPS config. ","operationId":"modifyWipsConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWipsConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/network-security/wireless-ids":{"get":{"tags":["Wireless IDS/IPS"],"summary":"Get wireless IDS config","description":"Get wireless IDS config. ","operationId":"getWidsConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWidsConfigOpenApiVO"}}}}},"x-order":1},"put":{"tags":["Wireless IDS/IPS"],"summary":"Modify wireless IDS config","description":"Modify wireless IDS config. ","operationId":"modifyWidsConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWidsConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/nat/port-forwardings/{portForwardingId}":{"put":{"tags":["NAT"],"summary":"Modify port forwarding","description":"Modify port forwarding.","operationId":"modifyPortForwarding","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"portForwardingId","in":"path","description":"Port Forwarding ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortForwardingConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3},"delete":{"tags":["NAT"],"summary":"Delete port forwarding","description":"Delete port forwarding.","operationId":"deletePortForwarding","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"portForwardingId","in":"path","description":"Port Forwarding ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/nat/one-to-one-nat/{otonatId}":{"put":{"tags":["NAT"],"summary":"Modify One-to-One NAT","description":"Modify One-to-One NAT.","operationId":"modifyOtoNat","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"otonatId","in":"path","description":"Otonat ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OtoNatOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9},"delete":{"tags":["NAT"],"summary":"Delete One-to-One NAT","description":"Delete One-to-One NAT.","operationId":"deleteOtoNat","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"otonatId","in":"path","description":"Otonat ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/nat/alg":{"get":{"tags":["NAT"],"summary":"Get ALG Info","description":"Get ALG Info.","operationId":"getAlg","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGetAlgOpenApiVO"}}}}},"x-order":5},"put":{"tags":["NAT"],"summary":"Modify ALG setting","description":"Modify ALG setting.","operationId":"modifyAlg","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ALGSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/mlag/{mlagId}":{"put":{"tags":["Mlag"],"summary":"Modify M-LAG group","description":"Modify M-LAG group.","operationId":"modifyMlagGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"mlagId","in":"path","description":"M-LAG ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MlagConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"delete":{"tags":["Mlag"],"summary":"Delete M-LAG group","description":"Delete M-LAG group.","operationId":"deleteMlagGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"mlagId","in":"path","description":"M-LAG ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/led":{"get":{"tags":["Site Configuration"],"summary":"Get site led setting","description":"Get site led setting","operationId":"getSiteLedSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"site_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteLedSetting"}}}}},"x-order":1},"put":{"tags":["Site Configuration"],"summary":"Modify site led setting","description":"Modify site led setting","operationId":"updateSiteLedSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"site_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteLedSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/lag-hash-alg":{"get":{"tags":["Site Configuration"],"summary":"Get site lag hash algorithm setting","description":"Get site lag hash algorithm setting","operationId":"getLagHashAlgSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"site_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteLagHashAlgOpenApiVO"}}}}},"x-order":30},"put":{"tags":["Site Configuration"],"summary":"Modify site lag hash algorithm setting","description":"Modify site lag hash algorithm setting","operationId":"updateSiteLagHashAlgSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"site_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteLagHashAlgOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":31}},"/openapi/v1/{omadacId}/sites/{siteId}/jumbo":{"get":{"tags":["Site Configuration"],"summary":"Get site jumbo setting","description":"Get site jumbo setting","operationId":"getJumboSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"site_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteJumboOpenApiVO"}}}}},"x-order":32},"put":{"tags":["Site Configuration"],"summary":"Modify site jumbo setting","description":"Modify site jumbo setting","operationId":"updateSiteJumboSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"site_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteJumboOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":33}},"/openapi/v1/{omadacId}/sites/{siteId}/internet/ports-config":{"get":{"tags":["Wired Network"],"summary":"Get internet ports config","description":"Get internet ports config.","operationId":"getWanPortsConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWanSettingOpenApiVO"}}}}},"x-order":21},"put":{"tags":["Wired Network"],"summary":"Modify internet ports config","description":"Modify internet ports config. Make sure the parameter[preConfiguration] is true and all wan ports config is include, so the port configuration can take effect after you adopt a gateway.","operationId":"modifyWanPortsConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WanSettingConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/sites/{siteId}/internet/lte/ports-config":{"get":{"tags":["Wired Network"],"summary":"Get internet lte wan ports config","description":"Get internet lte wan  ports config.","operationId":"getLteWanPortsConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLteWanSettingOpenApiVO"}}}}},"x-order":27},"put":{"tags":["Wired Network"],"summary":"Modify internet lte port config","description":"Modify internet port lte config. Make sure the parameter[preConfiguration] is true, so the port configuration can take effect after you adopt a gateway.","operationId":"modifyLteWanPortConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LteWanPortSettingConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":28}},"/openapi/v1/{omadacId}/sites/{siteId}/internet/load-balance":{"get":{"tags":["Wired Network"],"summary":"Get internet load balance config","description":"Get internet load balance config.","operationId":"getInternetLoadBalance_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWanLoadBalanceOpenApiVO"}}}}},"x-order":24},"put":{"tags":["Wired Network"],"summary":"Modify internet load balance config","description":"Modify internet load balance config.","operationId":"modifyInternetLoadBalance_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WanLoadBalanceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sites/{siteId}/internet/basic-info":{"get":{"tags":["Wired Network"],"summary":"Get internet basic info","description":"Get internet basic info. All port and port-related configuration will take effect only the The parameter [preConfiguration] is true.","operationId":"getInternetBasicPortInfo_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseInternetBaseInfoOpenApiVO"}}}}},"x-order":17},"put":{"tags":["Wired Network"],"summary":"Modify the internet basic configuration","description":"Modify the internet basic configuration.","operationId":"modifyInternetBasicPortInfo_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternetBaseConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/insight/wids/blacklist/{mac}":{"put":{"tags":["Insight"],"summary":"Remove the specified Device MAC from the blacklist of the reported device","description":"Remove the specified Device MAC from the blacklist of the reported device","operationId":"removeWipsBlackList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"mac","in":"path","description":"Mac Address","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveBlackListOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/pin":{"get":{"tags":["Gateway"],"summary":"Get PIN setting","description":"Get PIN setting.","operationId":"getPinSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOsgPinDetailOpenApiVO"}}}}},"x-order":19},"put":{"tags":["Gateway"],"summary":"Modify PIN management information of an LTE model","description":"Modify PIN management information of an LTE model.","operationId":"changePinSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsgLtePinOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOsgLtePinLockResultOpenApiVO"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/internet/lte/ports-config":{"put":{"tags":["Wired Network"],"summary":"Modify internet lte port config for ippt","description":"Modify internet port lte config for ippt. Make sure the parameter[preConfiguration] is true, so the port configuration can take effect after you adopt a gateway.","operationId":"modifyIpptLteWanPortConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LteWanPortSettingConfigOpenApiV2VO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":85}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/config/wlans":{"put":{"tags":["Gateway"],"summary":"Modify gateway wlans config","description":"Modify gateway wlans config","operationId":"modifyConfigWlans","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsgConfigWlansOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/config/services":{"put":{"tags":["Gateway"],"summary":"Modify gateway config service","description":"Modify gateway config service","operationId":"modifyConfigServices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsgConfigServicesOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/config/services/ssh":{"put":{"tags":["Gateway"],"summary":"Modify SSH setting by mac","description":"Modify SSH setting by mac","operationId":"modifySshSettingByMac","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SSHSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":30}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/config/radios":{"put":{"tags":["Gateway"],"summary":"Modify gateway radios config","description":"Modify gateway radios config","operationId":"modifyConfigRadios","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsgConfigRadiosopenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/config/general":{"put":{"tags":["Gateway"],"summary":"Modify gateway general config v2","description":"Modify gateway general config v2","operationId":"modifyConfigGeneral","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayGeneralConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/config/advanced":{"put":{"tags":["Gateway"],"summary":"Modify gateway advanced config","description":"Modify gateway advanced config","operationId":"modifyConfigAdvanced","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsgConfigAdvancedOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/config/advanced/wireless":{"put":{"tags":["Gateway"],"summary":"Modify gateway advanced wireless config","description":"Modify gateway advanced wireless config","operationId":"modifyConfigWirelessAdvanced","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsgConfigWirelessAdvancedOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":29}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/config/advanced/common":{"put":{"tags":["Gateway"],"summary":"Modify gateway advanced common config","description":"Modify gateway advanced common config","operationId":"modifyConfigCommonAdvanced","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsgConfigCommonAdvancedOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":28}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/{deviceMac}/replace-device":{"put":{"tags":["Device"],"summary":"Modify replace record","description":"Modify replace record.","operationId":"modifyReplaceRecord","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceReplaceSettingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":49},"post":{"tags":["Device"],"summary":"Create replace record","description":"Create replace record.","operationId":"createReplaceRecord","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceReplaceSettingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":48},"delete":{"tags":["Device"],"summary":"Delete replace record","description":"Delete replace record.","operationId":"deleteReplaceRecord","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":50}},"/openapi/v1/{omadacId}/sites/{siteId}/device-account":{"get":{"tags":["Site"],"summary":"Get site device account setting","description":"Get site device account setting","operationId":"getSiteDeviceAccountSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceAccountSettingOpenApiVO"}}}}},"x-order":12},"put":{"tags":["Site"],"summary":"Update site device account setting","description":"Update site device account settin","operationId":"updateSiteDeviceAccountSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceAccountSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/switches/es/config/loopback":{"put":{"tags":["Switch"],"summary":"Batch modify switch loopback control (Agile Series)","description":"Batch modify Agile Series switch loopback control.","operationId":"batchModifyESLoopbackControl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EasyManagedSwitchBatchLoopbackControl"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/switches/config/loopback":{"put":{"tags":["Switch"],"summary":"Batch modify switch loopback control","description":"Batch modify switch loopback control.","operationId":"batchModifyLoopbackControl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchBatchLoopbackControl"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/aps/config/power-saving":{"put":{"tags":["Ap"],"summary":"Batch Modify ap power saving config","description":"Batch Modify ap power saving config","operationId":"batchModifyPowerSavingConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchUpdateApPowerSavingConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":71}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/aps/config/ant-switch":{"put":{"tags":["Ap"],"summary":"Batch modify AP antSwitch setting","description":"Batch modify AP antSwitch setting","operationId":"batchModifyAntSwitchConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchUpdateApAntSwitchOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":70}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/uplink-config":{"get":{"tags":["Ap"],"summary":"Get AP uplink config","description":"Get AP uplink config","operationId":"getApUplinkConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListApUplinkConfigOpenApiVO"}}}}},"x-order":60},"put":{"tags":["Ap"],"summary":"Modify AP uplink config","description":"Modify AP uplink config","operationId":"modifyApUpLinkConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApUplinkConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApUplinkConfigOpenApiVO"}}}}},"x-order":61}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/power-saving":{"get":{"tags":["Ap"],"summary":"Get AP power saving config","description":"Get AP power saving config","operationId":"getPowerSavingConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApPowerSavingConfigOpenApiVO"}}}}},"x-order":15},"put":{"tags":["Ap"],"summary":"Modify AP power saving config","description":"Modify AP power saving config; If the device does not support this feature, it cannot be modified successfully.","operationId":"modifyPowerSavingConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApPowerSavingConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/management-wlan":{"get":{"tags":["Ap"],"summary":"Get AP management ssid config","description":"Get AP management ssid config","operationId":"getApManagementSsidConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApManagementSsidConfig"}}}}},"x-order":76},"put":{"tags":["Ap"],"summary":"Modify AP management ssid config","description":"Modify AP management ssid config","operationId":"modifyApManagementSsidConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApManagementSsidConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":77}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/lag":{"get":{"tags":["Ap"],"summary":"Get AP lag config","description":"Get AP lag config","operationId":"getApLagConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApTrunkSettingOpenApiVO"}}}}},"x-order":77},"put":{"tags":["Ap"],"summary":"Modify AP lag config","description":"Modify AP lag config","operationId":"modifyApLagConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApTrunkSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":78}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/channel-limit":{"get":{"tags":["Ap"],"summary":"Get AP channel limit config","description":"Get AP channel limit config.","operationId":"getChannelLimitConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseChannelLimitConfigOpenApiVO"}}}}},"x-order":29},"put":{"tags":["Ap"],"summary":"Modify AP channel limit config","description":"Modify AP channel limit config.","operationId":"modifyChannelLimitConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateChannelLimitConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":30}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/channel-config":{"put":{"tags":["Ap"],"summary":"Modify AP channel config","description":"Modify AP channel config","operationId":"modifyApChannelConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApChannelConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/ant-switch":{"get":{"tags":["Ap"],"summary":"Get AP antSwitch setting","description":"Get AP antSwitch setting","operationId":"getAntSwitchConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApAntSwitchConfigOpenApiVO"}}}}},"x-order":68},"put":{"tags":["Ap"],"summary":"Modify AP antSwitch setting","description":"Modify AP antSwitch setting","operationId":"modifyAntSwitchConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApAntSwitchConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":69}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/afc-config":{"get":{"tags":["Ap"],"summary":"Get AP AFC config","description":"Get AP AFC config.","operationId":"getAfcConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAfcConfigOpenApiVO"}}}}},"x-order":31},"put":{"tags":["Ap"],"summary":"Modify AP AFC config","description":"Modify AP AFC config.","operationId":"modifyAfcConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAfcConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":32}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/lag":{"put":{"tags":["Ap"],"summary":"Batch modify AP lag config","description":"Batch modify AP lag config","operationId":"batchModifyApLagConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchUpdateApLagOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApBatchConfigResultVO"}}}}},"x-order":79}},"/openapi/v1/{omadacId}/sites/{siteId}/applicationControl/status":{"get":{"tags":["Application Control"],"summary":"Get application control general settings","description":"Get application control general settings with the given omadacId, siteId.","operationId":"getApplicationControlStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDpiSettings"}}}}},"x-order":1},"put":{"tags":["Application Control"],"summary":"Modify application control general settings","description":"Modify application control general settings.","operationId":"editApplicationControlStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DpiSettings"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/applicationControl/rules/{ruleId}":{"put":{"tags":["Application Control"],"summary":"Modify an existing rule","description":"Modify an existing rule.","operationId":"editRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditRuleEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":13},"delete":{"tags":["Application Control"],"summary":"Delete an existing rule","description":"Delete an existing rule.","operationId":"deleteRules","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","description":"Rule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/applicationControl/restrictions/{restrictionId}":{"put":{"tags":["Application Control"],"summary":"Modify an existing restriction","description":"Modify an existing restriction.","operationId":"editAssignRestrictions","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"restrictionId","in":"path","description":"Restriction ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":5},"delete":{"tags":["Application Control"],"summary":"Delete an existing restriction","description":"Delete an existing restriction.","operationId":"deleteAssignRestrictions","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"restrictionId","in":"path","description":"Restriction ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/applicationControl/filters/{filterId}":{"put":{"tags":["Application Control"],"summary":"Modify an existing filter","description":"Modify an existing filter.","operationId":"editFilters","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filterId","in":"path","description":"Filter ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditFilterEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":9},"delete":{"tags":["Application Control"],"summary":"Delete an existing filter","description":"Delete an existing filter.","operationId":"deleteFilters","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filterId","in":"path","description":"Filter ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/ap-oui-rules/{ouiBasedVlanId}":{"put":{"tags":["OUI Based VLAN"],"summary":"Modify Ap oui based vlan","description":"Modify Ap oui based vlan.","operationId":"modifyApOuiBasedVlan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ouiBasedVlanId","in":"path","description":"Oui Based Vlan ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OuiBasedVlanApOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8},"delete":{"tags":["OUI Based VLAN"],"summary":"Delete Ap oui based vlan","description":"Delete Ap oui based vlan.","operationId":"deleteApOuiBasedVlan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ouiBasedVlanId","in":"path","description":"Oui Based Vlan ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/acls/osw-acls/{aclId}":{"put":{"tags":["ACL"],"summary":"Modify a switch ACL","description":"Modify a switch ACL.","operationId":"modifyOswAcl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"aclId","in":"path","description":"ACL ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchACLConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/acls/osg-config-mode":{"get":{"tags":["ACL"],"summary":"Get gateway ACL config mode","description":"Get gateway ACL config mode","operationId":"getAclConfigTypeSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGateway ACL Config Mode Entity"}}}}},"x-order":14},"put":{"tags":["ACL"],"summary":"Modify gateway ACL config mode","description":"Modify gateway ACL config mode","operationId":"modifyAclConfigTypeSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Gateway ACL config mode entity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/acls/osg-acls/{aclId}":{"put":{"tags":["ACL"],"summary":"Modify a gateway ACL","description":"Modify a gateway ACL.","operationId":"modifyOsgAcl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"aclId","in":"path","description":"ACL ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayACLConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/acls/eap-acls/{aclId}":{"put":{"tags":["ACL"],"summary":"Modify an  EAP ACL","description":"Modify an EAP ACL.","operationId":"modifyEapAcl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"aclId","in":"path","description":"ACL ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EapACLConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/settings/ui-setting":{"put":{"tags":["uisetting"],"summary":"modify global ui setting","description":"modify global ui setting","operationId":"modifyGlobalUiSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ui setting list request entity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":2},"post":{"tags":["uisetting"],"summary":"get global ui setting","description":"get global ui setting","operationId":"getGlobalUiSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ui setting list request entity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sdwan/sdwan-group/{groupId}":{"get":{"tags":["SD-WAN"],"summary":"Get SD-WAN Group.","description":"Get SD-WAN Group.","operationId":"getCurrentSdWanGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"The ID of a SD-WAN Group","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSdWanGroupDetail"}}}}},"x-order":4},"put":{"tags":["SD-WAN"],"summary":"Modify SD-WAN Group.","description":"Modify SD-WAN Group.","operationId":"modifySdWanGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"The ID of a SD-WAN Group","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdWanGroup"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3},"delete":{"tags":["SD-WAN"],"summary":"Delete SD-WAN Group.","description":"Delete SD-WAN Group.","operationId":"deleteSdWanGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"The ID of a SD-WAN Group","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sdwan/sdwan-group/map/{groupId}":{"put":{"tags":["SD-WAN"],"summary":"Modify SD-WAN Group NAT info.","description":"Modify SD-WAN Group NAT info.","operationId":"modifySdWanGroupNetWorkMap","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"The ID of a SD-WAN Group","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdWanNatInfoConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sdwan/sdwan-group/lan/modify":{"put":{"tags":["SD-WAN"],"summary":"Modify selected LanNetwork IP.","description":"Modify selected LanNetwork IP.","operationId":"modifyLanIpRange","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyLanNetworkBrief"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/roles/{roleId}":{"get":{"tags":["User and Role"],"summary":"Get role info","description":"Get role info","operationId":"getRole","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"roleId","in":"path","description":"Role ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseControllerRoleDetailVO"}}}}},"x-order":7},"put":{"tags":["User and Role"],"summary":"Modify an existing role","description":"Modify an existing role. Only user with all permissions modify can use this interface.","operationId":"modifyRole","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"roleId","in":"path","description":"Role ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyControllerRoleVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":9},"delete":{"tags":["User and Role"],"summary":"Delete an existing role","description":"Delete an existing role. Only user with all permissions modify can use this interface","operationId":"deleteRole","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"roleId","in":"path","description":"Role ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/controller/exceed-spec/tip":{"put":{"tags":["APP Controller Settings"],"summary":"Modify exceed-spec tip","description":"Modify exceed-spec tip. No further exceed-spec prompts after the user acknowledges and confirms.","operationId":"modifyExceedSpecTip","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/msp/{mspId}/users/{userID}":{"get":{"tags":["MSP User and Role"],"summary":"Get msp user info","description":"Get msp user info. This interface only supports the authorization code mode, not the client mode. Please call this interface in authorization code mode.","operationId":"getUser_1","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"User ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMspUserDetailVO"}}}}},"x-order":2},"put":{"tags":["MSP User and Role"],"summary":"Modify an existing msp user","description":"Modify an existing msp user. This interface only supports the authorization code mode, not the client mode. Please call this interface in authorization code mode.","operationId":"modifyMspUser","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"User ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyMspUserVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":4},"delete":{"tags":["MSP User and Role"],"summary":"Delete an existing msp user","description":"Delete an existing msp user. This interface only supports the authorization code mode, not the client mode. Please call this interface in authorization code mode.","operationId":"deleteMspUser","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"User ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUserVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":5}},"/openapi/v1/msp/{mspId}/sso/saml-idps/{idpId}":{"put":{"tags":["MSP SSO"],"summary":"Modify an existing msp idp","description":"Modify an existing msp idp.","operationId":"modifyIdpMetadata_1","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"idpId","in":"path","description":"Idp ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdpMetadataOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3},"delete":{"tags":["MSP SSO"],"summary":"Delete an existing msp idp","description":"Delete an existing msp idp.","operationId":"deleteIdpMetadata_1","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"idpId","in":"path","description":"Idp ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/msp/{mspId}/sso/external-user-groups/{externalUserGroupId}":{"put":{"tags":["MSP SSO"],"summary":"Modify an existing msp external user group","description":"Modify an existing msp external user group.","operationId":"modifyExternalUserGroup_1","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"externalUserGroupId","in":"path","description":"External user group ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MspExternalUserGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7},"delete":{"tags":["MSP SSO"],"summary":"Delete an existing msp external user group","description":"Delete an existing msp external user group.","operationId":"deleteExternalUserGroup_1","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"externalUserGroupId","in":"path","description":"External user group ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/msp/{mspId}/settings/ui-setting":{"put":{"tags":["uisetting"],"summary":"modify msp ui setting","description":"modify msp ui setting","operationId":"modifyMspUiSetting","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ui setting list request entity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":4},"post":{"tags":["uisetting"],"summary":"get msp ui setting","description":"get msp ui setting","operationId":"getMspUiSetting","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ui setting list request entity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":3}},"/openapi/v1/msp/{mspId}/roles/{roleId}":{"get":{"tags":["MSP User and Role"],"summary":"Get msp role info","description":"Get msp role info","operationId":"getMspRole","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"roleId","in":"path","description":"Role ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMspRoleDetailVO"}}}}},"x-order":7},"put":{"tags":["MSP User and Role"],"summary":"Modify an existing msp role","description":"Modify an existing msp role.","operationId":"modifyMspRole","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"roleId","in":"path","description":"Role ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyRoleVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":9},"delete":{"tags":["MSP User and Role"],"summary":"Delete an existing msp role","description":"Delete an existing msp role","operationId":"deleteMspRole","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"roleId","in":"path","description":"Role ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":10}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/gateways/{gatewayMac}/config/general":{"put":{"tags":["Gateway"],"summary":"Modify general gateway config for msp","description":"Modify general gateway config for msp","operationId":"modifyOsgConfigGeneralForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayMspConfigGeneral"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/openapi/v1/msp/{mspId}/controller/exceed-spec/tip":{"put":{"tags":["APP Controller Settings"],"summary":"Modify exceed-spec tip in Msp View","description":"Modify exceed-spec tip in Msp View. No further exceed-spec prompts after the user acknowledges and confirms.","operationId":"modifyMspExceedSpecTip","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/msp/{mspId}/account/customer-roles/{roleId}":{"put":{"tags":["MSP User and Role"],"summary":"Modify an existing customer role","description":"Modify an existing customer role.","operationId":"modifyCustomerRole","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"roleId","in":"path","description":"Role ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleDetailOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":13},"delete":{"tags":["MSP User and Role"],"summary":"Delete an existing customer role","description":"Delete an existing customer role","operationId":"deleteCustomerRole","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"roleId","in":"path","description":"Role ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":14}},"/openapi/v3/{omadacId}/sites/{siteId}/vpn/users":{"post":{"tags":["VPN"],"summary":"Create VPN user V3","description":"Create VPN user.","operationId":"createVpnUserV3","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnUserConfigVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnUserBriefVO"}}}}},"x-order":22}},"/openapi/v2/{omadacId}/topology/batch":{"post":{"tags":["Topology"],"summary":"Get multiple site topology","description":"Get topology of multiple site with the given omadacId and siteIds.","operationId":"getMultiSiteTopology","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopologyMultiSiteQueryOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOperationResponseTopologyOpenApiVO"}}}}},"x-order":7}},"/openapi/v2/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/wlans/{wlanId}/ssids":{"post":{"tags":["app"],"summary":"Create new SSID template V2","description":"Create new SSID template use full config","operationId":"createSsidTemplateV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSsidV2OpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":3}},"/openapi/v2/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/exist-network":{"post":{"tags":["Switch (Template)"],"summary":"Get the networks intersections existing on multiple switch templates V2","description":"Get the networks intersections existing on multiple switch templates.","operationId":"getBatchSwitchTemplateExistNetworksV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswDeviceTemplateIdListVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLanNetworkOpenApiV2GridVOLanNetworkSplitOpenApiVO"}}}}},"x-order":24}},"/openapi/v2/{omadacId}/sitetemplates/{siteTemplateId}/lan-profiles":{"get":{"tags":["Wired Network (Template)"],"summary":"Get switch profile template list","description":"Get switch profile template list.","operationId":"getOswLanProfileTemplateList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOLanProfileOpenApiVO"}}}}},"x-order":39},"post":{"tags":["Wired Network (Template)"],"summary":"Create new switch profile template","description":"Create new switch profile template.","operationId":"createOswLanProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanProfileSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseIdVO"}}}}},"x-order":40}},"/openapi/v2/{omadacId}/sitetemplates/{siteTemplateId}/lan-networks/batch-isolate":{"post":{"tags":["Wired Network (Template)"],"summary":"Batch isolate network","description":"Batch isolate network.","operationId":"batchIsolateLanNetwork","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchIsolateInterfaceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":35}},"/openapi/v2/{omadacId}/sites/{siteId}/wireless-network/wlans/{wlanId}/ssids":{"post":{"tags":["app"],"summary":"Create new SSID V2","description":"Create new SSID use full config","operationId":"createSsidV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSsidV2OpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":2}},"/openapi/v2/{omadacId}/sites/{siteId}/wireless-network/ssids":{"get":{"tags":["Wireless Network"],"summary":"Get SSID list by site","description":"Get SSID list by site","operationId":"getSsidListV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOSsidOpenApiVO"}}}}},"x-order":61},"post":{"tags":["Wireless Network"],"summary":"Create new SSID v2","description":"Create new SSID v2","operationId":"createSsidV2_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSsidOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCreateSsidResultVO"}}}}},"x-order":63}},"/openapi/v2/{omadacId}/sites/{siteId}/vpn/users":{"get":{"tags":["VPN"],"summary":"Get VPN user list V2","description":"Get VPN user list V2.","operationId":"getGridVpnUserV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"searchKey","required":false,"schema":{"type":"string"}},{"name":"filters.protocol","in":"query","description":"Filter query parameters, support field protocol. 0: L2TP or PPTP; 1: OpenVPN; 2: SSL VPN.","required":false,"schema":{"type":"string"}},{"name":"filters.clientMode","in":"query","description":"Filter query parameters, support field clientMode. 0: Network Extension Mode; 1: Client.","required":false,"schema":{"type":"string"}},{"name":"sorts.maxConnections","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.validity","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnUserOpenApiGridVOVpnUserInfoVO"}}}}},"x-order":19},"post":{"tags":["VPN"],"summary":"Create VPN user V2","description":"Create VPN user. This interface has been deprecated. Please use the following interfaces instead: Create VPN user V3. This interface had been deprecated.","operationId":"createVpnUserV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnUserRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":59}},"/openapi/v2/{omadacId}/sites/{siteId}/vpn/site-to-site-vpns":{"get":{"tags":["VPN"],"summary":"Get VPN Site to Site summary list","description":"Get VPN Site to Site summary list.","operationId":"getGridVpnS2SV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name.","required":false,"schema":{"type":"string"}},{"name":"filters.vpnType","in":"query","description":"Filter query parameters, support field vpnType. 2: IPSec; 4: WireGuard; 5: SSL VPN.","required":false,"schema":{"type":"string"}},{"name":"sorts.wans","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnSummaryOpenApiGridVOVpnSummaryVO"}}}}},"x-order":3},"post":{"tags":["VPN"],"summary":"Create site-to-site VPN by manual","description":"Create site-to-site VPN by manual.","operationId":"createS2SManualVpn","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnSiteToSiteManualConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":32}},"/openapi/v2/{omadacId}/sites/{siteId}/vpn/site-to-site-vpns/auto":{"post":{"tags":["VPN"],"summary":"Create site-to-site VPN by auto","description":"Create site-to-site VPN by auto.","operationId":"createS2SAutoVpn","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnSiteToSiteAutoConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":30}},"/openapi/v2/{omadacId}/sites/{siteId}/vpn/client-to-site-vpn-servers":{"get":{"tags":["VPN"],"summary":"Get VPN Server summary list","description":"Get VPN Server summary list.","operationId":"getGridVpnServerV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name.","required":false,"schema":{"type":"string"}},{"name":"filters.vpnType","in":"query","description":"Filter query parameters, support field vpnType. 0: L2TP; 1: PPTP; 2: IPSec; 3: OpenVPN; 4: WireGuard; 5: SSL VPN.","required":false,"schema":{"type":"string"}},{"name":"sorts.wans","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnSummaryOpenApiGridVOVpnSummaryVO"}}}}},"x-order":1},"post":{"tags":["VPN"],"summary":"Create client-to-site VPN server V2","description":"Create client-to-site VPN server V2.","operationId":"createVpnServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnServerConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/openapi/v2/{omadacId}/sites/{siteId}/vpn/client-to-site-vpn-clients":{"get":{"tags":["VPN"],"summary":"Get VPN Client summary list","description":"Get VPN Client summary list.","operationId":"getGridVpnClientV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name.","required":false,"schema":{"type":"string"}},{"name":"filters.vpnType","in":"query","description":"Filter query parameters, support field vpnType. 0: L2TP; 1: PPTP; 3: OpenVPN; 4: WireGuard;.","required":false,"schema":{"type":"string"}},{"name":"sorts.wans","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnSummaryOpenApiGridVOVpnSummaryVO"}}}}},"x-order":2},"post":{"tags":["VPN"],"summary":"Create client-to-site VPN client V2","description":"Create client-to-site VPN client.","operationId":"createVpnClient","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnClientConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":27}},"/openapi/v2/{omadacId}/sites/{siteId}/topology":{"get":{"tags":["Topology"],"summary":"Get site topology","description":"Get topology of the site with the given omadacId and siteId.","operationId":"getTopology","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTopologyOpenApiVO"}}}}},"x-order":1},"post":{"tags":["Topology"],"summary":"Refresh site topology","description":"Refresh topology of the site with the given omadacId and siteId.","operationId":"refreshTopology","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":3}},"/openapi/v2/{omadacId}/sites/{siteId}/topology/nodes":{"get":{"tags":["Topology"],"summary":"Get topology nodes","description":"Get the nodes in topology that can be set as topNode with the given omadacId and siteId. Only three types could be set when there is no gateway：switch、olt and other. Otherwise, this method will return empty list","operationId":"getTopologyNodes","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListTopologyRoot"}}}}},"x-order":5},"post":{"tags":["Topology"],"summary":"Set site topology top node","description":"Set topology top node of the site with the given omadacId, siteId and rootNode. Only three types could be set when there is no gateway：switch、olt and other. Otherwise, this method is invalid","operationId":"setTopologyNode","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopologyRootNode"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":4}},"/openapi/v2/{omadacId}/sites/{siteId}/topology/devices/all-clients":{"post":{"tags":["Topology"],"summary":"Get the clients by devices.","description":"Get the clients in topology of the devices with the given omadacId , siteId and device macs.","operationId":"getTopologyClientsByDevices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopologyClientsQuery"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListTopologyDeviceClients"}}}}},"x-order":12}},"/openapi/v2/{omadacId}/sites/{siteId}/stat/{deviceMac}/hourly":{"post":{"tags":["Statistic"],"summary":"Get device statistic data hourly","description":"Get device statistic data hourly. The supported attrs and response fields depend on the type parameter. For details, refer to section 5.9.1 Device Statistics of the Open API Access Guide.","operationId":"getDeviceHourlyStatistic","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Device Type. Supported type: ap, gateway, switch, olt.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatQueryVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseBaseDeviceStatDTO"}}}}},"x-order":7}},"/openapi/v2/{omadacId}/sites/{siteId}/stat/{deviceMac}/daily":{"post":{"tags":["Statistic"],"summary":"Get device statistic data daily","description":"Get device statistic data daily. The supported attrs and response fields depend on the type parameter. For details, refer to section 5.9.1 Device Statistics of the Open API Access Guide.","operationId":"getDeviceDailyStatistic","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Device Type. Supported type: ap, gateway, switch, olt.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatQueryVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseBaseDeviceStatDTO"}}}}},"x-order":8}},"/openapi/v2/{omadacId}/sites/{siteId}/stat/{deviceMac}/5min":{"post":{"tags":["Statistic"],"summary":"Get device statistic data 5 min","description":"Get device statistic data 5 min. The supported attrs and response fields depend on the type parameter. For details, refer to section 5.9.1 Device Statistics of the Open API Access Guide.","operationId":"getDevice5MinStatistic","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Device Type. Supported type: ap, gateway, switch, olt.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatQueryVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseBaseDeviceStatDTO"}}}}},"x-order":6}},"/openapi/v2/{omadacId}/sites/{siteId}/setting/iot/devices/config":{"get":{"tags":["Bluetooth"],"summary":"Get Bluetooth Advertising v2","description":"Get Bluetooth Advertising v2. Note:The parameter [transmitPower] is deprecated.","operationId":"getGridBtIbeaconListV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GridVOIotBtIbeaconOpenApiVO"}}}}},"x-order":19},"post":{"tags":["Bluetooth"],"summary":"Create Bluetooth Advertising v2","description":"Create Bluetooth Advertising v2. Note:The parameter [transmitPower] is deprecated.","operationId":"createBtIbeaconConfigV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigIotBtIbeaconV2OpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":20}},"/openapi/v2/{omadacId}/sites/{siteId}/setting/iot/devices/config/batch-config":{"post":{"tags":["Bluetooth"],"summary":"Batch modify Bluetooth Advertising","description":"Batch modify Bluetooth Advertising. Note:The parameter [transmitPower] is deprecated.","operationId":"batchModifyBtIbeaconConfigV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchModifyIbeaconV2OpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":24}},"/openapi/v2/{omadacId}/sites/{siteId}/report/export-schedule-email":{"get":{"tags":["Report v2"],"summary":"Get schedule time info","description":"Get schedule time info","operationId":"getScheduleTimeInfoV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":11},"post":{"tags":["Report v2"],"summary":"Export report for scheduler","description":"Export report for scheduler","operationId":"emailReportScheduleV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkReportScheduleVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":12}},"/openapi/v2/{omadacId}/sites/{siteId}/report/export-now-email":{"post":{"tags":["Report v2"],"summary":"Export report now for email","description":"Export report now for email","operationId":"exportNowEmailV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportExportV2"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":9}},"/openapi/v2/{omadacId}/sites/{siteId}/report/export-later-email":{"post":{"tags":["Report v2"],"summary":"Export report once later","description":"Export report once later","operationId":"exportLaterEmailV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkReportScheduleLaterVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":10}},"/openapi/v2/{omadacId}/sites/{siteId}/ppsk-profile":{"post":{"tags":["Profiles"],"summary":"Create PPSK profile V2","description":"Create PPSK profile","operationId":"createPPSKProfileV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PpskProfile V2"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"x-order":20}},"/openapi/v2/{omadacId}/sites/{siteId}/lan-profiles":{"get":{"tags":["Wired Network"],"summary":"Get switch profile list","description":"Get switch profile list.","operationId":"getOswLanProfileList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOLanProfileInfoOpenApiVO"}}}}},"x-order":59},"post":{"tags":["Wired Network"],"summary":"Create new switch profile","description":"Create new switch profile.","operationId":"createOswLanProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanProfileSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseIdVO"}}}}},"x-order":60}},"/openapi/v2/{omadacId}/sites/{siteId}/lan-networks":{"get":{"tags":["Wired Network"],"summary":"Get LAN network list","description":"Get LAN network list.(Pagination)","operationId":"getLanNetworkListV2","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLanNetworkOpenApiV2GridVOLanNetworkQueryOpenApiV2VO"}}}}},"x-order":9},"post":{"tags":["Wired Network"],"summary":"Create LAN network","description":"Create lan network. This interface has been deprecated. Please use the following interface instead: Confirm create lan network","operationId":"createLanNetworkV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanNetworkOpenApiV2VO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"deprecated":true,"x-order":10}},"/openapi/v2/{omadacId}/sites/{siteId}/lan-networks/batch-isolate":{"post":{"tags":["Wired Network"],"summary":"Batch isolate network","description":"Batch isolate network.","operationId":"batchIsolateLanNetwork_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchIsolateInterfaceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":81}},"/openapi/v2/{omadacId}/sites/{siteId}/clients":{"post":{"tags":["Client"],"summary":"Get all client list","description":"Get all clients, including online offline blocked and all list.","operationId":"getGridAllClients","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientQueryDataOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientGridVOOpenApi Client Info"}}}}},"x-order":1}},"/openapi/v2/{omadacId}/sites/{siteId}/aps/{apMac}/start-rf-scan":{"post":{"tags":["Ap"],"summary":"Start rf scan v2","description":"Wi-Fi connection will lost for several minutes during the scanning. Please select a spare time of network to start scanning.","operationId":"triggerRadioFrequencyScanV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RFScanCommand"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":21}},"/openapi/v2/{omadacId}/files/sites/{siteId}/vpn/certificate":{"post":{"tags":["VPN"],"summary":"Upload VPN certificate file V2","description":"Upload VPN certificate file.","operationId":"uploadVpnCertificateFileV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"Client VPN certificate file (exported from the VPN server). OpenVPN Client only supports .ovpn files; WireGuard Client only supports .conf files.","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnCertificateVO"}}}}},"x-order":54}},"/openapi/v2/{omadacId}/files/sites/{siteId}/report/export-now-local":{"post":{"tags":["Report v2"],"summary":"Export report now","description":"Export report","operationId":"exportNowLocal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportExportV2"}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":8}},"/openapi/v2/{omadacId}/files/sites/{siteId}/gateways/{gatewayMac}/sim/sms/export":{"post":{"tags":["SIM"],"summary":"Export SMS message by mac V2","description":"Export SMS message by mac.","operationId":"exportSmsMessageBymacV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportMessage"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":38}},"/openapi/v1/{omadacId}/webhook/settings":{"get":{"tags":["Webhook Setting"],"summary":"Get global webhook setting list.","description":"Get all global webhook setting.The template of webhook message is display at Open API Access Guide#5.3.1 Webhook Message Template.","operationId":"getWebhookForGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListWebhookSetting"}}}}},"x-order":1},"post":{"tags":["Webhook Setting"],"summary":"Create global webhook setting","description":"Create global webhook setting.The template of webhook message is display at Open API Access Guide#5.3.1 Webhook Message Template.","operationId":"createWebhookForGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiWebhookSettingAddVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/webhook/settings/{webhookId}":{"post":{"tags":["Webhook Setting"],"summary":"Test global webhook setting","description":"Test global webhook setting.The template of webhook message is display at Open API Access Guide#5.3.1 Webhook Message Template.","operationId":"testWebhookForGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"webhookId","in":"path","description":"webhook ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiWebhookSettingTestVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5},"delete":{"tags":["Webhook Setting"],"summary":"Delete global webhook setting","description":"Delete global webhook setting.The template of webhook message is display at Open API Access Guide#5.3.1 Webhook Message Template.","operationId":"deleteWebhookForGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"webhookId","in":"path","description":"webhook ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"patch":{"tags":["Webhook Setting"],"summary":"Modify global webhook setting","description":"Modify global webhook setting.The template of webhook message is display at Open API Access Guide#5.3.1 Webhook Message Template.","operationId":"modifyWebhookForGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"webhookId","in":"path","description":"webhook ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiWebhookSettingEditVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/users":{"get":{"tags":["User and Role"],"summary":"Get user list","description":"Get user list. This interface only supports the authorization code mode, not the client mode. Please call this interface in authorization code mode.","operationId":"getGridUsers","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.roleId","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.email","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field userName","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOUserDetailVO"}}}}},"x-order":1},"post":{"tags":["User and Role"],"summary":"Create new user","description":"Create new user.","operationId":"createNewUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCreateUserResultVO"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/users/feedback/evaluates":{"post":{"tags":["Controller Settings"],"summary":"Evaluate a customer feedback","description":"Evaluate a customer feedback","operationId":"evaluateFeedback","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/upgrade/plan/sites":{"post":{"tags":["Firmware"],"summary":"Get the sites of the selected model","description":"Paging to get the sites of the selected model","operationId":"getGridPlanUpgradeSiteList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelUpgradeSiteReqInfo"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseModelUpgradeSiteInfo"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/upgrade/plan/firmware":{"post":{"tags":["Firmware"],"summary":"Get the upgradeable information of the selected model","description":"Get the upgradeable information of the selected model.","operationId":"getPlanUpgradeModelInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelUpgradeInfo"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePlanUpgradeModelInfo"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/upgrade/overview/plans":{"get":{"tags":["Firmware"],"summary":"Get firmware upgrade plans","description":"Paging to get firmware upgrade plans.","operationId":"getGridUpgradePlans","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.scheduledUpgradeTime","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.modelTypeInfo","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOPlanUpgradeInfo"}}}}},"x-order":5},"post":{"tags":["Firmware"],"summary":"Create firmware upgrade plan","description":"Create firmware upgrade plan.","operationId":"createUpgradePlan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanUpgradeCreateInfo"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCreateUpgradePlanResinfo"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/upgrade/overview/firmwares/release-note":{"post":{"tags":["Firmware"],"summary":"Get release notes information","description":"Get release notes information of a firmware series","operationId":"getModelFirmwareReleaseNotes","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelFwReleaseNoteReqInfo"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseModelFwOemReleaseNoteInfo"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/upgrade/models":{"post":{"tags":["Firmware"],"summary":"Get the model of the specified site","description":"Get the model of the specified site. If no site is specified, it defaults to all authorized sites","operationId":"getModelBySites","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpgradeSiteModelReqInfo"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUpgradeSiteModelInfo"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/upgrade/firmwares/{firmwareId}":{"post":{"tags":["Firmware"],"summary":"Edit the uploaded firmware","description":"Edit the uploaded firmware","operationId":"editFirmwareUpgrade","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"firmwareId","in":"path","description":"Firmware ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditUploadFirmwareInfo"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":28}},"/openapi/v1/{omadacId}/upgrade/firmware-size/{firmwareSize}":{"post":{"tags":["Firmware"],"summary":"Check the limit of the firmware pool","description":"Check the limit of the firmware pool","operationId":"checkUploadUpgradeFirmwareLimit","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"firmwareSize","in":"path","description":"firmwareSize","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":27}},"/openapi/v1/{omadacId}/upgrade/autoCheck":{"get":{"tags":["Firmware"],"summary":"Get autocheck upgrade plan","description":"Paging to get autocheck upgrade plan","operationId":"getGridAutoCheckUpgrade","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.autoCheckTime","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field upgrade","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOAutoCheckUpgradeInfo"}}}}},"x-order":16},"post":{"tags":["Firmware"],"summary":"Create autocheck upgrade plan","description":"Create autocheck upgrade plan","operationId":"createAutoCheckUpgrade","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoCheckUpgradeCreateInfo"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCreateAutoCheckResInfo"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/unbind/cloudowner":{"post":{"tags":["Cloud User"],"summary":"Unbind the owner account for cloud owner","description":"Unbind the owner account for cloud owner.","operationId":"cloudOwnerUnbindOwner","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalOwnerConfirmVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sso/saml-idps":{"get":{"tags":["SSO"],"summary":"Get idp list","description":"Get idp list.","operationId":"getIdpMetadataList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.idpName","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOIdpMetadataDetailOpenApiVO"}}}}},"x-order":1},"post":{"tags":["SSO"],"summary":"Create new idp","description":"Create new idp.","operationId":"createIdpMetadata","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdpMetadataOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sso/external-user-groups":{"get":{"tags":["SSO"],"summary":"Get external user group list","description":"Get external user group list.","operationId":"getExternalUserGroupList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOExternalUserGroupDetailOpenApiVO"}}}}},"x-order":5},"post":{"tags":["SSO"],"summary":"Create new external user group","description":"Create new external user group.","operationId":"createExternalUserGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalUserGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sitetemplates":{"get":{"tags":["Site Template"],"summary":"Get site template list","description":"Get site template list","operationId":"getSiteTemplateList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOSiteTemplateSummaryVO"}}}}},"x-order":5},"post":{"tags":["Site Template"],"summary":"Create new site template","description":"Create new site template","operationId":"createNewSiteTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSiteTemplateEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/wlans":{"get":{"tags":["Wireless Network (Template)"],"summary":"Get WLAN Group template list","description":"Get WLAN Group template list, Legacy note: “WLAN Group” is the legacy name of “AP Group”. This endpoint will be deprecated in future releases. Please use Get AP Group template list.","operationId":"getWlanGroupListTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListWlanGroupOpenApiVO"}}}}},"deprecated":true,"x-order":51},"post":{"tags":["Wireless Network (Template)"],"summary":"Create new WLAN Group template","description":"Create new WLAN Group template, Legacy note: “WLAN Group” is the legacy name of “AP Group”. This endpoint will be deprecated in future releases. Please use Create new AP Group template.","operationId":"createWlanGroupTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWlanGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"deprecated":true,"x-order":52}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/wlans/{wlanId}/ssids":{"get":{"tags":["Wireless Network (Template)"],"summary":"Get SSID template list","description":"Get SSID template list, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Get SSID template list v2.","operationId":"getSsidListTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOSsidOpenApiVO"}}}}},"deprecated":true,"x-order":6},"post":{"tags":["Wireless Network (Template)"],"summary":"Create new SSID template","description":"Create new SSID template, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Create new SSID template v2.","operationId":"createSsidTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSsidOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"deprecated":true,"x-order":8}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/ssids":{"get":{"tags":["Wireless Network (Template)"],"summary":"Get SSID template list v2","description":"Get SSID template list v2","operationId":"getSsidListTemplateV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOSsidOpenApiVO"}}}}},"x-order":47},"post":{"tags":["Wireless Network (Template)"],"summary":"Create new SSID template v2","description":"Create new SSID template v2","operationId":"createSsidTemplateV2_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSsidOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCreateSsidResultVO"}}}}},"x-order":49}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/ssids/deviceTypeChanged":{"get":{"tags":["app"],"summary":"Query Template SSID Names with deviceType changed","description":"Query Template SSID Names with deviceType changed","operationId":"querySsidChangedDeviceType","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceTypeChangedSsidOpenApiVO"}}}}},"x-order":13},"post":{"tags":["app"],"operationId":"cleanTemplateSsidChangedNotifications","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":19},"delete":{"tags":["app"],"summary":"Clean Template SSIDs with deviceType changed","description":"Batch delete invalid gateway SSIDs and clean deviceTypeChanged field of template SSIDs","operationId":"cleanSsidChangedDeviceTypeByTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/ssid-operation":{"get":{"tags":["app"],"summary":"Get all SSID templates","description":"Get all SSID templates","operationId":"listTemplateSsids","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSsidDetailResponseVO"}}}}},"x-order":17},"post":{"tags":["app"],"summary":"Create new SSID template v3","description":"Create new SSID template v3","operationId":"createSsidTemplateV3","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SsidVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wired-networks/disable-nat":{"get":{"tags":["NAT (Template)"],"summary":"Get siteTemplate's Disable Nat list","description":"Get siteTemplate's Disable Nat list.","operationId":"getDisableNatGrid","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVODisableNatDetailOpenApiVO"}}}}},"x-order":8},"post":{"tags":["NAT (Template)"],"summary":"Create new siteTemplate's Disable Nat","description":"Create new siteTemplate's Disable Nat.","operationId":"addDisableNat","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disable Nat"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/voip/telephone-book":{"get":{"tags":["VoIP (Template)"],"summary":"Get siteTemplate's Voip Contact Person list","description":"Get siteTemplate's Voip Contact Person list.","operationId":"getVoipTelephoneBookTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOVoipTelephoneBookSetting"}}}}},"x-order":1},"post":{"tags":["VoIP (Template)"],"summary":"Create new siteTemplate's Contact Person","description":"Create new siteTemplate's Contact Person.","operationId":"createVoipTelephoneBookTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoipContactPersonSettings"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/voip/telephone-book/batch-delete":{"post":{"tags":["VoIP (Template)"],"summary":"Batch delete existing Contact Person in siteTemplate","description":"Batch delete existing Contact Person in siteTemplate.","operationId":"batchDeleteVoipTelephoneBookTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoipTelephoneBookBatchSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/voip/call-log-enable":{"get":{"tags":["VoIP (Template)"],"summary":"Get siteTemplate's Voip CallLog Setting","description":"Get siteTemplate's Voip CallLog Setting.","operationId":"getVoipCallLogEnable","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVoipCallLogEnableSetting"}}}}},"x-order":10},"post":{"tags":["VoIP (Template)"],"summary":"Modify siteTemplate's Voip CallLog Setting","description":"Modify siteTemplate's Voip CallLog Setting.","operationId":"modifyVoipCallLogEnable","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoipCallLogEnableSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/voip/call-forwarding":{"post":{"tags":["VoIP (Template)"],"summary":"Create new siteTemplate's Call Forwarding","description":"Create new siteTemplate's Call Forwarding.","operationId":"addCallForwardingRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallForwardingRule"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAddCallForwardingRuleResp"}}}}},"x-order":7},"delete":{"tags":["VoIP (Template)"],"summary":"Batch delete existing Call Forwarding in siteTemplate","description":"Batch delete existing Call Forwarding in siteTemplate.","operationId":"deleteCallForwardingRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallForwardingRules"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVoid"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/url-filters":{"post":{"tags":["URL Filtering (Template)"],"summary":"Create URL filtering template rule","description":"Create URL filtering template rule.","operationId":"createUrlFilteringRuleTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UrlFilteringOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":3},"patch":{"tags":["URL Filtering (Template)"],"summary":"Modify URL filtering template rule index","description":"Modify URL filtering template rule index.","operationId":"modifyUrlFilteringRuleIndexTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UrlDragSortIndexOpenapiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/transmission/otonats":{"post":{"tags":["NAT (Template)"],"summary":"Create site template's otonat","description":"Create site template's otonat. This interface had been deprecated.","operationId":"addOtoNatTemplates","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OtoNatOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":7}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/time-range-profiles":{"get":{"tags":["Profiles (Template)"],"summary":"Get time range profile template list","description":"Get time range profile template list","operationId":"getTimeRangeListTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListTimeRangeProfileOpenApiVO"}}}}},"x-order":26},"post":{"tags":["Profiles (Template)"],"summary":"Create time range profile template","description":"Create time range profile template","operationId":"createTimeRangeProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTimeRangeProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":27}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/vrfs":{"get":{"tags":["Switch (Template)"],"summary":"Get the vrfs on the switch template","description":"Get the vrfs on the switch template. This interface has been deprecated.","operationId":"getGridVrfTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOswVrfOpenApiVO"}}}}},"deprecated":true,"x-order":26},"post":{"tags":["Switch (Template)"],"summary":"Create new vrf template","description":"Create new vrf template. This interface has been deprecated.","operationId":"createOswVrfTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswVrfConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"deprecated":true,"x-order":27}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/stp/instance-detail":{"post":{"tags":["Switch (Template)"],"summary":"Get StpInstanceDetail Template","description":"Get StpInstanceDetail Template.","operationId":"getRpvstInstancesDetailTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StpInstanceDetailVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":32}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/interfaces/pmtud":{"post":{"tags":["Switch (Template)"],"summary":"Modify Path MTU Discovery Template","description":"modify Path MTU Discovery Template.","operationId":"modifyPmtudStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswPmtudVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":33}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/rpvst-instances":{"post":{"tags":["Switch (Template)"],"summary":"Get Batch Rpvst Instances Template","description":"Get Batch Rpvst Instances Template.","operationId":"getBatchRpvstInstancesTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":31}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/port-tag":{"get":{"tags":["Switch (Template)"],"summary":"Get template port label list","description":"Get template port label list.","operationId":"getPortTagTemplates","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PortTagOpenApiVO"}}}}}},"x-order":19},"post":{"tags":["Switch (Template)"],"summary":"Create new template port label","description":"Create new template port label.","operationId":"addPortTagTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePortTagOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PortTagOpenApiVO"}}}}},"x-order":16},"delete":{"tags":["Switch (Template)"],"summary":"Delete an existing template port label","description":"Delete an existing template port label.","operationId":"deletePortTagTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePortTagOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18},"patch":{"tags":["Switch (Template)"],"summary":"Modify an existing template port label","description":"Modify an existing template port label.","operationId":"modifyPortTagTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortTagOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/exist-network":{"post":{"tags":["Switch (Template)"],"summary":"Get the networks intersections existing on multiple switch templates","description":"Get the networks intersections existing on multiple switch templates.","operationId":"getBatchSwitchTemplateExistNetworks","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswMacListVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLanNetworkOpenApiV2GridVOLanNetworkSplitOpenApiVO"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switches/details":{"post":{"tags":["Switch (Template)"],"summary":"Get the details of osw templates with given omadacid, siteid and macs and stackIds.","description":"Get the details of osw templates with given omadacid, siteid and macs and stackIds.","operationId":"getOswsDetailsTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswDetailOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switch-oui-rules":{"get":{"tags":["OUI Based VLAN (Template)"],"summary":"Get Switch oui based vlan template list","description":"Get Switch oui based vlan template list.","operationId":"getGridSwitchOuiBasedVlanTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOuiBasedVlanTemplateSwitchQueryOpenApiVO"}}}}},"x-order":1},"post":{"tags":["OUI Based VLAN (Template)"],"summary":"Create Switch oui based vlan template","description":"Create Switch oui based vlan template.","operationId":"createSwitchOuiBasedVlanTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OuiBasedVlanTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switch-oui-rules/switches/{ouiBasedVlanId}/check":{"post":{"tags":["OUI Based VLAN (Template)"],"summary":"Get whether exist at least one port or lag with allow all network tags for oui based vlan modification.","description":"Get whether exist at least one port or lag with allow all network tags for oui based vlan modification.","operationId":"getWhetherExistAllowAllPortOrLagsForRuleModificationTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ouiBasedVlanId","in":"path","description":"Oui Based Vlan ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OuiBasedVlanRuleVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOuiBasedVlanOswPortNetworkTagsSettingVO"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switch-oui-rules/switches/check":{"post":{"tags":["OUI Based VLAN (Template)"],"summary":"Get whether exist at least one port or lag with allow all network tags for oui based vlan creation.","description":"Get whether exist at least one port or lag with allow all network tags for oui based vlan creation.","operationId":"getWhetherExistAllowAllPortOrLagsForRuleCreationTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OuiBasedVlanRuleVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOuiBasedVlanOswPortNetworkTagsSettingVO"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switch-oui-rules/enable-auto-add-vlan":{"post":{"tags":["OUI Based VLAN (Template)"],"summary":"Enable the site template and device auto add vlan.","description":"Enable the site template and device auto add vlan.","operationId":"enableAutoAddVlanTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/site/reset/log-notification":{"post":{"tags":["Log (Template)"],"summary":"Reset site template log notification","description":"Reset site template log notification.","operationId":"resetLogSettingSiteTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/voip/provider-profiles":{"post":{"tags":["VoIP (Template)"],"summary":"Create new provider profile template","description":"Create new provider profile template.","operationId":"createProviderProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProviderProfileEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/voip/digit-map":{"get":{"tags":["VoIP"],"summary":"Get digit map profile list template","description":"Get digit map profile list template.","operationId":"getDigitMapProfilesTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListDigitMapProfileInfo"}}}}},"x-order":43},"post":{"tags":["VoIP"],"summary":"Create new digit map profile template","description":"Create new digit map profile template.","operationId":"createDigitMapProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDigitMapProfileEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":44}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/voip/digit-map/delete":{"post":{"tags":["VoIP"],"summary":"Delete digit map profile template","description":"Delete digit map profile template.","operationId":"deleteDigitMapProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteDigitMapProfileEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListProfilesBindedDeviceInfo"}}}}},"x-order":46}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/voip/call-blocking":{"get":{"tags":["VoIP (Template)"],"summary":"Get call blocking profile list template","description":"Get call blocking profile list template.","operationId":"getCallBlockingProfiles","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListCallBlockingProfileEntity"}}}}},"x-order":20},"post":{"tags":["VoIP (Template)"],"summary":"Create new call blocking profile template","description":"Create new call blocking profile template.","operationId":"createCallBlockingProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallBlockingProfileEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/virtual-wans":{"get":{"tags":["Wired Network (Template)"],"summary":"Query virtual WAN list template","description":"Query virtual WAN list for template.","operationId":"getGridVirtualWanTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVirtualWanGridOpenApiVOVirtualWanInfoOpenApiVO"}}}}},"x-order":27},"post":{"tags":["Wired Network (Template)"],"summary":"Create virtual WAN template","description":"Create virtual WAN template.","operationId":"createVirtualWanTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualWanConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":29}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/speedTest":{"get":{"tags":["Wired Network (Template)"],"summary":"Get SpeedTest Setting Template","description":"Get SpeedTest Setting Template.","operationId":"getSpeedTestV2SettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSpeedTestV2SettingVO"}}}}},"x-order":62},"post":{"tags":["Wired Network (Template)"],"summary":"Modify SpeedTest Setting Template","description":"Modify SpeedTest Setting Template.","operationId":"modifySpeedTestV2SettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifySpeedTestV2SettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":63}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/service/port-schedules":{"get":{"tags":["Schedule (Template)"],"summary":"Get port Schedule list","description":"Get port Schedule list with the given omadacId and siteTemplateId.","operationId":"getPortScheduleListTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListPortOrPoeScheduleOpenApiVO"}}}}},"x-order":34},"post":{"tags":["Schedule (Template)"],"summary":"Create a new Port Schedule Template","description":"Create a new Port Schedule Template with the given params.","operationId":"addPortScheduleTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortOrPoeScheduleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":35}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/service/mdns":{"get":{"tags":["mDNS (Template)"],"summary":"Get mDNS template rule list","description":"Get mDNS template rule list of the site with the given omadacId and siteId.","operationId":"getMdnsGridTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMdnsRuleTemplateOpenApiVO"}}}}},"x-order":27},"post":{"tags":["mDNS (Template)"],"summary":"Create a new mDNS template rule","description":"Create a new mDNS template rule with the given params.","operationId":"createMdnsTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMdnsRuleTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":28}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/service/ddns":{"get":{"tags":["DNS (Template)"],"summary":"Get Dynamic DNS template list","description":"Get Dynamic DNS template list of the site with the given omadacId and siteId.","operationId":"getDdnsGridTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.service","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.updateInterval","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.status","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDdnsOpenApiGridVODdnsOpenApiVO"}}}}},"x-order":1},"post":{"tags":["DNS (Template)"],"summary":"Create a new Dynamic DNS template entry","description":"Create a new Dynamic DNS template entry with the given params.","operationId":"createDdnsTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDdnsOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/profiles/cert-profiles":{"get":{"tags":["CertProfiles (Template)"],"summary":"Get certificate profile Template list","description":"Get certificate profile Template list.(Pagination).","operationId":"getGridCertProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.type","in":"query","description":"Filter query parameters, support field type, it should be a value as follows: 0: CA Cert; 1: Client Cert.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"filters.status","in":"query","description":"Filter query parameters, support field status, it should be a value as follows: 0: Normal; 1: Expired Soon; 2: Expired","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field Name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCertProfileOpenApiVO"}}}}},"x-order":1},"post":{"tags":["CertProfiles (Template)"],"summary":"Create a new certificate profile Template","description":"Create a new certificate profile Template with the given params.","operationId":"createCertProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertProfileRequestOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/profiles/cert-profiles/{certId}":{"get":{"tags":["CertProfiles (Template)"],"summary":"Get a certificate profile Template detail","description":"Get a certificate profile Template detail with the given params.","operationId":"getCertProfileDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"certId","in":"path","description":"Cert profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCertProfileDetailOpenApiVO"}}}}},"x-order":2},"post":{"tags":["CertProfiles (Template)"],"summary":"Modify an exist certificate profile Template","description":"Modify an exist certificate profile Template with the given params.","operationId":"modifyCertProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"certId","in":"path","description":"Certificate profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertProfileRequestOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7},"delete":{"tags":["CertProfiles (Template)"],"summary":"Delete an exist certificate profile Template","description":"Delete an exist certificate profile Template with the given params.","operationId":"deleteCertProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"certId","in":"path","description":"Cert profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeleteCertOpenApiVO"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/profiles/cert-profiles/delete-file/{fileId}":{"post":{"tags":["CertProfiles (Template)"],"summary":"Delete an exist certificate profile Template file","description":"Delete an exist certificate profile Template file with the given params.","operationId":"deleteCertProfileFile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"fileId","in":"path","description":"Cert profile file ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/iot/servers":{"get":{"tags":["Bluetooth(Template)"],"summary":"Get IoT Transport Stream(Template)","description":"Get IoT Transport Stream setting in site template.","operationId":"getGridIotServerTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GridVOIotServerOpenApiVO"}}}}},"x-order":4},"post":{"tags":["Bluetooth(Template)"],"summary":"Create IoT Transport Stream(Template)","description":"Create IoT Transport Stream setting in site Template.","operationId":"createIotServerTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigIotServerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/session-limit/rules":{"get":{"tags":["Session Limit (Template)"],"summary":"Get site template's session limit rule list","description":"Get site template's session limit rule list.","operationId":"getTemplateGridSessionLimitRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSessionLimitRuleGridOpenApiVOQuerySessionLimitRuleOpenApiVO"}}}}},"x-order":3},"post":{"tags":["Session Limit (Template)"],"summary":"Create site template's session limit rule","description":"Create site template's session limit rule.","operationId":"createTemplateSessionLimitRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionLimitRuleTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"patch":{"tags":["Session Limit (Template)"],"summary":"Modify site template's session limit rule index","description":"Modify site template's session limit rule index.","operationId":"modifyTemplateSessionLimitRuleIndex","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransmissionDragSortIndexOpenapiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/routing/static-routings":{"get":{"tags":["Routing (Template)"],"summary":"Get site template's static routing list","description":"Get site template static routing list.","operationId":"getTemplateGridStaticRouting","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseStaticRoutingOpenApiGridVOStaticRoutingInfoTemplate"}}}}},"x-order":1},"post":{"tags":["Routing (Template)"],"summary":"Create site template's static routing","description":"Create site template static routing.","operationId":"createTemplateStaticRouting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticRoutingConfigTemplate"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/routing/policy-routings":{"get":{"tags":["Routing (Template)"],"summary":"Get site template's policy routing list","description":"Get site template's policy routing list.","operationId":"getTemplateGridPolicyRouting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePolicyRoutingOpenApiGridVOPolicyRoutingInfo"}}}}},"x-order":5},"post":{"tags":["Routing (Template)"],"summary":"Create site template's policy routing","description":"Create site template's policy routing.","operationId":"createTemplatePolicyRouting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyRoutingConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/routing/policy-routings/modifyIndex":{"post":{"tags":["Routing (Template)"],"summary":"Modify site template's policy routing Index","description":"Modify site template's policy routing Index.","operationId":"modifyTemplatePolicyRoutingIndex","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyRoutingDragSortIndexOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/remember-device":{"get":{"tags":["Site Template Configuration"],"summary":"Query site template setting exist or not","description":"Query site template setting exist or not","operationId":"getSiteTemplateRememberSettingByOpenApi","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteRememberDeviceSetting"}}}}},"x-order":19},"post":{"tags":["Site Template Configuration"],"summary":"Modify site template remember device setting","description":"Modify site template remember device setting","operationId":"modifySiteTemplateRememberSettingByOpenApi","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteRememberDeviceSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/reboot-schedules":{"get":{"tags":["Schedule (Template)"],"summary":"Get reboot schedule template list","description":"Get reboot schedule list template","operationId":"getRebootScheduleList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListRebootScheduleTemplateQueryOpenApiVO"}}}}},"x-order":1},"post":{"tags":["Schedule (Template)"],"summary":"Create new reboot schedule template","description":"Create new reboot schedule template","operationId":"createRebootSchedule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RebootScheduleTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/rate-limit-profiles":{"get":{"tags":["Profiles (Template)"],"summary":"Get rate limit profile template list","description":"Get rate limit profile template list","operationId":"getRateLimitProfileListTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListRateLimitProfileOpenApiVO"}}}}},"x-order":30},"post":{"tags":["Profiles (Template)"],"summary":"Create rate limit profile template","description":"Create rate limit profile template","operationId":"createRateLimitProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRateLimitProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":31}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/qos/gateway/class-rules":{"get":{"tags":["Gateway QOS (Template)"],"summary":"Get siteTemplate's class rule list","description":"Get siteTemplate's class rule list.","operationId":"getTemplateClassRuleGrid","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOClassRuleTemplateDetailOpenApiVO"}}}}},"x-order":6},"post":{"tags":["Gateway QOS (Template)"],"summary":"Create siteTemplate's new class rule","description":"Create siteTemplate's new class rule.","operationId":"createTemplateClassRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassRuleTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/qos/gateway/bwcs":{"get":{"tags":["Gateway QOS (Template)"],"summary":"Get siteTemplate's bandwidth control rule list","description":"Get siteTemplate's bandwidth control rule list.","operationId":"getTemplateBandwidthCtrlGrid","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOQosBwcDetailOpenApiVO"}}}}},"x-order":2},"post":{"tags":["Gateway QOS (Template)"],"summary":"Create siteTemplate's new bandwidth control rule","description":"Create siteTemplate's new bandwidth control rule.","operationId":"createTemplateBwCtrl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QosBwcOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/profiles/wifi-calling":{"get":{"tags":["Profiles (Template)"],"summary":"Get wifi calling profile template list","description":"Get wifi calling profile template list of the site with the given omadacId and siteId.","operationId":"getWifiCallingProfilesTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListWifiCallingProfileOpenApiVO"}}}}},"x-order":42},"post":{"tags":["Profiles (Template)"],"summary":"Create a new wifi calling profile template","description":"Create a new wifi calling profile template with the given params.","operationId":"createWifiCallingProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWifiCallingProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":43}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/profiles/wifi-calling/{profileId}/copy":{"post":{"tags":["Profiles (Template)"],"summary":"Copy wifi calling profile template","description":"Copy wifi calling profile template with the given params.","operationId":"copyWifiCallingProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CopyWifiCallingProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":45}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/profiles/service-type":{"get":{"tags":["Profiles (Template)"],"summary":"Get siteTemplate's Gateway QoS Service list","description":"Get siteTemplate's Gateway QoS Service list.","operationId":"listTemplateServiceType","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOGatewayQosServiceDetailOpenApiVO"}}}}},"x-order":91},"post":{"tags":["Profiles (Template)"],"summary":"Create siteTemplate's new Gateway QoS Service","description":"Create siteTemplate's new Gateway QoS Service.","operationId":"createTemplateServiceType","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayQosServiceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":92}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/profiles/radius":{"get":{"tags":["Profiles (Template)"],"summary":"Get RADIUS profile template list","description":"Get RADIUS profile template list of the site with the given omadacId and siteId.","operationId":"getRadiusProfileListTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListRadiusProfileOpenApiVO"}}}}},"x-order":11},"post":{"tags":["Profiles (Template)"],"summary":"Create a new RADIUS profile template","description":"Create a new RADIUS profile template with the given params.","operationId":"createRadiusProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRadiusProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/profiles/radius-server/users":{"get":{"tags":["Profiles (Template)"],"summary":"Get Build-in RADIUS profile user template list","description":"Get Build-in RADIUS profile user template list of the site with the given omadacId and siteId. Cloud Based Controller does not support built-in radius function, you cannot call this interface through openAPI on Cloud Based Controller.","operationId":"getRadiusUserListTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.username","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVORadiusUserOpenApiVO"}}}}},"x-order":15},"post":{"tags":["Profiles (Template)"],"summary":"Create a new Build-in RADIUS profile user template","description":"Get Build-in RADIUS profile user template list of the site with the given omadacId and siteId. Cloud Based Controller does not support built-in radius function, you cannot call this interface through openAPI on Cloud Based Controller.","operationId":"createRadiusUserTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRadiusUserOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/profiles/ldap":{"get":{"tags":["Profiles (Template)"],"summary":"Get LDAP profile template list","description":"Get LDAP profile template list of the site with the given omadacId and siteId.","operationId":"getLdapProfileListTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListLdapProfileOpenApiVO"}}}}},"x-order":34},"post":{"tags":["Profiles (Template)"],"summary":"Create a new LDAP profile template","description":"Create a new LDAP profile template with the given params.","operationId":"createLdapProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLdapProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":35}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/profiles/groups":{"get":{"tags":["Profiles (Template)"],"summary":"Get group profile template list","description":"Get group profile template list of the site with the given omadacId and siteId.","operationId":"getGroupProfilesTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListGroupOpenApiVO"}}}}},"x-order":1},"post":{"tags":["Profiles (Template)"],"summary":"Create a new group profile template","description":"Create a new group profile template with the given params.","operationId":"createGroupProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/profiles/bonjour-service":{"get":{"tags":["Profiles (Template)"],"summary":"Get Bonjour Service Template list","description":"Get Bonjour Service Template list.","operationId":"listMdnsProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseDataVOBonjourServiceDetailOpenApiVO"}}}}},"x-order":84},"post":{"tags":["Profiles (Template)"],"summary":"Create new Bonjour Service Template","description":"Create new Bonjour Service Template.","operationId":"createMdnsProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BonjourServiceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"x-order":85}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/profiles/apn":{"get":{"tags":["Profiles (Template)"],"summary":"Get APN profile template list","description":"Get APN profile template list of the site with the given omadacId and siteId.","operationId":"getApnProfileListTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListApnProfile"}}}}},"x-order":38},"post":{"tags":["Profiles (Template)"],"summary":"Create a new APN profile template","description":"Create a new APN profile template with the given params.","operationId":"createApnProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApnProfileConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":39}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/ppsk-profile":{"post":{"tags":["Profiles (Template)"],"summary":"Create PPSK profile template","description":"Create PPSK profile template","operationId":"createPPSKProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PpskProfile"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/ppsk-profile/{profileId}":{"get":{"tags":["Profiles (Template)"],"summary":"Get PPSK profile template detail","description":"Get PPSK profile template detail","operationId":"getPPSKProfileDetailTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"PPSK profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePPSKProfileVO"}}}}},"x-order":25},"post":{"tags":["Profiles (Template)"],"summary":"Modify PPSK profile template","description":"Modify PPSK profile template","operationId":"modifyPPSKProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"PPSK profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PpskProfile"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":21},"delete":{"tags":["Profiles (Template)"],"summary":"Delete PPSK profile template","description":"Delete PPSK profile template","operationId":"deletePPSKProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"PPSK profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/ppsk-profile/generate-psk":{"post":{"tags":["Profiles (Template)"],"summary":"Auto Create PSK templates","description":"Auto Create PSK templates","operationId":"autoCreatePPSKTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PpskAutoCreateSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PSK"}}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/portal":{"post":{"tags":["Authentication (Template)"],"summary":"Create portal template","description":"Create new portal template","operationId":"createPortalTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/portal/pics":{"post":{"tags":["Authentication (Template)"],"summary":"Upload portal picture in a site template ","description":"Upload portal picture in a site template ","operationId":"uploadPortalPicTemplate","parameters":[{"name":"type","in":"query","description":"Portal picture type: background/logo/advertisement.","required":true,"schema":{"type":"string"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","description":"Portal picture file.","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePortal Picture Info"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/portal/page":{"post":{"tags":["Authentication (Template)"],"summary":"Import portal page in a site template","description":"Import portal page in a site template","operationId":"uploadPortalPageTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"Portal page file.","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseImportedPortalPageResOpenApiVO"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/oui-profiles":{"get":{"tags":["Profiles (Template)"],"summary":"Get OUI profile template list","description":"Get OUI profile template list.(Pagination)","operationId":"getOuiProfileListTemplate","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOuiGridVOOuiProfileQueryOpenApiVO"}}}}},"x-order":6},"post":{"tags":["Profiles (Template)"],"summary":"Create OUI profile template","description":"Create OUI profile template","operationId":"createOuiProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OuiProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/networks/{networkId}/ports-check":{"post":{"tags":["Wired Network (Template)"],"summary":"Check port binding when modifying network for site template","description":"Check port binding when modifying network for site template","operationId":"checkTemplatePortBindingParamWhenModify","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectPortBindingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListString"}}}}},"x-order":48}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/networks/{networkId}/param-check":{"post":{"tags":["Wired Network (Template)"],"summary":"Check basic parameters when modifying the network","description":"Check basic parameters when modifying the network.","operationId":"checkNetworkTemplateParamWhenModify","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanNetworkOpenApiV3VO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLanNetworkQueryOpenApiV3VO"}}}}},"x-order":44}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/networks/{networkId}/devices/ports":{"post":{"tags":["Wired Network (Template)"],"summary":"Get the port information of the selected device templates when modifying the network for site template","description":"Get the port information of the selected device templates when modifying the network for site template.","operationId":"getSelectDeviceTemplatePortsInfoWhenModify","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectMacsWithVlanVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListSelectDeviceForVlanTemplateVO"}}}}},"x-order":46}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/networks/{networkId}/check":{"post":{"tags":["Wired Network (Template)"],"summary":"Check all parameters and generate configuration when modifying the network template","description":"Check all parameters and generate configuration when modifying the network template.","operationId":"checkTemplateParamAndGetPreConfigWhenModify","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyVlanParamOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVlanPreConfigOpenApiVO"}}}}},"x-order":52}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/networks/{networkId}/auto-select-devices":{"post":{"tags":["Wired Network (Template)"],"summary":"Get auto select devices when modifying network","description":"Get auto select devices when modifying network.","operationId":"getAutoSelectDevicesTemplateWhenModify","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanNetworkOpenApiV3VO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAutoSelectDevicesForVlanVO"}}}}},"x-order":61}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/networks/{networkId}/auto-effect-devices":{"post":{"tags":["Wired Network (Template)"],"summary":"Get auto effect devices when modifying network","description":"Get auto effect devices when modifying network.","operationId":"getAutoEffectDevicesTemplateWhenModify","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanNetworkOpenApiV3VO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAutoEffectDevicesForVlanVO"}}}}},"x-order":60}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/networks/ports-check":{"post":{"tags":["Wired Network (Template)"],"summary":"Check selected ports when creating network for site template","description":"Check selected ports when creating network for site template","operationId":"checkTemplatePortBindingParamWhenCreate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectPortBindingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListString"}}}}},"x-order":47}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/networks/param-check":{"post":{"tags":["Wired Network (Template)"],"summary":"Check basic parameters when creating network template","description":"Check basic parameters when creating network template","operationId":"checkNetworkTemplateParamWhenCreate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanNetworkOpenApiV3VO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLanNetworkQueryOpenApiV3VO"}}}}},"x-order":43}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/networks/devices/ports":{"post":{"tags":["Wired Network (Template)"],"summary":"Get the port information of the selected device templates when creating network for site template","description":"Get the port information of the selected device templates when creating network for site template","operationId":"getSelectDeviceTemplatePortsInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectMacsWithVlanVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListSelectDeviceForVlanTemplateVO"}}}}},"x-order":45}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/networks/confirm":{"post":{"tags":["Wired Network (Template)"],"summary":"Confirm create lan network template","description":"Confirm create lan network template","operationId":"confirmCreateVlanNetworkTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVlanParamOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVlanNetworkIdListVO"}}}}},"x-order":54}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/networks/check":{"post":{"tags":["Wired Network (Template)"],"summary":"Check all parameters and generate configuration when creating network template","description":"Check all parameters and generate configuration when creating network template","operationId":"checkTemplateParamAndGetPreConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVlanParamOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVlanPreConfigOpenApiVO"}}}}},"x-order":51}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/networks/auto-effect-devices":{"post":{"tags":["Wired Network (Template)"],"summary":"Get auto effect devices when creating network","description":"Get auto effect devices when creating network.","operationId":"getAutoEffectDevicesTemplateWhenCreate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanNetworkOpenApiV3VO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAutoEffectDevicesForVlanVO"}}}}},"x-order":59}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/network-security/ips/allow-list":{"post":{"tags":["IDS/IPS (Template)"],"summary":"Create site template's allow list","description":"Create site template's allow list.","operationId":"createTemplateAllowList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/New IPS allow list entry"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":4},"patch":{"tags":["IDS/IPS (Template)"],"summary":"Edit site template's allow list","description":"Modify site template's allow list entry.","operationId":"editTemplateAllowList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Modify IPS allow list entry"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/nat/port-forwardings":{"get":{"tags":["NAT (Template)"],"summary":"Get site template's port forwarding list","description":"Get site template's port forwarding list.","operationId":"getTemplatePortForwardingList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePortForwardingOpenApiGridVOPortForwardingInfoTemplate"}}}}},"x-order":1},"post":{"tags":["NAT (Template)"],"summary":"Create site template's new port forwarding","description":"Create site template's new port forwarding.","operationId":"createTemplatePortForwarding","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortForwardingTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/multi-sites/sync":{"post":{"tags":["Site Template"],"summary":"Batch sync site settings with the site template","description":"Batch sync site settings with the site template.","operationId":"batchSyncSiteWithTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchSyncSitesOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/mac-filters":{"post":{"tags":["MAC Filtering (Template)"],"summary":"Create MAC filtering template","description":"Create MAC filtering template.","operationId":"createMacFilteringTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacFiltering"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/lan/dns":{"get":{"tags":["Wired Network (Template)"],"summary":"Get LAN Dns template list","description":"Get LAN Dns template list.","operationId":"getLanDnsTemplateList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLanDnsGridVOLanDnsOpenApiVO"}}}}},"x-order":23},"post":{"tags":["Wired Network (Template)"],"summary":"Create LAN Dns template","description":"Create lan Dns template","operationId":"createLanDnsTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanDnsOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/lan-vlans":{"post":{"tags":["Wired Network (Template)"],"summary":"Batch create vlans template","description":"Batch create vlans template. Format support: 200, 1-100.","operationId":"createVlans","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Create VLANs"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/lan-profiles":{"get":{"tags":["Wired Network (Template)"],"summary":"Get LAN profile template list","description":"Get LAN profile template list.","operationId":"getLanProfileTemplateList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOLanProfileOpenApiVO"}}}}},"x-order":1},"post":{"tags":["Wired Network (Template)"],"summary":"Create new LAN profile template","description":"Create new LAN profile template.","operationId":"createLanProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanProfileConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseIdVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/lan-networks":{"get":{"tags":["Wired Network (Template)"],"summary":"Get LAN network template list","description":"Get LAN network template list.(Pagination)","operationId":"getLanNetworkTemplateList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLanNetworkOpenApiV2GridVOLanNetworkTemplateQueryOpenApiV2VO"}}}}},"x-order":5},"post":{"tags":["Wired Network (Template)"],"summary":"Create LAN network template","description":"Create lan network template","operationId":"createLanNetworkTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanNetworkTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/lan-multicasts":{"get":{"tags":["Lan Multicast (Template)"],"summary":"Get lan multicast template list","description":"Get lan multicast template list","operationId":"getGridLanMulticastTemplates","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOLanMulticastVO"}}}}},"x-order":1},"post":{"tags":["Lan Multicast (Template)"],"summary":"Create new lan multicast template","description":"Create new lan multicast template","operationId":"createLanMulticastTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanMulticastVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/ip-mac-binds":{"get":{"tags":["IP-MAC Binding (Template)"],"summary":"Get IP-MAC binding template list","description":"Get IP-MAC binding template list.","operationId":"getGridIpMacBindingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOIPMacBinding"}}}}},"x-order":3},"post":{"tags":["IP-MAC Binding (Template)"],"summary":"Create IP-MAC binding template","description":"Create IP-MAC binding template.","operationId":"createIpMacBindingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPMacBinding"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/ip-mac-binds/batch-delete":{"post":{"tags":["IP-MAC Binding (Template)"],"summary":"Batch delete IP-MAC bindings template","description":"Batch delete IP-MAC bindings template.","operationId":"batchDeleteIpMacBindingsTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/batchIds"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/devicetemplates":{"get":{"tags":["Site Template"],"summary":"Get deviceTemplate info list","description":"Get deviceTemplate info list.","operationId":"getGridDeviceTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVODeviceTemplateBriefOpenApiVO"}}}}},"x-order":14},"post":{"tags":["Site Template"],"summary":"create device template","description":"create device template","operationId":"createDeviceTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deviceTemplateAdd"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/devicetemplates/{deviceTemplateId}/batch-unbinddevice":{"post":{"tags":["Site Template"],"summary":"Device template batch unbind devices","description":"Device template batch unbind devices.","operationId":"deviceTemplateUnbindDeviceBatch","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchBindDeviceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BatchBindDeviceResultOpenApiVO"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/devicetemplates/{deviceTemplateId}/batch-sync-config":{"post":{"tags":["Site Template"],"summary":"Device template batch sync config to devices","description":"Device template batch sync config to devices.","operationId":"deviceTemplateSyncConfigBatch","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchBindDeviceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BatchBindDeviceResultOpenApiVO"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/devicetemplates/{deviceTemplateId}/batch-binddevice":{"post":{"tags":["Site Template"],"summary":"Device template batch bind devices","description":"Device template batch bind devices.","operationId":"deviceTemplateBindDeviceBatch","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchBindDeviceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseBatchBindDeviceResultOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/copy":{"post":{"tags":["Site Template"],"summary":"Create Site Template by copying exist site template","description":"Create Site Template by copying exist site template.","operationId":"copySiteTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CopySiteTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CopySiteResultVO"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/copy/batch":{"post":{"tags":["Site Template"],"summary":"Copy site template to customers","description":"Copy the site template to one or more customers (whose site templates the current user has permission to modify). Up to 10 customers can be operated at the same time.","operationId":"copySiteTemplateToCustomers","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCopySiteTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCopySiteTemplateOpenApiResultVO"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/cli/configs/config-id/{configId}/apply":{"post":{"tags":["CLI (Template)"],"summary":"Apply the CLI template configuration","description":"Apply the CLI template configuration","operationId":"applyCliConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"CLI Config ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/cli/config/cli-type/{cliType}/save":{"post":{"tags":["CLI (Template)"],"summary":"Create a new CLI template configuration","description":"Create a new CLI template configuration","operationId":"createCliConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"cliType","in":"path","description":"CLI type should be a value as follows: 0: site CLI; 1: device CLI； 2：model CLI. Site template only supports site CLI. Site template only supports site CLI.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyCliTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/bind-site":{"post":{"tags":["Site Template"],"summary":"Bind site with a site template","description":"Bind site with a site template.","operationId":"bindSiteTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BindSiteOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/batch-unbind":{"post":{"tags":["Site Template"],"summary":"Batch unbind sites from a site template","description":"Batch unbind sites from a site template.","operationId":"unbindSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ BatchUnbindSites"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/bandwidth-control/rules":{"get":{"tags":["Bandwidth Control (Template)"],"summary":"Get bandwidth control template rule list","description":"Get bandwidth control template rule list.","operationId":"getGridBandwidthCtrlRuleTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOBandwidthControlRule"}}}}},"x-order":3},"post":{"tags":["Bandwidth Control (Template)"],"summary":"Create bandwidth control template rule","description":"Create bandwidth control template rule.","operationId":"createBandwidthCtrlRuleTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BandwidthControlRule"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"patch":{"tags":["Bandwidth Control (Template)"],"summary":"Modify bandwidth control template rule index","description":"Modify bandwidth control template rule index.","operationId":"modifyBandwidthCtrlRuleIndexTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransmissionDragSortIndexOpenapiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/applicationControl/rules":{"get":{"tags":["Application Control"],"summary":"Get rule list","description":"Get rule list.","operationId":"getRulesTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field rule name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVORuleResultEntity"}}}}},"x-order":28},"post":{"tags":["Application Control"],"summary":"Create new rule","description":"Create new rule.","operationId":"addRuleTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddRuleEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseRuleResultEntity"}}}}},"x-order":29}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/applicationControl/restrictions":{"get":{"tags":["Application Control"],"summary":"Get application control assigned restriction list","description":"Get application control assigned restriction list with the given omadacId, siteId.","operationId":"getAssignRestrictionsTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVORestrictionResultEntity"}}}}},"x-order":20},"post":{"tags":["Application Control"],"summary":"Create new restriction assigned to lan network","description":"Create new restriction assigned to lan network.","operationId":"addAssignRestrictionTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseRestrictionResultEntity"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/applicationControl/filters":{"get":{"tags":["Application Control"],"summary":"Get filter list","description":"Get filter list.","operationId":"getFiltersTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field filter name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOFilterEntity"}}}}},"x-order":24},"post":{"tags":["Application Control"],"summary":"Create new filter","description":"Create new filter.","operationId":"addFilterTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddFilterEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseFilterEntity"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/ap-oui-rules":{"get":{"tags":["OUI Based VLAN (Template)"],"summary":"Get Ap oui based vlan template list","description":"Get Ap oui based vlan template list.","operationId":"getGridApOuiBasedVlanTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOuiBasedVlanApQueryOpenApiVO"}}}}},"x-order":5},"post":{"tags":["OUI Based VLAN (Template)"],"summary":"Create Ap oui based vlan template","description":"Create Ap oui based vlan template.","operationId":"createApOuiBasedVlanTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OuiBasedVlanApOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/ap-groups":{"get":{"tags":["Wireless Network (Template)"],"summary":"Get AP Group template list","description":"Get AP Group template list","operationId":"getApGroupTemplateList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApGroupGridVOApGroupOpenApiVO"}}}}},"x-order":1},"post":{"tags":["Wireless Network (Template)"],"summary":"Create new AP Group template","description":"Create new AP Group template","operationId":"createApGroupTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAddApGroupResultVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/acls/osg-custom-acls/modifyIndex":{"post":{"tags":["ACL (Template)"],"summary":"Modify gateway custom ACL template index","description":"Modify gateway custom ACL template index","operationId":"modifyOsgCustomAclIndexTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DragSortIndexOpenapiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/acls/osg-acls":{"get":{"tags":["ACL (Template)"],"summary":"Get gateway ACL template list","description":"Get gateway ACL template list.","operationId":"getOsgAclListTemplate","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOGatewayACLInfo"}}}}},"x-order":4},"post":{"tags":["ACL (Template)"],"summary":"Create new gateway template ACL","description":"Create new gateway template ACL.","operationId":"createOsgAclTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayACLConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/acls/modifyIndex":{"post":{"tags":["ACL (Template)"],"summary":"Modify ACL template Index","description":"Modify ACL template Index.","operationId":"modifyAclIndexTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DragSortIndexTemplateOpenapiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/acls/eap-acls":{"get":{"tags":["ACL (Template)"],"summary":"Get eap ACL template list","description":"Get eap ACL template list.","operationId":"getEapAclListTemplate","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOEapACLInfo"}}}}},"x-order":1},"post":{"tags":["ACL (Template)"],"summary":"Create new eap template ACL","description":"Create new eap template ACL.","operationId":"createEapAclTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EapACLConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites":{"get":{"tags":["Site"],"summary":"Get site list","description":"Get site list","operationId":"getSiteList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}},{"name":"filters.tag","in":"query","description":"Filter query parameters, support field tag ID","required":false,"schema":{"type":"string"}},{"name":"filters.type","in":"query","description":"Filter query parameters, support field site type. 0: basic site; 1: pro site.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOSiteSummaryInfo"}}}}},"x-order":1},"post":{"tags":["Site"],"summary":"Create new site","description":"Create new site","operationId":"createNewSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSiteEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/wlans":{"get":{"tags":["Wireless Network"],"summary":"Get WLAN Group list","description":"Get WLAN Group list, Legacy note: “WLAN Group” is the legacy name of “AP Group”. This endpoint will be deprecated in future releases. Please use Get AP Group list.","operationId":"getWlanGroupList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListWlanGroupOpenApiVO"}}}}},"deprecated":true,"x-order":65},"post":{"tags":["Wireless Network"],"summary":"Create new WLAN Group","description":"Create new WLAN Group, Legacy note: “WLAN Group” is the legacy name of “AP Group”. This endpoint will be deprecated in future releases. Please use Create new AP Group.","operationId":"createWlanGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWlanGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"deprecated":true,"x-order":66}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/wlans/{wlanId}/ssids":{"get":{"tags":["Wireless Network"],"summary":"Get SSID list","description":"Get SSID list of Wlan group, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Get SSID list by site.","operationId":"getSsidList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOSsidOpenApiVO"}}}}},"deprecated":true,"x-order":7},"post":{"tags":["Wireless Network"],"summary":"Create new SSID","description":"Create new SSID, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Create new SSID v2.","operationId":"createSsid","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSsidOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"deprecated":true,"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssids/deviceTypeChanged":{"get":{"tags":["app"],"summary":"Query SSID Names with deviceType changed","description":"Query SSID Names with deviceType changed","operationId":"querySsidChangedDeviceTypeBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceTypeChangedSsidOpenApiVO"}}}}},"x-order":12},"post":{"tags":["app"],"operationId":"cleanSsidChangedNotifications","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":18},"delete":{"tags":["app"],"summary":"Clean SSIDs with deviceType changed","description":"Batch delete invalid gateway SSIDs and clean deviceTypeChanged field of SSIDs","operationId":"cleanSsidChangedDeviceTypeBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssid-operation":{"get":{"tags":["app"],"summary":"Get SSID List By Site","description":"Get SSID List of Site","operationId":"listSsidBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSsidVO"}}}}},"x-order":7},"post":{"tags":["app"],"summary":"Create SSID By Site","description":"Create SSID of Site","operationId":"createSsidBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SsidVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/quick-create-ssid":{"post":{"tags":["app"],"summary":"Quick create ssid","description":"quick create ssid","operationId":"quickCreateSsid","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuickCreateSsidOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/wired-networks/disable-nat":{"post":{"tags":["Disable Nat"],"summary":"Create Disable Nat","description":"Create Disable Nat.","operationId":"addDisableNat_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Disable Nat"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/wifi/health/client/list":{"post":{"tags":["Health"],"summary":"Get site wifi top k device/client ","description":"Get site wifi top k device/client","operationId":"getWifiClientInfoList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WifiDeviceAndClientQueryVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/WifiClientInfoVO"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/wan/networks/isp-scan":{"post":{"tags":["Wired Network"],"summary":"Start Isp scan","description":"Start ISP scan.","operationId":"startIspScan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IspScanStartOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":46}},"/openapi/v1/{omadacId}/sites/{siteId}/wan/networks/band-scan":{"post":{"tags":["Wired Network"],"summary":"Start Band scan","description":"Start band scan.","operationId":"startBandScan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BandScanStart"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":44}},"/openapi/v1/{omadacId}/sites/{siteId}/wan/bandwidth":{"post":{"tags":["Dashboard"],"summary":"Set site dashboard wan bandwidth","description":"Set site dashboard wan bandwidth of the site with the given omadacId and siteId.","operationId":"configBandwidthForWanPorts","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WanPortBandwidthVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":27}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/wireguards":{"get":{"tags":["Wireguard VPN"],"summary":"Get wireguard list","description":"Get wireguard list. This interface has been deprecated. Please use the following interfaces instead: Get VPN Site to Site summary list and Get site-to-site VPN detail info.","operationId":"listWireguard","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"searchKey","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOWireguardDetailOpenApiVO"}}}}},"deprecated":true,"x-order":2},"post":{"tags":["Wireguard VPN"],"summary":"Create new wireguard","description":"Create new wireguard. This interface has been deprecated. Please use the following interfaces instead: Create site-to-site VPN by manual.","operationId":"createWireguard","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WireguardOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"deprecated":true,"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/wireguard-peers":{"get":{"tags":["Wireguard VPN"],"summary":"Get wireguard peer list","description":"Get wireguard peer list. This interface has been deprecated. Please use the following interfaces instead: Get site-to-site VPN detail info.","operationId":"listPeer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"searchKey","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWireguardPeerOpenApiGridVOWireguardPeerDetailOpenApiVO"}}}}},"deprecated":true,"x-order":7},"post":{"tags":["Wireguard VPN"],"summary":"Create new wireguard peer","description":"Create new wireguard peer. This interface has been deprecated. Please use the following interfaces instead: Create site-to-site VPN by manual or Modify site-to-site VPN by manual.","operationId":"createPeer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WireguardPeerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"deprecated":true,"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/users":{"get":{"tags":["VPN"],"summary":"Get VPN user list","description":"Get VPN user list. This interface has been deprecated. Please use the following interfaces instead: Get VPN user list V2. This interface had been deprecated.","operationId":"getGridVpnUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"searchKey","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnUserOpenApiGridVOVpnUserResponse"}}}}},"deprecated":true,"x-order":57},"post":{"tags":["VPN"],"summary":"Create VPN user","description":"Create VPN user. This interface has been deprecated. Please use the following interface instead: Create VPN user V2. This interface had been deprecated.","operationId":"createVpnUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnUser"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":58},"delete":{"tags":["VPN"],"summary":"Batch delete VPN user","description":"Batch delete VPN user.","operationId":"batchDeleteVpnUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchSelectVpnUserVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/stats/sslvpn/tunnel/{tunnelId}/lock":{"post":{"tags":["VPN"],"summary":"Lock SSL VPN tunnel","description":"Lock SSL VPN tunnel by VPN ID.","operationId":"lockSslVpnTunnel","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"tunnelId","in":"path","description":"SSL VPN tunnel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":34}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/stats/sslvpn/tunnel/{tunnelId}/disconnect":{"post":{"tags":["VPN"],"summary":"Disconnect SSL VPN tunnel","description":"Disconnect SSL VPN tunnel by VPN ID.","operationId":"disconnectSslVpnTunnel","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"tunnelId","in":"path","description":"SSL VPN tunnel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":35}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ssl-vpn-server/users":{"get":{"tags":["SSL VPN"],"summary":"Get user list for SSL VPN server","description":"Get user list for SSL VPN server. This interface has been deprecated. Please use the following interfaces instead: Get VPN user list V2 or Get user list by VPN server ID.","operationId":"getGridSslVpnServerUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSslVpnUserOpenApiGridVOSslVpnUserEntity"}}}}},"deprecated":true,"x-order":15},"post":{"tags":["SSL VPN"],"summary":"Create SSL VPN user","description":"Create SSL VPN user. This interface has been deprecated. Please use the following interfaces instead: Create VPN user V3.","operationId":"createSslVpnUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SslVpnUserConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ssl-vpn-server/user-groups":{"get":{"tags":["SSL VPN"],"summary":"Get user group list for SSL VPN server","description":"Get user group list for SSL VPN server.","operationId":"getGridSslVpnServerUserGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSslVpnUserGroupGridVOSslVpnUserGroupEntity"}}}}},"x-order":11},"post":{"tags":["SSL VPN"],"summary":"Create SSL VPN user group","description":"Create SSL VPN user group.","operationId":"createSslVpnUserGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SslVpnUserGroupConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":12},"delete":{"tags":["SSL VPN"],"summary":"Batch delete SSL VPN user group","description":"Batch delete SSL VPN user group.","operationId":"batchDeleteSslVpnUserGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchSelectSslUserVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":33}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ssl-vpn-server/resources":{"get":{"tags":["SSL VPN"],"summary":"Get resource list for SSL VPN server","description":"Get resource list for SSL VPN server.","operationId":"getGridSslVpnServerResource","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOSslVpnResourceEntity"}}}}},"x-order":3},"post":{"tags":["SSL VPN"],"summary":"Create SSL VPN resource","description":"Create SSL VPN tunnel resource.","operationId":"createSslVpnResource","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SslVpnResourceConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ssl-vpn-server/resource-groups":{"get":{"tags":["SSL VPN"],"summary":"Get resource group list for SSL VPN server","description":"Get resource group list for SSL VPN server.","operationId":"getGridSslVpnServerResourceGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOSslVpnResourceGroup"}}}}},"x-order":7},"post":{"tags":["SSL VPN"],"summary":"Create SSL VPN resource group","description":"Create SSL VPN tunnel resource group.","operationId":"createSslVpnResourceGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SslVpnResourceGroupConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ssl-vpn-server/locked-users":{"get":{"tags":["SSL VPN"],"summary":"Get locked user list for SSL VPN server","description":"Get locked user list for SSL VPN server.","operationId":"getGridLockedSslVpnServerUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name.","required":false,"schema":{"type":"string"}},{"name":"sorts.userName","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.ip","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.leftLockTime","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOSSL VPN Lock Entity"}}}}},"x-order":19},"post":{"tags":["SSL VPN"],"summary":"Create SSL VPN locked user","description":"Create SSL VPN locked user.","operationId":"createLockedSslVpnUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SslVpnLockConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ssl-vpn-server/locked-tunnels":{"get":{"tags":["SSL VPN"],"summary":"Get locked SSL VPN tunnel.","description":"Get locked SSL VPN tunnel.","operationId":"getLockedSslVpnTunnuels","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOSSL VPN Lock Entity"}}}}},"x-order":29},"post":{"tags":["SSL VPN"],"summary":"Create locked SSL VPN tunnel","description":"Create locked SSL VPN tunnel.","operationId":"createLockedSslVpnTunnuel","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SslVpnLockCreateAndModifyOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":28},"delete":{"tags":["SSL VPN"],"summary":"Batch delete SSL VPN locked tunnel","description":"Batch delete SSL VPN locked tunnel.","operationId":"batchDeleteLockedSslVpnTunnel","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchSelectSslUserVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":34}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/site-to-site-vpns":{"get":{"tags":["VPN"],"summary":"Get site-to-site VPN list","description":"Get site-to-site VPN list. This interface has been deprecated. Please use the following interfaces instead: Get VPN Site to Site summary list and Get site-to-site VPN detail info. This interface had been deprecated.","operationId":"getSiteToSiteVpnList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListSiteToSiteVpn"}}}}},"deprecated":true,"x-order":39},"post":{"tags":["VPN"],"summary":"Create site-to-site VPN","description":"Create site-to-site VPN. This interface has been deprecated. Please use the following interfaces instead: Create site-to-site VPN by auto or Create site-to-site VPN by manual. This interface had been deprecated.","operationId":"createSiteToSiteVpn","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteToSiteVpn"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":40}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ipsec_failovers":{"get":{"tags":["VPN"],"summary":"Get IPsec failover list","description":"Get IPsec failover list. This interface has been deprecated. Please use the following interfaces instead: Get VPN Site to Site summary list and Get site-to-site VPN detail info. This interface had been deprecated.","operationId":"getGridIpsecFailover","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOIPsecFailover Information"}}}}},"deprecated":true,"x-order":63},"post":{"tags":["VPN"],"summary":"Create IPsec failover","description":"Create IPsec failover. This interface has been deprecated. Please use the following interfaces instead: Create site-to-site VPN by manual or Modify site-to-site VPN by manual. This interface had been deprecated.","operationId":"createIpsecFailover","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPsecFailover configuration"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":64}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/defaultValue":{"post":{"tags":["VPN"],"summary":"Get default value for VPN","description":"Get default value for VPN.","operationId":"getVpnDefaultValue","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnDefaultValueReqVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnDefaultValueRespVO"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/client-to-site-vpn-servers":{"get":{"tags":["VPN"],"summary":"Get client-to-site VPN server list","description":"Get client-to-site VPN server list. This interface has been deprecated. Please use the following interfaces instead: Get VPN Server summary list and Get client-to-site VPN server detail info. This interface had been deprecated.","operationId":"getClientToSiteVpnServerList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnOpenApiGridVOClientToSiteVpnServer"}}}}},"deprecated":true,"x-order":43},"post":{"tags":["VPN"],"summary":"Create client-to-site VPN server","description":"Create client-to-site VPN server. This interface has been deprecated. Please use the following interfaces instead: Create client-to-site VPN server V2. This interface had been deprecated.","operationId":"createClientToSiteVpnServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientToSiteVpnServer"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":44}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/client-to-site-vpn-clients":{"get":{"tags":["VPN"],"summary":"Get client-to-site VPN client list","description":"Get client-to-site VPN client list. This interface has been deprecated. Please use the following interfaces instead: Get VPN Client summary list and Get client-to-site VPN client detail info. This interface had been deprecated.","operationId":"getClientToSiteVpnClientList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnOpenApiGridVOClientToSiteVpnClient"}}}}},"deprecated":true,"x-order":47},"post":{"tags":["VPN"],"summary":"Create client-to-site VPN client","description":"Create client-to-site VPN client. This interface has been deprecated. Please use the following interfaces instead: Create client-to-site VPN client V2. This interface had been deprecated.","operationId":"createClientToSiteVpnClient","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientToSiteVpnClient"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":48}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/checkValue":{"post":{"tags":["VPN"],"summary":"Check whether vpn value is available","description":"Check whether vpn value is available.","operationId":"checkValueAvailable","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnValueAvailableVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/checkUsed":{"post":{"tags":["VPN"],"summary":"Check used function for multiple VPN items","description":"Check used function for multiple VPN items.","operationId":"checkUsedInVpns","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchSelectVpnVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnListUsedFunctionOpenApiVO"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/certificate":{"post":{"tags":["VPN"],"summary":"Upload VPN certificate file","description":"Upload VPN certificate file. This interface has been deprecated. Please use the following interfaces instead: Upload VPN certificate file V2. This interface had been deprecated.","operationId":"uploadVpnCertificateFile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"Client VPN certificate file (exported from the VPN server). OpenVPN Client only supports .ovpn files; WireGuard Client only supports .conf files.","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnCertificateVO"}}}}},"deprecated":true,"x-order":55}},"/openapi/v1/{omadacId}/sites/{siteId}/voip/telephone-book":{"get":{"tags":["VoIP"],"summary":"Get Voip TelephoneBook List","description":"Get Voip TelephoneBook List.","operationId":"getVoipTelephoneBook","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOVoipTelephoneBookSetting"}}}}},"x-order":3},"post":{"tags":["VoIP"],"summary":"Create New Contact Person","description":"Create New Contact Person.","operationId":"createVoipTelephoneBook","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoipContactPersonSettings"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/voip/telephone-book/batch-delete":{"post":{"tags":["VoIP"],"summary":"Batch Delete Contact Person","description":"Batch Delete Contact Person.","operationId":"batchDeleteVoipTelephoneBook","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoipTelephoneBookBatchSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/voip/call-log-enable":{"get":{"tags":["VoIP"],"summary":"Get Voip CallLog Setting","description":"Get Voip CallLog Setting.","operationId":"getVoipCallLogEnable_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVoipCallLogEnableSetting"}}}}},"x-order":8},"post":{"tags":["VoIP"],"summary":"Modify Voip CallLog Setting","description":"Modify Voip CallLog Setting.","operationId":"modifyVoipCallLogEnable_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoipCallLogEnableSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/vigis/{vigiMac}/vigi-link-topology":{"post":{"tags":["Client"],"summary":"Get VIGI device link topology","description":"Get VIGI device link topology.","operationId":"getVigiTopology","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vigiMac","in":"path","description":"VIGI device MAC","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListClient Topology Nodes Info"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sites/{siteId}/vigi-stat-detail/{vigiMac}/hourly":{"post":{"tags":["Client"],"summary":"Get VIGI device statistical data details at a hourly interval.","description":"Get VIGI device statistical data details at a hourly interval.","operationId":"getVigiDetailStatHourly","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vigiMac","in":"path","description":"VIGI device MAC","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client Stat Query"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClient Statistical Data Detail Result"}}}}},"x-order":26}},"/openapi/v1/{omadacId}/sites/{siteId}/vigi-stat-detail/{vigiMac}/daily":{"post":{"tags":["Client"],"summary":"Get VIGI device statistical data details at a daily interval.","description":"Get VIGI device statistical data details at a daily interval.","operationId":"getVigiDetailStatDaily","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vigiMac","in":"path","description":"VIGI device MAC","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client Stat Query"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClient Statistical Data Detail Result"}}}}},"x-order":27}},"/openapi/v1/{omadacId}/sites/{siteId}/vigi-stat-detail/{vigiMac}/5Min":{"post":{"tags":["Client"],"summary":"Get VIGI device statistical data details at a 5-minute interval.","description":"Get VIGI device statistical data details at a 5-minute interval.","operationId":"getVigiDetailStat5Min","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vigiMac","in":"path","description":"VIGI device MAC","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client Stat Query"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClient Statistical Data Detail Result"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sites/{siteId}/url-filters":{"post":{"tags":["URL Filtering"],"summary":"Create URL filtering rule","description":"Create URL filtering rule.","operationId":"createUrlFilteringRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UrlFilteringOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":3},"patch":{"tags":["URL Filtering"],"summary":"Modify URL filtering rule index","description":"Modify URL filtering rule index.","operationId":"modifyUrlFilteringRuleIndex","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UrlDragSortIndexOpenapiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/upgrade-schedules":{"get":{"tags":["Schedule"],"summary":"Get upgrade schedule list","description":"Get upgrade schedule list.","operationId":"getUpgradeScheduleList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListUpgradeScheduleQueryOpenApiVO"}}}}},"x-order":15},"post":{"tags":["Schedule"],"summary":"Create new upgrade schedule","description":"Create new upgrade schedule","operationId":"createUpgradeSchedule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpgradeScheduleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/time-range-profiles":{"get":{"tags":["Profiles"],"summary":"Get time range profile list","description":"Get time range profile list","operationId":"getTimeRangeList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListTimeRangeProfileOpenApiVO"}}}}},"x-order":26},"post":{"tags":["Profiles"],"summary":"Create time range profile","description":"Create time range profile","operationId":"createTimeRangeProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTimeRangeProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":27}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/vrfs":{"get":{"tags":["Switch"],"summary":"Get the vrfs on the switch","description":"Get the vrfs on the switch.","operationId":"getGridVrf","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOswVrfOpenApiVO"}}}}},"x-order":61},"post":{"tags":["Switch"],"summary":"Create new vrf","description":"Create new vrf.","operationId":"createOswVrf","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswVrfConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/stp/instance-detail":{"post":{"tags":["Switch"],"summary":"Get StpInstanceDetail","description":"Get StpInstanceDetail.","operationId":"getStpInstancesDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StpInstanceDetailVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":67}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/staticRoutings":{"get":{"tags":["Switch"],"summary":"Get grid switch staticRouting","description":"Get grid switch staticRouting.","operationId":"getGridStaticRouting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswStaticRoutingGridVOOswStaticRoutingVO"}}}}},"x-order":74},"post":{"tags":["Switch"],"summary":"Create switch staticRouting","description":"Create switch staticRouting.","operationId":"createStaticRouting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswStaticRoutingConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":75}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/networks":{"get":{"tags":["Switch"],"summary":"Query switch vlan interface infos.","description":"Query switch vlan interface infos.","operationId":"listSwitchNetworks","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswNetworkGridOswNetworkOpenApi"}}}}},"x-order":23},"post":{"tags":["Switch"],"summary":"Batch modify switch vlan interfaces.","description":"Batch modify switch vlan interfaces.","operationId":"batchApplySwitchNetwork","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchApplyOswNetworkOpenApi"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/networks/{networkId}":{"post":{"tags":["Switch"],"summary":"Modify switch network config.","description":"Modify switch network config.","operationId":"modifySwitchNetwork","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Switch network ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswNetworkOpenApi"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/multi-ports/poe-recovery":{"post":{"tags":["Switch"],"summary":"Switch port poe recovery.","description":"Switch port poe recovery.","operationId":"batchPortPoERecovery","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswPoeRecoverOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswPoeResultOpenApiVO"}}}}},"x-order":26}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/loopback-interface":{"post":{"tags":["Switch"],"summary":"Create Loopback Interface","description":"Create Loopback Interface.","operationId":"createLoopbackInterface","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswLoopbackInterfaceVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswLoopbackInterfaceResultOpenApiVO"}}}}},"x-order":68}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/interfaces/pmtud":{"post":{"tags":["Switch"],"summary":"Modify Path MTU Discovery","description":"modify Path MTU Discovery.","operationId":"modifyPmtudStatus_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswPmtudVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":71}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/rpvst-instances":{"post":{"tags":["Switch"],"summary":"Get Batch Rpvst Instances","description":"Get Batch Rpvst Instances.","operationId":"getBatchRpvstInstances","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":66}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/ports/select":{"post":{"tags":["Switch"],"summary":"Get the switches and ports detail in batches","description":"Get the switches and ports detail in batches.","operationId":"getBatchSelectOswDetailsView","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiOswPortSelectVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOswDetailBatchSelectedVO"}}}}},"x-order":40}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/port-tag":{"get":{"tags":["Switch"],"summary":"Get switch port label list","description":"Get switch port label list.","operationId":"getPortTags","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PortTagOpenApiVO"}}}}}},"x-order":51},"post":{"tags":["Switch"],"summary":"Create new switch port label","description":"Create new switch port label.","operationId":"addPortTag","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePortTagOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PortTagOpenApiVO"}}}}},"x-order":48},"delete":{"tags":["Switch"],"summary":"Delete an existing switch port label","description":"Delete an existing switch port label.","operationId":"deletePortTag","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePortTagOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":50},"patch":{"tags":["Switch"],"summary":"Modify an existing switch port label","description":"Modify an existing switch port label.","operationId":"modifyPortTag","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortTagOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":49}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/multi-ports/clear-counters":{"post":{"tags":["Switch"],"summary":"Clear the switches ports counters","description":"Clear the switches ports counters.","operationId":"clearOswPortCounters","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearCountersVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseString"}}}}},"x-order":41}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/exist-network":{"post":{"tags":["Switch"],"summary":"Get the networks intersections existing on multiple switches","description":"Get the networks intersections existing on multiple switches.","operationId":"getBatchSwitchExistNetworks","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswMacListVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLanNetworkOpenApiV2GridVOLanNetworkSplitOpenApiVO"}}}}},"x-order":53}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/details":{"post":{"tags":["Switch"],"summary":"Get the details of osws with given omadacid, siteid and macs and stackIds.","description":"Get the details of osws with given omadacid, siteid and macs and stackIds.","operationId":"getOswsDetails","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswDetailOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":54}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-rule":{"get":{"tags":["Switch QoS"],"summary":"Get switch QoS rules.","description":"Get switch QoS rules.","operationId":"getQosRules","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field ","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOswQosRuleVO"}}}}},"x-order":2},"post":{"tags":["Switch QoS"],"summary":"Create switch QoS rule.","description":"Create switch QoS rule.","operationId":"createQosRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswQosRuleVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswQosRuleResultVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-rule/device-info":{"post":{"tags":["Switch QoS"],"summary":"Get switch QoS selected device brief info.","description":"Get switch QoS selected device brief info.","operationId":"getSelectedDeviceBriefInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswMacListVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListSelectedOswBriefVO"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-oui-rules":{"get":{"tags":["OUI Based VLAN"],"summary":"Get Switch oui based vlan list","description":"Get Switch oui based vlan list.","operationId":"getGridSwitchOuiBasedVlan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOuiBasedVlanSwitchQueryOpenApiVO"}}}}},"x-order":1},"post":{"tags":["OUI Based VLAN"],"summary":"Create Switch oui based vlan","description":"Create Switch oui based vlan.","operationId":"createSwitchOuiBasedVlan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OuiBasedVlanSwitchOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-oui-rules/switches/{ouiBasedVlanId}/check":{"post":{"tags":["OUI Based VLAN"],"summary":"Get whether exist at least one port or lag with allow all network tags for oui based vlan modification.","description":"Get whether exist at least one port or lag with allow all network tags for oui based vlan modification.","operationId":"getWhetherExistAllowAllPortOrLagsForRuleModification","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ouiBasedVlanId","in":"path","description":"Oui Based Vlan ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OuiBasedVlanRuleVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOuiBasedVlanOswPortNetworkTagsSettingVO"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-oui-rules/switches/check":{"post":{"tags":["OUI Based VLAN"],"summary":"Get whether exist at least one port or lag with allow all network tags for oui based vlan creation.","description":"Get whether exist at least one port or lag with allow all network tags for oui based vlan creation.","operationId":"getWhetherExistAllowAllPortOrLagsForRuleCreation","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OuiBasedVlanRuleVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOuiBasedVlanOswPortNetworkTagsSettingVO"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-oui-rules/enable-auto-add-vlan":{"post":{"tags":["OUI Based VLAN"],"summary":"Enable the site and device auto add vlan.","description":"Enable the site and device auto add vlan.","operationId":"enableAutoAddVlan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/stat/{deviceMac}/client-stat-5min":{"post":{"tags":["Client Insight"],"summary":"Get device client 5 min stat.","description":"Obtain the 5-minute sampling statistics of the clients.","operationId":"getDeviceClient5MinStat","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"deviceType","in":"query","description":"Device type.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceClientStatQueryOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListDeviceClientStatVO"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/stat/switches/{deviceMac}/chart":{"post":{"tags":["Statistic"],"summary":"Get switch statistics chart","description":"Display statistics based on the time granularity calculated by start and end times:\nWithin 26 hours, 5 minutes of data is displayed\n26 hours to 7 days 2 hours, showing hourly statistics\n7 days 2 hours to 120 days 2 hours, showing daily statistics\n120 days 2 hours or more, showing weekly statistics\n","operationId":"getSwitchStatChart","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswStatQueryOpenApiDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswStatOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/stat/stacks/{stackId}/client-stat":{"post":{"tags":["Client Insight"],"summary":"Get stack client stat.","description":"Obtain the sampling statistics of the clients.","operationId":"getStackClientStat","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceClientStatQueryOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListDeviceClientStatVO"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/stat/stack/{stackId}":{"post":{"tags":["Statistic"],"summary":"Get switch stack statistics","description":"Get switch stack statistics","operationId":"getOswStackDetailStat","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswStackStatQueryVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOswStackDetailStatVO"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/stat/stack/{stackId}/chart":{"post":{"tags":["Statistic"],"summary":"Get stack statistics chart","description":"Display statistics based on the time granularity calculated by start and end times:\nWithin 26 hours, 5 minutes of data is displayed\n26 hours to 7 days 2 hours, showing hourly statistics\n7 days 2 hours to 120 days 2 hours, showing daily statistics\n120 days 2 hours or more, showing weekly statistics\n","operationId":"getStackStatChart","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswStackStatQueryOpenApiDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOswStackMemberStatVO"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/stat/olts/{deviceMac}/chart":{"post":{"tags":["Statistic"],"summary":"Get olt statistics chart","description":"Display statistics based on the time granularity calculated by start and end times:\nWithin 26 hours, 5 minutes of data is displayed\n26 hours to 7 days 2 hours, showing hourly statistics\n7 days 2 hours to 120 days 2 hours, showing daily statistics\n120 days 2 hours or more, showing weekly statistics\n","operationId":"getOltStatChart","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OltStatQueryOpenApiDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOltStatOpenApiVO"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/stat/olt/{deviceMac}/ddm/info":{"post":{"tags":["OLT"],"summary":"Get DDM(Digital Diagnostic Monitoring) status list of OLT port list","description":"Get DDM(Digital Diagnostic Monitoring) status list of OLT port list","operationId":"getOltPortsDDMStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DDMStatusRequestVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListDDMStatusResultVO"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/stat/dpi/clients/trafficList":{"post":{"tags":["Application Control"],"summary":"Get clients traffic list","description":"Get clients traffic list.","operationId":"getClientTrafficList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientTrafficOpenApiQueryDataV2VO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientTrafficGridVOClientUpDownTrafficDetailOpenApiVO"}}}}},"x-order":44}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks":{"get":{"tags":["Stack"],"summary":"Get stack list","description":"Get stack list.","operationId":"getGridOswStackList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOswStackVO"}}}}},"x-order":1},"post":{"tags":["Stack"],"summary":"Create Switch Stack","description":"Create Switch Stack.","operationId":"createOswStack","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswStackConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/{stackId}/vrfs":{"get":{"tags":["Stack"],"summary":"Get stack vrf page","description":"Get stack vrf page","operationId":"getStackGridVrf","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GridVOOswVrfOpenApiVO"}}}}},"x-order":34},"post":{"tags":["Stack"],"summary":"Create new stack vrf","description":"Create new stack vrf","operationId":"createStackVrf","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswVrfVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"x-order":35}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/{stackId}/staticRoutings":{"get":{"tags":["Stack"],"summary":"Get grid stack staticRouting","description":"Get grid stack staticRouting.","operationId":"getGridStackStaticRouting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswStaticRoutingGridVOOswStaticRoutingVO"}}}}},"x-order":6},"post":{"tags":["Stack"],"summary":"Create stack staticRouting","description":"Create stack staticRouting.","operationId":"createStackStaticRouting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswStaticRoutingConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/{stackId}/remember":{"get":{"tags":["Stack"],"summary":"Get stack remember Config","description":"Get stack remember Config.","operationId":"getStackRememberMe","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceRememberConfig"}}}}},"x-order":1},"post":{"tags":["Stack"],"summary":"Modify stack remember Config","description":"Modify stack remember Config.","operationId":"modifyStackRememberMe","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceRememberConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/{stackId}/ports/config":{"post":{"tags":["Stack"],"summary":"Batch modify stack port","description":"Batch modify stack port. This interface has been deprecated. Please use the following interface instead: Batch modify stack port V2","operationId":"batchModifyOswStackPorts","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchStackPortSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/{stackId}/networks":{"get":{"tags":["Stack"],"summary":"Get stack vlan interface List","description":"Get stack vlan interface List.","operationId":"getStackNetworkList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswNetworkGridOswNetworkOpenApi"}}}}},"x-order":19},"post":{"tags":["Stack"],"summary":"Batch modify stack vlan interface status","description":"Batch modify stack vlan interface status.","operationId":"batchApplyStackNetworks","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchApplyStackNetworkOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/detect":{"post":{"tags":["Stack"],"summary":"Detect switch stacks members for all stacks","description":"Detect switch stacks members for all stacks.","operationId":"detectSwitchStackMembersForAllStacks","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/detect/{stackId}":{"post":{"tags":["Stack"],"summary":"Detect switch stack members","description":"Detect switch stack members.","operationId":"detectSwitchStackMembers","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/stack/{stackId}/stp/instance-detail":{"post":{"tags":["Stack"],"summary":"Get Stack StpInstanceDetail","description":"Get Stack StpInstanceDetail.","operationId":"getRpvstInstancesDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StpInstanceDetailVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":39}},"/openapi/v1/{omadacId}/sites/{siteId}/stack/{stackId}/loopback-interface":{"post":{"tags":["Stack"],"summary":"Create Stack Loopback Interface","description":"Create Stack Loopback Interface.","operationId":"createLoopbackInterface_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswLoopbackInterfaceVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswLoopbackInterfaceResultOpenApiVO"}}}}},"x-order":40}},"/openapi/v1/{omadacId}/sites/{siteId}/stack/{stackId}/interfaces/pmtud":{"post":{"tags":["Stack"],"summary":"Modify Stack Path MTU Discovery","description":"modify Stack Path MTU Discovery.","operationId":"modifyPmtudStatus_2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswPmtudVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":43}},"/openapi/v1/{omadacId}/sites/{siteId}/site/reset/log-notification":{"post":{"tags":["Log"],"summary":"Reset site log notification","description":"Reset site log notification.","operationId":"resetLogSettingSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/sim/sms/send":{"post":{"tags":["SIM"],"summary":"Send SMS message","description":"Send SMS message.","operationId":"sendSmsMessage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessage"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/sim/sms/operate":{"post":{"tags":["SIM"],"summary":"Operate SMS message","description":"Operate SMS message.","operationId":"operateSmsMessage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperateMessage"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/sim/sms/export":{"post":{"tags":["SIM"],"summary":"Export SMS message","description":"Export SMS message.","operationId":"exportSmsMessage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportMessage"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/sim/correct":{"post":{"tags":["SIM"],"summary":"Correct SIM data","description":"Correct SIM data.","operationId":"correctSimQuota","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrectSimQuota"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voip-devices/{deviceMac}/telephone-number/{phoneNumberId}":{"post":{"tags":["VoIP"],"summary":"Delete Telephone Number","description":"Delete Telephone Number.","operationId":"deleteTelephoneNumber","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"phoneNumberId","in":"path","description":"phone Number ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTelephoneNumber"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":32}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voip-devices/{deviceMac}/bind-telephone-number":{"post":{"tags":["VoIP"],"summary":"Bind Telephone Number","description":"Bind Telephone Number.","operationId":"bindTelephoneNumber","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BindNumberList"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":31}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voip-devices/telephone-number/import":{"post":{"tags":["VoIP"],"summary":"Import telephone number list from file","description":"Import telephone number list from existed file.","operationId":"importTelephoneNumberListFromFile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":34}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/provider-profiles":{"post":{"tags":["VoIP"],"summary":"Create new provider profile","description":"Create new provider profile.","operationId":"createProviderProfile_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProviderProfileEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/provider-profiles/delete":{"post":{"tags":["VoIP"],"summary":"Delete provider profile(s)","description":"Delete provider profile(s).","operationId":"deleteProviderProfiles","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmBindedDevicesEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListProfilesBindedDeviceInfo"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/digit-map":{"get":{"tags":["VoIP"],"summary":"Get digit map profile list","description":"Get digit map profile list.","operationId":"getDigitMapProfiles","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListDigitMapProfileInfo"}}}}},"x-order":16},"post":{"tags":["VoIP"],"summary":"Create new digit map profile","description":"Create new digit map profile.","operationId":"createDigitMapProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDigitMapProfileEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/digit-map/delete":{"post":{"tags":["VoIP"],"summary":"Delete digit map profile","description":"Delete digit map profile.","operationId":"deleteDigitMapProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteDigitMapProfileEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListProfilesBindedDeviceInfo"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/call-forwarding":{"post":{"tags":["VoIP"],"summary":"Add call forwarding rules","description":"Add call forwarding rules","operationId":"addCallForwardingRule_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallForwardingRule"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAddCallForwardingRuleResp"}}}}},"x-order":44},"delete":{"tags":["VoIP"],"summary":"Delete call forwarding rules","description":"Delete call forwarding rules","operationId":"deleteCallForwardingRule_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallForwardingRules"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVoid"}}}}},"x-order":46},"patch":{"tags":["VoIP"],"summary":"Modify call forwarding rules","description":"Modify call forwarding rules","operationId":"modifyCallForwardingRule_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallForwardingRule"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVoid"}}}}},"x-order":45}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/call-blocking":{"get":{"tags":["VoIP"],"summary":"Get call blocking profile list","description":"Get call blocking profile list.","operationId":"getCallBlockingProfiles_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListCallBlockingProfileEntity"}}}}},"x-order":20},"post":{"tags":["VoIP"],"summary":"Create new call blocking profile","description":"Create new call blocking profile.","operationId":"createCallBlockingProfile_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallBlockingProfileEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/call-blocking/delete":{"post":{"tags":["VoIP"],"summary":"Delete call blocking profile","description":"Delete call blocking profile.","operationId":"deleteCallBlockingProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallBlockingProfileEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListProfilesBindedDeviceInfo"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/virtual-wans":{"get":{"tags":["Wired Network"],"summary":"Query virtual WAN list","description":"Query virtual WAN list.","operationId":"getGridVirtualWan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVirtualWanGridOpenApiVOVirtualWanInfoOpenApiVO"}}}}},"x-order":32},"post":{"tags":["Wired Network"],"summary":"Create virtual WAN","description":"Create virtual WAN.","operationId":"createVirtualWan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualWanConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":34}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/speedTest":{"get":{"tags":["Wired Network"],"summary":"Get SpeedTest Setting","description":"Get SpeedTest Setting.","operationId":"getSpeedTestV2Setting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSpeedTestV2SettingVO"}}}}},"x-order":99},"post":{"tags":["Wired Network"],"summary":"Modify SpeedTest Setting","description":"Modify SpeedTest Setting.","operationId":"modifySpeedTestV2Setting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifySpeedTestV2SettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":100}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/mdns":{"get":{"tags":["mDNS"],"summary":"Get mDNS rule list","description":"Get mDNS rule list of the site with the given omadacId and siteId.","operationId":"getMdnsGrid","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMdnsRuleOpenApiVO"}}}}},"x-order":1},"post":{"tags":["mDNS"],"summary":"Create a new mDNS rule","description":"Create a new mDNS rule with the given params.","operationId":"createMdns","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMdnsRuleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/mdns-election":{"post":{"tags":["app"],"summary":"Refresh the election setting of the By Network mDNS Rules configuration","description":"Refresh the election setting of the By Network mDNS Rules configuration of the site with the given omadacId and siteId. Only the By Network mDNS Rule configuration will take effect.","operationId":"refreshMdnsElectionSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":31}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/files/dhcp/import":{"post":{"tags":["DHCP Reservation"],"summary":"Import DHCP reservation list from file","description":"Import DHCP reservation list from existed file.","operationId":"importDhcpReservationListFromFile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"file":{"type":"string","description":"DHCP reservation file.","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/files/dhcp/batch-export":{"post":{"tags":["DHCP Reservation"],"summary":"Batch Export DHCP reservation list to file","description":"Batch Export DHCP reservation list to file.","operationId":"batchExportDhcpReservationListToFile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DhcpReservationFilterVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/dhcp":{"get":{"tags":["DHCP Reservation"],"summary":"Get DHCP reservation list","description":"Get DHCP reservation list of the site with the given omadacId and siteId.","operationId":"getDhcpReservationGrid","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.mac","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.ip","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.netName","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.description","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.status","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field : mac, ip, description.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDhcpReservationOpenApiGridVODhcpReservationOpenApiVO"}}}}},"x-order":1},"post":{"tags":["DHCP Reservation"],"summary":"Create a new DHCP reservation","description":"Create a new DHCP reservation with the given params.","operationId":"createDhcpReservation","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDhcpReservationOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/dhcp/{mac}/export":{"post":{"tags":["DHCP Reservation"],"summary":"Export DHCP reservation to IP_MAC Binding","description":"Export an exist DHCP reservation to IP_MAC Binding.","operationId":"exportDhcpReservation","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"mac","in":"path","description":"DHCP MAC address","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportDhcpReservationOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/dhcp/user-list/reservation":{"post":{"tags":["DHCP Reservation"],"summary":"Reservation From Dhcp User List","description":"Reservation From Dhcp User List.","operationId":"reservationFromDhcpUserList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DhcpUserFilterVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDhcpReservationErrorVO"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/ddns":{"get":{"tags":["DNS"],"summary":"Get Dynamic DNS list","description":"Get Dynamic DNS list of the site with the given omadacId and siteId.","operationId":"getDdnsGrid","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.service","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.updateInterval","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.status","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDdnsOpenApiGridVODdnsOpenApiVO"}}}}},"x-order":6},"post":{"tags":["DNS"],"summary":"Create a new Dynamic DNS entry","description":"Create a new Dynamic DNS entry with the given params.","operationId":"createDdns","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDdnsOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/profiles/cert-profiles":{"get":{"tags":["CertProfiles"],"summary":"Get grid certificate profile list","description":"Get grid certificate profile list.(Pagination).","operationId":"getGridCertProfile_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.type","in":"query","description":"Filter query parameters, support field type, it should be a value as follows: 0: CA Cert; 1: Client Cert.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"filters.status","in":"query","description":"Filter query parameters, support field status, it should be a value as follows: 0: Normal; 1: Expired Soon; 2: Expired","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field Name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCertProfileOpenApiVO"}}}}},"x-order":1},"post":{"tags":["CertProfiles"],"summary":"Create a new certificate profile","description":"Create a new certificate profile with the given params.","operationId":"createCertProfile_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertProfileRequestOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/profiles/cert-profiles/{certId}":{"get":{"tags":["CertProfiles"],"summary":"Get a certificate profile detail","description":"Get a certificate profile detail with the given params.","operationId":"getCertProfileDetail_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"certId","in":"path","description":"Cert profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCertProfileDetailOpenApiVO"}}}}},"x-order":2},"post":{"tags":["CertProfiles"],"summary":"Modify an exist certificate profile","description":"Modify an exist certificate profile with the given params.","operationId":"modifyCertProfile_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"certId","in":"path","description":"Certificate profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertProfileRequestOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7},"delete":{"tags":["CertProfiles"],"summary":"Delete an exist certificate profile","description":"Delete an exist certificate profile with the given params.","operationId":"deleteCertProfile_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"certId","in":"path","description":"Cert profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeleteCertOpenApiVO"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/profiles/cert-profiles/delete-file":{"post":{"tags":["CertProfiles"],"summary":"Delete an exist certificate profile file","description":"Delete an exist certificate profile file with the given params.","operationId":"deleteCertProfileFile_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CertProfileFileIdVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/profiles/cert-profiles/delete-file/{fileId}":{"post":{"tags":["CertProfiles"],"summary":"Delete an exist certificate profile file by id in url","description":"Delete an exist certificate profile file with the given params.This interface has been deprecated. Please use the following interface instead: Delete an exist certificate profile file)","operationId":"deleteCertProfileFile_2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"fileId","in":"path","description":"Cert profile file ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/mails":{"get":{"tags":["SIM"],"summary":"Get mail server","description":"Get mail server.","operationId":"getMailServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMailServerOpenApiVO"}}}}},"x-order":17},"post":{"tags":["SIM"],"summary":"Create mail server","description":"Create mail server.","operationId":"createMailServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailServerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/lan/dns":{"get":{"tags":["Wired Network"],"summary":"Get LAN DNS list","description":"Get LAN DNS list.","operationId":"getGridLanDns","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLanDnsGridVOLanDnsQueryOpenApiVO"}}}}},"x-order":38},"post":{"tags":["Wired Network"],"summary":"Create a LAN DNS rule","description":"Create a LAN DNS rule.","operationId":"createLanDns","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanDnsOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":39}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/iot/servers":{"get":{"tags":["Bluetooth"],"summary":"Get IoT Transport Steam","description":"Get IoT Transport Steam.","operationId":"getGridIotServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GridVOIotServerOpenApiVO"}}}}},"x-order":4},"post":{"tags":["Bluetooth"],"summary":"Create IoT Transport Stream","description":"Create IoT Transport Stream setting.","operationId":"createIotServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigIotServerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/iot/devices/config":{"get":{"tags":["Bluetooth"],"summary":"Get Bluetooth Advertising","description":"Get Bluetooth Advertising.  Note:The parameter [transmitPower] is deprecated, if you want to configure the Transmit Power in Bluetooth -> Radio Setting, use the v2 interface to get the Bluetooth Advertising information.","operationId":"getGridBtIbeaconList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GridVOIotBtIbeaconOpenApiVO"}}}}},"deprecated":true,"x-order":6},"post":{"tags":["Bluetooth"],"summary":"Create Bluetooth Advertising","description":"Create Bluetooth Advertising. Note:The parameter [transmitPower] is deprecated, all devices with transmit power configured via this v1 interface will have their transmit power configuration set to override on the new radio setting page. If you want to configure Transmit Power in Bluetooth -> Radio Setting, configure Bluetooth Advertising using v2 interface.","operationId":"createBtIbeaconConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigIotBtIbeaconOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/iot/devices/config/batch-config":{"post":{"tags":["Bluetooth"],"summary":"Batch modify Bluetooth Advertising","description":"Batch modify Bluetooth Advertising. Note:The parameter [transmitPower] is deprecated, all devices with transmit power configured via this v1 interface will have their transmit power configuration set to override on the new radio setting page. If you want to configure Transmit Power in Bluetooth -> Radio Setting, configure Bluetooth Advertising using v2 interface.","operationId":"batchModifyBtIbeaconConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchModifyIbeaconOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/dns-cache-data/clear":{"post":{"tags":["DNS"],"summary":"Clear DNS cache list","description":"Clear DNS cache list with the given params.","operationId":"clearDnsCacheList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/disaster":{"get":{"tags":["Site Configuration"],"summary":"Get the status of disaster modes in Japan","description":"Get the status of disaster modes in Japan","operationId":"getDisasterModeStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDisasterModeOpenApiVO"}}}}},"x-order":21},"post":{"tags":["Site Configuration"],"summary":"Modify the status of disaster modes in Japan","description":"Modify the status of disaster modes in Japan","operationId":"modifyDisasterModeStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyDisasterModeOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sites/{siteId}/session-limit/rules":{"get":{"tags":["Session Limit"],"summary":"Get session limit rule list","description":"Get session limit rule list.","operationId":"getGridSessionLimitRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSessionLimitRuleGridOpenApiVOQuerySessionLimitRuleOpenApiVO"}}}}},"x-order":3},"post":{"tags":["Session Limit"],"summary":"Create session limit rule","description":"Create session limit rule.","operationId":"createSessionLimitRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionLimitRuleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"patch":{"tags":["Session Limit"],"summary":"Modify session limit rule index","description":"Modify session limit rule index.","operationId":"modifySessionLimitRuleIndex","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransmissionDragSortIndexOpenapiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/routing/static-routings":{"get":{"tags":["Routing"],"summary":"Get static routing list","description":"Get static routing list.","operationId":"getGridStaticRouting_1","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseStaticRoutingOpenApiGridVOStaticRoutingInfo"}}}}},"x-order":1},"post":{"tags":["Routing"],"summary":"Create new static routing","description":"Create new static routing.","operationId":"createStaticRouting_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StaticRoutingConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/routing/policy-routings":{"get":{"tags":["Routing"],"summary":"Get policy routing list","description":"Get policy routing list.","operationId":"getGridPolicyRouting","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePolicyRoutingOpenApiGridVOPolicyRoutingInfo"}}}}},"x-order":6},"post":{"tags":["Routing"],"summary":"Create new policy routing","description":"Create new policy routing.","operationId":"createPolicyRouting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyRoutingConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/routing/policy-routings/modifyIndex":{"post":{"tags":["Routing"],"summary":"Modify policy routing Index","description":"Modify policy routing  Index.","operationId":"modifyPolicyRoutingIndex","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PolicyRoutingDragSortIndexOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/rfPlanning/excludeAps/delete":{"post":{"tags":["WLAN Optimization"],"summary":"Delete ExcludeAps","description":"Delete ExcludeAps","operationId":"deleteExcludeAps","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExcludeApDeleteOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":26}},"/openapi/v1/{omadacId}/sites/{siteId}/report/cards":{"post":{"tags":["Report v2"],"summary":"Get cards info ","description":"Get cards info by card names","operationId":"getCardsInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportCardQueryVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCardInfoVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/remoteAccess/tunnel":{"get":{"tags":["Remote Access"],"summary":"Get remote access tunnel","description":"Get remote access tunnel","operationId":"getTunnel","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseNatTraversalTunnelGridVONatTraversalTunnelVO"}}}}},"x-order":1},"post":{"tags":["Remote Access"],"summary":"Create new remote access tunnel","description":"Create new remote access tunnel","operationId":"addTunnel","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NatTraversalTunnelOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/remember-device":{"get":{"tags":["Site Configuration"],"summary":"Get site remember device setting","description":"Get site remember device setting","operationId":"getSiteRememberSettingByOpenApi","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteRememberDeviceSetting"}}}}},"x-order":19},"post":{"tags":["Site Configuration"],"summary":"Modify site remember device setting","description":"Modify site remember device setting","operationId":"modifySiteRememberSettingByOpenApi","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteRememberDeviceSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/reboot-schedules":{"get":{"tags":["Schedule"],"summary":"Get reboot schedule list","description":"Get reboot schedule list.","operationId":"getRebootScheduleList_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListRebootScheduleQueryOpenApiVO"}}}}},"x-order":11},"post":{"tags":["Schedule"],"summary":"Create new reboot schedule","description":"Create new reboot schedule","operationId":"createRebootSchedule_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RebootScheduleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/rate-limit-profiles":{"get":{"tags":["Profiles"],"summary":"Get rate limit profile list","description":"Get rate limit profile list","operationId":"getRateLimitProfileList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListRateLimitProfileOpenApiVO"}}}}},"x-order":30},"post":{"tags":["Profiles"],"summary":"Create rate limit profile","description":"Create rate limit profile","operationId":"createRateLimitProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRateLimitProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":31}},"/openapi/v1/{omadacId}/sites/{siteId}/quick-action/network-wizard/auto-select-devices":{"post":{"tags":["Device"],"summary":"Get auto select devices in quick-config page.","description":"Get auto select devices in quick-config page.","operationId":"getAutoSelectDevices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDeviceListOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseQueryDeviceListOpenApiVO"}}}}},"x-order":31}},"/openapi/v1/{omadacId}/sites/{siteId}/qos/gateway/class-rules":{"get":{"tags":["Gateway QoS"],"summary":"Get class rule list","description":"Get class rule list.","operationId":"getClassRuleGrid","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOClassRuleDetailOpenApiVO"}}}}},"x-order":6},"post":{"tags":["Gateway QoS"],"summary":"Create new class rule","description":"Create new class rule.","operationId":"createClassRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClassRuleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/qos/gateway/bwcs":{"get":{"tags":["Gateway QoS"],"summary":"Get bandwidth control rule list","description":"Get bandwidth control rule list.","operationId":"getBandwidthCtrlGrid","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOQosBwcDetailOpenApiVO"}}}}},"x-order":2},"post":{"tags":["Gateway QoS"],"summary":"Create new bandwidth control rule","description":"Create new bandwidth control rule.","operationId":"createBwCtrl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QosBwcOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/wifi-calling":{"get":{"tags":["Profiles"],"summary":"Get wifi calling profile list","description":"Get wifi calling profile list of the site with the given omadacId and siteId.","operationId":"getWifiCallingProfiles","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListWifiCallingProfileOpenApiVO"}}}}},"x-order":49},"post":{"tags":["Profiles"],"summary":"Create a new wifi calling profile","description":"Create a new wifi calling profile with the given params.","operationId":"createWifiCallingProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWifiCallingProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":50}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/wifi-calling/{profileId}/copy":{"post":{"tags":["Profiles"],"summary":"Copy wifi calling profile","description":"Copy wifi calling profile with the given params.","operationId":"copyWifiCallingProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CopyWifiCallingProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":50}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/service-type":{"get":{"tags":["Profiles"],"summary":"Get Gateway QoS Service list","description":"Get Gateway QoS Service list.","operationId":"listServiceType","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOGatewayQosServiceDetailOpenApiVO"}}}}},"x-order":91},"post":{"tags":["Profiles"],"summary":"Create new Gateway QoS Service","description":"Create new Gateway QoS Service.","operationId":"createServiceType","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayQosServiceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"x-order":92}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/radius":{"get":{"tags":["Profiles"],"summary":"Get RADIUS profile list","description":"Get RADIUS profile list of the site with the given omadacId and siteId.","operationId":"getRadiusProfileList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListRadiusProfileOpenApiVO"}}}}},"x-order":11},"post":{"tags":["Profiles"],"summary":"Create a new RADIUS profile","description":"Create a new RADIUS profile with the given params.","operationId":"createRadiusProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRadiusProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/radius-server/users":{"get":{"tags":["Profiles"],"summary":"Get Build-in RADIUS profile user list","description":"Get Build-in RADIUS profile user list of the site with the given omadacId and siteId. Cloud Based Controller does not support built-in radius function, you cannot call this interface through openAPI on Cloud Based Controller.","operationId":"getRadiusUserList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.username","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVORadiusUserOpenApiVO"}}}}},"x-order":15},"post":{"tags":["Profiles"],"summary":"Create a new Build-in RADIUS profile user","description":"Get Build-in RADIUS profile user list of the site with the given omadacId and siteId. Cloud Based Controller does not support built-in radius function, you cannot call this interface through openAPI on Cloud Based Controller.","operationId":"createRadiusUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRadiusUserOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/ldap":{"get":{"tags":["Profiles"],"summary":"Get LDAP profile list","description":"Get LDAP profile list of the site with the given omadacId and siteId.","operationId":"getLdapProfileList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListLdapProfileOpenApiVO"}}}}},"x-order":34},"post":{"tags":["Profiles"],"summary":"Create a new LDAP profile","description":"Create a new LDAP profile with the given params.","operationId":"createLdapProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLdapProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":35}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/ldap/google":{"get":{"tags":["Profiles"],"summary":"Get google LDAP profile list","description":"Get google LDAP profile list of the site with the given omadacId and siteId.","operationId":"getGoogleLdapProfileList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListLdapProfileOpenApiVO"}}}}},"x-order":42},"post":{"tags":["Profiles"],"summary":"Create a new google LDAP profile","description":"Create a new google LDAP profile with the given params.","operationId":"createGoogleLdapProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["config","file"],"type":"object","properties":{"config":{"$ref":"#/components/schemas/CreateGoogleLdapProfileOpenApiVO"},"file":{"type":"string","description":"Google LDAP certificate file.","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":43}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/groups":{"get":{"tags":["Profiles"],"summary":"Get group profile list","description":"Get group profile list of the site with the given omadacId and siteId.","operationId":"getGroupProfiles","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListGroupOpenApiVO"}}}}},"x-order":1},"post":{"tags":["Profiles"],"summary":"Create a new group profile","description":"Create a new group profile with the given params.","operationId":"createGroupProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/bonjour-service":{"get":{"tags":["Profiles"],"summary":"Get Bonjour Service list","description":"Get Bonjour Service list.","operationId":"listMdnsProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseDataVOBonjourServiceDetailOpenApiVO"}}}}},"x-order":80},"post":{"tags":["Profiles"],"summary":"Create new Bonjour Service","description":"Create new Bonjour Service.","operationId":"createMdnsProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BonjourServiceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"x-order":81}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/apn":{"get":{"tags":["Profiles"],"summary":"Get APN profile list","description":"Get APN profile list of the site with the given omadacId and siteId.","operationId":"getApnProfileList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListApnProfile"}}}}},"x-order":38},"post":{"tags":["Profiles"],"summary":"Create a new APN profile","description":"Create a new APN profile with the given params.","operationId":"createApnProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApnProfileConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":39}},"/openapi/v1/{omadacId}/sites/{siteId}/ppsk-profile":{"post":{"tags":["Profiles"],"summary":"Create PPSK profile","description":"Create PPSK profile This interface has been deprecated. Please use the following interface instead: Create PPSK profile V2","operationId":"createPPSKProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PpskProfile"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"deprecated":true,"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/ppsk-profile/{profileId}":{"get":{"tags":["Profiles"],"summary":"Get PPSK profile detail","description":"Get PPSK profile detail","operationId":"getPPSKProfileDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"PPSK profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePPSKProfileVO"}}}}},"x-order":25},"post":{"tags":["Profiles"],"summary":"Modify PPSK profile","description":"Modify PPSK profile","operationId":"modifyPPSKProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"PPSK profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PpskProfile"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":21},"delete":{"tags":["Profiles"],"summary":"Delete PPSK profile","description":"Delete PPSK profile","operationId":"deletePPSKProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"PPSK profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/sites/{siteId}/ppsk-profile/{profileId}/delete-psk":{"post":{"tags":["Profiles"],"summary":"Delete PSKs to PPSK profile","description":"Delete PSKs to a PPSK profile","operationId":"deletePSKsToPPSKProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"PPSK profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePSKsOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sites/{siteId}/ppsk-profile/{profileId}/add-psk":{"post":{"tags":["Profiles"],"summary":"Add PSKs to PPSK profile","description":"Add PSKs to a PPSK profile","operationId":"addPSKsToPPSKProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"PPSK profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddPSKsOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sites/{siteId}/ppsk-profile/generate-psk":{"post":{"tags":["Profiles"],"summary":"Auto Create PSKs","description":"Auto Create PSKs","operationId":"autoCreatePPSK","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PpskAutoCreateSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PSK"}}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sites/{siteId}/portal":{"post":{"tags":["Authentication"],"summary":"Add portal","description":"Add new portal","operationId":"addPortal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/portal/pics":{"post":{"tags":["Authentication"],"summary":"Upload portal picture","description":"Upload portal picture","operationId":"uploadPortalPic","parameters":[{"name":"type","in":"query","description":"Portal picture type: background/logo/advertisement.","required":true,"schema":{"type":"string"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","description":"Portal picture file.","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePortal Picture Info"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/portal/page":{"post":{"tags":["Authentication"],"summary":"Import portal page","description":"Import portal page","operationId":"uploadPortalPage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"Portal page file.","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseImportedPortalPageResOpenApiVO"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/port-schedules":{"get":{"tags":["Schedule"],"summary":"Get port schedule list","description":"Get port schedule list","operationId":"getPortScheduleList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOPortScheduleQueryOpenApiVO"}}}}},"x-order":7},"post":{"tags":["Schedule"],"summary":"Create new Port Schedule","description":"Create new Port Schedule.","operationId":"createPortSchedule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortScheduleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/poe-schedules":{"get":{"tags":["Schedule"],"summary":"Get PoE schedule list","description":"Get poe schedule list.(Pagination)","operationId":"getPoeScheduleList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOPoeScheduleQueryOpenApiVO"}}}}},"x-order":2},"post":{"tags":["Schedule"],"summary":"Create new PoE Schedule","description":"Create new Poe Schedule","operationId":"createPoeSchedule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PoeScheduleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/planningHistory/{id}":{"get":{"tags":["WLAN Optimization"],"summary":"Get Planning History","description":"Get Planning History","operationId":"getPlanningHistory","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"planning history ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePlanning History Detail"}}}}},"x-order":9},"post":{"tags":["WLAN Optimization"],"summary":"apply Planning History","description":"apply Planning History","operationId":"applyPlanningHistory","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"planning history ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Applied Config"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":8},"delete":{"tags":["WLAN Optimization"],"summary":"delete Planning History","description":"delete Planning History","operationId":"deletePlanningHistory","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"planning history ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/planningHistory/batch/delete":{"post":{"tags":["WLAN Optimization"],"summary":"Batch Delete PlanningHistory","description":"Batch Delete PlanningHistory","operationId":"batchDeletePlanningHistory","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Batch Delete PlanningHistory"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/sites/{siteId}/oui-profiles":{"get":{"tags":["Profiles"],"summary":"Get OUI profile list","description":"Get OUI profile list.(Pagination)","operationId":"getOuiProfileList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOuiGridVOOuiProfileQueryOpenApiVO"}}}}},"x-order":6},"post":{"tags":["Profiles"],"summary":"Create OUI profile","description":"Create OUI profile","operationId":"createOuiProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OuiProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/osw-vrrp":{"get":{"tags":["VRRP"],"summary":"Get Switch Vrrp list","description":"Get Switch Vrrp list.","operationId":"getGridOswVrrp","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOswVrrpOpenApiVO"}}}}},"x-order":1},"post":{"tags":["VRRP"],"summary":"Create Switch Vrrp","description":"Create Switch Vrrp.","operationId":"createOswVrrp","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswVrrpConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/ospf/process":{"get":{"tags":["OSPF"],"summary":"Get Ospf Process list","description":"Get Ospf Process list.","operationId":"getGridOspfProcess","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOspfProcessOpenApiVO"}}}}},"x-order":1},"post":{"tags":["OSPF"],"summary":"Create Ospf Process","description":"Create Ospf Process.","operationId":"createOspfProcess","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OspfProcessConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/ospf/process/batch-delete":{"post":{"tags":["OSPF"],"summary":"Batch Delete Ospf Process","description":"Batch Delete Ospf Process.","operationId":"batchDeleteOspfProcess","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchOspfProcessOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/ospf/interface":{"get":{"tags":["OSPF"],"summary":"Get Ospf Interface list","description":"Get Ospf Interface list.","operationId":"getGridOspfInterface","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOspfInterfaceOpenApiVO"}}}}},"x-order":2},"post":{"tags":["OSPF"],"summary":"Create Ospf Interface","description":"Create Ospf Interface.","operationId":"createOspfInterface","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OspfInterfaceConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/ospf/interface/batch-delete":{"post":{"tags":["OSPF"],"summary":"Batch Delete Ospf Interface","description":"Batch Delete Ospf Interface.","operationId":"batchDeleteOspfInterface","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchOspfInterfaceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/system/system-tools/reboot/now":{"post":{"tags":["OLT"],"summary":"Reboot OLT","description":"Reboot OLT","operationId":"rebootNow","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceRebootAppDTO"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/system/system-info/configs/edit":{"post":{"tags":["OLT"],"summary":"Modify OLT description info","description":"Modify OLT description info","operationId":"editConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemInfoAppModifyDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeviceResponseBodyVoid"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/system/management-system-interface/edit":{"post":{"tags":["OLT"],"summary":"Modify OLT Management System Interface","description":"Modify OLT Management System Interface.","operationId":"editManagementSystemInterfaces","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagementSystemInterfaceDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-ports/edit":{"post":{"tags":["OLT Service Port"],"summary":"Modify an existing service port","description":"Modify an existing service port","operationId":"editServicePort","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicePortModifyDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":64}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-ports/delete":{"post":{"tags":["OLT Service Port"],"summary":"Batch delete existing service port","description":"Batch delete existing service port","operationId":"deleteServicePort","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntIdListRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":64}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-ports/add":{"post":{"tags":["OLT Service Port"],"summary":"Create new service port","description":"Create new service port","operationId":"addServicePort","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicePortAddDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":64}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-port/statistics/clear":{"post":{"tags":["OLT Service Port"],"summary":"Batch delete existing statistic info","description":"Batch delete existing statistic info","operationId":"clearStatisticInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntIdListRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":64}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-port/statistic/configs/edit":{"post":{"tags":["OLT Service Port"],"summary":"Modify an existing auto refresh config","description":"Modify an existing auto refresh config","operationId":"editAutoRefreshConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatisticConfigDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":64}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/traffic/profiles/edit":{"post":{"tags":["OLT Traffic Profile"],"summary":"Modify an existing traffic profile","description":"Modify an existing traffic profile","operationId":"editTrafficProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrafficProfileModifyDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":60}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/traffic/profiles/delete":{"post":{"tags":["OLT Traffic Profile"],"summary":"Delete an existing traffic profile","description":"Delete an existing traffic profile","operationId":"deleteTrafficProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntIdListRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyTrafficProfileDeleteResultDTO"}}}}},"x-order":60}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/traffic/profiles/add":{"post":{"tags":["OLT Traffic Profile"],"summary":"Create new traffic profile","description":"Create new traffic profile","operationId":"addTrafficProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrafficProfileDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyTrafficProfileAddResultDTO"}}}}},"x-order":60}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/service/{serviceId}/pots-ports/edit":{"post":{"tags":["OLT ONT Port"],"summary":"Modify an existing ont pots port","description":"Modify an existing ont pots port","operationId":"editOntPotsPort","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"serviceId","in":"path","description":"Service Profile ID should be a number between 0-512","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OntPotsPortModifyDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":56}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/service/{serviceId}/eth-ports/edit":{"post":{"tags":["OLT ONT Port"],"summary":"Modify an existing ont eth port","description":"Modify an existing ont eth port","operationId":"editOntEthPort","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"serviceId","in":"path","description":"Service Profile ID should be a number between 0-512","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OntEthPortModifyDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":56}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/service/profiles/edit":{"post":{"tags":["OLT Service Profile"],"summary":"Modify an existing service profile","description":"Modify an existing service profile","operationId":"editServiceProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceProfileModifyDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":58}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/service/profiles/delete":{"post":{"tags":["OLT Service Profile"],"summary":"Delete an existing service profile","description":"Delete an existing service profile","operationId":"deleteServiceProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntIdListRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyServiceProfileDeleteResultDTO"}}}}},"x-order":58}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/service/profiles/add":{"post":{"tags":["OLT Service Profile"],"summary":"Create new service profile","description":"Create new service profile","operationId":"addServiceProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceProfileDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyServiceProfileDTO"}}}}},"x-order":58}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/service-port/profiles/edit":{"post":{"tags":["OLT Service Port Profile"],"summary":"Modify an existing service port profile","description":"Modify an existing service port profile","operationId":"editServicePortProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicePortProfileModifyDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":57}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/service-port/profiles/detail/edit":{"post":{"tags":["OLT Service Port Profile"],"summary":"Modify an existing service port profile detail","description":"Modify an existing service port profile detail","operationId":"editServicePortProfileDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicePortProfileDetailDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":57}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/service-port/profiles/detail/delete":{"post":{"tags":["OLT Service Port Profile"],"summary":"Delete an existing service port profile detail","description":"Delete an existing service port profile detail","operationId":"deleteServicePortProfileDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicePortProfileDetailDeleteDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":57}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/service-port/profiles/detail/add":{"post":{"tags":["OLT Service Port Profile"],"summary":"Create new service port profile detail","description":"Create new service port profile detail","operationId":"addServicePortProfileDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicePortProfileDetailDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":57}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/service-port/profiles/delete":{"post":{"tags":["OLT Service Port Profile"],"summary":"Delete an existing service port profile","description":"Delete an existing service port profile","operationId":"deleteServicePortProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicePortProfileDeleteDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":57}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/service-port/profiles/add":{"post":{"tags":["OLT Service Port Profile"],"summary":"Create new service port profile","description":"Create new service port profile","operationId":"addServicePortProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicePortProfileModifyDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyServicePortProfileModifyDTO"}}}}},"x-order":57}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/{lineProfileId}/t-conts/edit":{"post":{"tags":["OLT T-cont"],"summary":"Modify an existing t-cont","description":"Modify an existing t-cont","operationId":"editTcont","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"lineProfileId","in":"path","description":"Line Profile ID should be a number between 0-512","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TcontModifyDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":59}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/{lineProfileId}/t-conts/delete":{"post":{"tags":["OLT T-cont"],"summary":"Delete an existing t-cont","description":"Delete an existing t-cont","operationId":"deleteTcont","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"lineProfileId","in":"path","description":"Line Profile ID should be a number between 0-512","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TcontDeleteDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyTcontDeleteResultDTO"}}}}},"x-order":59}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/{lineProfileId}/t-conts/add":{"post":{"tags":["OLT T-cont"],"summary":"Create new t-cont","description":"Create new t-cont","operationId":"addTcont","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"lineProfileId","in":"path","description":"Line Profile ID should be a number between 0-512","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TcontDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":59}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/{lineProfileId}/gem-ports/edit":{"post":{"tags":["OLT Gem Port"],"summary":"Modify an existing gem port","description":"Modify an existing gem port","operationId":"editGemPort","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"lineProfileId","in":"path","description":"Line Profile ID should be a number between 0-512","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GemPortModifyDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":54}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/{lineProfileId}/gem-ports/delete":{"post":{"tags":["OLT Gem Port"],"summary":"Delete an existing gem port","description":"Delete an existing gem port","operationId":"deleteGemPort","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"lineProfileId","in":"path","description":"Line Profile ID should be a number between 0-512","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GemPortDeleteDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyGemPortDeleteResultDTO"}}}}},"x-order":54}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/{lineProfileId}/gem-ports/add":{"post":{"tags":["OLT Gem Port"],"summary":"Create new gem port","description":"Create new gem port","operationId":"addGemPort","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"lineProfileId","in":"path","description":"Line Profile ID should be a number between 0-512","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GemPortDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":54}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/{lineProfileId}/gem-mappings/edit":{"post":{"tags":["OLT Gem Mapping"],"summary":"Modify an existing gem mapping","description":"Modify an existing gem mapping","operationId":"editGemMapping","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"lineProfileId","in":"path","description":"Line Profile ID should be a number between 0-512","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GemMappingModifyDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":53}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/{lineProfileId}/gem-mappings/delete":{"post":{"tags":["OLT Gem Mapping"],"summary":"Delete an existing gem mapping","description":"Delete an existing gem mapping","operationId":"deleteGemMapping","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"lineProfileId","in":"path","description":"Line Profile ID should be a number between 0-512","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GemMappingDeleteDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":53}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/{lineProfileId}/gem-mappings/add":{"post":{"tags":["OLT Gem Mapping"],"summary":"Create new gem mapping","description":"Create new gem mapping","operationId":"addGemMapping","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"lineProfileId","in":"path","description":"Line Profile ID should be a number between 0-512","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GemMappingDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":53}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/profiles/edit":{"post":{"tags":["OLT Line Profile"],"summary":"Modify an existing line profile","description":"Modify an existing line profile","operationId":"editLineProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineProfileModifyDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":55}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/profiles/delete":{"post":{"tags":["OLT Line Profile"],"summary":"Delete an existing line profile","description":"Delete an existing line profile","operationId":"deleteLineProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntIdListRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyLineProfileDeleteResultDTO"}}}}},"x-order":55}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/profiles/add":{"post":{"tags":["OLT Line Profile"],"summary":"Create new line profile","description":"Create new line profile","operationId":"addLineProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineProfileDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyLineProfileDTO"}}}}},"x-order":55}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/dba/profiles/edit":{"post":{"tags":["OLT DBA"],"summary":"Modify an existing DBA profile","description":"Modify an existing DBA profile","operationId":"editDBAProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DBAProfileModifyDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/dba/profiles/delete":{"post":{"tags":["OLT DBA"],"summary":"Delete an existing DBA profile","description":"Delete an existing DBA profile","operationId":"deleteDBAProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntIdListRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyDBAProfileDeleteResultDTO"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/dba/profiles/add":{"post":{"tags":["OLT DBA"],"summary":"Create new DBA profile","description":"Create new DBA profile","operationId":"addDBAProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DBAProfileModifyDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyDBAProfileDTO"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/pon-port/edit":{"post":{"tags":["OLT Pon Port"],"summary":"Batch modify pon port","description":"Batch modify pon port","operationId":"editPonPort","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PonPortBatchModifyDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyReactivePonPortDTO"}}}}},"x-order":63}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/autofind/onus/clear":{"post":{"tags":["OLT ONU Register"],"summary":"Batch delete existing ONU auto find config","description":"Batch delete existing ONU auto find config","operationId":"clearOnuAutofindConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StringKeyListRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/autofind/onus/auth":{"post":{"tags":["OLT ONU Register"],"summary":"Authenticate ONU","description":"Authenticate ONU","operationId":"authOnu","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnuActivationConfigDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/autofind/configs/edit":{"post":{"tags":["OLT ONU Register"],"summary":"Modify an existing ONU register auto find config","description":"Modify an existing ONU register auto find config","operationId":"editOnuRegisterAutofindConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutofindConfigDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/auto-authentication/rules/edit":{"post":{"tags":["OLT ONU Register"],"summary":"Modify an existing ONU auto authentication rule","description":"Modify an existing ONU auto authentication rule","operationId":"editOnuAutoAuthenticationRuleConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PonAutoAuthenticationRuleConfigEditDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/auto-authentication/rules/delete":{"post":{"tags":["OLT ONU Register"],"summary":"Delete an existing ONU auto authentication rule","description":"Delete an existing ONU auto authentication rule","operationId":"deleteOnuAutoAuthenticationRuleConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PonAutoAuthenticationRuleConfigDeleteDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/auto-authentication/rules/add":{"post":{"tags":["OLT ONU Register"],"summary":"Create ONU auto authentication rule","description":"Create ONU auto authentication rule","operationId":"addOnuAutoAuthenticationRuleConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PonAutoAuthenticationRuleConfigDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/auto-authentication/port-configs/edit":{"post":{"tags":["OLT ONU Register"],"summary":"Modify an existing ONU pon auto authentication config","description":"Modify an existing ONU pon auto authentication config","operationId":"editOnuPonAutoAuthenticationConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PonAutoAuthenticationConfigDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/auto-authentication/global/configs/edit":{"post":{"tags":["OLT ONU Register"],"summary":"Modify an existing ONU auto authentication config","description":"Modify an existing ONU auto authentication config","operationId":"editOnuAutoAuthenticationConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoAuthenticationConfigDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/authentications/edit":{"post":{"tags":["OLT ONU Register"],"summary":"Modify an existing authentication config","description":"Modify an existing authentication config","operationId":"editAuthenticationConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationConfigEditDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/authentications/delete":{"post":{"tags":["OLT ONU Register"],"summary":"Batch delete existing authentication config","description":"Batch delete existing authentication config","operationId":"deleteAuthenticationConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StringKeyListRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/authentications/admin-status/edit":{"post":{"tags":["OLT ONU Register"],"summary":"Modify an existing ONU admin status","description":"Modify an existing ONU admin status","operationId":"editOnuAdminStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnuAdminStatusEditDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/authentications/add":{"post":{"tags":["OLT ONU Register"],"summary":"Create authentication config","description":"Create authentication config","operationId":"addAuthenticationConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationConfigAddDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-management/informations/onu/reboot":{"post":{"tags":["OLT ONU Management"],"summary":"Reboot ONU","description":"Reboot ONU","operationId":"rebootOnu","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnuInformationRebootRequestDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyListSingleOnuRebootResponseDTO"}}}}},"x-order":61}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-management/informations/description/edit":{"post":{"tags":["OLT ONU Management"],"summary":"Modify an existing ONU description","description":"Modify an existing ONU description","operationId":"editOnuInformationDescriptionConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnuInformationDescriptionEditConfigDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":61}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-management/informations/admin/edit":{"post":{"tags":["OLT ONU Management"],"summary":"Modify an existing ONU admin status config","description":"Modify an existing ONU admin status config","operationId":"editOnuInformationAdminStatusConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnuInformationAdminStatusEditConfigDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":61}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-management/global-config/isolation/edit":{"post":{"tags":["OLT ONU Management"],"summary":"Modify an existing ONU  isolation status","description":"Modify an existing ONU  isolation status","operationId":"editOnuIsolationStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnuIsolationStatusDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":61}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-management/global-config/edit":{"post":{"tags":["OLT ONU Management"],"summary":"Modify an existing ONU global config status","description":"Modify an existing ONU global config status","operationId":"editOnuGlobalConfigStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnuGlobalConfigStatusEditDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":61}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/auto-service-ports/edit":{"post":{"tags":["OLT Service Port"],"summary":"Batch modify auto service port","description":"Batch modify auto service port","operationId":"editAutoServicePort","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AutoServicePortDTO"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceResponseBodyVoid"}}}}},"x-order":64}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/l2-feature/eth-port/port/unit1/edit":{"post":{"tags":["OLT"],"summary":"Batch Modify ETH Unit1 port of olt","description":"Batch Modify ETH Unit1 port of olt","operationId":"editPortsConfigList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EthUnit1PortAppListDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeviceResponseBodyVoid"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/l2-feature/eth-port/port/lags/edit":{"post":{"tags":["OLT"],"summary":"Batch modify ETH LAG(Link Aggregation Group) config","description":"Batch modify ETH LAG(Link Aggregation Group) config","operationId":"editLagsConfigList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EthLagPortAppListDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeviceResponseBodyVoid"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/stack/ports":{"post":{"tags":["Wired Network"],"summary":"Get the port information of the selected stacks when modifying the network","description":"Get the port information of the selected stacks when modifying the network.","operationId":"getSelectStackPortsInfoWhenModify","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectStacksWithVlanVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListSelectStackForVlanVO"}}}}},"x-order":77}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/ports-check":{"post":{"tags":["Wired Network"],"summary":"Check port binding when modifying network","description":"Check port binding when modifying network.","operationId":"checkPortBindingParamWhenModify","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectPortBindingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListCheckFailedDeviceInfoForVlanVO"}}}}},"x-order":78}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/param-check":{"post":{"tags":["Wired Network"],"summary":"Check basic parameters when modifying the network","description":"Check basic parameters when modifying the network.","operationId":"checkNetworkParamWhenModify","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanNetworkOpenApiV3VO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLanNetworkQueryOpenApiV3VO"}}}}},"x-order":75}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/devices/ports":{"post":{"tags":["Wired Network"],"summary":"Get the port information of the selected devices when modifying the network","description":"Get the port information of the selected devices when modifying the network.","operationId":"getSelectDevicePortsInfoWhenModify","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectMacsWithVlanVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListSelectDeviceForVlanVO"}}}}},"x-order":76}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/check":{"post":{"tags":["Wired Network"],"summary":"Check all parameters and generate configuration when modifying the network","description":"Check all parameters and generate configuration when modifying the network.","operationId":"checkParamAndGetPreConfigWhenModify","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyVlanParamOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVlanPreConfigOpenApiVO"}}}}},"x-order":79}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/auto-select-devices":{"post":{"tags":["Wired Network"],"summary":"Get auto select devices when modifying network","description":"Get auto select devices when modifying network.","operationId":"getAutoSelectDevicesWhenModify","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanNetworkOpenApiV3VO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAutoSelectDevicesForVlanVO"}}}}},"x-order":98}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/auto-effect-devices":{"post":{"tags":["Wired Network"],"summary":"Get auto effect devices when modifying network","description":"Get auto effect devices when modifying network.","operationId":"getAutoEffectDevicesWhenModify","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanNetworkOpenApiV3VO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAutoEffectDevicesForVlanVO"}}}}},"x-order":97}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/switches":{"post":{"tags":["Wired Network"],"summary":"Get LAN network list","description":"Get LAN network list.(Pagination)","operationId":"getOswForGivenLanNetworkIds","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryOswDateByNetworkVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOswDataVO"}}}}},"x-order":93}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/stack/ports":{"post":{"tags":["Wired Network"],"summary":"Get the port information of the selected stacks when creating network","description":"Get the port information of the selected stacks when creating network","operationId":"getSelectStackPortsInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectStacksWithVlanVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListSelectStackForVlanVO"}}}}},"x-order":68}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/ports-check":{"post":{"tags":["Wired Network"],"summary":"Check selected ports when creating network","description":"Check selected ports when creating network","operationId":"checkPortBindingParamWhenCreate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectPortBindingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListCheckFailedDeviceInfoForVlanVO"}}}}},"x-order":69}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/param-check":{"post":{"tags":["Wired Network"],"summary":"Check basic parameters when creating network","description":"Check basic parameters when creating network","operationId":"checkNetworkParamWhenCreate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanNetworkOpenApiV3VO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLanNetworkQueryOpenApiV3VO"}}}}},"x-order":66}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/devices/ports":{"post":{"tags":["Wired Network"],"summary":"Get the port information of the selected devices when creating network","description":"Get the port information of the selected devices when creating network","operationId":"getSelectDevicePortsInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectMacsWithVlanVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListSelectDeviceForVlanVO"}}}}},"x-order":67}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/device-support-ports":{"post":{"tags":["Wired Network"],"summary":"Get device port info on whether support any of current vlans","description":"Get device port info on whether support any of current vlans","operationId":"getDevicePortSupportVlansInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VlanNetworkVlansVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVlanNetworkDeviceSupportInfoVO"}}}}},"x-order":102}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/confirm":{"post":{"tags":["Wired Network"],"summary":"Confirm create lan network","description":"Confirm create lan network","operationId":"confirmCreateVlanNetwork","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVlanParamOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVlanNetworkIdListVO"}}}}},"x-order":71}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/check":{"post":{"tags":["Wired Network"],"summary":"Check all parameters and generate configuration when creating network","description":"Check all parameters and generate configuration when creating network","operationId":"checkParamAndGetPreConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVlanParamOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVlanPreConfigOpenApiVO"}}}}},"x-order":70}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/auto-effect-devices":{"post":{"tags":["Wired Network"],"summary":"Get auto effect devices when creating network","description":"Get auto effect devices when creating network","operationId":"getAutoEffectDevicesWhenCreate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanNetworkOpenApiV3VO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAutoEffectDevicesForVlanVO"}}}}},"x-order":96}},"/openapi/v1/{omadacId}/sites/{siteId}/networkReport/schedule":{"post":{"tags":["Network Report"],"summary":"Email Network Report Schedule","description":"Set the timing task configuration that send reports periodically.This interface has been deprecated. Please use the following interface instead: Export report for scheduler","operationId":"emailNetworkReportSchedule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkReportScheduleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"deprecated":true,"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/networkReport/oneTime":{"post":{"tags":["Network Report"],"summary":"Email Network Report Later","description":"Set the timing task configuration that send reports latterly.This interface has been deprecated. Please use the following interface instead: Export report once later","operationId":"emailNetworkReportLater","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkReportScheduleLaterOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"deprecated":true,"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/network-security/ips/allow-list":{"post":{"tags":["IDS/IPS"],"summary":"Create new allow list","description":"Create new allow list.","operationId":"createAllowList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/New IPS allow list entry"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":9},"patch":{"tags":["IDS/IPS"],"summary":"Edit allow list","description":"Modify an allow list entry.","operationId":"editAllowList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Modify IPS allow list entry"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/nat/port-forwardings":{"get":{"tags":["NAT"],"summary":"Get port forwarding list","description":"Get port forwarding list.","operationId":"getPortForwardingList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePortForwardingGridVOPortForwardingInfo"}}}}},"x-order":1},"post":{"tags":["NAT"],"summary":"Create new port forwarding","description":"Create new port forwarding.","operationId":"createPortForwarding","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortForwardingConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/nat/one-to-one-nat":{"get":{"tags":["NAT"],"summary":"Get One-to-One NAT list","description":"Get One-to-One NAT list.","operationId":"getGridOtoNats","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOtoNatOpenApiGridVO"}}}}},"x-order":7},"post":{"tags":["NAT"],"summary":"Create new One-to-One NAT","description":"Create new One-to-One NAT.","operationId":"createOtoNat","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OtoNatOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/multi-devices/unbind":{"post":{"tags":["Device"],"summary":"Batch unbind devices","description":"Batch unbind devices.","operationId":"unbindDevice","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbindDeviceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UnbindDeviceRespVO"}}}}}},"x-order":52}},"/openapi/v1/{omadacId}/sites/{siteId}/multi-devices/tag":{"post":{"tags":["Device"],"summary":"Set device tag for given devices","description":"Set device tag for given devices.","operationId":"updateDeviceTag","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetTagOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BatchTagRespOpenApiVO"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/multi-devices/start-rolling-upgrade":{"post":{"tags":["Device"],"summary":"Start batch rolling upgrade","description":"Batch online upgrade the devices in a certain order in the site. It is suggested to check firmware update before the operation, or the firmware might not be the latest","operationId":"onlineRollingUpgrade","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RollingUpgradeRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUpgradeTask"}}}}},"x-order":106}},"/openapi/v1/{omadacId}/sites/{siteId}/multi-devices/start-manually-upgrade":{"post":{"tags":["Device"],"summary":"Start manually upgrade","description":"Manually upgrade the devices of the same model in the site. The firmware needs to be uploaded first. Note: Each site can only execute one multi-device upgrade task at a time, and there is a number limit of the tasks that can be executed simultaneously in the controller.","operationId":"manuallyUpgrade","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpgradeRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUpgradeTask"}}}}},"x-order":110}},"/openapi/v1/{omadacId}/sites/{siteId}/multi-devices/sn-unbind":{"post":{"tags":["Device"],"summary":"Batch unbind devices by SN","description":"Batch unbind devices by SN.","operationId":"unbindDeviceBySn","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbindDeviceSnOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UnbindDeviceSnRespVO"}}}}}},"x-order":54}},"/openapi/v1/{omadacId}/sites/{siteId}/multi-devices/sn-add":{"post":{"tags":["Device"],"summary":"Batch add devices by SN","description":"Batch add devices by SN.","operationId":"addDevicesBySn","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceListAddBySnOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceAddRespOpenApiVO"}}}}},"x-order":51}},"/openapi/v1/{omadacId}/sites/{siteId}/multi-devices/sn-active":{"post":{"tags":["Device"],"summary":"Batch active devices by SN","description":"Batch active devices by SN.","operationId":"activeDeviceBySn","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveDeviceSnOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ActiveDeviceSnRespVO"}}}}}},"x-order":53}},"/openapi/v1/{omadacId}/sites/{siteId}/multi-devices/devicekey-add":{"post":{"tags":["Device"],"summary":"Batch add devices by DEVICE KEY.","description":"Batch add devices by DEVICE KEY.","operationId":"addDevicesByDeviceKey","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceListAddByDevicekeyOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceAddRespOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/multi-devices/active":{"post":{"tags":["Device"],"summary":"Batch active devices","description":"Batch active devices.","operationId":"activeDevice","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveDeviceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ActiveDeviceRespVO"}}}}}},"x-order":50}},"/openapi/v1/{omadacId}/sites/{siteId}/monitor-device/verify":{"post":{"tags":["Intelli Recover Device"],"summary":"Verify if the device is allowed to be monitored","description":"Verify if the device is allowed to be monitored","operationId":"verifyMonitorDevice","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyDevice"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/monitor-device/reboot-uplink-poe":{"post":{"tags":["Intelli Recover Device"],"summary":"Reboot the device uplinkDevice poe","description":"Reboot the device uplinkDevice poe","operationId":"rebootDeviceUplinkPoe","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorDevice"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/monitor-device/add":{"post":{"tags":["Intelli Recover Device"],"summary":"Add device into intelli recover device list","description":"Add device into intelli recover device list","operationId":"addMonitorDevices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddMonitorDeviceList"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/monitor-client/verify":{"post":{"tags":["Intelli Recover Client"],"summary":"Verify if the client is allowed to be monitored","description":"Verify if the client is allowed to be monitored","operationId":"verifyMonitorClient","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyClientVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/monitor-client/reboot-uplink-poe":{"post":{"tags":["Intelli Recover Client"],"summary":"Reboot the client uplinkDevice poe","description":"Reboot the client uplinkDevice poe","operationId":"rebootClientUplinkPoe","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorClient"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/monitor-client/add":{"post":{"tags":["Intelli Recover Client"],"summary":"Add client into intelli recover client list","description":"Add client into intelli recover client list","operationId":"addMonitorClients","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddMonitorClientList"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/mlag":{"get":{"tags":["Mlag"],"summary":"Get M-LAG group list","description":"Get M-LAG group list.","operationId":"getGridMlagGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOswMlagVO"}}}}},"x-order":1},"post":{"tags":["Mlag"],"summary":"Create M-LAG group","description":"Create M-LAG group.","operationId":"createMlagGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MlagConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/migrate/exportPreDevice":{"post":{"tags":["Device"],"summary":"Export preconfigured devices of site.","description":"Export preconfigured devices of site.","operationId":"exportPreConfigDevices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":34}},"/openapi/v1/{omadacId}/sites/{siteId}/mac-filters":{"post":{"tags":["MAC Filtering"],"summary":"Create MAC filtering","description":"Create MAC filtering.","operationId":"createMacFiltering","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacFiltering"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/logs/alerts/resolve":{"post":{"tags":["Log"],"summary":"Resolve site alert log","description":"Resolve site alert log.","operationId":"resolveAlertForSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolveSiteLogListOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sites/{siteId}/license/auto-renew":{"get":{"tags":["License"],"summary":"Get site license auto renew","description":"Get site license auto renew.","operationId":"getSiteAutoRenew","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLicenseAutoRenewOpenApiVO"}}}}},"x-order":12},"post":{"tags":["License"],"summary":"Modify site license auto renew","description":"Modify site license auto renew.","operationId":"modifySiteAutoRenew","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseAutoRenewOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/lan-vlans":{"post":{"tags":["Wired Network"],"summary":"Batch create vlans","description":"Batch create vlans. Format support: 200, 1-100.","operationId":"createVlans_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Create VLANs"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/lan-profiles":{"get":{"tags":["Wired Network"],"summary":"Get LAN profile list","description":"Get LAN profile list.","operationId":"getLanProfileList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOLanProfileOpenApiVO"}}}}},"x-order":1},"post":{"tags":["Wired Network"],"summary":"Create new LAN profile","description":"Create new LAN profile.","operationId":"createLanProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanProfileConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseIdVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/lan-networks":{"get":{"tags":["Wired Network"],"summary":"Get LAN network list","description":"Get LAN network list.(Pagination). This interface has been deprecated. Please use the following interface instead: Get LAN network list V3","operationId":"getLanNetworkList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLanNetworkOpenApiGridVOLanNetworkQueryOpenApiVO"}}}}},"deprecated":true,"x-order":5},"post":{"tags":["Wired Network"],"summary":"Create LAN network","description":"Create lan network. This interface has been deprecated. Please use the following interface instead: Confirm create lan network","operationId":"createLanNetwork","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanNetworkOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseIdVO"}}}}},"deprecated":true,"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/lan-networks/es":{"post":{"tags":["Wired Network"],"summary":"Query switches that used the Native Network's profile","description":"Query switches that used the Native Network's profile.(Pagination). This interface has been deprecated. Please use the following interface instead: Query switches that used the Native Network's profile V2","operationId":"getUseNativeNetworkOsw","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUseNativeNetworkOswOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOUseProfileOswOpenApiVO"}}}}},"deprecated":true,"x-order":29}},"/openapi/v1/{omadacId}/sites/{siteId}/lan-networks/es-native":{"post":{"tags":["Wired Network"],"summary":"Query switches that used the Native Network's profile V2","description":"Query switches that used the Native Network's profile V2.(Pagination)","operationId":"getUseNativeNetworkOswV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryUseNativeNetworkOswV2OpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOUseProfileOswOpenApiVO"}}}}},"x-order":31}},"/openapi/v1/{omadacId}/sites/{siteId}/lan-multicasts":{"get":{"tags":["Lan Multicast"],"summary":"Get lan multicast list","description":"Get lan multicast list","operationId":"getGridLanMulticasts","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOLanMulticastVO"}}}}},"x-order":1},"post":{"tags":["Lan Multicast"],"summary":"Create new lan multicast","description":"Create new lan multicast","operationId":"createLanMulticast","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanMulticastVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/ips/threat":{"post":{"tags":["Threat Management"],"summary":"Delete archived ips threat","description":"Delete archived ips threat.","operationId":"deleteThreatList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Delete Ips Threat"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/ips/threat/multi-ops":{"post":{"tags":["Threat Management"],"summary":"Block/Isolate Device/Signature Suppression/Allow ips threat","description":"Block/Isolate Device/Signature Suppression/Allow ips threat.","operationId":"operateThreats","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ips Operate Threat"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/ip-mac-binds":{"get":{"tags":["IP-MAC Binding"],"summary":"Get IP-MAC binding list","description":"Get IP-MAC binding list.","operationId":"getGridIpMacBinding","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOIPMacBinding"}}}}},"x-order":3},"post":{"tags":["IP-MAC Binding"],"summary":"Create IP-MAC binding","description":"Create IP-MAC binding.","operationId":"createIpMacBinding","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPMacBinding"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/ip-mac-binds/import":{"post":{"tags":["IP-MAC Binding"],"summary":"Import IP-MAC bindings from file","description":"Import IP-MAC bindings from file.","operationId":"importIpMacBindingListFromFile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/ip-mac-binds/check/dhcp-res":{"post":{"tags":["IP-MAC Binding"],"summary":"Check IP-MAC binding export to DHCP reservation","description":"Check IP-MAC binding export to DHCP reservation.","operationId":"checkIpMacBindingExportToDhcpReservation","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckIpMacBindingExportToDhcpReservationOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/ip-mac-binds/batch-delete":{"post":{"tags":["IP-MAC Binding"],"summary":"Batch delete IP-MAC bindings","description":"Batch delete IP-MAC bindings.","operationId":"batchDeleteIpMacBindings","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/batchIds"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/internet/change-model":{"post":{"tags":["Wired Network"],"summary":"Modify gateway mode for pre-configuration","description":"Only effective when there is no adopted gateway. The port-related configuration(like ACL) will lost after changing the model, so it is recommended to call this method before all gateway pre-configuration.","operationId":"modifyGatewayModel","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsgModelOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/intelli-recover/auto-setting/modify":{"post":{"tags":["Intelli Recover Device"],"summary":"Modify intelli recover setting","description":"Modify intelli recover setting","operationId":"modifyIntelliRecoverSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntelliRecoverSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/vouchers/batch/print":{"post":{"tags":["Voucher"],"summary":"Get selected vouchers in a voucher group","description":"Get selected vouchers brief in a voucher group.","operationId":"printVouchers","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectIdsOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListVoucherBriefOpenApiVO"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/vouchers/batch/delete":{"post":{"tags":["Voucher"],"summary":"Delete selected vouchers","description":"Delete selected vouchers with the given params.","operationId":"deleteVouchers","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectIdsOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/voucher-groups":{"get":{"tags":["Voucher"],"summary":"Get Voucher Group List","description":"Get Voucher Group List with the given params.","operationId":"getGridVoucherGroups","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.createTime","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"filters.timeStart","in":"query","description":"Filter query parameters, support field time range: start timestamp (ms).","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"filters.timeEnd","in":"query","description":"Filter query parameters, support field time range: end timestamp (ms).","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOVoucherGroupOpenApiVO"}}}}},"x-order":2},"post":{"tags":["Voucher"],"summary":"Create a new Voucher Group","description":"Create a Voucher Group with the given params.","operationId":"createVoucherGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVoucherGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCreatedResIdOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/voucher-groups/batch/print-unused":{"post":{"tags":["Voucher"],"summary":"Get unused vouchers in selected voucher groups","description":"Get unused vouchers brief information in selected voucher groups.","operationId":"printSelectedVoucherGroups","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectVoucherGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListVoucherBriefOpenApiVO"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/voucher-groups/batch/delete":{"post":{"tags":["Voucher"],"summary":"Delete selected Voucher Groups","description":"Delete selected Voucher Groups with the given params.","operationId":"deleteSelectedVoucherGroups","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectVoucherGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/voucher-groups/batch/clear-invalid":{"post":{"tags":["Voucher"],"summary":"Delete expired vouchers in voucher groups","description":"Delete expired vouchers in selected voucher group.","operationId":"clearInvalidVouchersInSelectedGroups","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectVoucherGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/surveys":{"get":{"tags":["Form Auth Data"],"summary":"Get authentication survey list","description":"Get authentication survey list in a site by the given omadacId, siteId.","operationId":"getAuthForms","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.createTime","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.answerNum","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListFormAuthOpenApiVO"}}}}},"x-order":4},"post":{"tags":["Form Auth Data"],"summary":"Create a new authentication survey","description":"Create a authentication survey in a site with the given params.","operationId":"createAuthForm","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFormAuthOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCreatedResIdOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/surveys/{surveyId}/auth-results":{"get":{"tags":["Form Auth Data"],"summary":"Get authentication result lists for given survey","description":"Get an authentication survey's result list with given omadacId, siteId, surveyId.","operationId":"getFormAuthResults","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"surveyId","in":"path","description":"Auth survey ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.formAuth","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOFormAuthResultOpenApiVO"}}}}},"x-order":6},"post":{"tags":["Form Auth Data"],"summary":"Delete selected authentication survey results for given surveyId","description":"Delete selected authentication survey results in a site with given omadacId, siteId, surveyId.","operationId":"deleteSelectedFormAuthResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"surveyId","in":"path","description":"Survey authentication ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Form Auth Result Selector"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/portal/candidates":{"post":{"tags":["Authentication"],"summary":"Get portal SSIDs and networks","description":"Get SSIDs and network of the portals","operationId":"getPortalCandidates","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalCandidatesOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePortalCandidatesResOpenApiVO"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/operators":{"get":{"tags":["Hotspot Operators"],"summary":"Get hotspot operators list","description":"Get hotspot operators list.","operationId":"getHotspotOperatorList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name,note","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOperator Response"}}}}},"x-order":1},"post":{"tags":["Hotspot Operators"],"summary":"Create a new hotspot operator","description":"Create a new hotspot operator.","operationId":"createHotspotOperator","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Hotspot Operator"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/localusers":{"get":{"tags":["Local User"],"summary":"Get local user list","description":"Get local user list in a site with the given omadacId, siteId, params.","operationId":"getLocalUsers","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field user_name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOLocalUserOpenApiVO"}}}}},"x-order":4},"post":{"tags":["Local User"],"summary":"Create a new local user","description":"Create a local user with the given params.","operationId":"createLocalUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLocalUserOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCreatedResIdOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/localusers/{id}":{"get":{"tags":["Local User"],"summary":"Get a local user for given localuserId","description":"Get a local user with the given omadacId, siteId, local user ID.","operationId":"getLocalUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"local user ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLocalUserOpenApiVO"}}}}},"x-order":3},"post":{"tags":["Local User"],"summary":"Modify an existing localuser","description":"Modify an existing local user with the given omadacId, siteId, localuserId.","operationId":"modifyLocalUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Local user ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyLocalUserOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5},"delete":{"tags":["Local User"],"summary":"Delete an existing localuser","description":"Delete an existing local user with the given omadacId, siteId, localuserId.","operationId":"deleteLocalUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Local user ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/localusers/{id}/clear-dynamic-mac":{"post":{"tags":["Local User"],"summary":"Clear dynamic mac","description":"Clear dynamic mac with the given omadacId, siteId, localuserId. The mac address binding type should be dynamic binding.","operationId":"clearLocalUserDynamicMac","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Local user ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/localusers/batch/delete":{"post":{"tags":["Local User"],"summary":"Batch delete local users","description":"Delete multiple local users by operation type and the selected IDs.","operationId":"deleteSelectedLocalUsers","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectLocalUsersOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/files/voucher/logos":{"post":{"tags":["Voucher"],"summary":"Upload voucher logo","description":"Upload voucher logo","operationId":"uploadVoucherLogo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["data","file"],"type":"object","properties":{"data":{"$ref":"#/components/schemas/UploadVoucherGroupLogoOpenApiVO"},"file":{"type":"string","description":"At least one of the file or md5 parameters needs to be passed","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePortal Picture Info"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/clients/{clientMac}/unauth":{"post":{"tags":["Authorized Client"],"summary":"Cancel authentication the given client","description":"Cancel the authentication of this client with the given omadacId, siteId, clientMac.","operationId":"cancelAuthClient","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/clients/{clientMac}/auth":{"post":{"tags":["Authorized Client"],"summary":"Authentication the given client","description":"Authentication this client with the given omadacId, siteId, clientMac","operationId":"authClient","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC, format: AA-BB-CC-DD-EE-FF.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/authed-records/{id}/period":{"post":{"tags":["Authorized Client"],"summary":"Modify period for given authed record","description":"Extend the valid time of the authentication record with the given omadacId, siteId, authClientId.","operationId":"extendHotspotAuthedClient","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Authed record ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtendOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/authed-records/{id}/disconnect":{"post":{"tags":["Authorized Client"],"summary":"Disconnect authed client ","description":"Disconnect the authentication record with the given omadacId, siteId, authClientId.","operationId":"disconnectHotspotAuthedClient","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Local user ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/authed-records/delete":{"post":{"tags":["Authorized Client"],"summary":"Delete all invalid authed record","description":"Delete all authentication record withs the given omadacId, siteId, authClientId.","operationId":"deleteAllInvalidAuthedClients","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Delete Filter Info"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/authed-client-list":{"post":{"tags":["Authorized Client"],"summary":"Export global authed client list","description":"Export global authed client list with the given omadacId, siteId.","operationId":"exportAuthedClientListGlobalByCloudAccess","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportAuthedClientOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/health/switches/rankingCards":{"post":{"tags":["Statistic"],"summary":"Get switch ranking cards","description":"Get switch ranking cards","operationId":"getOswRankingCards","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimeQueryOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswRankingCardsOpenApiVO"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/speedTest":{"post":{"tags":["Dashboard"],"summary":"Start Speed Test","description":"Start Speed Test.","operationId":"startSpeedTestV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiSpeedTestSelectPortsVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseStartSpeedTestV2ResultVO"}}}}},"x-order":30}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/speedTestResult/dateList":{"post":{"tags":["Dashboard"],"summary":"Get date list of speed test results","description":"Get date list of speed test results.","operationId":"getSpeedTestV2ResultDateList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiQuerySpeedTestDateListVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOSpeedTestV2ResultItemOpenApiVO"}}}}},"x-order":32}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/sim/sms/send":{"post":{"tags":["SIM"],"summary":"Send SMS message","description":"Send SMS message.","operationId":"sendSmsMessageByMac","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessage"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":34}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/sim/sms/operate":{"post":{"tags":["SIM"],"summary":"Operate SMS message by mac","description":"Operate SMS message by mac.","operationId":"operateSmsMessageByMac","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperateMessage"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":35}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/sim/sms/export":{"post":{"tags":["SIM"],"summary":"Export SMS message by mac","description":"Export SMS message by mac.This interface has been deprecated. Please use the following interfaces instead: Export SMS message by mac V2.","operationId":"exportSmsMessageBymac","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportMessage"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":36}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/sim/correct":{"post":{"tags":["SIM"],"summary":"Correct SIM data","description":"Correct SIM data.","operationId":"correctSimQuotaByMac","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorrectSimQuota"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":37}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/profiles/apns":{"get":{"tags":["Profiles"],"summary":"Get APN profile list by mac for ippt","description":"Get APN profile list of the site with the given omadacId, siteId and mac for ippt.","operationId":"getApnProfilesForIppt","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApnProfileData"}}}}},"x-order":47},"post":{"tags":["Profiles"],"summary":"Create a new APN profile by mac","description":"Create a new APN profile by mac with the given params.","operationId":"createApnProfileByMac","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApnProfileConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":48}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/ports/{port}/restart":{"post":{"tags":["Gateway"],"summary":"Recovery gateway poe port","description":"Recovery gateway poe port","operationId":"recoveryPoePort","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"port","in":"path","description":"Gateway port number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/mails":{"get":{"tags":["SIM"],"summary":"Get mail server by mac","description":"Get mail server by mac.","operationId":"getMailServerByMac","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMailServerOpenApiVO"}}}}},"x-order":25},"post":{"tags":["SIM"],"summary":"Create mail server by mac","description":"Create mail server by mac.","operationId":"createMailServerByMac","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailServerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":26}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/internet-state":{"post":{"tags":["Gateway"],"summary":"Change Internet State","description":"change internet state","operationId":"changeInternetState","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeInternetStateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":27}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/change-mode":{"post":{"tags":["Gateway"],"summary":"Change mode for 5G-Outdoor","description":"Change mode for 5G-Outdoor","operationId":"changeOduMode","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeOduModeVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":38}},"/openapi/v1/{omadacId}/sites/{siteId}/full-channel-detect/status":{"post":{"tags":["Insight"],"summary":"Get the interference detection status","description":"Get the interference detection status","operationId":"getBatchFullChannelDetectStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryBatchFullChannelDetectStatusVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListBatchFullChannelDetectStatusOpenApiVO"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sites/{siteId}/full-channel-detect-start":{"post":{"tags":["Insight"],"summary":"Enable batch interference detection","description":"Enable batch interference detection","operationId":"startBatchFullChannelDetect","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartBatchFullChannelDetectCmdOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":27}},"/openapi/v1/{omadacId}/sites/{siteId}/files/hotspot/local-users":{"get":{"tags":["Local User"],"summary":"Download local user file (excel or csv) by localhost","description":"Download local user file (excel or csv) by localhost.","operationId":"downloadLocalUsers","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"portals","in":"query","description":"Portal ids of the portals to download local user file from.","required":true,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name,username","required":false,"schema":{"type":"string"}},{"name":"fileType","in":"query","description":"Local user file format: csv or xlsx.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":8},"post":{"tags":["Local User"],"summary":"Upload local user file (excel or csv) by localhost","description":"Upload local user file (excel or csv) by localhost.","operationId":"uploadLocalUsers","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["config","file"],"type":"object","properties":{"config":{"$ref":"#/components/schemas/HotspotPortalsOpenApiVO"},"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/favorites":{"post":{"tags":["Controller Settings"],"summary":"Favorite site","description":"Favorite site","operationId":"favoriteSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/favorites/cancels":{"post":{"tags":["Controller Settings"],"summary":"Cancel favorite site","description":"Cancel favorite site","operationId":"cancelFavoriteSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/dhcpSnoops":{"get":{"tags":["Dhcp Snooping"],"summary":"Get dhcp snoop list","description":"Get dhcp snoop list","operationId":"getGridDhcpSnoops","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":1},"post":{"tags":["Dhcp Snooping"],"summary":"Create new dhcp snoops","description":"Create new dhcp snoops","operationId":"createDhcpSnoops","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DhcpSnoopVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseIdVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/dhcpSnoops/impbs":{"post":{"tags":["Dhcp Snooping"],"summary":"Get the impbs with given omadacid, siteid and mac and stackId.","description":"Get the impbs with given omadacid, siteid and mac and stackId.","operationId":"getDhcpSnoopImpbs","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DhcpSnoopImbpVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/dhcp-lease-time":{"post":{"tags":["Gateway"],"summary":"Get gateway dhcp client lease time","description":"Get gateway dhcp client lease time.","operationId":"getClientDhcpLeaseTimes","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDhcpLeaseTimeVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListClientDhcpLeaseTimeOpenApiVO"}}}}},"x-order":40}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/{deviceMac}/start-online-upgrade":{"post":{"tags":["Device"],"summary":"Start online upgrade","description":"Upgrade the device with the latest firmware in the cloud. It is suggested to check firmware update before the operation, or the firmware might not be the latest","operationId":"onlineUpgrade","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":104}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/{deviceMac}/start-adopt":{"post":{"tags":["Device"],"summary":"Start adopt device","description":"Start adopt device.This interface does not return the actual adoptive result, you need to use the interface:Get device adopt result to obtain the adoptive result","operationId":"adoptDevice","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdoptDeviceRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/{deviceMac}/site-move":{"post":{"tags":["Device"],"summary":"Move site","description":"Move the device to another site. If you want to move a networked bridge AP, use the \"batch move ap site\" interface to move all APs in the bridge network at the same time.","operationId":"moveSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceMoveSiteOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/{deviceMac}/replace-device/check":{"post":{"tags":["Device"],"summary":"Check replace record","description":"Check replace record.","operationId":"checkReplaceRecord","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckReplaceVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseReplaceConfigRespVO"}}}}},"x-order":51}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/{deviceMac}/remember":{"get":{"tags":["Device"],"summary":"Get device remember Config","description":"Get device remember Config","operationId":"getDeviceRememberMe","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceRememberConfig"}}}}},"x-order":17},"post":{"tags":["Device"],"summary":"Modify device remember Config","description":"Modify device remember Config","operationId":"modifyDeviceRememberMe","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceRememberConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/{deviceMac}/reboot":{"post":{"tags":["Device"],"summary":"Reboot device","description":"Reboot device.","operationId":"rebootDevice","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/{deviceMac}/locate":{"post":{"tags":["Device"],"summary":"Locate device","description":"Locate device.","operationId":"locateDevice","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocateDeviceRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/{deviceMac}/forget":{"post":{"tags":["Device"],"summary":"Forget device","description":"Forget device.","operationId":"forgetDevice","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/{deviceMac}/force-provision":{"post":{"tags":["Device"],"summary":"Force provision device","description":"Force provision device.","operationId":"forceProvisionDevice","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/{deviceMac}/add/retry":{"post":{"tags":["Device"],"summary":"Retry add device","description":"Retry add device","operationId":"retryAddDevice","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryAddDeviceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseRetryAddDeviceRespOpenApiVO"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/uplink-info":{"post":{"tags":["Device"],"summary":"Query uplink information for specified device MAC addresses under the site.","description":"Query uplink information for specified device MAC addresses under the site.","operationId":"getUplinkDeviceInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryDeviceUplinkOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListDeviceUplinkOpenApiVO"}}}}},"x-order":45}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/upgrade-file":{"post":{"tags":["Device"],"summary":"Upload device firmware","description":"Upload device firmware for manually upgrade.","operationId":"uploadUpgradeFile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"Upload a file in request body.","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseFile"}}}}},"x-order":109}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/tag":{"get":{"tags":["Device"],"summary":"Get tag list","description":"Get tag list.","operationId":"getTags","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TagRespOpenApiVO"}}}}}},"x-order":12},"post":{"tags":["Device"],"summary":"Create new tag","description":"Create new tag.","operationId":"addTag","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TagRespOpenApiVO"}}}}},"x-order":9},"delete":{"tags":["Device"],"summary":"Delete an existing tag","description":"Delete an existing tag.","operationId":"deleteTag","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteTagOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11},"patch":{"tags":["Device"],"summary":"Modify an existing tag","description":"Modify an existing tag.","operationId":"modifyTag","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyTagOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/sn-unbind-active":{"post":{"tags":["Device"],"summary":"Change the license from the old device to the new device","description":"Change the license from the old device to the new device (using the same license).","operationId":"unbindActiveDeviceBySn","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbindActiveDeviceSnOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":55}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/multi-add":{"post":{"tags":["Device"],"summary":"Batch add devices","description":"Batch add devices.This interface has been deprecated. Please use the following interface instead: Batch add devices by SN","operationId":"addDevices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceListAddOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceAddRespOpenApiVO"}}}}},"deprecated":true,"x-order":49}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/locate/switch-ports":{"post":{"tags":["Device"],"summary":"Locate multiple ports of multiple switches","description":"Locate multiple ports of multiple switches","operationId":"locatePorts","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocateOswPortsOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLocateOswPortsResultOpenApiVO"}}}}},"x-order":44}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/incidents":{"post":{"tags":["Device"],"summary":"Get site device incident counts","description":"Get incident counts for the specified devices in a site.","operationId":"getDeviceIncidentCounts","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceIncidentCountRequestOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceIncidentCountResultOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/export":{"post":{"tags":["Device"],"summary":"Export device list of site","description":"Export device list of site.","operationId":"exportSiteDeviceList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportGlobalDeviceListOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":33}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/copy":{"post":{"tags":["Device"],"summary":"Copy configuration","description":"Copy the configuration of one device to another device of the same model. Only for switch and access point.","operationId":"copyDeviceConfiguration","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceCopyConfigurationOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/tabs":{"get":{"tags":["Dashboard"],"summary":"Get tab list","description":"Get tab list.","operationId":"listAllTabs","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListListTabs"}}}}},"x-order":2},"post":{"tags":["Dashboard"],"summary":"Create new tab","description":"Create tab.","operationId":"createTab","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTabOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/clientTraffic":{"get":{"tags":["Application Control"],"summary":"Get clients traffic","description":"Get clients traffic.","operationId":"getClientTraffic","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientTrafficGridVOClientTrafficWithApplicationDetail"}}}}},"x-order":38},"post":{"tags":["Application Control"],"summary":"Get clients traffic V2","description":"Get clients traffic V2.","operationId":"getClientTrafficV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientTrafficOpenApiQueryDataVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientTrafficGridVOClientTrafficWithApplicationDetail"}}}}},"x-order":43}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/vpn/stats/tunnel/terminate":{"post":{"tags":["Insight"],"summary":"Terminating vpn tunnel","description":"Terminating vpn tunnel","operationId":"terminateVpnTunnel","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OsgVpnTunnelOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/stacks/{stackId}/reboot":{"post":{"tags":["Stack"],"summary":"Reboot switch stack","description":"Reboot switch stack.","operationId":"rebootOswStack","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswStackRebootOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListRebootResultVO"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/stacks/{stackId}/locate":{"post":{"tags":["Stack"],"summary":"Locate switch stack","description":"Locate switch stack.","operationId":"locateOswStack","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswStackLocateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLocateResultVO"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/stack/{stackId}/forget":{"post":{"tags":["Stack"],"summary":"Forget stack","description":"Forget stack.","operationId":"forgetStack","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/stack/{stackId}/forceProvision":{"post":{"tags":["Stack"],"summary":"Force provision stack","description":"Force provision stack.","operationId":"forceProvisionStack","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/speedTest":{"post":{"tags":["Wired Network"],"summary":"SpeedTest","description":"SpeedTest. This interface had been deprecated.","operationId":"speedTest","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternetOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":48}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/rogueaps/scan":{"post":{"tags":["Insight"],"summary":"Scan Rogue APs","description":"Scan Rogue APs","operationId":"scanRogueAps","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/rfPlanning/rrmOptimization":{"post":{"tags":["WLAN Optimization"],"summary":"start Rrm Optimization","description":"start Rrm Optimization","operationId":"startRrmOptimization","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Optimization Strategy"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/rfPlanning/optimization":{"post":{"tags":["WLAN Optimization"],"summary":"start Optimization","description":"start Optimization","operationId":"startOptimization","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Optimization Strategy"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/rfPlanning/cancel":{"post":{"tags":["WLAN Optimization"],"summary":"cancel Radio Frequency Planning","description":"cancel Radio Frequency Planning","operationId":"cancelRadioFrequencyPlanning","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/olts/move":{"post":{"tags":["OLT"],"summary":"Move OLT to another site","description":"Move OLT to another site","operationId":"moveToSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveToSiteVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMoveSiteProcessVO"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/mlag/{mlagId}/reboot":{"post":{"tags":["Mlag"],"summary":"Reboot M-LAG group","description":"Reboot M-LAG group.","operationId":"rebootMlag","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"mlagId","in":"path","description":"M-LAG ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MlagRebootOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/mlag/{mlagId}/locate":{"post":{"tags":["Mlag"],"summary":"Locate M-LAG group","description":"Locate M-LAG group.","operationId":"locateMlag","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"mlagId","in":"path","description":"M-LAG ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MlagLocateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLocateResultVO"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/gateways/{gatewayMac}/isp-upgrade":{"post":{"tags":["Gateway"],"summary":"Upgrade isp","description":"Upgrade isp","operationId":"ispUpgrade","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayIspUpgrade"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/gateways/{gatewayMac}/ipv6State":{"post":{"tags":["Gateway"],"summary":"Modify IPv6 state","description":"Modify IPv6 state","operationId":"changeIpv6State","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyIpv6State"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/gateways/move":{"post":{"tags":["Gateway"],"summary":"Move devices to another site","description":"Move devices to another site","operationId":"moveToSite_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveToSite"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/devices/onlineRollingUpgrade":{"post":{"tags":["Device"],"summary":"Start batch rolling upgrade By Query","description":"Perform batch online upgrades of devices in a specific order within the site, and filter them using filter conditions. It is recommended to check the firmware update status before the operation, otherwise the firmware may not be the latest version","operationId":"onlineRollingUpgradeByQuery","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filters.ecspFirstVersion","in":"query","description":"Filter query parameters, support field ecsp first version. 1: ecsp v1; 2: ecsp v2","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RollingUpgradeRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUpgradeTask"}}}}},"x-order":112}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/devices/batch-adopt":{"post":{"tags":["Device"],"summary":"batch adopt device","description":"batch adopt device.This interface does not return the actual adoptive result,you need to use the interface:Get device adopt result to obtain the adoptive result","operationId":"batchAdopt","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchAdoptDeviceRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/devices/auto-adopt":{"post":{"tags":["app"],"summary":"auto adopt site url device by app","description":"auto adopt site url device by app","operationId":"autoAdopt","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoAdoptDeviceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAutoAdoptResponseOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/clients/{clientMac}/unblock":{"post":{"tags":["Client"],"summary":"Unblock the client","description":"Unblock the client.","operationId":"unblockClient","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/clients/{clientMac}/reconnect":{"post":{"tags":["Client"],"summary":"Reconnect the client","description":"Reconnect the client.","operationId":"reconnectClient","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/clients/{clientMac}/reboot":{"post":{"tags":["Client"],"summary":"Reboot the client","description":"Reboot the client.","operationId":"rebootClient","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client Reboot"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/clients/{clientMac}/lock-to-ap":{"post":{"tags":["Client"],"summary":"Lock the given client to aps","description":"Lock the given client to aps.","operationId":"updateClientLockToApSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client Lock To AP Setting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/clients/{clientMac}/disconnect":{"post":{"tags":["Client"],"summary":"Disconnect the client","description":"Disconnect the client.","operationId":"disconnectClient","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/clients/{clientMac}/client-link-topology":{"post":{"tags":["Client"],"summary":"Get client link topology","description":"Get client link topology.","operationId":"getClientTopology","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListClient Topology Nodes Info"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/clients/{clientMac}/block":{"post":{"tags":["Client"],"summary":"Block the client","description":"Block the client.","operationId":"blockClient","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/clients/incidents":{"post":{"tags":["Client"],"summary":"Get site client incident counts","description":"Get incident counts for the specified clients in a site.","operationId":"getClientIncidentCounts","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientIncidentCountRequestOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientIncidentCountResultOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/clients/delete":{"post":{"tags":["Client"],"summary":"Batch delete clients","description":"Batch delete clients.","operationId":"deleteClients","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client Delete Filter"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClient Detail"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/clients/config":{"post":{"tags":["Client"],"summary":"Batch config clients","description":"Batch config clients.","operationId":"batchModifyClientSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client Batch Setting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClient Detail"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/client/realtime/cards":{"post":{"tags":["Client Insight"],"summary":"Get real-time client cards.","description":"Get real-time client distribution cards (e.g. by RSSI, SNR) with customizable buckets.","operationId":"getRealTimeClientCards","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCardsQueryOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientCardsResultOpenApiVO"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/sites/{siteId}/client-stat-detail/{clientMac}/hourly":{"post":{"tags":["Client"],"summary":"Get client statistical data details at a hourly interval.","description":"Get client statistical data details at a hourly interval.","operationId":"getClientDetailStatHourly","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client Stat Query"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClient Statistical Data Detail Result"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/client-stat-detail/{clientMac}/daily":{"post":{"tags":["Client"],"summary":"Get client statistical data details at a daily interval.","description":"Get client statistical data details at a daily interval.","operationId":"getClientDetailStatDaily","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client Stat Query"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClient Statistical Data Detail Result"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/sites/{siteId}/client-stat-detail/{clientMac}/5Min":{"post":{"tags":["Client"],"summary":"Get client statistical data details at a 5-minute interval.","description":"Get client statistical data details at a 5-minute interval.","operationId":"getClientDetailStat5Min","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client Stat Query"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClient Statistical Data Detail Result"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/sites/{siteId}/cli/import/variable":{"post":{"tags":["CLI"],"summary":"Import CLI variable","description":"Import CLI variable","operationId":"importCliVariableToFile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"File must be a file in .csv or .json form","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseImportCliVarOpenApiVO"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/cli/export/variable":{"post":{"tags":["CLI"],"summary":"Export CLI variable","description":"Export CLI variable,filename is a UTF-8 string encoded by URL Encoder","operationId":"exportCliVariableToFile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportCliVarOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/cli/configs/config-id/{configId}/apply":{"post":{"tags":["CLI"],"summary":"Apply the CLI configuration","description":"Apply the CLI configuration","operationId":"applyCliConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"CLI Config ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/cli/config/cli-type/{cliType}/save":{"post":{"tags":["CLI"],"summary":"Create a new CLI configuration","description":"Create a new CLI configuration","operationId":"createCliConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"cliType","in":"path","description":"CLI type should be a value as follows: 0: site CLI; 1: device CLI； 2：model CLI. Site template only supports site CLI. Site template only supports site CLI.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyCliOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/capture/device-type/{deviceType}/{deviceMac}/start":{"post":{"tags":["Network Analyze"],"summary":"Start package capturing","description":"Start package capturing.","operationId":"startPackageCapture","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceType","in":"path","description":"Device type, and should be a value in [ap, switch, gateway].","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PackageCaptureConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCaptureInfo"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/cable-test/switches/{switchMac}/start":{"post":{"tags":["Switch"],"summary":"Start cable test","description":"Start cable test.","operationId":"startCableTest","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswCableTestTestingPortOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":31}},"/openapi/v1/{omadacId}/sites/{siteId}/cable-test/switches/{switchMac}/cancel":{"post":{"tags":["Switch"],"summary":"Cancel cable test","description":"Cancel cable test.","operationId":"cancelCableTest","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":32}},"/openapi/v1/{omadacId}/sites/{siteId}/cable-test/stacks/{stackId}/start":{"post":{"tags":["Stack"],"summary":"Start stack cable test","description":"Start stack cable test.","operationId":"startStackCableTest","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswCableTestTestingPortOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sites/{siteId}/cable-test/stacks/{stackId}/cancel":{"post":{"tags":["Stack"],"summary":"Cancel stack cable test","description":"Cancel stack cable test.","operationId":"cancelStackCableTest","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/bandwidth-control/rules":{"get":{"tags":["Bandwidth Control"],"summary":"Get bandwidth control rule list","description":"Get bandwidth control rule list.","operationId":"getGridBandwidthCtrlRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOBandwidthControlRule"}}}}},"x-order":3},"post":{"tags":["Bandwidth Control"],"summary":"Create bandwidth control rule","description":"Create bandwidth control rule.","operationId":"createBandwidthCtrlRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BandwidthControlRule"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"patch":{"tags":["Bandwidth Control"],"summary":"Modify bandwidth control rule index","description":"Modify bandwidth control rule index.","operationId":"modifyBandwidthCtrlRuleIndex","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransmissionDragSortIndexOpenapiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/arpDetects":{"get":{"tags":["Arp Detection"],"summary":"Get arp detect list","description":"Get arp detect list","operationId":"getGridArpDetects","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":1},"post":{"tags":["Arp Detection"],"summary":"Create new arp detects","description":"Create new arp detects","operationId":"createArpDetects","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArpDetectVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseIdVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/arpDetects/portLagVlans":{"post":{"tags":["Arp Detection"],"summary":"Get the port or standard port or lag to vlans map of one osw.","description":"Get the port or standard port or lag to vlans map of one osw.","operationId":"getOswPortLagIdVlans","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArpDetectOswVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/arpDetects/impbs/import":{"post":{"tags":["Arp Detection"],"summary":"Import the static impbs from file.","description":"Import the static impbs from file.","operationId":"importArpDetectImpbsFromFile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/stop-paring-window":{"post":{"tags":["Ap"],"summary":"Bridge AP Stop Paring Window","description":"Bridge AP Stop Paring Window","operationId":"stopParingWindow","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":74}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/start-speed-test":{"post":{"tags":["Ap"],"summary":"Start speed test","description":"The speed test is initiated by device [apMac]. Different MAC addresses indicates a different speed test.(Only for P2P device)","operationId":"triggerSpeedTest","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpeedTestCommand"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":37}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/start-rf-scan":{"post":{"tags":["Ap"],"summary":"Start rf scan","description":"Wi-Fi connection will lost for several minutes during the scanning. Please select a spare time of network to start scanning. This interface has been deprecated. Please use the following interface instead: Start rf scan v2.","operationId":"triggerRadioFrequencyScan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/start-paring-window":{"post":{"tags":["Ap"],"summary":"Bridge AP Start Paring Window","description":"Bridge AP Start Paring Window","operationId":"startParingWindow","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":73}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/spectral-scan-stop":{"post":{"tags":["Insight"],"summary":"Stop environment scanning","description":"Stop environment scanning","operationId":"stopSpectralScan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/spectral-scan-start":{"post":{"tags":["Insight"],"summary":"Enable environment scanning","description":"Enable environment scanning","operationId":"triggerSpectralScan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/location-gps":{"post":{"tags":["Ap"],"summary":"Update AP location info use GPS","description":"Update AP location info use GPS, only support gps function aps can get valid data.","operationId":"updateApLocationUseGps","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApLocationConfigOpenApiVO"}}}}},"x-order":57}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/full-channel-detect-start":{"post":{"tags":["Insight"],"summary":"Enable interference detection","description":"Enable interference detection","operationId":"triggerFullChannelDetect","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullChanScanCommandOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/site-move":{"post":{"tags":["Device"],"summary":"Move aps to another site","description":"Move aps to another site. If you want to move networked bridge APs, ensure all APs in the bridge network are in movable state and move them at the same time. This interface will not move non-AP devices.","operationId":"moveSiteForAps","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApMoveSiteOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMoveSiteIdOpenApiVO"}}}}},"x-order":41}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/ports/config":{"post":{"tags":["Ap"],"summary":"Batch modify multiple APs port config","description":"Batch modify multiple APs port config.","operationId":"batchModifyMultiApPorts","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchUpdateMultiApPortsOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":34}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/ports/capability":{"post":{"tags":["Ap"],"summary":"Get multiple APs port capability","description":"Get port capability information for multiple APs. This interface has been deprecated.","operationId":"getMultiApPortList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiApPortCapOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListAP LAN Port List"}}}}},"deprecated":true,"x-order":33}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/channel-info":{"post":{"tags":["Ap"],"summary":"Get ap list channel info.","description":"Get ap list channel info.","operationId":"getApListChannelInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AP MAC list"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApChannelInfoOpenApiVO"}}}}},"x-order":72}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/change-role":{"post":{"tags":["Ap"],"summary":"Change p2p AP role","description":"Switch p2p AP role from main to client or client to main.","operationId":"changeP2pRole","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeP2pRole"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":39}},"/openapi/v1/{omadacId}/sites/{siteId}/applicationControl/rules":{"get":{"tags":["Application Control"],"summary":"Get rule list","description":"Get rule list.","operationId":"getRules","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field rule name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVORuleResultEntity"}}}}},"x-order":11},"post":{"tags":["Application Control"],"summary":"Create new rule","description":"Create new rule.","operationId":"addRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddRuleEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseRuleResultEntity"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/applicationControl/restrictions":{"get":{"tags":["Application Control"],"summary":"Get application control assigned restriction list","description":"Get application control assigned restriction list with the given omadacId, siteId.","operationId":"getAssignRestrictions","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVORestrictionResultEntity"}}}}},"x-order":3},"post":{"tags":["Application Control"],"summary":"Create new restriction assigned to lan network","description":"Create new restriction assigned to lan network.","operationId":"addAssignRestriction","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestrictionEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseRestrictionResultEntity"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/applicationControl/filters":{"get":{"tags":["Application Control"],"summary":"Get filter list","description":"Get filter list.","operationId":"getFilters","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field filter name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOFilterEntity"}}}}},"x-order":7},"post":{"tags":["Application Control"],"summary":"Create new filter","description":"Create new filter.","operationId":"addFilter","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddFilterEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseFilterEntity"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/ap-oui-rules":{"get":{"tags":["OUI Based VLAN"],"summary":"Get Ap oui based vlan list","description":"Get Ap oui based vlan list.","operationId":"getGridApOuiBasedVlan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOuiBasedVlanApQueryOpenApiVO"}}}}},"x-order":6},"post":{"tags":["OUI Based VLAN"],"summary":"Create Ap oui based vlan","description":"Create Ap oui based vlan.","operationId":"createApOuiBasedVlan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OuiBasedVlanApOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResIdOpenApiVO"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/ap-groups":{"get":{"tags":["Wireless Network"],"summary":"Get AP Group list","description":"Get AP Group list","operationId":"getApGroupList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApGroupGridVOApGroupOpenApiVO"}}}}},"x-order":1},"post":{"tags":["Wireless Network"],"summary":"Create new AP Group","description":"Create new AP Group","operationId":"createApGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAddApGroupResultVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/anomaly/overview/ranking-cards":{"post":{"tags":["Incidents"],"summary":"Get incident overview ranking cards","description":"Get incident overview ranking cards.","operationId":"getRankingCards","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncidentRankingQueryVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseIncidentRankingResultVO"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/anomaly/incidents/status":{"post":{"tags":["Incidents"],"summary":"Modify aggregate incident status","description":"Modify the status of aggregate incidents.","operationId":"modifyAggregateIncidentStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnomalyTimerSettingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseObject"}}}}}}},"/openapi/v1/{omadacId}/sites/{siteId}/anomaly/incidents/ranking-cards":{"post":{"tags":["Incidents"],"summary":"Get incidents ranking cards","description":"Get incidents ranking cards.","operationId":"getIncidentsRanking","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncidentRankingQueryVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseIncidentRankingResultVO"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/anomaly/incident/status":{"post":{"tags":["Incidents"],"summary":"Modify incident status","description":"Modify the status of incidents. For select-all operations, if both start and end are omitted, the server defaults to the last 30 days; a supplied time range is preserved.","operationId":"modifyIncidentStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnomalyListSettingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseObject"}}}}}}},"/openapi/v1/{omadacId}/sites/{siteId}/all-devices/start-check-latest-firmware":{"post":{"tags":["Device"],"summary":"Start check latest firmware for all devices","description":"Start a task to query the latest firmware of all devices in the cloud.","operationId":"onlineCheckUpgrade","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUpgradeTask"}}}}},"x-order":101}},"/openapi/v1/{omadacId}/sites/{siteId}/acls/osw-acls":{"get":{"tags":["ACL"],"summary":"Get switch ACL list","description":"Get switch ACL list.","operationId":"getOswAclList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOSwitchACLInfo"}}}}},"x-order":4},"post":{"tags":["ACL"],"summary":"Create new switch ACL","description":"Create new switch ACL.","operationId":"createOswAcl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchACLConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/acls/osg-custom-acls/modifyIndex":{"post":{"tags":["ACL"],"summary":"Modify gateway custom ACL index","description":"Modify gateway custom ACL index","operationId":"modifyOsgCustomAclIndex","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DragSortIndexOpenapiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/acls/osg-custom-acls/hit-counts":{"post":{"tags":["ACL"],"summary":"Clear gateway custom ACL hit counts","description":"Clear gateway custom ACL hit counts","operationId":"clearOsgHitCounts","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sites/{siteId}/acls/osg-acls":{"get":{"tags":["ACL"],"summary":"Get gateway ACL list","description":"Get gateway ACL list.","operationId":"getOsgAclList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOGatewayACLInfo"}}}}},"x-order":7},"post":{"tags":["ACL"],"summary":"Create new gateway ACL","description":"Create new gateway ACL.","operationId":"createOsgAcl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayACLConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/acls/osg-acls/hit-counts":{"post":{"tags":["ACL"],"summary":"Clear gateway ACL hit counts","description":"Clear gateway ACL hit counts","operationId":"clearOsgAclHitCounts","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":30}},"/openapi/v1/{omadacId}/sites/{siteId}/acls/modifyIndex":{"post":{"tags":["ACL"],"summary":"Modify ACL Index","description":"Modify ACL Index.","operationId":"modifyAclIndex","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DragSortIndexOpenapiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/acls/gateway-acls/batch-edit":{"post":{"tags":["ACL"],"summary":"batch Edit Osg Custom Acls","description":"batch Edit Osg Custom Acls","operationId":"batchEditOsgCustomAclStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchEditCustomAclOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/sites/{siteId}/acls/gateway-acls/batch-delete":{"post":{"tags":["ACL"],"summary":"batch Delete Osg Custom Acls","description":"batch Delete Osg Custom Acls","operationId":"batchDeleteOsgCustomAcls","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/batchIds"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/acls/eap-acls":{"get":{"tags":["ACL"],"summary":"Get EAP ACL list","description":"Get EAP ACL list.","operationId":"getEapAclList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOEapACLInfo"}}}}},"x-order":1},"post":{"tags":["ACL"],"summary":"Create new EAP ACL","description":"Create new EAP ACL.","operationId":"createEapAcl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EapACLConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/template":{"post":{"tags":["Site"],"summary":"Create new site from site template","description":"Create new site from site template","operationId":"createNewSiteByTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSiteByTemplate"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/tags":{"get":{"tags":["Site"],"summary":"Get site tag list","description":"Get site tag list.","operationId":"getTags_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Site Tag"}}}}}},"x-order":14},"post":{"tags":["Site"],"summary":"Create new site tag","description":"Create new site tag.","operationId":"addTag_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSiteTagOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Site Tag"}}}}},"x-order":15},"delete":{"tags":["Site"],"summary":"Delete an existing site tag","description":"Delete an existing site tag.","operationId":"deleteTag_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteSiteTagOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":17},"patch":{"tags":["Site"],"summary":"Modify an existing site tag","description":"Modify an existing site tag.","operationId":"modifyTag_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site Tag"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/statistic":{"post":{"tags":["Site"],"summary":"Get sites statistic","description":"Get sites statistic","operationId":"getSiteSummaryStatisticByOpenApi","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteStatisticList"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteSummaryStatistic"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/sites/multi-import":{"post":{"tags":["Site"],"summary":"Batch create sites by importing site backup files from file server","description":"Batch create sites by importing site backup files from file server.","operationId":"batchSiteImport","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchSiteImportVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteResultVO"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/maintenance/multi-restore/self-server":{"post":{"tags":["Backup and Restore"],"summary":"Restore multi sites config from self server","description":"Restore multi sites config from self server. At most 300 sites can be restored.","operationId":"restoreSitesSelfServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchSiteSelfRestoreVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/maintenance/multi-restore/file-server":{"post":{"tags":["Backup and Restore"],"summary":"Restore multi sites config from file server","description":"Restore multi sites config from file server. At most 300 sites can be restored.","operationId":"restoreSitesFileServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchSiteFileServerRestoreVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/maintenance/multi-backup/self-server":{"post":{"tags":["Backup and Restore"],"summary":"Backup multi sites config to self server","description":"Backup multi sites config to self server. At most 300 sites can backup.","operationId":"backupSitesSelfServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchSiteBackupVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/maintenance/multi-backup/file-server":{"post":{"tags":["Backup and Restore"],"summary":"Backup multi sites config to file server","description":"Backup multi sites config to file server. At most 300 sites can backup.","operationId":"backupSitesFileServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileServerSiteBackupVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/copy":{"post":{"tags":["Site"],"summary":"Batch create sites by copying from existing site","description":"Batch create sites by copying from existing site","operationId":"batchSiteCopy","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchSiteCopyVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteResultVO"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/settings/test-mail":{"post":{"tags":["Controller Settings"],"summary":"Send test mail for controller","description":"Send test mail for controller","operationId":"sendTestEmail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMailServerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/security/threat-map":{"post":{"tags":["Global Security"],"summary":"Get Global Threat Map","description":"Get the data for the initial page of the threat map","operationId":"getGlobalThreatMap","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreatMapOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGetThreatMapOpenApiVO"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/security/threat-map/threats":{"post":{"tags":["Global Security"],"summary":"Get Country Threats","description":"Get threats from individual countries","operationId":"getCountryThreats","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryCountryThreatListOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOIpsThreatOpenApiVO"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/security/threat-map/threat-count":{"post":{"tags":["Global Security"],"summary":"Get Global Category","description":"The number of threats to attack countries is displayed in categories","operationId":"getGlobalCategory","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryThreatMapOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseThreatMapCategoryOpenApiVO"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/security/blocked-country":{"post":{"tags":["Global Security"],"summary":"Get Blocked Countries","description":"Get the list of blocked countries","operationId":"getBlockedCountries","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteListOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseBlockedCountryOpenApiVO"}}}}},"x-order":3},"delete":{"tags":["Global Security"],"summary":"Delete blocked countries.","description":"Delete blocked countries.","operationId":"delBlockedCountry","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpsBlockedCountryOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/security/blocked-country/add":{"post":{"tags":["Global Security"],"summary":"Add Blocked Country","description":"Add blocked countries to list","operationId":"addBlockedCountry","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpsBlockedCountryOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sdwan/sdwan-group":{"get":{"tags":["SD-WAN"],"summary":"Get SD-WAN Group Grid.","description":"Get all SD-WAN Group. This interface has been deprecated. Please use the following interfaces instead: getGridSdWanGroupBrief","operationId":"getGridSdWanGroup","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOSdWanGroupDetail"}}}}},"deprecated":true,"x-order":1},"post":{"tags":["SD-WAN"],"summary":"Create SD-WAN Group.","description":"Create SD-WAN Group.","operationId":"createSdWanGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdWanGroup"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sdwan/sdwan-group/recommend/wans":{"post":{"tags":["SD-WAN"],"summary":"Auto recommend WAN port.","description":"Get the result of recommended WAN port with Auto Select.","operationId":"autoSelectWanPortRecommendResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchAutoSelectWanPortReq"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseBatchAutoSelectWanPortResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sdwan/sdwan-group/map/network":{"post":{"tags":["SD-WAN"],"summary":"Auto create mapped network.","description":"Auto create mapped network.","operationId":"autoCreateMappingNetwork","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdWanSelectedMapNetwork"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSdWanMappedNetworkResult"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sdwan/sdwan-group/map/check":{"post":{"tags":["SD-WAN"],"summary":"Check modified mapped network.","description":"Check modified mapped network.","operationId":"checkModifiedMappedNetwork","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckMappedNetwork"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sdwan/sdwan-group/ipPool/check":{"post":{"tags":["SD-WAN"],"summary":"Check SD-WAN IP pool conflict.","description":"Check whether the IP pool conflicts with the IP pool of other SD-WAN groups.","operationId":"checkSdWanGroupIpPool","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdWanIpPoolRange"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":9}},"/openapi/v1/{omadacId}/sdwan/sdwan-group/candidate/devices":{"post":{"tags":["SD-WAN"],"summary":"Get SD-WAN candidate devices.","description":"Get SD-WAN candidate devices.","operationId":"getGridSdWanGroupDevices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuerySdWanCandidateDevice"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOSdWanCandidateDevice"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/scenarios":{"get":{"tags":["Site"],"summary":"Get scenario list","description":"Get scenario list","operationId":"getScenarioList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListString"}}}}},"x-order":9},"post":{"tags":["Site"],"summary":"Create new scenario","description":"Create new scenario","operationId":"addScenario","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Scenario"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListString"}}}}},"x-order":10},"delete":{"tags":["Site"],"summary":"Delete site scenario","description":"Delete site scenario","operationId":"deleteScenario","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Scenario"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/roles":{"get":{"tags":["User and Role"],"summary":"Get role list","description":"Get role list","operationId":"getAllRoles","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListControllerRoleDetailVO"}}}}},"x-order":6},"post":{"tags":["User and Role"],"summary":"Create new role","description":"Create new role. Only user with all permissions modify can use this interface.","operationId":"createNewRole","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyControllerRoleVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCreateRoleResultVO"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/reset/log-notification":{"post":{"tags":["Log"],"summary":"Reset global log notification","description":"Reset global log notification.","operationId":"resetLogSettingGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/owner/transfer":{"post":{"tags":["User and Role"],"summary":"Transfer owner permission to an existing user","description":" Only Owner of current controller can use this interface.This interface only supports the authorization code mode, not the client mode. Please call this interface in authorization code mode.","operationId":"transferRoot","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferRootOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/notification/disable":{"post":{"tags":["System Settings"],"summary":"Turn off the software update push switch","description":"Turn off the software update push switch.","operationId":"disableControllerUpgradeNotification","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/multi-devices/sn-add":{"post":{"tags":["Device"],"summary":"Batch add devices by SN with multi site","description":"Batch add devices by SN with multi site.","operationId":"addDevicesBySnWithMultiSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceListAddMultiSiteBySnOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceAddRespOpenApiVO"}}}}},"x-order":52}},"/openapi/v1/{omadacId}/multi-devices/active":{"post":{"tags":["Device"],"summary":"Batch active devices with multi site","description":"Batch active devices with multi site.","operationId":"activeDeviceWithMultiSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActiveDeviceMultiSiteOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ActiveDeviceRespVO"}}}}}},"x-order":51}},"/openapi/v1/{omadacId}/migrate/exportPreDevice":{"post":{"tags":["Device"],"summary":"Export preconfigured devices in GLOBAL view.","description":"Export preconfigured devices in GLOBAL view.","operationId":"exportPreConfigDevicesGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":35}},"/openapi/v1/{omadacId}/mfa/status":{"get":{"tags":["User and Role"],"summary":"Get the status of the system's Two-Factor Authentication.","description":"Get the status of the system's Two-Factor Authentication.","operationId":"getGlobalMFAStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":9},"post":{"tags":["User and Role"],"summary":"Modify the status of the system's Two-Factor Authentication.","description":"Modify the status of the system's Two-Factor Authentication.","operationId":"modifyGlobalMFAStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MFAConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/maintenance/restore/self-server":{"post":{"tags":["Backup and Restore"],"summary":"Restore controller config from cloud server","description":"Restore controller config from cloud server.","operationId":"restoreSelfServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelfGlobalRestoreVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/maintenance/restore/file-server":{"post":{"tags":["Backup and Restore"],"summary":"Restore controller config from file server","description":"Restore controller config from file server.","operationId":"restoreFileServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileServerGlobalRestoreVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/maintenance/backup/self-server":{"post":{"tags":["Backup and Restore"],"summary":"Backup controller config to cloud server","description":"Backup controller config to cloud server. ","operationId":"backupSelfServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelfGlobalBackupVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/maintenance/backup/file-server":{"post":{"tags":["Backup and Restore"],"summary":"Backup controller config to file server","description":"Backup controller config to file server. ","operationId":"backupFileServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileServerGlobalBackupVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/logs/{upgradeLogId}/upgrade/overview/rollback":{"post":{"tags":["Firmware"],"summary":"Create rollback plan","description":"You can choose a specific time to create a rollback plan","operationId":"createRollback","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"upgradeLogId","in":"path","description":" The Upgrade log ID obtained from the interface (Get firmware upgrade logs)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RollbackCreateInfo"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/logs/{upgradeLogId}/upgrade/overview/failed-model-plan":{"post":{"tags":["Firmware"],"summary":"Create Upgrade Plan for Failed Device","description":"Create Upgrade Plan for Failed Device","operationId":"createFailedDeviceModelPlan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"upgradeLogId","in":"path","description":" The Upgrade log ID obtained from the interface (Get firmware upgrade logs)","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailedCreateModelPlanUpgradeInfo"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCreateFailedDeviceUpgradePlan"}}}}},"x-order":26}},"/openapi/v1/{omadacId}/logs/export":{"post":{"tags":["Log"],"summary":"Export log list in global view","description":"Export log list in global view.","operationId":"exportLogListForGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportLogOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/logs/audit/export":{"post":{"tags":["Audit Log"],"summary":"Export audit log list in global view","description":"Export audit log list in global view.","operationId":"exportAuditLogListForGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportLogOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/license/auto-renew":{"get":{"tags":["License"],"summary":"Get license auto renew","description":"Get license auto renew.","operationId":"getAutoRenew","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLicenseAutoRenewOpenApiVO"}}}}},"x-order":10},"post":{"tags":["License"],"summary":"Modify license auto renew","description":"Modify license auto renew.","operationId":"modifyAutoRenew","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseAutoRenewOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/license/auto-active":{"get":{"tags":["License"],"summary":"Get license auto active","description":"Get license auto active.","operationId":"getAutoActive","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLicenseAutoActiveOpenApiVO"}}}}},"x-order":1},"post":{"tags":["License"],"summary":"Modify license auto active","description":"Modify license auto active.","operationId":"modifyAutoActive","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseAutoActiveOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/ips/threat":{"post":{"tags":["Global Security"],"summary":"Delete Global Threat List","description":"Delete archived threats in batches","operationId":"deleteGlobalThreatList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteGlobalThreatOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/ips/threat/ops":{"post":{"tags":["Global Security"],"summary":"Operate Global Threats","description":"Perform operations on threats in batches","operationId":"operateGlobalThreats","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperateGlobalThreatOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/firmwares/{firmwareId}/upgrade/plan":{"post":{"tags":["Firmware"],"summary":"Create firmware upgrade plan based on manually uploaded firmware","description":"Create an upgrade plan based on manually uploaded firmware","operationId":"createFirmwareUpgradePlan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"firmwareId","in":"path","description":"Firmware ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanFirmwareUpgradeCreateInfo"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCreateUpgradePlanResinfo"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/files/upgrade/firmware":{"post":{"tags":["Firmware"],"summary":"Upload upgrade firmware","description":"Upload upgrade firmware","operationId":"uploadUpgradeFirmware","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"description","in":"query","description":"Description of upload firmware","required":true,"schema":{"type":"string"}},{"name":"showModel","in":"query","description":"ShowModel of upload firmware, you can also get this field throw: \"Get the model of the specified site\"","required":true,"schema":{"type":"string"}},{"name":"compoundModel","in":"query","description":"CompoundModel of upload firmware, you can also get this field throw: \"Get the model of the specified site\"","required":true,"schema":{"type":"string"}},{"name":"targetEnable","in":"query","description":"Do the sites set up specified firmware, it should be a value as follows: true, false","required":true,"schema":{"type":"boolean"}},{"name":"targetSites","in":"query","description":"A string of target site IDs separated by commas, exists when 'targetEnable' is true.","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"file":{"type":"string","description":"Firmware file.","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUploadFirmwareResInfo"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/files/sitetemplates/{siteTemplateId}/setting/profiles/cert-profiles/client-private-key":{"post":{"tags":["CertProfiles (Template)"],"summary":"Upload client private key Template file","description":"Upload client private key Template file of the omadac with the given omadacId.","operationId":"uploadClientPrivateKeyFile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"data","in":"query","description":"Certificate profile file name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"Certificate profile file","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUploadCertResponseOpenApiVO"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/files/sitetemplates/{siteTemplateId}/setting/profiles/cert-profiles/client-cert":{"post":{"tags":["CertProfiles (Template)"],"summary":"Upload client certificate profile Template file","description":"Upload client certificate  profile Template file of the site with the given omadacId and siteId.","operationId":"uploadClientCertFile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"data","in":"query","description":"Certificate profile file name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"Certificate profile file","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUploadCertResponseOpenApiVO"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/files/sitetemplates/{siteTemplateId}/setting/profiles/cert-profiles/ca-cert":{"post":{"tags":["CertProfiles (Template)"],"summary":"Upload CA profile Template file","description":"Upload CA profile Template file of the omadac with the given omadacId.","operationId":"uploadCaCertFile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"data","in":"query","description":"Certificate profile file name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"Certificate profile file","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUploadCertResponseOpenApiVO"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/files/sites/{siteId}/setting/profiles/cert-profiles/client-private-key":{"post":{"tags":["CertProfiles"],"summary":"Upload client private key file","description":"Upload client private key file of the omadac with the given omadacId.","operationId":"uploadClientPrivateKeyFile_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"data","in":"query","description":"Certificate profile file name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"Certificate profile file","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUploadCertResponseOpenApiVO"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/files/sites/{siteId}/setting/profiles/cert-profiles/client-cert":{"post":{"tags":["CertProfiles"],"summary":"Upload client certificate profile file","description":"Upload client certificate  profile file of the site with the given omadacId and siteId.","operationId":"uploadClientCertFile_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"data","in":"query","description":"Certificate profile file name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"Certificate profile file","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUploadCertResponseOpenApiVO"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/files/sites/{siteId}/setting/profiles/cert-profiles/ca-cert":{"post":{"tags":["CertProfiles"],"summary":"Upload CA profile file","description":"Upload CA profile file of the omadac with the given omadacId.","operationId":"uploadCaCertFile_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"data","in":"query","description":"Certificate profile file name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"Certificate profile file","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUploadCertResponseOpenApiVO"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/files/sites/{siteId}/rfPlanning/history/export":{"post":{"tags":["WLAN Optimization"],"summary":"Export PlanningHistory","description":"Export PlanningHistory","operationId":"exportRfPlanningHistory","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Export RF planning history openapi VO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/files/sites/{siteId}/gateways/{gatewayMac}/isp-upgrade":{"post":{"tags":["Gateway"],"summary":"Upload isp upgrade file","description":"Upload isp upgrade file","operationId":"uploadIspFile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/files/sites/{siteId}/clients/export":{"post":{"tags":["Client"],"summary":"Export client list","description":"Export client list.","operationId":"exportClient","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientExportOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/files/sites/{siteId}/capture/device-type/{deviceType}/{deviceMac}/download":{"post":{"tags":["Network Analyze"],"summary":"Download package capture file","description":"Download package capture file.","operationId":"downloadCaptureFile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceType","in":"path","description":"Device type, and should be a value in [ap, switch, gateway].","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadCaptureFileConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/files/neighbors":{"post":{"tags":["Insight"],"summary":"Export global Rogue AP scan results","description":"Export global Rogue AP scan results","operationId":"exportRogueApsGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Required Parameters for Exporting Rogue AP Scan Results"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/files/hotspot/sites/{siteId}/vouchers/export":{"post":{"tags":["Voucher"],"summary":"Export voucher list to file","description":"Export voucher list to file.","operationId":"exportVouchersWithSiteByCloudAccess","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportVoucherOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/files/client-list":{"post":{"tags":["Client"],"summary":"Export global client list.","description":"Export global client list.","operationId":"exportClientListGlobalByCloudAccess","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportClientListOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/files/all-client-list":{"post":{"tags":["Client"],"summary":"Export all client list in GLOBAL view","description":"Export all client list in GLOBAL view, .","operationId":"globalExportAllClientList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiSiteClientExportOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/devices/incidents":{"post":{"tags":["Device"],"summary":"Get global device incident counts","description":"Get incident counts for the specified devices globally.","operationId":"getGlobalDeviceIncidentCounts","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceIncidentCountRequestOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceIncidentCountResultOpenApiVO"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/devices/export":{"post":{"tags":["Device"],"summary":"Export device list in GLOBAL view","description":"Export device list in GLOBAL view.","operationId":"exportGlobalDeviceList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportGlobalDeviceListOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":32}},"/openapi/v1/{omadacId}/cmd/cloud/unbind":{"post":{"tags":["Cloud User"],"summary":"Unbind the owner account","description":"Unbind the owner account.","operationId":"unbindOwner","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/cmd/cloud/bind":{"post":{"tags":["Cloud User"],"summary":"Bind the owner account","description":"Bind the owner account.","operationId":"bindOwner","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BindOwnerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/clients/stat/devices":{"post":{"tags":["Client"],"summary":"Get global client statistics by device.","description":"Get global client statistics by device.","operationId":"globalClientStatByDevice","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalDevicesQueryOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListDeviceClientNumOpenApiVO"}}}}},"x-order":28}},"/openapi/v1/{omadacId}/batch":{"post":{"tags":["Batch OpenAPI"],"summary":"Batch Processing OpenAPIs","description":"Batch processing of multiple OpenAPIs under the same Omada controller through this OpenAPI.","operationId":"batchController","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Batch request entity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseBatch Response Entity"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/backupschedule/task":{"get":{"tags":["Backup schedule"],"summary":"Get backup schedule task","description":"Get backup schedule task.","operationId":"getBackupScheduleTask","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAutoBackupOpenApiVO"}}}}},"x-order":1},"post":{"tags":["Backup schedule"],"summary":"Modify backup schedule task","description":"Modify backup schedule task.","operationId":"modifyBackupScheduleTask","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoBackupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/account/users/{userID}/re-invite":{"post":{"tags":["User and Role"],"summary":"Re-Invite an existing user","description":"Re-Invite an existing user","operationId":"reinvite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"userID","in":"path","description":"User ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":6}},"/openapi/v1/msp/{mspId}/webhook/settings":{"get":{"tags":["Msp Webhook Setting"],"summary":"Get MSP webhook setting list","description":"Get all MSP webhook setting.","operationId":"getWebhookForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListWebhookSetting"}}}}},"x-order":1},"post":{"tags":["Msp Webhook Setting"],"summary":"Create MSP webhook setting","description":"Create MSP webhook setting.","operationId":"createWebhookForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiWebhookSettingAddVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/msp/{mspId}/webhook/settings/{webhookId}":{"post":{"tags":["Msp Webhook Setting"],"summary":"Test MSP webhook setting","description":"Test MSP webhook setting.","operationId":"testWebhookFormsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"webhookId","in":"path","description":"Webhook ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiWebhookSettingTestVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5},"delete":{"tags":["Msp Webhook Setting"],"summary":"Delete MSP webhook setting","description":"Delete MSP webhook setting.","operationId":"deleteWebhookForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"webhookId","in":"path","description":"Webhook ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"patch":{"tags":["Msp Webhook Setting"],"summary":"Modify MSP webhook setting","description":"Modify MSP webhook setting.","operationId":"modifyWebhookForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"webhookId","in":"path","description":"Webhook ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApiWebhookSettingEditVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/msp/{mspId}/users":{"get":{"tags":["MSP User and Role"],"summary":"Get msp user list","description":"Get msp user list. This interface only supports the authorization code mode, not the client mode. Please call this interface in authorization code mode.","operationId":"getGridUsers_1","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.roleId","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.email","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.customerRoleId","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field userName","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMspUserDetailVO"}}}}},"x-order":1},"post":{"tags":["MSP User and Role"],"summary":"Create new msp user","description":"Create new msp user. This interface only supports the authorization code mode, not the client mode. Please call this interface in authorization code mode.","operationId":"createNewMspUser","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMspUserVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCreateUserResultVO"}}}}},"x-order":3}},"/openapi/v1/msp/{mspId}/users/feedback/evaluates":{"post":{"tags":["Msp setting"],"summary":"Evaluate MSP feedback","description":"Evaluate MSP feedback","operationId":"evaluateMspFeedback","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/msp/{mspId}/unbind/cloudowner":{"post":{"tags":["Cloud User"],"summary":"Unbind the MSP owner account for cloud owner","description":"Unbind the MSP owner account for cloud owner.","operationId":"cloudOwnerUnbindMspOwner","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocalOwnerConfirmVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":12}},"/openapi/v1/msp/{mspId}/system/setting/ssl-key":{"post":{"tags":["Msp setting"],"summary":"Upload msp SSL key","description":"Upload msp SSL key. Only support .pem files.","operationId":"uploadSSLKey","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"keyName","in":"query","description":"SSL Key Name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":7}},"/openapi/v1/msp/{mspId}/system/setting/certificate":{"post":{"tags":["Msp setting"],"summary":"Upload msp certificate","description":"Upload msp certificate. Only support .pem, .pfx, .jks files. Certificate name should be the same as the file name.","operationId":"uploadCertificate","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"cerName","in":"query","description":"Upload certificate file name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["file"],"type":"object","properties":{"file":{"type":"string","description":"Upload certificate file","format":"binary"}}}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":5}},"/openapi/v1/msp/{mspId}/sso/saml-idps":{"get":{"tags":["MSP SSO"],"summary":"Get msp idp list","description":"Get msp idp list.","operationId":"getIdpMetadataList_1","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.idpName","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOIdpMetadataDetailOpenApiVO"}}}}},"x-order":1},"post":{"tags":["MSP SSO"],"summary":"Create new msp idp","description":"Create new msp idp.","operationId":"createIdpMetadata_1","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdpMetadataOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"x-order":2}},"/openapi/v1/msp/{mspId}/sso/external-user-groups":{"get":{"tags":["MSP SSO"],"summary":"Get msp external user group list","description":"Get msp external user group list.","operationId":"getExternalUserGroupList_1","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMspExternalUserGroupDetailOpenApiVO"}}}}},"x-order":5},"post":{"tags":["MSP SSO"],"summary":"Create new msp external user group","description":"Create new msp external user group.","operationId":"createExternalUserGroup_1","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MspExternalUserGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseIdVO"}}}}},"x-order":6}},"/openapi/v1/msp/{mspId}/settings/test-mail":{"post":{"tags":["Msp setting"],"summary":"Send test mail for MSP","description":"Send test mail for MSP","operationId":"sendTestMailForMspV2","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMailServerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":11}},"/openapi/v1/msp/{mspId}/roles":{"get":{"tags":["MSP User and Role"],"summary":"Get msp role list","description":"Get msp role list","operationId":"getAllMspRoles","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListMspRoleDetailVO"}}}}},"x-order":6},"post":{"tags":["MSP User and Role"],"summary":"Create new msp role","description":"Create new msp role","operationId":"createNewMspRole","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyMspRoleVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCreateRoleResultVO"}}}}},"x-order":8}},"/openapi/v1/msp/{mspId}/reset/log-notification":{"post":{"tags":["Msp Log"],"summary":"Reset MSP log notification","description":"Reset MSP log notification.","operationId":"resetLogSettingMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/msp/{mspId}/owner/transfer":{"post":{"tags":["User and Role"],"summary":"Transfer MSP owner permission to an existing user","description":"Transfer MSP owner permission to an existing user. Only Owner of current MSP controller can use this interface.This interface only supports the authorization code mode, not the client mode. Please call this interface in authorization code mode.","operationId":"transferMspRoot","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransferRootOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/msp/{mspId}/notification/disable":{"post":{"tags":["Msp setting"],"summary":"Turn off the software update push switch in MSP mode","description":"Turn off the software update push switch in MSP mode.","operationId":"disableMspControllerUpgradeNotification","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":17}},"/openapi/v1/msp/{mspId}/mfa/status":{"get":{"tags":["MSP User and Role"],"summary":"Get the status of the MSP system's Two-Factor Authentication.","description":"Get the status of the system's Two-Factor Authentication.","operationId":"getMFAStatus","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMFAConfigOpenApiVO"}}}}},"x-order":9},"post":{"tags":["MSP User and Role"],"summary":"Modify the status of the MSP system's Two-Factor Authentication.","description":"Modify the status of the system's Two-Factor Authentication.","operationId":"modifyMspMFAStatus","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MFAConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":10}},"/openapi/v1/msp/{mspId}/logs/export":{"post":{"tags":["Msp Log"],"summary":"Export log list in MSP view","description":"Export log list in MSP view.","operationId":"exportLogListForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportMspLogOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":12}},"/openapi/v1/msp/{mspId}/logs/audit/export":{"post":{"tags":["Msp Log"],"summary":"Export audit log list in MSP view","description":"Export audit log list in MSP view.","operationId":"exportAuditLogListForGlobal_1","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportMspLogOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":4}},"/openapi/v1/msp/{mspId}/logs/alerts/resolve":{"post":{"tags":["Msp Log"],"summary":"Resolve MSP alert log","description":"Resolve MSP alert log.","operationId":"resolveAlertForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResolveMspLogListOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/msp/{mspId}/license/recycle":{"get":{"tags":["Msp License"],"summary":"Get available recycle license info","description":"Get available recycle license info.","operationId":"getAutoActive_1","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"query","description":"Customer ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/LicenseAvailableRecycleOpenApiVO"}}}}},"x-order":2},"post":{"tags":["Msp License"],"summary":"Recycle license from a customer","description":"Recycle license from a customer.","operationId":"recycleLicenseForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseRecycleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/msp/{mspId}/license/auto-active":{"get":{"tags":["Msp License"],"summary":"Get license auto active","description":"Get license auto active.","operationId":"getAutoActive_2","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLicenseAutoActiveOpenApiVO"}}}}},"x-order":6},"post":{"tags":["Msp License"],"summary":"Modify license auto active","description":"Modify license auto active.","operationId":"modifyAutoActive_1","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseAutoActiveOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/msp/{mspId}/license/assign":{"get":{"tags":["Msp License"],"summary":"Get available assign license info","description":"Get available assign license info.","operationId":"assignAvailableLicenseForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/LicenseAvailableAssignOpenApiVO"}}}}},"x-order":1},"post":{"tags":["Msp License"],"summary":"Assign license to a customer","description":"Assign license to a customer.","operationId":"assignmentLicenseForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LicenseAssignmentOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/msp/{mspId}/devices/incidents":{"post":{"tags":["MSP Device"],"summary":"Get MSP device incident counts","description":"Get incident counts for customerId and device MAC pairs accessible in MSP view.","operationId":"getMspDeviceIncidentCounts","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MspDeviceIncidentCountRequestOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceIncidentCountResultOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/msp/{mspId}/customers":{"get":{"tags":["Customer"],"summary":"Get customer list","description":"Get customer list","operationId":"getCustomerList","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOCustomerInfoOpenApiVO"}}}}},"x-order":1},"post":{"tags":["Customer"],"summary":"Create new customer","description":"Create new customer(This interface only supports the authorization code mode, not the client mode. Please call this interface in authorization code mode.)","operationId":"createCustomer","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCreateCustomerOmadacVO"}}}}},"x-order":3}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/olts/{deviceMac}/system/system-info/configs/edit":{"post":{"tags":["OLT"],"summary":"Modify OLT description info(MSP mode)","description":"Modify OLT description info(MSP mode)","operationId":"editConfigForMsp","parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"mspId","in":"path","description":"mspId","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"customerId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemInfoAppModifyDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeviceResponseBodyVoid"}}}}},"x-order":14}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/gateways/{gatewayMac}/change-mode":{"post":{"tags":["Gateway"],"summary":"Change mode for 5G-Outdoor for msp","description":"Change mode for 5G-Outdoor for msp.","operationId":"changeOduModeForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeOduModeVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":39}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/devices/{deviceMac}/start-adopt":{"post":{"tags":["MSP Device"],"summary":"Start adopt device For Msp","description":"Start adopt device in msp view.This interface does not return the actual adoptive result, you need to use the interface:Get device adopt result to obtain the adoptive result","operationId":"adoptOneForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdoptDeviceRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/devices/{deviceMac}/forget":{"post":{"tags":["Device"],"summary":"Forget one device in MSP view.","description":"Forget one device in MSP view.","operationId":"forgetDeviceForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":24}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/devices/{deviceMac}/add/retry":{"post":{"tags":["Device"],"summary":"retry add device in msp view","description":"retry add device in msp view","operationId":"retryAddDeviceByMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryAddDeviceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseRetryAddDeviceRespOpenApiVO"}}}}},"x-order":5}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/devices/multi-add":{"post":{"tags":["Device"],"summary":"Batch add devices in MSP view","description":"Batch add devices in MSP view.","operationId":"addDevicesForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MspAddDeviceListOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceAddRespOpenApiVO"}}}}},"x-order":50}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/cmd/switches/move":{"post":{"tags":["Switch"],"summary":"Move site to target customer","description":"Move site to target customer","operationId":"mspMoveToCustomer","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveToCustomerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":34}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/cmd/olts/move":{"post":{"tags":["OLT"],"summary":"Move OLT to another customer(MSP mode)","description":"Move OLT to another customer(MSP mode)","operationId":"mspMoveToCustomer_1","parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"mspId","in":"path","description":"mspId","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"customerId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveToCustomerVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeviceResponseBodyVoid"}}}}},"x-order":16}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/cmd/gateways/move":{"post":{"tags":["Gateway"],"summary":"Move site to target customer","description":"Move site to target customer","operationId":"mspMoveToCustomer_2","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveToCustomerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":26}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/cmd/devices/batch-adopt":{"post":{"tags":["MSP Device"],"summary":"batch adopt device in msp view","description":"batch adopt device in msp view.This interface does not return the actual adoptive result,you need to use the interface:Get device adopt result to obtain the adoptive result","operationId":"batchAdoptForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchAdoptDeviceRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/cmd/aps/move":{"post":{"tags":["Ap"],"summary":"Move site to target customer","description":"Move site to target customer","operationId":"mspMoveToCustomer_3","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoveToCustomerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":56}},"/openapi/v1/msp/{mspId}/customers/{customerId}/favorites":{"post":{"tags":["Customer"],"summary":"Favorite a customer","description":"Favorite a customer","operationId":"favoriteCustomer","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/msp/{mspId}/customers/{customerId}/favorites/cancels":{"post":{"tags":["Customer"],"summary":"Cancel a favorite customer","description":"Cancel a favorite customer","operationId":"cancelFavoriteCustomer","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/msp/{mspId}/customers/copy":{"post":{"tags":["Customer"],"summary":"Create a customer by copying from existing customer","description":"Create a customer by copying from existing customer","operationId":"copyCustomer","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerCopyOpenapiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCustomerCopyOpenapiResVO"}}}}},"x-order":9}},"/openapi/v1/msp/{mspId}/customers/client-count":{"post":{"tags":["Client Insight"],"summary":"Get the Msp customers' client count.","description":"Get the Msp customers' client count.","operationId":"getClientNumberForCustomerList","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerQueryOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListCustomerListClientNumVO"}}}}},"x-order":9}},"/openapi/v1/msp/{mspId}/cmd/cloud/unbind":{"post":{"tags":["Cloud User"],"summary":"Unbind the MSP owner account","description":"Unbind the MSP owner account.","operationId":"unbindMspOwner","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/msp/{mspId}/cmd/cloud/bind":{"post":{"tags":["Cloud User"],"summary":"Bind the MSP owner account","description":"Bind the MSP owner account.","operationId":"bindMspOwner","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BindOwnerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/msp/{mspId}/clients/stat/devices":{"post":{"tags":["Client"],"summary":"Get msp client statistics by device.","description":"Get Msp level client statistics by device.","operationId":"mspClientStatByDevice","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MspDevicesQueryOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListMspDeviceClientNumOpenApiVO"}}}}},"x-order":29}},"/openapi/v1/msp/{mspId}/batch":{"post":{"tags":["MSP Batch OpenAPI"],"summary":"Batch Processing MSP OpenAPIs","description":"Batch processing of multiple OpenAPIs under the same MSP controller through this OpenAPI.","operationId":"mspBatchController","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Batch request entity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseBatch Response Entity"}}}}},"x-order":1}},"/openapi/v1/msp/{mspId}/account/customer-roles":{"post":{"tags":["MSP User and Role"],"summary":"Create new customer role","description":"Create new customer role","operationId":"createCustomerRole","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleDetailOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCreateRoleResultVO"}}}}},"x-order":12}},"/internal/api/v2/omadacs":{"post":{"tags":["abutment-omada-cloud-controller"],"operationId":"createOmadac","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOmadacRequestDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCreateOmadacResponseDTO"}}}}}}},"/internal/api/v2/omadacs/{customizeOmadacId}/users/acceptInvite":{"post":{"tags":["abutment-omada-cloud-controller"],"operationId":"acceptInvite","parameters":[{"name":"customizeOmadacId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptInviteRequestDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseObject"}}}}}}},"/internal/api/v2/omadacs/{customizeOmadacId}/logout":{"post":{"tags":["abutment-omada-cloud-controller"],"operationId":"logout","parameters":[{"name":"customizeOmadacId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogoutControllerRequestDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseObject"}}}}}}},"/internal/api/v2/omadacs/wizard":{"post":{"tags":["abutment-omada-cloud-controller"],"operationId":"createOmadac_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOmadacWithWizardRequestDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCreateOmadacResponseDTO"}}}}}}},"/internal/api/v2/omadacs/session/idle-timeout":{"post":{"tags":["abutment-omada-cloud-controller"],"operationId":"updateSessionIdleTimeout","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSessionRequestDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}}}},"/internal/api/v2/omadacs/pro/whitelist":{"get":{"tags":["abutment-omada-cloud-controller"],"operationId":"checkInProWhitelist","parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCheckInProWhitelistDTO"}}}}}},"post":{"tags":["abutment-omada-cloud-controller"],"operationId":"addInProWhitelist","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddProWhitelistDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}}}},"/internal/api/v2/omadacs/licenses/controllerIds":{"post":{"tags":["abutment-omada-cloud-controller"],"operationId":"getLicenseOmadacIdsByAccountId","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryByControllerIdsDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOmadacBasicInfoResponseDTO"}}}}}}},"/internal/api/v2/omadacs/info-without-device":{"post":{"tags":["abutment-omada-cloud-controller"],"operationId":"getBasicInfoByControllerIds","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryByControllerIdsDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOmadacBasicInfoResponseDTO"}}}}}}},"/internal/api/v2/omadacs/import-records":{"post":{"tags":["abutment-omada-cloud-controller"],"operationId":"saveLicenseImportRecord","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveLicenseImportedRecordDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}}}},"/internal/api/v2/omadacs/devices":{"post":{"tags":["abutment-omada-cloud-controller"],"operationId":"getDevices","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDevicesRequestDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGetDevicesResponseDTO"}}}}}}},"/internal/api/v2/omadacs/deviceStats":{"post":{"tags":["abutment-omada-cloud-controller"],"operationId":"getDeviceStatsByControllerIds","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryByControllerIdsDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOmadacBasicInfoResponseDTO"}}}}}}},"/internal/api/v2/omadacs/controllerInfo":{"post":{"tags":["abutment-omada-cloud-controller"],"operationId":"getOmadacInfoByControllerIds","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryByControllerIdsDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOmadacBasicInfoResponseDTO"}}}}}}},"/internal/api/v2/omadacs/controllerIds":{"post":{"tags":["abutment-omada-cloud-controller"],"operationId":"getOmadacIdsByAccountId","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryByControllerIdsDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOmadacBasicInfoResponseDTO"}}}}}}},"/internal/api/v2/omadacs/clients":{"post":{"tags":["abutment-omada-cloud-controller"],"operationId":"getClientsByControllerIds","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryByControllerIdsDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOmadacBasicInfoResponseDTO"}}}}}}},"/internal/api/v2/omadacs/appControllerInfo":{"post":{"tags":["abutment-omada-cloud-controller"],"operationId":"getOmadacInfoByControllerIdsForApp","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryByControllerIdsDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOmadacBasicInfoResponseDTO"}}}}}}},"/internal/api/v2/omadacs/alerts":{"post":{"tags":["abutment-omada-cloud-controller"],"operationId":"getAlertsByControllerIds","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryByControllerIdsDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOmadacBasicInfoResponseDTO"}}}}}}},"/internal/api/v2/manager/device/del-record":{"post":{"tags":["internal-manager-controller"],"operationId":"deleteDeviceRecord","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteDeviceRecordRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeviceInternalResponse"}}}}}}},"/internal/api/v2/manager/check/bind":{"post":{"tags":["internal-manager-controller"],"operationId":"checkBind","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckDeviceBindRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeviceInternalResponseListDeviceBindStatusDTO"}}}}}}},"/openapi/v3/{omadacId}/sites/{siteId}/vpn/users/{userId}":{"patch":{"tags":["VPN"],"summary":"Modify VPN user V3","description":"Modify VPN user.","operationId":"modifyVpnUserV3","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","description":"VPN user ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnUserConfigVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":23}},"/openapi/v2/{omadacId}/sitetemplates/{siteTemplateId}/lan-profiles/{profileId}":{"delete":{"tags":["Wired Network (Template)"],"summary":"Delete an existing switch profile template","description":"Delete an existing switch profile template.","operationId":"deleteOswLanProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"LAN profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":42},"patch":{"tags":["Wired Network (Template)"],"summary":"Modify a switch profile template","description":"Modify a switch profile template template.","operationId":"modifyOswLanProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"lanProfileId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanProfileSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":41}},"/openapi/v2/{omadacId}/sites/{siteId}/vpn/users/{userId}":{"patch":{"tags":["VPN"],"summary":"Modify VPN user V2","description":"Modify VPN user. This interface has been deprecated. Please use the following interfaces instead: Modify VPN user V3. This interface had been deprecated.","operationId":"modifyVpnUserV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","description":"VPN user ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnUserRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":61}},"/openapi/v2/{omadacId}/sites/{siteId}/vpn/site-to-site-vpns/{vpnId}":{"get":{"tags":["VPN"],"summary":"Get site-to-site VPN detail info","description":"Get site-to-site VPN detail information by VPN ID.","operationId":"getVpnS2SDetailInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnSiteToSiteDetailOpenApiVO"}}}}},"x-order":29},"patch":{"tags":["VPN"],"summary":"Modify site-to-site VPN by manual","description":"Modify site-to-site VPN by manual.","operationId":"modifyS2SManualVpn","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnSiteToSiteManualConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":33}},"/openapi/v2/{omadacId}/sites/{siteId}/vpn/site-to-site-vpns/auto/{vpnId}":{"patch":{"tags":["VPN"],"summary":"Modify site-to-site VPN by auto","description":"Modify site-to-site VPN by auto.","operationId":"modifyS2SAutoVpn","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnSiteToSiteAutoConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":31}},"/openapi/v2/{omadacId}/sites/{siteId}/vpn/client-to-site-vpn-servers/{vpnId}":{"get":{"tags":["VPN"],"summary":"Get client-to-site VPN server detail info","description":"Get client-to-site VPN server detail information by VPN ID.","operationId":"getVpnServerDetailInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnServerDetailVO"}}}}},"x-order":10},"patch":{"tags":["VPN"],"summary":"Modify client-to-site VPN server V2","description":"Modify client-to-site VPN server V2.","operationId":"modifyVpnServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnServerConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":12}},"/openapi/v2/{omadacId}/sites/{siteId}/vpn/client-to-site-vpn-clients/{vpnId}":{"get":{"tags":["VPN"],"summary":"Get client-to-site VPN client detail info","description":"Get client-to-site VPN client detail information by VPN ID.","operationId":"getVpnClientDetailInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnClientDetailVO"}}}}},"x-order":26},"patch":{"tags":["VPN"],"summary":"Modify client-to-site VPN client V2","description":"Modify client-to-site VPN client.","operationId":"modifyVpnClient","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnClientConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":28}},"/openapi/v2/{omadacId}/sites/{siteId}/stacks/{stackId}/ports/{port}":{"patch":{"tags":["Stack"],"summary":"Modify stack port V2","description":"Modify stack port V2.","operationId":"modifySwitchStackPortSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"port","in":"path","description":"Port","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackPortSettingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":26}},"/openapi/v2/{omadacId}/sites/{siteId}/stacks/{stackId}/multi-ports/config":{"patch":{"tags":["Stack"],"summary":"Batch modify stack port V2","description":"Batch modify stack port V2.","operationId":"batchModifySwitchStackPortSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchStackPortSettingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":27}},"/openapi/v2/{omadacId}/sites/{siteId}/stacks/{stackId}/lags/{lagId}":{"delete":{"tags":["Stack"],"summary":"Delete stack lag V2","description":"Delete stack lag V2.","operationId":"deleteSwitchStackLagSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"lagId","in":"path","description":"Lag ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":29},"patch":{"tags":["Stack"],"summary":"Modify stack lag V2","description":"Modify stack lag V2.","operationId":"modifySwitchStackLagSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"lagId","in":"path","description":"Lag ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackLagSettingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":28}},"/openapi/v2/{omadacId}/sites/{siteId}/site/log-notification":{"get":{"tags":["Log"],"summary":"Get site log notification v2","description":"Get site log notification.","operationId":"getLogSettingForSiteV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLogNotificationSettingOpenApiVO"}}}}},"x-order":10},"patch":{"tags":["Log"],"summary":"Modify site log notification v2","description":"Modify site log notification.","operationId":"modifyLogSettingSiteV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogNotificationSettingEditOpenApiV2VO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/openapi/v2/{omadacId}/sites/{siteId}/lan-profiles/{profileId}":{"delete":{"tags":["Wired Network"],"summary":"Delete an existing switch profile","description":"Delete an existing switch profile. If returns -33560, use \"Query Agile Series switch that used the profile\" to query these Agile Series witches.","operationId":"deleteOswLanProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Switch profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":62},"patch":{"tags":["Wired Network"],"summary":"Modify a switch profile","description":"Modify a switch profile.","operationId":"modifyOswLanProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Switch profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanProfileSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":61}},"/openapi/v2/{omadacId}/sites/{siteId}/lan-networks/{networkId}":{"patch":{"tags":["Wired Network"],"summary":"Modify LAN network","description":"Modify LAN network","operationId":"modifyLanNetworkV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanNetworkOpenApiV2VO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/openapi/v2/{omadacId}/sites/{siteId}/aps/{apMac}/override":{"get":{"tags":["Ap"],"summary":"Get AP WLANs override config V2","description":"Get AP WLANs override config.","operationId":"getWlansConfigV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApSsidWlansOpenApiV2VO"}}}}},"x-order":23},"patch":{"tags":["Ap"],"summary":"Modify AP WLANs override config V2","description":"Modify AP WLANs override config.","operationId":"modifyWlansConfigV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApSsidOverrideOpenApiV2VO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":24}},"/openapi/v2/{omadacId}/log-notification":{"get":{"tags":["Log"],"summary":"Get global log notification v2","description":"Get global log notification.","operationId":"getLogSettingForGlobalV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLogNotificationSettingOpenApiVO"}}}}},"x-order":7},"patch":{"tags":["Log"],"summary":"Modify global log notification v2","description":"Modify global log notification.","operationId":"modifyLogSettingGlobalV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogNotificationSettingEditOpenApiV2VO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/users/batch-temporary-users":{"patch":{"tags":["User and Role"],"summary":"Batch modify users.","description":"Batch modify users.","operationId":"modifyUserBatch","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchModifyUserOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseBatchModifyCountVO"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/upgrade/overview/try-beta":{"get":{"tags":["Firmware"],"summary":"Get try-beta switch status","description":"You can get try-beta switch status","operationId":"getTryBetaStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUpgradeSettingTryBeta"}}}}},"x-order":9},"patch":{"tags":["Firmware"],"summary":"Modify try-beta switch status","description":"You can modify the try-beta switch status","operationId":"modifyTryBetaStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpgradeSettingTryBeta"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/upgrade/overview/try-beta/channel":{"get":{"tags":["Firmware"],"summary":"Get try-beta Channel Info","description":"You can get try-beta channel info","operationId":"getTryBetaChannel","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUpgradeSettingTryBetaChannel"}}}}},"x-order":30},"patch":{"tags":["Firmware"],"summary":"Modify try-beta Channel Info","description":"You can modify try-beta channel info","operationId":"modifyTryBetaChannel","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpgradeSettingTryBetaChannel"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":32}},"/openapi/v1/{omadacId}/upgrade/overview/mail/reminder":{"get":{"tags":["Firmware"],"summary":"Get Email Reminder Switch Status","description":"You can get email reminder switch status","operationId":"getEmailReminderSwitchStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUpgradeSettingEmailReminder"}}}}},"x-order":31},"patch":{"tags":["Firmware"],"summary":"Modify Email Reminder Switch Status","description":"You can modify email reminder switch status","operationId":"modifyEmailReminderSwitchStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpgradeSettingEmailReminder"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":33}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/wlans/{wlanId}":{"delete":{"tags":["Wireless Network (Template)"],"summary":"Delete an existing WLAN Group template","description":"Delete an existing WLAN Group template, Legacy note: “WLAN Group” is the legacy name of “AP Group”. This endpoint will be deprecated in future releases. Please use Delete an existing AP Group template.","operationId":"deleteWlanGroupTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":54},"patch":{"tags":["Wireless Network (Template)"],"summary":"Modify an existing WLAN Group template","description":"Modify an existing WLAN Group template, Legacy note: “WLAN Group” is the legacy name of “AP Group”. This endpoint will be deprecated in future releases. Please use Modify an existing AP Group template.","operationId":"updateWlanGroupTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWlanGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":53}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-wlan-schedule":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID template WLAN schedule config","description":"Update SSID template WLAN schedule config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID Template WLAN schedule config by site.","operationId":"updateSsidWlanScheduleTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidWlanScheduleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":11}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-wifi-calling":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID template wifi calling config","description":"Update SSID template Wi-Fi Calling config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID Template wifi calling config by site.","operationId":"updateSsidWifiCallingConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWifiCallingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":25}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-rate-limit":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID template rate limit config","description":"Update SSID template rate limit config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID Template rate limit config by site.","operationId":"updateSsidRateLimitConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidRateLimitOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":10}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-rate-control":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID template 802.11 rate control config","description":"Update SSID template 802.11 rate control config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID Template 802.11 rate control config by site.","operationId":"updateSsidRateControlConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidRateControlOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":12}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-multicast-config":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID template Multicast/Broadcast management config","description":"Update SSID template Multicast/Broadcast management config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID Template Multicast/Broadcast management config by site.","operationId":"updateSsidMultiCastConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidMultiCastOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":14}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-mac-filter":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID template mac filter config","description":"Update SSID template MAC filter config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID Template mac filter config by site.","operationId":"updateSsidMacFilterConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidMacFilterOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":13}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-load-balance":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID template load balance config","description":"Update SSID template load balance config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID Template load balance config by site.","operationId":"updateSsidLoadBalanceConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidLoadBalanceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":26}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-hotspotv2":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID template Hotspot2.0 config","description":"Update SSID template Hotspot2.0 config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID Template Hotspot2.0 config by site.","operationId":"updateSsidHotspotV2SettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidHotspotV2SettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":18}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-dhcp-option":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID template DHCP option 82 config","description":"Update SSID template DHCP option 82 config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID Template DHCP option 82 config by site.","operationId":"updateSsidDhcpOptionConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidDhcpOptionOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":15}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-basic-config":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID template basic config","description":"Update SSID template basic config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID Template basic config by site.","operationId":"updateSsidBasicConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidBasicConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":9}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-band-steer":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID template band steer config","description":"Update SSID template band steer config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID Template band steer config by site.","operationId":"updateSsidBandSteerConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidBandSteerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":27}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/ssids/{ssidId}/wlan-schedule":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID Template WLAN schedule config by site","description":"Update SSID Template WLAN schedule config by site","operationId":"updateSsidTemplateWlanScheduleBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidWlanScheduleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":31}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/ssids/{ssidId}/wifi-calling":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID Template wifi calling config by site","description":"Update SSID Template Wi-Fi Calling config by site","operationId":"updateSsidTemplateWifiCallingConfigBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWifiCallingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":43}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/ssids/{ssidId}/rate-limit":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID Template rate limit config by site","description":"Update SSID Template rate limit config by site","operationId":"updateSsidTemplateRateLimitConfigBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidRateLimitOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":30}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/ssids/{ssidId}/rate-control":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID Template 802.11 rate control config by site","description":"Update SSID Template 802.11 rate control config by site","operationId":"updateSsidTemplateRateControlConfigBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidRateControlOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":32}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/ssids/{ssidId}/multicast-config":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID Template Multicast/Broadcast management config by site","description":"Update SSID Template Multicast/Broadcast management config","operationId":"updateSsidTemplateMultiCastConfigBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidMultiCastOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":40}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/ssids/{ssidId}/mac-filter":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID Template mac filter config by site","description":"Update SSID Template MAC filter config","operationId":"updateSsidTemplateMacFilterConfigBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidMacFilterOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":33}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/ssids/{ssidId}/load-balance":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID Template load balance config by site","description":"Update SSID Template load balance config by site","operationId":"updateSsidTemplateLoadBalanceConfigBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidLoadBalanceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":44}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/ssids/{ssidId}/hotspotv2":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID Template Hotspot2.0 config by site","description":"Update SSID Template Hotspot2.0 config by site","operationId":"updateSsidTemplateHotspotV2SettingBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidHotspotV2SettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":41}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/ssids/{ssidId}/enable":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID Template Enable Status","description":"Update SSID Template Enable Status","operationId":"updateSsidEnableStatusBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidEnableStatusOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":46}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/ssids/{ssidId}/dhcp-option":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID Template DHCP option 82 config by site","description":"Update SSID Template DHCP option 82 config by site","operationId":"updateSsidTemplateDhcpOptionConfigBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidDhcpOptionOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":42}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/ssids/{ssidId}/basic-config":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID Template basic config by site","description":"Update SSID Template basic config by site","operationId":"updateSsidTemplateBasicConfigBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidBasicConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":29}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/ssids/{ssidId}/band-steer":{"patch":{"tags":["Wireless Network (Template)"],"summary":"Update SSID Template band steer config by site","description":"Update SSID Template band steer config by site","operationId":"updateSsidTemplateBandSteerConfigBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidBandSteerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":45}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/ssids/duplicate-name":{"get":{"tags":["Wireless Network (Template)"],"summary":"Query Template SSIDs with the same name","description":"Query Template SSIDs with the same name","operationId":"querySsidDuplicateNameBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDuplicateSsidOpenApiVO"}}}}},"x-order":28},"patch":{"tags":["app"],"summary":"Merge Template SSIDs with the same name","description":"Merge Template SSIDs with the same name","operationId":"mergeTemplateSsidsBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MergeSsidOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/ssid-operation/{ssidId}":{"delete":{"tags":["app"],"summary":"Delete an existing SSID template","description":"Delete an existing SSID template","operationId":"deleteSsidTemplate_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":21},"patch":{"tags":["app"],"summary":"Delete an existing SSID template","description":"Delete an existing SSID template","operationId":"modifySsidTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SsidVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wan/networks/port-setting":{"patch":{"tags":["Wired Network (Template)"],"summary":"Modify Wan Port Settings Template","description":"Modify Wan Port Settings Template.","operationId":"modifySinglePortSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternetPortOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":64}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/voip/telephone-book/{contactId}":{"delete":{"tags":["VoIP (Template)"],"summary":"Delete an existing Contact Person in siteTemplate","description":"Delete an existing Contact Person in siteTemplate.","operationId":"deleteVoipTelephoneBookTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"contactId","in":"path","description":"Voip Contact Person ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoipDeleteTelephoneBook"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"patch":{"tags":["VoIP (Template)"],"summary":"Modify an existing Contact Person in siteTemplate","description":"Modify an existing Contact Person in siteTemplate.","operationId":"modifyVoipTelephoneBookTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"contactId","in":"path","description":"Voip Contact Person ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoipContactPersonSettings"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/voip/call-forwarding/{forwardingRuleId}":{"patch":{"tags":["VoIP (Template)"],"summary":"Modify an existing Call Forwarding in siteTemplate","description":"Modify an existing Call Forwarding in siteTemplate.","operationId":"modifyCallForwardingRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"forwardingRuleId","in":"path","description":"Entry ID of the call forwarding rule to be modified.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallForwardingRule"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVoid"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/url-filters/{ruleId}":{"delete":{"tags":["URL Filtering (Template)"],"summary":"Delete URL filtering template rule","description":"Delete URL filtering template rule.","operationId":"deleteUrlFilteringRuleTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","description":"URL filtering rule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5},"patch":{"tags":["URL Filtering (Template)"],"summary":"Modify URL filtering template rule","description":"Modify URL filtering template rule.","operationId":"modifyUrlFilteringRuleTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","description":"URL filtering rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UrlFilteringOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/ports/{port}":{"patch":{"tags":["Switch (Template)"],"summary":"Modify switch template port","description":"Modify switch template port.","operationId":"modifySwitchPortTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}},{"name":"port","in":"path","description":"Port ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswPortSettingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/multi-ports/config":{"patch":{"tags":["Switch (Template)"],"summary":"Batch modify switch template port","description":"Batch modify switch template port.","operationId":"batchModifySwitchPortTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchOswPortSettingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/lags/{lagId}":{"delete":{"tags":["Switch (Template)"],"summary":"Delete switch template lag","description":"Delete switch template lag.","operationId":"deleteSwitchLagTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}},{"name":"lagId","in":"path","description":"Lag ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":15},"patch":{"tags":["Switch (Template)"],"summary":"Modify switch template lag","description":"Modify switch template lag.","operationId":"modifySwitchLagTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}},{"name":"lagId","in":"path","description":"Lag ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswLagSettingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/site/log-notification":{"get":{"tags":["Log (Template)"],"summary":"Get site template log notification","description":"Get site template log notification.","operationId":"getLogSettingForSiteTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLogNotificationSettingOpenApiVO"}}}}},"x-order":15},"patch":{"tags":["Log (Template)"],"summary":"Modify site template log notification","description":"Modify site template log notification.","operationId":"modifyLogSettingSiteTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogNotificationSettingEditOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/site/audit-notification":{"get":{"tags":["Audit Log (Template)"],"summary":"Get site template audit log notification","description":"Get site template audit log notification.","operationId":"getAuditLogSettingForMsp","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAuditLogNotificationSettingOpenApiVO"}}}}},"x-order":13},"patch":{"tags":["Audit Log (Template)"],"summary":"Modify site template audit log notification","description":"Modify site template audit log notification.","operationId":"modifyAuditLogSettingSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditLogNotificationSettingEditOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/sim/sms/router-command":{"get":{"tags":["SIM (Template)"],"summary":"Query SMS router command template","description":"Query SMS router command template.","operationId":"querySmsRouterCommandTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSmsRouterCommand"}}}}},"x-order":4},"patch":{"tags":["SIM (Template)"],"summary":"Modify SMS router command template","description":"Modify SMS router command template.","operationId":"modifySmsRouterCommandTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsRouterCommand"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/sim/sms/policy":{"get":{"tags":["SIM (Template)"],"summary":"Query SMS policy setting template","description":"Query SMS policy setting template.","operationId":"querySmsPolicySettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSmaPolicySetting"}}}}},"x-order":5},"patch":{"tags":["SIM (Template)"],"summary":"Modify SMS policy setting template","description":"Modify SMS policy setting template.","operationId":"modifySmsPolicySettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmaPolicySetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting":{"patch":{"tags":["Site Template Configuration"],"summary":"Modify Site template settings","description":"Modify Site template settings.","operationId":"modifySiteTemplateSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteTemplateSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":25}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/wan-ports":{"get":{"tags":["Wired Network (Template)"],"summary":"Get available wan ports","description":"Get available wan ports for template","operationId":"getAvailableWanPorts","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"function","in":"query","description":"function used for wan ports query. 0: ACL, 1: QOS, 2: IP_MAC_BLINDING, 3: IGMP_PROXY, 4: VIRTUAL_WAN, 5: PORT_FROWARDING, 6: OTONAT, 7: BANDWIDTH_CONTROL, 8: STATIC_ROUTING, 9: POLICY_ROUTING, 10: VPN, 11: SSL_VPN, 12: DDNS, 13: UPNP, 14: MLD, 15: LAN","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAvailableWanResultOpenApiVO"}}}}},"x-order":22},"patch":{"tags":["Wired Network (Template)"],"summary":"Modify Wan Ports","description":"modify wan ports for site template, Note that modify wan ports will cause gateway reboot. You need to configure a gateway in Device Template to use this function.","operationId":"modifyWanPortsTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WanPortsOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/voip/provider-profiles/{profileId}":{"patch":{"tags":["VoIP (Template)"],"summary":"Modify a provider profile template","description":"Modify a provider profile template.","operationId":"modifyProviderProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyProviderProfileEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/voip/emergency-number-settings":{"get":{"tags":["VoIP (Template)"],"summary":"Get Voip Emergency Number Info Template","description":"Get Voip Emergency Number Info Template.","operationId":"getVoipEmergency","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVoipEmergencyNumberSetting"}}}}},"x-order":1},"patch":{"tags":["VoIP (Template)"],"summary":"Modify Voip Emergency Number Setting Template","description":"Modify Voip Emergency Number Setting Template.","operationId":"modifyVoipEmergency","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoipEmergencyNumberSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/voip/dnd/settings":{"get":{"tags":["VoIP (Template)"],"summary":"Get DND settings template","description":"Get DND settings template","operationId":"getDndSettings","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDndSettingEntity"}}}}},"x-order":41},"patch":{"tags":["VoIP (Template)"],"summary":"Modify DND settings template","description":"Modify DND settings template","operationId":"modifyDndSettings","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DndSettingEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVoid"}}}}},"x-order":42}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/voip/digit-map/{profileId}":{"patch":{"tags":["VoIP"],"summary":"Modify a digit map profile template","description":"Modify a digit map profile template.","operationId":"modifyDigitMapProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Profile ID. Default digit map profile cannot be modified.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyDigitMapProfileEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":45}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/voip/call-blocking/{profileId}":{"patch":{"tags":["VoIP (Template)"],"summary":"Modify a call blocking profile template","description":"Modify a call blocking profile template.","operationId":"modifyCallBlockingProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyCallBlockingProfileEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/virtual-wans/{virtualWanId}":{"delete":{"tags":["Wired Network (Template)"],"summary":"Delete virtual WAN template","description":"Delete virtual WAN template.","operationId":"deleteVirtualWan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"virtualWanId","in":"path","description":"Virtual WAN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":32},"patch":{"tags":["Wired Network (Template)"],"summary":"Modify virtual WAN template","description":"Modify virtual WAN template.","operationId":"modifyVirtualWanTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"virtualWanId","in":"path","description":"Virtual WAN ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualWanConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":30}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/virtual-wans/{virtualWanId}/status":{"patch":{"tags":["Wired Network (Template)"],"summary":"Modify virtual WAN status template","description":"Modify virtual WAN status template.","operationId":"modifyVirtualWanStatusTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"virtualWanId","in":"path","description":"Virtual WAN ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualWanStatusOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":31}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/service/snmp":{"get":{"tags":["SNMP (Template)"],"summary":"Get SNMP template setting","description":"Get SNMP template setting info of the site with the given omadacId and siteId.","operationId":"getSnmpSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSnmpSettingOpenApiVO"}}}}},"x-order":13},"patch":{"tags":["SNMP (Template)"],"summary":"Modify SNMP template setting","description":"Modify SNMP template setting info of the site with the given params.","operationId":"modifySnmpSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SnmpSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/service/mdns/{mdnsId}":{"delete":{"tags":["mDNS (Template)"],"summary":"Delete an exist mDNS template rule","description":"Delete an exist mDNS template rule with the given params.","operationId":"deleteMdnsTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"mdnsId","in":"path","description":"mDNS rule template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":30},"patch":{"tags":["mDNS (Template)"],"summary":"Modify an exist mDNS template rule","description":"Modify an exist mDNS template rule with the given params.","operationId":"modifyMdnsTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"mdnsId","in":"path","description":"mDNS rule template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMdnsRuleTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":29}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/service/dns-proxy":{"get":{"tags":["DNS (Template)"],"summary":"Get DNS proxy template setting","description":"Get DNS proxy template setting of the site with the given omadacId and siteId.","operationId":"getDnsProxyTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDnsProxySettingQueryOpenApiVO"}}}}},"x-order":15},"patch":{"tags":["DNS (Template)"],"summary":"Modify DNS proxy template setting","description":"Modify DNS proxy template setting info of the site with the given params.","operationId":"modifyDnsProxyTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DnsProxySettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/service/ddns/{ddnsId}":{"delete":{"tags":["DNS (Template)"],"summary":"Delete an exist Dynamic DNS template entry","description":"Delete an exist Dynamic DNS template entry with the given params.","operationId":"deleteDdnsTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ddnsId","in":"path","description":"Dynamic DNS entry ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"patch":{"tags":["DNS (Template)"],"summary":"Modify an exist Dynamic DNS template entry","description":"Modify an exist Dynamic DNS template entry with the given params.","operationId":"modifyDdnsTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ddnsId","in":"path","description":"Dynamic DNS entry ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDdnsOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/mails/{mailId}":{"patch":{"tags":["SIM (Template)"],"summary":"modify mail server","description":"modify mail server.","operationId":"modifyMailServerTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"mailId","in":"path","description":"Mail ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailServerOpenApiModifyVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/iot/radio":{"get":{"tags":["Bluetooth(Template)"],"summary":"Get Iot Radio Setting(Template)","description":"Get Iot Radio Setting in site template.","operationId":"getIotRadioSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/IotRadioSettingOpenApiVO"}}}}},"x-order":8},"patch":{"tags":["Bluetooth(Template)"],"summary":"Modify Iot Radio Setting(Template)","description":"Modify Iot Radio Setting in site template.","operationId":"modifyIotRadioSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IotRadioSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/access-control":{"get":{"tags":["Access Control (Template)"],"summary":"Get access control setting template","description":"Get access control setting template with the given omadacId and siteTemplateId.","operationId":"getAccessControlTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePortalAccessControlOpenApiVO"}}}}},"x-order":1},"patch":{"tags":["Access Control (Template)"],"summary":"Modify access control setting template","description":"Modify access control setting template. When modifying, the full configuration parameters should be passed in","operationId":"modifyAccessControlTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalAccessControlOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePortalAccessControlOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/session-limit":{"get":{"tags":["Session Limit (Template)"],"summary":"Get site template's session limit","description":"Get site template's session limit.","operationId":"getTemplateSessionLimit","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSession Limit Entity"}}}}},"x-order":1},"patch":{"tags":["Session Limit (Template)"],"summary":"Modify site template's session limit","description":"Modify site template's session limit.","operationId":"modifyTemplateSessionLimit","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session limit entity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/session-limit/rules/{ruleId}":{"delete":{"tags":["Session Limit (Template)"],"summary":"Delete site template's session limit rule","description":"Delete site template's session limit rule.","operationId":"deleteTemplateSessionLimitRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","description":"Session limit rule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6},"patch":{"tags":["Session Limit (Template)"],"summary":"Modify site template's session limit rule","description":"Modify site template's session limit rule.","operationId":"modifyTemplateSessionLimitRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","description":"Session limit rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionLimitRuleTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/service":{"patch":{"tags":["Site Template Configuration"],"summary":"Modify Site template service settings","description":"Modify Site template service settings.","operationId":"modifySiteServiceTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifySiteServiceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":23}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/roaming":{"get":{"tags":["Site Template Configuration"],"summary":"Get site template roaming setting","description":"Get site template roaming setting","operationId":"getRoamingTemplateSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteRoamingSetting"}}}}},"x-order":11},"patch":{"tags":["Site Template Configuration"],"summary":"Modify site template roaming setting","description":"Modify site template roaming setting","operationId":"updateRoamingTemplateSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteRoamingSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/remote-logging":{"get":{"tags":["Site Template Configuration"],"summary":"Get site template remote logging setting","description":"Get site template remote logging setting","operationId":"getRemoteLoggingTemplateSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteRemoteLoggingSetting"}}}}},"x-order":9},"patch":{"tags":["Site Template Configuration"],"summary":"Modify site template remote logging setting","description":"Modify site template remote logging setting","operationId":"updateRemoteLoggingTemplateSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteRemoteLoggingSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/profiles/wifi-calling/{profileId}":{"delete":{"tags":["Profiles (Template)"],"summary":"Delete an exist wifi calling profile template","description":"Delete an exist wifi calling profile template with the given params.","operationId":"deleteWifiCallingProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"wifi calling profile ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":46},"patch":{"tags":["Profiles (Template)"],"summary":"Modify a wifi calling profile template","description":"Modify a wifi calling profile template with the given params.","operationId":"modifyWifiCallingProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Wifi calling profile ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWifiCallingProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":44}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/profiles/radius/{radiusProfileId}":{"delete":{"tags":["Profiles (Template)"],"summary":"Delete an exist RADIUS profile template","description":"Delete an exist RADIUS profile template with the given params.","operationId":"deleteRadiusProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"radiusProfileId","in":"path","description":"Radius profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14},"patch":{"tags":["Profiles (Template)"],"summary":"Modify an exist RADIUS profile template","description":"Modify an exist RADIUS profile template with the given params.","operationId":"modifyRadiusProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"radiusProfileId","in":"path","description":"Radius profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRadiusProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/profiles/radius-server/users/{userId}":{"delete":{"tags":["Profiles (Template)"],"summary":"Delete an exist Build-in RADIUS profile user template","description":"Get Build-in RADIUS profile user template list of the site with the given omadacId and siteId. Cloud Based Controller does not support built-in radius function, you cannot call this interface through openAPI on Cloud Based Controller.","operationId":"deleteRadiusUserTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","description":"Build-in RADIUS profile user Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18},"patch":{"tags":["Profiles (Template)"],"summary":"Modify an exist Build-in RADIUS profile user template","description":"Get Build-in RADIUS profile user template list of the site with the given omadacId and siteId. Cloud Based Controller does not support built-in radius function, you cannot call this interface through openAPI on Cloud Based Controller.","operationId":"modifyRadiusUserTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","description":"Build-in RADIUS profile user Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRadiusUserOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/profiles/ldap/{ldapProfileId}":{"delete":{"tags":["Profiles (Template)"],"summary":"Delete an exist LDAP profile template","description":"Delete an exist LDAP profile template with the given params.","operationId":"deleteLdapProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ldapProfileId","in":"path","description":"LDAP profile ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":37},"patch":{"tags":["Profiles (Template)"],"summary":"Modify an exist LDAP profile template","description":"Modify an exist LDAP profile template with the given params.","operationId":"modifyLdapProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ldapProfileId","in":"path","description":"LDAP profile ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLdapProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":36}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/profiles/groups/{groupType}/{groupId}":{"delete":{"tags":["Profiles (Template)"],"summary":"Delete an exist group profile template","description":"Delete an exist group profile template with the given params.","operationId":"deleteGroupProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"groupType","in":"path","description":"Type of group profile, 0:IP Group; 1:IP Port Group; 2：Mac Group; 3:IPv6 Group; 4:IPv6 Port Group; 5:Country Group; 7:Domain Group.","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"Group profile id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5},"patch":{"tags":["Profiles (Template)"],"summary":"Modify an exist group profile template","description":"Modify an exist group profile template with the given params.","operationId":"modifyGroupProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"groupType","in":"path","description":"Type of group profile, 0:IP Group; 1:IP Port Group; 2：Mac Group; 3:IPv6 Group; 4:IPv6 Port Group; 5:Country Group; 7:Domain Group.","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"Group profile id.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/portal/{portalId}":{"get":{"tags":["Authentication (Template)"],"summary":"Get portal template detail","description":"Get portal template detail information with the given omadacId, siteTemplateId and portalId.","operationId":"getPortalTemplateDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"portalId","in":"path","description":"Portal ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePortalDetailResOpenApiVO"}}}}},"x-order":7},"delete":{"tags":["Authentication (Template)"],"summary":"Delete portal template","description":"Delete portal setting with the given portal ID","operationId":"deletePortalTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"portalId","in":"path","description":"Portal ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6},"patch":{"tags":["Authentication (Template)"],"summary":"Modify portal template","description":"Modify the portal with the portal ID","operationId":"modifyPortalTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"portalId","in":"path","description":"Portal ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/network-security/ips":{"get":{"tags":["IDS/IPS (Template)"],"summary":"Get site template IDS/IPS config","description":"Get site template IDS/IPS config","operationId":"getIpsTemplateConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseIpsInfo"}}}}},"x-order":1},"patch":{"tags":["IDS/IPS (Template)"],"summary":"Modify site template IDS/IPS config","description":"Modify site template IDS/IPS config","operationId":"modifyIpsTemplateConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IpsInfo"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/multicast-rate-limit":{"get":{"tags":["Site Template Configuration"],"summary":"Get site template multicast rate limit setting","description":"Get site template multicast rate limit setting","operationId":"getMulticastRateLimitTemplateByOpenApi","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteMulticastRateLimitSetting"}}}}},"x-order":17},"patch":{"tags":["Site Template Configuration"],"summary":"Modify site template multicast rate limit setting","description":"Modify site template multicast rate limit setting","operationId":"updateMcastRateLimitSettingTemplateByOpenApi","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteMulticastRateLimitSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/mesh":{"get":{"tags":["Site Template Configuration"],"summary":"Get site template mesh setting","description":"Get site template mesh setting","operationId":"getMeshTemplateSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteMeshSetting"}}}}},"x-order":4},"patch":{"tags":["Site Template Configuration"],"summary":"Modify site template mesh setmesh setting","description":"Modify site template mesh setting","operationId":"updateMeshTemplateSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteMeshSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/mac-filters/{filterId}":{"delete":{"tags":["MAC Filtering (Template)"],"summary":"Delete MAC filtering template","description":"Delete MAC filtering template.","operationId":"deleteMacFilteringTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"filterId","in":"path","description":"MAC filtering template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7},"patch":{"tags":["MAC Filtering (Template)"],"summary":"Modify MAC filtering template","description":"Modify MAC filtering template.","operationId":"modifyMacFilteringTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"filterId","in":"path","description":"MAC filtering template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacFiltering"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/mac-filter":{"get":{"tags":["MAC Filtering (Template)"],"summary":"Get MAC filtering template general setting","description":"Get MAC filtering template general setting.","operationId":"getMacFilteringGeneralSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMacFilteringGeneralSetting"}}}}},"x-order":1},"patch":{"tags":["MAC Filtering (Template)"],"summary":"Modify MAC filtering template general setting","description":"Modify MAC filtering template general setting.","operationId":"modifyMacFilteringGeneralSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacFilteringGeneralSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/mac-auth":{"get":{"tags":["Authentication (Template)"],"summary":"Get site MAC-Based Authentication Template info","description":"Get MAC-Based Authentication setting info of the siteTemplate with the given omadacId and siteTemplateId.","operationId":"getMacAuthSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMacAuthOpenApiVO"}}}}},"x-order":13},"patch":{"tags":["Authentication (Template)"],"summary":"Update site MAC-Based Authentication Template info","description":"Update MAC-Based Authentication setting info of the siteTemplate with the given parameters.","operationId":"updateMacAuthSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMacAuthOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/lldp":{"get":{"tags":["Site Template Configuration"],"summary":"Get site template lldp setting","description":"Get site template lldp setting","operationId":"getLldpTemplateSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteLldpSetting"}}}}},"x-order":6},"patch":{"tags":["Site Template Configuration"],"summary":"Modify site template lldp setting","description":"Modify site template lldp setting","operationId":"updateLldpTemplateSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteLldpSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/lan/dns/{dnsId}":{"delete":{"tags":["Wired Network (Template)"],"summary":"Delete LAN Dns template","description":"Delete LAN Dns template","operationId":"deleteLanDnsTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"dnsId","in":"path","description":"LAN DNS ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":26},"patch":{"tags":["Wired Network (Template)"],"summary":"Modify LAN Dns template","description":"Modify LAN Dns template","operationId":"modifyLanDnsTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"dnsId","in":"path","description":"LAN DNS ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanDnsOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/lan-profiles/{profileId}":{"delete":{"tags":["Wired Network (Template)"],"summary":"Delete an existing LAN profile template","description":"Delete an existing LAN profile template.","operationId":"deleteLanProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"LAN profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"patch":{"tags":["Wired Network (Template)"],"summary":"Modify a LAN profile template","description":"Modify a LAN profile template template.","operationId":"modifyLanProfileTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"lanProfileId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanProfileConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/lan-networks/{networkId}":{"get":{"tags":["Wired Network (Template)"],"summary":"Get LAN network template","description":"Get LAN network template.","operationId":"getLanNetworkTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLanNetworkTemplateQueryOpenApiV3VO"}}}}},"x-order":57},"delete":{"tags":["Wired Network (Template)"],"summary":"Delete LAN network template","description":"Delete LAN network template","operationId":"deleteLanNetworkTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8},"patch":{"tags":["Wired Network (Template)"],"summary":"Modify LAN network template","description":"Modify LAN network template","operationId":"modifyLanNetworkTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanNetworkTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/lan-multicasts/{multicastId}":{"delete":{"tags":["Lan Multicast (Template)"],"summary":"Delete an existing lan multicast template","description":"Delete an existing lan multicast template","operationId":"deleteLanMulticastTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"multicastId","in":"path","description":"lanMulticastId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"patch":{"tags":["Lan Multicast (Template)"],"summary":"Modify a lan multicast template","description":"Modify a lan multicast template","operationId":"modifyLanMulticastTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"multicastId","in":"path","description":"lanMulticastId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanMulticastVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/ip-mac-binds/{bindId}":{"delete":{"tags":["IP-MAC Binding (Template)"],"summary":"Delete IP-MAC binding template","description":"Delete IP-MAC binding template.","operationId":"deleteIpMacBindingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"bindId","in":"path","description":"IP MAC binding template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6},"patch":{"tags":["IP-MAC Binding (Template)"],"summary":"Modify IP-MAC binding template","description":"Modify IP-MAC binding template.","operationId":"modifyIpMacBindingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"bindId","in":"path","description":"IP MAC binding template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPMacBinding"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/ip-mac-bind":{"get":{"tags":["IP-MAC Binding (Template)"],"summary":"Get IP-MAC binding template general setting","description":"Get IP-MAC binding template general setting.","operationId":"getIpMacBindingGeneralSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseIPMacBindingGeneralSetting"}}}}},"x-order":1},"patch":{"tags":["IP-MAC Binding (Template)"],"summary":"Modify IP-MAC binding template general setting","description":"Modify IP-MAC binding template general setting.","operationId":"modifyIpMacBindingGeneralSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPMacBindingGeneralSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/general/config":{"patch":{"tags":["Site Template Configuration"],"summary":"Modify the general configuration settings of the Site template","description":"Modify the general configuration settings of the Site template.","operationId":"modifySiteTemplateGeneralConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteServiceGeneralConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":24}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/ports/{port}/config":{"patch":{"tags":["Gateway (Template)"],"summary":"Modify gateway template port config","description":"Modify gateway template port config","operationId":"modifyPortConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}},{"name":"port","in":"path","description":"Gateway port number","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTemplatePortSettingConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGatewayTemplatePortSettingConfig"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/config/wlans/ssid/{ssidId}/mac-filter":{"patch":{"tags":["Gateway (Template)"],"summary":"Update SSID mac filter config","description":"Update SSID MAC filter config","operationId":"modifySsidMacFilterConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidMacFilterOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/config/wlans/ssid/{ssidId}/basic-config":{"patch":{"tags":["Gateway (Template)"],"summary":"modify SSID basic config","description":"modify SSID basic config","operationId":"modifySsidBasicConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidBasicConfigForIpptOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/firewall":{"get":{"tags":["Firewall (Template)"],"summary":"Get firewall template setting","description":"Get firewall template setting.","operationId":"getFirewallSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseFirewallSetting"}}}}},"x-order":1},"patch":{"tags":["Firewall (Template)"],"summary":"Modify firewall template setting","description":"Modify firewall template setting.","operationId":"modifyFirewallSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FirewallSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/firewall/reset":{"patch":{"tags":["Firewall (Template)"],"summary":"Reset firewall template setting","description":"Reset firewall template setting.","operationId":"resetFirewallSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/devicetemplates/{deviceTemplateId}":{"delete":{"tags":["Site Template"],"summary":"delete device template","description":"delete device template","operationId":"deleteDeviceTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":20},"patch":{"tags":["Site Template"],"summary":"modify device template","description":"modify device template","operationId":"modifyDeviceTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deviceTemplateEdit"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/cli/config/cli-type/{cliType}/config-id/{configId}":{"get":{"tags":["CLI (Template)"],"summary":"Get the CLI template configuration content","description":"Get the CLI template configuration content","operationId":"getCliConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"cliType","in":"path","description":"CLI type should be a value as follows: 0: site CLI; 1: device CLI； 2：model CLI. Site template only supports site CLI. Site template only supports site CLI.","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"CLI Config ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCliConfigTemplateOpenApiVO"}}}}},"x-order":2},"patch":{"tags":["CLI (Template)"],"summary":"Modify the CLI template configuration content","description":"Modify the CLI template configuration content","operationId":"modifyCliConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"cliType","in":"path","description":"CLI type should be a value as follows: 0: site CLI; 1: device CLI； 2：model CLI. Site template only supports site CLI. Site template only supports site CLI.","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"CLI Config ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyCliTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/channel-limit":{"get":{"tags":["Site Template Configuration"],"summary":"Get site template channel limit setting","description":"Get site template channel limit settingThis interface has been deprecated.","operationId":"getChannelLimitTemplateSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteChannelLimitSetting"}}}}},"deprecated":true,"x-order":3},"patch":{"tags":["Site Template Configuration"],"summary":"Modify site template channel limit setting","description":"Modify site template channel limit settingThis interface has been deprecated.","operationId":"updateChannelLimitTemplateSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteChannelLimitSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/beacon-control":{"patch":{"tags":["Site Template Configuration"],"summary":"Modify site template beacon control setting","description":"Modify site template beacon control setting","operationId":"updateBeaconControlTemplateSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteBeaconControlSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/bandwidth-control":{"get":{"tags":["Bandwidth Control (Template)"],"summary":"Get bandwidth control template","description":"Get bandwidth control template.","operationId":"getBandwidthCtrlTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseBandwidthControl"}}}}},"x-order":1},"patch":{"tags":["Bandwidth Control (Template)"],"summary":"Modify bandwidth control template","description":"Modify bandwidth control template.","operationId":"modifyBandwidthCtrlTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BandwidthControl"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/bandwidth-control/rules/{ruleId}":{"delete":{"tags":["Bandwidth Control (Template)"],"summary":"Delete bandwidth control template rule","description":"Delete bandwidth control template rule.","operationId":"deleteBandwidthCtrlRuleTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","description":"Bandwidth control template rule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6},"patch":{"tags":["Bandwidth Control (Template)"],"summary":"Modify bandwidth control template rule","description":"Modify bandwidth control template rule.","operationId":"modifyBandwidthCtrlRuleTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","description":"Bandwidth control template rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BandwidthControlRule"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/band-steering":{"patch":{"tags":["Site Template Configuration"],"summary":"Modify site template band steering setting","description":"Modify site template band steering setting","operationId":"updateBandSteeringTemplateSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteBandSteeringSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/attack-defense":{"get":{"tags":["Attack Defense (Template)"],"summary":"Get attack and defense template setting","description":"Get attack and defense template setting.","operationId":"getAttackDefenseSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAttackDefenseSetting"}}}}},"x-order":1},"patch":{"tags":["Attack Defense (Template)"],"summary":"Modify attack and defense template setting","description":"Modify attack and defense template setting.","operationId":"modifyAttackDefenseSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttackDefenseSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/attack-defense/reset":{"patch":{"tags":["Attack Defense (Template)"],"summary":"Reset attack and defense template setting","description":"Reset attack and defense template setting.","operationId":"resetAttackDefenseSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/ap-groups/{apGroupId}":{"delete":{"tags":["Wireless Network (Template)"],"summary":"Delete an existing AP Group template","description":"Delete an existing AP Group template","operationId":"deleteApGroupTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"apGroupId","in":"path","description":"AP GROUP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"patch":{"tags":["Wireless Network (Template)"],"summary":"Modify an existing AP Group template","description":"Modify an existing AP Group template","operationId":"updateApGroupTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"apGroupId","in":"path","description":"AP GROUP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/anomaly/setting/modify":{"patch":{"tags":["Incident (Template)"],"summary":"Modify site template anomaly event setting","description":"Modify site template anomaly event setting.","operationId":"modifyAnomalyEventSettingForSiteTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnomalyEventSettingEditOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}}}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/anomaly/notification":{"get":{"tags":["Incident (Template)"],"summary":"Get abnormal notification template info","description":"Get abnormal notification template info.","operationId":"getNotificationTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseNotificationOpenApiVO"}}}}},"x-order":3},"patch":{"tags":["Incident (Template)"],"summary":"Set abnormal notification template info","description":"Set abnormal notification template info.","operationId":"modifyNotificationTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetNotificationOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSetNotificationOpenApiVO"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/acls/osg-custom-acls":{"get":{"tags":["ACL (Template)"],"summary":"Get osg custom ACL template","description":"Get osg custom ACL template.","operationId":"getOsgCustomAclListTemplate","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOGateway Custom ACL Info Entity"}}}}},"x-order":9},"patch":{"tags":["ACL (Template)"],"summary":"Update osg custom ACL templates","description":"Update osg custom ACL templates.","operationId":"updateOsgCustomAclsTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Gateway Custom ACL update entity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/wlans/{wlanId}":{"delete":{"tags":["Wireless Network"],"summary":"Delete an existing WLAN Group","description":"Delete an existing WLAN Group, Legacy note: “WLAN Group” is the legacy name of “AP Group”. This endpoint will be deprecated in future releases. Please use Delete an existing AP Group.","operationId":"deleteWlanGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":68},"patch":{"tags":["Wireless Network"],"summary":"Modify an existing WLAN Group","description":"Modify an existing WLAN Group, Legacy note: “WLAN Group” is the legacy name of “AP Group”. This endpoint will be deprecated in future releases. Please use Modify an existing AP Group.","operationId":"updateWlanGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWlanGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":67}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-wlan-schedule":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID WLAN schedule config","description":"Update SSID WLAN schedule config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID WLAN schedule config by site.","operationId":"updateSsidWlanSchedule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidWlanScheduleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-wifi-calling":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID wifi calling config","description":"Update SSID Wi-Fi Calling config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID wifi calling config by site.","operationId":"updateSsidWifiCallingConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWifiCallingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":29}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-rate-limit":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID rate limit config","description":"Update SSID rate limit config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID rate limit config by site.","operationId":"updateSsidRateLimitConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidRateLimitOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-rate-control":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID 802.11 rate control config","description":"Update SSID 802.11 rate control config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID 802.11 rate control config by site.","operationId":"updateSsidRateControlConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidRateControlOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-multicast-config":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID Multicast/Broadcast management config","description":"Update SSID Multicast/Broadcast management config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID Multicast/Broadcast management config by site.","operationId":"updateSsidMultiCastConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidMultiCastOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-mac-filter":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID mac filter config","description":"Update SSID MAC filter config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID mac filter config by site.","operationId":"updateSsidMacFilterConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidMacFilterOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-load-balance":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID load balance config","description":"Update SSID load balance config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID load balance config by site.","operationId":"updateSsidLoadBalanceConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidLoadBalanceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":30}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-hotspotv2":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID Hotspot2.0 config","description":"Update SSID Hotspot2.0 config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID Hotspot2.0 config by site.","operationId":"updateSsidHotspotV2Setting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidHotspotV2SettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":19}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-dhcp-option":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID DHCP option 82 config","description":"Update SSID DHCP option 82 config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID DHCP option 82 config by site.","operationId":"updateSsidDhcpOptionConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidDhcpOptionOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":21}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-basic-config":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID basic config","description":"Update SSID basic config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID basic config by site.","operationId":"updateSsidBasicConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidBasicConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}/update-band-steer":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID band steer config","description":"Update SSID band steer config, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Update SSID band steer config by site.","operationId":"updateSsidBandSteerConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidBandSteerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":31}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssids/{ssidId}/wlan-schedule":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID WLAN schedule config by site","description":"Update SSID WLAN schedule config by site","operationId":"updateSsidWlanScheduleBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidWlanScheduleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":37}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssids/{ssidId}/wifi-calling":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID wifi calling config by site","description":"Update SSID Wi-Fi Calling config by site","operationId":"updateSsidWifiCallingConfigBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWifiCallingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":43}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssids/{ssidId}/rate-limit":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID rate limit config by site","description":"Update SSID rate limit config by site","operationId":"updateSsidRateLimitConfigBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidRateLimitOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":36}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssids/{ssidId}/rate-control":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID 802.11 rate control config by site","description":"Update SSID 802.11 rate control config by site","operationId":"updateSsidRateControlConfigBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidRateControlOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":38}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssids/{ssidId}/multicast-config":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID Multicast/Broadcast management config by site","description":"Update SSID Multicast/Broadcast management config","operationId":"updateSsidMultiCastConfigBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidMultiCastOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":40}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssids/{ssidId}/mac-filter":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID mac filter config by site","description":"Update SSID MAC filter config","operationId":"updateSsidMacFilterConfigBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidMacFilterOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":39}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssids/{ssidId}/load-balance":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID load balance config by site","description":"Update SSID load balance config by site","operationId":"updateSsidLoadBalanceConfigBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidLoadBalanceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":44}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssids/{ssidId}/hotspotv2":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID Hotspot2.0 config by site","description":"Update SSID Hotspot2.0 config","operationId":"updateSsidHotspotV2SettingBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidHotspotV2SettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":41}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssids/{ssidId}/enable":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID Enable Status by site","description":"Update SSID Enable Status by site","operationId":"updateSsidEnableStatusBySite_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidEnableStatusOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":60}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssids/{ssidId}/dhcp-option":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID DHCP option 82 config by site","description":"Update SSID DHCP option 82 config by site","operationId":"updateSsidDhcpOptionConfigBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidDhcpOptionOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":42}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssids/{ssidId}/basic-config":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID basic config by site","description":"Update SSID basic config by site","operationId":"updateSsidBasicConfigBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidBasicConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":35}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssids/{ssidId}/band-steer":{"patch":{"tags":["Wireless Network"],"summary":"Update SSID band steer config by site","description":"Update SSID band steer config by site","operationId":"updateSsidBandSteerConfigBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidBandSteerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":45}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssids/{ssidId}/ap-groups":{"get":{"tags":["Wireless Network"],"summary":"Query AP Groups bound to the SSID","description":"Query AP Groups bound to the SSID","operationId":"querySsidBindApGroups","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApGroupDetailOpenApiVO"}}}}},"x-order":47},"patch":{"tags":["Wireless Network"],"summary":"Update SSID binding ap groups","description":"Update SSID binding ap groups","operationId":"updateSsidBindApGroups","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidBindApGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":46}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssids/duplicate-name":{"get":{"tags":["Wireless Network"],"summary":"Query SSIDs with the same name","description":"Query SSIDs with the same name","operationId":"querySsidDuplicateNameBySite_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDuplicateSsidOpenApiVO"}}}}},"x-order":53},"patch":{"tags":["app"],"summary":"Merge SSIDs with the same name","description":"Merge SSIDs with the same name","operationId":"mergeSsidBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MergeSsidOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":26}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssid-operation/{ssidId}":{"delete":{"tags":["app"],"summary":"Delete an existing SSID of Site","description":"Delete an existing SSID of Site","operationId":"deleteSsidBySite_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":20},"patch":{"tags":["app"],"summary":"Modify an existing SSID of Site","description":"Modify an existing SSID of Site","operationId":"modifySsidBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SsidVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/wan/networks/port-setting":{"patch":{"tags":["Wired Network"],"summary":"Modify Wan Port Settings","description":"Modify Wan Port Settings.","operationId":"modifyWanPortSettings","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternetPortOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":49}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/{vpnId}/status":{"patch":{"tags":["VPN"],"summary":"Modify VPN status","description":"Modify VPN status.","operationId":"modifyClientStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnStatusVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/users/{userId}":{"delete":{"tags":["VPN"],"summary":"Delete VPN user","description":"Delete VPN user.","operationId":"deleteVpnUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","description":"VPN user ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":62},"patch":{"tags":["VPN"],"summary":"Modify VPN user","description":"Modify VPN user. This interface has been deprecated. Please use the following interface instead: Modify VPN user V3. This interface had been deprecated.","operationId":"modifyVpnUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","description":"VPN user ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VpnUser"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":60}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/site-to-site-vpns/{vpnId}":{"get":{"tags":["VPN"],"summary":"Get site-to-site VPN info","description":"Get site-to-site VPN info. This interface has been deprecated. Please use the following interfaces instead: Get VPN Site to Site summary list and Get site-to-site VPN detail info. This interface had been deprecated.","operationId":"getSiteToSiteVpnInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteToSiteVpn"}}}}},"deprecated":true,"x-order":51},"delete":{"tags":["VPN"],"summary":"Delete site-to-site VPN","description":"Delete site-to-site VPN. This interface has been deprecated. Please use the following interfaces instead: Delete VPN V2. This interface had been deprecated.","operationId":"deleteSiteToSiteVpn","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":42},"patch":{"tags":["VPN"],"summary":"Modify site-to-site VPN","description":"Modify site-to-site VPN. This interface has been deprecated. Please use the following interfaces instead: Modify site-to-site VPN by auto or Modify site-to-site VPN by manual.","operationId":"modifySiteToSiteVpn","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteToSiteVpn"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":41}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ipsec_failovers/{failoverId}":{"delete":{"tags":["VPN"],"summary":"Delete IPsec failover","description":"Delete IPsec failover. This interface has been deprecated. Please use the following interfaces instead: Modify site-to-site VPN by manual. This interface had been deprecated.","operationId":"deleteIpsecFailover","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"failoverId","in":"path","description":"IPSec failover ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":66},"patch":{"tags":["VPN"],"summary":"Modify IPsec failover","description":"Modify IPsec failover. This interface has been deprecated. Please use the following interfaces instead: Modify site-to-site VPN by manual. This interface had been deprecated.","operationId":"modifyIpsecFailover","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"failoverId","in":"path","description":"IPSec failover ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPsecFailover configuration"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":65}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/client-to-site-vpn-servers/{vpnId}":{"get":{"tags":["VPN"],"summary":"Get client-to-site VPN server info","description":"Get client-to-site VPN server info. This interface has been deprecated. Please use the following interfaces instead: Get VPN Server summary list and Get client-to-site VPN server detail info. This interface had been deprecated.","operationId":"getClientToSiteVpnServerInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientToSiteVpnServer"}}}}},"deprecated":true,"x-order":52},"delete":{"tags":["VPN"],"summary":"Delete client-to-site VPN server","description":"Delete client-to-site VPN server. This interface has been deprecated. Please use the following interfaces instead: Delete VPN V2. This interface had been deprecated.","operationId":"deleteClientToSiteVpnServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":46},"patch":{"tags":["VPN"],"summary":"Modify client-to-site VPN server","description":"Modify client-to-site VPN server. This interface has been deprecated. Please use the following interfaces instead: Modify client-to-site VPN server V2. This interface had been deprecated.","operationId":"modifyClientToSiteVpnServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientToSiteVpnServer"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":45}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/client-to-site-vpn-clients/{vpnId}":{"get":{"tags":["VPN"],"summary":"Get client-to-site VPN client info","description":"Get client-to-site VPN client info. This interface has been deprecated. Please use the following interfaces instead: Get VPN Client summary list and Get client-to-site VPN client detail info. This interface had been deprecated.","operationId":"getVpnClientToSiteClientInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientToSiteVpnClient"}}}}},"deprecated":true,"x-order":53},"delete":{"tags":["VPN"],"summary":"Delete client-to-site VPN client","description":"Delete client-to-site VPN client. This interface has been deprecated. Please use the following interfaces instead: Delete VPN V2. This interface had been deprecated.","operationId":"deleteClientToSiteVpnClient","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":50},"patch":{"tags":["VPN"],"summary":"Modify client-to-site VPN client","description":"Modify client-to-site VPN client. This interface has been deprecated. Please use the following interfaces instead: Modify client-to-site VPN client V2. This interface had been deprecated.","operationId":"modifyClientToSiteVpnClient","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientToSiteVpnClient"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":49}},"/openapi/v1/{omadacId}/sites/{siteId}/voip/telephone-book/{contactId}":{"delete":{"tags":["VoIP"],"summary":"Delete Contact Person","description":"Delete Contact Person.","operationId":"deleteVoipTelephoneBook","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"contactId","in":"path","description":"Voip Contact Person ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoipDeleteTelephoneBook"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6},"patch":{"tags":["VoIP"],"summary":"Modify Contact Person","description":"Modify Contact Person.","operationId":"modifyVoipTelephoneBook","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"contactId","in":"path","description":"Voip Contact Person ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoipContactPersonSettings"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/voip/emergency-number-settings":{"get":{"tags":["VoIP"],"summary":"Get Voip Emergency Number Info","description":"Get Voip Emergency Number Info.","operationId":"getVoipEmergency_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVoipEmergencyNumberSetting"}}}}},"x-order":1},"patch":{"tags":["VoIP"],"summary":"Modify Voip Emergency Number Setting","description":"Modify Voip Emergency Number Setting.","operationId":"modifyVoipEmergency_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoipEmergencyNumberSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/url-filters/{ruleId}":{"delete":{"tags":["URL Filtering"],"summary":"Delete URL filtering rule","description":"Delete URL filtering rule.","operationId":"deleteUrlFilteringRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","description":"URL filtering rule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5},"patch":{"tags":["URL Filtering"],"summary":"Modify URL filtering rule","description":"Modify URL filtering rule.","operationId":"modifyUrlFilteringRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","description":"URL filtering rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UrlFilteringOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/url-filters/globalUrlFilter":{"get":{"tags":["URL Filtering"],"summary":"Get Content Filter Global","description":"Get Content Filter Global.","operationId":"getUrlFilterGeneral","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUrlFilterGlobalOpenApiVO"}}}}},"x-order":7},"patch":{"tags":["URL Filtering"],"summary":"Edit Content Filter Global","description":"Edit Content Filter Global.","operationId":"modifyUrlFilterGeneral","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UrlFilterGlobalOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/ports/{port}":{"patch":{"tags":["Switch"],"summary":"Modify switch port","description":"Modify switch port.","operationId":"modifySwitchPort","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"port","in":"path","description":"Port ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswPortSettingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseString"}}}}},"x-order":42}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/multi-ports/config":{"patch":{"tags":["Switch"],"summary":"Batch modify switch port","description":"Batch modify switch port.","operationId":"batchModifySwitchPort","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchOswPortSettingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseString"}}}}},"x-order":43}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/lags/{lagId}":{"delete":{"tags":["Switch"],"summary":"Delete switch lag","description":"Delete switch lag.","operationId":"deleteSwitchLag","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"lagId","in":"path","description":"Lag ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseString"}}}}},"x-order":45},"patch":{"tags":["Switch"],"summary":"Modify switch lag","description":"Modify switch lag.","operationId":"modifySwitchLag","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"lagId","in":"path","description":"Lag ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswLagSettingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseString"}}}}},"x-order":44}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/general-config":{"get":{"tags":["Switch"],"summary":"Get switch general config","description":"Get switch general config.","operationId":"getGeneralConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSwitchGeneralConfig"}}}}},"x-order":3},"patch":{"tags":["Switch"],"summary":"Modify switch general config","description":"Modify switch general config.","operationId":"modifyGeneralConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchGeneralConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswDetailVO"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/multi-ports/config":{"patch":{"tags":["Switch"],"summary":"Batch modify switches ports and lags","description":"Batch modify switches ports and lags.","operationId":"batchModifySwitchesPortLag","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiOswPortSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseString"}}}}},"x-order":46}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/es/{switchMac}/general-config":{"get":{"tags":["Switch"],"summary":"Get switch general config (Agile Series )","description":"Get Agile Series switch general config.","operationId":"getESGeneralConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseEasyManagedSwitchGeneralConfigDetail"}}}}},"x-order":7},"patch":{"tags":["Switch"],"summary":"Modify switch general config (Agile Series)","description":"Modify Agile Series switch general config.","operationId":"modifyESGeneralConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EasyManagedSwitchGeneralConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseESDetailVO"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/{stackId}/ports/{port}":{"patch":{"tags":["Stack"],"summary":"Modify stack port","description":"Modify stack port. This interface has been deprecated. Please use the following interface instead: Modify stack port V2","operationId":"modifyOswStackPort","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"port","in":"path","description":"Port","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswPortSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":17}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/{stackId}/networks/{networkId}":{"patch":{"tags":["Stack"],"summary":"Modify stack vlan interface","description":"Modify stack vlan interface.","operationId":"modifyStackNetwork","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswNetworkOpenApi"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswStackNetworkModifyRespOpenApiVO"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/{stackId}/lags/{lagId}":{"get":{"tags":["Stack"],"summary":"Get stack lag","description":"Get stack lag.","operationId":"getOswStackLag","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"lagId","in":"path","description":"LAG ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswStackMemberLagVO"}}}}},"x-order":12},"delete":{"tags":["Stack"],"summary":"Delete stack lag","description":"Delete stack lag. This interface has been deprecated. Please use the following interface instead: Delete stack lag V2","operationId":"deleteOswStackLag","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"lagId","in":"path","description":"LAG ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":14},"patch":{"tags":["Stack"],"summary":"Modify stack lag","description":"Modify stack lag. This interface has been deprecated. Please use the following interface instead: Modify stack lag V2","operationId":"modifyOswStackLag","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"lagId","in":"path","description":"LAG ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswStackMemberLagOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/{stackId}/config":{"patch":{"tags":["Stack"],"summary":"Modify stack detail","description":"Modify stack detail.","operationId":"modifyOswStackDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OswStackDetailConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/{stackId}/config/loopback":{"patch":{"tags":["Stack"],"summary":"Modify stack loopback control","description":"Modify stack loopback control.","operationId":"modifyStackLoopbackControl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchLoopbackControl"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/sites/{siteId}/site/log-notification":{"get":{"tags":["Log"],"summary":"Get site log notification","description":"Get site log notification.This interface has been deprecated. Please use the following interface instead: Get site log notification v2","operationId":"getLogSettingForSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLogNotificationSettingOpenApiVO"}}}}},"deprecated":true,"x-order":98},"patch":{"tags":["Log"],"summary":"Modify site log notification","description":"Modify site log notification.This interface has been deprecated. Please use the following interface instead: Modify site log notification v2","operationId":"modifyLogSettingSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogNotificationSettingEditOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":99}},"/openapi/v1/{omadacId}/sites/{siteId}/site/audit-notification":{"get":{"tags":["Audit Log"],"summary":"Get site audit log notification","description":"Get site audit log notification.","operationId":"getAuditLogSettingForMsp_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAuditLogNotificationSettingOpenApiVO"}}}}},"x-order":4},"patch":{"tags":["Audit Log"],"summary":"Modify site audit log notification","description":"Modify site audit log notification.","operationId":"modifyAuditLogSettingSite_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditLogNotificationSettingEditOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/sim/sms/router-command":{"get":{"tags":["SIM"],"summary":"Query SMS router command","description":"Query SMS router command.","operationId":"querySmsRouterCommand","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSmsRouterCommand"}}}}},"x-order":15},"patch":{"tags":["SIM"],"summary":"Modify SMS router command","description":"Modify SMS router command.","operationId":"modifySmsRouterCommand","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsRouterCommand"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/sim/sms/policy":{"get":{"tags":["SIM"],"summary":"Query SMS policy setting","description":"Query SMS policy setting.","operationId":"querySmsPolicySetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSmaPolicySetting"}}}}},"x-order":13},"patch":{"tags":["SIM"],"summary":"Modify SMS policy setting","description":"Modify SMS policy setting.","operationId":"modifySmsPolicySetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmaPolicySetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/sim/quota":{"get":{"tags":["SIM"],"summary":"Get SIM data setting","description":"Get SIM data setting.","operationId":"querySimQuotaSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSimQuotaSetting"}}}}},"x-order":2},"patch":{"tags":["SIM"],"summary":"Modify SIM data setting","description":"Modify SIM data setting.","operationId":"modifySimQuotaSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimQuotaSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/wan-ports":{"get":{"tags":["Wired Network"],"summary":"Get available wan ports","description":"Get available wan ports","operationId":"getAvailableWanPorts_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"function","in":"query","description":"function used for wan ports query. 0: ACL, 1: QOS, 2: IP_MAC_BLINDING, 3: IGMP_PROXY, 4: VIRTUAL_WAN, 5: PORT_FROWARDING, 6: OTONAT, 7: BANDWIDTH_CONTROL, 8: STATIC_ROUTING, 9: POLICY_ROUTING, 10: VPN, 11: SSL_VPN, 12: DDNS, 13: UPNP, 14: MLD, 15: LAN","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAvailableWanResultOpenApiVO"}}}}},"x-order":51},"patch":{"tags":["Wired Network"],"summary":"Modify Wan Ports","description":"modify wan ports, Note that modify wan ports will cause gateway reboot.","operationId":"modifyWanPorts","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WanPortsOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":56}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voip-devices/{deviceMac}":{"patch":{"tags":["VoIP"],"summary":"Modify Voip Device AP Setting","description":"Modify Voip Device AP Setting.","operationId":"modifyVoipDeviceSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyVoipDeviceApSettingEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseModifyConfirmResultOpenApiVO"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voip-devices/telephone-number/batch-config-list":{"get":{"tags":["VoIP"],"summary":"Get Telephone Number Config List","description":"Get Telephone Number Config List.","operationId":"getTelephoneNumberBatchConfigList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTelephoneNumberWithStatusGridVOTelephoneNumberWithStatusOpenApiVO"}}}}},"x-order":38},"patch":{"tags":["VoIP"],"summary":"Update Telephone Number List","description":"Update Telephone Number List.","operationId":"updateTelephoneNumberList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TelephoneNumberListUpdateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":39}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voip-devices/osg/{deviceMac}":{"patch":{"tags":["VoIP"],"summary":"Modify Voip Device OSG Setting","description":"Modify Voip Device OSG Setting.","operationId":"modifyVoipDeviceOsgSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyVoipDeviceOsgSettingEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseModifyConfirmResultOpenApiVO"}}}}},"x-order":26}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voip-devices/batch-modify":{"patch":{"tags":["VoIP"],"summary":"Batch Modify Voip Device Setting","description":"Batch modify VoIP device setting.","operationId":"batchModifyVoipDeviceSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchModifyVoipDeviceSettingEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListProfilesBindedDeviceInfo"}}}}},"x-order":27}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voice-mail/settings":{"get":{"tags":["VoIP"],"summary":"Get voice mail settings","description":"Get voice mail settings","operationId":"getVoipMailSettings","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVoiceMailSettingResponse"}}}}},"x-order":34},"patch":{"tags":["VoIP"],"summary":"Edit voice mail settings","description":"Edit voice mail settings","operationId":"setVoipMailSettings","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceMailSettingRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":35}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/provider-profiles/{profileId}":{"patch":{"tags":["VoIP"],"summary":"Modify a provider profile","description":"Modify a provider profile.","operationId":"modifyProviderProfile_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyProviderProfileEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/dnd/settings":{"get":{"tags":["VoIP"],"summary":"Get DND settings","description":"Get DND settings","operationId":"getDndSettings_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDndSettingEntity"}}}}},"x-order":41},"patch":{"tags":["VoIP"],"summary":"Modify DND settings","description":"Modify DND settings","operationId":"modifyDndSettings_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DndSettingEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVoid"}}}}},"x-order":42}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/digit-map/{profileId}":{"patch":{"tags":["VoIP"],"summary":"Modify a digit map profile","description":"Modify a digit map profile.","operationId":"modifyDigitMapProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Profile ID. Default digit map profile cannot be modified.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyDigitMapProfileEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/call-blocking/{profileId}":{"patch":{"tags":["VoIP"],"summary":"Modify a call blocking profile","description":"Modify a call blocking profile.","operationId":"modifyCallBlockingProfile_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyCallBlockingProfileEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/virtual-wans/{virtualWanId}":{"delete":{"tags":["Wired Network"],"summary":"Delete virtual WAN","description":"Delete virtual WAN.","operationId":"deleteVirtualWan_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"virtualWanId","in":"path","description":"Virtual WAN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":37},"patch":{"tags":["Wired Network"],"summary":"Modify virtual WAN","description":"Modify virtual WAN.","operationId":"modifyVirtualWan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"virtualWanId","in":"path","description":"Virtual WAN ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualWanConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":35}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/virtual-wans/{virtualWanId}/status":{"patch":{"tags":["Wired Network"],"summary":"Modify virtual WAN status","description":"Modify virtual WAN status.","operationId":"modifyVirtualWanStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"virtualWanId","in":"path","description":"Virtual WAN ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualWanStatusOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":36}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/snmp":{"get":{"tags":["SNMP"],"summary":"Get SNMP setting","description":"Get SNMP setting info of the site with the given omadacId and siteId.","operationId":"getSnmpSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSnmpSettingOpenApiVO"}}}}},"x-order":1},"patch":{"tags":["SNMP"],"summary":"Modify SNMP setting","description":"Modify SNMP setting info of the site with the given params.","operationId":"modifySnmpSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SnmpSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/mdns/{mdnsId}":{"delete":{"tags":["mDNS"],"summary":"Delete an exist mDNS rule","description":"Delete an exist mDNS rule with the given params.","operationId":"deleteMdns","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"mdnsId","in":"path","description":"mDNS rule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseString"}}}}},"x-order":4},"patch":{"tags":["mDNS"],"summary":"Modify an exist mDNS rule","description":"Modify an exist mDNS rule with the given params.","operationId":"modifyMdns","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"mdnsId","in":"path","description":"mDNS rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMdnsRuleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/dns-proxy":{"get":{"tags":["DNS"],"summary":"Get DNS proxy setting","description":"Get DNS proxy setting of the site with the given omadacId and siteId.","operationId":"getDnsProxy","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDnsProxySettingQueryOpenApiVO"}}}}},"x-order":14},"patch":{"tags":["DNS"],"summary":"Modify DNS proxy setting","description":"Modify DNS proxy setting info of the site with the given params.","operationId":"modifyDnsProxy","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DnsProxySettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/dhcp/{mac}":{"delete":{"tags":["DHCP Reservation"],"summary":"Delete an exist DHCP reservation","description":"Delete an exist DHCP reservation with the given params.","operationId":"deleteDhcpReservation","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"mac","in":"path","description":"MAC address of the DHCP reservation, format: AA-BB-CC-11-22-33.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"patch":{"tags":["DHCP Reservation"],"summary":"Modify an exist DHCP reservation","description":"Modify an exist DHCP reservation with the given params.","operationId":"modifyDhcpReservation","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"mac","in":"path","description":"MAC address of the DHCP reservation, format: AA-BB-CC-11-22-33.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDhcpReservationOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/ddns/{ddnsId}":{"delete":{"tags":["DNS"],"summary":"Delete an exist Dynamic DNS entry","description":"Delete an exist Dynamic DNS entry with the given params.","operationId":"deleteDdns","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ddnsId","in":"path","description":"Dynamic DNS entry ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9},"patch":{"tags":["DNS"],"summary":"Modify an exist Dynamic DNS entry","description":"Modify an exist Dynamic DNS entry with the given params.","operationId":"modifyDdns","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ddnsId","in":"path","description":"Dynamic DNS entry ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDdnsOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/roaming/pingpang/enable":{"patch":{"tags":["Site"],"summary":"enable the site setting of ping pang suppression","description":"enable the site setting of ping pang suppression","operationId":"modifySiteWirelessFeaturePingPangEnable","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":27}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/mails/{mailId}":{"patch":{"tags":["SIM"],"summary":"Modify mail server","description":"Modify mail server.","operationId":"modifyMailServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"mailId","in":"path","description":"Mail ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailServerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/lan/dns/{dnsId}":{"delete":{"tags":["Wired Network"],"summary":"Delete an existing LAN DNS rule","description":"Delete an existing LAN DNS rule. ","operationId":"deleteLanDns","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"dnsId","in":"path","description":"LAN DNS ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":41},"patch":{"tags":["Wired Network"],"summary":"Modify an existing LAN DNS rule","description":"Modify an existing LAN DNS rule.","operationId":"modifyLanDns","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"dnsId","in":"path","description":"LAN DNS ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanDnsOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":40}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/iot/radio":{"get":{"tags":["Bluetooth"],"summary":"Get Iot Radio Setting","description":"Get Iot Radio Setting.","operationId":"getIotRadioSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/IotRadioSettingOpenApiVO"}}}}},"x-order":15},"patch":{"tags":["Bluetooth"],"summary":"Modify Iot Radio Setting","description":"Modify Iot Radio Setting.","operationId":"modifyIotRadioSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IotRadioSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/access-control":{"get":{"tags":["Access Control"],"summary":"Get access control setting","description":"Get access control setting of the site with the given omadacId and siteId.","operationId":"getAccessControl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePortalAccessControlOpenApiVO"}}}}},"x-order":1},"patch":{"tags":["Access Control"],"summary":"Modify access control setting","description":"Modify access control setting of the site. When modifying, the full configuration parameters should be passed in","operationId":"modifyAccessControl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalAccessControlOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePortalAccessControlOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/session-limit":{"get":{"tags":["Session Limit"],"summary":"Get session limit","description":"Get session limit.","operationId":"getSessionLimit","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSession Limit Entity"}}}}},"x-order":1},"patch":{"tags":["Session Limit"],"summary":"Modify session limit","description":"Modify session limit.","operationId":"modifySessionLimit","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Session limit entity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/session-limit/rules/{ruleId}":{"delete":{"tags":["Session Limit"],"summary":"Delete session limit rule","description":"Delete session limit rule.","operationId":"deleteSessionLimitRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","description":"Session limit rule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6},"patch":{"tags":["Session Limit"],"summary":"Modify session limit rule","description":"Modify session limit rule.","operationId":"modifySessionLimitRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","description":"Session limit rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionLimitRuleOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/roaming":{"get":{"tags":["Site Configuration"],"summary":"Get site roaming setting","description":"Get site roaming setting","operationId":"getRoamingSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"site_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteRoamingSetting"}}}}},"x-order":11},"patch":{"tags":["Site Configuration"],"summary":"Modify site roaming setting","description":"Modify site roaming setting","operationId":"updateRoamingSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteRoamingSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/remoteAccess/tunnel/{tunnelId}":{"delete":{"tags":["Remote Access"],"summary":"Delete remote access tunnel information","description":"Delete new remote access tunnel information","operationId":"deleteTunnel","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"tunnelId","in":"path","description":"Remote access tunnel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6},"patch":{"tags":["Remote Access"],"summary":"Modify remote access tunnel information","description":"Modify remote access tunnel information","operationId":"editTunnel","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"tunnelId","in":"path","description":"Remote access tunnel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NatTraversalTunnelModifyOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/remoteAccess/tunnel/{tunnelId}/status":{"get":{"tags":["Remote Access"],"summary":"Get remote access tunnel's status","description":"Get remote access tunnel's status","operationId":"getTunnelStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"tunnelId","in":"path","description":"Remote access tunnel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseNatTraversalSingleTunnelStatusVO"}}}}},"x-order":7},"patch":{"tags":["Remote Access"],"summary":"Enable/Disable remote access tunnel","description":"Enable/Disable remote access tunnel","operationId":"modifyTunnel","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"tunnelId","in":"path","description":"Remote access tunnel ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NatTraversalTunnelOpenVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/remote-logging":{"get":{"tags":["Site Configuration"],"summary":"Get site remote logging setting","description":"Get site remote logging setting","operationId":"getRemoteLoggingSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"site_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteRemoteLoggingSetting"}}}}},"x-order":9},"patch":{"tags":["Site Configuration"],"summary":"Modify site remote logging setting","description":"Modify site remote logging setting","operationId":"updateRemoteLoggingSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteRemoteLoggingSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/wifi-calling/{profileId}":{"delete":{"tags":["Profiles"],"summary":"Delete an exist wifi calling profile","description":"Delete an exist wifi calling profile with the given params.","operationId":"deleteWifiCallingProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"wifi calling profile ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":52},"patch":{"tags":["Profiles"],"summary":"Modify a wifi calling profile","description":"Modify a wifi calling profile with the given params.","operationId":"modifyWifiCallingProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Wifi calling profile ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWifiCallingProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":51}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/radius/{radiusProfileId}":{"delete":{"tags":["Profiles"],"summary":"Delete an exist RADIUS profile","description":"Delete an exist RADIUS profile with the given params.","operationId":"deleteRadiusProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"radiusProfileId","in":"path","description":"Radius profile Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14},"patch":{"tags":["Profiles"],"summary":"Modify an exist RADIUS profile","description":"Modify an exist RADIUS profile with the given params.","operationId":"modifyRadiusProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"radiusProfileId","in":"path","description":"Radius profile Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRadiusProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/radius-server/users/{userId}":{"delete":{"tags":["Profiles"],"summary":"Delete an exist Build-in RADIUS profile user","description":"Get Build-in RADIUS profile user list of the site with the given omadacId and siteId. Cloud Based Controller does not support built-in radius function, you cannot call this interface through openAPI on Cloud Based Controller.","operationId":"deleteRadiusUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","description":"Build-in RADIUS profile user Id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18},"patch":{"tags":["Profiles"],"summary":"Modify an exist Build-in RADIUS profile user","description":"Get Build-in RADIUS profile user list of the site with the given omadacId and siteId. Cloud Based Controller does not support built-in radius function, you cannot call this interface through openAPI on Cloud Based Controller.","operationId":"modifyRadiusUser","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"userId","in":"path","description":"Build-in RADIUS profile user Id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRadiusUserOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/ldap/{ldapProfileId}":{"delete":{"tags":["Profiles"],"summary":"Delete an exist LDAP profile","description":"Delete an exist LDAP profile with the given params.","operationId":"deleteLdapProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ldapProfileId","in":"path","description":"LDAP profile ID.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":37},"patch":{"tags":["Profiles"],"summary":"Modify an exist LDAP profile","description":"Modify an exist LDAP profile with the given params.","operationId":"modifyLdapProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ldapProfileId","in":"path","description":"LDAP profile ID.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLdapProfileOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":36}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/groups/{groupType}/{groupId}":{"delete":{"tags":["Profiles"],"summary":"Delete an exist group profile","description":"Delete an exist group profile with the given params.","operationId":"deleteGroupProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"groupType","in":"path","description":"Type of group profile, 0:IP Group; 1:IP Port Group; 2：Mac Group; 3:IPv6 Group; 4:IPv6 Port Group; 5:Country Group; 7:Domain Group.","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"Group profile id.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5},"patch":{"tags":["Profiles"],"summary":"Modify an exist group profile","description":"Modify an exist group profile with the given params.","operationId":"modifyGroupProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"groupType","in":"path","description":"Type of group profile, 0:IP Group; 1:IP Port Group; 2：Mac Group; 3:IPv6 Group; 4:IPv6 Port Group; 5:Country Group; 7:Domain Group.","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"Group profile id.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/portal/{portalId}":{"get":{"tags":["Authentication"],"summary":"Get portal detail","description":"Get portal detail information with the given omadacId, siteId and portalId.","operationId":"getPortalDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"portalId","in":"path","description":"Portal ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePortalDetailResOpenApiVO"}}}}},"x-order":16},"delete":{"tags":["Authentication"],"summary":"Delete portal","description":"Delete portal setting with the given portalId","operationId":"deletePortal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"portalId","in":"path","description":"Portal ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":15},"patch":{"tags":["Authentication"],"summary":"Modify portal","description":"Modify the portal with the portal ID","operationId":"modifyPortal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"portalId","in":"path","description":"Portal ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}":{"get":{"tags":["OLT"],"summary":"Get OLT info","description":"Get OLT info","operationId":"getDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOltDetailVO"}}}}},"x-order":1},"patch":{"tags":["OLT"],"summary":"Modify olt config","description":"Modify olt config","operationId":"modifyOltConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OltConfigModifyDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOltDetailVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/network-security/ips":{"get":{"tags":["IDS/IPS"],"summary":"Get site IDS/IPS config","description":"Get site IDS/IPS config","operationId":"getIpsConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseIpsInfo"}}}}},"x-order":1},"patch":{"tags":["IDS/IPS"],"summary":"Modify site IDS/IPS config","description":"Modify site IDS/IPS config","operationId":"modifyIpsConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IpsInfo"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/network-security/ips/signature/{signId}":{"delete":{"tags":["IDS/IPS"],"summary":"Delete signature","description":"Delete signature","operationId":"deleteSignature","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"signId","in":"path","description":"Unique Signature ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":5},"patch":{"tags":["IDS/IPS"],"summary":"Modify signature","description":"Modify signature","operationId":"modifySignature","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"signId","in":"path","description":"Unique Signature ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IpsSignatureConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/network-mapping":{"patch":{"tags":["Wired Network"],"summary":"Network mapping","description":"map device internet config to another, if already adopted gateway, this api will not work","operationId":"networkMapping","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkMappingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseInternetOpenApiVO"}}}}},"x-order":53}},"/openapi/v1/{omadacId}/sites/{siteId}/multicast-rate-limit":{"get":{"tags":["Site Configuration"],"summary":"Get site multicast rate limit setting","description":"Get site multicast rate limit setting","operationId":"getMulticastRateLimitByOpenApi","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteMulticastRateLimitSetting"}}}}},"x-order":17},"patch":{"tags":["Site Configuration"],"summary":"Modify site multicast rate limit setting","description":"Modify site multicast rate limit setting","operationId":"updateMcastRateLimitSettingByOpenApi","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteMulticastRateLimitSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/mesh":{"get":{"tags":["Site Configuration"],"summary":"Get site mesh setting","description":"Get site mesh setting","operationId":"getMeshSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"site_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteMeshSetting"}}}}},"x-order":5},"patch":{"tags":["Site Configuration"],"summary":"Modify site mesh setting","description":"Modify site mesh setting","operationId":"updateMeshSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"site_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteMeshSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/mac-filters/{filterId}":{"delete":{"tags":["MAC Filtering"],"summary":"Delete MAC filtering","description":"Delete MAC filtering.","operationId":"deleteMacFiltering","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filterId","in":"path","description":"MAC filtering ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7},"patch":{"tags":["MAC Filtering"],"summary":"Modify MAC filtering","description":"Modify MAC filtering.","operationId":"modifyMacFiltering","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filterId","in":"path","description":"MAC filtering ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacFiltering"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/mac-filter":{"get":{"tags":["MAC Filtering"],"summary":"Get MAC filtering general setting","description":"Get MAC filtering general setting.","operationId":"getMacFilteringGeneralSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMacFilteringGeneralSetting"}}}}},"x-order":1},"patch":{"tags":["MAC Filtering"],"summary":"Modify MAC filtering general setting","description":"Modify MAC filtering general setting.","operationId":"modifyMacFilteringGeneralSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacFilteringGeneralSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/mac-auth":{"get":{"tags":["Authentication"],"summary":"Get site MAC-Based Authentication info","description":"Get MAC-Based Authentication setting info of the site with the given omadacId and siteId.","operationId":"getMacAuthSetting_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMacAuthOpenApiVO"}}}}},"x-order":7},"patch":{"tags":["Authentication"],"summary":"Update site MAC-Based Authentication info","description":"Update MAC-Based Authentication setting info of the site with the given parameters.","operationId":"updateMacAuthSetting_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMacAuthOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/lldp":{"get":{"tags":["Site Configuration"],"summary":"Get site lldp setting","description":"Get site lldp setting","operationId":"getLldpSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"site_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteLldpSetting"}}}}},"x-order":7},"patch":{"tags":["Site Configuration"],"summary":"Modify site lldp setting","description":"Modify site lldp setting","operationId":"updateLldpSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"site_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteLldpSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/lan-profiles/{profileId}":{"delete":{"tags":["Wired Network"],"summary":"Delete an existing LAN profile","description":"Delete an existing LAN profile. If returns -33560, use \"Query Agile Series switch that used the profile\" to query these Agile Series switches.","operationId":"deleteLanProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"LAN profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"patch":{"tags":["Wired Network"],"summary":"Modify a LAN profile","description":"Modify a LAN profile.","operationId":"modifyLanProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"lanProfileId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanProfileConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/lan-networks/{networkId}":{"get":{"tags":["Wired Network"],"summary":"Get LAN network","description":"Get LAN network.","operationId":"getLanNetwork","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLanNetworkQueryOpenApiV3VO"}}}}},"x-order":87},"delete":{"tags":["Wired Network"],"summary":"Delete LAN network","description":"Delete LAN network. If returns -33566, use \"Query switches that used the Native Network's profile\" to query these switches.","operationId":"deleteLanNetwork","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8},"patch":{"tags":["Wired Network"],"summary":"Modify LAN network","description":"Modify LAN network. This interface has been deprecated. Please use the following interface instead: Confirm modify lan network","operationId":"modifyLanNetwork","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanNetworkOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/lan-multicasts/{multicastId}":{"delete":{"tags":["Lan Multicast"],"summary":"Delete an existing lan multicast","description":"Delete an existing lan multicast","operationId":"deleteLanMulticast","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"multicastId","in":"path","description":"lanMulticastId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"patch":{"tags":["Lan Multicast"],"summary":"Modify a lan multicast","description":"Modify a lan multicast","operationId":"modifyLanMulticast","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"multicastId","in":"path","description":"lanMulticastId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LanMulticastVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/ip-mac-binds/{bindId}":{"delete":{"tags":["IP-MAC Binding"],"summary":"Delete IP-MAC binding","description":"Delete IP-MAC binding.","operationId":"deleteIpMacBinding","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"bindId","in":"path","description":"IP MAC binding ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6},"patch":{"tags":["IP-MAC Binding"],"summary":"Modify IP-MAC binding","description":"Modify IP-MAC binding.","operationId":"modifyIpMacBinding","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"bindId","in":"path","description":"IP MAC binding ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPMacBinding"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/ip-mac-bind":{"get":{"tags":["IP-MAC Binding"],"summary":"Get IP-MAC binding general setting","description":"Get IP-MAC binding general setting.","operationId":"getIpMacBindingGeneralSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseIPMacBindingGeneralSetting"}}}}},"x-order":1},"patch":{"tags":["IP-MAC Binding"],"summary":"Modify IP-MAC binding general setting","description":"Modify IP-MAC binding general setting.","operationId":"modifyIpMacBindingGeneralSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IPMacBindingGeneralSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/voucher-groups/{groupId}/pattern":{"patch":{"tags":["Voucher"],"summary":"Edit voucher group pattern","description":"Edit vouvhcer group pattern.","operationId":"editVoucherGroupPattern","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"Voucher group ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditVoucherGroupPatternOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/surveys/{surveyId}":{"get":{"tags":["Form Auth Data"],"summary":"Get an authentication survey for given surveyId","description":"Get an authentication survey by the given omadacId, siteId, surveyId.","operationId":"getAuthForm","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"surveyId","in":"path","description":"Auth survey ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseFormAuthOpenApiVO"}}}}},"x-order":3},"delete":{"tags":["Form Auth Data"],"summary":"Delete an existing authentication survey","description":"Delete an existing authentication survey by the given omadacId, siteId, surveyId.","operationId":"deleteAuthForm","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"surveyId","in":"path","description":"Auth survey ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2},"patch":{"tags":["Form Auth Data"],"summary":"Modify an authentication survey for given surveyId","description":"Modify an authentication survey in a site with given omadacId, siteId, surveyId.","operationId":"modifyAuthForm","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"surveyId","in":"path","description":"Survey authentication ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFormAuthOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/setting":{"patch":{"tags":["Voucher"],"summary":"Modify voucher currency","description":"Modify voucher currency of the site.","operationId":"modifyHotspotSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HotspotSiteSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/operators/{id}":{"get":{"tags":["Hotspot Operators"],"summary":"Get hotspot operator detail","description":"Get hotspot operator detail.","operationId":"getHotspotOperatorDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Hotspot Operator ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOperator Response"}}}}},"x-order":2},"delete":{"tags":["Hotspot Operators"],"summary":"Delete an existing hotspot operator","description":"Delete an existing hotspot operator.","operationId":"deleteHotspotOperator","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Hotspot Operator ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":5},"patch":{"tags":["Hotspot Operators"],"summary":"Modify an existing hotspot operator","description":"Modify an existing hotspot operator.","operationId":"modifyHotspotOperator","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Hotspot Operator ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Hotspot Operator"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseString"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/sim/sms/router-command":{"get":{"tags":["SIM"],"summary":"Query SMS router command by mac","description":"Query SMS router command by mac.","operationId":"querySmsRouterCommandByMac","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSmsRouterCommand"}}}}},"x-order":23},"patch":{"tags":["SIM"],"summary":"Modify SMS router command by mac","description":"Modify SMS router command by mac.","operationId":"modifySmsRouterCommandByMac","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmsRouterCommand"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/sim/sms/policy":{"get":{"tags":["SIM"],"summary":"Query SMS policy setting by mac","description":"Query SMS policy setting by mac.","operationId":"querySmsPolicySettingByMac","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSmaPolicySetting"}}}}},"x-order":21},"patch":{"tags":["SIM"],"summary":"Modify SMS policy setting","description":"Modify SMS policy setting.","operationId":"modifySmsPolicySettingByMac","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmaPolicySetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/sim/quota":{"get":{"tags":["SIM"],"summary":"Get SIM data setting by mac","description":"Get SIM data setting by mac.","operationId":"querySimQuotaSettingByMac","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSimQuotaSetting"}}}}},"x-order":27},"patch":{"tags":["SIM"],"summary":"Modify SIM data setting by mac","description":"Modify SIM data setting by mac.","operationId":"modifySimQuotaSettingByMac","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimQuotaSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":29}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/ports/{port}/config":{"patch":{"tags":["Gateway"],"summary":"Modify gateway port config","description":"Modify gateway port config","operationId":"modifyPortConfig_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"port","in":"path","description":"Gateway port number","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayPortSettingConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGatewayPortSettingConfig"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/network/ipv6":{"get":{"tags":["Gateway"],"summary":"Get lan ipv6 config for ippt","description":"Get lan ipv6 config for ippt","operationId":"getIpptLanIpv6","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseIpv6ForIpptOpenApiVO"}}}}},"x-order":34},"patch":{"tags":["Gateway"],"summary":"Modify lan ipv6 config for ippt","description":"Modify lan ipv6 config for ippt","operationId":"modifyIpptLanIpv6","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ipv6ForIpptOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":35}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/multi-ports/config":{"patch":{"tags":["Gateway"],"summary":"Batch modify gateway port config","description":"Batch modify gateway port config","operationId":"batchModifyPortConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway ports config entity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGateway Ports Config Entity"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/internet/wan-mode":{"patch":{"tags":["Wired Network"],"summary":"Modify internet wan mode","description":"modify internet wan mode","operationId":"modifyIpptWanMode","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IpptWanModeOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":84}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/general-config":{"get":{"tags":["Gateway"],"summary":"Get gateway general config","description":"Get gateway general config","operationId":"getGeneralConfig_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGatewayGeneralConfig"}}}}},"x-order":2},"patch":{"tags":["Gateway"],"summary":"Modify gateway general config","description":"Modify gateway general config. This interface has been deprecated. Please use the following interface instead: Modify gateway general config v2.","operationId":"modifyGeneralConfig_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayGeneralConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/config/wlans/ssid/{ssidId}/mac-filter":{"patch":{"tags":["Gateway"],"summary":"Update SSID mac filter config","description":"Update SSID MAC filter config","operationId":"modifySsidMacFilterConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidMacFilterOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":33}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/config/wlans/ssid/{ssidId}/basic-config":{"patch":{"tags":["Gateway"],"summary":"modify SSID basic config","description":"modify SSID basic config","operationId":"modifySsidBasicConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSsidBasicConfigForIpptOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":32}},"/openapi/v1/{omadacId}/sites/{siteId}/firewall":{"get":{"tags":["Firewall"],"summary":"Get firewall setting","description":"Get firewall setting.","operationId":"getFirewallSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseFirewallSetting"}}}}},"x-order":1},"patch":{"tags":["Firewall"],"summary":"Modify firewall setting","description":"Modify firewall setting.","operationId":"modifyFirewallSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FirewallSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/firewall/reset":{"patch":{"tags":["Firewall"],"summary":"Reset firewall setting","description":"Reset firewall setting.","operationId":"resetFirewallSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/dot1x":{"get":{"tags":["Authentication"],"summary":"Get site switch 802.1x setting","description":"Get switch 802.1x setting of the site with the given omadacId and siteId.","operationId":"getSwitchDot1xSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDot1xSwitchResOpenApiVO"}}}}},"x-order":1},"patch":{"tags":["Authentication"],"summary":"Modify site switch 802.1x setting","description":"Modify switch 802.1x setting of the site with the given parameters.","operationId":"updateSwitchDot1xSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dot1xSwitchOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/dot1x/eap":{"get":{"tags":["Authentication"],"summary":"Get site eap 802.1x setting","description":"Get eap 802.1x setting of the site with the given omadacId and siteId.MAB is enabled by default.","operationId":"getEapDot1xSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDot1xBasicInfoEapOpenApiVO"}}}}},"x-order":4},"patch":{"tags":["Authentication"],"summary":"Modify site EAP 802.1x setting","description":"Modify EAP 802.1x setting of the site with the given parameters.MAB is enabled by default.","operationId":"updateEapDot1xSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dot1xEapOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/dhcpSnoops/{dhcpSnoopId}":{"delete":{"tags":["Dhcp Snooping"],"summary":"Delete an existing dhcp snoop","description":"Delete an existing dhcp snoop","operationId":"deleteDhcpSnoop","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"dhcpSnoopId","in":"path","description":"dhcpSnoopId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"patch":{"tags":["Dhcp Snooping"],"summary":"Modify a dhcp snoop","description":"Modify a dhcp snoop","operationId":"modifyDhcpSnoop","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"dhcpSnoopId","in":"path","description":"dhcpSnoopId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DhcpSnoopVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/dhcpSnoops/status":{"get":{"tags":["Dhcp Snooping"],"summary":"Get dhcp snoop status","description":"Get dhcp snoop status","operationId":"getDhcpSnoopStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":5},"patch":{"tags":["Dhcp Snooping"],"summary":"Modify dhcp snoop status","description":"Modify a dhcp snoop status","operationId":"modifyDhcpSnoopStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DhcpSnoopStatusVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/tabs/{tabId}":{"delete":{"tags":["Dashboard"],"summary":"Delete an existing tab","description":"Delete an existing tab.","operationId":"removeTab","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"tabId","in":"path","description":"Tab ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"patch":{"tags":["Dashboard"],"summary":"Modify an existing tab","description":"Modify an existing tab.","operationId":"updateTab","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"tabId","in":"path","description":"Tab ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTabOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/multi-tabs/config":{"patch":{"tags":["Dashboard"],"summary":"Batch set tab config","description":"Batch set tab configurations, add or delete tabs.","operationId":"batchConfigTab","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchEditTabs"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/clients/{clientMac}/ratelimit":{"patch":{"tags":["Client"],"summary":"Set ratelimit setting for given client","description":"Set ratelimit setting for given client.","operationId":"updateClientRateLimitSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client Rate Limit Setting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/clients/{clientMac}/name":{"patch":{"tags":["Client"],"summary":"Set name for given client","description":"Set name for given client.","operationId":"updateClientName","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client Name Setting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/cli/config/cli-type/{cliType}/config-id/{configId}":{"get":{"tags":["CLI"],"summary":"Get the CLI configuration content","description":"Get the CLI configuration content","operationId":"getCliConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"cliType","in":"path","description":"CLI type should be a value as follows: 0: site CLI; 1: device CLI； 2：model CLI. Site template only supports site CLI. Site template only supports site CLI.","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"CLI Config ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCliConfigOpenApiVO"}}}}},"x-order":2},"patch":{"tags":["CLI"],"summary":"Modify the CLI configuration content","description":"Modify the CLI configuration content","operationId":"modifyCliConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"cliType","in":"path","description":"CLI type should be a value as follows: 0: site CLI; 1: device CLI； 2：model CLI. Site template only supports site CLI. Site template only supports site CLI.","required":true,"schema":{"type":"string"}},{"name":"configId","in":"path","description":"CLI Config ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyCliOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/channel-limit":{"get":{"tags":["Site Configuration"],"summary":"Get site channel limit setting","description":"Get site channel limit setting. This interface has been deprecated. Please use the following interface instead: Get ap channel limit config","operationId":"getChannelLimitSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"site_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteChannelLimitSetting"}}}}},"deprecated":true,"x-order":3},"patch":{"tags":["Site Configuration"],"summary":"Modify site channel limit setting","description":"Modify site channel limit setting. This interface has been deprecated. Please use the following interface instead: Modify ap channel limit config","operationId":"updateChannelLimitSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"site_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteChannelLimitSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/beacon-control":{"get":{"tags":["Site Configuration"],"summary":"Get site beacon control setting","description":"Get site beacon control setting","operationId":"getBeaconControlSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"site_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteBeaconControlSetting"}}}}},"x-order":15},"patch":{"tags":["Site Configuration"],"summary":"Modify site beacon control setting","description":"Modify site beacon control setting","operationId":"updateBeaconControlSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteBeaconControlSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/bandwidth-control":{"get":{"tags":["Bandwidth Control"],"summary":"Get bandwidth control","description":"Get bandwidth control.","operationId":"getBandwidthCtrl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseBandwidthControl"}}}}},"x-order":1},"patch":{"tags":["Bandwidth Control"],"summary":"Modify bandwidth control","description":"Modify bandwidth control.","operationId":"modifyBandwidthCtrl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BandwidthControl"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/bandwidth-control/rules/{ruleId}":{"delete":{"tags":["Bandwidth Control"],"summary":"Delete bandwidth control rule","description":"Delete bandwidth control rule.","operationId":"deleteBandwidthCtrlRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","description":"Bandwidth control rule ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6},"patch":{"tags":["Bandwidth Control"],"summary":"Modify bandwidth control rule","description":"Modify bandwidth control rule.","operationId":"modifyBandwidthCtrlRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ruleId","in":"path","description":"Bandwidth control rule ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BandwidthControlRule"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/band-steering":{"get":{"tags":["Site Configuration"],"summary":"Get site band steering setting","description":"Get site band steering setting","operationId":"getBandSteeringSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"site_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteBandSteeringSetting"}}}}},"x-order":13},"patch":{"tags":["Site Configuration"],"summary":"Modify site band steering setting","description":"Modify site band steering setting","operationId":"updateBandSteeringSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteBandSteeringSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/attack-defense":{"get":{"tags":["Attack Defense"],"summary":"Get attack and defense setting","description":"Get attack and defense setting.","operationId":"getAttackDefenseSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAttackDefenseSettingForQuery"}}}}},"x-order":1},"patch":{"tags":["Attack Defense"],"summary":"Modify attack and defense setting","description":"Modify attack and defense setting.","operationId":"modifyAttackDefenseSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttackDefenseSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/attack-defense/reset":{"patch":{"tags":["Attack Defense"],"summary":"Reset attack and defense setting","description":"Reset attack and defense setting.","operationId":"resetAttackDefenseSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/arpDetects/{arpDetectId}":{"delete":{"tags":["Arp Detection"],"summary":"Delete an existing arp detect","description":"Delete an existing arp detect","operationId":"deleteArpDetect","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"arpDetectId","in":"path","description":"arpDetectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"patch":{"tags":["Arp Detection"],"summary":"Modify a arp detect","description":"Modify a arp detect","operationId":"modifyArpDetect","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"arpDetectId","in":"path","description":"arpDetectId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArpDetectVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/arpDetects/status":{"get":{"tags":["Arp Detection"],"summary":"Get arp detect status","description":"Get arp detect status","operationId":"getArpDetectStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":5},"patch":{"tags":["Arp Detection"],"summary":"Modify arp detect status","description":"Modify arp detect status","operationId":"modifyArpDetectStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArpDetectStatusVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/wlan-group":{"patch":{"tags":["Ap"],"summary":"Switch AP's wlan group","description":"Switch AP's wlan group","operationId":"modifyApWlanGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApUpdateWlanGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":45}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/trunk-setting":{"get":{"tags":["Ap"],"summary":"Get AP trunk setting config","description":"Get AP trunk setting (LAG) config","operationId":"getApTrunkSettingConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApTrunkSettingOpenApiVO"}}}}},"x-order":52},"patch":{"tags":["Ap"],"summary":"Modify AP trunk setting config","description":"Modify AP trunk setting (LAG) config.","operationId":"modifyApTrunkSettingConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApTrunkSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":53}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/service-config":{"patch":{"tags":["Ap"],"summary":"Modify AP service config","description":"Modify AP service config","operationId":"modifyApServicesConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApServicesConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":40}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/radio-config":{"get":{"tags":["Ap"],"summary":"Get AP radio config","description":"Get AP radio config","operationId":"getRadiosConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApRadiosConfig"}}}}},"x-order":5},"patch":{"tags":["Ap"],"summary":"Modify AP radio config","description":"Modify AP radio config","operationId":"modifyRadiosConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApRadiosConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/qos":{"get":{"tags":["Ap"],"summary":"Get AP qos config","description":"Get AP qos config","operationId":"getApQoSConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApAdvancedQosOpenApiVO"}}}}},"x-order":48},"patch":{"tags":["Ap"],"summary":"Modify AP qos config","description":"Modify AP qos config","operationId":"modifyApQosConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyApAdvancedQosOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":49}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/ports/{port}":{"patch":{"tags":["Ap"],"summary":"Modify AP port config","description":"Modify AP port config","operationId":"modifyApPort","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"port","in":"path","description":"ap port","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Modify AP LAN Port"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":59}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/ofdma":{"get":{"tags":["Ap"],"summary":"Get AP OFDMA config","description":"Get AP OFDMA config","operationId":"getApOfdmaConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApOfdmaConfigOpenApiVO"}}}}},"x-order":17},"patch":{"tags":["Ap"],"summary":"Modify AP OFDMA config","description":"Modify AP OFDMA config; If the device does not support this feature, it cannot be modified successfully.","operationId":"modifyApOfdmaConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApOfdmaConfigOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/load-balance":{"get":{"tags":["Ap"],"summary":"Get AP load balance config","description":"Get AP load balance config","operationId":"getApLoadBalanceConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApAdvancedLoadBalanceOpenApiVO"}}}}},"x-order":50},"patch":{"tags":["Ap"],"summary":"Modify AP load balance config","description":"Modify AP load balance config","operationId":"modifyApLoadBalanceConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApAdvancedLoadBalanceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":51}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/ipv6-setting":{"get":{"tags":["Ap"],"summary":"Get AP ipv6 setting","description":"Get AP ipv6 setting, the AP should support ipv6","operationId":"getIpv6SettingConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApIPv6Setting"}}}}},"x-order":46},"patch":{"tags":["Ap"],"summary":"Modify AP ipv6 setting","description":"Modify AP ipv6 setting, the AP should support ipv6. Ensure the configuration is correct. Otherwise the device may be unable to connect to the Controller and require a factory reset.","operationId":"modifyIpv6SettingConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApIPv6Setting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":47}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/ip-setting":{"get":{"tags":["Ap"],"summary":"Get AP ip setting","description":"Get AP IP setting","operationId":"getIpSettingConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApIPSetting"}}}}},"x-order":7},"patch":{"tags":["Ap"],"summary":"Modify AP ip setting","description":"Modify AP IP setting","operationId":"modifyIpSettingConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApIPSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/general-config":{"get":{"tags":["Ap"],"summary":"Get AP general config","description":"Get AP general config","operationId":"getGeneralConfig_2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApGeneralConfig"}}}}},"x-order":2},"patch":{"tags":["Ap"],"summary":"Modify AP general config","description":"Modify AP general config","operationId":"modifyGeneralConfig_2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApGeneralConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/bridge":{"get":{"tags":["Ap"],"summary":"Get P2P bridge config","description":"Get P2P bridge config","operationId":"getApBridgeInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApBridgeInfo"}}}}},"x-order":26},"patch":{"tags":["Ap"],"summary":"Modify P2P bridge config","description":"Modify P2P bridge config","operationId":"modifyApBridgeInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApBridgeConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":27}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/antenna-gain":{"get":{"tags":["Ap"],"summary":"Get AP antenna gain config","description":"Get AP antenna gain config.","operationId":"getAntennaGainConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApAnteGainConfig"}}}}},"x-order":35},"patch":{"tags":["Ap"],"summary":"Modify AP antenna gain config","description":"Modify AP antenna gain config.","operationId":"modifyAntennaGainConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApAnteGainConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":36}},"/openapi/v1/{omadacId}/sites/{siteId}/ap-groups/{apGroupId}":{"delete":{"tags":["Wireless Network"],"summary":"Delete an existing AP Group","description":"Delete an existing AP Group","operationId":"deleteApGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apGroupId","in":"path","description":"AP GROUP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4},"patch":{"tags":["Wireless Network"],"summary":"Modify an existing AP Group","description":"Modify an existing AP Group","operationId":"updateApGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apGroupId","in":"path","description":"AP GROUP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApGroupOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/anomaly/setting/modify":{"patch":{"tags":["Incidents"],"summary":"Modify site incident event setting","description":"Modify site incident event setting.","operationId":"modifyAnomalyEventSettingForSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnomalyEventSettingEditOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/anomaly/notification":{"get":{"tags":["Incidents"],"summary":"Get incident notification info","description":"Get incident notification info.","operationId":"getNotificationTemplate_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseNotificationOpenApiVO"}}}}},"x-order":3},"patch":{"tags":["Incidents"],"summary":"Set incident notification info","description":"Set incident notification info.","operationId":"modifyNotification","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetNotificationOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSetNotificationOpenApiVO"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/acls/osg-custom-acls":{"get":{"tags":["ACL"],"summary":"Get osg custom ACL","description":"Get osg custom ACL.","operationId":"getOsgCustomAclList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOGateway Custom ACL Info Entity"}}}}},"x-order":12},"patch":{"tags":["ACL"],"summary":"Update osg custom ACLs","description":"Update osg custom ACLs.","operationId":"updateOsgCustomAcls","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Gateway Custom ACL update entity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/retention":{"get":{"tags":["History Data Retention"],"summary":"Get history data retention configuration","description":"Get data retention configuration.","operationId":"getDataRetention","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseHistory Retention"}}}}},"x-order":1},"patch":{"tags":["History Data Retention"],"summary":"Modify history data retention configuration","description":"Modify history data retention configuration.","operationId":"modifyRetention","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyHistoryRetentionOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/plans/{planId}/upgrade/overview":{"delete":{"tags":["Firmware"],"summary":"Delete firmware upgrade plan","description":"Delete firmware upgrade plan.","operationId":"deleteUpgradePlan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"planId","in":"path","description":"Upgrade Plan ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8},"patch":{"tags":["Firmware"],"summary":"Edit firmware upgrade plan","description":"Edit firmware upgrade plan.","operationId":"editUpgradePlan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"planId","in":"path","description":"Upgrade Plan ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlanUpgradeEditInfo"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/network/sites/{siteId}/cmd/clients/{clientMac}/update-ipSetting":{"patch":{"tags":["Client"],"summary":"Set ip setting for given client","description":"Set ip setting for given client.","operationId":"modifyClientIpSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenApi Client Ip Setting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/log-notification":{"get":{"tags":["Log"],"summary":"Get global log notification","description":"Get global log notification.This interface has been deprecated. Please use the following interface instead: Get global log notification v2","operationId":"getLogSettingForGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLogNotificationSettingOpenApiVO"}}}}},"deprecated":true,"x-order":96},"patch":{"tags":["Log"],"summary":"Modify global log notification","description":"Modify global log notification.This interface has been deprecated. Please use the following interface instead: Modify global log notification v2","operationId":"modifyLogSettingGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogNotificationSettingEditOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":97}},"/openapi/v1/{omadacId}/global/controller/setting/syslog":{"get":{"tags":["Controller Settings"],"summary":"Get remote logging","description":"Get remote logging.","operationId":"getRemoteLogging","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseRemote Log"}}}}},"x-order":5},"patch":{"tags":["Controller Settings"],"summary":"Modify an existing remote logging","description":"Modify an existing remote logging.","operationId":"modifyRemoteLogging","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Remote Log"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/global/controller/setting/network/radius-server":{"get":{"tags":["Controller Settings"],"summary":"Get Built-In RADIUS server setting","description":"Get Built-In RADIUS server setting","operationId":"getRadiusServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseBuilt In RADIUS Server Setting Result"}}}}},"x-order":20},"patch":{"tags":["Controller Settings"],"summary":"Modify Built-In RADIUS server setting","description":"Modify Built-In RADIUS server setting","operationId":"modifyRadiusServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Built In RADIUS Server Config RequestBody"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/global/controller/setting/network/radius-proxy":{"get":{"tags":["Controller Settings"],"summary":"Get RADIUS proxy server setting","description":"Get RADIUS proxy server setting","operationId":"getRadiusProxy","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseRadius Proxy Server Setting Result"}}}}},"x-order":22},"patch":{"tags":["Controller Settings"],"summary":"Modify RADIUS proxy server setting","description":"Modify RADIUS proxy server setting","operationId":"modifyRadiusProxy","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Radius Proxy Server Setting RequestBody"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/global/controller/setting/general":{"get":{"tags":["Controller Settings"],"summary":"Get general settings","description":"Get general settings.","operationId":"getGernalSettings","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGeneral Setting"}}}}},"x-order":1},"patch":{"tags":["Controller Settings"],"summary":"Modify an existing general settings","description":"Modify an existing general settings.","operationId":"modifyGeneralSettings","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/General Setting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/global/controller/setting/exp-improve":{"get":{"tags":["Controller Settings"],"summary":"Get experience improvement","description":"Get experience improvement.","operationId":"getExpImprove","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseExperience Improvement Program"}}}}},"x-order":11},"patch":{"tags":["Controller Settings"],"summary":"Modify an existing experience improvement","description":"Modify an existing experience improvement.","operationId":"modifyExpImprove","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Experience Improvement Program"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/device-mgmt":{"get":{"tags":["Device Management Setting"],"summary":"Get device access management setting","description":"Get device access management setting.","operationId":"getDeviceAccessMgmtSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceAccessManagementSetting"}}}}},"x-order":1},"patch":{"tags":["Device Management Setting"],"summary":"Modify device access management setting","description":"Modify device access management setting.","operationId":"modifyDeviceAccessMgmtSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceAccessManagementSetting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/controller/setting/ui-interface":{"get":{"tags":["Controller Settings"],"summary":"Get UI interface","description":"Get UI interface.","operationId":"getUiInterface","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUI Interface"}}}}},"x-order":3},"patch":{"tags":["Controller Settings"],"summary":"Modify an existing UI interface","description":"Modify an existing UI interface.","operationId":"modifyUiInterface","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UI Interface"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/controller/setting/retention":{"get":{"tags":["Controller Settings"],"summary":"Get retention","description":"Get retention.","operationId":"getRetention","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseHistory Retention"}}}}},"x-order":9},"patch":{"tags":["Controller Settings"],"summary":"Modify an existing retention","description":"Modify an existing retention.","operationId":"modifyRetention_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/History Retention"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/controller/setting/general":{"get":{"tags":["APP Controller Settings"],"summary":"Get general settings","description":"Get general settings.","operationId":"getControllerGeneralSettings","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseController General Setting"}}}}},"x-order":1},"patch":{"tags":["APP Controller Settings"],"summary":"Modify an existing general settings","description":"Modify an existing general settings.","operationId":"modifyControllerGeneralSettings","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Controller General Setting"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/controller/setting/client-recognition":{"get":{"tags":["Controller Settings"],"summary":"Get whether client recognition is enabled","description":"Get whether client recognition is enabled.","operationId":"getClientRecognitionEnable","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientRecognitionEnableOpenApiVO"}}}}},"x-order":24},"patch":{"tags":["Controller Settings"],"summary":"Modify client recognition enable","description":"Enable or disable client recognition. On local controller, enabling client recognition requires enabling cloud access.","operationId":"modfiyClientRecognitionEnable","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientRecognitionEnableOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/controller/setting/active-timeout":{"get":{"tags":["Controller Settings"],"summary":"Get client active timeout","description":"Get client active timeout.","operationId":"getClientActiveTimeout","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClient Active Timeout"}}}}},"x-order":7},"patch":{"tags":["Controller Settings"],"summary":"Modify an existing client active timeout","description":"Modify an existing client active timeout.","operationId":"modifyClientActiveTimeout","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Client Active Timeout"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/controller/health/tip":{"patch":{"tags":["APP Controller Settings"],"summary":"Modify health tip","description":"Modify health tip. No further prompts after the user acknowledges and confirms.","operationId":"modifyHealthTip","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/client-detail-information":{"get":{"tags":["Controller Settings"],"summary":"Get client detail information settings","description":"Get client detail information settings.","operationId":"getClientDetailInformationSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientDetailInformationSettingVO"}}}}},"x-order":26},"patch":{"tags":["Controller Settings"],"summary":"Modify client detail information settings","description":"Modify client detail information settings.On local controller, enabling client recognition requires enabling cloud access.","operationId":"modifyClientDetailInformationSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientDetailInformationSettingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":27}},"/openapi/v1/{omadacId}/autoCheck/{autoCheckId}/upgrade":{"delete":{"tags":["Firmware"],"summary":"Delete autoCheck upgrade plan","description":"Delete autoCheck upgrade plan","operationId":"deleteAutoCheckUpgrade","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"autoCheckId","in":"path","description":"Auto Check ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":19},"patch":{"tags":["Firmware"],"summary":"Edit autoCheck upgrade plan","description":"Edit autoCheck upgrade plan","operationId":"editAutoCheckUpgrade","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"autoCheckId","in":"path","description":"Auto Check ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoCheckUpgradeCreateInfo"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/audit-notification":{"get":{"tags":["Audit Log"],"summary":"Get global audit log notification","description":"Get global audit log notification.","operationId":"getAuditLogSettingForGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAuditLogNotificationSettingOpenApiVO"}}}}},"x-order":3},"patch":{"tags":["Audit Log"],"summary":"Modify global audit log notification","description":"Modify global audit log notification.","operationId":"modifyAuditLogSettingGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditLogNotificationSettingEditOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/msp/{mspId}/users/batch-temporary-users":{"patch":{"tags":["MSP User and Role"],"summary":"Batch modify MSP users.","description":"Batch modify MSP users.","operationId":"modifyMspUserBatch","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchModifyUserOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseBatchModifyCountVO"}}}}},"x-order":7}},"/openapi/v1/msp/{mspId}/ui-interface":{"get":{"tags":["Msp setting"],"summary":"Get msp ui interface","description":"Get msp ui interface. This interface has been deprecated. Please use the following interface instead: Get msp user interface.","operationId":"getUiInterface_1","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMspUiInterfaceOpenApiVO"}}}}},"deprecated":true,"x-order":3},"patch":{"tags":["Msp setting"],"summary":"Modify msp ui interface","description":"Modify msp ui interface. This interface has been deprecated. Please use the following interface instead: Modify msp user interface.","operationId":"modifyUiInterface_1","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MspUiInterfaceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":4}},"/openapi/v1/msp/{mspId}/settings/user-interface":{"get":{"tags":["Msp setting"],"summary":"Get msp user interface","description":"Get msp user interface","operationId":"getMspUserInterface","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMspUserInterfaceOpenApiVO"}}}}},"x-order":5},"patch":{"tags":["Msp setting"],"summary":"Modify msp user interface","description":"Modify msp user interface","operationId":"modifyMspUserInterface","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MspUserInterfaceOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v1/msp/{mspId}/settings/network/radius-server":{"get":{"tags":["Msp setting"],"summary":"Get Msp Built-In RADIUS server setting","description":"Get Msp Built-In RADIUS server setting","operationId":"getMspRadiusServer","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseBuilt In RADIUS Server Setting Result"}}}}},"x-order":13},"patch":{"tags":["Msp setting"],"summary":"Modify Msp Built-In RADIUS server setting","description":"Modify Msp Built-In RADIUS server setting","operationId":"modifyMspRadiusServer","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Built In RADIUS Server Config RequestBody"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":14}},"/openapi/v1/msp/{mspId}/settings/network/radius-proxy":{"get":{"tags":["Msp setting"],"summary":"Get Msp RADIUS proxy server setting","description":"Get Msp RADIUS proxy server setting","operationId":"getMspRadiusProxy","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseRadius Proxy Server Setting Result"}}}}},"x-order":15},"patch":{"tags":["Msp setting"],"summary":"Modify Msp RADIUS proxy server setting","description":"Modify Msp RADIUS proxy server setting","operationId":"modifyRadiusProxy_1","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Radius Proxy Server Setting RequestBody"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":16}},"/openapi/v1/msp/{mspId}/settings/mail-server":{"get":{"tags":["Msp setting"],"summary":"Get MSP mail server","description":"Get MSP mail server","operationId":"getMspMailServer","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSendMailServerOpenApiVO"}}}}},"x-order":12},"patch":{"tags":["Msp setting"],"summary":"Modify MSP mail server","description":"Modify MSP mail server.","operationId":"modifyMspMailServer","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyMailServerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18}},"/openapi/v1/msp/{mspId}/retention":{"get":{"tags":["MSP History Data Retention"],"summary":"Get MSP history data retention configuration","description":"Get MSP history data retention configuration.","operationId":"getMspDataRetention","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseHistory Retention"}}}}},"x-order":3},"patch":{"tags":["MSP History Data Retention"],"summary":"Modify MSP history data retention configuration","description":"Modify MSP history data retention configuration.","operationId":"modifyMspRetention","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyHistoryRetentionOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/msp/{mspId}/remote-logging":{"get":{"tags":["Msp setting"],"summary":"Get msp remote logging setting","description":"Get msp remote logging setting","operationId":"getRemoteLoggingSetting_1","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMspRemoteLoggingSettingOpenApiVO"}}}}},"x-order":7},"patch":{"tags":["Msp setting"],"summary":"Modify msp remote logging setting","description":"Modify msp remote logging setting","operationId":"modifyRemoteLoggingSetting","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyMspRemoteLoggingSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/msp/{mspId}/log-notification":{"get":{"tags":["Msp Log"],"summary":"Get MSP log notification","description":"Get msp log notification.This interface has been deprecated.Please use the following interface instead: Get MSP log notification v2.","operationId":"getLogSettingForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLogNotificationSettingOpenApiVO"}}}}},"deprecated":true,"x-order":98},"patch":{"tags":["Msp Log"],"summary":"Modify MSP log notification","description":"Modify MSP log notification.This interface has been deprecated.Please use the following interface instead: Modify MSP log notification v2.","operationId":"modifyLogSettingMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogNotificationSettingEditOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":99}},"/openapi/v1/msp/{mspId}/log-notification-setting":{"get":{"tags":["Msp Log"],"summary":"Get MSP log notification v2","description":"Get msp log notification.","operationId":"getLogSettingForMspV2","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLogNotificationSettingOpenApiVO"}}}}},"x-order":4},"patch":{"tags":["Msp Log"],"summary":"Modify MSP log notification v2","description":"Modify MSP log notification.","operationId":"modifyLogSettingMspV2","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogNotificationSettingEditOpenApiV2VO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/msp/{mspId}/general-setting":{"get":{"tags":["Msp setting"],"summary":"Get msp general setting","description":"Get msp general setting","operationId":"getGeneralSetting","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMspGeneralSettingOpenApiVO"}}}}},"x-order":1},"patch":{"tags":["Msp setting"],"summary":"Modify msp general setting","description":"Modify msp general setting","operationId":"modifyGeneralSetting","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyMspGeneralSettingOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/msp/{mspId}/customers/{customerId}":{"get":{"tags":["Customer"],"summary":"Get customer info","description":"Get customer info","operationId":"getCustomerDetail","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCustomerInfoOpenApiVO"}}}}},"x-order":2},"delete":{"tags":["Customer"],"summary":"Delete an existing customer","description":"Delete an existing customer(This interface only supports the authorization code mode, not the client mode. Please call this interface in authorization code mode.)","operationId":"deleteCustomer","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5},"patch":{"tags":["Customer"],"summary":"Modify an existing customer","description":"Modify an existing customer","operationId":"modifyCustomer","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/olts/{deviceMac}":{"get":{"tags":["OLT"],"summary":"Get OLT info(MSP mode)","description":"Get OLT info(MSP mode)","operationId":"getOltDetailForMsp","parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"mspId","in":"path","description":"mspId","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"customerId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOltDetailVO"}}}}},"x-order":3},"patch":{"tags":["OLT"],"summary":"Modify olt config(MSP mode)","description":"Modify olt config(MSP mode)","operationId":"modifyOltConfigForMsp","parameters":[{"name":"mspId","in":"path","description":"mspId","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"customerId","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OltConfigModifyDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOltDetailVO"}}}}},"x-order":4}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/gateways/{gatewayMac}":{"patch":{"tags":["Gateway"],"summary":"Modify gateway config for msp","description":"Modify gateway config for msp","operationId":"modifyOsgConfigForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayOsgMspConfig"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/msp/{mspId}/controller/health/tip":{"patch":{"tags":["APP Controller Settings"],"summary":"Modify health tip in Msp View","description":"Modify health tip in Msp View. No further prompts after the user acknowledges and confirms.","operationId":"modifyMspHealthTip","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/msp/{mspId}/client-detail-information":{"get":{"tags":["History Data Retention"],"summary":"Get MSP client detail information setting.","description":"Get MSP client detail information setting.","operationId":"getMspClientDetailInfoSetting","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":3},"patch":{"tags":["History Data Retention"],"summary":"Modify MSP client detail information setting.","description":"Modify MSP client detail information setting.","operationId":"modifyMspClientDetailInfoSetting","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MspClientDetailInfoSettingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":4}},"/openapi/v1/msp/{mspId}/audit-notification":{"get":{"tags":["Msp Log"],"summary":"Get MSP audit log notification","description":"Get msp audit log notification.","operationId":"getAuditLogSettingForMsp_2","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAuditLogNotificationSettingOpenApiVO"}}}}},"x-order":2},"patch":{"tags":["Msp Log"],"summary":"Modify MSP audit log notification","description":"Modify MSP audit log notification.","operationId":"modifyAuditLogSettingMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditLogNotificationSettingEditOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/internal/api/v2/omadacs/{customizeOmadacId}/detailInfo":{"get":{"tags":["abutment-omada-cloud-controller"],"operationId":"findOmadacById","parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"customizeOmadacId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOmadacDetailResponseDTO"}}}}}},"patch":{"tags":["abutment-omada-cloud-controller"],"operationId":"modifyOmadac","parameters":[{"name":"customizeOmadacId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyOmadacByOmadaCloudRequestDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseObject"}}}}}}},"/openapi/v3/{omadacId}/sitetemplates/{siteTemplateId}/lan-networks":{"get":{"tags":["Wired Network (Template)"],"summary":"Get LAN network template list","description":"Get LAN network template list.(Pagination)","operationId":"getLanNetworkTemplateListV3","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLanNetworkOpenApiV3GridVOLanNetworkTemplateQueryOpenApiV3VO"}}}}},"x-order":56}},"/openapi/v3/{omadacId}/sites/{siteId}/vpn/{vpnId}/users":{"get":{"tags":["VPN"],"summary":"Get user list by VPN server ID","description":"Get user list by VPN server ID.","operationId":"getVpnServerUserListV3","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}},{"name":"filters.clientMode","in":"query","description":"Filter query parameters, support field clientMode. 0: Network Extension Mode; 1: Client.","required":false,"schema":{"type":"string"}},{"name":"sorts.maxConnections","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnUserServerGridVOVpnUserInfoVO"}}}}},"x-order":18}},"/openapi/v3/{omadacId}/sites/{siteId}/topology":{"get":{"tags":["Topology"],"summary":"Get site topology, version 3","description":"Get topology of the site with the given omadacId, siteId and deviceStatus.","operationId":"getV3Topology","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filters.deviceStatus","in":"query","description":"Filter query parameters, support field device status. 0: connected; 1: disconnected; 0,1: both.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTopologyV3OpenApiVO"}}}}},"x-order":8}},"/openapi/v3/{omadacId}/sites/{siteId}/topology/{networkId}/vlan/{vlan}/devices":{"get":{"tags":["Topology"],"summary":"Filter Devices of Vlan in Topology","description":"Filter devices of vlan in topology with given omadacId and siteId by networkId and vlan.","operationId":"getFilterDevicesOfVlan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"networkId","required":true,"schema":{"type":"string"}},{"name":"vlan","in":"path","description":"vlan","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTopologyFilterDevicesVO"}}}}},"x-order":19}},"/openapi/v3/{omadacId}/sites/{siteId}/topology/ssids/{ssidId}/devices":{"get":{"tags":["Topology"],"summary":"Filter Devices of Ssid in Topology","description":"Filter devices of ssid in topology with given omadacId and siteId by ssidId.","operationId":"getFilterDevicesOfSsid","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTopologyFilterDevicesVO"}}}}},"x-order":18}},"/openapi/v3/{omadacId}/sites/{siteId}/lan-networks":{"get":{"tags":["Wired Network"],"summary":"Get LAN network list V3","description":"Get LAN network list V3.(Pagination)","operationId":"getLanNetworkListV3","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLanNetworkOpenApiV3GridVOLanNetworkQueryOpenApiV3VO"}}}}},"x-order":86}},"/openapi/v2/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/wlans":{"get":{"tags":["Wireless Network (Template)"],"summary":"Get WLAN Group template list paging query","description":"Get WLAN Group template list paging query, Legacy note: “WLAN Group” is the legacy name of “AP Group”. This endpoint will be deprecated in future releases. Please use Get AP Group template list.","operationId":"getGridWlanGroupTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWlanGroupGridOpenApiVO"}}}}},"deprecated":true,"x-order":56}},"/openapi/v2/{omadacId}/sitetemplates/{siteTemplateId}/lan-networks/isolate/interfaces":{"get":{"tags":["Wired Network (Template)"],"summary":"Get interface Grid","description":"Get interface Grid.","operationId":"getAllInterfacesForBatchIsolate","parameters":[{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field ","required":false,"schema":{"type":"string"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"isolation_filter","in":"query","description":"non-isolation set 0; isolation set 1; don't filter isolation vlan set 2.","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListInterfaceForBatchIsolateOpenApiVO"}}}}},"x-order":36}},"/openapi/v2/{omadacId}/sites/{siteId}/wlanSsid":{"get":{"tags":["app"],"summary":"Query SSID by AP Group","description":"Query SSID by AP Group","operationId":"listWlanAndSsid","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceType","in":"query","description":"Device Type. 0: ap, 1: wireless router","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListWlanBriefAppVO"}}}}},"x-order":22}},"/openapi/v2/{omadacId}/sites/{siteId}/wireless-network/wlans":{"get":{"tags":["Wireless Network"],"summary":"Get WLAN Group list paging query","description":"Get WLAN Group list paging query, Legacy note: “WLAN Group” is the legacy name of “AP Group”. This endpoint will be deprecated in future releases. Please use Get AP Group list.","operationId":"getGridWlanGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWlanGroupGridOpenApiVO"}}}}},"deprecated":true,"x-order":70}},"/openapi/v2/{omadacId}/sites/{siteId}/wireless-network/wlans/{wlanId}":{"get":{"tags":["Wireless Network"],"summary":"Get WLAN Group by wlan id","description":"Get WLAN Group by wlan id, Legacy note: “WLAN Group” is the legacy name of “AP Group”. This endpoint will be deprecated in future releases. Please use Get an existing AP Group info.","operationId":"getWlanGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWlanGroupOpenApiVO"}}}}},"deprecated":true,"x-order":71}},"/openapi/v2/{omadacId}/sites/{siteId}/vpn/usergroups/{userGroupId}/users":{"get":{"tags":["SSL VPN"],"summary":"Get SSL VPN user list in group V2.","description":"Get SSL VPN user list in group V2.","operationId":"getGridSslVpnUserInGroupV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"userGroupId","in":"path","description":"User Group Id","required":true,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field user name.","required":false,"schema":{"type":"string"}},{"name":"sorts.username","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effectuser name.","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSslVpnUserGridVOVpnUserInfoVO"}}}}},"x-order":35}},"/openapi/v2/{omadacId}/sites/{siteId}/topology/{networkId}/vlan/{vlan}/devices":{"get":{"tags":["Topology"],"summary":"Search Devices of Vlan in Topology","description":"Search for devices of vlan in topology with given omadacId and siteId by networkId and vlan.","operationId":"getDevicesOfVlan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"networkId","required":true,"schema":{"type":"string"}},{"name":"vlan","in":"path","description":"vlan","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListString"}}}}},"x-order":17}},"/openapi/v2/{omadacId}/sites/{siteId}/topology/ssids/{ssidId}/devices":{"get":{"tags":["Topology"],"summary":"Search Devices of Ssid in Topology","description":"Search for devices of ssid in topology with given omadacId and siteId by ssidId.","operationId":"getDevicesOfSsid","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListString"}}}}},"x-order":16}},"/openapi/v2/{omadacId}/sites/{siteId}/topology/search-device-client":{"get":{"tags":["Topology"],"summary":"Search Device or Client in Topology","description":"Search for devices or clients in topology with given omadacId and siteId by mac and name.","operationId":"getGridDeviceClient","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field ","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOTopologyDeviceClient"}}}}},"x-order":15}},"/openapi/v2/{omadacId}/sites/{siteId}/topology/isolated-and-pre-config":{"get":{"tags":["Topology"],"summary":"Get isolated and preconfigured devices","description":"Get devices whose status is isolated or pre config with the given omadacId and siteId.","operationId":"getIsolatedAndPreConfigDevices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTopologyIsolatedAndPreConfigDevice"}}}}},"x-order":9}},"/openapi/v2/{omadacId}/sites/{siteId}/topology/discovery/status":{"get":{"tags":["Topology"],"summary":"Get topology discovery status","description":"Get the status of whether the topology is calculating or not with the given omadacId and siteId.","operationId":"getTopologyDiscoveryStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":6}},"/openapi/v2/{omadacId}/sites/{siteId}/topology/devices/{mac}/clients":{"get":{"tags":["Topology"],"summary":"Get the clients","description":"Get the clients in topology of the device with the given omadacId , siteId and device Mac.","operationId":"getTopologyClients","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"mac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListTopologyClient"}}}}},"x-order":2}},"/openapi/v2/{omadacId}/sites/{siteId}/topology/devices/{mac}/all-clients":{"get":{"tags":["Topology"],"summary":"Get the clients by device","description":"Get the clients in topology of the device with the given omadacId , siteId and device Mac.","operationId":"getTopologyClientsByDevice","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"mac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"filters.type","in":"query","description":"Filter query parameters, support field filter client group type. 0: except ipc; 1: just ipc; 0,1: all client.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListTopologyClientNode"}}}}},"x-order":11}},"/openapi/v2/{omadacId}/sites/{siteId}/topology/available-vlans":{"get":{"tags":["Topology"],"summary":"Get available vlans","description":"Get available wired network with the given omadacId and siteId.","operationId":"getAvailableVlans","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTopology Available Network And SSID"}}}}},"x-order":20}},"/openapi/v2/{omadacId}/sites/{siteId}/topology/available-ssids":{"get":{"tags":["Topology"],"summary":"Get available ssids","description":"Get available wireless network with the given omadacId and siteId.","operationId":"getGridAvailableSsids","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field ","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTopology Available Network And SSID"}}}}},"x-order":21}},"/openapi/v2/{omadacId}/sites/{siteId}/topology/available-network":{"get":{"tags":["Topology"],"summary":"Get available network","description":"Get available wired and wireless network with the given omadacId and siteId.","operationId":"getAvailableNetworks","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTopology Available Network And SSID"}}}}},"x-order":10}},"/openapi/v2/{omadacId}/sites/{siteId}/lockToAp/aps":{"get":{"tags":["Ap"],"summary":"Get lock to AP brief APs","description":"Get lock to AP brief APs","operationId":"getAllApBriefInfosBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListAp Brief Info"}}}}},"x-order":67}},"/openapi/v2/{omadacId}/sites/{siteId}/lan-networks/isolate/interfaces":{"get":{"tags":["Wired Network"],"summary":"Get interface List","description":"Get interface List.","operationId":"getAllInterfacesForBatchIsolate_1","parameters":[{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field ","required":false,"schema":{"type":"string"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"isolation_filter","in":"query","description":"non-isolation set 0; isolation set 1; don't filter isolation vlan set 2.","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListInterfaceForBatchIsolateOpenApiVO"}}}}},"x-order":82}},"/openapi/v2/{omadacId}/sites/{siteId}/lan-networks/interface":{"get":{"tags":["Wired Network"],"summary":"Get all \"single\"/\"multi\" interface lan network V2","description":"Get all \"single\"/\"multi\" interface lan network V2","operationId":"getInterfaceLanNetworkV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Interface vlan type. When \"type\" is 0, return \"single\" interface lan network, else return \"single\"/\"multi\" interface lan network","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseDataVOLanNetworkQueryOpenApiV2VO"}}}}},"x-order":13}},"/openapi/v2/{omadacId}/sites/{siteId}/gateway":{"get":{"tags":["app"],"summary":"Query gateway by site with SSID activated","description":"Query gateway by site with SSID activated","operationId":"getGatewayDetailBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSsidDeviceOpenApiVO"}}}}},"x-order":23}},"/openapi/v2/{omadacId}/sites/{siteId}/devices/{deviceMac}/device-link-topology":{"get":{"tags":["Topology"],"summary":"Get Device Link Topology","description":"Get link topology of the device with the given omadacId, siteId and deviceMac.","operationId":"getDeviceLinkTopology","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListTopologyV3OpenApiNodeVO"}}}}},"x-order":13}},"/openapi/v2/{omadacId}/sites/{siteId}/dashboard/most-active-eaps":{"get":{"tags":["Dashboard"],"summary":"Get the most active eap list","description":"Obtain the top 5 APs with the highest device traffic within the time range (in Bytes)..","operationId":"getActiveApsV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceNum","in":"query","description":"The number of most active APs acquired.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGetActiveDeviceV2OpenApiVO"}}}}},"x-order":29}},"/openapi/v2/{omadacId}/sites/{siteId}/clients/{clientMac}/health/detail":{"get":{"tags":["Health"],"summary":"Get client health detail (V2)","description":"Get client health detail (V2)","operationId":"getClientHealthDetailV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientHealthDetailV2VO"}}}}},"x-order":21}},"/openapi/v2/{omadacId}/sites/{siteId}/aps/{apMac}/rf-scan-result":{"get":{"tags":["Ap"],"summary":"Get rf scan result v2","description":"Get rf scan result v2","operationId":"getRFScanResultV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApRFScanResult"}}}}},"x-order":22}},"/openapi/v2/msp/{mspId}/customers/{customerId}/sites/{siteId}/devices/{deviceMac}/device-link-topology":{"get":{"tags":["Topology"],"summary":"Get Msp Device Link Topology","description":"Get msp link topology of the device with the given mspId, siteId and deviceMac.","operationId":"getMspDeviceLinkTopology","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListTopologyV3OpenApiNodeVO"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/webhook/settings/dispatch-logs":{"get":{"tags":["Webhook Setting"],"summary":"Get global webhook dispatch log list","description":"Get global webhook dispatch log list.The template of webhook message is display at Open API Access Guide#5.3.1 Webhook Message Template.","operationId":"getWebhookLogsForGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.webhookId","in":"query","description":"Filter query parameters, support field d66aed17ea7238154ba610710d9a2890","required":true,"schema":{"type":"string"}},{"name":"filters.timeStart","in":"query","description":"Filter query parameters, support field 1679297710438","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.timeEnd","in":"query","description":"Filter query parameters, support field 1681889710438","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOpenApiWebhookDispatchLogVO"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/users/local":{"get":{"tags":["User and Role"],"summary":"Get all local users exclude owner","description":"Get all local users exclude owner","operationId":"getAllLocalUsersExcludeRoot","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGetUserListResponseVO"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/users/cloud":{"get":{"tags":["User and Role"],"summary":"Get all cloud users exclude owner","description":"Get all cloud users exclude owner","operationId":"getAllCloudUsersExcludeRoot","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGetUserListResponseVO"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/upgrade/plan/models":{"get":{"tags":["Firmware"],"summary":"Get the list of models","description":"Get the list of models on the Controller upgrade plan page.","operationId":"getGridPlanUpgradeModelList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.modelTypeInfo","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field upgrade","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOPlanUpgradeModelList"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/upgrade/overview/logs":{"get":{"tags":["Firmware"],"summary":"Get firmware upgrade logs","description":"Paging to get firmware upgrade logs.","operationId":"getGridUpgradeLogs","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.upgradeTime","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.modelTypeInfo","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOUpgradeLogOpenApiInfo"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/upgrade/overview/firmwares":{"get":{"tags":["Firmware"],"summary":"Get firmware pool list","description":"Paging to get firmware pool list","operationId":"getGridFirmwarePoolList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"channel","in":"query","description":"Channel should be a value as follows: 0: stable; 1: Release Candidate(RC); 2: Beta.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.modelTypeInfo","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.releaseTime","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseModelFirmwarePoolGridInfoModelLatestFwInfo"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/upgrade/overview/critical":{"get":{"tags":["Firmware"],"summary":"Get the number of critical models","description":"You can get the number of critical models.","operationId":"getcriticalModelNum","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCriticalModelNum"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/upgrade/firmwares":{"get":{"tags":["Firmware"],"summary":"Get the uploaded firmware list","description":"Paging to get the uploaded firmware list","operationId":"getGridFirmwareList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.modelTypeInfo","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.uploadTime","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field upgrade","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOFirmwareInfo"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/upgrade/firmwares/{firmwareId}/target-sites":{"get":{"tags":["Firmware"],"summary":"Get all sites of target firmware","description":"Get all sites of target firmware","operationId":"getTargetFirmwareAllSites","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"firmwareId","in":"path","description":"Firmware ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAllTargetSites"}}}}},"x-order":29}},"/openapi/v1/{omadacId}/unplaced-site-position":{"get":{"tags":["Site"],"summary":"Obtain the geographic location information of unplaced Sites","description":"Obtain the geographic location information of unplaced Sites.","operationId":"getUnplacedSitePositions","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUnplaced SitesUnplaced Site"}}}}},"x-order":26}},"/openapi/v1/{omadacId}/system/setting/controller-status":{"get":{"tags":["System Settings"],"summary":"Get controller status","description":"Get controller status.","operationId":"getControllerStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseController Status"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sso/external-users":{"get":{"tags":["SSO"],"summary":"Get external user list","description":"Get external user list.","operationId":"getExternalUserList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.userName","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field userName","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOExternalUserDetailOpenApiVO"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}":{"get":{"tags":["Wireless Network (Template)"],"summary":"Get SSID template detail info","description":"Get SSID template detail info, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Get SSID template detail info.","operationId":"getSsidDetailTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSsidDetailOpenApiVO"}}}}},"deprecated":true,"x-order":7},"delete":{"tags":["Wireless Network (Template)"],"summary":"Delete an existing SSID template","description":"Delete an existing SSID template, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Delete an existing SSID template.","operationId":"deleteSsidTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":16}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/ssids/{ssidId}":{"get":{"tags":["Wireless Network (Template)"],"summary":"Get SSID template detail info","description":"Get SSID template detail info","operationId":"getSsidDetailTemplateV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSsidDetailOpenApiVO"}}}}},"x-order":48},"delete":{"tags":["Wireless Network (Template)"],"summary":"Delete an existing SSID template","description":"Delete an existing SSID template","operationId":"deleteSsidTemplateV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":50}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/ssids/duplicate-name/{ssidId}":{"get":{"tags":["app"],"summary":"Check template SSID device type compatibility","description":"Check whether same-name template SSIDs contain a device type not covered by the selected SSID. Returns 0 when no warning is required, 1 when the target SSID does not include Gateway, or 2 when the target SSID does not include AP.","operationId":"queryTemplateSsidDuplicateNameDeviceType","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}},{"name":"ssidName","in":"query","description":"SSID name used to find same-name template SSIDs.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSsidDeviceTypeConflictOpenApiVO"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wireless-network/cmd/countWlans":{"get":{"tags":["Wireless Network (Template)"],"summary":"Check if the number of WLAN Groups is out of limit","description":"Check if the number of WLAN Groups is out of limit. The value of \"wlanGroupNum\" indicates number of WLAN Group and the value of \"exceeded\" indicates whether the number of WLANs exceeds the limit, Legacy note: “WLAN Group” is the legacy name of “AP Group”. This endpoint will be deprecated in future releases.Please use Check if the number of AP Groups template is out of limit.","operationId":"countWlansTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWlanGroupStatusOpenApiVO"}}}}},"deprecated":true,"x-order":55}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wan-max-speed":{"get":{"tags":["Wired Network (Template)"],"summary":"Get wan ports max speed","description":"Get max speed for certain wan ports for template,if ports doesn't exist, this interface will return default result","operationId":"getWanPortsMaxSpeed","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"wanId","in":"query","description":"WanId, can pass multiple wan ports using comma separator like '{portId1},{portId2}'.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWanMaxSpeedOpenApiVO"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/wan-lan-status":{"get":{"tags":["Wired Network (Template)"],"summary":"Check template WAN-LAN status","description":"Get gateway template basic info and template WAN/LAN list. Use this API to operate \"LanNetwork\".","operationId":"checkWanLanStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCheckWanLanStatusOpenApiVO"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/voip/call-forwarding/grid":{"get":{"tags":["VoIP (Template)"],"summary":"Get siteTemplate's Call Forwarding list","description":"Get siteTemplate's Call Forwarding list.","operationId":"getCallForwardingRulesGridTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCallForwardingRulesGrid"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/url-filters/gateway":{"get":{"tags":["URL Filtering (Template)"],"summary":"Get URL filtering template rule list for gateway","description":"Get URL filtering template rule list for gateway.","operationId":"getGridGatewayRuleTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUrlFilteringOpenApiGridVOQueryUrlFilteringOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/url-filters/eap":{"get":{"tags":["URL Filtering (Template)"],"summary":"Get URL filtering template rule list for eap","description":"Get URL filtering template rule list for eap.","operationId":"getGridEapRuleTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUrlFilteringOpenApiGridVOQueryUrlFilteringOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}":{"get":{"tags":["Switch (Template)"],"summary":"Get switch template info","description":"Get switch template info.","operationId":"getSwitchTemplateInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSwitchTemplateOverviewInfo"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/rpvst-instances":{"get":{"tags":["Switch (Template)"],"summary":"Get Rpvst Instances Template","description":"Get Rpvst Instances Template.","operationId":"getRpvstInstancesTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":30}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/port-lag-networks":{"get":{"tags":["Switch (Template)"],"summary":"Get the networks used on switch template's ports and LAGs","description":"Get the networks used on switch template's ports and LAGs.","operationId":"getGridPortAndLagNetworks","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GridVOOswNetworkBriefInfoOpenApiVO"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/port-lag-networks/{networkId}/vlan/{vlan}":{"get":{"tags":["Switch (Template)"],"summary":"Get the switch template's ports and LAGs that the network affects","description":"Get the switch template's ports and LAGs that the network affects.","operationId":"getPortAndLagNetwork","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Switch network ID.","required":true,"schema":{"type":"string"}},{"name":"vlan","in":"path","description":"VLAN.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OswPortAndLagNetworkVO"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/interfaces":{"get":{"tags":["Switch (Template)"],"summary":"List Switch Interfaces Template","description":"List Switch Interfaces Template, include VLAN Interface and Loopback Interface.","operationId":"listSwitchInterfacesTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswInterfaceGridOswInterfaceOpenApi"}}}}},"x-order":34}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switchtemplates/{deviceTemplateId}/exist-network":{"get":{"tags":["Switch (Template)"],"summary":"Get the networks existing on the switch template","description":"Get the networks existing on the switch template.","operationId":"getSwitchTemplateExistNetworks","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLanNetworkOpenApiV2GridVOLanNetworkSplitOpenApiVO"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switch-qos/qos-rule/dscp-mapping":{"get":{"tags":["Switch QoS"],"summary":"Get switch QoS dscp mapping in site template.","description":"Get switch QoS dscp mapping in site template.","operationId":"getDscpMappingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDscpMappingVO"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switch-oui-rules/whether-auto-add-vlan":{"get":{"tags":["OUI Based VLAN (Template)"],"summary":"Get whether site template open oui rule auto add vlan.","description":"Get whether site template open oui rule auto add vlan.","operationId":"getWhetherSiteOpenAutoAddVlanTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOuiBasedVlanSiteAutoAddVlanVO"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switch-oui-rules/valid-vlans":{"get":{"tags":["Wired Network (Template)"],"summary":"Get valid site template vlanList for switch oui based vlan","description":"Get valid site template vlanList for switch oui based vlan","operationId":"getAllValidVlansInSiteForSwitchOuiBasedVlan","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GridVOLanNetworkVlansOpenApiVO"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switch-oui-rules/switches":{"get":{"tags":["OUI Based VLAN (Template)"],"summary":"Get all oui based vlan switch template list.","description":"Get all oui based vlan switch template list.","operationId":"getOuiBasedVlanSwitchListTemplate","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOuiBasedVlanGridVOSwitchDataVO"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switch-oui-rules/switches/support-auto-add-vlan":{"get":{"tags":["OUI Based VLAN (Template)"],"summary":"Get switch template list of supporting oui based vlan with ports(lags) info of vlans in oui based rules but not included in port(lag) vlan.","description":"Get switch template list of supporting oui based vlan with ports(lags) info of vlans in oui based rules but not included in port(lag) vlan.","operationId":"getAllSupportAutoAddVlanSwitchListTemplate","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOuiBasedVlanDeviceInfoVO"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/switch-oui-rules/auto-add-vlan-all-support":{"get":{"tags":["OUI Based VLAN (Template)"],"summary":"Get whether all switches template support oui rule auto add vlan.","description":"Get whether all switches template support oui rule auto add vlan.","operationId":"getWhetherAllSwitchSupportAutoAddVlanTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOuiBasedVlanDeviceAutoAddVlanVO"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/specification":{"get":{"tags":["Site Template"],"summary":"Get siteTemplate functional specifications","description":"Get siteTemplate functional specifications(Return value only after adding a low-specification device).","operationId":"getSiteTemplateSpecification","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSpecificationOpenApiVO"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/sim/quota/{simCard}":{"get":{"tags":["SIM (Template)"],"summary":"Get one of Dual-SIM card's SIM data setting template","description":"Get SIM data setting template.","operationId":"querySimCardQuotaSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"simCard","in":"path","description":"SIM card. 1: SIM1; 2: SIM2.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSimQuotaSetting"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/wireless/feature":{"get":{"tags":["Site Template"],"summary":"get site template WirelessFeature","description":"get site template WirelessFeature.","operationId":"getSiteTemplateWirelessFeature","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSite Template WirelessFeature"}}}}},"x-order":28}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/voip/grid/provider-profiles":{"get":{"tags":["VoIP (Template)"],"summary":"Get the grid of provider profile list template","description":"Get the grid of provider profile list template.","operationId":"getGridProviderProfileList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOProviderProfileEntity"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/virtual-wans/delete-check":{"get":{"tags":["Wired Network (Template)"],"summary":"Check Virtual Wan Used","description":"check configurations who have used current virtualWan","operationId":"checkVirtualWanUsed","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"virtualWanId","in":"query","description":"Virtual WAN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVirtualWanIdUsedOpenApiVO"}}}}},"x-order":33}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/service":{"get":{"tags":["Site Template"],"summary":"get site template service","description":"get site template service","operationId":"getSiteTemplateService","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteServiceOpenApiVO"}}}}},"x-order":27}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/service/dns-cache-data/refresh":{"get":{"tags":["DNS (Template)"],"summary":"Refresh dns cache list","description":"Send refresh command to devices and refresh dns cache list.","operationId":"refreshDnsCacheListTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"vo","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DnsCacheQueryOpenApiVO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVODnsCacheInfoVO"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/service/ddns/update-url":{"get":{"tags":["DNS (Template)"],"summary":"Get DDNS update url","description":"Get global DDNS update url of the site with the given omadacId and siteId.","operationId":"getGlobalDdnsUpdateUrlTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseString"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/ntp":{"get":{"tags":["Site"],"summary":"Get template ntp server status","description":"Get template ntp server status.","operationId":"getNtpServerStatusTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/mails":{"get":{"tags":["SIM (Template)"],"summary":"get mail server","description":"get mail server.","operationId":"getMailServerTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMailServerOpenApiVO"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/general/config":{"get":{"tags":["Site Template"],"summary":"get site template general config","description":"get site template general config","operationId":"getSiteTemplateGeneralConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteServiceGeneralConfigOpenApiVO"}}}}},"x-order":26}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/exist":{"get":{"tags":["Site Template"],"summary":"Query site template setting exist or not","description":"Query site template setting exist or not","operationId":"getExistSiteTemplateSettingByOpenApi","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseExistSiteSettingOpenApiVO"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/configuration":{"get":{"tags":["Site Template"],"summary":"get site template settings","description":"get site template settings.","operationId":"getSiteTemplateConfiguration","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSite Template Settings"}}}}},"x-order":29}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/available-virtual-wans":{"get":{"tags":["Wired Network (Template)"],"summary":"Query available virtual WAN list for template","description":"Query available virtual WAN list for template.","operationId":"getAvailableVirtualWanTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVirtualWanAvailablesOpenApiVO"}}}}},"x-order":28}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/auto-free-auth-policy":{"get":{"tags":["Access Control (Template)"],"summary":"Get automatically generated free auth policy template items","description":"Get automatically generated free auth policy template items with the given omadacId and siteTemplateId.","operationId":"getAutoFreeAuthPolicyTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListAutoFreeAuthPolicyOpenApi"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/qos/gateway/wans":{"get":{"tags":["Gateway QOS (Template)"],"summary":"Get siteTemplate's WAN ports info for Gateway QoS","description":"Get siteTemplate's WAN ports info for Gateway QoS.","operationId":"getTemplateQosWans","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseDataVOQosBwcWanInfoOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/profiles/service-type-summary":{"get":{"tags":["Profiles (Template)"],"summary":"Get all Gateway QoS Service's ID and name info in siteTemplate","description":"Get all Gateway QoS Service's ID and name info in siteTemplate.","operationId":"getTemplateServiceTypeSummary","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseDataVOGatewayQosServiceSummaryOpenApiVO"}}}}},"x-order":90}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/profiles/groups/{groupType}":{"get":{"tags":["Profiles (Template)"],"summary":"Get group profile template list by type","description":"Get a certain type of group profile template list of the site with the given omadacId and siteId and type.","operationId":"getGroupProfilesByTypeTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"groupType","in":"path","description":"Type of group profile, 0:IP Group; 1:IP Port Group; 2：Mac Group; 3:IPv6 Group; 4:IPv6 Port Group; 5:Country Group; 7:Domain Group.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListGroupOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/ppsk-profiles":{"get":{"tags":["Profiles (Template)"],"summary":"Get PPSK profile templates list","description":"Get PPSK profile templates list","operationId":"getPPSKProfilesTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"PPSK Profile type, should be a value as follows: 0: PPSK Without RADIUS; 1: PPSK With Built-In RADIUS","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListPpskProfileBriefInfo"}}}}},"x-order":19},"delete":{"tags":["Profiles (Template)"],"summary":"Delete All PPSK profile templates","description":"Delete All PPSK profile templates","operationId":"deleteAllPPSKProfilesTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/portals":{"get":{"tags":["Authentication (Template)"],"summary":"Get portal list in a site template ","description":"Get portal list with the given omadacId, siteTemplateId.","operationId":"getPortalListTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListPortalResOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/portal/{portalId}/customization":{"get":{"tags":["Authentication (Template)"],"summary":"Get portal template customization","description":"Get portal template customization information with the given omadacId, siteTemplateId and portalId.","operationId":"getPortalTemplateCustomization","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"portalId","in":"path","description":"Portal ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePortalCustomizationPageResOpenApiVO"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/oui-profiles/all":{"get":{"tags":["Profiles (Template)"],"summary":"Get OUI profile template summary list","description":"Get OUI profile template summary list.","operationId":"getOuiProfileFullListTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOuiProfileSummaryOpenApiVO"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/networks/{networkId}/vlans/{vlan}/switches":{"get":{"tags":["Switch (Template)"],"summary":"Get the paging query for the osw templates with given network id and vlan","description":"Get the paging query for the osw templates with given network id and vlan","operationId":"getOswForGivenLanNetworkIdAndVlanTemplate","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"networkId","required":true,"schema":{"type":"string"}},{"name":"vlan","in":"path","description":"vlan","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/networks/{networkId}/vlan/{vlan}/ssids":{"get":{"tags":["Wired Network (Template)"],"summary":"Get grid ssid template list that use the vlan","description":"Get grid ssid template list that use the vlan","operationId":"getVlanNetworkAffectedSsid","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}},{"name":"vlan","in":"path","description":"Vlan ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOVlanNetworkAffectingSsidVO"}}}}},"x-order":58}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/networks/{networkId}/vlan/{vlan}/ports":{"get":{"tags":["Wired Network (Template)"],"summary":"Get the ports of devices template that use the network","description":"Get the ports of devices template that use the network.","operationId":"getTemplateGridVlanNetworkAffectedDevicePorts","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}},{"name":"vlan","in":"path","description":"Vlan ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVlanForPortDisplayGridVOVlanNetworkAffectingDeviceDetailVO"}}}}},"x-order":50}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/networks/{networkId}/vlan/{vlan}/devices":{"get":{"tags":["Wired Network (Template)"],"summary":"Get device template list that use the network","description":"Get device template list that use the network","operationId":"getVlanNetworkAffectedDevice","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}},{"name":"vlan","in":"path","description":"Vlan ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListVlanNetworkAffectingDeviceVO"}}}}},"x-order":38}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/networks/devices":{"get":{"tags":["Wired Network (Template)"],"summary":"Get device template list that can be dhcp server","description":"Get device template list that can be dhcp server","operationId":"getGridSupportVlanNetworkDevicesBySiteTemplate","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVODeviceVO"}}}}},"x-order":37}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/mac-filters/deny":{"get":{"tags":["MAC Filtering (Template)"],"summary":"Get deny MAC filtering template list","description":"Get deny MAC filtering template list.","operationId":"getGridDenyMacFilteringTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMacFiltering"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/mac-filters/allow":{"get":{"tags":["MAC Filtering (Template)"],"summary":"Get allow MAC filtering template list","description":"Get allow MAC filtering template list.","operationId":"getGridAllowMacFilteringTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMacFiltering"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/mac-auth/ssids":{"get":{"tags":["Authentication (Template)"],"summary":"Get ssids that support MAC auth Template","description":"Get ssid list that support MAC-Based Authentication Template with the given omadacId and siteTemplateId.","operationId":"getMacAuthSsids","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListWlanSimpleOpenApiVO"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/lan-profiles/{profileId}/es":{"get":{"tags":["Wired Network (Template)"],"summary":"Get Use LAN profile ES template list","description":"Get Use LAN profile ES template list.","operationId":"getUseLanProfileESTemplateList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"LAN profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOUseProfileOswOpenApiVO"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/lan-networks/interface":{"get":{"tags":["Wired Network (Template)"],"summary":"Get all \"single\"/\"multi\" interface lan network template","description":"Get all \"single\"/\"multi\" interface lan network template","operationId":"getInterfaceLanNetworkV2_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Interface vlan type. When \"type\" is 0, return \"single\" interface lan network, else return \"single\"/\"multi\" interface lan network","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseDataVOLanNetworkQueryOpenApiV2VO"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/lan-networks/all":{"get":{"tags":["Wired Network (Template)"],"summary":"Get all network templates for the omada id and site template id","description":"Get all network templates for the omada id and site template id","operationId":"getAllLanNetworksTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListLanNetworkVO"}}}}},"x-order":34}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/internet":{"get":{"tags":["Wired Network (Template)"],"summary":"Get internet info","description":"Get internet info On site template.","operationId":"getInternetTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseInternetOpenApiVO"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/internet/load-balance/status":{"get":{"tags":["Wired Network (Template)"],"summary":"Check Wan Loadbalance status","description":"Check Wan Loadbalance weight modified or not","operationId":"getLoadBalanceWeightStatusTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":49}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/grid/allow-list":{"get":{"tags":["IDS/IPS (Template)"],"summary":"Get site template grid ips allow list","description":"Obtain site template grid allow list.","operationId":"getTemplateGridAllowList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field IP / Subnet","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}":{"get":{"tags":["Gateway (Template)"],"summary":"Get gateway template info","description":"Get gateway template info","operationId":"getGatewayInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGatewayTemplateInfo"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/ports/config":{"get":{"tags":["Gateway (Template)"],"summary":"Get gateway template port info","description":"Get gateway template port info","operationId":"getPortsTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOsgPortInfoOpenApiVO"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/gatewaytemplates/{deviceTemplateId}/config/wlans/ssid":{"get":{"tags":["Gateway (Template)"],"summary":"Get SSID detail info","description":"Get SSID detail info","operationId":"getSsidDetailTemplate_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSsidDetailOpenApiVO"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/dst-info":{"get":{"tags":["Site Template"],"summary":"Get daylight saving time information for the Site template configuration","description":"Get daylight saving time information for the Site template configuration","operationId":"getSiteTemplateDstInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":30}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/dns-cache":{"get":{"tags":["DNS (Template)"],"summary":"Get DNS cache setting template","description":"Get DNS cache setting template of the site template with the given omadacId and siteTemplateId.","operationId":"getDnsCacheSettingTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDnsCacheOpenApiVO"}}}}},"x-order":38}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/devicetemplates/{deviceTemplateId}/bound-devices":{"get":{"tags":["Site Template"],"summary":"Get deviceTemplate's bound devices","description":"Get deviceTemplate's bound devices.","operationId":"getGridDeviceTemplateBoundDevices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVODeviceBindOpenApiVO"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/devicetemplates/{deviceTemplateId}/available-bind-devices":{"get":{"tags":["Site Template"],"summary":"Get deviceTemplate's available devices","description":"Get deviceTemplate's available devices.","operationId":"getGridDeviceTemplateAvailableDevices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"deviceTemplateId","in":"path","description":"Device Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVODeviceBindOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/devicetemplates/support-ports":{"get":{"tags":["Wired Network (Template)"],"summary":"Get grid devices templates that support ports config.","description":"Get grid devices templates that support ports config.","operationId":"getSupportPortsDeviceTemplates","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListDeviceTemplateForVlanVO"}}}}},"x-order":53}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/devicetemplates/detail":{"get":{"tags":["Site Template"],"summary":"get device template","description":"get device template","operationId":"getGridDeviceTemplateDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceTemplateGridOpenApiVODeviceTemplateOpenApiQueryVO"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/devicetemplates/available-devices/{siteId}":{"get":{"tags":["Site Template"],"summary":"get the devices on the site and the templates that can be bound","description":"get the devices on the site and the templates that can be bound","operationId":"getGridDevicesAvailableTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVODeviceAvailableTemplateOpenApiVO"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/devices/un-support-radsec":{"get":{"tags":["Site Template"],"summary":"Check for unsupported RadSec devices in the bound sites.","description":"Get the result of detecting devices in the bound sites that do not support the RadSec feature.","operationId":"boundSiteExistUnSupportRadSecDevice","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUnSupportRadSecOpenApiVO"}}}}},"x-order":31}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/count-ap-groups":{"get":{"tags":["Wireless Network (Template)"],"summary":"Check if the number of AP Groups template is out of limit","description":"Check if the number of AP Groups template is out of limit. The value of \"ApGroupNum\" indicates number of AP group and the value of \"exceeded\" indicates whether the number of AP Groups exceeds the limit. \nThe limit is the total number that a Controller can create, not the limit of a single Site.","operationId":"countApGroupsTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApGroupStatusOpenApiVO"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/cli/configs/cli-type/{cliType}/device-type/{deviceType}":{"get":{"tags":["CLI (Template)"],"summary":"Get the CLI template configuration list","description":"Get the CLI template configuration list","operationId":"getGridCliTemplate","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"cliType","in":"path","description":"CLI type should be a value as follows: 0: site CLI; 1: device CLI； 2：model CLI. Site template only supports site CLI. Site template only supports site CLI.","required":true,"schema":{"type":"string"}},{"name":"deviceType","in":"path","description":"Device Type. Supported type: switch.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOCliTemplateOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/capacity":{"get":{"tags":["Site Template"],"summary":"Get siteTemplate capabilities.","description":"Get siteTemplate capabilities.","operationId":"getSiteTemplateSettingCap","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteSettingCapOpenApiVO"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/binding-sites":{"get":{"tags":["Site Template"],"summary":"Get sites info which bound to the site template","description":"Get sites info which bound to the site template.","operationId":"getBoundSites","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseBindSiteBriefOpenApiVO"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/available-devicemodels":{"get":{"tags":["Site Template"],"summary":"get valid device template","description":"get valid device template","operationId":"getValidDeviceModel","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseValidDeviceModelOpenApiVO"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/available-bind":{"get":{"tags":["Site"],"summary":"Get available site to bind template","description":"Get available site to bind template.","operationId":"getAvailableSiteToBind","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSitesSite"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/applicationControl/families":{"get":{"tags":["Application Control"],"summary":"Get family list","description":"Get family list.","operationId":"getFamiliesTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListFamilyEntity"}}}}},"x-order":32}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/applicationControl/applications":{"get":{"tags":["Application Control"],"summary":"Get application list","description":"Get application list.","operationId":"getApplicationsTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field application name","required":false,"schema":{"type":"string"}},{"name":"filtersFamilyId","in":"query","description":"Filter query parameters, support field 0","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOApplicationEntity"}}}}},"x-order":33}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/anomaly/setting":{"get":{"tags":["Incident (Template)"],"summary":"Get site template anomaly event setting","description":"Get site template anomaly event setting.","operationId":"getAnomalyEventSettingForSiteTemlate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.enable","in":"query","description":"Filter query parameters, support field enable, it should be a value as follows: 0:enable, 1:disable, example:0.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"filters.level","in":"query","description":"Filter query parameters, support field level, it should be a value as follows: 0:Critical, 1:Error, 2:Warning, 3: Info, example:1.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"filters.category","in":"query","description":"Filter query parameters, support field category, one or more categories, each category should be a value as follows: 11:Access, 12:Authentication, 13:Roaming, 14:Wireless Network, 15:Wired Network, 16:Link, 17:WAN and Services, 18:Device Status, 19:Security, example: 11 Or 12,13,14","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAnomalySettingGridVOAnomalyEventSettingOpenApiVO"}}}}}}},"/openapi/v1/{omadacId}/sitetemplates/modules":{"get":{"tags":["Site Template"],"summary":"Get function modules which can be selected when creating site template","description":"Get function modules which can be selected when creating site template. This interface has been deprecated. Please use the following interface instead: Get all function modules which can be selected when creating site template.","operationId":"getSiteTemplateModules","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteTemplateModulesOpenApiVO"}}}}},"deprecated":true,"x-order":17}},"/openapi/v1/{omadacId}/sitetemplates/all-modules":{"get":{"tags":["Site Template"],"summary":"Get all function modules which can be selected when creating site template","description":"Get all function modules which can be selected when creating site template.","operationId":"getSiteTemplateAllModules","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteTemplateAllModulesOpenApiVO"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/wlans/{wlanId}/ssids/{ssidId}":{"get":{"tags":["Wireless Network"],"summary":"Get SSID detail info","description":"Get SSID detail info, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Get SSID detail info.","operationId":"getSsidDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSsidDetailOpenApiVO"}}}}},"deprecated":true,"x-order":8},"delete":{"tags":["Wireless Network"],"summary":"Delete an existing SSID","description":"Delete an existing SSID, Legacy note: “wlanId” is the legacy name of “apGroupId”. This endpoint will be deprecated in future releases. Please use Delete an existing SSID.","operationId":"deleteSsid","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wlanId","in":"path","description":"WLAN ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssids":{"get":{"tags":["Wireless Network"],"summary":"Get all ssids of the site","description":"Get all ssids of the site","operationId":"getSsidsBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Device Type. Supported type: ap and wireless router. 1: ap, 2: wireless router, 3: ap and wireless router","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListWlanSimpleOpenApiVO"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssids/{ssidId}":{"get":{"tags":["Wireless Network"],"summary":"Get SSID detail info","description":"Get SSID detail info","operationId":"getSsidDetailV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSsidDetailOpenApiVO"}}}}},"x-order":62},"delete":{"tags":["Wireless Network"],"summary":"Delete an existing SSID","description":"Delete an existing SSID","operationId":"deleteSsidBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":34}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssids/{ssidId}/overrides":{"get":{"tags":["app"],"summary":"Get Ssid override details","description":"Get Ssid override details","operationId":"listSsidOverrideBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOSsidOverrideDetailVO"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssids/{ssidId}/gateway/overrides":{"get":{"tags":["app"],"summary":"Query gateway by site with SSID override activated","description":"Query gateway by site with SSID override activated","operationId":"getGatewaySsidOverrideBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSsidOverrideDetailVO"}}}}},"x-order":27}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/ssids/duplicate-name/{ssidId}":{"get":{"tags":["app"],"summary":"Check SSID device type compatibility","description":"Check whether same-name SSIDs contain a device type not covered by the selected SSID. Returns 0 when no warning is required, 1 when the target SSID does not include Gateway, or 2 when the target SSID does not include AP.","operationId":"querySsidDuplicateNameDeviceType","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","description":"SSID ID","required":true,"schema":{"type":"string"}},{"name":"ssidName","in":"query","description":"SSID name used to find same-name SSIDs.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSsidDeviceTypeConflictOpenApiVO"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/multi-band-6g/exist":{"get":{"tags":["Wireless Network"],"summary":"Get the site exists 6G ap","description":"Get the site exists 6G ap","operationId":"getSiteApExist6G","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApExist6GOpenApiVO"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sites/{siteId}/wireless-network/cmd/countWlans":{"get":{"tags":["Wireless Network"],"summary":"Check if the number of WLAN groups is out of limit","description":"Check if the number of WLAN groups is out of limit. The value of \"wlanGroupNum\" indicates number of wlan group and the value of \"exceeded\" indicates whether the number of WLANs exceeds the limit. Legacy note: “WLAN Group” is the legacy name of “AP Group”. This endpoint will be deprecated in future releases. Please use Check if the number of AP Groups is out of limit.","operationId":"countWlans","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWlanGroupStatusOpenApiVO"}}}}},"deprecated":true,"x-order":69}},"/openapi/v1/{omadacId}/sites/{siteId}/wired-networks/disable-nats":{"get":{"tags":["Disable Nat"],"summary":"Get Disable Nat Grid","description":"Get Disable Nat Grid.","operationId":"getDisableNatGrid_1","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVODisableNatDetailOpenApiVO"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/wifi/sub/health/timeline":{"get":{"tags":["Health"],"summary":"Get site wifi sub health detail ","description":"Get site wifi sub health detail ","operationId":"getWifiSubHealthTimeList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/WifiHealthDetailVO"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/sites/{siteId}/wifi/health/timeline":{"get":{"tags":["Health"],"summary":"Get site wifi health time line","description":"Get site wifi health time line","operationId":"getWifiHealthTimeList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTimeScoreListVO"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/wan/networks/unsupportedFunction":{"get":{"tags":["Wired Network"],"summary":"Get linkage functions that are not supported by WAN","description":"Get linkage functions that are not supported by WAN.","operationId":"obtainWanUnsupportedFunction","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filter","in":"query","description":"1: Obtain the functions that are not supported when you configure DS-Lite and MAP-E dial-up for IPv4 on the WAN port.","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWanUnsupportedFunctionOpenApiVO"}}}}},"x-order":92}},"/openapi/v1/{omadacId}/sites/{siteId}/wan/networks/isp-scan/{portUuid}/{simCard}":{"get":{"tags":["Wired Network"],"summary":"Obtain the ispScan result of the corresponding SIM card","description":"Obtain the ispScan result of the corresponding SIM card.","operationId":"getSimCardIspScanResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"portUuid","in":"path","description":"The ID of the port.","required":true,"schema":{"type":"string"}},{"name":"simCard","in":"path","description":"SIM card. 1: SIM1; 2: SIM2.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseIspScanResultOpenApiVO"}}}}},"x-order":47}},"/openapi/v1/{omadacId}/sites/{siteId}/wan/networks/band-scan/{portUuid}/{simCard}":{"get":{"tags":["Wired Network"],"summary":"Obtain the bandScan result of the corresponding SIM card","description":"Obtain the bandScan result of the corresponding SIM card.","operationId":"getSimCardBandScanResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"portUuid","in":"path","description":"The ID of the port.","required":true,"schema":{"type":"string"}},{"name":"simCard","in":"path","description":"SIM card. 1: SIM1; 2: SIM2.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseBandScanResultOpenApiVO"}}}}},"x-order":45}},"/openapi/v1/{omadacId}/sites/{siteId}/wan-max-speed":{"get":{"tags":["Wired Network"],"summary":"Get wan ports max speed","description":"Get max speed for certain wan ports,if ports doesn't exist, this interface will return default result","operationId":"getWanPortsMaxSpeed_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wanId","in":"query","description":"WanId, can pass multiple wan ports using comma separator like '{portId1},{portId2}'.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWanMaxSpeedOpenApiVO"}}}}},"x-order":52}},"/openapi/v1/{omadacId}/sites/{siteId}/wan-lan-status":{"get":{"tags":["Wired Network"],"summary":"Check WAN-LAN status","description":"Get gateway basic info and WAN/LAN list. Use this API to operate \"LanNetwork\".","operationId":"checkWanLanStatus_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCheckWanLanStatusOpenApiVO"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn":{"get":{"tags":["VPN"],"summary":"Get All VPN list","description":"Get All VPN list. This interface has been deprecated. Please use the following interfaces instead: Get VPN Server summary list and Get client-to-site VPN server detail info;Get VPN Client summary list and Get client-to-site VPN client detail info;Get VPN Site to Site summary list and Get site-to-site VPN detail info. This interface had been deprecated.","operationId":"getAllVpnList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnOpenApiGridVOVPN"}}}}},"deprecated":true,"x-order":36},"delete":{"tags":["VPN"],"summary":"Batch delete VPN","description":"Batch delete VPN.","operationId":"batchDeleteVpn","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchSelectVpnVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/{vpnId}/checkUsed":{"get":{"tags":["VPN"],"summary":"Check used function for single VPN item","description":"Check used function for single VPN item.","operationId":"checkUsedVpn","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseFunctionOpenApiVO"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/wireguard-summarys":{"get":{"tags":["Wireguard VPN"],"summary":"Get all wireguard's id and name info","description":"Get all wireguard's id and name info.","operationId":"getWireguardSummary","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseDataVOWireguardSummaryOpenApiVO"}}}}},"deprecated":true,"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/wireguard-key":{"get":{"tags":["Wireguard VPN"],"summary":"Get new private key and public key","description":"Get new private key and public key.","operationId":"getWireguardKey","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWireguardKeyOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/userlist/{protocol}":{"get":{"tags":["VPN"],"summary":"Get VPN user list without page","description":"Get VPN user list without page.","operationId":"getVpnUserList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"protocol","in":"path","description":"0: L2TP or PPTP; 1: OpenVPN; 2: SSL VPN","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnUserOpenApiGridVOVpnUserResponse"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/userlist/server/{serverId}":{"get":{"tags":["VPN"],"summary":"Get brief VPN user list by VPN server ID without page","description":"Get brief VPN user list by VPN server ID without page.","operationId":"getBriefVpnUserByServerIdList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"serverId","in":"path","description":"VPN server ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListVpnUserBriefVO"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/userServers":{"get":{"tags":["VPN"],"summary":"Get VPN server list for user","description":"Get VPN server list for user.","operationId":"getVpnUserServerList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListVpnUserServerBriefVO"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ssl-vpn-server/usergroups/{userGroupId}/users":{"get":{"tags":["SSL VPN"],"summary":"Get SSL VPN user list in group.","description":"Get SSL VPN user list in group. This interface has been deprecated. Please use the following interfaces instead: Get SSL VPN user list in group V2.","operationId":"getGridSslVpnUserInGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"userGroupId","in":"path","description":"User Group Id","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSslVpnUserOpenApiGridVOSslVpnUserEntity"}}}}},"deprecated":true,"x-order":27}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ssl-vpn-server/radius":{"get":{"tags":["SSL VPN"],"summary":"Get radius server for SSL VPN server","description":"Get radius server for SSL VPN server.","operationId":"getRadiusServerInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListRadiusServerBriefInfo"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ssl-vpn-server/certificate":{"get":{"tags":["SSL VPN"],"summary":"Download SSL VPN certificate.","description":"Download SSL VPN certificate. Filename is a UTF-8 string encoded by URL Encoder. This interface has been deprecated. Please use the following interfaces instead: Download Open VPN or SSL VPN certificate.","operationId":"downloadSslVpnCertificate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"wanIp","in":"query","description":"WLAN IP","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"deprecated":true,"x-order":26}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ssl-vpn-server/briefusergroups":{"get":{"tags":["SSL VPN"],"summary":"Get SSL VPN user Group list.","description":"Get SSL VPN user Group list. This interface has been deprecated. Please use the following interfaces instead: Get SSL VPN user Group list V2.","operationId":"getSslVpnUserGroupList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListSslVpnUserGroupBriefVO"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ssl-vpn-server/briefresources":{"get":{"tags":["SSL VPN"],"summary":"Get SSL VPN resource list","description":"Get SSL VPN resource list.","operationId":"getSslVpnResourceList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListSslVpnResourceBriefInfo"}}}}},"x-order":31}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ssl-vpn-server/briefresourcegroups":{"get":{"tags":["SSL VPN"],"summary":"Get SSL VPN resource group list.","description":"Get SSL VPN resource group list.","operationId":"getSslVpnResourceGroupList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListSslVpnResourceGroupBriefInfo"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/psk":{"get":{"tags":["VPN"],"summary":"Generate a random pre-shared key for IPSec","description":"Generate a random pre-shared key for IPSec.","operationId":"getVpnPreSharedKey","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnPreSharedKeyVO"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/ippool":{"get":{"tags":["VPN"],"summary":"Get available IP pools for VPN","description":"Get available IP pools for VPN.","operationId":"getVpnAvailableIpPool","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnAvailableIpPoolVO"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/client-to-site-vpn-servers/{vpnId}/users":{"get":{"tags":["VPN"],"summary":"Get user list for client-to-site VPN server","description":"Get user list for client-to-site VPN server.","operationId":"getClientToSiteVpnServerUserList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListVpnUserResponse"}}}}},"x-order":56}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/briefusergroups":{"get":{"tags":["VPN"],"summary":"Get SSL VPN user Group list V2","description":"Get SSL VPN user Group brief information list.","operationId":"getSslVpnUserGroupBriefList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSslVpnUserGroupGridVOSslVpnUserGroupBriefVO"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sites/{siteId}/voip/call-log":{"get":{"tags":["VoIP"],"summary":"Get Voip CallLog Data List","description":"Get Voip CallLog Data List.","operationId":"getVoipCallLog","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.dateTime","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"filters.status","in":"query","description":"Filter query parameters, support field status: 0: incoming, 1: outgoing, 3: transfer, 4: miss，5: rejected","required":false,"schema":{"type":"string"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field deviceNumber/telephonyDevice","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCallLogGridVOVoipCallLog"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/vlan-interface/switches/{switchMac}":{"get":{"tags":["OSPF"],"summary":"Get Switch Vlan Interface list for OSPF","description":"Get Switch Vlan Interface list for OSPF.","operationId":"getOswVlanIf","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListVlanInterfaceOpenApiVO"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/vlan-interface/stack/{stackId}":{"get":{"tags":["OSPF"],"summary":"Get Stack Vlan Interface list for OSPF","description":"Get Stack Vlan Interface list for OSPF.","operationId":"getStackVlanIf","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListVlanInterfaceOpenApiVO"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/vigis/{vigiMac}/vigi-timeline":{"get":{"tags":["Client"],"summary":"Get VIGI device timeline events","description":"Get VIGI device timeline events.","operationId":"getVigiTimeline","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vigiMac","in":"path","description":"VIGI device MAC","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, unit: ms","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, unit: ms","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"type","in":"query","description":"Query type, 0: Connection Timeline; 1: Association; 2: Roaming; 3: Disconnection.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListActivity Records Of A Client's Single Connections"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/sites/{siteId}/vigis/{vigiMac}/vigi-connection":{"get":{"tags":["Client"],"summary":"Get VIGI device connection histories","description":"Get VIGI device connection histories.","operationId":"getVigiJourney","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vigiMac","in":"path","description":"VIGI device MAC","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, unit: ms","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, unit: ms","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClient Connection Histories"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/sites/{siteId}/url":{"get":{"tags":["Site"],"summary":"Get site url","description":"Get site url","operationId":"getSiteUrlByOpenApi","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteUrlOpenApiVO"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/url-filters/gateway":{"get":{"tags":["URL Filtering"],"summary":"Get URL filtering rule list for gateway","description":"Get URL filtering rule list for gateway.","operationId":"getGridGatewayRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUrlFilteringOpenApiGridVOQueryUrlFilteringOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/url-filters/eap":{"get":{"tags":["URL Filtering"],"summary":"Get URL filtering rule list for eap","description":"Get URL filtering rule list for eap.","operationId":"getGridEapRule","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUrlFilteringOpenApiGridVOQueryUrlFilteringOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/url-filters/category":{"get":{"tags":["URL Filtering"],"summary":"Get Category","description":"Get Category.","operationId":"getCategory","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUrlCategoryOpenApiVO"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}":{"get":{"tags":["Switch"],"summary":"Get switch info","description":"Get switch info.","operationId":"getSwitchInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSwitchOverviewInfo"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/sdm-used":{"get":{"tags":["Switch"],"summary":"Get the used sdm template num on the switch","description":"Get the used template num on the switch.","operationId":"getSwitchUsedSdmNum","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswSdmApplicationVO"}}}}},"x-order":57}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/rpvst-instances":{"get":{"tags":["Switch"],"summary":"Get Rpvst Instances","description":"Get Rpvst Instances.","operationId":"getRpvstInstances","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":65}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/routingTable":{"get":{"tags":["Insight"],"summary":"Get switch routing table","description":"Get switch routing table.","operationId":"getGridOswRoutingTable","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.destinationIp","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"filters.type","in":"query","description":"Filter query parameters, support field type","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field destinationIp","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOswRoutingOpenApiVO"}}}}},"x-order":33}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/port-lag-networks":{"get":{"tags":["Switch"],"summary":"Get the networks used on switch's ports and LAGs","description":"Get the networks used on switch's ports and LAGs.","operationId":"getGridPortAndLagNetworks_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GridVOOswNetworkBriefInfoOpenApiVO"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/port-lag-networks/{networkId}/vlan/{vlan}":{"get":{"tags":["Switch"],"summary":"Get the switch's ports and LAGs that the network affects","description":"Get the switch's ports and LAGs that the network affects.","operationId":"getPortAndLagNetwork_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Switch network ID.","required":true,"schema":{"type":"string"}},{"name":"vlan","in":"path","description":"VLAN.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OswPortAndLagNetworkVO"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/ospf-neighbors":{"get":{"tags":["Switch"],"summary":"Get switch ospf neighbor table","description":"Get switch ospf neighbor table.","operationId":"getGridOspfNeighborTable","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.neighborInterface","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"filters.neighborInterface","in":"query","description":"Filter query parameters, support field neighborInterface","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filters.processId","in":"query","description":"Filter query parameters, support field processId","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field neighborIp","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswOspfNeighborGridVOOswOspfNeighborVO"}}}}},"x-order":33}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/networks-detail":{"get":{"tags":["Switch"],"summary":"Get the networks detail (including the vlan related ports and lags info) used on switch's ports and LAGs","description":"Get the networks detail (including the vlan related ports and lags info) used on switch's ports and LAGs.","operationId":"getGridPortAndLagNetworksDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GridVOOswNetworkDetailInfoOpenApiVO"}}}}},"x-order":55}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/lldp-neighbors":{"get":{"tags":["Switch"],"summary":"Get switch lldp neighbor table","description":"Get switch lldp neighbor table.","operationId":"getGridLldpNeighborTable","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.portId","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field portId,standardPort,deviceId,systemName","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOswLldpNeighborVO"}}}}},"x-order":56}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/l3-sdm-used":{"get":{"tags":["Switch"],"summary":"Get the used sdm template num on the campus series switches","description":"Get the used template num on the campus series switches.","operationId":"getL3SwitchUsedSdmNum","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswL3SdmApplicationVO"}}}}},"x-order":73}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/interfaces":{"get":{"tags":["Switch"],"summary":"List Switch Interfaces","description":"List Switch Interfaces, include VLAN Interface and Loopback Interface.","operationId":"listSwitchInterfaces","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswInterfaceGridOswInterfaceOpenApi"}}}}},"x-order":72}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/interfaces/brief":{"get":{"tags":["Switch"],"summary":"List Switch Brief Interfaces","description":"List Switch Brief Interfaces for OSPF Configurations, include VLAN Interface and Loopback Interface.","operationId":"listSwitchBriefInterfaces","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOswInterfaceBriefVO"}}}}},"x-order":78}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/health/timeline":{"get":{"tags":["Health"],"summary":"Get switch health time line","description":"Get switch health time line","operationId":"getOswHealthTimeList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTimeScoreListVO"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/health/detail":{"get":{"tags":["Health"],"summary":"Get switch health detail","description":"Get switch health detail","operationId":"getOswHealthDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswHealthDetailVO"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/exist-network":{"get":{"tags":["Switch"],"summary":"Get the networks existing on the switch","description":"Get the networks existing on the switch.","operationId":"getSwitchExistNetworks","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLanNetworkOpenApiV2GridVOLanNetworkSplitOpenApiVO"}}}}},"x-order":52}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/dhcp/user-list":{"get":{"tags":["Switch"],"summary":"Get switch dhcp user list","description":"Get switch dhcp user list.","operationId":"getGridDhcpUserList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDhcpUserGridVODhcpUserVO"}}}}},"x-order":58}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/ddm/info":{"get":{"tags":["Switch"],"summary":"Get osw ddm info.","description":"Get osw ddm info.","operationId":"getOswDDMInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOswDDMInfoOpenApiVO"}}}}},"x-order":35}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/supportDhcpSnoop":{"get":{"tags":["Switch"],"summary":"Get the paging query for the osws that support dhcp snoop.","description":"Get the paging query for the osws that support dhcp snoop.","operationId":"getOswsSupportDhcpSnoop","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":59}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/supportArpDetect":{"get":{"tags":["Switch"],"summary":"Get the paging query for the osws that support arp detect.","description":"Get the paging query for the osws that support arp detect.","operationId":"getOswsSupportArpDetect","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":60}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/ports/switch-detail":{"get":{"tags":["Switch"],"summary":"Get the switches detail for ports view","description":"Get the switches detail for ports view.","operationId":"getOswDetailInfoListForPortsView","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOswDetailForPortsViewVO"}}}}},"x-order":39}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/ports/poe-info":{"get":{"tags":["Switch"],"summary":"Get the switches ports poe information","description":"Get the switches ports poe information.","operationId":"getGridSwitchesPortsPoe","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOswPortsSettingPoeVO"}}}}},"x-order":37}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/ports/overview":{"get":{"tags":["Switch"],"summary":"Get the switches ports overview","description":"Get the switches ports overview.","operationId":"getGridSwitchesPortsOverview","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOswPortsSettingOverviewVO"}}}}},"x-order":36}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/ports/counters":{"get":{"tags":["Switch"],"summary":"Get the switches ports counters information","description":"Get the switches ports information.","operationId":"getGridSwitchesPortsCounters","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOswPortsSettingCountersVO"}}}}},"x-order":38}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/health/timeline":{"get":{"tags":["Health"],"summary":"Batch get switch health time line","description":"Batch get switch health time line","operationId":"getMultiOswHealthTimeList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"macs","in":"query","description":"Switch MAC address list, using comma separator, like AA-BB-CC-DD-EE-FF,FF-EE-DD-CC-BB-AA","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseHealthTimeLineVO"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/es/{switchMac}":{"get":{"tags":["Switch"],"summary":"Get switch info (Agile Series)","description":"Get Agile Series switch info.","operationId":"getESInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseEasyManageOverviewInfo"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/es/{switchMac}/network-overview":{"get":{"tags":["Switch"],"summary":"Query Agile Series switch valid network","description":"Query Agile Series switch valid network.","operationId":"getESNetworkOverview","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListNetworkPortsAssociationVO"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-support":{"get":{"tags":["Site Configuration"],"summary":"Get supported switch types information for the site","description":"Get supported switch types information for the site.","operationId":"getSiteSupportSwitchInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteSupportSwitchOpenApiVO"}}}}},"x-order":27}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-qos/upgradable-devices":{"get":{"tags":["Switch QoS"],"summary":"Get switch QoS upgradable devices.","description":"Get switch QoS upgradable devices.","operationId":"getUpgradableDevices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListSelectedOswBriefVO"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-rule/selectable-devices":{"get":{"tags":["Switch QoS"],"summary":"Get switch QoS selectable devices.","description":"Get switch QoS selectable devices.","operationId":"getSelectableDevices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"query","description":"Network ID","required":false,"schema":{"type":"string"}},{"name":"ruleType","in":"query","description":"The type of Qos rule, 0:Network, 1:Port, 2:Custom","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOswDetailVO"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-qos/qos-rule/selectable-devices/all":{"get":{"tags":["Switch QoS"],"summary":"Get switch QoS all selectable device's mac.","description":"Get switch QoS all selectable device's mac.","operationId":"getAllSelectableDevices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"query","description":"Network ID","required":false,"schema":{"type":"string"}},{"name":"ruleType","in":"query","description":"The type of Qos rule, 0:Network, 1:Port, 2:Custom","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswMacListVO"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-oui-rules/whether-auto-add-vlan":{"get":{"tags":["OUI Based VLAN"],"summary":"Get whether site open oui rule auto add vlan.","description":"Get whether site open oui rule auto add vlan.","operationId":"getWhetherSiteOpenAutoAddVlan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOuiBasedVlanSiteAutoAddVlanVO"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-oui-rules/valid-vlans":{"get":{"tags":["Wired Network"],"summary":"Get valid vlanList for switch oui based vlan","description":"Get valid vlanList for switch oui based vlan","operationId":"getAllValidVlansInSiteForSwitchOuiBasedVlan_1","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GridVOLanNetworkVlansOpenApiVO"}}}}},"x-order":26}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-oui-rules/switches":{"get":{"tags":["OUI Based VLAN"],"summary":"Get all oui based vlan switch list.","description":"Get all oui based vlan switch list.","operationId":"getOuiBasedVlanSwitchList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOuiBasedVlanGridVOSwitchDataVO"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-oui-rules/switches/support-auto-add-vlan":{"get":{"tags":["OUI Based VLAN"],"summary":"Get switch list of supporting oui based vlan with ports(lags) info of vlans in oui based rules but not included in port(lag) vlan.","description":"Get switch list of supporting oui based vlan with ports(lags) info of vlans in oui based rules but not included in port(lag) vlan.","operationId":"getAllSupportAutoAddVlanSwitchList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"name","in":"query","description":"Switch name. Support fuzzy search","required":false,"schema":{"type":"string"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOuiBasedVlanDeviceInfoVO"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-oui-rules/support-device":{"get":{"tags":["OUI Based VLAN"],"summary":"Get switch list of supporting oui based vlan","description":"Get switch list of supporting oui based vlan","operationId":"getSwitchList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"name","in":"query","description":"Switch name. Support fuzzy search","required":false,"schema":{"type":"string"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOuiBasedVlanDeviceInfoVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/switch-oui-rules/auto-add-vlan-all-support":{"get":{"tags":["OUI Based VLAN"],"summary":"Get whether all switches support oui rule auto add vlan.","description":"Get whether all switches support oui rule auto add vlan.","operationId":"getWhetherAllSwitchSupportAutoAddVlan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOuiBasedVlanDeviceAutoAddVlanVO"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/stat/switches/{deviceMac}":{"get":{"tags":["Statistic"],"summary":"Get switch statistics","description":"Get switch statistics","operationId":"getSwitchStat","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseStatisticsOswVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/{stackId}/ports":{"get":{"tags":["Stack"],"summary":"Get stack port List","description":"Get stack port List.","operationId":"getOswStackPortList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOswStackPortVO"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/{stackId}/port-lag-networks":{"get":{"tags":["Stack"],"summary":"Get the networks used on stack's ports and LAGs","description":"Get the networks used on stack's ports and LAGs.","operationId":"getGridStackPortAndLagNetworks","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GridVOOswNetworkBriefInfoOpenApiVO"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/{stackId}/port-lag-networks/{networkId}/vlan/{vlan}":{"get":{"tags":["Stack"],"summary":"Get the stack's ports and LAGs that the network affects","description":"Get the stack's ports and LAGs that the network affects.","operationId":"getStackPortAndLagNetwork","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Switch network ID.","required":true,"schema":{"type":"string"}},{"name":"vlan","in":"path","description":"VLAN.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OswPortAndLagNetworkVO"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/{stackId}/networks-detail":{"get":{"tags":["Stack"],"summary":"Get the networks detail (including the vlan related ports and lags info) used on stack's ports and LAGs","description":"Get the networks detail (including the vlan related ports and lags info) used on stack's ports and LAGs.","operationId":"getGridStackPortAndLagNetworksDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GridVOOswNetworkDetailInfoOpenApiVO"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/{stackId}/lags":{"get":{"tags":["Stack"],"summary":"Get stack lag List","description":"Get stack lag List.","operationId":"getOswStackLagList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOswStackMemberLagVO"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/switches":{"get":{"tags":["Stack"],"summary":"Get stackable switches","description":"Get stackable switches.","operationId":"getStackableSwitches","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"query","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswStackSwitchVO"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/stacks/discovery":{"get":{"tags":["Stack"],"summary":"Get discovery stack list","description":"Get discovery stack list.","operationId":"getGridDiscoveryStackList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/stack/{stackId}/sdm-used":{"get":{"tags":["Stack"],"summary":"Get the used sdm template num on the stack","description":"Get the used template num on the stack.","operationId":"getStackUsedSdmNum","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswStackSdmApplicationVO"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/sites/{siteId}/stack/{stackId}/rpvst-instances":{"get":{"tags":["Stack"],"summary":"Get Stack Rpvst Instances","description":"Get Stack Rpvst Instances.","operationId":"getStackRpvstInstances","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":38}},"/openapi/v1/{omadacId}/sites/{siteId}/stack/{stackId}/routingTable":{"get":{"tags":["Insight"],"summary":"Get stack routing table","description":"Get stack routing table.","operationId":"getGridStackRoutingTable","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.destinationIp","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"filters.type","in":"query","description":"Filter query parameters, support field type","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field destinationIp","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOStackRoutingOpenApiVO"}}}}},"x-order":32}},"/openapi/v1/{omadacId}/sites/{siteId}/stack/{stackId}/ospf-neighbors":{"get":{"tags":["Stack"],"summary":"Get stack ospf neighbor table","description":"Get stack ospf neighbor table.","operationId":"getGridStackOspfNeighborTable","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.neighborInterface","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"filters.neighborInterface","in":"query","description":"Filter query parameters, support field neighborInterface","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filters.processId","in":"query","description":"Filter query parameters, support field processId","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field neighborIp","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswOspfNeighborGridVOOswOspfNeighborVO"}}}}},"x-order":30}},"/openapi/v1/{omadacId}/sites/{siteId}/stack/{stackId}/lldp-neighbors":{"get":{"tags":["Stack"],"summary":"Get stack lldp neighbor table","description":"Get stack lldp neighbor table.","operationId":"getGridStackLldpNeighborTable","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.standardPort","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field portId,standardPort,deviceId,systemName","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOswLldpNeighborVO"}}}}},"x-order":32}},"/openapi/v1/{omadacId}/sites/{siteId}/stack/{stackId}/interfaces":{"get":{"tags":["Stack"],"summary":"List Stack Interfaces","description":"List Stack Interfaces, include VLAN Interface and Loopback Interface.","operationId":"listStackInterfaces","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswInterfaceGridOswInterfaceOpenApi"}}}}},"x-order":44}},"/openapi/v1/{omadacId}/sites/{siteId}/stack/{stackId}/interfaces/brief":{"get":{"tags":["Stack"],"summary":"List Stack Brief Interfaces","description":"List Stack Brief Interfaces for OSPF Configurations, include VLAN Interface and Loopback Interface.","operationId":"listStackBriefInterfaces","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOswInterfaceBriefVO"}}}}},"x-order":45}},"/openapi/v1/{omadacId}/sites/{siteId}/stack/{stackId}/downloadDeviceInfo":{"get":{"tags":["Stack"],"summary":"Download stack device info.","description":"Download stack device info.","operationId":"downloadStackDeviceInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Single"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/stack/{stackId}/dhcp/user-list":{"get":{"tags":["Stack"],"summary":"Get stack dhcp user list","description":"Get stack dhcp user list.","operationId":"getGridStackDhcpUserList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDhcpUserGridVODhcpUserVO"}}}}},"x-order":33}},"/openapi/v1/{omadacId}/sites/{siteId}/stack/{stackId}/ddm/info":{"get":{"tags":["Stack"],"summary":"Get stack ddm info.","description":"Get stack ddm info.","operationId":"getOswStackDDMInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOswDDMInfoOpenApiVO"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/spectral-scan/aps/{apMac}/spectral-scan-result":{"get":{"tags":["Insight"],"summary":"Get current results of environment scanning","description":"Get current results of environment scanning. The results of the environment scan are compressed by the Deflate algorithm and then base64 encoded.","operationId":"getSpectralScanResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"times","in":"query","description":"The time between the requested spectral scan results.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/spectral-scan/aps/{apMac}/spectral-scan-result/history":{"get":{"tags":["Insight"],"summary":"Get history results of environment scanning","description":"Get history results of environment scanning. The results of the environment scan are compressed by the Deflate algorithm and then base64 encoded.","operationId":"getSpectralScanHistoryResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/specification":{"get":{"tags":["Site Configuration"],"summary":"Get site functional specifications","description":"Get site functional specifications(Return value only after adopting low-specification equipment).","operationId":"getSiteSpecification","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSpecificationOpenApiVO"}}}}},"x-order":26}},"/openapi/v1/{omadacId}/sites/{siteId}/sim/sms/support":{"get":{"tags":["SIM"],"summary":"Get support SMS","description":"Get SIM card whether supports SMS.","operationId":"getSupportSms","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSupportSmsOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/sim/sms/outbox":{"get":{"tags":["SIM"],"summary":"Get SMS outbox message","description":"Get SMS outbox message.","operationId":"getGridSmsOutboxMessage","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMessage"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/sim/sms/outbox/{simCard}":{"get":{"tags":["SIM"],"summary":"Get one of Dual-SIM card's SMS outbox message","description":"Get SMS outbox message.","operationId":"getGridSimCardSmsOutboxMessage","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"simCard","in":"path","description":"SIM card. 1: SIM1; 2: SIM2.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMessage"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/sim/sms/inbox":{"get":{"tags":["SIM"],"summary":"Get SMS inbox message","description":"Get SMS inbox message.","operationId":"getGridSmsInboxMessage","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMessage"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/sim/sms/inbox/{simCard}":{"get":{"tags":["SIM"],"summary":"Get one of Dual-SIM card's SMS inbox message","description":"Get SMS inbox message.","operationId":"getGridSimCardSmsInboxMessage","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"simCard","in":"path","description":"SIM card. 1: SIM1; 2: SIM2.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMessage"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/sim/quota/{simCard}":{"get":{"tags":["SIM"],"summary":"Get one of Dual-SIM card's SIM data setting","description":"Get SIM data setting.","operationId":"querySimCardQuotaSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"simCard","in":"path","description":"SIM card. 1: SIM1; 2: SIM2.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSimQuotaSetting"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/vpn/stats/tunnel":{"get":{"tags":["Insight"],"summary":"Query the vpnStats tunnel list","description":"Query the vpnStats tunnel list","operationId":"getGridVpnTunnel","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOsgVpnTunnelOpenApiVO"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/vpn/stats/server":{"get":{"tags":["Insight"],"summary":"Get VPN Server status list","description":"Get VPN Server status list.","operationId":"getGridVpnServerStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filters.vpnType","in":"query","description":"Filter query parameters, support field vpnType. 0: L2TP; 1: PPTP; 2: IPSec; 3: OpenVPN; 4: WireGuard; 5: SSL VPN.","required":true,"schema":{"type":"string"}},{"name":"filters.clientMode","in":"query","description":"Filter query parameters, support field Client mode for VPN user. 0: NEM(Network Extension Mode) ; 1: Client.","required":false,"schema":{"type":"string"}},{"name":"sorts.activeClients","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.clients","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVpnTunnelGridVOVpnTunnelStatusVO"}}}}},"x-order":34}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/vpn/stats/server/{vpnId}/client":{"get":{"tags":["Insight"],"summary":"Get VPN Server's clients status list","description":"Get VPN Server's clients status list by VPN ID.","operationId":"getGridVpnServerClientsStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}},{"name":"filters.status","in":"query","description":"Filter query parameters, support field status. 0: disconnected; 1: connected.","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"searchKey","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOVpnTunnelRemoteStatusVO"}}}}},"x-order":35}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/vpn/stats/s2s":{"get":{"tags":["Insight"],"summary":"Get VPN Site-to-Site status list","description":"Get VPN Site-to-Site status list.","operationId":"getGridVpnS2SStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filters.vpnType","in":"query","description":"Filter query parameters, support field vpnType. 2: IPSec; 4: WireGuard.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGetVpnResponseGridVOVpnTunnelStatusVO"}}}}},"x-order":37}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/vpn/stats/s2s/{vpnId}/peer":{"get":{"tags":["Insight"],"summary":"Get VPN Site-to-Site's peers status list","description":"Get VPN Site-to-Site's peers status list by VPN ID.","operationId":"getGridVpnS2SPeersStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}},{"name":"filters.status","in":"query","description":"Filter query parameters, support field status. 0: disconnected; 1: connected.","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"searchKey","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGetVpnResponseGridVOVpnTunnelRemoteStatusVO"}}}}},"x-order":38}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/vpn/stats/ipsec":{"get":{"tags":["Insight"],"summary":"Query the vpnStats ipsec list","description":"Query the vpnStats ipsec list","operationId":"getGridVpnIpSec","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOsgVpnIpSecOpenApiVO"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/vpn/stats/client":{"get":{"tags":["Insight"],"summary":"Get VPN Client status list","description":"Get VPN Client status list.","operationId":"getGridVpnClientStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filters.vpnType","in":"query","description":"Filter query parameters, support field vpnType. 0: L2TP; 1: PPTP; 3: OpenVPN; 4: WireGuard.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOVpnTunnelStatusVO"}}}}},"x-order":36}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voip-devices":{"get":{"tags":["VoIP"],"summary":"Get Voip Device List","description":"Get Voip Device List.","operationId":"getVoipDeviceList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOVoipDevice"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voip-devices/{deviceMac}/registration-result":{"get":{"tags":["VoIP"],"summary":"Get Telephone Number Registration Results","description":"Get Telephone Number Registration Results.","operationId":"getTelephoneNumberRegistrationResults","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseNumberRegistrationResult"}}}}},"x-order":33}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voip-devices/telephone-number/import-result":{"get":{"tags":["VoIP"],"summary":"Download telephone number list import result","description":"Download telephone number list import result. When the API [Import telephone number list from file] returns error code 0, it means that the configuration in the CSV file is correct and there is no need to call the API.","operationId":"downloadTelephoneNumberImportResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":35}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voip-devices/telephone-number/export":{"get":{"tags":["VoIP"],"summary":"Export telephone number list to file","description":"Export existed telephone number list to file.","operationId":"exportTelephoneNumberListToFile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":36}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voip-devices/simplied-list":{"get":{"tags":["VoIP"],"summary":"Get Grid of Simplified VoIP Devices","description":"Get Grid of Simplified VoIP Devices.","operationId":"getGridSimplifiedVoipDevices","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOSimplifiedVoipDeviceOpenApiVO"}}}}},"x-order":37}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voip-devices/grid/telephone-number":{"get":{"tags":["VoIP"],"summary":"Get Grid of Telephone Number Registration Results","description":"Get Grid of Telephone Number Registration Results.","operationId":"getGridTelephoneNumberRegistrationResults","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVODeviceTelephoneNumber"}}}}},"x-order":28}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voip-devices/digit-map":{"get":{"tags":["VoIP"],"summary":"Get All Digit Map Profiles","description":"Get All Digit Map Profiles.","operationId":"getAllDigitMapProfiles","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListSimplifiedDigitMapProfile"}}}}},"x-order":29}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voip-devices/call-blocking":{"get":{"tags":["VoIP"],"summary":"Get All Call Blocking Profiles","description":"Get All Call Blocking Profiles.","operationId":"getAllCallBlockingProfiles","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListSimplifiedCallBlockingProfile"}}}}},"x-order":30}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voice-mail/{voiceId}/download":{"get":{"tags":["VoIP"],"summary":"Get voice mail","description":"Get voice mail","operationId":"downloadVoiceMail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"voiceId","in":"path","description":"Voice ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":40}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voice-mail/settings/usbInfo":{"get":{"tags":["VoIP"],"summary":"Get USB info","description":"Get USB info","operationId":"getUsbInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUsbInfoListResponse"}}}}},"x-order":39}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voice-mail/grid":{"get":{"tags":["VoIP"],"summary":"Get voice mail list","description":"Get voice mail list","operationId":"getVoipMailGrid","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOVoiceMail"}}}}},"x-order":36}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/grid/provider-profiles":{"get":{"tags":["VoIP"],"summary":"Get the grid of provider profile list","description":"Get the grid of provider profile list.","operationId":"getGridProviderProfileList_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOProviderProfileEntity"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/call-forwarding/grid":{"get":{"tags":["VoIP"],"summary":"Get call forwarding rules","description":"Get call forwarding rules","operationId":"getCallForwardingRulesGrid","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCallForwardingRulesGrid"}}}}},"x-order":43}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/virtual-wans/delete-check":{"get":{"tags":["Wired Network"],"summary":"Check Virtual Wan Used","description":"check configurations who have used current virtualWan","operationId":"checkVirtualWanUsed_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"virtualWanId","in":"query","description":"Virtual WAN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVirtualWanIdUsedOpenApiVO"}}}}},"x-order":57}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/snmp/incompatible-devices":{"get":{"tags":["SNMP"],"summary":"Get the list of site devices that do not support SNMP v3 enhanced configuration","description":"Get the list of site devices that do not support SNMP v3 enhanced configuration.","operationId":"getSnmpIncompatibleDevices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVODeviceVO"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/mdns-exception":{"get":{"tags":["app"],"summary":"Get mDNS Rules configuration status","description":"Get mDNS Rules configuration status of the site with the given omadacId and siteId.","operationId":"getNetworkMdnsExceptionInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMdnsExceptionInfoVO"}}}}},"x-order":30}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/files/dhcp/import-result":{"get":{"tags":["DHCP Reservation"],"summary":"Download DHCP import result","description":"Download DHCP import result.","operationId":"downloadDhcpImportResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/files/dhcp/export":{"get":{"tags":["DHCP Reservation"],"summary":"Export DHCP reservation list to file","description":"Export existed DHCP reservation list to file.","operationId":"exportDhcpReservationListToFile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/service/dhcp/user-list":{"get":{"tags":["DHCP Reservation"],"summary":"Get the dhcp user list of all servers","description":"Get the dhcp user list of all servers.","operationId":"getGridAllDhcpUserList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDhcpUserGridVODhcpUserVO"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/profiles/all-cert-profiles":{"get":{"tags":["CertProfiles"],"summary":"Get certificate profile list","description":"Get certificate profile list.(Pagination).","operationId":"getAllCertProfile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCertProfileOpenApiVO"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/ntp":{"get":{"tags":["Site"],"summary":"Get ntp server status","description":"Get ntp server status.","operationId":"getNtpServerStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/iot/devices":{"get":{"tags":["Bluetooth"],"summary":"Get Bluetooth Advertising Devices","description":"Gets a list of devices that can configure iBeacon.","operationId":"getGridBtIbeaconDevices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GridVOApBtDetailOpenApiVO"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/exist":{"get":{"tags":["Site Configuration"],"summary":"Query site setting exist or not","description":"Query site setting exist or not","operationId":"getExistSiteSettingByOpenApi","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseExistSiteSettingOpenApiVO"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/dns-cache-data":{"get":{"tags":["DNS"],"summary":"Get DNS cache list","description":"Get DNS cache list of the site with the given omadacId and siteId.","operationId":"getDnsCacheList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"dnsCacheQueryVO","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DnsCacheQueryOpenApiV2VO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDnsCacheOpenApiVO"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/available-virtual-wans":{"get":{"tags":["Wired Network"],"summary":"Query available virtual WAN list","description":"Query available virtual WAN list.","operationId":"getAvailableVirtualWan","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVirtualWanAvailablesOpenApiVO"}}}}},"x-order":33}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/auto-free-auth-policy":{"get":{"tags":["Access Control"],"summary":"Get automatically generated free auth policy items","description":"Get automatically generated free auth policy items of the site with the given omadacId and siteId.","operationId":"getAutoFreeAuthPolicy","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListAutoFreeAuthPolicyOpenApi"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/rrm/incompatible":{"get":{"tags":["Rrm"],"summary":"Get incompatible rrm ap list","description":"Get incompatible rrm ap list","operationId":"getRrmIncompatibleAps","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name,mac","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVORrmIncompatibleApOpenApiVO"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/routing/static-routings/interfaces":{"get":{"tags":["Routing"],"summary":"Get static routing interface list","description":"Get static routing interface list.","operationId":"getStaticRoutingInterfaceList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseStaticRoutingInterfaceResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/rogue-ap/export/{format}":{"get":{"tags":["Data Export"],"summary":"Export site Rogue AP scan results","description":"Export site Rogue AP scan results.","operationId":"exportSiteRogueApZipFile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"format","in":"path","description":"The type of the exported file. 0: CSV, 1: xlsx.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/rfplanning/history":{"get":{"tags":["WLAN Optimization"],"summary":"get RF Planning Deploy History","description":"check whether RF Planning has been successfully executed before.","operationId":"getRFPlanningDeployHistory","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RF Planning Deploy Result"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/rfPlanning":{"get":{"tags":["WLAN Optimization"],"summary":"get Radio Frequency Planning Config","description":"get Radio Frequency Planning Config","operationId":"getRadioFrequencyPlanningConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseRF Planning Config"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/rfPlanning/result":{"get":{"tags":["WLAN Optimization"],"summary":"get Radio Frequency Planning Result","description":"get Radio Frequency Planning Result","operationId":"getRadioFrequencyPlanningResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseRF Planning Result"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/rfPlanning/history/timeline":{"get":{"tags":["WLAN Optimization"],"summary":"Get the planningHistory Time Line","description":"Get the planningHistory drawing of the past period of time","operationId":"getTimeLinePlanningHistorys","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"end time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"type","in":"query","description":"type：0-day,1-week","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePlanningHistoryListVO"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/sites/{siteId}/rfPlanning/history/last20times":{"get":{"tags":["WLAN Optimization"],"summary":"get Last 20 PlanningHistorys","description":"get Last 20 PlanningHistorys","operationId":"getLast20PlanningHistorys","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/rfPlanning/dashboard":{"get":{"tags":["WLAN Optimization"],"summary":"Get RRM AI time line","description":"Get RRM AI time line","operationId":"queryRFPlanningBoard","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWlanOptDashBoardOpenApiVO"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sites/{siteId}/rfPlanning/dashboard/status":{"get":{"tags":["WLAN Optimization"],"summary":"Get RRM AI dashboard status","description":"Get RRM AI dashboard status","operationId":"queryRFPlanningBoardStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWlanOptDashBoardOpenApiVO"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sites/{siteId}/rfPlanning/dashboard/history":{"get":{"tags":["WLAN Optimization"],"summary":"Get RRM AI dashboard history time line","description":"Get RRM AI dashboard history time line","operationId":"queryRFPlanningDashboardHistory","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWlanOptDashBoardOpenApiVO"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/report/{tabId}":{"get":{"tags":["Report v2"],"summary":"Get all cards in a tab","description":"Get all cards in a tab","operationId":"getTabById","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"tabId","in":"path","description":"tab ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/report/allTabs":{"get":{"tags":["Report v2"],"summary":"Get report all tabs","description":"Get report all tabs","operationId":"getAllTabs","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListReportTab"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/remoteSites":{"get":{"tags":["VPN"],"summary":"List Remote Site","description":"List Remote Site.","operationId":"listRemoteSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMapStringObject"}}}}},"x-order":38}},"/openapi/v1/{omadacId}/sites/{siteId}/remoteAccess/tunnel/{tunnelId}/ewebInfo":{"get":{"tags":["Remote Access"],"summary":"Get tunnel eweb info","description":"Get tunnel eweb info","operationId":"getTunnelsEwebInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"tunnelId","in":"path","description":"Remote access tunnel ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseNatTraversalEwebInfoVO"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/remoteAccess/tunnel/status":{"get":{"tags":["Remote Access"],"summary":"Get all remote access tunnel's status","description":"Get all remote access tunnel's status","operationId":"getTunnelsStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseNatTraversalTunnelsStatusVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/remoteAccess/tunnel/deviceTunnel/{localMac}":{"get":{"tags":["Remote Access"],"summary":"Get single device tunnel","description":"Get single device tunnel","operationId":"getSingleDeviceTunnel","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"localMac","in":"path","description":"Mac of the local target device","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseNatTraversalTunnelVO"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/remote-logging/tip":{"get":{"tags":["Log"],"summary":"Get site remote logging setting tip","description":"Get site remote logging setting tip.","operationId":"getRemoteLoggingSettingTip","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"site_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteRemoteLoggingSetting"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sites/{siteId}/quick-action/network-wizard/default-network":{"get":{"tags":["Quick Action"],"summary":"Get default network of the network wizard","description":"Get default network of the network wizard.","operationId":"getNetworkWizardDefaultNetwork","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLanNetworkOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/qos/gateway/wans":{"get":{"tags":["Gateway QoS"],"summary":"Get WAN ports info for Gateway QoS","description":"Get WAN ports info for Gateway QoS.","operationId":"getQosWans","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseDataVOQosBwcWanInfoOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/wifi-calling/grid/summary":{"get":{"tags":["Wi-Fi Calling Traffic"],"summary":"Get Wi-Fi Calling Summary","description":"Get Wi-Fi Calling Summary.","operationId":"getGridWifiCallingTrafficResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"topK","in":"query","description":"Get the top-k SSIDs or EPDGs based on voice call traffic statistics. Parameter [topK] should not be null when parameter [queryTopEPDG] or parameter [queryTopEPDG] is true.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"queryTopSsid","in":"query","description":"Whether to query top k ssids by traffic.","required":true,"schema":{"type":"boolean"}},{"name":"queryTopEPDG","in":"query","description":"Whether to query top k ePDGs by traffic.","required":true,"schema":{"type":"boolean"}},{"name":"queryClients","in":"query","description":"Whether to query client history.","required":true,"schema":{"type":"boolean"}},{"name":"queryClientsByMac","in":"query","description":"Whether to query client history by client MAC.","required":true,"schema":{"type":"boolean"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.apName","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.carrierName","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.wifiCallingProfileName","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.clientName","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.ip","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.domain","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.trafficDown","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.trafficUp","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.totalTraffic","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.clientMac","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.priority","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.ssid","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.startTime","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.endTime","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"filters.timeStart","in":"query","description":"Filter query parameters, support field time range: start timestamp (second).","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.timeEnd","in":"query","description":"Filter query parameters, support field time range: end timestamp (second).","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field clientName,clientMac,ip,ssid,domain","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWifiCallingTrafficGridOpenApiVOWifiCallingTrafficOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/service-type-summary":{"get":{"tags":["Profiles"],"summary":"Get all Gateway QoS Service's ID and name info","description":"Get all Gateway QoS Service's ID and name info.","operationId":"getServiceTypeSummary","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseDataVOGatewayQosServiceSummaryOpenApiVO"}}}}},"x-order":90}},"/openapi/v1/{omadacId}/sites/{siteId}/profiles/groups/{groupType}":{"get":{"tags":["Profiles"],"summary":"Get group profile list by type","description":"Get a certain type of group profile list of the site with the given omadacId and siteId and type.","operationId":"getGroupProfilesByType","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"groupType","in":"path","description":"Type of group profile, 0:IP Group; 1:IP Port Group; 2：Mac Group; 3:IPv6 Group; 4:IPv6 Port Group; 5:Country Group; 7:Domain Group.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListGroupOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/ppsk-profiles":{"get":{"tags":["Profiles"],"summary":"Get PPSK profiles list","description":"Get PPSK profiles list","operationId":"getPPSKProfiles","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListPpskProfileBriefInfo"}}}}},"x-order":19},"delete":{"tags":["Profiles"],"summary":"Delete All PPSK profiles","description":"Delete All PPSK profiles","operationId":"deleteAllPPSKProfiles","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/sites/{siteId}/portals":{"get":{"tags":["Authentication"],"summary":"Get portal list in a site","description":"Get portal list with the given omadacId, siteId.","operationId":"getPortalList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListPortalResOpenApiVO"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/portals/logout-enabled":{"get":{"tags":["Authentication"],"summary":"Gets a list of logout enabled portals on the site","description":"Gets a list of logout enabled portals on the site","operationId":"getPortalListWithLogoutEnabled","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListString"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/portal/{portalId}/customization":{"get":{"tags":["Authentication"],"summary":"Get portal customization","description":"Get portal customization information with the given omadacId, siteId and portalId.","operationId":"getPortalCustomization","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"portalId","in":"path","description":"Portal ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePortalCustomizationPageResOpenApiVO"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sites/{siteId}/portal/setting/domain":{"get":{"tags":["Authentication"],"summary":"Get Portal Domain","description":"Get portal domain setting with the given omadacId and siteId.","operationId":"getGlobalPortalDomainSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGlobalPortalDomainOpenApiVO"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/port-status-ports":{"get":{"tags":["Schedule"],"summary":"Get device ports list supporting port schedule","description":"Get device ports list supporting port schedule","operationId":"getPortSchedulePorts","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListPort Device Detail."}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/poe-ports":{"get":{"tags":["Schedule"],"summary":"Get PoE ports list","description":"Get PoE ports list","operationId":"getPoePortsList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListPoe Device Detail."}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/planningHistory":{"get":{"tags":["WLAN Optimization"],"summary":"get Gird Planning Historys","description":"get Gird Planning Historys","operationId":"getGirdPlanningHistorys","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GridVORF Planning History"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/planningHistoryByTime":{"get":{"tags":["WLAN Optimization"],"summary":"Get the planningHistory","description":"Get the planningHistory by time","operationId":"getPlanningHistorysByTime","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"currentPage","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"currentPageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"start","in":"query","description":"start time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"end time","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVORF Planning History"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sites/{siteId}/oui-profiles/all":{"get":{"tags":["Profiles"],"summary":"Get OUI profile summary list","description":"Get OUI profile summary list.","operationId":"getOuiProfileFullList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOuiProfileSummaryOpenApiVO"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/ospf/device":{"get":{"tags":["OSPF"],"summary":"Get Ospf Device list","description":"Get Ospf Device list.","operationId":"getOspfDevice","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOspfDeviceOpenApiVO"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/system/system-info/configs":{"get":{"tags":["OLT"],"summary":"Get OLT description info","description":"Get OLT description info","operationId":"getConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSystemInfoAppDTO"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/system/management-system-interface/get":{"get":{"tags":["OLT"],"summary":"Get OLT Management System Interface list","description":"Get OLT Management System Interface list.","operationId":"getManagementSystemInterfaces","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseManagementSystemInterfaceDTO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-ports/page":{"get":{"tags":["OLT Service Port"],"summary":"Get service port page","description":"Get service port page","operationId":"getServicePortPage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ServicePortQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePageResponseServicePortVO"}}}}},"x-order":64}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-ports/list":{"get":{"tags":["OLT Service Port"],"summary":"Get service port list","description":"Get service port list","operationId":"getServicePortList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ServicePortQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListServicePortVO"}}}}},"x-order":64}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-port/statistics/page":{"get":{"tags":["OLT Service Port"],"summary":"Get statistic info page","description":"Get statistic info page","operationId":"getStatisticInfoPage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/StatisticInfoQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePageResponseStatisticInfoDTO"}}}}},"x-order":64}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-port/statistics/list":{"get":{"tags":["OLT Service Port"],"summary":"Get statistic info list","description":"Get statistic info list","operationId":"getStatisticInfoList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/StatisticInfoQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListStatisticInfoDTO"}}}}},"x-order":64}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-port/statistics/detail":{"get":{"tags":["OLT Service Port"],"summary":"Get statistic info detail","description":"Get statistic info detail","operationId":"getStatisticInfoDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/StatisticInfoDetailQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseStatisticInfoDetailDTO"}}}}},"x-order":64}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/service-port/statistic/configs":{"get":{"tags":["OLT Service Port"],"summary":"Get auto refresh config","description":"Get auto refresh config","operationId":"getAutoRefreshConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseStatisticConfigDTO"}}}}},"x-order":64}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/traffic/profiles/page":{"get":{"tags":["OLT Traffic Profile"],"summary":"Get traffic profile page","description":"Get traffic profile page","operationId":"getTrafficProfilePage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/TrafficProfilePageQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePageResponseTrafficProfileVO"}}}}},"x-order":60}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/traffic/profiles/list":{"get":{"tags":["OLT Traffic Profile"],"summary":"Get traffic profile list","description":"Get traffic profile list","operationId":"getTrafficProfileList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/TrafficProfileListQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListTrafficProfileVO"}}}}},"x-order":60}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/service/{serviceId}/pots-ports/list":{"get":{"tags":["OLT ONT Port"],"summary":"Get ont pots port list","description":"Get ont pots port list","operationId":"getOntPotsPortList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"serviceId","in":"path","description":"Service Profile ID should be a number between 0-512","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OntPotsPortListQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOntPotsPortDTO"}}}}},"x-order":56}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/service/{serviceId}/eth-ports/list":{"get":{"tags":["OLT ONT Port"],"summary":"Get ont eth port list","description":"Get ont eth port list","operationId":"getOntEthPortList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"serviceId","in":"path","description":"Service Profile ID should be a number between 0-512","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OntEthPortListQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOntEthPortDTO"}}}}},"x-order":56}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/service/profiles/page":{"get":{"tags":["OLT Service Profile"],"summary":"Get service profile page","description":"Get service profile page","operationId":"getServiceProfilePage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ServiceProfilePageQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePageResponseServiceProfileVO"}}}}},"x-order":58}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/service/profiles/list":{"get":{"tags":["OLT Service Profile"],"summary":"Get service profile list","description":"Get service profile list","operationId":"getServiceProfileList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ServiceProfileListQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListServiceProfileVO"}}}}},"x-order":58}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/service-port/profiles/page":{"get":{"tags":["OLT Service Port Profile"],"summary":"Get service port profile page","description":"Get service port profile page","operationId":"getServicePortProfilePage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ServicePortProfilePageQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePageResponseServicePortProfileDTO"}}}}},"x-order":57}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/service-port/profiles/list":{"get":{"tags":["OLT Service Port Profile"],"summary":"Get service port profile list","description":"Get service port profile list","operationId":"getServicePortProfileList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListServicePortProfileDTO"}}}}},"x-order":57}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/service-port/profiles/detail/page":{"get":{"tags":["OLT Service Port Profile"],"summary":"Get service port profile page detail","description":"Get service port profile page detail","operationId":"getServicePortProfilePageDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ServicePortProfileDetailPageQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePageResponseServicePortProfileListDetailDTO"}}}}},"x-order":57}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/service-port/profiles/detail/list":{"get":{"tags":["OLT Service Port Profile"],"summary":"Get service port profile list detail","description":"Get service port profile list detail","operationId":"getServicePortProfileListDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ServicePortProfileDetailListQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListServicePortProfileListDetailDTO"}}}}},"x-order":57}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/{lineProfileId}/t-conts/page":{"get":{"tags":["OLT T-cont"],"summary":"Get t-cont page","description":"Get t-cont page","operationId":"getTcontPage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"lineProfileId","in":"path","description":"Line Profile ID should be a number between 0-512","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/TcontPageQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePageResponseTcontVO"}}}}},"x-order":59}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/{lineProfileId}/t-conts/list":{"get":{"tags":["OLT T-cont"],"summary":"Get t-cont list","description":"Get t-cont list","operationId":"getTcontList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"lineProfileId","in":"path","description":"Line Profile ID should be a number between 0-512","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/TcontListQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListTcontVO"}}}}},"x-order":59}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/{lineProfileId}/gem-ports/page":{"get":{"tags":["OLT Gem Port"],"summary":"Get gem port page","description":"Get gem port page","operationId":"getGemPortPage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"lineProfileId","in":"path","description":"Line Profile ID should be a number between 0-512","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GemPortPageQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePageResponseGemPortDTO"}}}}},"x-order":54}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/{lineProfileId}/gem-ports/list":{"get":{"tags":["OLT Gem Port"],"summary":"Get gem port list","description":"Get gem port list","operationId":"getGemPortList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"lineProfileId","in":"path","description":"Line Profile ID should be a number between 0-512","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GemPortListQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListGemPortDTO"}}}}},"x-order":54}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/{lineProfileId}/gem-mappings/page":{"get":{"tags":["OLT Gem Mapping"],"summary":"Get gem mapping page","description":"Get gem mapping page","operationId":"getGemMappingPage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"lineProfileId","in":"path","description":"Line Profile ID should be a number between 0-512","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GemMappingPageQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePageResponseGemMappingDTO"}}}}},"x-order":53}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/{lineProfileId}/gem-mappings/list":{"get":{"tags":["OLT Gem Mapping"],"summary":"Get gem mapping list","description":"Get gem mapping list","operationId":"getGemMappingList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"lineProfileId","in":"path","description":"Line Profile ID should be a number between 0-512","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GemMappingListQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListGemMappingDTO"}}}}},"x-order":53}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/profiles/page":{"get":{"tags":["OLT Line Profile"],"summary":"Get line profile page","description":"Get line profile page","operationId":"getLineProfilePage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/LineProfilePageQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePageResponseLineProfileVO"}}}}},"x-order":55}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/line/profiles/list":{"get":{"tags":["OLT Line Profile"],"summary":"Get line profile list","description":"Get line profile list","operationId":"getLineProfileList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/LineProfileListQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListLineProfileVO"}}}}},"x-order":55}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/dba/profiles/page":{"get":{"tags":["OLT DBA"],"summary":"Get DBA profile page","description":"Get DBA profile page","operationId":"getDBAProfilePage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DBAProfilePageQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePageResponseDBAProfileVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/profile/dba/profiles/list":{"get":{"tags":["OLT DBA"],"summary":"Get DBA profile list","description":"Get DBA profile list","operationId":"getDBAProfileList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DBAProfileListQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListDBAProfileVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/pon-port/informations/page":{"get":{"tags":["OLT Pon Port"],"summary":"Get pon port information page","description":"Get pon port information page","operationId":"getPonPortInformationPage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/BaseDevicePageQueryRequest"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePageResponsePonPortInformationDTO"}}}}},"x-order":63}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/pon-port/informations/list":{"get":{"tags":["OLT Pon Port"],"summary":"Get pon port information list","description":"Get pon port information list","operationId":"getPonPortInformationList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListPonPortInformationDTO"}}}}},"x-order":63}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/pon-port/configs/page":{"get":{"tags":["OLT Pon Port"],"summary":"Get pon port page","description":"Get pon port page","operationId":"getPonPortPage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/BaseDevicePageQueryRequest"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePageResponsePonPortDTO"}}}}},"x-order":63}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/pon-port/configs/list":{"get":{"tags":["OLT Pon Port"],"summary":"Get pon port list","description":"Get pon port list","operationId":"getPonPortList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListPonPortDTO"}}}}},"x-order":63}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/autofinds/page":{"get":{"tags":["OLT ONU Register"],"summary":"get ONU auto find config page","description":"get ONU auto find config page","operationId":"getOnuAutofindConfigPage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OnuRegisterAutoFindPageQueryRequestDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePageResponseOnuAutofindConfigDTO"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/autofinds/list":{"get":{"tags":["OLT ONU Register"],"summary":"Get ONU auto find config list","description":"Get ONU auto find config list","operationId":"getOnuAutofindConfigList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OnuRegisterAutoFindPageQueryRequestDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOnuAutofindConfigDTO"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/autofind/configs/get":{"get":{"tags":["OLT ONU Register"],"summary":"Get ONU register auto find config","description":"Get ONU register auto find config","operationId":"getOnuRegisterAutofindConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAutofindConfigDTO"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/auto-authentication/rules/page":{"get":{"tags":["OLT ONU Register"],"summary":"Get ONU auto authentication rule page","description":"Get ONU auto authentication rule page","operationId":"getOnuAutoAuthenticationRuleConfigPage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OnuRegisterAuthenticationPageQueryRequestDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePageResponsePonAutoAuthenticationRuleConfigDTO"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/auto-authentication/rules/list":{"get":{"tags":["OLT ONU Register"],"summary":"Get ONU auto authentication rule list","description":"Get ONU auto authentication rule list","operationId":"getOnuAutoAuthenticationRuleConfigList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OnuRegisterAuthenticationPageQueryRequestDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListPonAutoAuthenticationRuleConfigDTO"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/auto-authentication/port-configs/get":{"get":{"tags":["OLT ONU Register"],"summary":"Get ONU pon auto authentication config","description":"Get ONU pon auto authentication config","operationId":"getOnuPonAutoAuthenticationConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/PonPortRequestDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePonAutoAuthenticationConfigDTO"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/auto-authentication/global/configs/get":{"get":{"tags":["OLT ONU Register"],"summary":"Get ONU auto authentication config","description":"Get ONU auto authentication config","operationId":"getOnuAutoAuthenticationConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAutoAuthenticationConfigDTO"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/authentications/page":{"get":{"tags":["OLT ONU Register"],"summary":"Get authentication config page","description":"Get authentication config page","operationId":"getAuthenticationConfigPage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OnuRegisterAuthenPageQueryRequestDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePageResponseAuthenticationConfigDTO"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-register/authentications/list":{"get":{"tags":["OLT ONU Register"],"summary":"Get authentication config list","description":"Get authentication config list","operationId":"getAuthenticationConfigList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OnuRegisterAuthenPageQueryRequestDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListAuthenticationConfigDTO"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-management/informations/reboot-status/list":{"get":{"tags":["OLT ONU Management"],"summary":"Get ONU reboot status","description":"Get ONU reboot status","operationId":"getOnuRebootStatusConfigList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOnuInformationRebootStatusConfigDTO"}}}}},"x-order":61}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-management/informations/page":{"get":{"tags":["OLT ONU Management"],"summary":"Get ONU information config page","description":"Get ONU information config page","operationId":"getOnuInformationConfigPage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OnuManagementPageQueryRequestDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePageResponseOnuInformationConfigDTO"}}}}},"x-order":61}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-management/informations/list":{"get":{"tags":["OLT ONU Management"],"summary":"Get ONU information config list","description":"Get ONU information config list","operationId":"getOnuInformationConfigList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OnuManagementListQueryRequestDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOnuInformationConfigDTO"}}}}},"x-order":61}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-management/informations/detail/get":{"get":{"tags":["OLT ONU Management"],"summary":"Get ONU information detail","description":"Get ONU information detail","operationId":"getOnuInformationDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OnuInfoDetailRequestDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOnuDetailConfigDTO"}}}}},"x-order":61}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-management/global-config/isolation/get":{"get":{"tags":["OLT ONU Management"],"summary":"Get ONU isolation status","description":"Get ONU isolation status","operationId":"getOnuIsolationStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOnuIsolationStatusDTO"}}}}},"x-order":61}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/onu-management/global-config/get":{"get":{"tags":["OLT ONU Management"],"summary":"Get ONU global config status","description":"Get ONU global config status","operationId":"getOnuGlobalConfigStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOnuGlobalConfigStatusDTO"}}}}},"x-order":61}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/auto-service-ports/page":{"get":{"tags":["OLT Service Port"],"summary":"Get auto service port config page","description":"Get auto service port config page","operationId":"getAutoServicePortConfigPage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/AutoServicePortQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePageResponseAutoServicePortVO"}}}}},"x-order":64}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/pon/auto-service-ports/list":{"get":{"tags":["OLT Service Port"],"summary":"Get auto service port list","description":"Get auto service port list","operationId":"getAutoServicePortList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/AutoServicePortQueryDTO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListAutoServicePortVO"}}}}},"x-order":64}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/l2-feature/eth-port/port/unit1/list":{"get":{"tags":["OLT"],"summary":"Get ETH Unit1 port list of olt","description":"Get ETH Unit1 port list of olt","operationId":"getPortsConfigList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListEthUnit1PortAppDTO"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/l2-feature/eth-port/port/lags/list":{"get":{"tags":["OLT"],"summary":"Get ETH LAG(Link Aggregation Group) config list","description":"Get ETH LAG(Link Aggregation Group) config list","operationId":"getLagsConfigList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListEthLagPortAppDTO"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/olts/{deviceMac}/eth-port/and/pon-port/list":{"get":{"tags":["OLT"],"summary":"Get pon port and eth port of OLT","description":"Get pon port and eth port of OLT","operationId":"getEthAndPonList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseEthAndPonListDTO"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/vlans/{vlan}/switches":{"get":{"tags":["Switch"],"summary":"Get the paging query for the osws with given network id and vlan","description":"Get the paging query for the osws with given network id and vlan","operationId":"getOswForGivenLanNetworkIdAndVlan","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"networkId","required":true,"schema":{"type":"string"}},{"name":"vlan","in":"path","description":"vlan","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":47}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/vlan/{vlan}/ssids":{"get":{"tags":["Wired Network"],"summary":"Get grid ssid list that use the vlan","description":"Get grid ssid list that use the vlan","operationId":"getVlanNetworkAffectedSsid_1","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}},{"name":"vlan","in":"path","description":"Vlan ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOVlanNetworkAffectingSsidVO"}}}}},"x-order":95}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/vlan/{vlan}/ports":{"get":{"tags":["Wired Network"],"summary":"Get the ports of devices that use the network","description":"Get the ports of devices that use the network","operationId":"getGridVlanNetworkAffectedDevicePorts","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}},{"name":"vlan","in":"path","description":"Vlan ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVlanForPortDisplayGridVOVlanNetworkAffectingDeviceDetailVO"}}}}},"x-order":64}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/vlan/{vlan}/devices":{"get":{"tags":["Wired Network"],"summary":"Get devices list that use the network","description":"Get devices list that use the network","operationId":"getVlanNetworkAffectedDevice_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}},{"name":"vlan","in":"path","description":"Vlan ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListVlanNetworkAffectingDeviceVO"}}}}},"x-order":63}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/vlan/{vlan}/device-support-ports":{"get":{"tags":["Wired Network"],"summary":"Get device port info on whether support current vlan","description":"Get device port info on whether support current vlan","operationId":"getVlanNetworkDevicePortSupportVlanInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}},{"name":"vlan","in":"path","description":"Vlan ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVlanNetworkDeviceSupportInfoVO"}}}}},"x-order":101}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/process":{"get":{"tags":["Wired Network"],"summary":"Get network delivering process and config","description":"Get network delivering process and config","operationId":"getDeliveringProcess","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVlanNetworkDeliverDataVO"}}}}},"x-order":72}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/dhcp-server/capabilities":{"get":{"tags":["Wired Network"],"summary":"Get the capabilities of the DHCP server under the network","description":"Get the capabilities of the DHCP server under the network.","operationId":"getDhcpServerDevCapForNetwork","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDhcpServerDevCapForVlanVO"}}}}},"x-order":94}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/dhcp-server-info":{"get":{"tags":["Wired Network"],"summary":"Get the address pool of the DHCP server under the network and the number of available IPs","description":"Get the address pool of the DHCP server under the network and the number of available IPs.","operationId":"getDhcpServerInfoForNetwork","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDhcpServerForVlanVO"}}}}},"x-order":90}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/{networkId}/brief-process":{"get":{"tags":["Wired Network"],"summary":"Get network delivering process","description":"Get network delivering process","operationId":"getDeliveringProcessWithoutConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"networkId","in":"path","description":"Network ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVlanNetworkDeliverBriefDataVO"}}}}},"x-order":73}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/vlans":{"get":{"tags":["Wired Network"],"summary":"Get the networks whose purpose is vlan","description":"Get the networks whose purpose is vlan","operationId":"getGridVlans","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOVlanLanNetworkForBtachDeleteVO"}}}}},"x-order":91}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/server-for-reservation":{"get":{"tags":["Wired Network"],"summary":"Get all networks that can reserve IP addresses and their corresponding servers","description":"Get all networks that can reserve IP addresses and their corresponding servers.","operationId":"getNetworksWithServersForReservation","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDhcpServerInfoUnderNetworkVO"}}}}},"x-order":92}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/devices":{"get":{"tags":["Wired Network"],"summary":"Get devices list that can be dhcp server","description":"Get devices list that can be dhcp server","operationId":"getGridSupportVlanNetworkDevicesBySite","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVODeviceVO"}}}}},"x-order":65}},"/openapi/v1/{omadacId}/sites/{siteId}/networks/client":{"get":{"tags":["Wired Network"],"summary":"Get client list","description":"Get all clients.","operationId":"getGridAllClients_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field ","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVONetworkClientAllOpenApiVO"}}}}},"x-order":93}},"/openapi/v1/{omadacId}/sites/{siteId}/network-security/ips/signature":{"get":{"tags":["IDS/IPS"],"summary":"Get signature list","description":"Get signature list","operationId":"getGridSignature","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOIpsSignatureInfo"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/network-security/ips/grid/block-list":{"get":{"tags":["IDS/IPS"],"summary":"Get grid IPS block list","description":"Obtain the grid IPS block list.","operationId":"getGridBlockList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field Name/Source Ip/Destination","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOIps Block List Entry"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/network-security/ips/grid/allow-list":{"get":{"tags":["IDS/IPS"],"summary":"Get grid ips allow list","description":"Obtain grid allow list.","operationId":"getGridAllowList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field IP / Subnet","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/multi-devices/rolling-upgrade-tasks/{taskId}":{"get":{"tags":["Device"],"summary":"Get the result of the given rolling upgrade task","description":"Get the result of the rolling upgrade task. The results include whether the task is finished and how many devices have not completed the upgrade.","operationId":"getRollingUpgradeRes","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"taskId","in":"path","description":"Task ID. The ID is the return value of 'Start batch rolling upgrade' interface.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseRollingUpgradeRes"}}}}},"x-order":107},"delete":{"tags":["Device"],"summary":"End the rolling upgrade task","description":"Cancel the rolling upgrade task in the site. But the devices which have completed the upgrade will not be rolled back to the old version","operationId":"cancelRollingUpgrade","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"taskId","in":"path","description":"Task ID. The ID is the return value of 'Start batch rolling upgrade' interface.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":108}},"/openapi/v1/{omadacId}/sites/{siteId}/multi-devices/manually-upgrade-tasks/{taskId}":{"get":{"tags":["Device"],"summary":"Get the result of the given manually upgrade task","description":"Get the result of the manually upgrade task. The results include whether the task is finished and how many devices have not completed the upgrade.","operationId":"getManuallyUpgradeRes","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"taskId","in":"path","description":"Task ID. The ID is the return value of 'Start manually upgrade' interface.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUpgradeRes"}}}}},"x-order":111}},"/openapi/v1/{omadacId}/sites/{siteId}/multi-devices/add/{operateId}/status":{"get":{"tags":["Device"],"summary":"Batch get added device status","description":"Batch get added device status.","operationId":"getAddDevicesStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"operateId","in":"path","description":"Add device operation ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceAddProcessRespVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/monitor-device/grids":{"get":{"tags":["Intelli Recover Device"],"summary":"Get the intelli recover device list","description":"Get the intelli recover device list","operationId":"getGridMonitorDevice","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMonitorDevice"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/monitor-device/eligible-device-grids":{"get":{"tags":["Intelli Recover Device"],"summary":"Obtain the list of devices that can be monitored","description":"Obtain the list of devices that can be monitored","operationId":"getEligibleDeviceList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMonitorDevice"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/monitor-client/grids":{"get":{"tags":["Intelli Recover Client"],"summary":"Get the intelli recover client list","description":"Get the intelli recover client list","operationId":"getGridMonitorClient","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMonitorClient"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/monitor-client/eligible-client-grids":{"get":{"tags":["Intelli Recover Client"],"summary":"Obtain the list of clients that can be monitored","description":"Obtain the list of clients that can be monitored","operationId":"getEligibleClientList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMonitorClient"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/mlag/{mlagId}/mlag-ccc/{type}":{"get":{"tags":["Mlag"],"summary":"Get the configuration consistency check result of the M-LAG Group","description":"Get the configuration consistency check result of the M-LAG Group.","operationId":"getMlagCccResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"mlagId","in":"path","description":"M-LAG ID","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","description":"The level of configuration consistency check should be a value as follows: 0:Critical & Significant 1: Critical; 2: Significant","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMapStringOswMlagCccVO"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/mlag/switches":{"get":{"tags":["Mlag"],"summary":"Get support M-LAG group switch list","description":"Get support M-LAG group switch list.","operationId":"listSupportMlagGroupOsws","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMlagSupportOswVO"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/maintenance/backup/files":{"get":{"tags":["Backup and Restore"],"summary":"Get site backup file list in self server","description":"Get site backup file list in self server.","operationId":"getSelfServerSiteFileList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BackupFileListVO"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/mac-filters/deny":{"get":{"tags":["MAC Filtering"],"summary":"Get deny MAC filtering list","description":"Get deny MAC filtering list.","operationId":"getGridDenyMacFiltering","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMacFiltering"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/mac-filters/allow":{"get":{"tags":["MAC Filtering"],"summary":"Get allow MAC filtering list","description":"Get allow MAC filtering list.","operationId":"getGridAllowMacFiltering","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMacFiltering"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/mac-auth/ssids":{"get":{"tags":["Authentication"],"summary":"Get ssids that support MAC auth","description":"Get ssid list that support MAC-Based Authentication with the given omadacId and siteId.","operationId":"getMacAuthSsids_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListWlanSimpleOpenApiVO"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/logs/events":{"get":{"tags":["Log"],"summary":"Get site event log list","description":"Get logs in site event log page.","operationId":"getEventLogsForSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.timeStart","in":"query","description":"Filter query parameters, support field 1679297710438","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.timeEnd","in":"query","description":"Filter query parameters, support field 1681889710438","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.module","in":"query","description":"Filter query parameters, support field module, it should be a value as follows: System, Device, Client","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseEventLogGridVOEventLogOpenApiVO"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/logs/alerts":{"get":{"tags":["Log"],"summary":"Get site alert log list","description":"Get logs in site alert log page.","operationId":"getAlertLogsForSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.timeStart","in":"query","description":"Filter query parameters, support field 1679297710438","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.timeEnd","in":"query","description":"Filter query parameters, support field 1681889710438","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.module","in":"query","description":"Filter query parameters, support field module, it should be a value as follows: System, Device, Client","required":false,"schema":{"type":"string"}},{"name":"filters.resolved","in":"query","description":"Filter query parameters, support field resolved, it should be a value as follows: true, false","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAlertLogGridVOAlertLogOpenApiVO"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/lan-switch-setting":{"get":{"tags":["Wired Network"],"summary":"Get switch port profile info","description":"Get switch port profile info.(Pagination)","operationId":"getOswPortLanNetInfo","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GridVOOswProfileOpenApiVO"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/lan-profiles/{profileId}/es":{"get":{"tags":["Wired Network"],"summary":"Query Agile Series switches that used the profile","description":"Query Agile Series switches that used the profile.(Pagination)","operationId":"getUseLanProfileES","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"profileId","in":"path","description":"Switch profile ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOUseProfileOswOpenApiVO"}}}}},"x-order":30}},"/openapi/v1/{omadacId}/sites/{siteId}/lan-networks/interface":{"get":{"tags":["Wired Network"],"summary":"Get all \"single\"/\"multi\" interface lan network","description":"Get all \"single\"/\"multi\" interface lan network. This interface has been deprecated. Please use the following interface instead: Get all \"single\"/\"multi\" interface lan network V2","operationId":"getInterfaceLanNetwork","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Interface vlan type. When \"type\" is 0, return \"single\" interface lan network, else return \"single\"/\"multi\" interface lan network","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseResponseDataVOLanNetworkQueryOpenApiVO"}}}}},"deprecated":true,"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/lan-networks/all":{"get":{"tags":["Wired Network"],"summary":"Get all networks for the omada id and site id","description":"Get all networks for the omada id and site id","operationId":"getAllLanNetworks","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListLanNetworkVO"}}}}},"x-order":74}},"/openapi/v1/{omadacId}/sites/{siteId}/ips/threat/{threatId}":{"get":{"tags":["Threat Management"],"summary":"Get threat entry detail","description":"Get threat entry detail.","operationId":"getThreatDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"threatId","in":"path","description":"threatId","required":true,"schema":{"type":"string"}},{"name":"time","in":"query","description":"Timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGet Ips Threat Detail"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/ips/grid/threat-management":{"get":{"tags":["Threat Management"],"summary":"Get grid threat list","description":"Get grid threat list.","operationId":"getThreatList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"archived","in":"query","description":"archived","required":true,"schema":{"type":"boolean"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.startTime","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.endTime","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.severity","in":"query","description":"Threat Severity, such as 0:Critical, 1: Major, 2:Moderate, 3:Minor, 4:Low","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.time","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field Threat Description/Classification/Classification Description","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOGet Grid Ips Threat"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/internet":{"get":{"tags":["Wired Network"],"summary":"Get internet info","description":"Get internet info.","operationId":"getInternet","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseInternetOpenApiVO"}}}}},"x-order":50}},"/openapi/v1/{omadacId}/sites/{siteId}/internet/models":{"get":{"tags":["Wired Network"],"summary":"Get supported gateway model list for pre-configuration","description":"Get ID and name of supported gateway models for pre-configuration.","operationId":"getSupportInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSupportOsgModelOpenApiAppVO"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/sites/{siteId}/internet/location-isp":{"get":{"tags":["Wired Network"],"summary":"Get location and ISP info","description":"Get index and name of location and ISP in usb wan port configuration.","operationId":"getLocationAndIspInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseLocationAndIspInfoOpenApiVO"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sites/{siteId}/internet/load-balance/status":{"get":{"tags":["Wired Network"],"summary":"Check Wan Loadbalance status","description":"Check Wan Loadbalance weight modified or not","operationId":"getLoadBalanceWeightStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":58}},"/openapi/v1/{omadacId}/sites/{siteId}/internet/isp-scan/{portUuid}":{"get":{"tags":["Wired Network"],"summary":"Get Isp scan result","description":"Get result of Isp scan","operationId":"getIspScanResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"portUuid","in":"path","description":"Port Uuid to be scanned","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseIspScanResultOpenApiVO"}}}}},"x-order":54}},"/openapi/v1/{omadacId}/sites/{siteId}/internet/band-scan/{portUuid}":{"get":{"tags":["Wired Network"],"summary":"Get band scan result.","description":"Get result of band scan.","operationId":"getBandScanResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"portUuid","in":"path","description":"Port uuid to get band scan result","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseBandScanResultOpenApiVO"}}}}},"x-order":55}},"/openapi/v1/{omadacId}/sites/{siteId}/intelli-recover/auto-setting/config":{"get":{"tags":["Intelli Recover Device"],"summary":"Get intelli recover setting","description":"Get intelli recover setting","operationId":"getIntelliRecoverSetting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseIntelliRecoverSetting"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/insight/wids":{"get":{"tags":["Insight"],"summary":"Query the Wireless IDS entry list","description":"Query the Wireless IDS entry list","operationId":"getGridWidsData","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOWidsDataOpenApiVO"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/insight/wids/blacklist":{"get":{"tags":["Insight"],"summary":"Get the dynamic blacklist entry data of Wireless IDS","description":"Get the dynamic blacklist entry data of Wireless IDS","operationId":"getGridWipsBlackList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOWipsBlackListOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/insight/routing/{type}":{"get":{"tags":["Insight"],"summary":"Get the routing table data interface","description":"Get the routing table data interface","operationId":"getGridRouting","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","description":"Device type, the type should be gateway, switch.","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOswRoutingOpenApiVO"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/insight/rogueaps":{"get":{"tags":["Insight"],"summary":"Query the Rogue AP scan results","description":"Query the Rogue AP scan results","operationId":"getGridRogueAps","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVORogue AP Scan Result Entry"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sites/{siteId}/insight/port-forwarding/{type}":{"get":{"tags":["Insight"],"summary":"Get Port Forwarding Status","description":"Get Port Forwarding Status","operationId":"getPortForwardStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","description":"User/UPnP","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOPortForwardingOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/insight/past-connection":{"get":{"tags":["Client Insight"],"summary":"Get client past connection list","description":"Get client past connection list.","operationId":"getGridPastConnections","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.lastSeen","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"filters.timeStart","in":"query","description":"Filter query parameters, support field time range: start timestamp (ms).","required":false,"schema":{"type":"string"}},{"name":"filters.timeEnd","in":"query","description":"Filter query parameters, support field time range: end timestamp (ms).","required":false,"schema":{"type":"string"}},{"name":"filters.guest","in":"query","description":"Filter query parameters, support field guest: true/false.","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name,mac,ssid.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOClient History Info"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/insight/clients":{"get":{"tags":["Client Insight"],"summary":"Get known clients list","description":"Get known clients list.","operationId":"getGridKnownClients","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.lastSeen","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"filters.timeStart","in":"query","description":"Filter query parameters, support field time range: start timestamp (ms).","required":false,"schema":{"type":"string"}},{"name":"filters.timeEnd","in":"query","description":"Filter query parameters, support field time range: end timestamp (ms).","required":false,"schema":{"type":"string"}},{"name":"filters.guest","in":"query","description":"Filter query parameters, support field guest: true/false.","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name,mac,ssid.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOKnownClientVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/incident/{mac}":{"get":{"tags":["Incidents"],"summary":"Get grid device incident List","description":"Get device incident list.","operationId":"getGridDeviceIncidentList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filters.status","in":"query","description":"Incident status filter","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.startTime","in":"query","description":"Start time in milliseconds","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"filters.endTime","in":"query","description":"End time in milliseconds","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAnomalyGridVOAnomalyAggregateVO"}}}}}}},"/openapi/v1/{omadacId}/sites/{siteId}/incident/stack/{stackId}":{"get":{"tags":["Incidents"],"summary":"Get grid stack incident list","description":"Get incident list for a stack detail page.","operationId":"getGridStackIncidentList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}},{"name":"filters.status","in":"query","description":"Incident status filter. 0: unresolved, 1: resolved, 2: ignored, 3: ongoing, null: all","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.startTime","in":"query","description":"Start time in milliseconds","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"filters.endTime","in":"query","description":"End time in milliseconds","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAnomalyGridVOAnomalyAggregateVO"}}}}}}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/vouchers/{id}":{"get":{"tags":["Voucher"],"summary":"Get a voucher","description":"Get a voucher with the given params.","operationId":"getVoucher","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Voucher ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVoucherOpenApiVO"}}}}},"x-order":14},"delete":{"tags":["Voucher"],"summary":"Delete an existing voucher","description":"Delete an existing voucher with the given params.","operationId":"deleteVoucher","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Voucher ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/vouchers/statistics/summary":{"get":{"tags":["Voucher"],"summary":"Get voucher summary","description":"Get voucher summary of all time in the site.","operationId":"getAllTimeVoucherSummary","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAllTimeVoucherSummaryOpenApiVO"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/vouchers/statistics/summary/voucher-groups/{groupId}":{"get":{"tags":["Voucher"],"summary":"Get voucher summary for voucher group","description":"Get voucher summary of all time in the voucher group.","operationId":"getAllTimeVoucherSummaryForGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"Voucher group ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAllTimeVoucherSummaryOpenApiVO"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/vouchers/statistics/history":{"get":{"tags":["Voucher"],"summary":"Get voucher history statistics","description":"Get voucher history statistics.","operationId":"getVoucherHistoryStatistics","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filters.timeStart","in":"query","description":"Filter query parameters, support field time range: start timestamp (second).","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.timeEnd","in":"query","description":"Filter query parameters, support field time range: end timestamp (second).","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVoucherStatisticsHistoryOpenApiVO"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/vouchers/statistics/history/voucher-groups/{groupId}":{"get":{"tags":["Voucher"],"summary":"Get voucher history statistics of voucher group","description":"Get voucher history statistics of voucher group.","operationId":"getVoucherHistoryStatisticsForGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filters.timeStart","in":"query","description":"Filter query parameters, support field time range: start timestamp (second).","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.timeEnd","in":"query","description":"Filter query parameters, support field time range: end timestamp (second).","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVoucherStatisticsHistoryOpenApiVO"}}}}},"x-order":26}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/vouchers/statistics/history/distribution/unit-price":{"get":{"tags":["Voucher"],"summary":"Get voucher distribution by price","description":"Get voucher distribution by price.","operationId":"getVoucherDistributionByPrice","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filters.timeStart","in":"query","description":"Filter query parameters, support field time range: start timestamp (second).","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.timeEnd","in":"query","description":"Filter query parameters, support field time range: end timestamp (second).","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOVoucherUnitPriceDistributionOpenApiVO"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/vouchers/statistics/history/distribution/unit-price/voucher-groups/{groupId}":{"get":{"tags":["Voucher"],"summary":"Get voucher distribution of voucher group by price","description":"Get voucher distribution of voucher group by price.","operationId":"getVoucherDistributionByPriceForGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.timeStart","in":"query","description":"Filter query parameters, support field time range: start timestamp (second).","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.timeEnd","in":"query","description":"Filter query parameters, support field time range: end timestamp (second).","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOVoucherUnitPriceDistributionOpenApiVO"}}}}},"x-order":27}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/vouchers/statistics/history/distribution/duration":{"get":{"tags":["Voucher"],"summary":"Get voucher distribution by duration","description":"Get voucher distribution by duration.","operationId":"getVoucherDistributionByDuration","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filters.timeStart","in":"query","description":"Filter query parameters, support field time range: start timestamp (second).","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.timeEnd","in":"query","description":"Filter query parameters, support field time range: end timestamp (second).","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOVoucherDurationDistributionOpenApiVO"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/vouchers/statistics/history/distribution/duration/voucher-groups/{groupId}":{"get":{"tags":["Voucher"],"summary":"Get voucher distribution of voucher group by duration","description":"Get voucher distribution of voucher group by duration.","operationId":"getVoucherDistributionByDurationForGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.timeStart","in":"query","description":"Filter query parameters, support field time range: start timestamp (second).","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.timeEnd","in":"query","description":"Filter query parameters, support field time range: end timestamp (second).","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOVoucherDurationDistributionOpenApiVO"}}}}},"x-order":28}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/voucher-groups/{groupId}":{"get":{"tags":["Voucher"],"summary":"Get Voucher Group Detail","description":"Get Voucher Group Detail with the given params.","operationId":"getVoucherGroupDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"Voucher Group ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.code","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"filters.status","in":"query","description":"Filter query parameters, support field status for vouchers in the voucher group: 0: unused vouchers, 1: in-use vouchers, 2: expired vouchers","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field code","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseVoucherGroupGridOpenApiVO"}}}}},"x-order":3},"delete":{"tags":["Voucher"],"summary":"Delete an existing Voucher Group","description":"Delete an existing Voucher Group with the given params.","operationId":"deleteVoucherGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"Voucher Group ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/voucher-groups/{groupId}/print-unused":{"get":{"tags":["Voucher"],"summary":"Get unused vouchers in voucher group","description":"Get unused vouchers brief information in a voucher group.","operationId":"printVoucherGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"Voucher Group ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListVoucherBriefOpenApiVO"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/voucher-groups/currency-list":{"get":{"tags":["Voucher"],"summary":"Get voucher currency candidates","description":"Get voucher currency candidates.","operationId":"getVoucherCurrencyCandidates","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCurrencyCandidatesOpenApiVO"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/voucher-groups/config-limit":{"get":{"tags":["Voucher"],"summary":"Get voucher group config limit","description":"Get voucher group config limit.","operationId":"getGroupConfigLimit","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListVoucherConfigLimitOpenApiVO"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/voucher-group-options":{"get":{"tags":["Voucher"],"summary":"Get voucher group options","description":"Get voucher group options.","operationId":"getVoucherGroupOptions","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOVoucherGroupOptionOpenApiVO"}}}}},"x-order":29}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/surveys/auth-results/{surveyResultId}":{"get":{"tags":["Form Auth Data"],"summary":"Get an authentication survey result for given surveyResultId","description":"Get an authentication survey's result in a site with given omadacId, siteId, surveyResultId.","operationId":"getFormAuthResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"surveyResultId","in":"path","description":"Survey authentication result ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseFormAuthResultOpenApiVO"}}}}},"x-order":5},"delete":{"tags":["Form Auth Data"],"summary":"Delete an authentication survey result for given surveyResultId","description":"Delete an authentication survey result in a site with given omadacId, siteId, surveyResultId.","operationId":"deleteFormAuthResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"surveyResultId","in":"path","description":"Survey authentication result ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/form-auths/{formId}/auth-results":{"get":{"tags":["Form Auth Data"],"summary":"Get Form Authentication Result","description":"Get Form Authentication Result.","operationId":"getGridFormAuthResults","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"formId","in":"path","description":"Form auth Id.","required":true,"schema":{"type":"string"}},{"name":"queryDataVO","in":"query","description":"Query Data","required":true,"schema":{"$ref":"#/components/schemas/OpenApiQueryDataVO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/files/voucher/logos/{picId}":{"get":{"tags":["Voucher"],"summary":"Get voucher logo","description":"Get voucher logo","operationId":"getVoucherLogo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"picId","in":"path","description":"Voucher logo picture id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseObject"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/dashboard/statistics":{"get":{"tags":["Authorized Client"],"summary":"Get hotspot statistic","description":"Get hotspot statistic with the given omadacId and siteId.","operationId":"getHotspotStatistic","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseHotspotStatisticVO"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/authed-records":{"get":{"tags":["Authorized Client"],"summary":"Get authentication record list","description":"Get all authentication records in a site with the given omadacId, siteId.","operationId":"getHotspotAuthedClients","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.mac","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.ip","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.authType","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.ssidOrNetwork","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.download","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.upload","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.status","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.start","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.end","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.duration","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field client_mac,client_name,voucher.code,local_user.user_name,form_name,auth_admin,ssid_name,network_name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOAuthClientOpenApiVO"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/health/timeline":{"get":{"tags":["Health"],"summary":"Get site health time line","description":"Get site health time line","operationId":"getSiteHealthTimeList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteScoreTimelineListVO"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/health/incident/{mac}":{"get":{"tags":["Incidents"],"summary":"Get device/client health incidents","description":"Get incident list for device/client health detail page.","operationId":"getObjectHealthIncident","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filters.startTime","in":"query","description":"Start time in milliseconds","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.endTime","in":"query","description":"End time in milliseconds","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListAnomalyBriefCountVO"}}}}}}},"/openapi/v1/{omadacId}/sites/{siteId}/health/gateways/{gatewayMac}/wans/details":{"get":{"tags":["Gateway"],"summary":"Get enable wan port detail","description":"Get enable wan port detail","operationId":"getEnableWanDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWanDetails"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/health/client/timeline":{"get":{"tags":["Health"],"summary":"Get site client health time line","description":"Get site client health time line","operationId":"getSiteClientHealthTimeList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientScoreTimelineListVO"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sites/{siteId}/grid/full-channel-detect/ap-list":{"get":{"tags":["Insight"],"summary":"Get the list of devices that can perform interference detection by page","description":"Get the list of devices that can perform interference detection by page","operationId":"getGridEnableFullChannelDetectApList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListEnableFullChannelDetectApInfoOpenApiVO"}}}}},"x-order":26}},"/openapi/v1/{omadacId}/sites/{siteId}/grid/devices/upgradeable":{"get":{"tags":["shield"],"summary":"Get upgradeable devices on site view","description":"Get upgradeable devices on site view.","operationId":"getUpgradeableGridDevicesOnSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.ecspFirstVersion","in":"query","description":"Filter query parameters, support field ecsp first version. 1: ecsp v1; 2: ecsp v2","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOUpgradeableDevices"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/grid/devices/pending":{"get":{"tags":["Device"],"summary":"Get adoptable device list of target site","description":"Get adoptable device list of target site.","operationId":"getGridPendingDevicesBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"searchKey","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVODeviceInfo"}}}}},"x-order":42}},"/openapi/v1/{omadacId}/sites/{siteId}/grid/bridge-devices/pending":{"get":{"tags":["Device"],"summary":"Get Bridge group ungrouped devices","description":"Get Bridge group ungrouped devices.","operationId":"getGridPendingBridgeDevicesBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.mac","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchMacs","in":"query","description":"Fuzzy query parameters, support field mac","required":false,"schema":{"type":"string"}},{"name":"searchNames","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}},{"name":"searchModels","in":"query","description":"Fuzzy query parameters, support field model","required":false,"schema":{"type":"string"}},{"name":"searchSns","in":"query","description":"Fuzzy query parameters, support field sn","required":false,"schema":{"type":"string"}},{"name":"filters.tag","in":"query","description":"Filter query parameters, support field tag ID","required":false,"schema":{"type":"string"}},{"name":"filters.deviceSeriesType","in":"query","description":"Filter query parameters, support field Device series type. 0: basic; 1: pro.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVODeviceInfo"}}}}},"x-order":40}},"/openapi/v1/{omadacId}/sites/{siteId}/grid/bridge-devices/adopted":{"get":{"tags":["Device"],"summary":"Get Bridge group grouped devices","description":"Get Bridge group grouped devices.","operationId":"getGridAdoptedBridgeDevicesBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.mac","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchMacs","in":"query","description":"Fuzzy query parameters, support field mac","required":false,"schema":{"type":"string"}},{"name":"searchNames","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}},{"name":"searchModels","in":"query","description":"Fuzzy query parameters, support field model","required":false,"schema":{"type":"string"}},{"name":"searchSns","in":"query","description":"Fuzzy query parameters, support field sn","required":false,"schema":{"type":"string"}},{"name":"filters.tag","in":"query","description":"Filter query parameters, support field tag ID","required":false,"schema":{"type":"string"}},{"name":"filters.deviceSeriesType","in":"query","description":"Filter query parameters, support field Device series type. 0: basic; 1: pro.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAdoptedDeviceGridVODeviceInfo"}}}}},"x-order":39}},"/openapi/v1/{omadacId}/sites/{siteId}/global-dashboard/site-map/abnormal":{"get":{"tags":["Site"],"summary":"Get the details of a site","description":"Get the details of a site in the Dashboard - site map","operationId":"getSiteInfoForAbnormal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}":{"get":{"tags":["Gateway"],"summary":"Get gateway info","description":"Get gateway info","operationId":"getGatewayInfo_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGatewayInfo"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/wan-status":{"get":{"tags":["Gateway"],"summary":"Get gateway wan status","description":"Get gateway wan status","operationId":"getWanStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListGateway Wan Status Entity"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/speedTestResult":{"get":{"tags":["Dashboard"],"summary":"Get Speed Test Result","description":"Get Speed Test Result.","operationId":"getSpeedTestV2Result","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSpeedTestV2ResultVO"}}}}},"x-order":31}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/simCardUsed":{"get":{"tags":["Gateway"],"summary":"Get SIM card used","description":"Get SIM card used","operationId":"getSimCardUsed","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOsgSimCardOpenApiVO"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/sim/sms/support":{"get":{"tags":["SIM"],"summary":"Get support SMS","description":"Get SIM card whether supports SMS.","operationId":"getSupportSmsByMac","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSupportSmsOpenApiVO"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/sim/sms/outbox":{"get":{"tags":["SIM"],"summary":"Get SMS outbox message by mac","description":"Get SMS outbox message by mac.","operationId":"getGridSmsOutboxMessageByMac","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOutboxMessageOpenApiGridVOOutboxMessage"}}}}},"x-order":32}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/sim/sms/outbox/{simCard}":{"get":{"tags":["SIM"],"summary":"Get one of Dual-SIM card's SMS outbox message by mac","description":"Get SMS outbox message by mac.","operationId":"getGridSimCardSmsOutboxMessageByMac","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"simCard","in":"path","description":"SIM card. 1: SIM1; 2: SIM2.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOutboxMessageOpenApiGridVOOutboxMessage"}}}}},"x-order":33}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/sim/sms/inbox":{"get":{"tags":["SIM"],"summary":"Get SMS inbox message by mac","description":"Get SMS inbox message by mac.","operationId":"getGridSmsInboxMessageByMac","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOInboxMessage"}}}}},"x-order":30}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/sim/sms/inbox/{simCard}":{"get":{"tags":["SIM"],"summary":"Get one of Dual-SIM card's SMS inbox message by mac","description":"Get SMS inbox message by mac.","operationId":"getGridSimCardSmsInboxMessageByMac","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"simCard","in":"path","description":"SIM card. 1: SIM1; 2: SIM2.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOInboxMessage"}}}}},"x-order":31}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/sim/quota/{simCard}":{"get":{"tags":["SIM"],"summary":"Get one of Dual-SIM card's SIM data setting by mac","description":"Get SIM data setting by mac.","operationId":"querySimCardQuotaSettingByMac","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"simCard","in":"path","description":"SIM card. 1: SIM1; 2: SIM2.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSimQuotaSetting"}}}}},"x-order":28}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/ports":{"get":{"tags":["Gateway"],"summary":"Get gateway ports","description":"Get gateway ports","operationId":"getPorts","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGatewayPortInfos"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/lan-status":{"get":{"tags":["Gateway"],"summary":"Get gateway lan status","description":"Get gateway lan status","operationId":"getLanStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListLanStatus"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/internet":{"get":{"tags":["Wired Network"],"summary":"Get internet info by mac","description":"Get internet info by mac","operationId":"getIpptInternet","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseInternetOpenApiVO"}}}}},"x-order":83}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/health/timeline":{"get":{"tags":["Health"],"summary":"Get gateway health time line","description":"Get gateway health time line","operationId":"getOsgHealthTimeList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTimeScoreListVO"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/health/detail":{"get":{"tags":["Health"],"summary":"Get gateway health detail","description":"Get gateway health detail","operationId":"getOsgHealthDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"wirelessRouter","in":"query","description":"Whether the device is a wireless router","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOsgHealthDetailVO"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/dhcp/user-list":{"get":{"tags":["Gateway"],"summary":"Get gateway dhcp user list","description":"Get gateway dhcp user list.","operationId":"getGridDhcpUserList_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOsgDhcpUserGridVOOsgDhcpUserVO"}}}}},"x-order":37}},"/openapi/v1/{omadacId}/sites/{siteId}/gateways/{gatewayMac}/config/wlans/ssid":{"get":{"tags":["Gateway"],"summary":"Get SSID detail info","description":"Get SSID detail info","operationId":"getSsidDetail_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSsidDetailOpenApiVO"}}}}},"x-order":31}},"/openapi/v1/{omadacId}/sites/{siteId}/full-channel-detect/{historyId}/grid/wifi-interference":{"get":{"tags":["Insight"],"summary":"Get WiFi interference results of batch interference detection","description":"Get WiFi interference results of batch interference detection","operationId":"getBatchWifiInterferencesResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"historyId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.type","in":"query","description":"Filter query parameters, support field wifi-interference result type. 0: all device; 1: one device.","required":true,"schema":{"type":"string"}},{"name":"filters.radioId","in":"query","description":"Filter query parameters, support field radio id. 0: 2.4G; 1: 5G; 3:6G.","required":false,"schema":{"type":"string"}},{"name":"filters.mac","in":"query","description":"Filter query parameters, support field AP MAC address, like AA-BB-CC-DD-EE-FF. When parameter [filter.type] is 0, this parameter is invalid.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOBatchWifiInterferenceOpenApiVO"}}}}},"x-order":28}},"/openapi/v1/{omadacId}/sites/{siteId}/full-channel-detect/{historyId}/grid/interference":{"get":{"tags":["Insight"],"summary":"Get Batch Interferences Result","description":"Get Batch Interferences Result","operationId":"getBatchInterferencesResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"historyId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListApInterference"}}}}},"x-order":29}},"/openapi/v1/{omadacId}/sites/{siteId}/full-channel-detect/{historyId}/channel-load":{"get":{"tags":["Insight"],"summary":"Get channel utilization results of batch interference detection","description":"Get channel utilization results of batch interference detection","operationId":"getBatchChannelLoadsResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"historyId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"mac","in":"query","description":"Mac Address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListApChannelLoadResult"}}}}},"x-order":30}},"/openapi/v1/{omadacId}/sites/{siteId}/full-channel-detect/{historyId}/ap-list":{"get":{"tags":["Insight"],"summary":"Get the AP list of batch interference detection","description":"Get the AP list of batch interference detection","operationId":"getBatchFullChannelDetectApList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"historyId","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseBatchFullChannelDetectApListOpenApiVO"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/sites/{siteId}/full-channel-detect/grid/scan-history":{"get":{"tags":["Insight"],"summary":"Get the interference detection history by page","description":"Get the interference detection history by page","operationId":"getGridFullChannelDetectHistory","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseBatchFullChannelDetectGridBatchFullChannelDetectHistoryOpenApiVO"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sites/{siteId}/full-channel-detect/batch/info":{"get":{"tags":["Insight"],"summary":"Get the MAC list of APs that cannot perform interference detection","description":"Get the MAC list of APs that cannot perform interference detection","operationId":"getDisableFullChannelDetectApMacList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDisableFullChanDetectApListOpenApiVO"}}}}},"x-order":32}},"/openapi/v1/{omadacId}/sites/{siteId}/firewall/timeout/default":{"get":{"tags":["Firewall"],"summary":"Get firewall default setting","description":"Get firewall default setting.","operationId":"getDefaultFirewallConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseFirewallSetting"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/files/hotspot/form-auths/{formId}/export":{"get":{"tags":["Form Auth Data"],"summary":"Export the Form Authentication Result List","description":"Export the Form Authentication Result List.","operationId":"exportAuthForms","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"formId","in":"path","description":"Form auth Id.","required":true,"schema":{"type":"string"}},{"name":"exportFormVO","in":"query","description":"Export Form Parameters","required":true,"schema":{"$ref":"#/components/schemas/ExportFormOpenApiVO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Single"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/experienceIndex":{"get":{"tags":["WLAN Optimization"],"summary":"get Experience Index","description":"get Experience Index","operationId":"getExperienceIndex","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Experience Index"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/eaps/{apMac}/health/timeline":{"get":{"tags":["Health"],"summary":"Get ap health time line","description":"Get ap health time line","operationId":"getApHealthTimeList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTimeScoreListVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/sites/{siteId}/eaps/{apMac}/health/detail":{"get":{"tags":["Health"],"summary":"Get ap health detail","description":"Get ap health detail","operationId":"getApHealthDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApHealthDetailVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/dst-info":{"get":{"tags":["Site Configuration"],"summary":"Get site DST","description":"Get site DST","operationId":"getOmadacDstInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDstOpenApiVO"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/sites/{siteId}/dot1x/eap/candidates":{"get":{"tags":["Authentication"],"summary":"Get site EAP 802.1x setting candidates","description":"Get EAP 802.1x setting candidates of the site with the given omadacId and siteId. ","operationId":"getEapDot1xCandidates","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListDot1xEapInfoOpenApiVO"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/dot1x/candidates":{"get":{"tags":["Authentication"],"summary":"Get site switch 802.1x setting candidates","description":"Get switch 802.1x setting candidates of the site with the given omadacId and siteId.","operationId":"getSwitchDot1xCandidates","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListDot1xSwitchInfoOpenApiVO"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/devices":{"get":{"tags":["Device"],"summary":"Get site device list","description":"Get site device list.","operationId":"getDeviceList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.status","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.ip","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name,mac,ip","required":false,"schema":{"type":"string"}},{"name":"filters.tag","in":"query","description":"Filter query parameters, support field tag name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVODeviceInfo"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/{deviceMac}/timeline":{"get":{"tags":["Device"],"summary":"Get device online timeline","description":"Get device online timeline","operationId":"getOnlineTimeline","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"queryParam","in":"query","required":true,"schema":{"$ref":"#/components/schemas/TimeIntervalQueryOpenApiVO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTimelineOpenApiVO"}}}}},"x-order":43}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/{deviceMac}/online-upgrade-result":{"get":{"tags":["Device"],"summary":"Get online upgrade result","description":"Get the result of the online upgrade.","operationId":"getOnlineUpgradeRes","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOnlineUpgradeRes"}}}}},"x-order":105}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/{deviceMac}/move/{moveSiteId}/status":{"get":{"tags":["Device"],"summary":"Get move site process of device","description":"Get move site process of one device from batch-move-site. The expire time of result for each device is 300 seconds","operationId":"getSingleMoveSiteProcess","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"moveSiteId","in":"path","description":"Move Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/{deviceMac}/latest-firmware-info":{"get":{"tags":["Device"],"summary":"Get the latest firmware info of the device","description":"Get latest firmware info of the device, including the latest firmware version and release logs.","operationId":"getFirmwareInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceFirmwareInfo"}}}}},"x-order":103}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/{deviceMac}/forget/{forgetId}/status":{"get":{"tags":["Device"],"summary":"Get forget process of device","description":"Get forget process of one device from batch-forget. The expire time of result for each device is 300 seconds.","operationId":"getSingleForgetProcess","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"forgetId","in":"path","description":"Forget ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/{deviceMac}/check-mac-type":{"get":{"tags":["Device"],"summary":"Check the device type by mac.","description":"Check the device type by mac.","operationId":"checkMacType","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCheckMacTypeOpenApiVO"}}}}},"x-order":47}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/{deviceMac}/adopt-result":{"get":{"tags":["Device"],"summary":"Get device adopt result","description":"Get device adopt result.","operationId":"getDeviceAdoptResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAdoptResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/un-support-radsec":{"get":{"tags":["Device"],"summary":"Check for unsupported RadSec devices.","description":"Get the result of detecting devices that do not support the RadSec feature.","operationId":"existUnSupportRadSecDevice","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUnSupportRadSecOpenApiVO"}}}}},"x-order":46}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/move/{moveSiteId}/status":{"get":{"tags":["Device"],"summary":"Get batch move site process","description":"Get process of the batch move site operation. The expire time of result is 300 seconds.","operationId":"getMoveSiteProcess","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"moveSiteId","in":"path","description":"Move Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/forget/{forgetId}/status":{"get":{"tags":["Device"],"summary":"Get batch forget process","description":"Get process of the batch forget operation. The expire time of result is 300 seconds.","operationId":"getForgetProcess","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"forgetId","in":"path","description":"Forget ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/sites/{siteId}/devices/all":{"get":{"tags":["Device"],"summary":"Get device list info.","description":"Get device list info.","operationId":"getAllDeviceBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListDeviceInfo"}}}}},"x-order":27}},"/openapi/v1/{omadacId}/sites/{siteId}/device-white-list":{"get":{"tags":["Device"],"summary":"Get the whitelist list of devices.","description":"Get the whitelist list of devices.","operationId":"getDeviceWhiteList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListWhiteDeviceInfoOpenApiVO"}}}}},"x-order":29}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/without-overall-tabs":{"get":{"tags":["Dashboard"],"summary":"Get tab without overall tab list","description":"Get tabs without Overall Tab.","operationId":"listTabs","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListListTabs"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/wifi-summary":{"get":{"tags":["Dashboard"],"summary":"Get wifi summary","description":"Get wifi summary.","operationId":"getWifiSummary","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWifiSummary"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/vpn-tunnel-stats":{"get":{"tags":["Dashboard"],"summary":"Get grid dashboard tunnel statistic list","description":"Get the status, IP address, and other information of the established dashboard tunnel statistic VPN connection","operationId":"getGridDashboardTunnelStats","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Type should be a value as follows: 0:Server,1:Client","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListDashboardVpnStats"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/traffic-distribution":{"get":{"tags":["Dashboard"],"summary":"Get traffic distribution","description":"Obtain wired/wireless traffic distribution data within the time range","operationId":"getTrafficDistribution","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTrafficDistribution"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/traffic-activities":{"get":{"tags":["Dashboard"],"summary":"Get traffic activity","description":"Obtain AP and Switch traffic Activities within the time range","operationId":"getTrafficActivities","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTrafficActivities"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/top-interference":{"get":{"tags":["Dashboard"],"summary":"Get top interference","description":"Obtain the 5 APs with the highest interference intensity in different frequency bands within the time range","operationId":"getInterference","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApInterferences"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/top-device-memory-usage":{"get":{"tags":["Dashboard"],"summary":"Get top device memory usage","description":"Obtain the top 5 memory usage devices within the time range","operationId":"getTopMemoryUsageWithTimeRange","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListMemUsage"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/top-device-cpu-usage":{"get":{"tags":["Dashboard"],"summary":"Get top device cpu usage","description":"Obtain the top 5 CPU usage devices within the time range","operationId":"getTopCpuUsageWithTimeRange","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListCpuUsage"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/top-aps":{"get":{"tags":["Dashboard"],"summary":"Get Top 5 Aps","description":"Get Top 5 Aps.","operationId":"getTop5Aps","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTopApByRtDropVO"}}}}},"x-order":28}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/switch-summary":{"get":{"tags":["Dashboard"],"summary":"Get switch summary","description":"Get switch summary","operationId":"getSwitchSummary","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSwitchSummary"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/specificClientInfo/{clientMac}":{"get":{"tags":["Application Control"],"summary":"Get app traffic in specific client","description":"Get app traffic in specific client.","operationId":"getSpecificClientInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client Mac","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListApplicationStatTraffic"}}}}},"x-order":42}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/specificAppInfo/{applicationId}":{"get":{"tags":["Application Control"],"summary":"Get client traffic in specific app","description":"Get client traffic in specific app.","operationId":"getSpecificAppInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"applicationId","in":"path","description":"Application Id","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListClientTrafficWithApplicationDetail"}}}}},"x-order":41}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/retry-dropped-rate":{"get":{"tags":["Dashboard"],"summary":"Get retried rate and dropped rate","description":"Get retried rate and dropped rate.","operationId":"getRetryAndDroppedRate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseRetryDropRate"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/poe-usage":{"get":{"tags":["Dashboard"],"summary":"Get poe usage","description":"Obtain the PoE usage of the switch within the time range","operationId":"getPoeUsage","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListPoeUsage"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/past-client-num":{"get":{"tags":["Client Insight"],"summary":"Get past client number.","description":"Get past client number with the given omadacId and siteId.","operationId":"getPastClientNum","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientSummaryVO"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/overview-diagram":{"get":{"tags":["Dashboard"],"summary":"Get site overview diagram info","description":"Get site overview diagram info.","operationId":"getOverview","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGetDashboardOverview"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/open-vpn-tunnel-stats":{"get":{"tags":["Dashboard"],"summary":"Get grid dashboard open vpn tunnel statistic list","description":"Obtain the status, traffic, and other information of the established open VPN connection","operationId":"getGridDashboardOpenVpnTunnelStats","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"type: 0:Server, 1:Client","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListDashboardVpnStats"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/mostActiveAppTraffic":{"get":{"tags":["Application Control"],"summary":"Get most active applications","description":"Get most active applications.","operationId":"getMostActiveApplications","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListApplicationTrafficWithClientCount"}}}}},"x-order":34}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/most-active-switches":{"get":{"tags":["Dashboard"],"summary":"Get most active switch list","description":"Obtain the top 5 switches with the highest device traffic within the time range (in Bytes)","operationId":"getActiveSwitches","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListActiveDevice"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/most-active-eaps":{"get":{"tags":["Dashboard"],"summary":"Get the most active eap list","description":"Obtain the top 5 APs with the highest device traffic within the time range (in Bytes)..","operationId":"getActiveAps","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListActiveDevice"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/lpset-tunnel-stats":{"get":{"tags":["Dashboard"],"summary":"Get grid dashboard lpsec tunnel statistic list","description":"Obtain the status, IP address, and other information of the established IPsec VPN connection","operationId":"getGridDashboardIpsecTunnelStats","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListIpsecVpnStats"}}}}},"x-order":22}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/longest-uptime":{"get":{"tags":["Client Insight"],"summary":"Get longest client uptime.","description":"Get longest client uptime with the given omadacId and siteId.","operationId":"getLongestClientUptime","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientSummaryVO"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/isp-load":{"get":{"tags":["Dashboard"],"summary":"Get isp load info","description":"Obtain IPS load data for the gateway within the time range.","operationId":"getIspLoad","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListIspLoad"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/gateway/isp/load":{"get":{"tags":["Dashboard"],"summary":"Get site dashboard isp load inform","description":"Get site dashboard isp load inform of the site with the given omadacId and siteId.","operationId":"getGatewayIspLoad","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDashboardIspLoadDetailVO"}}}}},"x-order":26}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/current-client-num":{"get":{"tags":["Client Insight"],"summary":"Get current client number.","description":"Get current client number with the given omadacId and siteId.","operationId":"getCurrentClientNum","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientSummaryVO"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/clients-bubble":{"get":{"tags":["Client Insight"],"summary":"Get clients bubble.","description":"Get clients bubble with the given omadacId and siteId.","operationId":"getClientsBubble","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListActiveClientBubbleVO"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/client-ssid-distribution":{"get":{"tags":["Client Insight"],"summary":"Get clients ssid distribution.","description":"Get clients ssid distribution with the given omadacId and siteId.","operationId":"getClientsSsidDistribution","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientSummaryVO"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/client-signal-distribution":{"get":{"tags":["Client Insight"],"summary":"Get clients signal distribution.","description":"Get clients signal distribution with the given omadacId and siteId.","operationId":"getClientsBandDistribution","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientSignalDistributionVO"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/client-rssi-distribution":{"get":{"tags":["Client Insight"],"summary":"Get clients rssi distribution.","description":"Get clients rssi distribution with the given omadacId and siteId.","operationId":"getClientsRssiDistribution","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientRssiChannelDistributionVO"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/client-freq-distribution":{"get":{"tags":["Client Insight"],"summary":"Get clients freq distribution.","description":"Get clients freq distribution with the given omadacId and siteId.","operationId":"getClientsFreqDistribution","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientSummaryVO"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/client-distribution":{"get":{"tags":["Client Insight"],"summary":"Get client distribution.","description":"Get client distribution with the given omadacId and siteId.","operationId":"getClientsDistribution","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDashboardDistributionVO"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/client-association-time-distribution":{"get":{"tags":["Client Insight"],"summary":"Get clients association time distribution.","description":"Get clients association time distribution with the given omadacId and siteId.","operationId":"getClientsAssociationTimeDistribution","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientAssociationTimeDistributionVO"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/client-association-activities":{"get":{"tags":["Client Insight"],"summary":"Get clients association activities.","description":"Get clients association activities with the given omadacId and siteId.","operationId":"getClientsAssociationActivities","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientSummaryVO"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/client-activity":{"get":{"tags":["Client Insight"],"summary":"Get client activity","description":"Get client activity with the given omadacId and siteId.","operationId":"getClientActivity","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListClientActivitiesVO"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/channels":{"get":{"tags":["Dashboard"],"summary":"Get channel distribution and usage","description":"Get channel distribution and usage.","operationId":"getChannels","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApChannelStats"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/categoryUserInfo/{familyId}":{"get":{"tags":["Application Control"],"summary":"Get client traffic in specific category","description":"Get client traffic in specific category.","operationId":"getCategoryUserInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"familyId","in":"path","description":"Family Id","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListClientTrafficWithApplicationDetail"}}}}},"x-order":40}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/categoryInfo":{"get":{"tags":["Application Control"],"summary":"Get category info","description":"Get category info.","operationId":"getCategoryInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApplicationGridVOCategoryTraffic"}}}}},"x-order":35}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/categoryAppInfo/{familyId}":{"get":{"tags":["Application Control"],"summary":"Get app traffic in specific category","description":"Get app traffic in specific category.","operationId":"getCategoryAppInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"familyId","in":"path","description":"Family Id","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListApplicationStatTraffic"}}}}},"x-order":39}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/card/overview":{"get":{"tags":["Dashboard"],"summary":"Get network overview","description":"Obtain the statistic info of devices.","operationId":"getCardTopology","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListCardOverviewOpenApiVO"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/blockApp":{"get":{"tags":["Application Control"],"summary":"Get block app","description":"Get block app.","operationId":"getBlockApp","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApplicationGridVOApplicationStatTraffic"}}}}},"x-order":37}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/ap-density":{"get":{"tags":["Client Insight"],"summary":"Get ap density.","description":"Get ap density with the given omadacId and siteId.","operationId":"getApDensity","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseEapRssiChannelDistributionVO"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/allowApp":{"get":{"tags":["Application Control"],"summary":"Get allow app","description":"Get allow app.","operationId":"getAllowApp","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApplicationGridVOApplicationStatTraffic"}}}}},"x-order":36}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/allNetworkActivity":{"get":{"tags":["Dashboard"],"summary":"Get grid dashboard open network activity statistic list","operationId":"getAllNetworkActivity","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseNetworkActivityVO"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/sites/{siteId}/dashboard/active-clients":{"get":{"tags":["Client Insight"],"summary":"Get most active client.","description":"Get most active clients with the given omadacId and siteId.","operationId":"getMostActiveClients","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListActiveClientVO"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/count-ap-groups":{"get":{"tags":["Wireless Network"],"summary":"Check if the number of AP Groups is out of limit","description":"Check if the number of AP Groups is out of limit. The value of \"ApGroupNum\" indicates number of AP group and the value of \"exceeded\" indicates whether the number of AP Groups exceeds the limit. \nThe limit is the total number that a Controller can create, not the limit of a single Site.","operationId":"countApGroups","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApGroupStatusOpenApiVO"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/cmd/devices/{deviceMac}/downloadDeviceInfo/{type}":{"get":{"tags":["Device"],"summary":"Download device information.","description":"Download device information.","operationId":"downloadDeviceInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","description":"Device Type. Supported type: ap, gateway, switch, olt.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":38}},"/openapi/v1/{omadacId}/sites/{siteId}/clients":{"get":{"tags":["Client"],"summary":"Get client list","description":"Get all clients.","operationId":"getGridActiveClients","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.mac","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.ip","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"filters.wireless","in":"query","description":"Filter query parameters, support field wireless: true/false.","required":false,"schema":{"type":"string"}},{"name":"filters.radioId","in":"query","description":"Filter query parameters, support field radioId: 0: 2G, 1: 5G1, 2: 5G2, 3: 6G","required":false,"schema":{"type":"string"}},{"name":"filters.apMac","in":"query","description":"Filter query parameters, support field ap mac","required":false,"schema":{"type":"string"}},{"name":"filters.switchMac","in":"query","description":"Filter query parameters, support field switch mac","required":false,"schema":{"type":"string"}},{"name":"filters.gatewayMac","in":"query","description":"Filter query parameters, support field gateway mac","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field clientName,clientMac,ip,channel,ssid,apName,apMac,switchMac,switchName,gatewayMac,gatewayName.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientGridVOOpenApi Client Info"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/clients/{clientMac}":{"get":{"tags":["Client"],"summary":"Get client info","description":"Get client info.","operationId":"getClientDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClient Detail"}}}}},"x-order":2},"delete":{"tags":["Client"],"summary":"Delete client","description":"Delete client.","operationId":"deleteClient","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/clients/{clientMac}/health/timeline":{"get":{"tags":["Health"],"summary":"Get client health time line","description":"Get client health time line","operationId":"getClientHealthTimeList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTimeScoreListVO"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/clients/{clientMac}/health/detail":{"get":{"tags":["Health"],"summary":"Get client health detail","description":"Get client health detail","operationId":"getClientHealthDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientHealthDetailVO"}}}}},"deprecated":true,"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/clients/{clientMac}/client-timeline":{"get":{"tags":["Client"],"summary":"Get client timeline events","description":"Get client timeline events.","operationId":"getClientTimeline","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, unit: ms","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, unit: ms","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"type","in":"query","description":"Query type, 0: Connection Timeline; 1: Association; 2: Roaming; 3: Disconnection.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListActivity Records Of A Client's Single Connections"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sites/{siteId}/clients/{clientMac}/client-history":{"get":{"tags":["Client"],"summary":" Get Client history.","description":"Get Client history.","operationId":"getGridClientHistory","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.mac","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.ip","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.authType","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.ssidOrNetwork","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.download","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.upload","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.status","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.start","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.end","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.duration","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field client_mac,client_name,voucher.code,local_user.user_name,form_name,auth_admin,ssid_name,network_name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOClientHistoryVO"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/clients/{clientMac}/client-connection":{"get":{"tags":["Client"],"summary":"Get client connection histories","description":"Get client connection histories.","operationId":"getClientJourney","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"clientMac","in":"path","description":"Client MAC","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, unit: ms","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, unit: ms","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClient Connection Histories"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/clients/search-fields-options":{"get":{"tags":["Client"],"summary":"Get client list filtering options","description":"Get client list filtering options.","operationId":"getClientFilteringOptions","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClient Filtering Options"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/clientList/{ssidId}":{"get":{"tags":["Client"],"summary":"Get clients list of ssid.","description":"Get clients list of ssid.","operationId":"getGridSsidClients","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"ssidId","in":"path","required":true,"schema":{"type":"string"}},{"name":"queryDataVO","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OpenApiQueryDataV2VO"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientGridVOSsidClientVO"}}}}},"x-order":30}},"/openapi/v1/{omadacId}/sites/{siteId}/cli/models/device-type/{deviceType}":{"get":{"tags":["CLI"],"summary":"Get model and version for model CLI.","description":"Get model and version for model CLI.","operationId":"getModelAndVersionListByType","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceType","in":"path","description":"Device Type. Supported type: switch.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListModelAndModelVersionVO"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/cli/configs/cli-type/{cliType}/device-type/{deviceType}":{"get":{"tags":["CLI"],"summary":"Get the CLI configuration list","description":"Get the CLI configuration list","operationId":"getCliList","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"cliType","in":"path","description":"CLI type should be a value as follows: 0: site CLI; 1: device CLI； 2：model CLI. Site template only supports site CLI. Site template only supports site CLI.","required":true,"schema":{"type":"string"}},{"name":"deviceType","in":"path","description":"Device Type. Supported type: switch.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOCliVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/cli/config/devices":{"get":{"tags":["CLI"],"summary":"Get device list when importing device configuration","description":"Get device list when importing device configuration","operationId":"getCliDevice","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListSupportCliDeviceVO"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/cli/config/devices/device-type/{deviceType}":{"get":{"tags":["CLI"],"summary":"Get device list when creating CLI","description":"Get device list when creating CLI","operationId":"getCliDeviceByType","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceType","in":"path","description":"Device Type. Supported type: switch.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListCliDeviceListVO"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/capture/lastDevice":{"get":{"tags":["Network Analyze"],"summary":"Get last capture device","description":"Get last capture device.","operationId":"getLastCaptureDevice","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceInterfaces"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/capture/device-type/{deviceType}/{deviceMac}/{requestId}/status":{"get":{"tags":["Network Analyze"],"summary":"Query package capture status","description":"Query package capture status.","operationId":"queryPackageCaptureStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceType","in":"path","description":"Device type, and should be a value in [ap, switch, gateway].","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"requestId","in":"path","description":"A GUID based on the timestamp.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCaptureResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/capture/device-type/{deviceType}/{deviceMac}/stop":{"get":{"tags":["Network Analyze"],"summary":"Stop package capturing","description":"Stop package capturing.","operationId":"stopPackageCapture","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceType","in":"path","description":"Device type, and should be a value in [ap, switch, gateway].","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/capture/device-type/{deviceType}/{deviceMac}/interfaces":{"get":{"tags":["Network Analyze"],"summary":"Get device interfaces","description":"Get device interfaces.","operationId":"getDeviceInterfaces","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceType","in":"path","description":"Device type, and should be a value in [ap, switch, gateway].","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceInterfaces"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/capture/all-devices/device-type/{deviceType}":{"get":{"tags":["Network Analyze"],"summary":"Get devices that can capture packages","description":"Get the grid of devices that can capture packages.","operationId":"getAllCaptureDevices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceType","in":"path","description":"Device type, and should be a value in [ap, switch, gateway].","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVODeviceCaptureInfo"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/capacity":{"get":{"tags":["Site Configuration"],"summary":"Get site capabilities.","description":"Get site capabilities.","operationId":"getSiteSettingCap","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteSettingCapOpenApiVO"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sites/{siteId}/cable-test/switches/{switchMac}/ports":{"get":{"tags":["Switch"],"summary":"Get the port list used for cable test","description":"Get the port list used for cable test.","operationId":"getCableTestOswPorts","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOswCableTestPortVO"}}}}},"x-order":27}},"/openapi/v1/{omadacId}/sites/{siteId}/cable-test/switches/{switchMac}/logs":{"get":{"tags":["Switch"],"summary":"Get the cable test logs","description":"Get the cable test logs.","operationId":"getCableTestLogs","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOswCableTestLogOpenApiVO"}}}}},"x-order":30}},"/openapi/v1/{omadacId}/sites/{siteId}/cable-test/switches/{switchMac}/increment-results":{"get":{"tags":["Switch"],"summary":"Get the cable test increment results","description":"Get the cable test increment results.","operationId":"getCableTestIncrementResults","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswCableTestResultWithStatusVO"}}}}},"x-order":29}},"/openapi/v1/{omadacId}/sites/{siteId}/cable-test/switches/{switchMac}/full-results":{"get":{"tags":["Switch"],"summary":"Get the cable test full results","description":"Get the cable test full results.","operationId":"getCableTestFullResults","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswCableTestResultWithStatusVO"}}}}},"x-order":28}},"/openapi/v1/{omadacId}/sites/{siteId}/cable-test/stacks/{stackId}/ports":{"get":{"tags":["Stack"],"summary":"Get the port list of stack used for cable test","description":"Get the port list of stack used for cable test.","operationId":"getStackCableTestPorts","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswStackCableTestVO"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/sites/{siteId}/cable-test/stacks/{stackId}/logs":{"get":{"tags":["Stack"],"summary":"Get stack cable test logs","description":"Get stack cable test logs.","operationId":"getStackCableTestLogs","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListOswCableTestLogOpenApiVO"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/cable-test/stacks/{stackId}/increment-results":{"get":{"tags":["Stack"],"summary":"Get stack cable test increment results","description":"Get stack cable test increment results.","operationId":"getStackCableTestIncrementResults","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswCableTestResultWithStatusVO"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/cable-test/stacks/{stackId}/full-results":{"get":{"tags":["Stack"],"summary":"Get stack cable test full results","description":"Get stack cable test full results.","operationId":"getStackCableTestFullResults","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswCableTestResultWithStatusVO"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/backup/result":{"get":{"tags":["Backup and Restore"],"summary":"Get site backup result","description":"Get site backup result.","operationId":"getSiteBackupResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BackupResultOpenApiVO"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/audit-logs":{"get":{"tags":["Audit Log"],"summary":"Get site audit log list","description":"Get audit logs in site audit page.","operationId":"getAuditLogsForSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.time","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"filters.result","in":"query","description":"Filter query parameters, support field result,it should be a value as follows: 0: successful; 1: failed,example:0","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"filters.level","in":"query","description":"Filter query parameters, support field level,it should be a value as follows: Error; Warning; Information, example:Error","required":false,"schema":{"type":"string"}},{"name":"filters.auditTypes","in":"query","description":"Filter query parameters, support field auditTypes, for the values of auditLog type, refer to section 5.2.2 of the Open API Access Guide, example:Log,Cloud Access,User Interface.","required":false,"schema":{"type":"string"}},{"name":"filters.times","in":"query","description":"Filter query parameters, support field times, example:[{\"timeStart\":1678060800000,\"timeEnd\":1678665599999}](UrlEncode:%5B%7B%22timeStart%22%3A1678060800000%2C%22timeEnd%22%3A1678665599999%7D%5D).If this parameter is not specified (not included or empty array), the interface will query data within the default time period: [{\"timeStart\":  Current timestamp minus milliseconds of 7 days,\"timeEnd\": Current timestamp}].","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field content","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOAuditLogOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/audit-logs/{apMac}/ssid-overrides":{"get":{"tags":["Audit Log"],"summary":"Get ap ssidoverride audit log list","description":"Get ap ssidoverride audit logs in site audit page.","operationId":"getApSsidOverridesAuditLogs","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.time","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"filters.times","in":"query","description":"Filter query parameters, support field times, example:[{\"timeStart\":1678060800000,\"timeEnd\":1678665599999}](UrlEncode:%5B%7B%22timeStart%22%3A1678060800000%2C%22timeEnd%22%3A1678665599999%7D%5D).If this parameter is not specified (not included or empty array), the interface will query data within the default time period: [{\"timeStart\":  Current timestamp minus milliseconds of 7 days,\"timeEnd\": Current timestamp}].","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOApOverrideAuditLogVO"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/attack-defense/default":{"get":{"tags":["Attack Defense"],"summary":"Get attack and defense default setting","description":"Get attack and defense default setting.","operationId":"getDefaultAttackDefense","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAttackDefenseSetting"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}":{"get":{"tags":["Ap"],"summary":"Get AP info","description":"Get AP info","operationId":"getOverviewDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApOverviewInfo"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/wired-uplink":{"get":{"tags":["Ap"],"summary":"Get AP uplink(wired) detail","description":"Get AP uplink(wired) detail","operationId":"getUplinkWiredDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApWiredUplink"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/wired-downlink":{"get":{"tags":["Ap"],"summary":"Get AP downlink(wired) device list","description":"Get AP downlink(wired) device list","operationId":"getDownlinkWiredDevices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApWiredDownlink"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/vlan":{"get":{"tags":["Ap"],"summary":"Get AP vlan config","description":"Get AP vlan config. This interface has been deprecated. Please use the following interface instead: Get AP vlan config v2.","operationId":"getApVlanConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApVlanConfigOpenApiVO"}}}}},"deprecated":true,"x-order":41}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/speed-test-result":{"get":{"tags":["Ap"],"summary":"Get speed test result","description":"Get the test results of the speed from device [apMac].(Only for P2P device)","operationId":"getSpeedTestResults","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApSpeedTestResultsOpenApiVO"}}}}},"x-order":38}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/snmp":{"get":{"tags":["Ap"],"summary":"Get AP snmp config","description":"Get AP snmp config","operationId":"getApSnmpConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApSnmpConfigOpenApiVO"}}}}},"x-order":42}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/rf-scan-result":{"get":{"tags":["Ap"],"summary":"Get rf scan result","description":"Get rf scan result. This interface has been deprecated. Please use the following interface instead: Get rf scan result v2.","operationId":"getRFScanResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApRFScanInfo"}}}}},"deprecated":true,"x-order":14}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/radios":{"get":{"tags":["Ap"],"summary":"Get AP radio detail","description":"Get AP radio detail","operationId":"getRadiosDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApRadiosDetail"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/ports":{"get":{"tags":["Ap"],"summary":"Get AP port list","description":"Get AP port list","operationId":"getApPortList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListAP LAN Port List"}}}}},"x-order":58}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/port-vlans":{"get":{"tags":["Ap"],"summary":"Get AP current vlans config","description":"get AP current vlans config","operationId":"getApPortVlans","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOApVlansVO"}}}}},"x-order":62}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/paring-window-result":{"get":{"tags":["Ap"],"summary":"Get Paring Window Result","description":"Get Paring Window Result","operationId":"getParingWindowResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAP Bridge Paring Window Result"}}}}},"x-order":75}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/p2pInfo":{"get":{"tags":["Ap"],"summary":"Get P2P bridge group info","description":"Get P2P bridge group info","operationId":"getApP2pInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApP2pInfo"}}}}},"x-order":28}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/mesh/statistics":{"get":{"tags":["Ap"],"summary":"Get AP mesh statistics","description":"Get AP mesh statistics","operationId":"getMeshStatistics","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApMeshStatisticsOpenApiVO"}}}}},"x-order":55}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/lldp":{"get":{"tags":["Ap"],"summary":"Get AP lldp config","description":"Get AP lldp config","operationId":"getApLldpConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApLldpConfigOpenApiVO"}}}}},"x-order":43}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/lan-traffic-info":{"get":{"tags":["Ap"],"summary":"Get AP lan traffic info","description":"Get AP lan traffic info","operationId":"getLanDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApLanTraffic"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/l3access":{"get":{"tags":["Ap"],"summary":"Get AP l3Access config","description":"Get AP l3Access config","operationId":"getApL3AccessConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApL3AccessConfigOpenApiVO"}}}}},"x-order":44}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/grid/mesh/candiParents":{"get":{"tags":["Ap"],"summary":"Get the candidate parent AP of the mesh AP","description":"Get the candidate parent AP of the mesh AP, call before adoption.","operationId":"getGridMeshCandiParentsForAdopt","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOCandidateParentForAdoptOpenApiVO"}}}}},"x-order":54}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/full-channel-detect/wlan-interference":{"get":{"tags":["Insight"],"summary":" Get WiFi interference results of interference detection","description":" Get WiFi interference results of interference detection","operationId":"getGridWifiInterfResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOApWifiInterferenceResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/full-channel-detect/status":{"get":{"tags":["Insight"],"summary":"Get the interference detection status of APs","description":"Get Full Channel Detect Status","operationId":"getFullChannelDetectStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApFullChannelScanStatus"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/full-channel-detect/grid/interference":{"get":{"tags":["Insight"],"summary":"Get Interference result","description":"Get Interference result","operationId":"getInterfResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApInterference"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/full-channel-detect/channel-load":{"get":{"tags":["Insight"],"summary":"Get channel utilization results of interference detection","description":"Get channel utilization results of interference detection","operationId":"getChannelLoadResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApChannelLoadResult"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/available-channel":{"get":{"tags":["Ap"],"summary":"Get available channel list of AP","description":"Get available channel list of AP","operationId":"getAvailableChannelOfAp","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListApAvailableChannelOpenApiVO"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/{apMac}/afc":{"get":{"tags":["Ap"],"summary":"Get AP AFC Status Info","description":"Get AP AFC Status Info.","operationId":"getAfcInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApAfcInfoOpenApiVO"}}}}},"x-order":28}},"/openapi/v1/{omadacId}/sites/{siteId}/aps/not-support-wpa3-ppsk":{"get":{"tags":["app"],"summary":"Get grid ap list that does not support wpa3 ppsk.","description":"Get grid ap list that does not support wpa3 ppsk.","operationId":"getGridNotSupportWpa3PpskAps","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GridVOAp Brief Info"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/applicationControl/traffics":{"get":{"tags":["Application Control"],"summary":"Get top 10 application traffics","description":"Get top 10 application traffics","operationId":"getApplicationControlTraffics","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"dateStart","in":"query","description":"Date Start","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"dateEnd","in":"query","description":"Date End","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListTrafficOpenApiVO"}}}}},"x-order":34}},"/openapi/v1/{omadacId}/sites/{siteId}/applicationControl/families":{"get":{"tags":["Application Control"],"summary":"Get family list","description":"Get family list.","operationId":"getFamilies","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListFamilyEntity"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sites/{siteId}/applicationControl/applications":{"get":{"tags":["Application Control"],"summary":"Get application list","description":"Get application list.","operationId":"getApplications","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field application name","required":false,"schema":{"type":"string"}},{"name":"filtersFamilyId","in":"query","description":"Filter query parameters, support field 0","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOApplicationEntity"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sites/{siteId}/ap-groups/{apGroupId}/info":{"get":{"tags":["Wireless Network"],"summary":"Get an existing AP Group info","description":"Get an existing AP Group info","operationId":"getApGroupInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apGroupId","in":"path","description":"AP GROUP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApGroupOpenApiVO"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sites/{siteId}/ap-groups/{apGroupId}/aps":{"get":{"tags":["app"],"summary":"Get AP list by AP group","description":"Get AP list by AP group","operationId":"listApByApGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apGroupId","in":"path","description":"AP GROUP ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOSsidDeviceOpenApiVO"}}}}},"x-order":28}},"/openapi/v1/{omadacId}/sites/{siteId}/ap-groups/{apGroupId}/aps-not-in-group":{"get":{"tags":["app"],"summary":"Get AP list not in the AP group","description":"Get AP list not in the AP group","operationId":"listApNotInApGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apGroupId","in":"path","description":"AP GROUP ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOSsidDeviceOpenApiVO"}}}}},"x-order":29}},"/openapi/v1/{omadacId}/sites/{siteId}/ap-groups/aps":{"get":{"tags":["Wireless Network"],"summary":"Get All AP grouping by ap group","description":"Get All AP grouping by ap group","operationId":"getAllApGroupListBySite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOSsidDeviceOpenApiVO"}}}}},"x-order":56}},"/openapi/v1/{omadacId}/sites/{siteId}/anomaly/{mac}/influencing-devices":{"get":{"tags":["Incidents"],"summary":"Get Influencing Devices by an incident","description":"Get Influencing Devices by an incident","operationId":"getInfluencingDevices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"mac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"anomalyCode","in":"query","description":"Anomaly Code","required":true,"schema":{"type":"string"}},{"name":"startTime","in":"query","description":"Start time of the query range, in milliseconds. If both startTime and endTime are omitted, the server defaults to the last 30 days.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"End time of the query range, in milliseconds. If both startTime and endTime are omitted, the server defaults to the last 30 days.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"status","in":"query","description":"Status of the incident. 0: unresolved, 1: resolved, 2: ignored, 3: ongoing, null: all","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–100.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"filters.status","in":"query","description":"Filter query parameters, support field status","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field deviceName,mac,ip.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOInfluencingDeviceVO"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/anomaly/{mac}/influencing-clients":{"get":{"tags":["Incidents"],"summary":"Get Influencing Clients by an incident","description":"Get Influencing Clients by an incident","operationId":"getInfluencingClients","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"mac","in":"path","description":"Client MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"anomalyCode","in":"query","description":"Anomaly Code","required":true,"schema":{"type":"string"}},{"name":"startTime","in":"query","description":"Start time of the query range, in milliseconds (epoch). If both startTime and endTime are omitted, the server defaults to the last 30 days.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"End time of the query range, in milliseconds (epoch). If both startTime and endTime are omitted, the server defaults to the last 30 days.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"status","in":"query","description":"Status of the incident. 0: unresolved, 1: resolved, 2: ignored, 3: ongoing, null: all","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–100.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"filters.active","in":"query","description":"Filter query parameters, support field active: true/false.","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field clientName,mac,ip.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOInfluencingClientVO"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/anomaly/unresolved-incidents":{"get":{"tags":["Incidents"],"summary":"Get unresolved incident count","description":"Get unresolved incident count.","operationId":"getUnresolvedIncidentCount","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ActiveIncidentCountVO"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/anomaly/setting":{"get":{"tags":["Incidents"],"summary":"Get site incident event setting","description":"Get site incident event setting.","operationId":"getAnomalyEventSettingForSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.enable","in":"query","description":"Filter query parameters, support field enable, it should be a value as follows: 0:enable, 1:disable, example:0.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"filters.level","in":"query","description":"Filter query parameters, support field level, it should be a value as follows: 0:Critical, 1:Error, 2:Warning, 3: Info, example:1.","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"filters.category","in":"query","description":"Filter query parameters, support field category, one or more categories, each category should be a value as follows: 11:Access, 12:Authentication, 13:Roaming, 14:Wireless Network, 15:Wired Network, 16:Link, 17:WAN and Services, 18:Device Status, 19:Security, example: 11 Or 12,13,14","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAnomalySettingGridVOAnomalyEventSettingOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/sites/{siteId}/anomaly/overview/statistics":{"get":{"tags":["Incidents"],"summary":"Get incident overview statistics","description":"Get incident overview statistics for the pie chart.","operationId":"getOverviewStatistics","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filters.startTime","in":"query","description":"Query start time, in milliseconds","required":true,"schema":{"type":"integer","format":"int64"},"example":1646356605000},{"name":"filters.endTime","in":"query","description":"Query end time, in milliseconds","required":true,"schema":{"type":"integer","format":"int64"},"example":1646360205000}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOverviewStatisticsOpenApiVO"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/sites/{siteId}/anomaly/overview/incident-distribution":{"get":{"tags":["Incidents"],"summary":"Get incident overview distribution","description":"Get incident overview distribution.","operationId":"getIncidentDistribution","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filters.startTime","in":"query","description":"Start time in milliseconds","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.endTime","in":"query","description":"End time in milliseconds","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseIncidentDistributionOpenApiVO"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/anomaly/incidents":{"get":{"tags":["Incidents"],"summary":"Get grid incident List","description":"Get incident list.","operationId":"getGridIncidentList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filters.status","in":"query","description":"Incident status filter","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.startTime","in":"query","description":"Start time in milliseconds","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.endTime","in":"query","description":"End time in milliseconds","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.category","in":"query","description":"Incident category filter","required":false,"schema":{"type":"string"}},{"name":"filters.anomalyCode","in":"query","description":"Anomaly code filter","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAnomalyGridVOAnomalyAggregateVO"}}}}}},"delete":{"tags":["Incidents"],"summary":"Delete aggregate incident","description":"Delete aggregate incidents.","operationId":"deleteAggregateIncident","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnomalyTimerSettingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseObject"}}}}}}},"/openapi/v1/{omadacId}/sites/{siteId}/anomaly/incident/{incidentId}":{"get":{"tags":["Incidents"],"summary":"Get incident detail","description":"Get incident detail","operationId":"getIncidentDetail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"incidentId","in":"path","description":"Incident ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAnomalyVO"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/anomaly/category":{"get":{"tags":["Incidents"],"summary":"Get incident category event count","description":"Get incident category event count statistics.","operationId":"getCategoryEventCount","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filters.startTime","in":"query","description":"Start time in milliseconds","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.endTime","in":"query","description":"End time in milliseconds","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"category","in":"query","description":"Incident category (11-19)","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListAnomalyCategoryEventCountVO"}}}}}}},"/openapi/v1/{omadacId}/sites/{siteId}/all-devices/check-latest-firmware-tasks/{taskId}":{"get":{"tags":["Device"],"summary":"Get the result of the given check latest firmware task","description":"Get the result of the firmware update task, containing a list of devices with firmware updates","operationId":"getCheckFirmwareTaskResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"taskId","in":"path","description":"Task ID. The ID is the return value of 'Start check latest firmware for all devices' interface","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCheckFirmwareRes"}}}}},"x-order":102}},"/openapi/v1/{omadacId}/site-overrides":{"get":{"tags":["Site Template"],"summary":"get site overrides","description":"get site overrides","operationId":"getSitesOverrides","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteIds","in":"query","description":"Site IDs","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSiteOverrideResultOpenApiVO"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/security/threat-management":{"get":{"tags":["Global Security"],"summary":"Get Global Threat List","description":"Get the global view threat management list","operationId":"getGlobalThreatList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteList","in":"query","description":"sites are separated by ','. If no value is passed, all sites are selected by default.","required":false,"schema":{"type":"string"}},{"name":"archived","in":"query","description":"archived","required":true,"schema":{"type":"boolean"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.startTime","in":"query","description":"Start timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.endTime","in":"query","description":"End timestamp, in seconds, such as 1682000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.severity","in":"query","description":"Threat Severity, such as 0:Critical, 1: Major, 2:Moderate, 3:Minor, 4:Low","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.time","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field Threat Description/Classification/Classification Description","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOIpsThreatOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/security/threat-management/top":{"get":{"tags":["Global Security"],"summary":"Get Global Top Threat List","description":"Get the number of threats in the global view top5","operationId":"getGlobalTopThreatList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"startTime","in":"query","description":"Start Time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"End Time","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTop5ThreatNumOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/security/threat-management/severity":{"get":{"tags":["Global Security"],"summary":"Get Threat Count","description":"Get the global view of the number of threats by severity level","operationId":"getThreatCount","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"startTime","in":"query","description":"Start Time","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"endTime","in":"query","description":"End Time","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseThreatSeverityOpenApiVO"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sdwan/sdwan-group/{groupId}/firstCheck":{"get":{"tags":["SD-WAN"],"summary":"First check SD-WAN group connection.","description":"First check the connection between devices in the SD-WAN group.","operationId":"firstCheckConnection","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"The ID of a SD-WAN Group","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSdWanGroupTunnelStatus"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sdwan/sdwan-group/saved/devices/{groupId}":{"get":{"tags":["SD-WAN"],"summary":"Get current SD-WAN devices.","description":"Get current SD-WAN devices that participate in the networking.","operationId":"getSdWanGroupDevices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"The ID of a SD-WAN Group","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSdWanCurrentSelectedDeviceInfo"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sdwan/sdwan-group/brief":{"get":{"tags":["SD-WAN"],"summary":"Get SD-WAN Group Grid brief info.","description":"Get all SD-WAN Group brief info.","operationId":"getGridSdWanGroupBrief","parameters":[{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOSdWanGroupBrief"}}}}},"x-order":16}},"/openapi/v1/{omadacId}/sdwan/sdwan-group/auto/groupName":{"get":{"tags":["SD-WAN"],"summary":"Auto create group name.","description":"Auto create group name.","operationId":"autoCreateSdWanGroupName","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseString"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/scenarios/difference":{"get":{"tags":["Site"],"summary":"Get scenario list difference","description":"Get a list of default scenarios for differentiation","operationId":"getScenarioListDifference","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSetScenarioDifferenceVO"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/roles/available":{"get":{"tags":["User and Role"],"summary":"Get available roles for creating new user","description":"Get available roles for creating new user.","operationId":"getAvailableRole","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListRoleBriefVO"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/privacy-policy":{"get":{"tags":["Controller Settings"],"summary":"Get privacy policy","description":"Get privacy policy","operationId":"getPrivacyPolicy","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePrivacy Policy"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/port/layout":{"get":{"tags":["Osw Port Layout"],"summary":"Get all osw port layout.","description":"Get all osw port layout.","operationId":"getOswPortLayoutVO","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/placed-site-position":{"get":{"tags":["Site"],"summary":"Obtain the geographic location information of Placed Sites","description":"Obtain the geographic location information of Placed Sites in batches.","operationId":"getPlacedSitePositions","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListPlaced Site"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/multi-devices/add/{operateId}/status":{"get":{"tags":["Device"],"summary":"Batch get added device status with multi site","description":"Batch get added device status with multi site.","operationId":"getAddDevicesStatusMultiSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"operateId","in":"path","description":"Add device operation ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDeviceAddProcessRespVO"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/maintenance/restore/result":{"get":{"tags":["Backup and Restore"],"summary":"Get controller restore result","description":"Get controller restore result.","operationId":"getRestoreResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestoreResultVO"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/maintenance/backup/result":{"get":{"tags":["Backup and Restore"],"summary":"Get controller backup result","description":"Get controller backup result.","operationId":"getBackupResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BackupResultOpenApiVO"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/maintenance/backup/files":{"get":{"tags":["Backup and Restore"],"summary":"Get controller backup file list in self server","description":"Get controller backup file list in self server.","operationId":"getSelfServerFileList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/BackupFileListVO"}}}}},"x-order":12}},"/openapi/v1/{omadacId}/mail/status":{"get":{"tags":["Controller Settings"],"summary":"Get mailServer status","description":"Get mailServer status","operationId":"getMailServerStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/logs/{upgradeLogId}/upgrade/overview/failed-model-firmware":{"get":{"tags":["Firmware"],"summary":"Get firmware information about the failed device to be upgraded","description":"Get firmware information about the failed device to be upgraded","operationId":"getUpgradeFailedDeviceFirmwareInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"upgradeLogId","in":"path","description":" The Upgrade log ID obtained from the interface (Get firmware upgrade logs)","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseFailedDeviceUpgradeFirmwareInfo"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/logs/{upgradeLogId}/upgrade/overview/failed-devices":{"get":{"tags":["Firmware"],"summary":"Get the list of devices which upgrade failed","description":"Get the list of devices which upgrade failed through upgrade logs","operationId":"getUpgradeFailedDeviceInfos","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"upgradeLogId","in":"path","description":" The Upgrade log ID obtained from the interface (Get firmware upgrade logs)","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOUpgradeFailedDeviceInfo"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/logs/events":{"get":{"tags":["Log"],"summary":"Get global event log list","description":"Get logs in global event log page.","operationId":"getEventLogsForGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.timeStart","in":"query","description":"Filter query parameters, support field 1679297710438","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.timeEnd","in":"query","description":"Filter query parameters, support field 1681889710438","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.module","in":"query","description":"Filter query parameters, support field module, it should be a value as follows: System, Device","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseEventLogGridVOEventLogOpenApiVO"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/logs/alerts":{"get":{"tags":["Log"],"summary":"Get global alert log list","description":"Get logs in global alert log page.","operationId":"getAlertLogsForGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.timeStart","in":"query","description":"Filter query parameters, support field 1679297710438","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.timeEnd","in":"query","description":"Filter query parameters, support field 1681889710438","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.module","in":"query","description":"Filter query parameters, support field module, it should be a value as follows: System, Device","required":false,"schema":{"type":"string"}},{"name":"filters.resolved","in":"query","description":"Filter query parameters, support field resolved, it should be a value as follows: true, false","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAlertLogGridVOAlertLogOpenApiVO"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/licenses/available-license":{"get":{"tags":["License"],"summary":"Get available license num","description":"Get available license number of the specified device category","operationId":"getLicenseNumByCategory","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"category","in":"query","description":"It should be a value as follows: basic; ap; l2Switch; l3Switch; gateway","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/LicenseBindAvailableNumOpenApiVO"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/hotspot/sites/{siteId}/setting/profiles/rateLimits":{"get":{"tags":["Profiles"],"summary":"get the rate limit list","description":"Query the rate limit list.","operationId":"listRateLimitForHotspot","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListRateLimitProfileVO"}}}}},"x-order":46}},"/openapi/v1/{omadacId}/grid/devices/upgradeable":{"get":{"tags":["shield"],"summary":"Get upgradeable devices on global view","description":"Get upgradeable devices on global view.","operationId":"getUpgradeableGridDevicesOnOmada","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.ecspFirstVersion","in":"query","description":"Filter query parameters, support field ecsp first version. 1: ecsp v1; 2: ecsp v2","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOUpgradeableDevices"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/global/gateways/wan-status":{"get":{"tags":["Gateway"],"summary":"Get global gateways wan status","description":"Get global gateways wan status","operationId":"getSpecifiedGatewayInfos","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOGateway Infos"}}}}},"x-order":36}},"/openapi/v1/{omadacId}/global/controller/setting/syslog/tip":{"get":{"tags":["Log"],"summary":"Get customer remote logging tip","description":"Get customer remote logging tip.","operationId":"getRemoteLoggingTip","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCustomerRemoteLogTipOpenApiVO"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/files/sitetemplates/{siteTemplateId}/acls/export":{"get":{"tags":["ACL (Template)"],"summary":"Export gateway custom ACL template rules","description":"Export gateway custom ACL template rules","operationId":"exportOsgCustomAclTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/files/sites/{siteId}/wifi-calling/summary/{format}":{"get":{"tags":["Wi-Fi Calling Traffic"],"summary":"Export wi-fi calling traffic summary","description":"Export wi-fi calling traffic summary.","operationId":"exportBatchFullChannelDetectResultData","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"format","in":"path","description":"export data format","required":true,"schema":{"type":"string"}},{"name":"timeStart","in":"query","description":"Filter query parameters, support field time range: start timestamp (second).","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"timeEnd","in":"query","description":"Filter query parameters, support field time range: end timestamp (second).","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field clientName,clientMac,ip,ssid,domain","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/files/sites/{siteId}/vpn/{vpnId}/certificate":{"get":{"tags":["VPN"],"summary":"Download Open VPN or SSL VPN certificate","description":"Download Open VPN or SSL VPN certificate. Filename is a UTF-8 string encoded by URL Encoder.","operationId":"downloadVpnCertificate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/files/sites/{siteId}/full-channel-detect/{historyId}":{"get":{"tags":["Insight"],"summary":"Export batch interference detection results","description":"Export batch interference detection results","operationId":"exportBatchFullChannelDetectResultData_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"historyId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"format","in":"query","description":"export data format","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":31}},"/openapi/v1/{omadacId}/files/sites/{siteId}/aps/{apMac}/full-channel-detect/export":{"get":{"tags":["Insight"],"summary":"Export interference detection results","description":"Export interference detection results","operationId":"exportFullChannelDetectResult","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"format","in":"query","description":"export data format","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":39}},"/openapi/v1/{omadacId}/files/sites/{siteId}/acls/export":{"get":{"tags":["ACL"],"summary":"Export gateway custom ACL rules","description":"Export gateway custom ACL rules","operationId":"exportOsgCustomAcl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":31}},"/openapi/v1/{omadacId}/dst-info":{"get":{"tags":["Controller Settings"],"summary":"Get controller DST","description":"Get controller DST","operationId":"getOmadacDstInfo_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDstOpenApiVO"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/devices":{"get":{"tags":["Device"],"summary":"Global search for devices returns the devices under the sites that have permissions.","description":"Global search for devices returns the devices under the sites that have permissions.","operationId":"searchGlobalDevice","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"searchKey","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGlobalSearchResultOpenApiVO"}}}}},"x-order":28}},"/openapi/v1/{omadacId}/devices/upgradeable/stat":{"get":{"tags":["shield"],"summary":"Get upgradeable device statistics on global view","description":"Get upgradeable device statistics on global view.","operationId":"getUpgradeableDevicesStatOnOmada","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUpgradeableDevicesStat"}}}}},"x-order":4}},"/openapi/v1/{omadacId}/devices/unknown-devices":{"get":{"tags":["Device"],"summary":"Get global unknown device list","description":"Get global unknown device list.","operationId":"getGlobalUnknownDeviceList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.mac","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchMacs","in":"query","description":"Fuzzy query parameters, support field mac","required":false,"schema":{"type":"string"}},{"name":"searchNames","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}},{"name":"searchModels","in":"query","description":"Fuzzy query parameters, support field model","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOGlobalUnknownDeviceOpenApiVO"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/devices/stat":{"get":{"tags":["Device"],"summary":"Query the statistics for the list of global adopted devices.","description":"Query the statistics for the list of global adopted devices.","operationId":"getGridAdoptedDevicesStatByGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.status","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.ip","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name,mac,ip","required":false,"schema":{"type":"string"}},{"name":"filters.tag","in":"query","description":"Filter query parameters, support field tag name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGlobalDeviceStatOpenApiVO"}}}}},"x-order":30}},"/openapi/v1/{omadacId}/devices/known-devices":{"get":{"tags":["Device"],"summary":"Get global known device list","description":"Get global known device list.","operationId":"getGlobalKnownDeviceList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.mac","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchMacs","in":"query","description":"Fuzzy query parameters, support field mac","required":false,"schema":{"type":"string"}},{"name":"searchNames","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}},{"name":"searchModels","in":"query","description":"Fuzzy query parameters, support field model","required":false,"schema":{"type":"string"}},{"name":"searchSns","in":"query","description":"Fuzzy query parameters, support field sn","required":false,"schema":{"type":"string"}},{"name":"filters.tag","in":"query","description":"Filter query parameters, support field tag ID","required":false,"schema":{"type":"string"}},{"name":"filters.deviceSeriesType","in":"query","description":"Filter query parameters, support field Device series type. 0: basic; 1: pro.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOGlobalKnownDeviceOpenApiVO"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/devices/batch/info":{"get":{"tags":["Device"],"summary":"Batch get info of adopted device in global view.","description":"Batch get info of adopted device in global view.","operationId":"getAdoptAbleDevicesForGlobalBatchAdopt","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.status","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.ip","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name,mac,ip","required":false,"schema":{"type":"string"}},{"name":"filters.tag","in":"query","description":"Filter query parameters, support field tag name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListBriefDeviceInfoDetailForBatchAdoptOpenApiVO"}}}}},"x-order":25}},"/openapi/v1/{omadacId}/devices/add/{operateId}/export":{"get":{"tags":["Device"],"summary":"Export the device file that failed to add in GLOBAL view.","description":"Export the device file that failed to add in GLOBAL view. Format should be a number as follows. 0 means CSV , 1 means XLSX.","operationId":"exportAddFailDevices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"operateId","in":"path","description":"Operation ID","required":true,"schema":{"type":"string"}},{"name":"format","in":"query","description":"File format. 0: CSV, 1: XLSX","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":36}},"/openapi/v1/{omadacId}/dashboard/overview-without-client":{"get":{"tags":["Global Dashboard Overview"],"summary":"Get global dashboard overview","description":"global dashboard overview.","operationId":"getGernalSettings_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGlobalOverViewOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/correction-list":{"get":{"tags":["Client"],"summary":"Get client correction options list","description":"Get client correction options list","operationId":"getClientCorrectionList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseClientCorrectionOptionListVO"}}}}},"x-order":13}},"/openapi/v1/{omadacId}/copy/site/template/batch/customers":{"get":{"tags":["Customer"],"summary":"Obtain the customer ID with permission to modify site templates","description":"Obtain the IDs of customers whose site templates the current user has permission to modify.","operationId":"getCustomersInGlobalHaveSiteTemplateModify","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListCustomerInfoOpenApiVO"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/controller/features":{"get":{"tags":["APP Controller Settings"],"summary":"Get health tip feature","description":"Get health tip feature. Whether to display a health notification pop-up (pop-up styles vary).","operationId":"getFeatures","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseRead Features Result"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/controller/client/history-enable":{"get":{"tags":["Client"],"summary":"Get History data retention config.","description":"Get history data retention config.","operationId":"getClientHistoryDataEnable","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOmadacClientSettingOpenApiVO"}}}}},"x-order":14}},"/openapi/v1/{omadacId}/cloud/user":{"get":{"tags":["Cloud User"],"summary":"Get cloud user information","description":"Get cloud user information, only for remote access.","operationId":"getCloudUserInfo","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/cloud/status":{"get":{"tags":["Cloud User"],"summary":"Get cloud access status","description":"Get cloud access status.","operationId":"getCloudAccessStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCloudAccessOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/{omadacId}/cloud/remote/bind/status":{"get":{"tags":["Cloud User"],"summary":"Get remote bind status","description":"Get remote bind status.only for combined gateway controller","operationId":"getRemoteBindingStatus","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseRemoteBindingOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/audit-logs":{"get":{"tags":["Audit Log"],"summary":"Get global audit log list","description":"Get audit logs in global audit page.","operationId":"getAuditLogsForGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.time","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"filters.result","in":"query","description":"Filter query parameters, support field result,it should be a value as follows: 0: successful; 1: failed,example:0","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"filters.level","in":"query","description":"Filter query parameters, support field level,it should be a value as follows: Error; Warning; Information, example:Error","required":false,"schema":{"type":"string"}},{"name":"filters.auditTypes","in":"query","description":"Filter query parameters, support field auditTypes, for the values of auditLog type, refer to section 5.2.2 of the Open API Access Guide, example:Log,Cloud Access,User Interface.","required":false,"schema":{"type":"string"}},{"name":"filters.times","in":"query","description":"Filter query parameters, support field times, example:[{\"timeStart\":1678060800000,\"timeEnd\":1678665599999}](UrlEncode:%5B%7B%22timeStart%22%3A1678060800000%2C%22timeEnd%22%3A1678665599999%7D%5D).If this parameter is not specified (not included or empty array), the interface will query data within the default time period: [{\"timeStart\":  Current timestamp minus milliseconds of 7 days,\"timeEnd\": Current timestamp}].","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field content","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOAuditLogOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/{omadacId}/all-users":{"get":{"tags":["User and Role"],"summary":"Get user list for app","description":"Get user list. This interface only supports the authorization code mode, not the client mode. Please call this interface in authorization code mode.","operationId":"getAppGridUsers","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.roleId","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.email","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field userName","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOControllerUserAppVO"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/adopt-tip":{"get":{"tags":["Device"],"summary":"Get adopt tip","description":"Get adopt tip","operationId":"getAdoptTip","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAdoptTipOpenApiVO"}}}}},"x-order":46}},"/openapi/v1/{omadacId}/account/user/favorite-sites":{"get":{"tags":["app"],"summary":"Query favorite site of user","description":"Query favorite site of user","operationId":"getUserFavoriteSites","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseFavoriteSitesVO"}}}}},"x-order":5}},"/openapi/v1/msp/{mspId}/webhook/settings/dispatch-logs":{"get":{"tags":["Msp Webhook Setting"],"summary":"Get MSP webhook dispatch log list","description":"Get MSP webhook dispatch log list.","operationId":"getWebhookLogsForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.webhookId","in":"query","description":"Filter query parameters, support field d66aed17ea7238154ba610710d9a2890","required":true,"schema":{"type":"string"}},{"name":"filters.timeStart","in":"query","description":"Filter query parameters, support field 1679297710438","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.timeEnd","in":"query","description":"Filter query parameters, support field 1681889710438","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOOpenApiWebhookDispatchLogVO"}}}}},"x-order":6}},"/openapi/v1/msp/{mspId}/users/local":{"get":{"tags":["MSP User and Role"],"summary":"Get all MSP local users exclude owner","operationId":"getAllMspLocalUsersExcludeRoot","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGetUserListResponseVO"}}}}},"x-order":6}},"/openapi/v1/msp/{mspId}/users/cloud":{"get":{"tags":["MSP User and Role"],"summary":"Get all MSP cloud users exclude owner","operationId":"getAllMspCloudUsersExcludeRoot","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGetUserListResponseVO"}}}}},"x-order":6}},"/openapi/v1/msp/{mspId}/stack":{"get":{"tags":["Stack"],"summary":"Get msp stack List","description":"Get msp stack List.","operationId":"getMspOswStackList","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/msp/{mspId}/sso/external-users":{"get":{"tags":["MSP SSO"],"summary":"Get msp external user list","description":"Get msp external user list.","operationId":"getExternalUserList_1","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.userName","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field userName","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMspExternalUserDetailOpenApiVO"}}}}},"x-order":9}},"/openapi/v1/msp/{mspId}/sites":{"get":{"tags":["MSP Site"],"summary":"Get msp site list","description":"Get msp site list","operationId":"getSiteList_1","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}},{"name":"filters.tag","in":"query","description":"Filter query parameters, support field tag ID","required":false,"schema":{"type":"string"}},{"name":"filters.type","in":"query","description":"Filter query parameters, support field site type. 0: basic site; 1: pro site.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMspSiteSummaryInfo"}}}}},"x-order":1}},"/openapi/v1/msp/{mspId}/sites/tags":{"get":{"tags":["MSP Site"],"summary":"Get msp site tag list","description":"Get msp site tag list.","operationId":"getTags_2","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Site Tag"}}}}}},"x-order":2}},"/openapi/v1/msp/{mspId}/roles/customer/roles/available":{"get":{"tags":["MSP User and Role"],"summary":"Get available customer roles for creating new user","description":"Get available customer roles for creating new user.","operationId":"getAvailableCustomerRoles","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListRoleBriefVO"}}}}},"x-order":16}},"/openapi/v1/msp/{mspId}/roles/available":{"get":{"tags":["MSP User and Role"],"summary":"Get available MSP roles for creating new user","description":"Get available MSP roles for creating new user.","operationId":"getAvailableMspRoles","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListRoleBriefVO"}}}}},"x-order":15}},"/openapi/v1/msp/{mspId}/privacy-policy":{"get":{"tags":["Msp setting"],"summary":"Get msp privacy policy","description":"Get msp privacy policy","operationId":"getPrivacyPolicyMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponsePrivacy Policy"}}}}},"x-order":7}},"/openapi/v1/msp/{mspId}/port/layout":{"get":{"tags":["Msp Osw Port Layout"],"summary":"Get all msp osw port layout.","description":"Get all msp osw port layout.","operationId":"getMspOswPortLayoutVO","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":1}},"/openapi/v1/msp/{mspId}/logs/events":{"get":{"tags":["Msp Log"],"summary":"Get MSP event log list","description":"Get logs in MSP event log page.","operationId":"getEventLogsForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.timeStart","in":"query","description":"Filter query parameters, support field 1679297710438","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.timeEnd","in":"query","description":"Filter query parameters, support field 1681889710438","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.module","in":"query","description":"Filter query parameters, support field module, it should be a value as follows: System, Device","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseEventLogGridVOEventLogOpenApiVO"}}}}},"x-order":7}},"/openapi/v1/msp/{mspId}/logs/alerts":{"get":{"tags":["Msp Log"],"summary":"Get MSP alert log list","description":"Get logs in MSP alert log page.","operationId":"getAlertLogsForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.timeStart","in":"query","description":"Filter query parameters, support field 1679297710438","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.timeEnd","in":"query","description":"Filter query parameters, support field 1681889710438","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.module","in":"query","description":"Filter query parameters, support field module, it should be a value as follows: System, Device","required":false,"schema":{"type":"string"}},{"name":"filters.resolved","in":"query","description":"Filter query parameters, support field resolved, it should be a value as follows: true, false","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAlertLogGridVOAlertLogOpenApiVO"}}}}},"x-order":8}},"/openapi/v1/msp/{mspId}/license/used":{"get":{"tags":["Msp License"],"summary":"Get used license info list for assign or recycle license","description":"Get used license info list for assign or recycle license.","operationId":"getUsedLicenseForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"query","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"category","in":"query","description":"It should be a value as follows: basic; ap; l2Switch; l3Switch; gateway","required":true,"schema":{"type":"string"}},{"name":"assign","in":"query","description":"Assign license: true; recycle license: false","required":true,"schema":{"type":"boolean"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GridVOUsedLicenseDetailOpenApiVO"}}}}},"x-order":3}},"/openapi/v1/msp/{mspId}/grid/devices/upgradeable":{"get":{"tags":["shield"],"summary":"Get upgradeable devices on msp view","description":"Get upgradeable devices on msp view.","operationId":"getUpgradeableGridDevicesOnMsp","parameters":[{"name":"mspId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"filters.ecspFirstVersion","in":"query","description":"Filter query parameters, support field ecsp first version. 1: ecsp v1; 2: ecsp v2","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOUpgradeableDevices"}}}}},"x-order":3}},"/openapi/v1/msp/{mspId}/dst-info":{"get":{"tags":["Msp setting"],"summary":"Get msp DST","description":"Get msp DST","operationId":"getMspDstInfo","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseDstOpenApiVO"}}}}},"x-order":8}},"/openapi/v1/msp/{mspId}/devices/upgradeable/stat":{"get":{"tags":["shield"],"summary":"Get upgradeable device statistics on msp view","description":"Get upgradeable device statistics on msp view.","operationId":"getUpgradeableDevicesStatOnMsp","parameters":[{"name":"mspId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseUpgradeableDevicesStat"}}}}},"x-order":5}},"/openapi/v1/msp/{mspId}/devices/unknown-devices":{"get":{"tags":["MSP Device"],"summary":"Get MSP unknown device list","description":"Get MSP unknown device list","operationId":"getMspUnknownDeviceList","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchMacs","in":"query","description":"Fuzzy query parameters, support field mac","required":false,"schema":{"type":"string"}},{"name":"searchNames","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}},{"name":"searchModels","in":"query","description":"Fuzzy query parameters, support field model","required":false,"schema":{"type":"string"}},{"name":"filters.deviceSeriesType","in":"query","description":"Filter query parameters, support field Device series type. 0: basic; 1: pro.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMspUnknownDeviceOpenApiVO"}}}}},"x-order":2}},"/openapi/v1/msp/{mspId}/devices/tag":{"get":{"tags":["MSP Device"],"summary":"Get tag list","description":"Get tag list.","operationId":"getTags_3","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListTagRespOpenApiVO"}}}}},"x-order":3}},"/openapi/v1/msp/{mspId}/devices/known-devices":{"get":{"tags":["MSP Device"],"summary":"Get MSP known device list","description":"Get MSP known device list","operationId":"getMspKnownDeviceList","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"searchMacs","in":"query","description":"Fuzzy query parameters, support field mac","required":false,"schema":{"type":"string"}},{"name":"searchNames","in":"query","description":"Fuzzy query parameters, support field name","required":false,"schema":{"type":"string"}},{"name":"searchModels","in":"query","description":"Fuzzy query parameters, support field model","required":false,"schema":{"type":"string"}},{"name":"searchSns","in":"query","description":"Fuzzy query parameters, support field sn","required":false,"schema":{"type":"string"}},{"name":"filters.tag","in":"query","description":"Filter query parameters, support field tag ID","required":false,"schema":{"type":"string"}},{"name":"filters.deviceSeriesType","in":"query","description":"Filter query parameters, support field Device series type. 0: basic; 1: pro.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMspKnownDeviceOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/msp/{mspId}/devices/batch/info":{"get":{"tags":["Device"],"summary":"Batch get info of adopted device in MSP view.","description":"Batch get info of adopted device in MSP view.","operationId":"getAdoptAbleDevicesForMspBatchAdopt","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.status","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.ip","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field name,mac,ip","required":false,"schema":{"type":"string"}},{"name":"filters.tag","in":"query","description":"Filter query parameters, support field tag name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListBriefDeviceInfoDetailForBatchAdoptOpenApiVO"}}}}},"x-order":26}},"/openapi/v1/msp/{mspId}/dashboard/client/overview-diagram":{"get":{"tags":["Client Insight"],"summary":"Get the msp overview diagram of client.","description":"Get the msp overview diagram of client","operationId":"getMspDashboardOverall","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseMspClientOverallVO"}}}}},"x-order":8}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/switches/{switchMac}/health/timeline":{"get":{"tags":["Health"],"summary":"Get msp switch health time line","description":"Get msp switch health time line","operationId":"getMspOswHealthTimeList","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTimeScoreListVO"}}}}},"x-order":13}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/switches/{switchMac}/health/detail":{"get":{"tags":["Health"],"summary":"Get msp switch health detail","description":"Get msp switch health detail","operationId":"getMspOswHealthDetail","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOswHealthDetailVO"}}}}},"x-order":12}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/stack/{stackId}":{"get":{"tags":["Stack"],"summary":"Get msp stack detail","description":"Get msp stack detail.","operationId":"getMspOswStackDetail","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"customerId","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"stackId","in":"path","description":"Stack ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":4}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/olts/{deviceMac}/system/system-info/configs":{"get":{"tags":["OLT"],"summary":"Get OLT description info(MSP mode)","description":"Get OLT description info(MSP mode)","operationId":"getConfigForMsp","parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"mspId","in":"path","description":"mspId","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"customerId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseSystemInfoAppDTO"}}}}},"x-order":13}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/olts/{deviceMac}/pon/pon-port/configs/list":{"get":{"tags":["OLT Pon Port"],"summary":"Get pon port list(msp mode)","description":"Get pon port list(msp mode)","operationId":"getPonPortListMsp","parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"mspId","in":"path","description":"mspId","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"customerId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListPonPortDTO"}}}}},"x-order":63}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/olts/{deviceMac}/l2-feature/eth-port/port/unit1/list":{"get":{"tags":["OLT"],"summary":"Get ETH Unit1 port list of olt(MSP mode)","description":"Get ETH Unit1 port list of olt(MSP mode)","operationId":"getPortsConfigListForMsp","parameters":[{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"deviceMac","in":"path","description":"Device MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"mspId","in":"path","description":"mspId","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"customerId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListEthUnit1PortAppDTO"}}}}},"x-order":8}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/health/incident/{mac}":{"get":{"tags":["MSP Device"],"summary":"MSP - Get device/client health incidents","description":"MSP view: Get incident list for device/client health detail page. customerId is omadacId.","operationId":"getMspObjectHealthIncident","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID (same as omadacId)","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"filters.startTime","in":"query","description":"Start time in milliseconds","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"filters.endTime","in":"query","description":"End time in milliseconds","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListAnomalyBriefCountVO"}}}}}}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/gateways/{gatewayMac}/health/timeline":{"get":{"tags":["Health"],"summary":"Get msp gateway health time line","description":"Get msp gateway health time line","operationId":"getMspOsgHealthTimeList","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTimeScoreListVO"}}}}},"x-order":8}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/gateways/{gatewayMac}/health/detail":{"get":{"tags":["Health"],"summary":"Get msp gateway health detail","description":"Get msp gateway health detail","operationId":"getMspOsgHealthDetail","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"wirelessRouter","in":"query","description":"Whether the device is a wireless router","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOsgHealthDetailVO"}}}}},"x-order":7}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/eth-port/and/pon-port/list":{"get":{"tags":["OLT"],"summary":"Get pon port and eth port of OLT(MSP mode)","description":"Get pon port and eth port of OLT(MSP mode)","operationId":"getEthAndPonListForMsp","parameters":[{"name":"mspId","in":"path","description":"mspId","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"customerId","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseEthAndPonListDTO"}}}}},"x-order":19}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/eaps/{apMac}/health/timeline":{"get":{"tags":["Health"],"summary":"Get msp ap health time line","description":"Get msp ap health time line","operationId":"getMspApHealthTimeList","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseTimeScoreListVO"}}}}},"x-order":4}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/eaps/{apMac}/health/detail":{"get":{"tags":["Health"],"summary":"Get msp ap health detail","description":"Get msp ap health detail","operationId":"getMspApHealthDetail","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"start","in":"query","description":"Start timestamp, in milliseconds, such as 174951360000","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"end","in":"query","description":"End timestamp, in milliseconds, such as 1749600000000","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApHealthDetailVO"}}}}},"x-order":3}},"/openapi/v1/msp/{mspId}/customers/{customerId}/sites/{siteId}/aps/{apMac}/mesh/statistics":{"get":{"tags":["Ap"],"summary":"Get AP mesh statistics for MSP view","description":"Get AP mesh statistics for MSP view","operationId":"getMeshStatisticsForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"apMac","in":"path","description":"AP MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseApMeshStatisticsOpenApiVO"}}}}},"x-order":66}},"/openapi/v1/msp/{mspId}/customers/{customerId}/devices/add/{operateId}/export":{"get":{"tags":["Device"],"summary":"Export the device file that failed to add in MSP view.","description":"Export the device file that failed to add in MSP view. Format should be a value as follows. 0 means CSV , 1 means XLSX.","operationId":"exportMspAddFailDevices","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"customerId","in":"path","description":"Customer ID","required":true,"schema":{"type":"string"}},{"name":"operateId","in":"path","description":"Operation ID","required":true,"schema":{"type":"string"}},{"name":"format","in":"query","description":"File format. 0: CSV, 1: XLSX","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":37}},"/openapi/v1/msp/{mspId}/customer-roles":{"get":{"tags":["MSP User and Role"],"summary":"Get customer role list in msp","description":"Get customer role list in msp","operationId":"getAllCustomerRoles","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListControllerRoleDetailVO"}}}}},"x-order":11}},"/openapi/v1/msp/{mspId}/controller/features":{"get":{"tags":["APP Controller Settings"],"summary":"Get health tip feature in Msp View","description":"Get health tip feature in Msp View. Whether to display a health notification pop-up (pop-up styles vary).","operationId":"getMspFeatures","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseRead Features Result"}}}}},"x-order":6}},"/openapi/v1/msp/{mspId}/cluster/nodes/info":{"get":{"tags":["Cluster"],"summary":"Get msp cluster nodes information.","description":"Get msp cluster nodes information.","operationId":"getMspClusterNodesInfo","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListNodeInfoVO"}}}}},"x-order":1}},"/openapi/v1/msp/{mspId}/cloud/status":{"get":{"tags":["Cloud User"],"summary":"Get MSP cloud access status","description":"Get MSP cloud access status.","operationId":"getMspCloudAccessStatus","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCloudAccessOpenApiVO"}}}}},"x-order":3}},"/openapi/v1/msp/{mspId}/audit-logs":{"get":{"tags":["Msp Log"],"summary":"Get MSP audit log list","description":"Get audit logs in msp audit page.","operationId":"getAuditLogsForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100)","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.time","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"filters.result","in":"query","description":"Filter query parameters, support field result,it should be a value as follows: 0: successful; 1: failed,example:0","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"filters.level","in":"query","description":"Filter query parameters, support field level,it should be a value as follows: Error; Warning; Information, example:Error","required":false,"schema":{"type":"string"}},{"name":"filters.auditTypes","in":"query","description":"Filter query parameters, support field auditTypes, for the values of auditLog type, refer to section 5.2.2 of the Open API Access Guide, example:Log,Cloud Access,User Interface.","required":false,"schema":{"type":"string"}},{"name":"filters.times","in":"query","description":"Filter query parameters, support field times, example:[{\"timeStart\":1678060800000,\"timeEnd\":1678665599999}](UrlEncode:%5B%7B%22timeStart%22%3A1678060800000%2C%22timeEnd%22%3A1678665599999%7D%5D).If this parameter is not specified (not included or empty array), the interface will query data within the default time period: [{\"timeStart\":  Current timestamp minus milliseconds of 7 days,\"timeEnd\": Current timestamp}].","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field content","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOAuditLogOpenApiVO"}}}}},"x-order":1}},"/openapi/v1/msp/{mspId}/all-users":{"get":{"tags":["MSP User and Role"],"summary":"Get msp user list for app","description":"Get msp user list. This interface only supports the authorization code mode, not the client mode. Please call this interface in authorization code mode.","operationId":"getMspAppGridUsers","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Start page number. Start from 1.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Number of entries per page. It should be within the range of 1–1000.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"sorts.name","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.roleId","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.email","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"sorts.customerRoleId","in":"query","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect","required":false,"schema":{"type":"string"}},{"name":"searchKey","in":"query","description":"Fuzzy query parameters, support field userName","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGridVOMspUserVO"}}}}},"x-order":8}},"/openapi/v1/msp/{mspId}/adopt-tip":{"get":{"tags":["Device"],"summary":"MSP get adopt tip","description":"MSP get adopt tip","operationId":"getMspAdoptTip","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseAdoptTipOpenApiVO"}}}}},"x-order":52}},"/openapi/v1/msp/{mspId}/account/mail-status":{"get":{"tags":["Msp setting"],"summary":"Get MSP mailServer status","description":"Get MSP mailServer status","operationId":"getMspMailServerStatusGlobal","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":10}},"/internal/api/v2/omadacs/{omadacId}/licenseusers":{"get":{"tags":["abutment-omada-cloud-controller"],"operationId":"getLicenseUsers","parameters":[{"name":"omadacId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListUsersResponseDTO"}}}}}}},"/internal/api/v2/omadacs/{customizeOmadacId}/sites":{"get":{"tags":["abutment-omada-cloud-controller"],"operationId":"getSiteListByPage","parameters":[{"name":"customizeOmadacId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","required":true,"schema":{"type":"string"}},{"name":"query","in":"query","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGetSiteListByPageResponseDTO"}}}}}}},"/internal/api/v2/omadacs/{customizeOmadacId}/customers":{"get":{"tags":["abutment-omada-cloud-controller"],"operationId":"getCustomerListByPage","parameters":[{"name":"customizeOmadacId","in":"path","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","required":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","required":true,"schema":{"type":"string"}},{"name":"query","in":"query","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseGetCustomerListByPageResponseDTO"}}}}}}},"/internal/api/v2/omadacs/{customizeOmadacId}/check/status":{"get":{"tags":["abutment-omada-cloud-controller"],"operationId":"checkStatus","parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"customizeOmadacId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCheckStatusResponseDTO"}}}}}}},"/internal/api/v2/omadacs/checkCBCPrivileges":{"get":{"tags":["abutment-omada-cloud-controller"],"operationId":"checkCBCPrivileges","parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseCheckCBCPrivilegesDTO"}}}}}}},"/internal/api/v2/omadacs/basicInfo":{"get":{"tags":["abutment-omada-cloud-controller"],"operationId":"listOmadacsByBasicInfo","parameters":[{"name":"accountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"customizeOmadacId","in":"query","required":false,"schema":{"type":"string"}},{"name":"query","in":"query","required":false,"schema":{"type":"string"}},{"name":"pageSize","in":"query","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseOmadacBasicInfoResponseDTO"}}}}}}},"/openapi/v2/{omadacId}/sites/{siteId}/vpn/{vpnId}":{"delete":{"tags":["VPN"],"summary":"Delete VPN V2","description":"Delete VPN V2.","operationId":"deleteVpnV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":6}},"/openapi/v2/{omadacId}/sites/{siteId}/setting/iot/devices/config/batch":{"delete":{"tags":["Bluetooth"],"summary":"Batch delete Bluetooth Advertising v2","description":"Batch delete Bluetooth Advertising v2.","operationId":"batchDeleteBtIbeaconConfigV2","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchDeleteCommonOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/voip/provider-profiles/delete":{"delete":{"tags":["VoIP (Template)"],"summary":"Delete provider profile(s) template","description":"Delete provider profile(s) template.","operationId":"deleteProviderProfiles_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteProviderProfileTemplateEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListProfilesBindedDeviceInfo"}}}}},"x-order":15}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/voip/call-blocking/delete":{"delete":{"tags":["VoIP (Template)"],"summary":"Delete call blocking profile template","description":"Delete call blocking profile template.","operationId":"deleteCallBlockingProfile_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCallBlockingProfileEntity"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListProfilesBindedDeviceInfo"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/setting/iot/servers/batch-delete":{"delete":{"tags":["Bluetooth(Template)"],"summary":"Batch delete IoT Transport Stream(Template)","description":"Batch delete IoT Transport Stream setting in site template.","operationId":"batchDeleteIotServerTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchDeleteCommonOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/network-security/ips/allow-list/{entryId}":{"delete":{"tags":["IDS/IPS (Template)"],"summary":"Delete template allow list","description":"Delete template allow List by entry id.","operationId":"deleteTemplateAllowList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site Template ID","required":true,"schema":{"type":"string"}},{"name":"entryId","in":"path","description":"Allow entry ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":6}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/cli/configs/cli-type/{cliType}":{"delete":{"tags":["CLI (Template)"],"summary":"Delete the CLI template configuration","description":"Delete the CLI template configuration","operationId":"deleteCliConfigTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"cliType","in":"path","description":"CLI type should be a value as follows: 0: site CLI; 1: device CLI； 2：model CLI. Site template only supports site CLI. Site template only supports site CLI.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCliTemplateOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/acls/{aclId}":{"delete":{"tags":["ACL (Template)"],"summary":"Delete Gateway/AP ACL template","description":"Delete Gateway/AP ACL template.","operationId":"deleteAclTemplate","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteTemplateId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"aclId","in":"path","description":"ACL ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":8}},"/openapi/v1/{omadacId}/sites/{siteId}/vpn/{vpnId}":{"delete":{"tags":["VPN"],"summary":"Delete VPN","description":"Delete VPN. This interface has been deprecated. Please use the following interfaces instead: Delete VPN V2. This interface had been deprecated.","operationId":"deleteVpn","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"vpnId","in":"path","description":"VPN ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":37}},"/openapi/v1/{omadacId}/sites/{siteId}/voip/call-log/delete-all":{"delete":{"tags":["VoIP"],"summary":"Delete Voip CallLog Data List","description":"Delete Voip CallLog Data List.","operationId":"clearVoipCallLog","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/process/{ospfProcessId}":{"delete":{"tags":["OSPF"],"summary":"Delete Ospf Process","description":"Delete Ospf Process.","operationId":"deleteOspfProcess","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"ospfProcessId","in":"path","description":"Ospf Process ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":9}},"/openapi/v1/{omadacId}/sites/{siteId}/switches/{switchMac}/interface/{ospfInterfaceId}":{"delete":{"tags":["OSPF"],"summary":"Delete Ospf Interface","description":"Delete Ospf Interface.","operationId":"deleteOspfInterface","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"switchMac","in":"path","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"ospfInterfaceId","in":"path","description":"Ospf Interface ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/stat/dpi":{"delete":{"tags":["Application Control"],"summary":"Clear DPI data","description":"Clear all DPI data.","operationId":"clearDpiData","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearDpiDataRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseListFamilyEntity"}}}}},"x-order":17}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voice-mail/batch-delete":{"delete":{"tags":["VoIP"],"summary":"Batch delete voice mail","description":"Batch delete voice mail","operationId":"deleteVoipMail","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoiceMailBatchDelete"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":38}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/voip/voice-mail/all":{"delete":{"tags":["VoIP"],"summary":"Delete all voice mail","description":"Delete all voice mail","operationId":"deleteTelephoneNumber_1","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":37}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/iot/servers/batch-delete":{"delete":{"tags":["Bluetooth"],"summary":"Batch Delete IoT Transport Stream","description":"Batch Delete IoT Transport Stream.","operationId":"batchDeleteIotServer","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchDeleteCommonOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/setting/iot/devices/config/batch":{"delete":{"tags":["Bluetooth"],"summary":"Batch delete Bluetooth Advertising","description":"Batch delete Bluetooth Advertising. Note:The parameter [transmitPower] is deprecated, all devices with transmit power configured via this v1 interface will have their transmit power configuration set to override on the new radio setting page. If you want to configure Transmit Power in Bluetooth -> Radio Setting, configure Bluetooth Advertising using v2 interface.","operationId":"batchDeleteBtIbeaconConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchDeleteCommonOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"deprecated":true,"x-order":10}},"/openapi/v1/{omadacId}/sites/{siteId}/report/tab/{tabIds}":{"delete":{"tags":["Report v2"],"summary":"Batch delete tabs","description":"Batch delete the tabs by id list","operationId":"deleteTabNetworkReport","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"tabIds","in":"path","description":"tab ID list","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/network-security/ips/block-list/{entryId}":{"delete":{"tags":["IDS/IPS"],"summary":"Delete block list","description":"Delete block list by entry id.","operationId":"deleteBlockList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"entryId","in":"path","description":"Block entry ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":7}},"/openapi/v1/{omadacId}/sites/{siteId}/network-security/ips/allow-list/{entryId}":{"delete":{"tags":["IDS/IPS"],"summary":"Delete allow list","description":"Delete allow List by entry id.","operationId":"deleteAllowList","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"entryId","in":"path","description":"Allow entry ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/sites/{siteId}/monitor-device/delete":{"delete":{"tags":["Intelli Recover Device"],"summary":"Delete the intelli recover device","description":"Delete the intelli recover device","operationId":"deleteMonitorDevices","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteIntelliRecoverDevice"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/monitor-client/delete":{"delete":{"tags":["Intelli Recover Client"],"summary":"Delete the intelli recover client","description":"Delete the intelli recover client","operationId":"deleteMonitorClients","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteIntelliRecoverClient"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":3}},"/openapi/v1/{omadacId}/sites/{siteId}/logs/events/delete":{"delete":{"tags":["Log"],"summary":"Delete site event log","description":"Delete site event log.","operationId":"deleteEventLogsForSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteSiteEventLogListOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":20}},"/openapi/v1/{omadacId}/sites/{siteId}/logs/alerts/delete":{"delete":{"tags":["Log"],"summary":"Delete site alert log","description":"Delete site alert log.","operationId":"deleteAlertLogsForSite","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteSiteAlertLogListOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":21}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/voucher-groups/{groupId}/clear-invalid":{"delete":{"tags":["Voucher"],"summary":"Delete expired vouchers in a voucher group","description":"Delete expired vouchers in a voucher group.","operationId":"clearInvalidVouchersInaGroup","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"groupId","in":"path","description":"Voucher Group ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/sites/{siteId}/hotspot/authed-records/{id}":{"delete":{"tags":["Authorized Client"],"summary":"Delete given authed record","description":"Delete the authentication record with the given omadacId, siteId, authClientId.","operationId":"deleteHotspotAuthedClient","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Authed record ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/full-channel-detect":{"delete":{"tags":["Insight"],"summary":"Delete all interference detection history","description":"Delete all interference detection history","operationId":"deleteALLBatchFullChannelDetectHistory","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/sites/{siteId}/full-channel-detect/{historyId}":{"delete":{"tags":["Insight"],"summary":"Delete the interference detection history","description":"Delete the interference detection history","operationId":"deleteBatchFullChannelDetectHistory","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"historyId","in":"path","description":"The ID List of full channel detect","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":23}},"/openapi/v1/{omadacId}/sites/{siteId}/cli/configs/cli-type/{cliType}":{"delete":{"tags":["CLI"],"summary":"Delete the CLI configuration","description":"Delete the CLI configuration","operationId":"deleteCliConfig","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"cliType","in":"path","description":"CLI type should be a value as follows: 0: site CLI; 1: device CLI； 2：model CLI. Site template only supports site CLI. Site template only supports site CLI.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCliOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":5}},"/openapi/v1/{omadacId}/sites/{siteId}/anomaly/incident":{"delete":{"tags":["Incidents"],"summary":"Delete incidents","description":"Delete incidents from the incident list. For select-all operations, if both start and end are omitted, the server defaults to the last 30 days; a supplied time range is preserved.","operationId":"deleteIncidents","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAnomalyListSettingVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseObject"}}}}}}},"/openapi/v1/{omadacId}/sites/{siteId}/acls/{aclId}":{"delete":{"tags":["ACL"],"summary":"Delete ACL","description":"Delete ACL.","operationId":"deleteAcl","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"aclId","in":"path","description":"ACL ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/openapi/v1/{omadacId}/logs/events/delete":{"delete":{"tags":["Log"],"summary":"Delete global event log","description":"Delete global event log.","operationId":"deleteEventLogsForGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteGlobalEventLogListOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":18}},"/openapi/v1/{omadacId}/logs/alerts/delete":{"delete":{"tags":["Log"],"summary":"Delete global alert log","description":"Delete global alert log.","operationId":"deleteAlertLogsForGlobal","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteGlobalAlertLogListOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":19}},"/openapi/v1/{omadacId}/firmwares/{firmwareId}/upgrade":{"delete":{"tags":["Firmware"],"summary":"Delete upgrade firmware","description":"Delete the manually uploaded firmware","operationId":"deleteUpgradeFirmware","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"firmwareId","in":"path","description":"Firmware ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":24}},"/openapi/v1/{omadacId}/files/sites/{siteId}/gateways/{gatewayMac}/isp-upgrade/{fileId}":{"delete":{"tags":["Gateway"],"summary":"Delete isp file","description":"Delete isp file","operationId":"deleteIspFile","parameters":[{"name":"omadacId","in":"path","description":"Omada ID","required":true,"schema":{"type":"string"}},{"name":"siteId","in":"path","description":"Site ID","required":true,"schema":{"type":"string"}},{"name":"gatewayMac","in":"path","description":"Gateway MAC address, like AA-BB-CC-DD-EE-FF","required":true,"schema":{"type":"string"}},{"name":"fileId","in":"path","description":"fileId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":13}},"/openapi/v1/msp/{mspId}/system/setting/ssl-key/{keyId}":{"delete":{"tags":["Msp setting"],"summary":"Delete an existing msp SSL key","description":"Delete an existing msp SSL key.","operationId":"deleteSSLKey","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"keyId","in":"path","description":"SSL Key ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":8}},"/openapi/v1/msp/{mspId}/system/setting/certificate/{cerId}":{"delete":{"tags":["Msp setting"],"summary":"Delete an existing msp certificate","description":"Delete an existing msp certificate.","operationId":"deleteCertificate","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}},{"name":"cerId","in":"path","description":"Certificate ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}}},"x-order":6}},"/openapi/v1/msp/{mspId}/logs/events/delete":{"delete":{"tags":["Msp Log"],"summary":"Delete MSP event log","description":"Delete MSP event log.","operationId":"deleteEventLogsForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMspEventLogListOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":10}},"/openapi/v1/msp/{mspId}/logs/alerts/delete":{"delete":{"tags":["Msp Log"],"summary":"Delete MSP alert log","description":"Delete MSP alert log.","operationId":"deleteAlertLogsForMsp","parameters":[{"name":"mspId","in":"path","description":"MSP ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMspAlertLogListOpenApiVO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}}}},"x-order":11}},"/internal/api/v2/omadacs/{customizeOmadacId}":{"delete":{"tags":["abutment-omada-cloud-controller"],"operationId":"unbindOmadac","parameters":[{"name":"customizeOmadacId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnbindOmadacRequestDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OperationResponseObject"}}}}}}}},"components":{"schemas":{"ConfigIotBtIbeaconV2OpenApiVO":{"required":["macList","major","minor","name","uuid"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"The Bluetooth Advertising seting name. The name of built-in entry are not allowed to be modified."},"macList":{"maxItems":2147483647,"minItems":1,"type":"array","description":"List of device MAC addresses bound to this configuration.","items":{"maxLength":2147483647,"minLength":1,"type":"string","description":"List of device MAC addresses bound to this configuration."}},"enable":{"type":"boolean","description":"Whether to enable the Bluetooth Advertising setting.(Disable by default)"},"measurePower":{"type":"integer","description":"RSSI Calibration Value. The parameter [measurePower] is used to input the RSSI measured at a 1-meter distance from the device, enabling positioning functionality.(-65 by default)","format":"int32"},"advInterval":{"type":"integer","description":"Advertising interval in milliseconds.(500 by default)","format":"int32"},"uuid":{"type":"string","description":"The UUID (Universally Unique Identifier) of the advertising ibeacon packet."},"major":{"type":"string","description":"The major value of adverting ibeacon packet, indicating a larger group."},"minor":{"type":"string","description":"The minor value of adverting ibeacon packet, indicating a smaller group."}}},"OperationResponseWithoutResult":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"}}},"ApMvlanSettingOpenApiVO":{"required":["mode"],"type":"object","properties":{"mode":{"type":"integer","description":"Mode for the AP management VLAN configuration to take effect.[0:Default,1:Custom]","format":"int32"},"lanNetworkId":{"type":"string","description":"This field indicates the currently effective lanNetworkId."},"bridgeVlan":{"type":"integer","description":"When mvlanNetworkId is bridge vlan, mvlanBridgeVlan has a value.","format":"int32"}},"description":"Management VLAN setting."},"ApVoipVlanSettingOpenApiVO":{"required":["mode"],"type":"object","properties":{"mode":{"type":"integer","description":"VoIP VLAN mode. 0 : Follow Management VLAN. 1: Custom.","format":"int32"},"lanNetworkId":{"type":"string","description":"LAN network ID. Parameter [lanNetworkId] should not be null, and should not be the same as the lanNetworkId of management VLAN when parameter [mode] is 1."},"voipBridgeVlan":{"type":"integer","description":"VoIP bridge vlan. Parameter [voipBridgeVlan] should not be null and be between 1 and 4090 when parameter [lanNetworkId] corresponds to a multiple VLAN LAN network.","format":"int32"},"ipType":{"type":"integer","description":"VoIP VLAN IP Type. 0: Static IP. 1: DHCP.","format":"int32"},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"VoIP VLAN IP. Parameter [ip] should not be null when [ipType] is 0."},"ipMask":{"pattern":"(254|252|248|240|224|192|128|0).0.0.0|255.(254|252|248|240|224|192|128|0).0.0|255.255.(254|252|248|240|224|192|128|0).0|255.255.255.(254|252|248|240|224|192|128|0)","type":"string","description":"VoIP VLAN IP mask. Parameter [ipMask] should not be null when [ipType] is 0."},"ipGateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"VoIP VLAN IP gateway. Parameter [ipGateway] should not be null when [ipType] is 0."},"ipDns1":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP DNS1."},"ipDns2":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP DNS2."}},"description":"VoIP VLAN setting."},"UpdateApVlanOpenApiVO":{"type":"object","properties":{"mvlanSetting":{"$ref":"#/components/schemas/ApMvlanSettingOpenApiVO"},"voipVlanSetting":{"$ref":"#/components/schemas/ApVoipVlanSettingOpenApiVO"}}},"ApVlanConfigV2OpenApiVO":{"type":"object","properties":{"mvlanSetting":{"$ref":"#/components/schemas/ApMvlanSettingOpenApiVO"},"voipVlanSetting":{"$ref":"#/components/schemas/ApVoipVlanSettingOpenApiVO"}}},"OperationResponseApVlanConfigV2OpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApVlanConfigV2OpenApiVO"}}},"BatchUpdateApVlanOpenApiVO":{"required":["apMacList"],"type":"object","properties":{"apMacList":{"type":"array","description":"AP mac list","items":{"type":"string","description":"AP mac list"}},"mvlanSetting":{"$ref":"#/components/schemas/ApMvlanSettingOpenApiVO"},"voipVlanSetting":{"$ref":"#/components/schemas/ApVoipVlanSettingOpenApiVO"}}},"CreateSitePrivilegeVO":{"type":"object","properties":{"all":{"type":"boolean","description":"Whether user has all site permission, including new created site."},"sites":{"uniqueItems":true,"type":"array","description":"User site privilege list","items":{"type":"string","description":"User site privilege list"}},"serviceType":{"type":"integer","description":"Service type should be a value as follows: 1: Omada System.","format":"int32"}},"description":"User site privileges"},"ModifyUserVO":{"required":["allSite","name","roleId"],"type":"object","properties":{"roleId":{"type":"string","description":"This field represents Role ID. Role can be created using 'Create new role' interface, and Role ID can be obtained from 'Get role list' interface."},"name":{"pattern":"^(?![+=@-])[\\041-\\0176]$|^(?![+=@-])[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"User name should contain 1 to 128 characters and start with letters, numbers, and underscores. When creating cloud user, you should set TP-LINK ID."},"password":{"pattern":"^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[\\!\\#\\$\\%\\&\\'\\(\\)\\*\\+\\,\\-\\.\\/\\:\\;\\<\\=\\>\\@\\[\\\\\\]\\^\\_\\`\\{\\|\\}\\~])(?!.*[\\00-\\040\\042\\077\\0177]).{8,128}$","type":"string","description":"Password of local user should contain 8 to 128 characters. And password must be a combination of uppercase letters, lowercase letters, numbers, and special symbols. Symbols such as ! # $ % & * @ ^ are supported."},"email":{"type":"string","description":"Email of user"},"alert":{"type":"boolean","description":"Whether this user wants to receive alert, event, and incident emails. Make sure your email is not null."},"forceModify":{"type":"boolean","description":"Force modify"},"incidentNotification":{"type":"boolean","description":"Incident notification, this field is deprecated, please use alert field instead.","deprecated":true},"sites":{"uniqueItems":true,"type":"array","description":"User site privilege list","items":{"type":"string","description":"User site privilege list"}},"allSite":{"type":"boolean","description":"Whether user has all site permission, including new created site."},"temporaryEnable":{"type":"boolean","description":"Whether the user wants to enable the temporary worker permission"},"startTime":{"type":"integer","description":"The start time of the user's validity period. time range: start timestamp (Millisecond).","format":"int64"},"endTime":{"type":"integer","description":"The end time of the user's validity period. time range: end timestamp (Millisecond).","format":"int64"},"sitePrivileges":{"type":"array","description":"User site privileges","items":{"$ref":"#/components/schemas/CreateSitePrivilegeVO"}}}},"OperationResponse":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"object"}}},"IdpMetadataOpenApiVO":{"required":["entityId","loginUrl","name","x509Certificate"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,30}[^ ]$","type":"string","description":"IdP name should contain 1 to 32 characters."},"description":{"pattern":"^$|^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"IdP description should contain 0 to 128 characters."},"entityId":{"pattern":"^(?=^.{3,255}$)(http(s)?:\\/\\/)(www\\.)?[a-zA-Z0-9][-a-zA-Z0-9]{0,62}(\\.[a-zA-Z0-9][-a-zA-Z0-9]{0,62})+(:\\d+)*(\\/[\\w-]*(\\.[\\w-]+)?)*([\\?&][\\w-]+=[\\w-]*)*$","type":"string","description":"The IdP entity id which must be unique in same Omadac."},"loginUrl":{"pattern":"^(?=^.{3,255}$)(http(s)?:\\/\\/)(www\\.)?[a-zA-Z0-9][-a-zA-Z0-9]{0,62}(\\.[a-zA-Z0-9][-a-zA-Z0-9]{0,62})+(:\\d+)*(\\/[\\w-]*(\\.[\\w-]+)?)*([\\?&][\\w-]+=[\\w-]*)*$","type":"string","description":"Login url"},"x509Certificate":{"type":"string","description":"BASE64 encoded string of x509 certificate."}}},"ExternalUserGroupOpenApiVO":{"required":["allSite","name","roleId"],"type":"object","properties":{"name":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"External user group name should contain 1 to 128 characters."},"roleId":{"type":"string","description":"Role ID which can be obtained from 'Get role list' interface."},"allSite":{"type":"boolean","description":"Whether having all site permissions."},"sites":{"uniqueItems":true,"type":"array","description":"The site IDs that can be accessed. Effective when allSite is false.","items":{"type":"string","description":"The site IDs that can be accessed. Effective when allSite is false."}},"temporaryEnable":{"type":"boolean","description":"Whether the user wants to enable the temporary worker permission"},"startTime":{"type":"integer","description":"The start time of the user's validity period. time range: start timestamp (Millisecond).","format":"int64"},"endTime":{"type":"integer","description":"The end time of the user's validity period. time range: end timestamp (Millisecond).","format":"int64"}}},"UpdateSiteByTemplate":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,62}[^ ]$","type":"string","description":"Name of the site should contain 1 to 64 characters."}}},"Disable Nat":{"required":["interface","lanList","name","status"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name of the Disable Nat."},"status":{"type":"boolean","description":"The Status of the Disable Nat."},"lanList":{"type":"array","description":"A list of Lan of the Disable Nat.","items":{"type":"string","description":"A list of Lan of the Disable Nat."}},"description":{"type":"string","description":"The description of the Disable Nat."},"interface":{"type":"string","description":"The wan of the Disable Nat."}}},"UpnpSettingOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable UPnP"},"wanPortIds":{"type":"array","description":"This field represents WAN Port ID, WAN Port ID can be obtained from \"Get internet basic info\" interface.","items":{"type":"string","description":"This field represents WAN Port ID, WAN Port ID can be obtained from \"Get internet basic info\" interface."}},"networkIds":{"type":"array","description":"This field represents LAN Network ID. LAN Network ID can be obtained from \"Get all \"single\"/\"multi\" interface lan network\" interface.","items":{"type":"string","description":"This field represents LAN Network ID. LAN Network ID can be obtained from \"Get all \"single\"/\"multi\" interface lan network\" interface."}},"supportByDsLiteAndMapE":{"type":"boolean","description":"Whether this feature is supported for the DS-Lite or Map-E WAN connection types."}}},"CustomDayModeOpenApiVO":{"required":["dayFri","dayMon","daySat","daySun","dayThu","dayTue","dayWed"],"type":"object","properties":{"dayMon":{"type":"boolean","description":"Whether to enable Monday of time range profile."},"dayTue":{"type":"boolean","description":"Whether to enable Tuesday of time range profile."},"dayWed":{"type":"boolean","description":"Whether to enable Wednesday of time range profile."},"dayThu":{"type":"boolean","description":"Whether to enable Thursday of time range profile."},"dayFri":{"type":"boolean","description":"Whether to enable Friday of time range profile."},"daySat":{"type":"boolean","description":"Whether to enable Saturday of time range profile."},"daySun":{"type":"boolean","description":"Whether to enable Sunday of time range profile."}},"description":"Time range profile custom day mode, this field is required when parameter [dayMode] is 3."},"ScheduleTimeOpenApiVO":{"required":["dayType","endTimeH","endTimeM","startTimeH","startTimeM"],"type":"object","properties":{"dayType":{"type":"integer","description":"Time range schedule time day type, 1 to 7 indicates Monday to Sunday, if parameter [dayMode] is 0 to 2, the input value for this field should be 0.","format":"int32"},"startTimeH":{"type":"integer","description":"Time range schedule start time (unit: hour); It should be within the range of 0–24.","format":"int32"},"startTimeM":{"type":"integer","description":"Time range schedule start time (unit: minute); It should be a value as follows: [0, 15, 30, 45].","format":"int32"},"endTimeH":{"type":"integer","description":"Time range schedule end time (unit: hour); It should be within the range of 0–24.","format":"int32"},"endTimeM":{"type":"integer","description":"Time range schedule end time (unit: minute); It should be a value as follows: [0, 15, 30, 45].","format":"int32"}},"description":"Time range profile schedule time config"},"UpdateTimeRangeProfileOpenApiVO":{"required":["dayMode","name","timeList"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Time range profile name should contain 1 to 64 characters."},"dayMode":{"type":"integer","description":"Time range profile day mode; 0: Every Day, 1: Weekday, 2: Weekend, 3: Customized","format":"int32"},"customDayMode":{"$ref":"#/components/schemas/CustomDayModeOpenApiVO"},"timeList":{"type":"array","description":"Time range profile schedule time config","items":{"$ref":"#/components/schemas/ScheduleTimeOpenApiVO"}}}},"OswVrfConfigOpenApiVO":{"required":["ipv6Enable"],"type":"object","properties":{"vrf":{"pattern":"^(?!(\\.|\\.\\.)$)[a-zA-Z0-9.\\-_@+]{1,15}$","type":"string","description":"VRF name: 1 to 15 characters consisting of numbers (0 to 9), uppercase and lowercase letters (A to Z, a to z), and symbols -_@.+; cannot be '.' or '..' only. This parameter is required when creating a VRF and is not needed when modifying a VRF."},"ipv4Enable":{"type":"boolean","description":"Whether to enable ipv4. Ipv4Enable should be true. This parameter is required when creating a VRF and is not needed when modifying a VRF."},"ipv6Enable":{"type":"boolean","description":"Whether to enable ipv6"}}},"SwitchPortStatus":{"required":["status"],"type":"object","properties":{"status":{"type":"integer","description":"Status should be a value as follows: 0: off; 1: on","format":"int32"}}},"SwitchProfileID":{"required":["profileId"],"type":"object","properties":{"profileId":{"type":"string","description":"Profile ID. "}}},"ProfileOverride":{"required":["profileOverrideEnable"],"type":"object","properties":{"profileOverrideEnable":{"type":"boolean","description":"Profile Override Enable"}}},"SwitchPortPoe":{"required":["poeMode"],"type":"object","properties":{"poeMode":{"type":"integer","description":"Poe mode should be a value as follows: 1: on(802.3at/af); 0: off.","format":"int32"}}},"SwitchPortName":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^[^ ?\"]$|^[^ ?\"][^?\"]{0,126}[^ ?\"]$","type":"string","description":"Name should contain 1 to 128 characters."}}},"SwitchPortsStatus":{"required":["portList","status"],"type":"object","properties":{"portList":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Port list","items":{"maximum":2147483647,"minimum":1,"type":"integer","description":"Port list","format":"int32"}},"status":{"type":"integer","description":"Status should be a value as follows: 0: off; 1: on","format":"int32"}}},"BatchProfileOverride":{"required":["portList","profileOverrideEnable"],"type":"object","properties":{"portList":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Port ID List.","items":{"maximum":2147483647,"minimum":1,"type":"integer","description":"Port ID List.","format":"int32"}},"profileOverrideEnable":{"type":"boolean","description":"Profile Override Enable."}}},"SwitchPortsPoe":{"required":["poeMode","portList"],"type":"object","properties":{"portList":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Port ID List.","items":{"maximum":2147483647,"minimum":1,"type":"integer","description":"Port ID List.","format":"int32"}},"poeMode":{"type":"integer","description":"Poe mode should be a value as follows: 1: on(802.3at/af); 0: off.","format":"int32"}}},"PortNameList":{"required":["portNameList"],"type":"object","properties":{"portNameList":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Port name list","items":{"$ref":"#/components/schemas/SwitchMultiPortName"}}}},"SwitchMultiPortName":{"required":["name","port"],"type":"object","properties":{"port":{"type":"integer","description":"Port ID","format":"int32"},"name":{"pattern":"^[^ ?\"]$|^[^ ?\"][^?\"]{0,126}[^ ?\"]$","type":"string","description":"Port name should contain 1 to 128 characters."}},"description":"Port name list"},"OuiBasedVlanTemplateOpenApiVO":{"required":["enable","mode","name","ruleCombine"],"type":"object","properties":{"enable":{"type":"boolean","description":"Switch Rule state."},"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Switch Rule name should contain 1 to 128 characters."},"mode":{"type":"integer","description":"Switch Rule type should be a value as follows: 0: All device port","format":"int32"},"ruleCombine":{"type":"array","description":"Basic vlan-oui-priority configuration of oui based rule. Cannot be empty.","items":{"$ref":"#/components/schemas/VlanOuiModeOpenApiVO"}}}},"VlanOuiModeOpenApiVO":{"required":["ouiProfileId","priority","vlanId"],"type":"object","properties":{"vlanId":{"type":"integer","description":"Selected vlan, valid range is 1 to 4094.","format":"int32"},"priority":{"type":"integer","description":"Selected priority, valid range is 0 to 7.","format":"int32"},"ouiProfileId":{"type":"string","description":"Oui profile ID."}},"description":"Basic vlan-oui-priority configuration of oui based rule. Cannot be empty."},"SSHSetting":{"required":["sshEnable"],"type":"object","properties":{"sshEnable":{"type":"boolean","description":"Whether to enable SSH"},"sshServerPort":{"type":"integer","description":"SSH server port should be 22 or within the range of 1025-65535.","format":"int32"},"layer3Access":{"type":"boolean","description":"Whether to enable layer 3 accessibility"}},"description":"SSH setting"},"PortOrPoeScheduleOpenApiVO":{"required":["name","portsMap","scheduleType","status","turnOnTime"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Port Schedule Name should contain 1 to 128 characters."},"scheduleType":{"type":"integer","description":"Port Schedule Type should be 0 or 1.","format":"int32"},"status":{"type":"boolean","description":"Port Schedule Status."},"turnOnTime":{"type":"string","description":"Time Range ID, cannot be empty."},"portsMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Key:Mac(\"String\"), Value:Set of Ports(\"Integer\")","items":{"type":"integer","description":"Key:Mac(\"String\"), Value:Set of Ports(\"Integer\")","format":"int32"}},"description":"Key:Mac(\"String\"), Value:Set of Ports(\"Integer\")"},"nextExecute":{"type":"integer","description":"Show PoE Schedule next execution timestamp.","format":"int64"},"notInDst":{"type":"boolean","description":"When notInDst is true, not displayed in DST."}}},"FeatureInfoVO":{"type":"object","properties":{"feature":{"type":"string","description":"Gateway feature name."},"featureState":{"type":"integer","description":"Gateway feature status: 0: The current gateway supports this feature. 1: The current gateway does not support this feature, but it is pre-configured. 2: The current gateway does not support this feature.","format":"int32"},"changeable":{"type":"boolean","description":"If the current gateway does not support this feature, then the [changeable] is false."}},"description":"Gateway Feature Description."},"IgmpOpenApiVO":{"required":["enable","version"],"type":"object","properties":{"enable":{"type":"boolean"},"version":{"type":"integer","description":"Version should be one of the following values: 2:v2; 3:v3.","format":"int32"},"wanPortId":{"type":"string","description":"WAN port ID, can be obtained from 'Get internet basic info' interface. At least one of the WAN Port IDs or Virtual WAN Port IDs should not be null."},"virtualWanId":{"type":"string","description":"Virtual WAN ID, can be obtained from 'Query virtual WAN list' interface. At least one of the WAN Port IDs or Virtual WAN Port IDs should not be null."},"featureDescription":{"type":"array","description":"Gateway Feature Description.","items":{"$ref":"#/components/schemas/FeatureInfoVO"}}},"description":"IGMP's configuration."},"IptvCustomOpenApiVO":{"required":["ipPhoneVlanId","ipPhoneVlanPriority","iptvVlanId","iptvVlanPriority"],"type":"object","properties":{"ipPhoneVlanId":{"type":"integer","description":"IP Phone VLAN ID should be within the range of 1–4094.","format":"int32"},"ipPhoneVlanPriority":{"type":"integer","description":"IP Phone VLAN priority should be within the range of 0–7.","format":"int32"},"iptvVlanId":{"type":"integer","description":"IPTV VLAN ID should be within the range of 1–4094.","format":"int32"},"iptvVlanPriority":{"type":"integer","description":"IPTV VLAN priority should be within the range of 0–7.","format":"int32"}},"description":"Required when parameter[mode] is 1"},"IptvDslOpenApiVO":{"required":["modulationType"],"type":"object","properties":{"modulationType":{"type":"integer","description":"Modulation Type should be a value as follows: 0: ADSL, 1: VDSL.","format":"int32"},"ipPhoneVpi":{"type":"integer","description":"IP Phone VPI should be a number between 0 and 255.","format":"int32"},"ipPhoneVci":{"type":"integer","description":"IP Phone VCI should be a number between 0 and 35535.","format":"int32"},"iptvVpi":{"type":"integer","description":"IPTV VPI should be a number between 0 and 255.","format":"int32"},"iptvVci":{"type":"integer","description":"IPTV VCI should be a number between 0 and 35535.","format":"int32"}},"description":"Configurations that appear only when DSL WAN port is selected."},"IptvOpenApiVO":{"required":["enable","mode","portConfig","wanPortId"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable iptv feature. Options: 'true' or 'false'."},"wanPortId":{"type":"string","description":"WAN port ID can be obtained from 'Get internet basic info' interface."},"mode":{"type":"integer","description":"Mode should be a value as follows: 0:Bridge, 1:Custom","format":"int32"},"customConfig":{"$ref":"#/components/schemas/IptvCustomOpenApiVO"},"portConfig":{"type":"array","description":"Config the port mode of the LAN ports to determine which port is used to support Internet service, IPTV service, or IP Phone service.","items":{"$ref":"#/components/schemas/IptvPortOpenApiVO"}},"dslConfig":{"$ref":"#/components/schemas/IptvDslOpenApiVO"},"featureDescription":{"type":"array","description":"Gateway Feature Description.","items":{"$ref":"#/components/schemas/FeatureInfoVO"}}},"description":"IPTV's configuration."},"IptvPortOpenApiVO":{"required":["portId","type"],"type":"object","properties":{"portId":{"type":"string","description":"This field represents Port ID."},"name":{"type":"string","description":"This field represents Port's Name."},"type":{"type":"integer","description":"Type should be a value as follows: 1: Internet; 2:IPTV; 3:IP-Phone","format":"int32"}},"description":"Config the port mode of the LAN ports to determine which port is used to support Internet service, IPTV service, or IP Phone service."},"IptvSettingOpenApiVO":{"required":["igmpSetting"],"type":"object","properties":{"igmpSetting":{"$ref":"#/components/schemas/IgmpOpenApiVO"},"iptvSetting":{"$ref":"#/components/schemas/IptvOpenApiVO"}}},"IptvConfigOpenApiVO":{"required":["enable","mode","portConfig","wanPortId"],"type":"object","properties":{"enable":{"type":"boolean"},"wanPortId":{"type":"string","description":"WAN port ID can be obtained from 'Get internet basic info' interface."},"mode":{"type":"integer","description":"Mode should be a value as follows: 0:Bridge; 1:Custom","format":"int32"},"customConfig":{"$ref":"#/components/schemas/IptvCustomOpenApiVO"},"portConfig":{"type":"array","description":"All available ports need to be configured. The list of port ID is the same as that returned by \"Get IPTV setting\"","items":{"$ref":"#/components/schemas/IptvPortConfigOpenApiVO"}},"dslConfig":{"$ref":"#/components/schemas/IptvDslOpenApiVO"}}},"IptvPortConfigOpenApiVO":{"required":["portId","type"],"type":"object","properties":{"portId":{"type":"string","description":"Port ID can be obtained from 'Get internet basic info' interface."},"type":{"type":"integer","description":"Type should be a value as follows: 1: Internet; 2:IPTV; 3:IP-Phone, 3 is valid only IPTV mode is custom.","format":"int32"}},"description":"All available ports need to be configured. The list of port ID is the same as that returned by \"Get IPTV setting\""},"IgmpTemplateOpenApiVO":{"required":["enable","version","wanPortId"],"type":"object","properties":{"enable":{"type":"boolean"},"version":{"type":"integer","description":"Version should be a value as follows: 2:v2; 3:v3.","format":"int32"},"wanPortId":{"type":"string","description":"wan port ID, can be obtained from 'Get site template internet basic info' interface."}}},"DnsCacheOpenApiVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable DNS Cache. Options: 'true' or 'false'."},"ttl":{"type":"integer","description":"TTL should be within the range of 1 or 86400.","format":"int32"}}},"ConfigIotServerOpenApiVO":{"required":["accessToken","authentication","blePeriodicTelemetry","clientId","deviceClasses","enable","name","rawData","rssiFormat","serverType","serverUrl"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"IoT Transport Stream setting name."},"enable":{"type":"boolean","description":"Whether to enable the IoT Transport Stream setting."},"serverUrl":{"type":"string","description":"If the service type is http, the server URL must start with http://."},"serverType":{"type":"integer","description":"The server type should be a value as follows: [0: http].","format":"int32"},"deviceClasses":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Supports protocol-based filtering during IoT data reporting processes.<br />The device class list should contain the value as follows: [0:minew; 1:iBeacon; 2:Eddystone].","items":{"maximum":2147483647,"minimum":1,"type":"integer","description":"Supports protocol-based filtering during IoT data reporting processes.<br />The device class list should contain the value as follows: [0:minew; 1:iBeacon; 2:Eddystone].","format":"int32"}},"reportInterval":{"type":"integer","description":"Data reporting interval configuration for AP devices in IoT systems.The parameter [reportInterval] should be within the range of 1–3600 in seconds, and it cannot be null when blePeriodicTelemetry is enabled.","format":"int32"},"authentication":{"type":"integer","description":"The parameter [authentication] should be a value as follows:[0:Use Token].","format":"int32"},"accessToken":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"This parameter becomes mandatory when the authentication method is set to \"Use Token\".<br/>Note:The parameter [clientId] should be 1 ~ 128 characters."},"clientId":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"This parameter becomes mandatory when the authentication method is set to \"Use Token\".<br />Note:The parameter [clientId] should be 1 ~ 128 characters."},"rssiFormat":{"type":"integer","description":"The signal strength reporting format currently supports five types: [0:Average; 1:Max; 2:Last; 3:Smooth; 4:Bulk].","format":"int32"},"filtersType":{"type":"array","description":"User-defined settings to manage AP device filtering rules for IoT devices.<br />The parameter [filtersType] should contain the value as follows:[0:Company Identifier; 1:Vendor; 2:Local Name; 3:Service UUID; 4:Mac Oui; 5:iBeacon UUID; 6:UID; 7:URL].","items":{"type":"integer","description":"User-defined settings to manage AP device filtering rules for IoT devices.<br />The parameter [filtersType] should contain the value as follows:[0:Company Identifier; 1:Vendor; 2:Local Name; 3:Service UUID; 4:Mac Oui; 5:iBeacon UUID; 6:UID; 7:URL].","format":"int32"}},"filters":{"type":"object","additionalProperties":{"type":"array","description":"The keys in the [filters] map represent the filter types, while the values correspond to the specific filtering criteria or values associated with each filter type.<br />Note:<br />Filter type = 0, The Company Identifier must conform to a 4-digit or 6-digit hexadecimal encoding. It is only applicable to ibeacon devices<br />Filter type = 1, The Vendor should not exceed 255 bytes in length.<br />Filter type = 2, The Local Name should not exceed 120 bytes in length. It is only applicable to minew devices.<br />Filter type = 3, The Service UUID must conform to a 4-digit hexadecimal encoding. It is only applicable to minew and eddystone devices.<br />Filter type = 4, The Mac Oui must conform to a 6-digit hexadecimal encoding.<br />Filter type = 5, The iBeacon UUID must conform to a 32-digit hexadecimal encoding. It is only applicable to iBeacon devices.<br />Filter type = 6, The UID must conform to a 20-digit or 32-digit hexadecimal encoding. It is only applicable to eddystone devices.<br />Filter type = 7, The URL should not include a scheme. It is only applicable to eddystone devices.<br />","items":{"type":"string","description":"The keys in the [filters] map represent the filter types, while the values correspond to the specific filtering criteria or values associated with each filter type.<br />Note:<br />Filter type = 0, The Company Identifier must conform to a 4-digit or 6-digit hexadecimal encoding. It is only applicable to ibeacon devices<br />Filter type = 1, The Vendor should not exceed 255 bytes in length.<br />Filter type = 2, The Local Name should not exceed 120 bytes in length. It is only applicable to minew devices.<br />Filter type = 3, The Service UUID must conform to a 4-digit hexadecimal encoding. It is only applicable to minew and eddystone devices.<br />Filter type = 4, The Mac Oui must conform to a 6-digit hexadecimal encoding.<br />Filter type = 5, The iBeacon UUID must conform to a 32-digit hexadecimal encoding. It is only applicable to iBeacon devices.<br />Filter type = 6, The UID must conform to a 20-digit or 32-digit hexadecimal encoding. It is only applicable to eddystone devices.<br />Filter type = 7, The URL should not include a scheme. It is only applicable to eddystone devices.<br />"}},"description":"The keys in the [filters] map represent the filter types, while the values correspond to the specific filtering criteria or values associated with each filter type.<br />Note:<br />Filter type = 0, The Company Identifier must conform to a 4-digit or 6-digit hexadecimal encoding. It is only applicable to ibeacon devices<br />Filter type = 1, The Vendor should not exceed 255 bytes in length.<br />Filter type = 2, The Local Name should not exceed 120 bytes in length. It is only applicable to minew devices.<br />Filter type = 3, The Service UUID must conform to a 4-digit hexadecimal encoding. It is only applicable to minew and eddystone devices.<br />Filter type = 4, The Mac Oui must conform to a 6-digit hexadecimal encoding.<br />Filter type = 5, The iBeacon UUID must conform to a 32-digit hexadecimal encoding. It is only applicable to iBeacon devices.<br />Filter type = 6, The UID must conform to a 20-digit or 32-digit hexadecimal encoding. It is only applicable to eddystone devices.<br />Filter type = 7, The URL should not include a scheme. It is only applicable to eddystone devices.<br />"},"countOnly":{"type":"boolean","description":"A switch that controls whether the AP device exclusively reports the count of IoT devices, and it cannot be null when blePeriodicTelemetry is enabled."},"blePeriodicTelemetry":{"type":"boolean","description":"Whether to enable the BLE Periodic Telemetry. When disabled no periodic packets will be uploaded."},"rawData":{"type":"boolean","description":"Whether to enable the BLE Data Forwarding. When enabled, the AP directly reports the Bluetooth packet rawData to the server."}}},"IotAgingTimeOpenApiVO":{"required":["agingTime_iotAgingTime","format_iotAgingTime"],"type":"object","properties":{"agingTime_iotAgingTime":{"type":"integer","description":"The system automatically removes a device's registry entry if no data reports are received within a predefined aging period.<br/>When format = 0, The parameter aging time should be within the range of 30-86400.<br/>When format = 1, The parameter aging time should be within the range of 1-1440.<br/>When format = 2, The parameter aging time should be within the range of 1-24.<br/>","format":"int32"},"format_iotAgingTime":{"type":"integer","description":"The parameter [format] should be a value as follows: [0:second 1:minute; 2:hour]","format":"int32"}}},"RrmSettingOpenApiVO":{"required":["mode","timeRangeEnable"],"type":"object","properties":{"mode":{"type":"integer","description":"The mode of Auto WLAN Optimization, such as: 0: disable, 1: adaptive","format":"int32"},"resource":{"type":"integer","description":"The anomaly event setting creation resource, such as: 0: new created, 1: from template, 2: override","format":"int32"},"timeRangeEnable":{"type":"boolean","description":"Whether the Time Range is enabled. True: enable, false: disable."},"timeRangeId":{"type":"string","description":"This field represents Time Range Profile ID. Time Range Profile can be created using Create time range profile interface, and Time Range Profile ID can be obtained from Get time range profile list interface."},"timeRangeAction":{"type":"integer","description":"The Time Range Action, such as: 0: out of range, 1: in range","format":"int32"}}},"StaticRoutingConfigTemplate":{"required":["destinations","metric","name","routeType","status"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name, name should contain 1 to 64 characters."},"status":{"type":"boolean","description":"Status"},"destinations":{"type":"array","description":"IP address/SubNet","items":{"type":"string","description":"IP address/SubNet"}},"routeType":{"type":"integer","description":"RouteType should be a value as follows: 0: NextHop; 1: Interface","format":"int32"},"nextHopIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Only for routeType:0 or routeType:1 and selected WAN is Static IP/Dynamic IP mode"},"interfaceType":{"type":"integer","description":"Only for routeType:1, interfaceType should be a value as follows: 0: Internet(WAN); 1: Network(LAN); 2: L2TP, 3: PPTP, 5: Virtual WAN.","format":"int32"},"interfaceId":{"type":"string","description":"Interface ID, for example: if interfaceType is network, interfaceId should be LAN network ID. LAN Network can be created using 'Create LAN network template' interface, and LAN Network ID can be obtained from 'Get LAN network list template' interface."},"metric":{"type":"integer","description":"Metric should be within the range of 0–15.","format":"int32"}}},"PolicyRoutingConfig":{"required":["backupInterface","destinationIds","destinationType","name","protocols","sourceIds","sourceType","status"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name, name should contain 1 to 64 characters."},"status":{"type":"boolean","description":"Status"},"protocols":{"type":"array","description":"For the values of protocols, refer to section 5.5.2 of the Open API Access Guide.","items":{"type":"integer","description":"For the values of protocols, refer to section 5.5.2 of the Open API Access Guide.","format":"int32"}},"interfaceType":{"type":"integer","description":"InterfaceType should be a value as follows: 0: WAN; 2: L2TP; 3: PPTP; 4: multi-select WAN or VPN or virtual WAN.","format":"int32"},"interfaceId":{"type":"string","description":"Interface ID"},"wanPortIds":{"type":"array","description":"WAN port list. When interfaceType is 4, at least one of the wanPortIds or vpnIds or virtualWanIds is not empty.","items":{"type":"string","description":"WAN port list. When interfaceType is 4, at least one of the wanPortIds or vpnIds or virtualWanIds is not empty."}},"vpnIds":{"type":"array","description":"VPN list. When interfaceType is 4, at least one of the wanPortIds or vpnIds or virtualWanIds is not empty.","items":{"type":"string","description":"VPN list. When interfaceType is 4, at least one of the wanPortIds or vpnIds or virtualWanIds is not empty."}},"virtualWanIds":{"type":"array","description":"Virtual WAN list. When interfaceType is 4, at least one of the wanPortIds or vpnIds or virtualWanIds is not empty.","items":{"type":"string","description":"Virtual WAN list. When interfaceType is 4, at least one of the wanPortIds or vpnIds or virtualWanIds is not empty."}},"backupInterface":{"type":"boolean","description":"Use the other WAN port if the current one is down"},"sourceType":{"type":"integer","description":"SourceType should be a value as follows: 0: Network; 1: IP Group; 2: IP port Group","format":"int32"},"sourceIds":{"type":"array","description":"Source IDs, which depends on sourceType, for example: if sourceType is network, sourceIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Source IDs, which depends on sourceType, for example: if sourceType is network, sourceIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."}},"destinationType":{"type":"integer","description":"DestinationType should be a value as follows: 0: Network; 1: IP Group; 2: IP port Group","format":"int32"},"destinationIds":{"type":"array","description":"Destination IDs, which depends on destinationType, for example: if destinationType is network, destinationIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Destination IDs, which depends on destinationType, for example: if destinationType is network, destinationIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."}}}},"CustomSettingVO":{"required":["bandDeployEnable","channelDeployEnable","channelWidthDeployEnable","powerAdjustEnable"],"type":"object","properties":{"channelDeployEnable":{"type":"boolean","description":"Whether to enable channel deployment."},"channelWidthDeployEnable":{"type":"boolean","description":"Whether to enable channel width deployment."},"bandDeployEnable":{"type":"boolean","description":"Whether to enable band deployment."},"powerAdjustEnable":{"type":"boolean","description":"Whether to enable power adjustment."},"advancedSetting":{"$ref":"#/components/schemas/PlanningAdvancedSettingVO"}},"description":"Custom setting. Cannot be null when parameter [mode] is 1."},"ExcludeChannelVO":{"type":"object","properties":{"channel":{"type":"integer","description":"Channel.","format":"int32"},"freq":{"type":"integer","description":"Frequency. ","format":"int32"}},"description":"Excluded 5 GHz channel list."},"PlanningAdvancedSettingVO":{"type":"object","properties":{"exclude5gChEn":{"type":"boolean","description":"Whether to enable the Excluded 5GHz Channels function."},"exclude5gCh":{"type":"array","description":"Excluded 5 GHz channel list.","items":{"$ref":"#/components/schemas/ExcludeChannelVO"}},"powerMode":{"type":"integer","description":"Power mode. 0: Auto. 1: Custom.","format":"int32"},"powerRange":{"$ref":"#/components/schemas/PowerRangeVO"},"widthSelectEn":{"type":"boolean","description":"Whether to enable channel width selection."},"widthRange":{"$ref":"#/components/schemas/WidthRangeVO"},"powerThreshold":{"$ref":"#/components/schemas/PowerThresholdVO"}}},"PowerRangeVO":{"type":"object","properties":{"minPower2g":{"type":"integer","description":"Minimum power in 2.4 GHz. Parameter [minPower2g] should between 9 and 30","format":"int32"},"maxPower2g":{"type":"integer","description":"Maximum power in 2.4 GHz. Parameter [maxPower2g] should between 9 and 30","format":"int32"},"minPower5g":{"type":"integer","description":"Minimum power in 5 GHz. Parameter [minPower5g] should between 9 and 30","format":"int32"},"maxPower5g":{"type":"integer","description":"Maximum power in 5 GHz. Parameter [maxPower5g] should between 9 and 30","format":"int32"},"minPower6g":{"type":"integer","description":"Minimum power in 6 GHz. Parameter [minPower6g] should between 9 and 30","format":"int32"},"maxPower6g":{"type":"integer","description":"Maximum power in 6 GHz. Parameter [maxPower6g] should between 9 and 30","format":"int32"}},"description":"Power range. Parameter [powerRange] should not be null when parameter [powerMode] is 1."},"PowerThresholdVO":{"type":"object","properties":{"mode":{"type":"integer","description":"Parameter [mode] should be 0 or 1. 0: Auto. 1: Custom.","format":"int32"},"threshold2g":{"type":"integer","description":"Power threshold in 2.4 GHz. Parameter [threshold2g] should range from -75 and -60.","format":"int32"},"threshold5g":{"type":"integer","description":"Power threshold in 5 GHz. Parameter [threshold5g] should range from -75 and -60.","format":"int32"},"threshold6g":{"type":"integer","description":"Power threshold in 6 GHz. Parameter [threshold6g] should range from -75 and -60.","format":"int32"}},"description":"Power threshold."},"RF Planning Deploy Config":{"required":["mode"],"type":"object","properties":{"mode":{"type":"integer","description":"0: Auto configuration. 1: Custom configuration.","format":"int32"},"customSetting":{"$ref":"#/components/schemas/CustomSettingVO"}}},"WidthRangeVO":{"type":"object","properties":{"minWidth5g":{"type":"integer","description":"Minimum channel width in 5 GHz. Parameter [minWidth5g] should be 20,40,80,160,240.","format":"int32"},"maxWidth5g":{"type":"integer","description":"Maximum channel width in 5 GHz. Parameter [maxWidth5g] should be 20,40,80,160,240.","format":"int32"},"minWidth6g":{"type":"integer","description":"Minimum channel width in 6 GHz. Parameter [minWidth6g] should be 20,40,80,160,320.","format":"int32"},"maxWidth6g":{"type":"integer","description":"Maximum channel width in 6 GHz. Parameter [maxWidth6g] should be 20,40,80,160,320.","format":"int32"}},"description":"Channel width range. Parameter [widthRange] should not be null when parameter [widthSelectEn] is true. "},"RebootScheduleTemplateOpenApiVO":{"required":["name","status","time"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Reboot Schedule name should contain 1 to 128 characters."},"status":{"type":"boolean","description":"Reboot Schedule status."},"time":{"$ref":"#/components/schemas/RebootScheduleTimeOpenApiVO"}}},"RebootScheduleTimeOpenApiVO":{"required":["hour","minute","timingType"],"type":"object","properties":{"timingType":{"type":"integer","description":"Time type should be a value as follows: 1:Daily; 2:Weekly; 3:Monthly","format":"int32"},"dayOfWeek":{"type":"integer","description":"It should be within the range of 0(Sunday)~6(Saturday). Required when parameter [timingType] is 2.","format":"int32"},"dayOfMonth":{"type":"integer","description":"It should be within the range of 1~31. Required when parameter [timingType] is 3.","format":"int32"},"hour":{"type":"integer","description":"It should be within the range of 0~23","format":"int32"},"minute":{"type":"integer","description":"It should be within the range of 0~59","format":"int32"}},"description":"Execution time setting."},"UpdateRateLimitProfileOpenApiVO":{"required":["downLimitEnable","name","upLimitEnable"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Rate limit profile name should contain 1 to 64 characters."},"downLimitEnable":{"type":"boolean","description":"Whether to enable download limit"},"downLimit":{"type":"integer","description":"Download limit(Unit: Kbps), this field is required when parameter [downLimitEnable] is true.","format":"int64"},"upLimitEnable":{"type":"boolean","description":"Whether to enable upload limit"},"upLimit":{"type":"integer","description":"Upload limit(Unit: Kbps), this field is required when parameter [upLimitEnable] is true.","format":"int64"}}},"VoipOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"The status of First Priority for VoIP SIP/RTP, valid value is true or false."},"sipUdpPort":{"type":"integer","description":"The SIP UDP Port should be within the range of 0-65535 when parameter [enable] is true.","format":"int32"}}},"TagOutConfigOpenApiVO":{"required":["tagConfigList"],"type":"object","properties":{"tagConfigList":{"type":"array","description":"The Tag Outbound configuration of class type, must contains class 1, class 2, class 3 and others.","items":{"$ref":"#/components/schemas/TagOutItemOpenApiVO"}}}},"TagOutItemOpenApiVO":{"required":["classType","dscp","enable"],"type":"object","properties":{"classType":{"type":"integer","description":"Class type should be a value as follows: 1: class 1, 2: class 2, 3: class 3, 0: others.","format":"int32"},"enable":{"type":"boolean","description":"The status of Class Type, valid value is true or false."},"dscp":{"type":"string","description":"The DSCP value selected in the Precedence configuration should be a value as follows: 8: IP precedence 1; 16: IP precedence 2; 24: IP precedence 3; 32: IP precedence 4; 40: IP precedence 5; 48: IP precedence 6; 56: IP precedence 7; 10: AF Class 1 (Low Drop); 12: AF Class 1 (Medium Drop); 14: AF Class 1 (High Drop); 18: AF Class 2 (Low Drop); 20: AF Class 2 (Medium Drop); 22: AF Class 2 (High Drop); 26: AF Class 3 (Low Drop); 28: AF Class 3 (Medium Drop); 30: AF Class 3 (High Drop); 34: AF Class 4 (Low Drop); 36: AF Class 4 (Medium Drop); 38: AF Class 4 (High Drop); 46: EF Class."}},"description":"The Tag Outbound configuration of class type, must contains class 1, class 2, class 3 and others."},"ClassRuleTemplateOpenApiVO":{"required":["classType","dscp","enable","ipVersion","localIp","remoteIp","serviceType"],"type":"object","properties":{"enable":{"type":"boolean","description":"The status of class rule. valid values are true or false."},"ipVersion":{"type":"integer","description":"The IP Version of class rule should be a value as follows: 0: IPv4; 1: IPv6.","format":"int32"},"localIp":{"type":"string","description":"The ID of IP Group or IPv6 Group selected in the Local Address configuration. The ID can be obtained from 'Get group profile template list' interface."},"remoteIp":{"type":"string","description":"The ID of IP Group or IPv6 Group selected in the Remote Address configuration. The ID can be obtained from 'Get group profile template list' interface."},"dscp":{"type":"string","description":"The DSCP value selected in the DSCP configuration should be a value as follows: any: any; 8: IP precedence 1; 16: IP precedence 2; 24: IP precedence 3; 32: IP precedence 4; 40: IP precedence 5; 48: IP precedence 6; 56: IP precedence 7; 10: AF Class 1 (Low Drop); 12: AF Class 1 (Medium Drop); 14: AF Class 1 (High Drop); 18: AF Class 2 (Low Drop); 20: AF Class 2 (Medium Drop); 22: AF Class 2 (High Drop); 26: AF Class 3 (Low Drop); 28: AF Class 3 (Medium Drop); 30: AF Class 3 (High Drop); 34: AF Class 4 (Low Drop); 36: AF Class 4 (Medium Drop); 38: AF Class 4 (High Drop); 46: EF Class."},"serviceType":{"type":"string","description":"The ID of Gateway Qos Service selected in the Service Name configuration. The ID can be obtained from 'Get all Gateway QoS Service's ID and name info in siteTemplate' interface."},"classType":{"type":"integer","description":"The Class value selected in the Qos Class configuration should be a value as follows: 1: Class 1, 2: Class 2, 3: Class 3.","format":"int32"}}},"QosBwcEditOpenApiVO":{"required":["classRatio","direction","inBandwidth","outBandwidth","outPrioritization","status","udpBandwidthCtrl"],"type":"object","properties":{"status":{"type":"boolean","description":"The status of Bandwidth Control rule, valid values is true or false."},"wan":{"type":"string","description":"The wan of Bandwidth Control rule."},"udpBandwidthCtrl":{"type":"boolean","description":"The UDP Bandwidth Control of Bandwidth Control rule, valid values is true or false."},"udpRatio":{"type":"integer","description":"The Limited Bandwidth Ratio of Bandwidth Control rule. It should be within the range of 0-100 when parameter [udpBandwidthCtrl] is true.","format":"int32"},"outPrioritization":{"type":"boolean","description":"The Outbound TCP ACK Prioritize of Bandwidth Control rule, valid values is true or false."},"direction":{"type":"integer","description":"The direction value selected in the Direction configuration should be a value as follows: 0: Inbound; 1: Outbound; 2: Both.","format":"int32"},"inBandwidth":{"type":"integer","description":"The Inbound Bandwidth of Bandwidth Control rule should be within the range of 100-1000000.","format":"int32"},"outBandwidth":{"type":"integer","description":"The Outbound Bandwidth of Bandwidth Control rule should be within the range of 100-1000000.","format":"int32"},"classRatio":{"type":"array","description":"The ratio of class type, value's format is [class1 ratio, class2 ratio, class3 ratio, others ratio].","items":{"type":"integer","description":"The ratio of class type, value's format is [class1 ratio, class2 ratio, class3 ratio, others ratio].","format":"int32"}}}},"GatewayQosServiceOpenApiVO":{"required":["name","protocol"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"The name of Gateway QoS Service should contain 1 to 64 characters."},"protocol":{"type":"integer","description":"The protocol of Gateway QoS Service should be a value as follows: 0: TCP, 1: UDP, 2: TCP/UDP, 3: ICMP, 4: Other.","format":"int32"},"sourceStartPort":{"type":"integer","description":"The start port of Source Port Range. It must be less than the end port. It should be within the range of 0-65535 when protocol is 0(TCP), 1(UDP) or 2(TCP/UDP).","format":"int32"},"sourceEndPort":{"type":"integer","description":"The end port of Source Port Range. It must be more than the start port. It should be within the range of 0-65535 when protocol is 0(TCP), 1(UDP) or 2(TCP/UDP).","format":"int32"},"destStartPort":{"type":"integer","description":"The start port of Destination Port Range. It must be less than the end port. It should be within the range of 0-65535 when protocol is 0(TCP), 1(UDP) or 2(TCP/UDP).","format":"int32"},"destEndPort":{"type":"integer","description":"The end port of Destination Port Range. It must be more than the start port. It should be within the range of 0-65535 when protocol is 0(TCP), 1(UDP) or 2(TCP/UDP).","format":"int32"},"type":{"type":"integer","description":"The type cannot be null and should be within the range of 0-255 when protocol is 3(ICMP).","format":"int32"},"code":{"type":"integer","description":"The code cannot be null and should be within the range of 0-255 when protocol is 3(ICMP).","format":"int32"},"protoNum":{"type":"integer","description":"The protoNum cannot be null and should be within the range of 1-255 when protocol is 4(Other).","format":"int32"},"description":{"pattern":"^$|^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"The description of Gateway QoS Service should contain 0 to 128 characters."}}},"BonjourServiceOpenApiVO":{"required":["name","serviceIds"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"The name of Bonjour Service should contain 1 to 64 characters."},"serviceIds":{"maxItems":3,"minItems":1,"type":"array","description":"The Service ID list of Bonjour Service. Service ID is a string in \"_A._B.local\" format, where \"A\" can be lowercase letters/numbers/hyphens (-)/underscore (_), and \"B\" should be lowercase letters. For example: _a1._b.local.Up to 3 entries are allowed for the serviceIds list.","items":{"maxLength":3,"minLength":1,"type":"string","description":"The Service ID list of Bonjour Service. Service ID is a string in \"_A._B.local\" format, where \"A\" can be lowercase letters/numbers/hyphens (-)/underscore (_), and \"B\" should be lowercase letters. For example: _a1._b.local.Up to 3 entries are allowed for the serviceIds list."}}}},"ApnProfileConfig":{"required":["apnType","authentication","name","pdpType"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"APN profile name, name should contain 1 to 64 characters."},"pdpType":{"type":"integer","description":"PdpType should be a value as follows: 0: IPv4; 1: IPv6; 2: IPv4 & IPv6.","format":"int32"},"apnType":{"type":"integer","description":"ApnType should be a value as follows: 0: static; 1: dynamic.","format":"int32"},"apn":{"pattern":"^([A-Za-z0-9\\-\\.]){1,62}$","type":"string","description":"Access point name, only for apnType static, should contain 1 to 62 characters and should meet the following requirements:\n    1. Only allow letters, numbers, hyphens and dots.\n    2. Should not start with \"rac\", \"lac\", \"sgsn\" or \"rnc\" and end with \".gprs\", ignoring case.\n    3. Should not contain \".-\", \"-.\" and spaces.\n"},"username":{"pattern":"^[\\x21\\x23-\\x26\\x28-\\x2B\\x2D-\\x7E]{1,64}$","type":"string","description":"Username should contain 1 to 64 characters, spaces, comma, single quotation marks and double quotation marks are not allowed."},"password":{"pattern":"^[\\x21\\x23-\\x26\\x28-\\x2B\\x2D-\\x7E]{1,64}$","type":"string","description":"Password should contain 1 to 64 characters, spaces, comma, single quotation marks and double quotation marks are not allowed."},"authentication":{"type":"integer","description":"Authentication should be a value as follows: 0: None; 1: PAP; 2: CHAP","format":"int32"},"applyToSIM":{"type":"integer","description":"When the device supports Dual-SIM card, parameter [applyToSim] should be a value as follows: 1: apply to SIM1; 2: apply to SIM2; 3: apply to SIM1 and SIM2.","format":"int32"}}},"OUI and description.":{"required":["oui"],"type":"object","properties":{"oui":{"type":"string","description":"Organizationally unique identifier, should be upper MAC"},"description":{"type":"string","description":"The description of OUI should contain 1 to 128 characters., could be empty"}},"description":"OUI and description"},"OuiProfileOpenApiVO":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"OUI Profile name should contain 1 to 64 characters."},"ouiCombine":{"type":"array","description":"OUI and description","items":{"$ref":"#/components/schemas/OUI and description."}}},"description":"OUIProfileOpenApiVO"},"Dhcp Servers setting":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"The switch of DHCP Guarding. When the switch is off, any configuration of DHCP Guarding will not be saved."},"mode":{"type":"integer","description":"The fill mode of DHCP Guarding, 1：follow Server 2：custom","format":"int32"},"dhcpSvr1":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Primary DHCP Guarding IP"},"dhcpSvr2":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Secondary DHCP Guarding IP"}},"description":"Legal DHCP Server"},"DhcpRangeOpenApiVO":{"type":"object","properties":{"ipaddrStart":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"DHCP Range Start IP"},"ipaddrEnd":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"DHCP Range End IP"}},"description":"The list of DHCP Range, which size can't be more than \"dhcpRangePoolSize\", \"dhcpRangePoolSize\" can be obtained from 'Get LAN network list' interface."},"DhcpSettingConfig":{"type":"object","properties":{"enable":{"type":"boolean","description":"When value is true, DHCP server is enabled"},"ipRangePool":{"type":"array","description":"The list of DHCP Range, which size can't be more than \"dhcpRangePoolSize\", \"dhcpRangePoolSize\" can be obtained from 'Get LAN network list' interface.","items":{"$ref":"#/components/schemas/DhcpRangeOpenApiVO"}},"dhcpns":{"type":"string","description":"Setup DHCP server: \"auto\" or \"manual\""},"priDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"When DHCPs are \"manual\", primary DNS Server."},"sndDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"When DHCPs are \"manual\", second DNS Server."},"leasetime":{"type":"integer","description":"Leasetime should be within the range of 2-10080","format":"int32"},"gateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Manual Setup of DHCP Gateway IP"},"dhcpNextServer":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The dhcpNextServer should be valid IP address, which is used in optional set next DHCP server."},"dhcpPoolMask":{"type":"integer","format":"int32"},"options":{"type":"array","description":"User custom DHCP options","items":{"$ref":"#/components/schemas/custom DHCP Options"}}},"description":"Configure DHCP settings"},"Dhcpv6 Servers setting":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"The switch of DHCPv6 Guarding"},"dhcpv6Svr1":{"pattern":"(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\S*$)","type":"string","description":"DHCPv6 Server IP1"},"dhcpv6Svr2":{"pattern":"(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\S*$)","type":"string","description":"DHCPv6 Server IP2"}},"description":"Legal DHCPv6 Server"},"Dhcpv6 Setting":{"type":"object","properties":{"gateway":{"type":"string","description":"Gateway IPv6"},"subnet":{"type":"integer","description":"Netmask IPv6","format":"int32"},"ipaddrStart":{"type":"string","description":"DHCP Range Start"},"ipaddrEnd":{"type":"string","description":"DHCP Range End"},"leasetime":{"type":"integer","description":"Leasetime should be within the range of 1-11520. Time unit: min(s)","format":"int32"},"dnsv6":{"type":"integer","description":"DHCP Name Server, should be a value as follows: 0: \"auto\"; 1: \"manual\"","format":"int32"},"priDns":{"type":"string","description":"When DNSv6 is 1: \"manual\", primary DNS Server"},"sndDns":{"type":"string","description":"When DNSv6 is 1: \"manual\", second DNS Server"}},"description":"Dhcpv6 Setting"},"Lan network IPV6 config":{"required":["enable","proto"],"type":"object","properties":{"proto":{"type":"integer","description":"The IPv6 Connection Type of LAN port. Proto should be a value as follows:  0: \"none\" (Default); 1: \"DHCPv6\"; 2: \"SLAAC+Stateless DHCP\"; 3: \"SLAAC+RDNSS\"; 4: \"passthrough\"","format":"int32"},"enable":{"type":"integer","description":"IPv6 enable should be a value as follows: 0: Disable (Default); 1: Enable","format":"int32"},"dhcpv6":{"$ref":"#/components/schemas/Dhcpv6 Setting"},"slaac":{"$ref":"#/components/schemas/Lan network proto: SLAAC+Stateless DHCP mode or SLAAC+RDNSS mode"},"rdnss":{"$ref":"#/components/schemas/Lan network proto: SLAAC+Stateless DHCP mode or SLAAC+RDNSS mode"},"passthrough":{"$ref":"#/components/schemas/Lan network proto: Pass-Through mode"},"ra":{"$ref":"#/components/schemas/Ra Setting"}},"description":"LAN network IPv6 config"},"Lan network proto: Pass-Through mode":{"type":"object","properties":{"portId":{"type":"string","description":"The port ID of WAN port"}},"description":"Lan network proto: Pass-Through mode"},"Lan network proto: SLAAC+Stateless DHCP mode or SLAAC+RDNSS mode":{"type":"object","properties":{"preType":{"type":"integer","description":"Prefix type should be a value as follows:  0: \"manual\"; 1: \"get from PD\"","format":"int32"},"prefix":{"type":"string","description":"Address prefix"},"portUuid":{"type":"string","description":"The port UUID of WAN"},"preId":{"type":"integer","description":"Prefix ID should be within the range of 0-127","format":"int32"},"dnsv6":{"type":"integer","description":"DHCP Name Server, should be a value as follows: 0: \"auto\"; 1: \"manual\"","format":"int32"},"priDns":{"type":"string","description":"Primary DHCP Name Server, only effective for DNSv6 \"manual\""},"sndDns":{"type":"string","description":"Secondary DHCP Name Server, only effective for dnsv6 \"manual\""}},"description":"Lan network proto: SLAAC+Stateless DHCP mode or SLAAC+RDNSS mode"},"LanNetworkOpenApiV3VO":{"required":["deviceType","igmpSnoopEnable","name"],"type":"object","properties":{"name":{"type":"string","description":"LAN network name should contain 1 to 128 characters."},"vlanType":{"type":"integer","description":"VLANType should be a value as follows: 0: Single; 1: Multiple","format":"int32"},"vlans":{"pattern":"^[\\d|\\d-\\d]+(,[\\d|\\d-\\d]+)*$","type":"string","description":"Only valid when vlanType is 1 and device type is 0 , 1 or 3. When device type is 0 or 3, batch create single vlan, when deviceType is 1 , create bridge vlan. VLAN format: 200, 1-100."},"vlan":{"type":"integer","description":"Only Valid when vlanType is 0. Vlan should be within the range of 1-4094.","format":"int32"},"gatewaySubnet":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])/(\\d|((1|2)\\d)|(30))\\b","type":"string","description":"When deviceType is 1, gateway subnet is needed. Format: IP/Mask"},"dhcpSettings":{"$ref":"#/components/schemas/DhcpSettingConfig"},"domain":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"The domain of this network"},"igmpSnoopEnable":{"type":"boolean","description":"Enable IGMP snooping"},"mldSnoopEnable":{"type":"boolean","description":"Enable MLD snooping"},"dhcpL2RelayEnable":{"type":"boolean","description":"The switch of DHCP L2 relay"},"dhcpGuard":{"$ref":"#/components/schemas/Dhcp Servers setting"},"dhcpv6Guard":{"$ref":"#/components/schemas/Dhcpv6 Servers setting"},"lanNetworkIpv6Config":{"$ref":"#/components/schemas/Lan network IPV6 config"},"arpDetectionEnable":{"type":"boolean","description":"Enable arp detection. Only valid when deviceType is 1 and gateway supports this feature."},"isolation":{"type":"boolean","description":"Whether network isolated."},"qosQueueEnable":{"type":"boolean","description":"The switch of QoS queue."},"queueId":{"type":"integer","description":"QoS queue Id.","format":"int32"},"deviceType":{"type":"integer","description":"DHCP Server Device type. It should be a value as follows: 0:External Device 1:gateway 2:switch 3:none","format":"int32"},"deviceMac":{"type":"string","description":"DHCP Server Device mac. Only valid when deviceType is 1 or 2. When deviceType is 1, deviceMac can be empty when there is no gateway in the site."},"stackId":{"type":"string","description":"DHCP Server Device stackId. Only valid when deviceType is 2 and the selected device is stack"},"ip":{"$ref":"#/components/schemas/OswIpSettingBriefOpenapiVO"},"mode":{"type":"integer","description":"DHCP mode. 0: None 1: DHCP Server 2: DHCP Relay. Only valid when deviceType is 2.","format":"int32"},"vrfId":{"type":"string","description":"VRF ID"},"dhcpServer":{"$ref":"#/components/schemas/OswDhcpServerOpenApiVO"},"dhcpRelay":{"$ref":"#/components/schemas/OswDhcpRelayOpenApiVO"},"subnetOverrideEnable":{"type":"boolean","description":"The switch status of DHCP Settings Overrides."}},"description":"LANNetworkOpenApiVO"},"ModifyVlanParamOpenApiVO":{"required":["deviceConfig","lanNetwork"],"type":"object","properties":{"skipEnable":{"type":"boolean","description":"Whether skip the second step when modify vlan"},"lanNetwork":{"$ref":"#/components/schemas/LanNetworkOpenApiV3VO"},"deviceConfig":{"$ref":"#/components/schemas/SelectPortBindingBriefVO"}},"description":"ModifyVlanParamOpenApiVO"},"OswDhcpRelayOpenApiVO":{"type":"object","properties":{"addr":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Address IP, like 192.168.0.1"},"vrfId":{"type":"string","description":"VRF ID"},"serverAddrs":{"type":"array","description":"Server Address IP List, like 192.168.0.1","items":{"type":"string","description":"Server Address IP List, like 192.168.0.1"}}},"description":"Network DHCP relay settings. Only valid when deviceType is 2 and mode is 2"},"OswDhcpServerOpenApiVO":{"required":["leasetime"],"type":"object","properties":{"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"DHCP Server IP, like 192.168.0.1."},"netmask":{"type":"string","description":"Parameter [netmask] should be within the range of 1-31"},"ipRangePool":{"type":"array","description":"The list of DHCP Range","items":{"$ref":"#/components/schemas/OswDhcpServerRangeOpenApiVO"}},"priDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Primary DNS, like 192.0.0.1"},"sndDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Second DNS, like 8.8.8.8"},"leasetime":{"type":"integer","description":"Lease time should be within the range of 2–2880","format":"int32"},"gateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Gateway IP, like 192.168.0.1"},"option138":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"option138 ip, like 192.168.0.1"},"dhcpPoolMask":{"type":"integer","description":"DHCP pool mask, value is from 1 to 31.","format":"int32"},"options":{"maxItems":256,"minItems":0,"type":"array","description":"Custom DHCP options.","items":{"$ref":"#/components/schemas/Switch custom DHCP Options"}},"vrfId":{"type":"string","description":"VRF ID"}},"description":"Network DHCP server settings. Only valid when deviceType is 2 and mode is 1."},"OswDhcpServerRangeOpenApiVO":{"required":["endIp","startIp"],"type":"object","properties":{"startIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string"},"endIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string"}},"description":"The list of DHCP Range"},"OswIpSettingBriefOpenapiVO":{"required":["mode"],"type":"object","properties":{"mode":{"type":"integer","description":"IP Setting mode. Static:0, DHCP:1","format":"int32"},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Static IP for mode 0, like 192.168.0.1"},"netmask":{"pattern":"(254|252|248|240|224|192|128|0).0.0.0|255.(254|252|248|240|224|192|128|0).0.0|255.255.(254|252|248|240|224|192|128|0).0|255.255.255.(254|252|248|240|224|192|128|0)","type":"string","description":"IP Mask, like 255.255.255.0"},"option12":{"type":"string","description":"option12"}},"description":"Network IP setting. Only valid when deviceType is 2."},"PortBindingVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device mac for Site Setting or Device template ID for Site Template Setting"},"type":{"type":"integer","description":"Device type, 1: gateway  2: switch  3: ap","format":"int32"},"ports":{"type":"array","description":"Selected ports.","items":{"type":"string","description":"Selected ports."}},"lags":{"type":"array","description":"Selected lags.","items":{"type":"integer","description":"Selected lags.","format":"int32"}},"stackId":{"type":"string","description":"Stack ID.Site Template Setting ignores this field"}},"description":"Device List"},"Ra Setting":{"type":"object","properties":{"enable":{"type":"boolean","description":"The switch of Ra"},"preference":{"type":"integer","description":"Preference should be a value as follows: 0: \"low\"; 1: \"medium\"; 2: \"high\"","format":"int32"},"validLifetime":{"type":"integer","description":"ValidLifetime should be larger than PreferredLifetime.","format":"int32"},"preferredLifetime":{"type":"integer","description":"PreferredLifetime","format":"int32"}},"description":"Ra Setting"},"SelectPortBindingBriefVO":{"type":"object","properties":{"portIsolationEnable":{"type":"boolean","description":"Enable Port Isolation, only valid when creating network."},"flowControlEnable":{"type":"boolean","description":"Enable Flow Control, only valid when creating network."},"tagIds":{"uniqueItems":true,"type":"array","description":"Tag ID Set","items":{"type":"string","description":"Tag ID Set"}},"deviceList":{"type":"array","description":"Device List","items":{"$ref":"#/components/schemas/PortBindingVO"}},"internetPorts":{"type":"array","description":"Internet Ports","items":{"type":"string","description":"Internet Ports"}}},"description":"Devcie config."},"Switch custom DHCP Options":{"type":"object","properties":{"custom":{"type":"boolean","description":"Whether is custom by user."},"name":{"type":"string","description":"Custom DHCP option name."},"code":{"type":"integer","description":"Custom DHCP option code","format":"int32"},"type":{"type":"integer","description":"Type should be a value as follows: 0: \"Hex Array\"; 1: \"String\"; 2: \"IP Address\"","format":"int32"},"value":{"type":"string","description":"Value"}},"description":"Custom DHCP options."},"custom DHCP Options":{"type":"object","properties":{"custom":{"type":"boolean","description":"Whether is custom by user."},"name":{"type":"string","description":"Custom DHCP option name."},"code":{"type":"integer","description":"Custom DHCP option code","format":"int32"},"type":{"type":"integer","description":"Type should be a value as follows: 0: \"String\"; 1: \"IP Address\"; 2: \"Hex Array\"","format":"int32"},"value":{"type":"string","description":"Value"}},"description":"User custom DHCP options"},"OperationResponseVlanNetworkIdListVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VlanNetworkIdListVO"}}},"VlanNetworkIdListVO":{"type":"object","properties":{"networkIdList":{"type":"array","description":"Network ID list","items":{"type":"string","description":"Network ID list"}}}},"UpdateWipsConfigOpenApiVO":{"required":["deauthEn","dynamicEn","status"],"type":"object","properties":{"status":{"type":"boolean","description":"Wireless IPS config status; true:enable, false:disable."},"deauthEn":{"type":"boolean","description":"Wireless IPS deauthenticate config status; true:enable, false:disable."},"dynamicEn":{"type":"boolean","description":"Wireless IPS dynamic block list config status; true:enable, false:disable."},"lockTime":{"type":"integer","description":"Wireless IPS device locking duration config status; It should be within the range of 300–36000; this field is required when parameter [dynamicEn] is true.","format":"int32"}}},"UpdateWidsConfigOpenApiVO":{"required":["level","status"],"type":"object","properties":{"status":{"type":"boolean","description":"Wireless IDS config status; true:enable, false:disable."},"level":{"type":"integer","description":"Wireless IDS detection level; It should be a value as follows: 0:High; 1:Low; 2:Custom.","format":"int32"},"detection":{"type":"array","description":"Wireless IDS detection type, the value is returned only when level is custom(2); It should be a value as follows: 0: Signature_disassociation_broadcast; 1: Signature_deauth_broadcast; 2: Detect_apspoofing; 3: Detect_adhoc_using_valid_ssid; 4: Detect_malformed_large_duration; 5: Detect_overflow_eapol_key; 6: Detect_ap_impersonation; 7: Detect_ht_greenfield; 8: Detect_incomplete_ie; 9: Detect_malformed_htie; 10: Detect_malformed_frame_auth; 11: Detect_malformed_assoc_req; 12: Detect_valid_ssid_misuse; 13: Detect_adhoc_network; 14: Detect_client_flood; 16: Detect_power_save_dos_flood_attack; 17: Detect_violence_break.","items":{"type":"integer","description":"Wireless IDS detection type, the value is returned only when level is custom(2); It should be a value as follows: 0: Signature_disassociation_broadcast; 1: Signature_deauth_broadcast; 2: Detect_apspoofing; 3: Detect_adhoc_using_valid_ssid; 4: Detect_malformed_large_duration; 5: Detect_overflow_eapol_key; 6: Detect_ap_impersonation; 7: Detect_ht_greenfield; 8: Detect_incomplete_ie; 9: Detect_malformed_htie; 10: Detect_malformed_frame_auth; 11: Detect_malformed_assoc_req; 12: Detect_valid_ssid_misuse; 13: Detect_adhoc_network; 14: Detect_client_flood; 16: Detect_power_save_dos_flood_attack; 17: Detect_violence_break.","format":"int32"}}}},"PortForwardingTemplateOpenApiVO":{"required":["dMZ","forwardIp","from","interfaceWanPortId","name","status"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name, name should contain 1 to 64 characters."},"status":{"type":"boolean","description":"Port-forwarding enable status."},"from":{"type":"integer","description":"From corresponds with source IP in web. From should be a value as follows: 0: where; 1: limited address","format":"int32"},"limitedAddresses":{"type":"array","description":"Only for limited address","items":{"type":"string","description":"Only for limited address"}},"interfaceWanPortId":{"type":"array","description":"This field represents WAN port ID. WAN port ID can be obtained from can be obtained from 'Get internet basic info' interface.","items":{"type":"string","description":"This field represents WAN port ID. WAN port ID can be obtained from can be obtained from 'Get internet basic info' interface."}},"externalPort":{"pattern":"^(([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5]))|((([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5]))-(([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5])))$","type":"string","description":"External port corresponds with source port in web. External port should be within the range of 1–65535. Must be filled in when DMS is false."},"forwardIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Forward IP corresponds with destination IP in web. Forward IP"},"forwardPort":{"pattern":"^(([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5]))|((([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5]))-(([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5])))$","type":"string","description":"Forward port corresponds with destination port in web. Forward port should be 1 or 1-10, within the range of 1–65535. Must be filled in when DMS is false."},"protocol":{"type":"integer","description":"Protocol should be a value as follows: 0: ALL; 1: TCP; 2: UDP. Must be filled in when DMS is false.","format":"int32"},"dMZ":{"type":"boolean","description":"With DMZ enabled, all ports are open and the traffic from external network will be forwarded to the specific destination IP in the LAN."}}},"ALGSetting":{"required":["ftp","h323","ipSec","pptp","sip"],"type":"object","properties":{"ftp":{"type":"boolean","description":"Whether to enable the FTP ALG"},"h323":{"type":"boolean","description":"Whether to enable the H323 ALG"},"pptp":{"type":"boolean","description":"Whether to enable the PPTP ALG"},"sip":{"type":"boolean","description":"Whether to enable the SIP ALG"},"ipSec":{"type":"boolean","description":"Whether to enable the IPSec ALG"},"ftpPorts":{"type":"array","description":"The listening port for FTP signaling messages, the default port is 21","items":{"type":"integer","description":"The listening port for FTP signaling messages, the default port is 21","format":"int32"}},"sipTcp":{"type":"boolean","description":"Enable this option if your SIP signaling uses the TCP protocol and the device needs to modify the IP address and port in SIP messages, enabled by default."},"sipUdp":{"type":"boolean","description":"Enable this option if your SIP signaling uses the UDP protocol and the device needs to modify the IP address and port in SIP signaling messages, enabled by default."},"sipPorts":{"type":"array","description":"The listening ports for SIP signaling messages, the default ports are 5060 and 5061","items":{"type":"integer","description":"The listening ports for SIP signaling messages, the default ports are 5060 and 5061","format":"int32"}},"sipDirectSignaling":{"type":"boolean","description":"Enable this option if you want SIP signaling connections to only arrive from registered IP addresses, enabled by default."},"sipDirectMedia":{"type":"boolean","description":"Enable this option if you want SIP media connections to only arrive from registered IP addresses."},"sipTimeout":{"type":"boolean","description":"Enable this option if you want to apply timeout limits to SIP signaling and media connections on the device."},"sipSignalingTimeout":{"type":"integer","description":"Modify this item if you want to adjust the timeout duration for SIP signaling sessions (1 – 86,400 seconds).","format":"int32"},"sipMediaTimeout":{"type":"integer","description":"Modify this item if you want to adjust the timeout duration for SIP media sessions (1 – 86,400 seconds).","format":"int32"}}},"SiteLedSetting":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable led"}},"description":"Site led setting"},"SiteLagHashAlgOpenApiVO":{"required":["type"],"type":"object","properties":{"type":{"type":"integer","description":"It should be a value as follows: 0: SRC MAC; 1: DST MAC; 2: SRC MAC + DST MAC; 3: SRC IP; 4: DST IP; 5: SRC IP + DST IP.","format":"int32"}}},"SiteJumboOpenApiVO":{"type":"object","properties":{"size":{"type":"integer","description":"It should be within the range of 1518–9216 Bytes.","format":"int32"}}},"VirtualWanWeightOpenApiVO":{"required":["virtualWanId"],"type":"object","properties":{"virtualWanId":{"type":"string","description":"virtual wan id"},"weight":{"type":"integer","description":"virtual wan weight","format":"int32"},"name":{"type":"string","description":"virtual wan name"},"physicalWanId":{"type":"string","description":"physical wan id"}},"description":"virtual wan load balance"},"WanLoadBalanceOpenApiVO":{"required":["appOptRouting","linkBackup","weights"],"type":"object","properties":{"weights":{"type":"array","description":"Load Balancing Weights,item of weights should be within the range of 1 to the max int value(2147483647). It is sorted by port ID.","items":{"type":"integer","description":"Load Balancing Weights,item of weights should be within the range of 1 to the max int value(2147483647). It is sorted by port ID.","format":"int32"}},"appOptRouting":{"type":"boolean","description":"Application Optimized Routing"},"linkBackup":{"type":"boolean","description":"Link Backup"},"method":{"type":"string","description":"effective only for 'linkBackup: true'"},"primaryWans":{"type":"array","description":"Primary WAN port IDs. It is required when [linkBackup] is true.","items":{"type":"string","description":"Primary WAN port IDs. It is required when [linkBackup] is true."}},"backupWan":{"type":"string","description":"Backup WAN ID. It is required when [linkBackup] is true."},"backupMode":{"type":"integer","description":"It is required when [linkBackup] is true. 0: The system will try to forward the traffic via the backup WAN port when primary WAN fails. Even if the primary WAN is recovered, it will not switch back unless the backup WAN fails; 1: Traffic is always forwarded through the primary WAN port unless it fails. The system will try to forward the traffic via the backup WAN port when it fails, and switch back when it recovers.","format":"int32"},"mode":{"type":"integer","description":"It is required when [linkBackup] is true. 0: Enable backup link when any primary WAN fails. 1: Enable backup link when all primary WANs fail. 2: Timing","format":"int32"},"timeRangeId":{"type":"string","description":"Time Range ID. It is required when [mode] is timing."},"virtualWanWeights":{"type":"array","description":"virtual wan load balance","items":{"$ref":"#/components/schemas/VirtualWanWeightOpenApiVO"}}}},"InternetBaseConfigTemplateOpenApiVO":{"required":["wanPortList"],"type":"object","properties":{"wanPortList":{"type":"array","description":"List of enabled WAN port IDs, the valid port IDs can be obtained from \"Get site template internet basic info\".","items":{"type":"string","description":"List of enabled WAN port IDs, the valid port IDs can be obtained from \"Get site template internet basic info\"."}},"interval":{"type":"integer","description":"Online detection interval(second). 0 means disable. It should be within the range of 0–3600.","format":"int32"}}},"OsgConfigWlansOpenApiVO":{"required":["ssidOverrides"],"type":"object","properties":{"wlanId":{"type":"string","description":"WLAN ID"},"ssidOverrides":{"type":"array","description":"Overrided SSID List","items":{"$ref":"#/components/schemas/OsgSsidOverrideOpenApiVO"}},"wlansResource":{"type":"integer","description":"Wlans Resource","format":"int32"}}},"OsgSsidOverrideOpenApiVO":{"required":["enable","globalSsid","hidePwd","index","security","ssid","ssidEnable","vlanEnable"],"type":"object","properties":{"index":{"type":"integer","description":"SSID Entry ID","format":"int32"},"globalSsid":{"type":"string","description":"SSID Name"},"bandInfo":{"type":"integer","description":"Band. Deprecated, use supportBands instead","format":"int32","deprecated":true},"supportBands":{"type":"array","description":"support band 2.4GHz(0) 5GHz(1) 6GHz(2)","items":{"type":"integer","description":"support band 2.4GHz(0) 5GHz(1) 6GHz(2)","format":"int32"}},"security":{"type":"integer","description":"SSID Security Mode, must be the same as the current SSID Security","format":"int32"},"enable":{"type":"boolean","description":"Enable/disable SSID override"},"vlanEnable":{"type":"boolean","description":"Enable/disable VLAN override"},"vlanId":{"type":"integer","description":"VLAN ID","format":"int32"},"ssid":{"type":"string","description":"Override SSID"},"psk":{"type":"string","description":"Override SSID Password"},"ssidEnable":{"type":"boolean","description":"Enable/disable SSID"},"hidePwd":{"type":"boolean","description":"hide password"}},"description":"Overrided SSID List"},"OsgConfigServicesOpenApiVO":{"type":"object","properties":{"snmp":{"$ref":"#/components/schemas/OsgSnmpOpenApiVO"}}},"OsgSnmpOpenApiVO":{"type":"object","properties":{"location":{"pattern":"^[!-~][\\040-\\0176]{0,126}[!-~]$|^[!-~]$|$","type":"string","description":"Location, location should contain 0 to 128 ASCII characters, spaces are allowed, and leading and trailing spaces are not allowed."},"contact":{"pattern":"^[\\041-\\0176]{0,128}$","type":"string","description":"Contact, contact should contain 0 to 128 ASCII characters, spaces are not allowed."},"type":{"type":"integer","description":"SNMP config type, 0: use site setting, 1:custom.","format":"int32"}},"description":"Snmp setting"},"ApRadioSettingopenApiVO":{"type":"object","properties":{"radioEnable":{"type":"boolean","description":"Enable/Disable radio setting(if false, other params is not required)"},"channelRange":{"type":"array","description":"Custom optional channel freq collection.","items":{"type":"integer","description":"Custom optional channel freq collection.","format":"int32"}},"channelWidth":{"pattern":"^([2-9]|10)$","type":"string","description":"RADIO_20 = 2; RADIO_40 = 3; RADIO_40_20 = 4(corresponding 2G Auto); RADIO_80 = 5; RADIO_80_40_20 = 6(corresponding 5G Auto); RADIO_160= 7; RADIO_160_80_40_20 = 8; RADIO_240 = 9; RADIO_320 = 10"},"channel":{"pattern":"^[0-9]+$","type":"string","description":"Channel Index; The channel index list supported by device can be obtained from interface : Get available channel list of ap; If select auto configuration need to enter 0."},"txPower":{"type":"integer","description":"TX Power","format":"int32"},"txPowerLevel":{"type":"integer","description":"It should be a value as follows: 0: Low; 1: Medium; 2: High; 3: Custom; 4: Auto","format":"int32"},"channelLimitEnable":{"type":"boolean","description":"Enable channel limit(site level)"},"freq":{"type":"integer","description":"Frequency;The frequency list supported by device can be obtained from interface : Get available channel list of ap.The freq and channel fields should be corresponding, otherwise the channel will be corrected based on the freq field.","format":"int32"},"wirelessMode":{"type":"integer","description":"Wireless mode config status of the device; -2 : Auto; 3 : 802.11b/g mixed(Only for 2.4G); 4 : 802.11b/g/n mixed(Only for 2.4G); 13 : 802.11b/g/n/ax mixed(Only for 2.4G); 17 : 802.11b/g/n/ax/be mixed(Only for 2.4G); 7 : 802.11a/n mixed(Only for 5G); 10 : 802.11a/n/ac mixed(Only for 5G); 16 : 802.11a/n/ac/ax mixed(Only for 5G); 18 : 802.11a/n/ac/ax/be mixed(Only for 5G); 11 : 802.11ax only(Only for 6G); 19 : 802.11ax/be mixed(Only for 6G).","format":"int32"},"nonPscEnable":{"type":"boolean","description":"APP 6G Radio Setting"},"autoSwitchOffWifi":{"type":"boolean","description":"Whether enable to auto switch off wifi"},"autoSwitchOffWifiInterval":{"type":"integer","description":"The interval of auto switch off wifi","format":"int32"}},"description":"Radio setting of 6 GHz."},"OsgConfigRadiosopenApiVO":{"type":"object","properties":{"radioSetting2g":{"$ref":"#/components/schemas/ApRadioSettingopenApiVO"},"radioSetting5g":{"$ref":"#/components/schemas/ApRadioSettingopenApiVO"},"radioSetting5g1":{"$ref":"#/components/schemas/ApRadioSettingopenApiVO"},"radioSetting5g2":{"$ref":"#/components/schemas/ApRadioSettingopenApiVO"},"radioSetting6g":{"$ref":"#/components/schemas/ApRadioSettingopenApiVO"}}},"DeviceLocationDetailOpenApiVO":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude of the device. This subsection is deprecated.","format":"double"},"latitude":{"type":"number","description":"Latitude of the device. This subsection is deprecated.","format":"double"},"address":{"type":"string","description":"Address of the device. This subsection is deprecated."}},"description":"Device location. This subsection is deprecated."},"OsgGeneralConfigOpenApiV2VO":{"required":["ledSetting"],"type":"object","properties":{"name":{"type":"string","description":"Device name should contain 1 to 128 characters. This subsection is deprecated.","deprecated":true},"ledSetting":{"type":"integer","description":"Led setting should be a value as follows: 0:off; 1:on; 2:Use Site Settings","format":"int32"},"tagIds":{"type":"array","description":"Tag IDs. This subsection is deprecated.","deprecated":true,"items":{"type":"string","description":"Tag IDs. This subsection is deprecated.","deprecated":true}},"location":{"$ref":"#/components/schemas/DeviceLocationDetailOpenApiVO"},"snmp":{"$ref":"#/components/schemas/OsgSnmpOpenApiVO"},"rememberDevice":{"type":"integer","format":"int32"}}},"ApLoadBalanceOpenApiVO":{"type":"object","properties":{"lbEnable":{"type":"boolean","description":"Load Balance enabled or not."},"maxClients":{"type":"integer","description":"Maximum associated clients.","format":"int32"}},"description":"Load Balance setting of 6 GHz."},"ApQosOpenApiVO":{"type":"object","properties":{"wmmEnable":{"type":"boolean","description":"WWM enabled or not.","deprecated":true},"noAcknowledgement":{"type":"boolean","description":"No Acknowledgement enabled or not."},"deliveryEnable":{"type":"boolean","description":"Unscheduled Automatic Power Save Delivery enabled or not."}},"description":"Qos setting of 6 GHz."},"ApRssiThresholdOpenApiVO":{"type":"object","properties":{"rssiEnable":{"type":"boolean","description":"Rssi Threshold enabled or not."},"threshold":{"type":"integer","description":"Value of rssi threshold.","format":"int32"}},"description":"Rssi Threshold setting of 6 GHz."},"OsgConfigAdvancedOpenApiVO":{"type":"object","properties":{"hwOffloadEnable":{"type":"boolean","description":"Hardware Offload enabled or not."},"lldpEnable":{"type":"boolean","description":"LLDP enabled or not. Deprecated, filed lldpSetting is recommended","deprecated":true},"lldpSetting":{"type":"integer","description":"LLDP setting. 0: Off, 1: On, 2: Follow site.","format":"int32"},"poeSettings":{"type":"array","description":"Port Poe setting list.","items":{"$ref":"#/components/schemas/OsgPortPoeOpenApiVO"}},"echoServer":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"Echo Server should be a domain name or IP address."},"lbSetting2g":{"$ref":"#/components/schemas/ApLoadBalanceOpenApiVO"},"lbSetting5g":{"$ref":"#/components/schemas/ApLoadBalanceOpenApiVO"},"lbSetting5g1":{"$ref":"#/components/schemas/ApLoadBalanceOpenApiVO"},"lbSetting5g2":{"$ref":"#/components/schemas/ApLoadBalanceOpenApiVO"},"lbSetting6g":{"$ref":"#/components/schemas/ApLoadBalanceOpenApiVO"},"rssiSetting2g":{"$ref":"#/components/schemas/ApRssiThresholdOpenApiVO"},"rssiSetting5g":{"$ref":"#/components/schemas/ApRssiThresholdOpenApiVO"},"rssiSetting5g1":{"$ref":"#/components/schemas/ApRssiThresholdOpenApiVO"},"rssiSetting5g2":{"$ref":"#/components/schemas/ApRssiThresholdOpenApiVO"},"rssiSetting6g":{"$ref":"#/components/schemas/ApRssiThresholdOpenApiVO"},"qosSetting2g":{"$ref":"#/components/schemas/ApQosOpenApiVO"},"qosSetting5g":{"$ref":"#/components/schemas/ApQosOpenApiVO"},"qosSetting5g1":{"$ref":"#/components/schemas/ApQosOpenApiVO"},"qosSetting5g2":{"$ref":"#/components/schemas/ApQosOpenApiVO"},"qosSetting6g":{"$ref":"#/components/schemas/ApQosOpenApiVO"},"ofdmaEnable2g":{"type":"boolean","description":"Enable or disable OFDMA of 2.4 GHz."},"ofdmaEnable5g":{"type":"boolean","description":"Enable or disable OFDMA of 5 GHz."},"ofdmaEnable5g1":{"type":"boolean","description":"Enable or disable OFDMA of 5 GHz-1."},"ofdmaEnable5g2":{"type":"boolean","description":"Enable or disable OFDMA of 5 GHz-2."},"ofdmaEnable6g":{"type":"boolean","description":"Enable or disable OFDMA of 6 GHz."}}},"OsgPortPoeOpenApiVO":{"type":"object","properties":{"portId":{"type":"integer","description":"The number of the port.","format":"int32"},"portName":{"type":"string","description":"The name of the port."},"enable":{"type":"boolean","description":"The port enabled or not."}},"description":"Port Poe setting list."},"ApLoadBalanceVO":{"type":"object","properties":{"lbEnable":{"type":"boolean"},"maxClients":{"type":"integer","format":"int32"}}},"ApQosVO":{"type":"object","properties":{"wmmEnable":{"type":"boolean","deprecated":true},"noAcknowledgement":{"type":"boolean"},"deliveryEnable":{"type":"boolean"}}},"ApRssiThresholdVO":{"type":"object","properties":{"rssiEnable":{"type":"boolean"},"threshold":{"type":"integer","format":"int32"}}},"OsgConfigWirelessAdvancedOpenApiVO":{"type":"object","properties":{"lbSetting2g":{"$ref":"#/components/schemas/ApLoadBalanceVO"},"lbSetting5g":{"$ref":"#/components/schemas/ApLoadBalanceVO"},"lbSetting5g1":{"$ref":"#/components/schemas/ApLoadBalanceVO"},"lbSetting5g2":{"$ref":"#/components/schemas/ApLoadBalanceVO"},"lbSetting6g":{"$ref":"#/components/schemas/ApLoadBalanceVO"},"rssiSetting2g":{"$ref":"#/components/schemas/ApRssiThresholdVO"},"rssiSetting5g":{"$ref":"#/components/schemas/ApRssiThresholdVO"},"rssiSetting5g1":{"$ref":"#/components/schemas/ApRssiThresholdVO"},"rssiSetting5g2":{"$ref":"#/components/schemas/ApRssiThresholdVO"},"rssiSetting6g":{"$ref":"#/components/schemas/ApRssiThresholdVO"},"qosSetting2g":{"$ref":"#/components/schemas/ApQosVO"},"qosSetting5g":{"$ref":"#/components/schemas/ApQosVO"},"qosSetting5g1":{"$ref":"#/components/schemas/ApQosVO"},"qosSetting5g2":{"$ref":"#/components/schemas/ApQosVO"},"qosSetting6g":{"$ref":"#/components/schemas/ApQosVO"},"ofdmaEnable2g":{"type":"boolean"},"ofdmaEnable5g":{"type":"boolean"},"ofdmaEnable5g1":{"type":"boolean"},"ofdmaEnable5g2":{"type":"boolean"},"ofdmaEnable6g":{"type":"boolean"}}},"OsgConfigCommonAdvancedOpenApiVO":{"type":"object","properties":{"hwOffloadEnable":{"type":"boolean"},"lldpEnable":{"type":"boolean","description":"Deprecated, filed lldpSetting is recommended","deprecated":true},"lldpSetting":{"type":"integer","format":"int32"},"poeSettings":{"type":"array","items":{"$ref":"#/components/schemas/OsgPortPoeVO"}},"echoServer":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string"}}},"OsgPortPoeVO":{"type":"object","properties":{"portId":{"type":"integer","format":"int32"},"portName":{"type":"string"},"enable":{"type":"boolean"}}},"DpiSettings":{"required":["dpi","loggingTraffic"],"type":"object","properties":{"dpi":{"type":"boolean","description":"Enable dpi. true:enable / false:disable"},"loggingTraffic":{"type":"boolean","description":"Enable logging traffic. true:enable / false:disable"}}},"EditRuleEntity":{"required":["applications","qos","ruleName","schedule"],"type":"object","properties":{"ruleName":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"Rule name. It should be 1 - 128 characters"},"schedule":{"type":"string","description":"Schedule profile ID, which can be queried by request： Get time range profile list."},"qos":{"type":"boolean","description":"Enable qos. true:enable / false:disable"},"qosClass":{"type":"integer","description":"The Class value selected in the Qos Class configuration, required when qos is enable. Valid values is 0: Others, 1: Class 1, 2: Class 2, 3: Class 3.","format":"int32"},"applications":{"type":"array","description":"Application ID list can be obtained from 'Get application list' interface.","items":{"type":"integer","description":"Application ID list can be obtained from 'Get application list' interface.","format":"int32"}}}},"RestrictionEntity":{"required":["filterId","networkName"],"type":"object","properties":{"networkName":{"type":"string","description":"Network name. It should be the name of LAN network, can be obtained from 'Get LAN network list' interface."},"filterId":{"type":"integer","description":"Filter ID can be obtained from 'Get filter list' interface.","format":"int32"},"networkId":{"type":"string","description":"Network ID. It should be the ID of lan network. It can be queried by request: Get LAN network list."}}},"EditFilterEntity":{"required":["filterName","rules"],"type":"object","properties":{"filterName":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"Filter name. It should be 1 - 128 characters"},"description":{"pattern":"^.{1,128}$","type":"string","description":"Description of filter. It should be 1 - 128 characters"},"rules":{"type":"array","description":"Rule ID list can be obtained from 'Get rule list' interface.","items":{"type":"integer","description":"Rule ID list can be obtained from 'Get rule list' interface.","format":"int32"}}}},"OuiBasedVlanApOpenApiVO":{"required":["enable","name","ruleCombine","ssidIdList"],"type":"object","properties":{"enable":{"type":"boolean","description":"Ap Rule state."},"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Ap Rule name should contain 1 to 128 characters."},"ssidIdList":{"type":"array","description":"Configured ssid list.","items":{"type":"string","description":"Configured ssid list."}},"ruleCombine":{"type":"array","description":"Basic vlan-oui-priority configuration of oui based vlan rule. Cannot be empty.","items":{"$ref":"#/components/schemas/VlanOuiModeOpenApiVO"}}}},"Gateway ACL config mode entity":{"required":["mode"],"type":"object","properties":{"mode":{"type":"integer","description":"Gateway acl config mode should be a value as follows: 0: Through profiles; 1: Custom","format":"int32"}}},"Gateway ACL states entity":{"type":"object","properties":{"stateNew":{"type":"boolean","description":"Match state new"},"established":{"type":"boolean","description":"Match state established"},"related":{"type":"boolean","description":"Match state related"},"invalid":{"type":"boolean","description":"Match state invalid"}},"description":"Only for Gateway ACL"},"Gateway direction entity":{"type":"object","properties":{"lanToWan":{"type":"boolean","description":"Whether select LAN->WAN direction"},"lanToLan":{"type":"boolean","description":"Whether select LAN->LAN direction, which conflicts with other directions"},"wanInIds":{"type":"array","description":"Selected WAN port IDs","items":{"type":"string","description":"Selected WAN port IDs"}},"vpnInIds":{"type":"array","description":"Selected VPN IDs","items":{"type":"string","description":"Selected VPN IDs"}}},"description":"Only for Gateway."},"GatewayACLConfig":{"required":["description","destinationType","direction","policy","protocols","sourceIds","sourceType","stateMode","status","syslog"],"type":"object","properties":{"description":{"pattern":"^[^ ]$|^[^ ].{0,510}[^ ]$","type":"string","description":"ACL rule description, description should contain 1 to 512 characters."},"status":{"type":"boolean","description":"Status should be a value as follows: 0: disable; 1: enable"},"policy":{"type":"integer","description":"Policy should be a value as follows: 0: drop; 1: allow;","format":"int32"},"protocols":{"type":"array","description":"For the values of protocols, refer to section 5.5 of the Open API Access Guide.","items":{"type":"integer","description":"For the values of protocols, refer to section 5.5 of the Open API Access Guide.","format":"int32"}},"sourceIds":{"type":"array","description":"Source IDs, which depends on sourceType, for example: if sourceType is network, sourceIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Source IDs, which depends on sourceType, for example: if sourceType is network, sourceIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."}},"destinationIds":{"type":"array","description":"Source IDs, which depends on destinationType, for example: if destinationType is network, destinationIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Source IDs, which depends on destinationType, for example: if destinationType is network, destinationIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."}},"syslog":{"type":"boolean","description":"Enable remote log"},"sourceType":{"type":"integer","description":"SourceType should be a value as follows: 0: network; 1: IP Group; 2: IP-Port Group; 4: SSID; 6: IPv6 Group; 7: IPv6-Port Group; 8: Country; 9: Country Group; 11: !Network; 12: !IP Group; 13: !IP-Port Group; 14: !IPv6 Group; 15: !IPv6-port Group","format":"int32"},"destinationType":{"type":"integer","description":"DestinationType should be a value as follows: 0: network; 1: IP Group; 2: IP-Port Group; 6: IPv6 Group; 7: IPv6-Port Group;10: Domain Group; 11: !Network; 12: !IP Group；13: !IP-Port Group；14: !IPv6 Group；15: !IPv6-port Group","format":"int32"},"direction":{"$ref":"#/components/schemas/Gateway direction entity"},"stateMode":{"type":"integer","description":"StateMode should be a value as follows: 0: auto; 1: manual","format":"int32"},"states":{"$ref":"#/components/schemas/Gateway ACL states entity"},"timeRangeId":{"type":"string","description":"Gateway ACL time range ID."}}},"EapACLConfig":{"required":["description","destinationType","policy","protocols","sourceIds","sourceType","status"],"type":"object","properties":{"description":{"pattern":"^[^ ]$|^[^ ].{0,510}[^ ]$","type":"string","description":"ACL rule description, description should contain 1 to 512 characters."},"status":{"type":"boolean","description":"Status should be a value as follows: 0: disable; 1: enable"},"policy":{"type":"integer","description":"Policy should be a value as follows: 0: drop; 1: allow;","format":"int32"},"protocols":{"type":"array","description":"For the values of protocols, refer to section 5.5 of the Open API Access Guide.","items":{"type":"integer","description":"For the values of protocols, refer to section 5.5 of the Open API Access Guide.","format":"int32"}},"sourceIds":{"type":"array","description":"Source IDs, which depends on sourceType, for example: if sourceType is network, sourceIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Source IDs, which depends on sourceType, for example: if sourceType is network, sourceIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."}},"destinationIds":{"type":"array","description":"Source IDs, which depends on destinationType, for example: if destinationType is network, destinationIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Source IDs, which depends on destinationType, for example: if destinationType is network, destinationIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."}},"sourceType":{"type":"integer","description":"SourceType should be a value as follows: 0: network; 1: IP Group; 2: IP-Port Group; 4: SSID; 6: IPv6 Group; 7: IPv6-Port Group","format":"int32"},"destinationType":{"type":"integer","description":"DestinationType should be a value as follows: 0: network; 1: IP Group; 2: IP-Port Group; 6: IPv6 Group; 7: IPv6-Port Group","format":"int32"}}},"DstTimeOpenApiDTO":{"required":["day","hour","minute","month","serial"],"type":"object","properties":{"month":{"type":"integer","description":"Month of the DST config should be a value as follows: 1: January; 2: February; 3: March; 4: April; 5: May; 6: June; 7: July; 8: August; 9: September; 10: October; 11: November; 12: December.","format":"int32"},"serial":{"type":"integer","description":"Week of the DST config should be a value as follows: 1: 1st; 2: 2nd; 3: 3rd; 4: 4th; 5: Last.","format":"int32"},"day":{"type":"integer","description":"Day of the DST config should be a value as follows: 1: Monday; 2: Tuesday; 3: Wednesday; 4: Thursday; 5: Friday; 6: Saturday; 7: Sunday.","format":"int32"},"hour":{"type":"integer","description":"Hour of the DST config should be within the range of 0–23.","format":"int32"},"minute":{"type":"integer","description":"Minute of the DST config should be within the range of 0–59.","format":"int32"}},"description":"DST end time config"},"ModifyDstDTO":{"type":"object","properties":{"enable":{"type":"boolean","description":"DST config status; If false, other parameters are not required. Deprecated, use mode instead.","deprecated":true},"mode":{"type":"integer","description":"DST config mode; If disable, other parameters are not required. 0: disable, 1: auto, 2: manually","format":"int32"},"start":{"$ref":"#/components/schemas/DstTimeOpenApiDTO"},"end":{"$ref":"#/components/schemas/DstTimeOpenApiDTO"},"offset":{"type":"integer","description":"DST offset config(Unit: ms); It should be a value as follows: [1800000, 3600000, 5400000, 7200000]. When DST mode is 2(manually), offset is required.","format":"int64"}},"description":"Daylight Saving Time config of the site"},"UpdateSiteEntity":{"required":["region","scenario","timeZone"],"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,62}[^ ]$","type":"string","description":"Site name should contain 1 to 64 characters."},"region":{"type":"string","description":"Country/Region of the site; For the values of region, refer to the abbreviation of the ISO country code; For example, you need to input \"United States\" for the United States of America."},"timeZone":{"type":"string","description":"For the values of the timezone of the site, refer to section 5.1 of the Open API Access Guide."},"tagIds":{"uniqueItems":true,"type":"array","description":"Site tag ID, Site tag ID can be created using \"Create new site tag\" interface, and site tag ID can be obtained from \"Get site tag list\" interface","items":{"type":"string","description":"Site tag ID, Site tag ID can be created using \"Create new site tag\" interface, and site tag ID can be obtained from \"Get site tag list\" interface"}},"ntpEnable":{"type":"boolean","description":"NTP server status of the site"},"ntpServers":{"maxItems":5,"minItems":0,"type":"array","description":"NTP server address; Up to 5 entries are allowed for the NTP server address list.","items":{"$ref":"#/components/schemas/ntp server"}},"dst":{"$ref":"#/components/schemas/ModifyDstDTO"},"scenario":{"type":"string","description":"For the values of the scenario of the site, refer to result of the interface for Get scenario list."},"longitude":{"type":"number","description":"Longitude of the site should be within the range of -180 - 180.","format":"double"},"latitude":{"type":"number","description":"Latitude of the site should be within the range of -90 - 90.","format":"double"},"address":{"type":"string","description":"Address of the site"},"supportES":{"type":"boolean","description":"Whether the site supports adopting Agile Series Switches"},"supportL2":{"type":"boolean","description":"Whether the site supports adopting Non-Agile Series Switches"}}},"ntp server":{"type":"object","properties":{"address":{"pattern":"(?=^.{3,64}$)[a-zA-Z0-9][-a-zA-Z0-9]{0,62}(\\.[a-zA-Z0-9][-a-zA-Z0-9]{0,62})+","type":"string","description":"NTP server address."}},"description":"NTP server address; Up to 5 entries are allowed for the NTP server address list."},"WireguardOpenApiVO":{"required":["listenPort","localIp","mtu","name","privateKey","status"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"The name of WireGuard VPN should contain 1 to 64 characters."},"status":{"type":"boolean","description":"The status of WireGuard VPN. Valid value is true or false."},"mtu":{"type":"integer","description":"The MTU of WireGuard VPN should be within the range of 576-1440.","format":"int32"},"listenPort":{"type":"integer","description":"The listening port for WireGuard VPN should be within the range of 1-65535.","format":"int32"},"privateKey":{"pattern":"^[0-9a-zA-Z+/]{43}=$","type":"string","description":"The private key of WireGuard VPN must have 44 character of base64 and end with '='."},"localIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The local IP address of WireGuard VPN."}}},"WireguardPeerOpenApiVO":{"required":["allowAddress","interfaceId","keepAlive","name","publicKey","status"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"The name of WireGuard peer should contain 1 to 64 characters."},"status":{"type":"boolean","description":"The status of WireGuard peer. Valid value is true or false."},"interfaceId":{"type":"string","description":"The ID of WireGuard VPN to which this WireGuard peer binds. The ID can be obtained from 'Get all wireguard's id and name info' interface."},"publicKey":{"pattern":"^[0-9a-zA-Z+/]{43}=$","type":"string","description":"The public key of WireGuard peer must have 44 character of base64 and end with '='."},"endPoint":{"type":"string","description":"The end point IP of WireGuard peer. Get whether supports domain from interface 'Get wireguard peer list'."},"endPointPort":{"type":"integer","description":"The end point port of WireGuard peer should be within the range of 1-65535.","format":"int32"},"allowAddress":{"type":"array","description":"IP/MASK address list of WireGuard peer allowed.","items":{"type":"string","description":"IP/MASK address list of WireGuard peer allowed."}},"presharedKey":{"pattern":"^$|^[0-9a-zA-Z+/]{43}=$","type":"string","description":"The presharedKey of WireGuard peer must have 44 character of base64 and end with '='."},"keepAlive":{"type":"integer","description":"The keepalive second of WireGuard peer should be within the range of 0-65535.","format":"int32"},"comment":{"pattern":"^$|^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"The comment of WireGuard peer should contain 0 to 128 characters."}}},"SslVpnUserModifyOpenApiVO":{"required":["concurrentNumber","password","status","validity"],"type":"object","properties":{"groupId":{"type":"string","description":"Group ID of the SSL VPN user. User group can be created using 'Create SSL VPN user group' interface, and User Group ID can be obtained from 'Get user group list for SSL VPN server' interface."},"status":{"type":"boolean","description":"Status of the SSL VPN user"},"password":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,62}[\\041-\\0176]$","type":"string","description":"Password of the SSL VPN user should contain 1 to 64 characters."},"validity":{"type":"string","description":"Validity of the SSL VPN user. The format is Month/Day/Year, for example 08/20/2022"},"concurrentNumber":{"type":"integer","description":"Concurrent number of the SSL VPN user. It should be within the range of 1–100.","format":"int32"}}},"SslVpnUserGroupModifyOpenApiVO":{"type":"object","properties":{"radiusAttribute":{"type":"string","description":"Attribute value used for radius authentication. It should contain 1 to 20 characters."},"ldapAttribute":{"type":"string","description":"Attribute value used for LDAP authentication. It should contain 1 to 20 characters."},"resourceGroupList":{"type":"array","description":"Resource group ID list of the SSL VPN user group. Resource group can be created using 'Create SSL VPN resource group' interface, and Resource group ID can be obtained from 'Get resource group list for SSL VPN server' interface.","items":{"type":"string","description":"Resource group ID list of the SSL VPN user group. Resource group can be created using 'Create SSL VPN resource group' interface, and Resource group ID can be obtained from 'Get resource group list for SSL VPN server' interface."}}}},"LdapSettingOpenApiVO":{"required":["LDAPProfile","defaultGroup"],"type":"object","properties":{"LDAPProfile":{"type":"string","description":"LDAP profile ID. LDAP profile can be created using 'Create a new LDAP profile' interface, and LDAP profile ID can be obtained from 'Get LDAP profile list' interface."},"defaultGroup":{"type":"string","description":"Default user group ID for the user on the LDAP server. User group can be created using 'Create SSL VPN user group' interface, and user group ID can be obtained from 'Get user group list for SSL VPN server' interface."}},"description":"It is required when parameter [authType] is 2."},"LockSettingOpenApiVO":{"required":["status"],"type":"object","properties":{"status":{"type":"boolean","description":"Status of the SSL VPN server name lock or IP lock."},"times":{"type":"integer","description":"The number of login failures that trigger the lock. It is required when parameter [status] is true, and it should be within the range of 1–10","format":"int32"},"duration":{"type":"integer","description":"Lock duration should be within the range of 1–1080(min).","format":"int32"}},"description":"IP lock config. It is required when parameter [status] is true."},"RadiusSettingOpenApiVO":{"required":["authType","defaultGroup","overTime","radiusProfile","repeatTime"],"type":"object","properties":{"radiusProfile":{"type":"string","description":"Radius profile ID. RADIUS profile can be created using 'Create a new RADIUS profile' interface, and RADIUS profile ID can be obtained from 'Get RADIUS profile list' interface."},"defaultGroup":{"type":"string","description":"Default user group ID for the user on the radius server. User group can be created using 'Create SSL VPN user group' interface, and user group ID can be obtained from 'Get user group list for SSL VPN server' interface."},"authType":{"type":"integer","description":"Authtype should be a value as follows: 0：PAP; 1:CHAP","format":"int32"},"repeatTime":{"type":"integer","description":"Repeat time should be within the range of 1–10","format":"int32"},"overTime":{"type":"integer","description":"Request Timeout, 1~60(s).","format":"int32"},"nasIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"NAS IP"}},"description":"It is required when parameter [authType] is 1."},"SslVpnServerConfigOpenApiVO":{"required":["status"],"type":"object","properties":{"status":{"type":"boolean","description":"Status of the SSL VPN server."},"wanPort":{"type":"string","description":"WAN port ID of the SSL VPN server. It is required when parameter [status] is true. WAN port ID can be obtained from 'Get internet basic info' interface"},"ipPoolStart":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The start IP of the IP pool. It is required when parameter [status] is true."},"ipPoolEnd":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The end IP of the IP pool. It is required when parameter [status] is true."},"primaryDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Primary DNS Server of the SSL VPN server. It is required when parameter [status] is true."},"secondaryDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Secondary DNS Server of the SSL VPN server."},"servicePort":{"type":"integer","description":"Service port of the SSL VPN server. Default value is 1194. It is required when parameter [status] is true, and it should be within the range of 1–65535","format":"int32"},"authType":{"type":"integer","description":"Authentication type of the SSL VPN server should be a value as follows: 0: local; 1: radius; 2: LDAP. It is required when parameter [status] is true.","format":"int32"},"radiusSetting":{"$ref":"#/components/schemas/RadiusSettingOpenApiVO"},"LDAPSetting":{"$ref":"#/components/schemas/LdapSettingOpenApiVO"},"nameLockSetting":{"$ref":"#/components/schemas/LockSettingOpenApiVO"},"ipLockSetting":{"$ref":"#/components/schemas/LockSettingOpenApiVO"},"exitAtIdle":{"type":"boolean","description":"Whether to exit when idle.  It is required when parameter [status] is true."},"exitTime":{"type":"integer","description":"Exit time should be within the range of 5–3600(s). It is required when parameter [exitAtIdle] is true.","format":"int32"},"totalTraffic":{"type":"boolean","description":"Whether to proxy all traffic. It is required when parameter [status] is true."}}},"SslVpnResourceModifyOpenApiVO":{"required":["type"],"type":"object","properties":{"type":{"type":"integer","description":"Type of the SSL VPN resource should be a value as follows: 0: IP; 1: domain, and it can not be modified.","format":"int32"},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP of the SSL VPN resource, exists when type is 0."},"mask":{"type":"string","description":"Mask of the SSL VPN resource, exists when type is 0."},"domain":{"type":"string","description":"Domain of the SSL VPN resource, exists when type is 1."},"protocol":{"type":"integer","description":"Protocol of the SSL VPN resource should be a value as follows: 0:All; 1:TCP; 2:UDP; 3:TCP/UDP; 4:ICMP; 5:Other","format":"int32"},"srcPortStart":{"type":"integer","description":"Start source port of the SSL VPN resource, exists when protocol is TCP or UDP. It should be within the range of 0–65535","format":"int32"},"srcPortEnd":{"type":"integer","description":"End source port of the SSL VPN resource, exists when protocol is TCP or UDP. It should be within the range of 0–65535","format":"int32"},"dstPortStart":{"type":"integer","description":"Start destination port of the SSL VPN resource, exists when protocol is TCP or UDP. It should be within the range of 0–65535","format":"int32"},"dstPortEnd":{"type":"integer","description":"End destination port of the SSL VPN resource, exists when protocol is TCP or UDP. It should be within the range of 0–65535","format":"int32"},"icmpType":{"type":"integer","description":"ICMP type of the SSL VPN resource, exists when protocol is ICMP. It should be within the range of 0–255","format":"int32"},"icmpCode":{"type":"integer","description":"ICMP code of the SSL VPN resource, exists when protocol is ICMP. It should be within the range of 0–255","format":"int32"},"otherProtocol":{"type":"integer","description":"Other protocol of the SSL VPN resource. It should be within the range of 1–255","format":"int32"}}},"SslVpnResourceGroupModifyOpenApiVO":{"type":"object","properties":{"resourcesList":{"type":"array","description":"Resources ID list of the SSL VPN resource group. Resource can be created using 'Create SSL VPN resource' interface, and resource ID can be obtained from 'Get resource list for SSL VPN server' interface.","items":{"type":"string","description":"Resources ID list of the SSL VPN resource group. Resource can be created using 'Create SSL VPN resource' interface, and resource ID can be obtained from 'Get resource list for SSL VPN server' interface."}}}},"SslVpnLockModifyOpenApiVO":{"required":["totalLockTime","type"],"type":"object","properties":{"type":{"type":"integer","description":"Type of the SSL VPN lock should be a value as follows: 0:username, 1:IP. It can not be modified.","format":"int32"},"username":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,18}[\\041-\\0176]$","type":"string","description":"Username of the SSL VPN lock. It is required when parameter [type] is 0."},"ip":{"type":"string","description":"IP of the SSL VPN lock. It is required when parameter [type] is 1."},"totalLockTime":{"type":"integer","description":"Total lock time of the SSL VPN lock should be within the range of 1–1080(min).","format":"int32"}}},"SslVpnLockCreateAndModifyOpenApiVO":{"required":["totalLockTime","type"],"type":"object","properties":{"type":{"type":"integer","description":"Type of the SSL VPN lock should be a value as follows: 0:username; 1:IP","format":"int32"},"username":{"pattern":"^[a-zA-Z0-9_]{1,20}$","type":"string","description":"Username of the SSL VPN lock. It is required when parameter [type] is 0."},"ip":{"pattern":"^((25[0-5]|2[0-4]\\d|[01]?\\d\\d?)\\.){3}(25[0-5]|2[0-4]\\d|[01]?\\d\\d?)$","type":"string","description":"IP of the SSL VPN lock. It is required when parameter [type] is 1."},"totalLockTime":{"type":"integer","description":"Total lock time of the SSL VPN lock should be within the range of 1–1080(min).","format":"int32"}}},"UpdateEoGreTunnelSettingOpenApiVO":{"required":["greEnable","tunnelMtu"],"type":"object","properties":{"greEnable":{"type":"boolean","description":"EoGRE Tunnel global config status; True: enable, false: disable."},"tunnelMtu":{"type":"integer","description":"Maximum Transmission Unit. The value of parameter [tunnelMtu] should be between [850, 1500].","format":"int32"},"interval":{"type":"integer","description":"EoGRE Tunnel keep interval config(Unit: Seconds); It should be within the range of 10–600.","format":"int32"},"maxCount":{"type":"integer","description":"EoGRE Tunnel max keepalive skip count config; It should be within the range of 3–10.","format":"int32"},"primaryAddress":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"EoGRE Tunnel primary gateway IP address config"},"secondaryAddress":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"EoGRE Tunnel secondary gateway IP address config"}}},"BaseScheduleTimeOpenApiVO":{"required":["hour","minute","timingType"],"type":"object","properties":{"timingType":{"type":"integer","description":"Time type should be a value as follows: 1:Daily; 2:Weekly; 3:Monthly","format":"int32"},"dayOfWeek":{"type":"integer","description":"It should be within the range of 0(Sunday)~6(Saturday). Required when parameter [timingType] is 2.","format":"int32"},"dayOfMonth":{"type":"integer","description":"It should be within the range of 1~31. Required when parameter [timingType] is 3.","format":"int32"},"monthOfYear":{"type":"integer","description":"It should be within the range of 1~12. Required when parameter [timingType] is 4.","format":"int32"},"hour":{"type":"integer","description":"It should be within the range of 0~23","format":"int32"},"minute":{"type":"integer","description":"It should be within the range of 0~59","format":"int32"}},"description":"Execution occurrence setting. Required when type is 1."},"UpgradeScheduleOpenApiVO":{"required":["deviceMacs","name","status","type"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Upgrade schedule name should contain 1 to 128 characters."},"status":{"type":"boolean","description":"Upgrade schedule status."},"type":{"type":"integer","description":"Type should be a value as follows: 0: execute only once; 1: repeat","format":"int32"},"nextExecuteTime":{"type":"integer","description":"Execution timeStamp(ms). Required when type is 0.","format":"int64"},"occurrenceTime":{"$ref":"#/components/schemas/BaseScheduleTimeOpenApiVO"},"deviceMacs":{"type":"array","description":"MAC address of the selected devices. E.g. AA-BB-CC-DD-11-22","items":{"type":"string","description":"MAC address of the selected devices. E.g. AA-BB-CC-DD-11-22"}}}},"OswStaticRoutingConfigOpenApiVO":{"required":["destinations","distance","ipVersion","nextHopIp","status"],"type":"object","properties":{"ipVersion":{"type":"integer","description":"The IP Version of class rule should be a value as follows: 0: IPv4; 1: IPv6.","format":"int32"},"status":{"type":"boolean","description":"StaticRouting status"},"destinations":{"type":"array","description":"IP address/SubNet, up to 16 entries are allowed for the destinations list.","items":{"type":"string","description":"IP address/SubNet, up to 16 entries are allowed for the destinations list."}},"nextHopIp":{"type":"string","description":"NextHopIp"},"distance":{"type":"integer","description":"Distance should be within the range of 1–255.","format":"int32"},"description":{"pattern":"^[0-9a-zA-Z\\-_@:/.+# ]{0,128}$","type":"string","description":"The description of static routing. It may contain 0 to 128 characters, including digits (0–9), uppercase and lowercase letters (A–Z, a–z), spaces, and -_@:/.+# ."},"vrfId":{"type":"string","description":"VrfId"},"nextHopVrfId":{"type":"string","description":"NextHopVrfId"}}},"OswLoopbackInterfaceVO":{"required":["ip","loopbackId","name","status"],"type":"object","properties":{"status":{"type":"integer","description":"Interface status.0: disable, 1: enable.","format":"int32"},"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"Loopback Interface name."},"vrfId":{"type":"string","description":"VRF ID. This field is non-empty when the device supports VRF."},"loopbackId":{"type":"integer","description":"Loopback ID.","format":"int32"},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP address."}}},"OswStpInstanceConfigOpenApiVO":{"required":["id","priority","vlan"],"type":"object","properties":{"id":{"type":"integer","description":"ID","format":"int32"},"priority":{"type":"integer","description":"Priority","format":"int32"},"vlan":{"type":"string","description":"Parameter [vlan] should be between 1 and 4094."}},"description":"Instances"},"OswStpMstpConfigOpenApiVO":{"required":["instances","region"],"type":"object","properties":{"region":{"$ref":"#/components/schemas/OswStpRegionConfigOpenApiVO"},"instances":{"type":"array","description":"Instances","items":{"$ref":"#/components/schemas/OswStpInstanceConfigOpenApiVO"}}},"description":"STP MSTP Config, must not be null when stp is 3."},"OswStpRegionConfigOpenApiVO":{"required":["revision"],"type":"object","properties":{"name":{"type":"string","description":"Name"},"revision":{"type":"integer","description":"Revision","format":"int32"}},"description":"Region"},"OswStpRpvstInstanceVO":{"type":"object","properties":{"priority":{"type":"integer","description":"Priority","format":"int32"},"vlan":{"type":"string","description":"Vlan"},"enable":{"type":"integer","description":"Enable","format":"int32"}},"description":"Instances"},"OswStpRpvstVO":{"type":"object","properties":{"instances":{"type":"array","description":"Instances","items":{"$ref":"#/components/schemas/OswStpRpvstInstanceVO"}}},"description":"STP RPVST Config, must not be null when stp is 4."},"SwitchLoopbackControl":{"type":"object","properties":{"loopbackDetectEnable":{"type":"boolean","description":"LoopbackDetectEnable"},"stp":{"type":"integer","description":"STP should be a value as follows: 0: OFF 1: STP 2: RSTP 3: MSTP 4: RPVST ","format":"int32"},"priority":{"type":"integer","description":"Parameter [priority] should be an integer from 0 to 61440 and divisible by 4096.","format":"int32"},"helloTime":{"type":"integer","description":"helloTime should be between 1 and 10.","format":"int32"},"maxAge":{"type":"integer","description":"maxAge should be between 6 and 40.","format":"int32"},"forwardDelay":{"type":"integer","description":"forwardDelay should be between 4 and 30.","format":"int32"},"txHoldCount":{"type":"integer","description":"txHoldCount should be between 1 and 20.","format":"int32"},"maxHops":{"type":"integer","description":"maxHops should be between 1 and 40. maxHops is only allowed when the STP type is MSTP.","format":"int32"},"mstp":{"$ref":"#/components/schemas/OswStpMstpConfigOpenApiVO"},"rpvst":{"$ref":"#/components/schemas/OswStpRpvstVO"}}},"EasyManagedSwitchLoopbackControl":{"type":"object","properties":{"loopbackDetectEnable":{"type":"boolean","description":"LoopbackDetectEnable"},"stp":{"type":"integer","description":"STP should be a value as follows: 0: OFF 1: STP 2: RSTP","format":"int32"},"priority":{"type":"integer","description":"priority","format":"int32"},"maxAge":{"type":"integer","description":"maxAge should be between 6 and 40.","format":"int32"},"forwardDelay":{"type":"integer","description":"forwardDelay should be between 4 and 30.","format":"int32"},"txHoldCount":{"type":"integer","description":"txHoldCount should be between 1 and 10.","format":"int32"}}},"LanNetworkEntryVO":{"type":"object","properties":{"networkId":{"type":"string","description":"The LAN Network ID"},"vlanId":{"type":"integer","description":"The VLAN ID","format":"int32"}},"description":"It can be issued when the type is either \"Network\" or \"Custom\". For the \"Network\" type, multiple options are available; for the \"Custom\" type, a single option is required."},"OswQosRuleDeviceVO":{"type":"object","properties":{"mac":{"type":"string","description":"The device mac."},"stackDevice":{"type":"boolean","description":"Stack device identifier, true: stack device, false: normal device."},"portList":{"type":"array","description":"The selected standard port ID(unit/slot/port) list.","items":{"type":"string","description":"The selected standard port ID(unit/slot/port) list."}},"lagList":{"type":"array","description":"The selected lag ID list.","items":{"type":"integer","description":"The selected lag ID list.","format":"int32"}}},"description":"List of switch devices to which QoS rule are bound, only for bindType 1"},"OswQosRuleVO":{"required":["ipVersion","name","queue","status","type"],"type":"object","properties":{"id":{"type":"string","description":"The Qos rule id. This parameter is not required when creating or modifying Qos rule."},"index":{"type":"integer","description":"The index of Qos rule. This parameter is not required when creating or modifying Qos rule.","format":"int32"},"name":{"pattern":"^\\S(?:.{0,126}\\S)?$","type":"string","description":"The name of Qos rule."},"status":{"type":"boolean","description":"The status of Qos rule, true: enable, false:disable"},"type":{"type":"integer","description":"The type of Qos rule, 0:Network, 1:Port, 2:Custom","format":"int32"},"ipVersion":{"type":"array","description":"The selected ipVersion list of Qos rule, IPv4:[0], IPv6:[1], IPv4&IPv6:[0,1]","items":{"type":"integer","description":"The selected ipVersion list of Qos rule, IPv4:[0], IPv6:[1], IPv4&IPv6:[0,1]","format":"int32"}},"lanNetworkEntries":{"type":"array","description":"It can be issued when the type is either \"Network\" or \"Custom\". For the \"Network\" type, multiple options are available; for the \"Custom\" type, a single option is required.","items":{"$ref":"#/components/schemas/LanNetworkEntryVO"}},"protocol":{"type":"integer","description":"Network Protocol(Reference to chapter 5.5.1 ACL Protocol Template at Home page). When the type is \"Custom\", it can be issued.","format":"int32"},"dscp":{"type":"integer","description":"The dscp value(0-63). When the type is \"Custom\", it can be issued.","format":"int32"},"queue":{"type":"integer","description":"The queue of Qos rule(0-7).","format":"int32"},"dscpReEnable":{"type":"boolean","description":"Whether to enable DSCP remark"},"dscpRe":{"type":"integer","description":"The remarked dscp value(0-63). If it is set to \"Auto\", the actual issued value is 64.","format":"int32"},"bindType":{"type":"integer","description":"Switch port bind type(0: all switch port, 1: custom switch port).","format":"int32"},"deviceList":{"type":"array","description":"List of switch devices to which QoS rule are bound, only for bindType 1","items":{"$ref":"#/components/schemas/OswQosRuleDeviceVO"}},"sPort":{"type":"integer","description":"The source port(0-65535). When the type is \"Custom\" and the protocol is TCP or UDP, it can be issued.","format":"int32"},"dPort":{"type":"integer","description":"The destination port(0-65535). When the type is \"Custom\" and the protocol is TCP or UDP, it can be issued.","format":"int32"}}},"OperationResponseOswQosRuleResultVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswQosRuleResultVO"}}},"OswQosRuleResultVO":{"type":"object","properties":{"failDevices":{"type":"array","description":"List of device information for which QoS rules failed to be issued.","items":{"$ref":"#/components/schemas/QosRuleDeviceInfo"}},"successDevices":{"type":"array","description":"List of device information for which QoS rules have been successfully issued.","items":{"$ref":"#/components/schemas/QosRuleDeviceInfo"}}}},"QosRuleDeviceInfo":{"type":"object","properties":{"mac":{"type":"string","description":"The device mac."},"name":{"type":"string","description":"The device name."},"statusCategory":{"type":"integer","description":"Device status should be a value as follows: 0: Disconnected; 1: Connected; 2: Pending; 3: Heartbeat Missed; 4: Isolated","format":"int32"},"model":{"type":"string","description":"The device model."},"modelVersion":{"type":"string","description":"The model version of device, for example:3.0"},"showModel":{"type":"string","description":"The device showModel(model + modelVersion)."},"stackDevice":{"type":"boolean","description":"Stack device identifier, true: stack device, false: normal device."},"errCode":{"type":"integer","description":"The code of the device's response after the QoS rules are issued.","format":"int32"}},"description":"List of device information for which QoS rules have been successfully issued."},"OswQosRuleStatusVO":{"required":["status"],"type":"object","properties":{"status":{"type":"boolean"}}},"QueueScheduleConfigVO":{"required":["queue","type"],"type":"object","properties":{"queue":{"type":"integer","format":"int32"},"type":{"type":"integer","format":"int32"},"weight":{"type":"integer","format":"int32"}}},"QueueSchedulerMappingVO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"types":{"type":"integer","format":"int32"},"mapping":{"type":"array","items":{"$ref":"#/components/schemas/QueueScheduleConfigVO"}},"buildIn":{"type":"boolean"}}},"DscpMappingVO":{"required":["mapping"],"type":"object","properties":{"mapping":{"type":"object","additionalProperties":{"type":"array","description":"The Queue-DSCP mapping map. The key corresponds to the queue and the value corresponds to the DSCP value list","items":{"maximum":8,"minimum":8,"type":"integer","description":"The Queue-DSCP mapping map. The key corresponds to the queue and the value corresponds to the DSCP value list","format":"int32"}},"description":"The Queue-DSCP mapping map. The key corresponds to the queue and the value corresponds to the DSCP value list"}}},"OswQosModeVO":{"type":"object","properties":{"qosMode":{"type":"integer","description":"Switch QoS Mode, 0:old mode(Based on Qos Profile implementation), 1:new mode(Based on QoS rules implementation.)","format":"int32"},"completed":{"type":"integer","description":"Indicates whether the new mode switch has been completed. 0: Not completed, 1: Completed. If it is in the preview state, qosMode is 1 and completed is 0.","format":"int32"}}},"DragSortIndexVO":{"required":["indexes"],"type":"object","properties":{"type":{"type":"string"},"omadacId":{"type":"string"},"siteId":{"type":"string"},"indexes":{"type":"object","additionalProperties":{"type":"integer","description":"DragSort indexes. The key corresponds to the rule id and the value corresponds to the new index value.","format":"int32"},"description":"DragSort indexes. The key corresponds to the rule id and the value corresponds to the new index value."}}},"DeviceOuiModeOpenApiVO":{"required":["deviceMac"],"type":"object","properties":{"deviceMac":{"type":"string","description":"Device MAC. E.g. AA-BB-CC-DD-11-22 . When \"oldFirmwareDevice\" is true, deivce should configure in only one OUI Based VLAN rule."},"stackId":{"type":"string","description":"The stack id of the stack device."},"stackPortList":{"type":"array","description":"The stack port list.","items":{"type":"string","description":"The stack port list."}},"portList":{"type":"array","description":"Device port list.","items":{"type":"integer","description":"Device port list.","format":"int32"}},"lagList":{"type":"array","description":"Device lag list.","items":{"type":"integer","description":"Device lag list.","format":"int32"}}},"description":"When mode is 1, should configure device info."},"OuiBasedVlanSwitchOpenApiVO":{"required":["enable","mode","name","ruleCombine"],"type":"object","properties":{"enable":{"type":"boolean","description":"Switch Rule state."},"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Switch Rule name should contain 1 to 128 characters."},"mode":{"type":"integer","description":"Switch Rule type. 0:\"All device port\", 1:\"Custom device port\"","format":"int32"},"deviceList":{"type":"array","description":"When mode is 1, should configure device info.","items":{"$ref":"#/components/schemas/DeviceOuiModeOpenApiVO"}},"ruleCombine":{"type":"array","description":"Basic vlan-oui-priority configuration of oui based rule. Cannot be empty.","items":{"$ref":"#/components/schemas/VlanOuiModeOpenApiVO"}}}},"InstancesVO":{"type":"object","properties":{"stp":{"type":"integer","description":"stp, 0: MSTP / 1: RPVST","format":"int32"},"id":{"type":"integer","description":"mstp instanceId","format":"int32"},"vlan":{"type":"string","description":"rpvst vlanId"},"priority":{"type":"integer","description":"priority","format":"int32"},"costMode":{"type":"integer","description":"costMode, 0: auto / 1: custom","format":"int32"},"cost":{"type":"integer","description":"cost","format":"int32"}},"description":"Instances"},"MirroredLag":{"type":"object","properties":{"lagId":{"type":"integer","description":"Lag ID","format":"int32"},"lagName":{"type":"string","description":"Lag Name"}},"description":"Monitored LAG"},"MirroredPort":{"type":"object","properties":{"port":{"type":"integer","description":"Port","format":"int32"},"standardPort":{"type":"string","description":"Standard Port"},"portName":{"type":"string","description":"Port Name"}},"description":"Monitored Port"},"OswBandCtrlLimitRangeVO":{"type":"object","properties":{"unit":{"type":"integer","description":"unit: 1: kbps, 2: mbps","format":"int32"},"minIngressRate":{"type":"integer","description":"min ingress rate","format":"int32"},"maxIngressRate":{"type":"integer","description":"max ingress rate","format":"int32"},"minEgressRate":{"type":"integer","description":"min egress rate","format":"int32"},"maxEgressRate":{"type":"integer","description":"max egress rate","format":"int32"}},"description":"The limit range of the bandwidth control"},"OswBandCtrlVO":{"required":["egressEnable","ingressEnable"],"type":"object","properties":{"egressEnable":{"type":"boolean","description":"Indicates whether egress is enabled"},"egressLimit":{"type":"integer","description":"Egress Limit, when the user-configured value is much larger than the actual maximum value, the device will process it at the maximum value","format":"int32"},"egressUnit":{"type":"integer","description":"Egress Unit should be a value as follows: 1: Kbps; 2: Mbps","format":"int32"},"ingressEnable":{"type":"boolean","description":"Indicates whether egress is enabled"},"ingressLimit":{"type":"integer","description":"Ingress Limit, when the user-configured value is much larger than the actual maximum value, the device will process it at the maximum value","format":"int32"},"ingressUnit":{"type":"integer","description":"Ingress Unit should be a value as follows: 1: Kbps; 2: Mbps","format":"int32"},"limitRange":{"type":"array","description":"The limit range of the bandwidth control","items":{"$ref":"#/components/schemas/OswBandCtrlLimitRangeVO"}},"unitSupport":{"type":"array","description":"The supported units of the bandwidth control, 1: Kbps; 2: Mbps","items":{"type":"integer","description":"The supported units of the bandwidth control, 1: Kbps; 2: Mbps","format":"int32"}}},"description":"Speed Limit"},"OswDownlinkVO":{"type":"object","properties":{"port":{"type":"integer","description":"Port","format":"int32"},"stPort":{"type":"string","description":"Standard Port, unit/slot/port"},"lagId":{"type":"integer","description":"LagId. If it is not null, it indicates that the port is a LAG port","format":"int32"},"model":{"type":"string","description":"The model of uplink device"},"hwVersion":{"type":"string","description":"HwVersion"},"modelVersion":{"type":"string","description":"Model Version"},"mac":{"type":"string","description":"The mac of downlink device"},"stackId":{"type":"string","description":"The ID of uplink stack device"},"stackName":{"type":"string","description":"The name of uplink stack device"},"name":{"type":"string","description":"The name of downlink device"},"linkSpeed":{"type":"integer","description":"Link Speed","format":"int32"},"duplex":{"type":"integer","description":"Duplex","format":"int32"},"rx":{"type":"integer","description":"Port total rx bytes","format":"int64"},"rx Rate":{"type":"integer","description":"Port rx Rate","format":"int64"},"tx":{"type":"integer","description":"Port total tx bytes","format":"int64"},"tx Rate":{"type":"integer","description":"Port tx Rate","format":"int64"},"stpDiscarding":{"type":"boolean","description":"STP Discarding"},"blockedVlans":{"type":"string","description":"Blocked Vlans"},"blockedType":{"type":"integer","description":"Blocked Type","format":"int32"},"type":{"type":"string","description":"The type of downlink device, it should be a value as follows: ap, gateway, switch(stack)"},"linkPeerPortInfo":{"$ref":"#/components/schemas/OswPeerPortVO"},"ip":{"type":"string"}},"description":"Downlink Omada device list"},"OswFecCapVO":{"type":"object","properties":{"linkSpeed":{"type":"integer","description":"speed of the link","format":"int32"},"fecMode":{"type":"integer","description":"FEC mode, 0 - reserved, 1 - FEC-OFF, 2 - FEC-RS528, 3 - FEC-RS544, 4 - FEC-AUTO, 5 - FEC-BASER","format":"int32"}},"description":"All LinkSpeed&FECMode combinations supported by the port"},"OswLagStatusVO":{"type":"object","properties":{"name":{"type":"string","description":"Lag name"},"lagId":{"type":"integer","description":"Lag ID","format":"int32"},"linkStatus":{"type":"integer","description":"Link Status should be a value as follows: 1: link up; 0: link down","format":"int32"},"linkSpeed":{"type":"integer","description":"Link Speed should be a value as follows: 0: auto; 1: 10M; 2: 100M; 3: 1000M; 4: 2.5G; 5: 10G","format":"int32"},"duplex":{"type":"integer","description":"Duplex should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"},"tx":{"type":"integer","description":"Tx","format":"int64"},"rx":{"type":"integer","description":"Rx","format":"int64"},"txRate":{"type":"integer","description":"Tx Rate","format":"int64"},"rxRate":{"type":"integer","description":"Rx Rate","format":"int64"},"lagType":{"type":"integer","description":"LagType should be a value as follows: 1: static; 2: LACP","format":"int32"},"ports":{"uniqueItems":true,"type":"array","description":"Ports member","items":{"type":"integer","description":"Ports member","format":"int32"}},"standardPorts":{"uniqueItems":true,"type":"array","description":"Standard Ports","items":{"$ref":"#/components/schemas/OswStandPortVO"}},"stpDiscarding":{"type":"boolean","description":"STP Discarding"},"blockedVlans":{"type":"string","description":"Blocked Vlans"},"blockedType":{"type":"integer","description":"Blocked Type","format":"int32"},"trunkState":{"type":"integer","description":"LACP state","format":"int32"}},"description":"Lag Status"},"OswLagVO":{"type":"object","properties":{"id":{"type":"string","description":"ID"},"switchId":{"type":"string","description":"Switch ID"},"switchMac":{"type":"string","description":"Switch MAC Address"},"site":{"type":"string","description":"Site"},"lagId":{"type":"integer","description":"Lag ID","format":"int32"},"name":{"pattern":"^[^ ?\"]$|^[^ ?\"][^?\"]{0,126}[^ ?\"]$","type":"string","description":"Lag Name"},"tagIds":{"type":"array","description":"Lag label ID List","items":{"type":"string","description":"Lag label ID List"}},"tagName":{"type":"string","description":"Lag label Name"},"networkMode":{"type":"integer","description":"Network Mode should be a value as follows: 0: Trunk, 1: Access","format":"int32"},"nativeNetworkId":{"type":"string","description":"Native Network ID, Native Network cannot be selected from Tagged Networks or Untagged Networks."},"nativeBridgeVlan":{"type":"integer","description":"Native Network Bridge Vlan.","format":"int32"},"networkTagsSetting":{"type":"integer","description":"Network Tags Setting should be a value as follows: 0: Allow All; 1: Block All; 2: Custom","format":"int32"},"tagNetworkIds":{"type":"array","description":"Tag Network IDs","items":{"type":"string","description":"Tag Network IDs"}},"tagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Tag Network Bridge Vlan Map","items":{"type":"integer","description":"Tag Network Bridge Vlan Map","format":"int32"}},"description":"Tag Network Bridge Vlan Map"},"untagNetworkIds":{"type":"array","description":"Untag Network IDs","items":{"type":"string","description":"Untag Network IDs"}},"untagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Untag Network Bridge Vlan Map","items":{"type":"integer","description":"Untag Network Bridge Vlan Map","format":"int32"}},"description":"Untag Network Bridge Vlan Map"},"voiceNetworkEnable":{"type":"boolean","description":"Voice network enable status"},"voiceNetworkId":{"type":"string","description":"Voice Network ID"},"voiceBridgeVlan":{"type":"integer","description":"Voice Network Bridge Vlan","format":"int32"},"voiceDscpEnable":{"type":"boolean","description":"Voice DSCP enable status"},"voiceDscp":{"type":"integer","description":"Voice DSCP","format":"int32"},"portAlertEnable":{"type":"boolean","description":"Indicates whether port alert is enabled"},"ports":{"type":"array","description":"Lag Ports","items":{"type":"integer","description":"Lag Ports","format":"int32"}},"stPorts":{"type":"array","description":"Lag StPorts","items":{"type":"string","description":"Lag StPorts"}},"allAggregatingPorts":{"uniqueItems":true,"type":"array","description":"All aggregating ports of the current Switch","items":{"type":"integer","description":"All aggregating ports of the current Switch","format":"int32"}},"allMirroringPorts":{"uniqueItems":true,"type":"array","description":"All mirroring ports of the current Switch","items":{"type":"integer","description":"All mirroring ports of the current Switch","format":"int32"}},"allMirroredPorts":{"uniqueItems":true,"type":"array","description":"All mirrored ports on the Switch","items":{"type":"integer","description":"All mirrored ports on the Switch","format":"int32"}},"allMlagPeerLinkPorts":{"uniqueItems":true,"type":"array","description":"All ports configured with M-LAG PeerLink on the current Switch","items":{"type":"integer","description":"All ports configured with M-LAG PeerLink on the current Switch","format":"int32"}},"allMlagDadPorts":{"uniqueItems":true,"type":"array","description":"All ports configured with M-LAG DAD on the current Switch","items":{"type":"integer","description":"All ports configured with M-LAG DAD on the current Switch","format":"int32"}},"lagType":{"type":"integer","description":"Lag Type should be a value as follows: 1: STATIC; 2: LACP; 3: LACP ACTIVE; 4: LACP PASSIVE","format":"int32"},"mlagName":{"type":"string","description":"M-LAG Name"},"mlagEnable":{"type":"boolean","description":"Indicates whether M-LAG is enabled"},"mlagPeerSetting":{"$ref":"#/components/schemas/OswMlagPeerSettingVO"},"lagStatus":{"$ref":"#/components/schemas/OswLagStatusVO"},"disable":{"type":"boolean","description":"Indicates whether to disable"},"profileId":{"type":"string","description":"Profile ID"},"profileName":{"type":"string","description":"Lan Profile Name"},"profileOverrideEnable":{"type":"boolean","description":"Indicates whether to enable Profile Override before v6.2.10; Indicates the fill mode of port configuration after v6.2.10: true: custom; false: follow profile"},"profileVlanOverrideEnable":{"type":"boolean","description":"Indicates the fill mode of vlan configuration: true: custom; false: follow profile"},"linkSpeed":{"type":"integer","description":"Link Speed should be a value as follows: 0: auto; 1: 10M; 2: 100M; 3: 1000M; 4: 2.5G; 5: 10G","format":"int32"},"duplex":{"type":"integer","description":"Duplex should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"},"igmpSnoopingEnable":{"type":"boolean","description":"Indicates whether IGMP Snooping is enabled"},"bandCtrl":{"$ref":"#/components/schemas/OswBandCtrlVO"},"stormCtrl":{"$ref":"#/components/schemas/OswStormCtrlVO"},"bandWidthCtrlType":{"type":"integer","description":"BandWidthCtrlType should be a value as follows: 0: Off; 1: Rate Limit; 2: Storming Control","format":"int32"},"spanningTreeEnable":{"type":"boolean","description":"Indicates whether SpanningTree is enabled"},"spanningTreeSetting":{"$ref":"#/components/schemas/SpanningTreeSettingVO"},"loopbackDetectEnable":{"type":"boolean","description":"Indicates whether loopbackDetect port based is enabled"},"loopbackDetectVlanBasedEnable":{"type":"boolean","description":"Indicates whether loopbackDetect vlan based is enabled"},"igmpFastLeaveEnable":{"type":"boolean","description":"Indicates whether igmp fast leave is enabled"},"mldFastLeaveEnable":{"type":"boolean","description":"Indicates whether mld fast leave is enabled"},"portIsolationEnable":{"type":"boolean","description":"Indicates whether port isolation is enabled"},"eeeEnable":{"type":"boolean","description":"Indicates whether EEE is enabled"},"flowControlEnable":{"type":"boolean","description":"Indicates whether flow control is enabled"},"fastLeaveEnable":{"type":"boolean","description":"Indicates whether igmpSnooping fastLeave is enabled"},"dhcpL2RelaySettings":{"$ref":"#/components/schemas/OswPortDhcpL2RelayVO"},"dot1pPriority":{"type":"integer","description":"Dot1p Priority","format":"int32"},"trustMode":{"type":"integer","description":"TrustMode should be a value as follows: 0: Untrusted; 1: Trust 802.1p; 2: Trust DSCP","format":"int32"},"qosSupport":{"type":"boolean","description":"Indicates whether qos support is enabled"},"esQosSupport":{"type":"boolean","description":"Indicates whether the ES device port supports modification of QoS configuration"},"qosQueueEnable":{"type":"boolean","description":"Indicates whether the ES device port has enabled the Qos scheduling queue configuration"},"queueId":{"type":"integer","description":"ES Qos scheduling queue ID","format":"int32"},"esEnableAllProfileCanAdd":{"type":"boolean","description":"Indicates whether es enable of all profile can continue to add VLANs"},"networkConflict":{"type":"boolean","description":"Indicates whether the VLAN configuration activated on the port is inconsistent with the VLAN configuration in the Profile."},"resource":{"type":"integer","description":"Data Source. Resource should be a value as follows: 0: new created; 1: from template; 2: override","format":"int32"},"mlagPeerAllPortsConfigInfo":{"$ref":"#/components/schemas/OswMlagPeerAllPortsConfigInfoVO"},"locateEnable":{"type":"boolean","description":"Whether locate function is enabled"},"ouiBasedVlanNetworks":{"$ref":"#/components/schemas/OswPortOuiBasedVlanVO"}},"description":"Including some port configuration information and port real-time status"},"OswLinkCapVO":{"type":"object","properties":{"linkSpeed":{"type":"integer","description":"Link Speed","format":"int32"},"duplex":{"type":"integer","description":"Duplex should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"}},"description":"Port Capability"},"OswMlagPeerAllPortsConfigInfoVO":{"type":"object","properties":{"allAggregatingPorts":{"uniqueItems":true,"type":"array","description":"all aggregating ports of M-LAG Peer Switch","items":{"type":"integer","description":"all aggregating ports of M-LAG Peer Switch","format":"int32"}},"allMirroringPorts":{"uniqueItems":true,"type":"array","description":"all mirroring ports of M-LAG Peer Switch","items":{"type":"integer","description":"all mirroring ports of M-LAG Peer Switch","format":"int32"}},"allMirroredPorts":{"uniqueItems":true,"type":"array","description":"all mirrored ports of M-LAG Peer Switch","items":{"type":"integer","description":"all mirrored ports of M-LAG Peer Switch","format":"int32"}},"allMlagPeerLinkPorts":{"uniqueItems":true,"type":"array","description":"all M-LAG PeerLink ports of M-LAG Peer Switch","items":{"type":"integer","description":"all M-LAG PeerLink ports of M-LAG Peer Switch","format":"int32"}},"allMlagDadPorts":{"uniqueItems":true,"type":"array","description":"all M-LAG DAD ports of M-LAG Peer Switch","items":{"type":"integer","description":"all M-LAG DAD ports of M-LAG Peer Switch","format":"int32"}}},"description":"Configuration information of all M-LAG Peer ports, used to determine whether the port can be selected"},"OswMlagPeerSettingVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device mac"},"mlagPeerPorts":{"uniqueItems":true,"type":"array","description":"M-LAG group peer device LAG ports","items":{"type":"integer","description":"M-LAG group peer device LAG ports","format":"int32"}},"mlagPeerStandardPorts":{"uniqueItems":true,"type":"array","description":"M-LAG group peer device LAG standard ports","items":{"$ref":"#/components/schemas/OswStandPortVO"}}},"description":"M-LAG group peer device setting"},"OswPeerPortVO":{"type":"object","properties":{"port":{"type":"integer","description":"Port","format":"int32"},"stPort":{"type":"string","description":"Standard Port, unit/slot/port"},"lagId":{"type":"integer","description":"LagId. If it is not null, it indicates that the port is a LAG port","format":"int32"},"linkSpeed":{"type":"integer","description":"Link Speed","format":"int32"},"duplex":{"type":"integer","description":"Duplex","format":"int32"},"rx":{"type":"integer","description":"Port total rx bytes","format":"int64"},"rx Rate":{"type":"integer","description":"Port rx Rate","format":"int64"},"tx":{"type":"integer","description":"Port total tx bytes","format":"int64"},"tx Rate":{"type":"integer","description":"Port tx Rate","format":"int64"},"stpDiscarding":{"type":"boolean","description":"STP Discarding"},"blockedVlans":{"type":"string","description":"Blocked Vlans"},"blockedType":{"type":"integer","description":"Blocked Type","format":"int32"}},"description":"Downlink Port Info"},"OswPortDhcpL2RelayVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"Enable"},"format":{"type":"integer","description":"Format should be a value as follows: 0: Normal; 1: Private","format":"int32"},"circuitId":{"pattern":"^[a-zA-Z0-9-_@:/\\.#]{0,64}$","type":"string","description":"Circuit ID"},"remoteId":{"pattern":"^[a-zA-Z0-9-_@:/\\.#]{0,64}$","type":"string","description":"Remote ID"}},"description":"Dhcp L2 Relay Setting"},"OswPortOuiBasedVlanVO":{"type":"object","properties":{"networks":{"type":"array","description":"The network configured in the osw port.","items":{"$ref":"#/components/schemas/OuiBasedVlanNetworkVO"}}},"description":"Vlans configured in oui based rules."},"OswPortSpeedCapVO":{"type":"object","properties":{"Link Speed":{"$ref":"#/components/schemas/PortSpeedCapVO"},"duplex":{"$ref":"#/components/schemas/PortSpeedCapVO"}},"description":"Port Speed Capability"},"OswPortStackSettingVO":{"type":"object","properties":{"mirroredPorts":{"type":"array","description":"Mirrored Standard Ports","items":{"$ref":"#/components/schemas/OswStandPortVO"}},"lagSetting":{"$ref":"#/components/schemas/OswStackLagVO"},"stackId":{"type":"string","description":"Stack ID"}},"description":"Port Stack Setting"},"OswPortStatusVO":{"type":"object","properties":{"port":{"type":"integer","description":"Port Number","format":"int32"},"linkStatus":{"type":"integer","description":"LinkStatus should be a value as follows: 0: link down; 1: link up","format":"int32"},"linkSpeed":{"type":"integer","description":"LinkSpeed should be a value as follows: 1: 10Mbps; 2: 100Mbps; 3: 1000Mbps; 4: 10Gbps","format":"int32"},"duplex":{"type":"integer","description":"Duplex should be a value as follows: 1: Half; 2: Full","format":"int32"},"fecMode":{"type":"integer","description":"The configured FEC Mode","format":"int32"},"fecRealMode":{"type":"integer","description":"The actual effective FEC Mode","format":"int32"},"poe":{"type":"boolean","description":"Indicates whether PoE power supply is in use"},"poePower":{"type":"number","description":"PoE Power","format":"double"},"tx":{"type":"integer","description":"Tx, in bytes","format":"int64"},"rx":{"type":"integer","description":"Rx, in bytes","format":"int64"},"txRate":{"type":"integer","description":"Tx rate, in bit/s","format":"int64"},"rxRate":{"type":"integer","description":"Rx rate, in bit/s","format":"int64"},"stp":{"type":"string","description":"STP Status"},"stpDiscarding":{"type":"boolean","description":"STP Discarding"},"blockedVlans":{"type":"string","description":"Blocked Vlans"},"blockedType":{"type":"integer","description":"Blocked Type","format":"int32"},"chassisIdSubtype":{"type":"string","description":"Chassis ID Subtype"},"chassisId":{"type":"string","description":"Chassis ID"},"portIdSubtype":{"type":"string","description":"Port ID Subtype"},"portId":{"type":"string","description":"Port ID"},"stkStatus":{"type":"integer","description":"Stk Status","format":"int32"},"trunkState":{"type":"integer","description":"LACP port state","format":"int32"}},"description":"Port Status"},"OswStackConfigOpenApiVO":{"required":["member","name"],"type":"object","properties":{"name":{"type":"string","description":"Stack Name"},"member":{"type":"array","description":"Stack member list","items":{"$ref":"#/components/schemas/OswStackMemberVO"}}}},"OswStackLagVO":{"required":["lagId"],"type":"object","properties":{"lagId":{"type":"integer","description":"Lag ID","format":"int32"},"ports":{"uniqueItems":true,"type":"array","description":"Lag ports","items":{"type":"integer","description":"Lag ports","format":"int32"}},"lagType":{"type":"integer","description":"LagType should be a value as follows: 1: Static LAG; 2: LACP; 3: LACP-Active; 4: LACP-Passive","format":"int32"},"mlagName":{"type":"string","description":"M-LAG group Name"},"mlagEnable":{"type":"boolean","description":"Indicates whether M-LAG port is enabled"},"mlagPeerSetting":{"$ref":"#/components/schemas/OswMlagPeerSettingVO"},"stackId":{"type":"string","description":"Stack ID"},"standPorts":{"type":"array","description":"Standard LAG Ports","items":{"$ref":"#/components/schemas/OswStandPortVO"}}},"description":"Basic configuration of the LAG"},"OswStackMemberPortCapAndStatusVO":{"type":"object","properties":{"stackSupport":{"type":"boolean","description":"Stack Support"},"standardPort":{"$ref":"#/components/schemas/OswStandPortVO"},"portStatus":{"$ref":"#/components/schemas/OswPortStatusVO"}},"description":"Port Information"},"OswStackMemberPortVO":{"type":"object","properties":{"id":{"type":"string","description":"ID"},"port":{"type":"integer","description":"Port","format":"int32"},"standardPort":{"$ref":"#/components/schemas/OswStandPortVO"},"configStack":{"type":"boolean","description":"Indicates whether the current port is configured as a stack port (joined a stack aggregation group)"},"stackPortsGroupIndex":{"type":"integer","description":"Number of the stacking port aggregation group to join","format":"int32"},"switchId":{"type":"string","description":"Switch ID to which the port belongs"},"switchMac":{"type":"string","description":"Switch Mac to which the port belongs"},"site":{"type":"string","description":"Site to which the port belongs"},"name":{"type":"string","description":"Port Name"},"disable":{"type":"boolean","description":"Indicates whether to disable the port"},"type":{"type":"integer","description":"Type should be a value as follows: 1: Copper; 2: Combo; 3: SFP","format":"int32"},"maxSpeed":{"type":"integer","description":"MaxSpeed should be a value as follows: 1: 10Mbps; 2: 100Mbps; 3: 1000Mbps; 4: 2.5Gbps; 5: 10Gbps","format":"int32"},"tagIds":{"type":"array","description":"Port label ID List","items":{"type":"string","description":"Port label ID List"}},"tagName":{"type":"string","description":"Port label Name"},"networkMode":{"type":"integer","description":"Network Mode should be a value as follows: 0: Trunk, 1: Access","format":"int32"},"nativeNetworkId":{"type":"string","description":"Native Network ID, Native Network cannot be selected from Tagged Networks or Untagged Networks."},"nativeBridgeVlan":{"type":"integer","description":"Native Network Bridge Vlan.","format":"int32"},"networkTagsSetting":{"type":"integer","description":"Network Tags Setting should be a value as follows: 0: Allow All; 1: Block All; 2: Custom","format":"int32"},"tagNetworkIds":{"type":"array","description":"Tag Network IDs","items":{"type":"string","description":"Tag Network IDs"}},"tagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Tag Network Bridge Vlan Map","items":{"type":"integer","description":"Tag Network Bridge Vlan Map","format":"int32"}},"description":"Tag Network Bridge Vlan Map"},"untagNetworkIds":{"type":"array","description":"Untag Network IDs","items":{"type":"string","description":"Untag Network IDs"}},"untagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Untag Network Bridge Vlan Map","items":{"type":"integer","description":"Untag Network Bridge Vlan Map","format":"int32"}},"description":"Untag Network Bridge Vlan Map"},"voiceNetworkEnable":{"type":"boolean","description":"Voice network enable status"},"voiceNetworkId":{"type":"string","description":"Voice Network ID"},"voiceBridgeVlan":{"type":"integer","description":"Voice Network Bridge Vlan","format":"int32"},"voiceDscpEnable":{"type":"boolean","description":"Voice DSCP enable status"},"voiceDscp":{"type":"integer","description":"Voice DSCP","format":"int32"},"profileId":{"type":"string","description":"Lan Profile ID"},"profileName":{"type":"string","description":"Lan Profile Name"},"profileOverrideEnable":{"type":"boolean","description":"Indicates whether to enable Profile Override before v6.2.10; Indicates the fill mode of port configuration after v6.2.10: true: custom; false: follow profile"},"profileVlanOverrideEnable":{"type":"boolean","description":"Indicates the fill mode of vlan configuration: true: custom; false: follow profile"},"operation":{"type":"string","description":"Operation should be a value as follows: SWITCHING; MIRRORING; AGGREGATING"},"mirroredPorts":{"type":"array","description":"Monitored Port","items":{"$ref":"#/components/schemas/MirroredPort"}},"mirroredLags":{"type":"array","description":"Monitored LAG","items":{"$ref":"#/components/schemas/MirroredLag"}},"aggregatingPorts":{"uniqueItems":true,"type":"array","description":"Aggregated ports (including this port), non-null only in aggregating mode","items":{"type":"integer","description":"Aggregated ports (including this port), non-null only in aggregating mode","format":"int32"}},"allAggregatingPorts":{"uniqueItems":true,"type":"array","description":"All ports in the aggregating state on the Switch","items":{"type":"integer","description":"All ports in the aggregating state on the Switch","format":"int32"}},"allMirroringPorts":{"uniqueItems":true,"type":"array","description":"All ports in the mirroring state on the Switch","items":{"type":"integer","description":"All ports in the mirroring state on the Switch","format":"int32"}},"allMirroredPorts":{"uniqueItems":true,"type":"array","description":"All mirrored ports on the Switch","items":{"type":"integer","description":"All mirrored ports on the Switch","format":"int32"}},"allMlagPeerLinkPorts":{"uniqueItems":true,"type":"array","description":"All ports configured with M-LAG PeerLink on the Switch","items":{"type":"integer","description":"All ports configured with M-LAG PeerLink on the Switch","format":"int32"}},"allMlagDadPorts":{"uniqueItems":true,"type":"array","description":"All ports configured with M-LAG DAD on the Switch","items":{"type":"integer","description":"All ports configured with M-LAG DAD on the Switch","format":"int32"}},"allAggregatingStPorts":{"uniqueItems":true,"type":"array","description":"All aggregating ports of the current Stack","items":{"$ref":"#/components/schemas/OswStandPortVO"}},"allMirroringStPorts":{"uniqueItems":true,"type":"array","description":"All mirroring ports of the current Stack","items":{"$ref":"#/components/schemas/OswStandPortVO"}},"allMirroredStPorts":{"uniqueItems":true,"type":"array","description":"All mirrored ports of the current Stack","items":{"$ref":"#/components/schemas/OswStandPortVO"}},"lagSetting":{"$ref":"#/components/schemas/OswLagVO"},"linkSpeed":{"type":"integer","description":"Link Speed should be a value as follows: 0: auto; 1: 10M; 2: 100M; 3: 1000M; 4: 10G","format":"int32"},"duplex":{"type":"integer","description":"Duplex should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"},"igmpSnoopingEnable":{"type":"boolean","description":"Indicates whether IGMP Snooping is enabled"},"dot1x":{"type":"integer","description":"Dot1x should be a value as follows: 0: Force unauthorized; 1: Force authorized; 2: Auto","format":"int32"},"madUsed":{"type":"boolean","description":"Mad Used"},"esEnableAllProfileCanAdd":{"type":"boolean","description":"Indicates whether es enable of all profile can continue to add VLANs"},"supportPoe":{"type":"boolean","description":"Indicates whether PoE is supported"},"supportLocate":{"type":"boolean","description":"Whether the port support locate."},"poeDisplayType":{"type":"integer","description":"PoeDisplayType should be a value as follows: -1: Not Support POE; 0: Support POE; 1: POE(4W); 2: POE(7W); 3: POE(15.4W); 4: POE+(30W); 5: POE++(45W); 6: POE++(60W); 7: POE++(75W); 8: POE++(90W); 9: POE++(100W).","format":"int32"},"poe":{"type":"integer","description":"PoE switch should be a value as follows: 0: Off; 1: 802.3at/af","format":"int32"},"bandWidthCtrlType":{"type":"integer","description":"BandWidth Control should be a value as follows: 0: Off; 1: Rate Limit; 2: Storming Control","format":"int32"},"bandCtrl":{"$ref":"#/components/schemas/OswBandCtrlVO"},"stormCtrl":{"$ref":"#/components/schemas/OswStormCtrlVO"},"lldpMedEnable":{"type":"boolean","description":"Indicates whether LLDP MED is enabled"},"topoNotifyEnable":{"type":"boolean","description":"Indicates whether to enable topology change notification"},"spanningTreeEnable":{"type":"boolean","description":"Indicates whether SpanningTree is enabled"},"spanningTreeSetting":{"$ref":"#/components/schemas/SpanningTreeSettingVO"},"loopbackDetectEnable":{"type":"boolean","description":"Indicates whether loopbackDetect port based is enabled"},"loopbackDetectVlanBasedEnable":{"type":"boolean","description":"Indicates whether loopbackDetect vlan based is enabled"},"igmpFastLeaveEnable":{"type":"boolean","description":"Indicates whether IGMP fast leave is enabled"},"mldFastLeaveEnable":{"type":"boolean","description":"Indicates whether MLD fast leave is enabled"},"portIsolationEnable":{"type":"boolean","description":"Indicates whether port isolation is enabled"},"portStatus":{"$ref":"#/components/schemas/OswPortStatusVO"},"speed":{"type":"integer","description":"Port Speed should be a value as follows: 1: 10Mbps; 2: 100Mbps; 3: 1000Mbps; 4: 10Gbps","format":"int32"},"lagStatus":{"$ref":"#/components/schemas/OswLagStatusVO"},"portCap":{"uniqueItems":true,"type":"array","description":"Port Capability","items":{"$ref":"#/components/schemas/OswLinkCapVO"}},"portSpeedCap":{"uniqueItems":true,"type":"array","description":"Port Speed Capability","items":{"$ref":"#/components/schemas/OswPortSpeedCapVO"}},"eeeEnable":{"type":"boolean","description":"Indicates whether EEE is enabled"},"flowControlEnable":{"type":"boolean","description":"Indicates whether flow control is enabled"},"extendModeSupport":{"type":"boolean","description":"Indicates whether extend mode is supported"},"extendModeEnable":{"type":"boolean","description":"Indicates whether extendMode is enabled"},"fastLeaveEnable":{"type":"boolean","description":"Indicates whether igmpSnooping fastLeave is enabled"},"dhcpL2RelaySettings":{"$ref":"#/components/schemas/OswPortDhcpL2RelayVO"},"dot1pPriority":{"type":"integer","description":"Dot1p Priority","format":"int32"},"trustMode":{"type":"integer","description":"TrustMode should be a value as follows: 0: Untrusted; 1: Trust 802.1p; 2: Trust DSCP","format":"int32"},"qosSupport":{"type":"boolean","description":"Indicates whether the device port supports modifying qos configuration"},"esQosSupport":{"type":"boolean","description":"Indicates whether the ES device port supports modification of QoS configuration"},"qosQueueEnable":{"type":"boolean","description":"Indicates whether the ES device port has enabled the Qos scheduling queue configuration"},"queueId":{"type":"integer","description":"ES Qos scheduling queue ID","format":"int32"},"networkConflict":{"type":"boolean","description":"Indicates whether the VLAN configuration activated on the port is inconsistent with the VLAN configuration in the Profile."},"resource":{"type":"integer","description":"Data Source. Resource should be a value as follows: 0: new created; 1: from template; 2: override","format":"int32"},"portAlertEnable":{"type":"boolean","description":"Indicates whether Port Alert is enabled"},"fecSupport":{"type":"boolean","description":"Indicates whether the port supports FEC configuration"},"fecCap":{"uniqueItems":true,"type":"array","description":"All LinkSpeed&FECMode combinations supported by the port","items":{"$ref":"#/components/schemas/OswFecCapVO"}},"fecMode":{"type":"integer","description":"FEC Mode, sourced from FecModeEnum. 0 - Reserved; 1 - FEC-OFF (Off); 2 - FEC-RS528; 3 - FEC-RS544; 4 - FEC-AUTO; 5 - FEC-BASER","format":"int32"},"fecLinkPeerApplyEnable":{"type":"boolean","description":"Indicates whether the same FEC mode is applied to the link peer"},"configMlagPeerLink":{"type":"boolean","description":"Indicates whether the port is configured with M-LAG Peer Link"},"configMlagDad":{"type":"boolean","description":"Indicates whether the port is configured with M-LAG DAD Link"},"mlagPeerAllPortsConfigInfo":{"$ref":"#/components/schemas/OswMlagPeerAllPortsConfigInfoVO"},"locateEnable":{"type":"boolean","description":"Whether locate function is enabled"},"usedFunctions":{"type":"array","description":"List of functions that use this port","items":{"type":"string","description":"List of functions that use this port"}},"isCopper":{"type":"boolean","description":"Whether the port is copper when the port is combo."},"ouiBasedVlanNetworks":{"$ref":"#/components/schemas/OswPortOuiBasedVlanVO"},"stackSupport":{"type":"boolean","description":"Stack Support"},"stackSetting":{"$ref":"#/components/schemas/OswPortStackSettingVO"},"stackId":{"type":"string","description":"Stack ID"}},"description":"Including some port configuration information and port real-time status"},"OswStackMemberVO":{"required":["mac","priority","stackPorts","unit"],"type":"object","properties":{"omadacId":{"type":"string","description":"OmadacId"},"mac":{"type":"string","description":"Device Mac"},"name":{"type":"string","description":"Device Name"},"ip":{"type":"string","description":"IP"},"unit":{"type":"integer","description":"Unit number of the local stacking system of the device","format":"int32"},"priority":{"type":"integer","description":"Priority of the device in the local stacking system","format":"int32"},"status":{"type":"integer","description":"Device Status","format":"int32"},"memberStatus":{"type":"integer","description":"Stack Member Status should be a value as follows: 0: master; 1: slaver; 2: notInitial; 3: licenseOverdue; 4: licenseUnactive","format":"int32"},"compatible":{"type":"integer","description":"Compatible Type","format":"int32"},"model":{"type":"string","description":"Member Model"},"modelVersion":{"type":"string","description":"Member Model Version"},"showModel":{"type":"string","description":"ShowModel"},"compoundModel":{"type":"string"},"version":{"type":"string","description":"Software Version"},"active":{"type":"boolean","description":"Indicates whether the device is activated"},"licenseStatus":{"type":"integer","description":"License Status should be a value as follows: 0: UnActive; 1: Unbind; 2: Expired; 3: Active; 4: NotMatch; 5: NearExpired","format":"int32"},"dueTime":{"type":"integer","description":"Expiration time","format":"int64"},"dueTimeLeft":{"type":"integer","description":"The number of milliseconds from the current time to the expiration time","format":"int64"},"category":{"type":"string","description":"Category"},"licenseId":{"type":"string","description":"License Id"},"licenseUnbindingLimit":{"type":"integer","description":"The remaining number of times to unbind the license","format":"int32"},"initialUnbindingLimit":{"type":"integer","description":"The initial number of times to unbind the license","format":"int32"},"uptime":{"type":"string","description":"Uptime"},"cpuUtil":{"type":"integer","description":"Real-time CPU usage","format":"int32"},"memUitl":{"type":"integer","description":"Real-time memory usage","format":"int32"},"poeTotalPower":{"type":"number","description":"PoE Total Power (W)","format":"double"},"poeRemain":{"type":"number","description":"PoE Residual Power (W)","format":"double"},"poeRemainPercent":{"type":"number","description":"PoE Residual Power Percentage","format":"double"},"loopbackNum":{"type":"integer","description":"Number of loops","format":"int32"},"loop":{"type":"string","description":"Loopback port"},"blockNum":{"type":"integer","description":"Number of blocks","format":"int32"},"block":{"type":"string","description":"Block port"},"supportStackGroupSpeed":{"type":"boolean","description":"Indicates whether the member device supports configuring the link speed of the stack port aggregation group"},"stackPortConfigCaps":{"type":"array","description":"Ports capability that support configuration as stack port","items":{"$ref":"#/components/schemas/OswStackPortCapVO"}},"defaultGroupSpeedCap":{"uniqueItems":true,"type":"array","description":"Stack port aggregation group default link speed capability","items":{"type":"integer","description":"Stack port aggregation group default link speed capability","format":"int32"}},"portCaps":{"type":"array","description":"Port Information","items":{"$ref":"#/components/schemas/OswStackMemberPortCapAndStatusVO"}},"ports":{"type":"array","description":"Including some port configuration information and port real-time status","items":{"$ref":"#/components/schemas/OswStackMemberPortVO"}},"stackPorts":{"type":"array","description":"Stack port list","items":{"$ref":"#/components/schemas/OswStackPortGroupVO"}},"oswStackPortGroupStatus":{"type":"array","description":"Including some port configuration information and port real-time status","items":{"$ref":"#/components/schemas/OswLagVO"}},"maxStackGroups":{"type":"integer","description":"Maximum number of stacking port aggregation groups supported","format":"int32"},"maxStackUnitNumber":{"type":"integer","description":"The maximum unit number supported by the device, starting from 1","format":"int32"},"stackPortCap":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"locateEnable":{"type":"boolean","description":"Indicates whether the locate function is enabled"},"inWhitelist":{"type":"boolean","description":"Indicates whether it is in the whitelist"},"deviceSeriesType":{"type":"integer","description":"DeviceSeriesType should be a value as follows: 0: advanced; 1: pro","format":"int32"},"type":{"type":"string","description":"Type"},"statusCategory":{"type":"integer","format":"int32"},"uplink":{"$ref":"#/components/schemas/OswUplinkVO"},"downlinkList":{"type":"array","description":"Downlink Omada device list","items":{"$ref":"#/components/schemas/OswDownlinkVO"}}},"description":"Stack member list"},"OswStackPortCapVO":{"type":"object","properties":{"standardPort":{"$ref":"#/components/schemas/OswStandPortVO"},"groupSpeedCap":{"uniqueItems":true,"type":"array","description":"Stack port aggregation group link speed capability","items":{"type":"integer","description":"Stack port aggregation group link speed capability","format":"int32"}}},"description":"Ports capability that support configuration as stack port"},"OswStackPortGroupVO":{"required":["ID"],"type":"object","properties":{"ID":{"type":"integer","description":"The ID of the stack port aggregation group","format":"int32"},"name":{"type":"string","description":"Name of the stacking port aggregation group"},"ports":{"type":"array","description":"Stack port aggregation group member port","items":{"$ref":"#/components/schemas/OswStandPortVO"}},"groupSpeed":{"type":"integer","description":"Stack port aggregation group link speed config","format":"int32"}},"description":"Stack port list"},"OswStandPortVO":{"required":["port","slot","unit"],"type":"object","properties":{"unit":{"type":"integer","description":"Unit","format":"int32"},"slot":{"type":"integer","description":"Slot","format":"int32"},"port":{"type":"integer","description":"Port","format":"int32"}},"description":"Stack port aggregation group member port"},"OswStormCtrlLimitRangeVO":{"type":"object","properties":{"broadcastLimitKbps":{"type":"integer","description":"The maximum rate limits for Broadcast(kbps).","format":"int32"},"multicastLimitKbps":{"type":"integer","description":"The maximum rate limits for Multicast(kbps).","format":"int32"},"unknownUnicastLimitKbps":{"type":"integer","description":"The maximum rate limits for Unknown Unicast(kbps).","format":"int32"}},"description":"The maximum rate limits for Broadcast/Multicast/Unknown Unicast."},"OswStormCtrlVO":{"required":["action","broadcastEnable","multicastEnable","unknownUnicastEnable"],"type":"object","properties":{"rateMode":{"type":"integer","description":"RateMode should be a value as follows: 0: ratio; 1: kbps","format":"int32"},"unknownUnicastEnable":{"type":"boolean","description":"Indicates whether unknown unicast is enabled"},"unknownUnicast":{"type":"integer","description":"Unknown Unicast","format":"int32"},"multicastEnable":{"type":"boolean","description":"Indicates whether multicast is enabled"},"multicast":{"type":"integer","description":"Multicast","format":"int32"},"broadcastEnable":{"type":"boolean","description":"Indicates whether broadcast is enabled"},"broadcast":{"type":"integer","description":"Broadcast","format":"int32"},"action":{"type":"integer","description":"Action should be a value as follows: 0: drop; 1: shutdown","format":"int32"},"recoverTime":{"type":"integer","description":"Recover Time","format":"int32"},"limitRange":{"$ref":"#/components/schemas/OswStormCtrlLimitRangeVO"}},"description":"Storm Control"},"OswUplinkVO":{"type":"object","properties":{"port":{"type":"integer","description":"Port","format":"int32"},"stPort":{"type":"string","description":"Standard Port, unit/slot/port"},"lagId":{"type":"integer","description":"LagId. If it is not null, it indicates that the port is a LAG port","format":"int32"},"mac":{"type":"string","description":"The mac of uplink device"},"stackId":{"type":"string","description":"The ID of uplink stack device"},"stackName":{"type":"string","description":"The name of uplink stack device"},"name":{"type":"string","description":"The name of uplink device"},"model":{"type":"string","description":"The model of uplink device"},"hwVersion":{"type":"string","description":"HwVersion"},"modelVersion":{"type":"string","description":"Model Version"},"linkSpeed":{"type":"integer","description":"Link Speed","format":"int32"},"duplex":{"type":"integer","description":"Duplex","format":"int32"},"rx":{"type":"integer","description":"Port total rx bytes","format":"int64"},"rxRate":{"type":"integer","description":"Rx Rate","format":"int64"},"tx":{"type":"integer","description":"Port total tx bytes","format":"int64"},"txRate":{"type":"integer","description":"Tx Rate","format":"int64"},"stpDiscarding":{"type":"boolean","description":"STP Discarding"},"blockedVlans":{"type":"string","description":"Blocked Vlans"},"blockedType":{"type":"integer","description":"Blocked Type","format":"int32"},"type":{"type":"string","description":"The type of uplink device, it should be a value as follows: ap, gateway, switch(stack)"},"linkPeerPortInfo":{"$ref":"#/components/schemas/OswPeerPortVO"},"ip":{"type":"string"}},"description":"Uplink Omada device"},"OuiBasedVlanNetworkVO":{"type":"object","properties":{"ouiBasedVlanId":{"type":"string","description":"The id of the oui based vlan rule."},"ouiBasedVlanName":{"type":"string","description":"The name of the oui based vlan rule."},"ruleMode":{"type":"integer","description":"The mode of the oui based vlan rule. 0 represents all device ports ,1 represents custom.","format":"int32"},"networkId":{"type":"string","description":"The id for the network."},"networkName":{"type":"string","description":"The name of the network."},"vlanType":{"type":"integer","description":"0:Single, 1:Multiple(Bridge Vlan)","format":"int32"},"vlan":{"type":"integer","description":"The vlan of one network that multicast config used.","format":"int32"}},"description":"The network configured in the osw port."},"PortSpeedCapVO":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"value":{"type":"integer","description":"Value","format":"int32"}},"description":"Duplex"},"SpanningTreeSettingVO":{"required":["edgePort","extPathCost","intPathCost","p2pLink","priority"],"type":"object","properties":{"priority":{"type":"integer","description":"Priority should be within the range of 0–240","format":"int32"},"extPathCost":{"type":"integer","description":"ExtPathCost should be within the range of 0–2000000","format":"int32"},"intPathCost":{"type":"integer","description":"IntPathCost should be within the range of 0–2000000","format":"int32"},"edgePort":{"type":"boolean","description":"Indicates whether edge port is enabled"},"p2pLink":{"type":"integer","description":"P2pLink should be within the range of 0-2","format":"int32"},"mcheck":{"type":"boolean","description":"Indicates whether mcheck is enabled"},"loopProtect":{"type":"boolean","description":"Indicates whether loop protect is enabled"},"rootProtect":{"type":"boolean","description":"Indicates whether root protect is enabled"},"tcGuard":{"type":"boolean","description":"Indicates whether tcGuard is enabled"},"bpduProtect":{"type":"boolean","description":"Indicates whether bpdu protect is enabled"},"bpduFilter":{"type":"boolean","description":"Indicates whether bpdu filter is enabled"},"bpduForward":{"type":"boolean","description":"Indicates whether bpdu forward is enabled"},"instanceEnable":{"type":"boolean","description":"Indicates whether instance is enabled"},"instances":{"type":"array","description":"Instances","items":{"$ref":"#/components/schemas/InstancesVO"}}},"description":"SpanningTree Setting"},"ModifyOswVrfOpenApiVO":{"required":["ipv6Enable"],"type":"object","properties":{"ipv6Enable":{"type":"boolean","description":"Whether to enable ipv6"}}},"Ui setting list request entity":{"type":"object","properties":{"settings":{"type":"array","description":"List of ui settings","items":{"$ref":"#/components/schemas/Ui setting request entity"}}}},"Ui setting request entity":{"type":"object","properties":{"settingKey":{"type":"string","description":"Key of ui setting"},"uiSetting":{"type":"string","description":"Value of ui setting"},"accountLevel":{"type":"boolean","description":"Is account level or not"}},"description":"List of ui settings"},"MldOpenApiVO":{"required":["enable","version"],"type":"object","properties":{"enable":{"type":"boolean"},"version":{"type":"integer","description":"Version should be one of the following values: 1: v1; 2: v2.","format":"int32"},"wanPortId":{"type":"string","description":"WAN port ID can be obtained from 'Get internet basic info' interface. At least one of the WAN Port IDs should not be null. Only IPv6-enabled WAN ports can be selected as MLD Interface. MLD does not support the 6to4 Tunnel and Pass-Through(Bridge) IPv6 dial-up modes."},"featureDescription":{"type":"array","description":"Gateway Feature Description.","items":{"$ref":"#/components/schemas/FeatureInfoVO"}}}},"BatchConfigIotTransmitPowerOpenApiVO":{"required":["macs","override","selectAll"],"type":"object","properties":{"macs":{"type":"array","description":"Device mac list. If selectAll is true, mac in macs is excluded.","items":{"type":"string","description":"Device mac list. If selectAll is true, mac in macs is excluded."}},"override":{"type":"boolean","description":"Whether to override the configuration."},"transmitPower":{"type":"integer","description":"Broadcast transmission power.<br />The parameter [transmitPower] should be a value as follows:[-20, -18, -15, -12, -10, -9, -6, -5, -3, 0, 1, 2, 3, 4, 5, 14, 15, 16, 17, 18, 19, 20].(0 by default)","format":"int32"},"selectAll":{"type":"boolean","description":"Whether to select all device. The selected devices are the ones filtered out based on the searchKey."},"searchKey":{"type":"string","description":"Look for a specific piece of data."}}},"ConfigIotBtIbeaconOpenApiVO":{"required":["macList","major","minor","name","uuid"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"The Bluetooth Advertising seting name. The name of built-in entry are not allowed to be modified."},"macList":{"maxItems":2147483647,"minItems":1,"type":"array","description":"List of device MAC addresses bound to this configuration.","items":{"maxLength":2147483647,"minLength":1,"type":"string","description":"List of device MAC addresses bound to this configuration."}},"enable":{"type":"boolean","description":"Whether to enable the Bluetooth Advertising setting.(Disable by default)"},"transmitPower":{"type":"integer","description":"Broadcast transmission power.<br />The parameter [transmitPower] should be a value as follows:[-20, -18, -15, -12, -10, -9, -6, -5, -3, 0, 1, 2, 3, 4, 5, 14, 15, 16, 17, 18, 19, 20].(0 by default)","format":"int32","deprecated":true},"measurePower":{"type":"integer","description":"RSSI Calibration Value. The parameter [measurePower] is used to input the RSSI measured at a 1-meter distance from the device, enabling positioning functionality.(-65 by default)","format":"int32"},"advInterval":{"type":"integer","description":"Advertising interval in milliseconds.(500 by default)","format":"int32"},"uuid":{"type":"string","description":"The UUID (Universally Unique Identifier) of the advertising ibeacon packet."},"major":{"type":"string","description":"The major value of adverting ibeacon packet, indicating a larger group."},"minor":{"type":"string","description":"The minor value of adverting ibeacon packet, indicating a smaller group."}}},"StaticRoutingConfig":{"required":["destinations","metric","name","routeType","status"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name, name should contain 1 to 64 characters."},"status":{"type":"boolean","description":"Status"},"destinations":{"type":"array","description":"IP address/SubNet","items":{"type":"string","description":"IP address/SubNet"}},"routeType":{"type":"integer","description":"RouteType should be a value as follows: 0: NextHop; 1: Interface","format":"int32"},"nextHopIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Only for routeType:0 or routeType:1 and selected WAN is Static IP/Dynamic IP mode"},"interfaceType":{"type":"integer","description":"Only for routeType:1, interfaceType should be a value as follows: 0: Internet(WAN); 1: Network(LAN); 2: L2TP, 3: PPTP, 5: Virtual WAN.","format":"int32"},"interfaceId":{"type":"string","description":"Interface ID, for example: if interfaceType is network, interfaceId should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."},"metric":{"type":"integer","description":"Metric should be within the range of 0–15.","format":"int32"}}},"RFPlanningScheduleConfigOpenApiVO":{"required":["occurrence","scheduleEnable"],"type":"object","properties":{"scheduleEnable":{"type":"boolean","description":"Whether by WLAN Optimization schedule. The optimization schedule function is temporarily offline."},"occurrence":{"$ref":"#/components/schemas/occurrence"}}},"occurrence":{"required":["hour","minute","timingType"],"type":"object","properties":{"timingType":{"type":"integer","description":"Time type should be a value as follows: 1:Daily; 2:Weekly; 3:Monthly","format":"int32"},"hour":{"type":"integer","description":"It should be within the range of 0~23","format":"int32"},"minute":{"type":"integer","description":"It should be within the range of 0~59","format":"int32"},"dayOfWeek":{"type":"integer","description":"It should be within the range of 0(Sunday)~6(Saturday). Required when parameter [timingType] is 2.","format":"int32"},"dayOfMonth":{"type":"integer","description":"It should be within the range of 1~31. Required when parameter [timingType] is 3.","format":"int32"}},"description":"The optimization schedule function is temporarily offline."},"Excluded APs Config":{"required":["delete"],"type":"object","properties":{"delete":{"type":"boolean","description":"Whether to delete device(s) from the excluded AP list."},"excludeAps":{"type":"string","description":"Parameter [excludeAps] should not be null when parameter [delete] is true. It contains device MAC that should not be excluded. MAC should be concatenated with ','. "},"selectMacs":{"$ref":"#/components/schemas/SelectMacsVO"}}},"SelectMacsVO":{"type":"object","properties":{"selectType":{"type":"string","description":"The value of parameter [selectType] must be in [all, include, exclude]."},"macs":{"type":"array","description":"MAC list. When parameter [selectType] is 'all', it should be null.When parameter [selectType] is 'include', it means the MAC list that needs to be included.When parameter [selectType] is 'exclude', it means the MAC list that needs to be excluded.","items":{"type":"string","description":"MAC list. When parameter [selectType] is 'all', it should be null.When parameter [selectType] is 'include', it means the MAC list that needs to be included.When parameter [selectType] is 'exclude', it means the MAC list that needs to be excluded."}}},"description":"Parameter [selectMacs] should not be null when parameter [delete] is false. "},"CardGroupVO":{"type":"object","properties":{"cardGroupName":{"type":"string"},"cardList":{"type":"array","items":{"type":"string"}}},"description":"list of card group"},"ReportTab":{"type":"object","properties":{"tabId":{"type":"string","description":"tab id"},"name":{"type":"string","description":"tab name"},"cards":{"type":"array","description":"list of cards in tab","items":{"type":"string","description":"list of cards in tab"}},"cardGroupList":{"type":"array","description":"list of card group","items":{"$ref":"#/components/schemas/CardGroupVO"}},"type":{"type":"integer","description":"tab type, default 0, customize 1","format":"int32"},"status":{"type":"integer","description":"tab status, 0: disable, 1: enable","format":"int32"},"rank":{"type":"integer","description":"tab rank","format":"int32"},"defaultKey":{"type":"string","description":"defaultKey"},"defaultTab":{"type":"string","description":"defaultTab"},"cancelCards":{"uniqueItems":true,"type":"array","description":"cards be cancelled","items":{"type":"string","description":"cards be cancelled"}}}},"RebootScheduleOpenApiVO":{"required":["deviceMacs","name","status","time"],"type":"object","properties":{"id":{"type":"string","description":"Reboot Schedule Id."},"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Reboot Schedule name should contain 1 to 128 characters."},"status":{"type":"boolean","description":"Reboot Schedule status."},"deviceMacs":{"type":"array","description":"MAC address of the selected devices. E.g. AA-BB-CC-DD-11-22","items":{"type":"string","description":"MAC address of the selected devices. E.g. AA-BB-CC-DD-11-22"}},"time":{"$ref":"#/components/schemas/RebootScheduleTimeOpenApiVO"}}},"ClassRuleOpenApiVO":{"required":["classType","dscp","enable","ipVersion","localIp","remoteIp","serviceType"],"type":"object","properties":{"enable":{"type":"boolean","description":"The status of class rule. valid values are true or false."},"ipVersion":{"type":"integer","description":"The IP Version of class rule should be a value as follows: 0: IPv4; 1: IPv6.","format":"int32"},"localIp":{"type":"string","description":"The ID of IP Group or IPv6 Group selected in the Local Address configuration. The ID can be obtained from 'Get group profile list' interface."},"remoteIp":{"type":"string","description":"The ID of IP Group or IPv6 Group selected in the Remote Address configuration. The ID can be obtained from 'Get group profile list' interface."},"dscp":{"type":"string","description":"The DSCP value selected in the DSCP configuration should be a value as follows: any: any; 8: IP precedence 1; 16: IP precedence 2; 24: IP precedence 3; 32: IP precedence 4; 40: IP precedence 5; 48: IP precedence 6; 56: IP precedence 7; 10: AF Class 1 (Low Drop); 12: AF Class 1 (Medium Drop); 14: AF Class 1 (High Drop); 18: AF Class 2 (Low Drop); 20: AF Class 2 (Medium Drop); 22: AF Class 2 (High Drop); 26: AF Class 3 (Low Drop); 28: AF Class 3 (Medium Drop); 30: AF Class 3 (High Drop); 34: AF Class 4 (Low Drop); 36: AF Class 4 (Medium Drop); 38: AF Class 4 (High Drop); 46: EF Class."},"serviceType":{"type":"string","description":"The ID of Gateway Qos Service selected in the Service Name configuration. The ID can be obtained from 'Get all Gateway QoS Service's ID and name info' interface."},"classType":{"type":"integer","description":"The Class value selected in the Qos Class configuration should be a value as follows: 1: Class 1, 2: Class 2, 3: Class 3.","format":"int32"}}},"CreateGoogleLdapProfileOpenApiVO":{"required":["baseDn","bindType","cn","name","port","server","status"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Google LDAP profile name. Name should contain 1 to 64 characters."},"status":{"type":"boolean","description":"LDAP profile enable status."},"bindType":{"type":"integer","description":"Type of LDAP bind. BindType should be a value as follows: 0: Simple Mode; 2: Regular Mode.","format":"int32"},"server":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"LDAP server address."},"port":{"type":"integer","description":"LDAP server listening port. dstPort should be within the range of 0-65535. It is generally 636.","format":"int32"},"cn":{"type":"string","description":"LDAP server common name, for example: cn, uid. Cn should contain 1 to 64 characters."},"baseDn":{"type":"string","description":"LDAP server base distinguish name, for example: dc=xxx,dc=com. BaseDn should contain 1 to 512 characters."},"filter":{"type":"string","description":"Additional filter, optional when parameter [type] is 1 or 2. For example: ou=xxx. Filter should contain 1 to 512 characters."},"account":{"type":"string","description":"Account, required when parameter [type] is 2. account should contain 1 to 256 characters."},"password":{"type":"string","description":"Password, required when parameter [type] is 2. password should contain 6 to 256 characters."}},"description":"Configuration of google LDAP profile, need to specify Content-Type of this form part as application/json."},"PortalLogoutConfigOpenApiVO":{"type":"object","properties":{"domain":{"pattern":"^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6}$","type":"string","description":"The domain of the portal logout url"}}},"PortScheduleOpenApiVO":{"required":["name","portsMap","status","turnOnTime"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Port Schedule Name should contain 1 to 128 characters."},"status":{"type":"boolean","description":"Port Schedule Status."},"turnOnTime":{"type":"string","description":"Time Range ID, cannot be empty."},"portsMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Key:MAC(\"String\"), Value:Set of Ports(\"Integer\")","items":{"type":"integer","description":"Key:MAC(\"String\"), Value:Set of Ports(\"Integer\")","format":"int32"}},"description":"Key:MAC(\"String\"), Value:Set of Ports(\"Integer\")"}}},"PoeScheduleOpenApiVO":{"required":["name","poePortsMap","status","turnOnTime"],"type":"object","properties":{"siteId":{"type":"string","description":"Site ID"},"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"PoE Schedule Name should contain 1 to 128 characters."},"status":{"type":"boolean","description":"PoE Schedule Status."},"turnOnTime":{"type":"string","description":"Time Range ID, cannot be empty."},"poePortsMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Key:Mac(\"String\"), Value:Set of Ports(\"Integer\")","items":{"type":"integer","description":"Key:Mac(\"String\"), Value:Set of Ports(\"Integer\")","format":"int32"}},"description":"Key:Mac(\"String\"), Value:Set of Ports(\"Integer\")"}},"description":"Poe schedule entity"},"OswVrrpConfigOpenApiVO":{"required":["advertiseTimer","authentication","delayTime","name","preemptMode","vrId"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"VRRP name, it should be visible ASCII, and should contain 1 to 64 characters."},"vrId":{"type":"integer","description":"Virtual Router ID, its value should be within the range of 1-255.","format":"int32"},"deviceList":{"maxItems":8,"minItems":1,"type":"array","description":"Up to 8 entries are allowed for the deviceList, and it cannot be empty.","items":{"$ref":"#/components/schemas/OswVrrpDeviceConfigOpenApiVO"}},"virtualIpv4s":{"maxItems":32,"minItems":0,"type":"array","description":"Up to 32 entries are allowed for the virtualIpv4s.","items":{"maxLength":32,"minLength":0,"type":"string","description":"Up to 32 entries are allowed for the virtualIpv4s."}},"ipV6LinkLocal":{"type":"string","description":"Virtual IpV6LinkLocal Address"},"ipV6Global":{"maxItems":15,"minItems":0,"type":"array","description":"Up to 15 entries are allowed for the ipV6Global.","items":{"maxLength":15,"minLength":0,"type":"string","description":"Up to 15 entries are allowed for the ipV6Global."}},"advertiseTimer":{"type":"integer","description":"AdvertiseTimer should be within the range of 1-255, the default setting value is 100 and the unit is millimeter second.","format":"int32"},"preemptMode":{"type":"boolean","description":"Whether the preemption mode is enabled or not, it defaults to enabled."},"delayTime":{"type":"integer","description":"DelayTime should be within the range of 0-255, default setting is 0 and the unit is second","format":"int32"},"authentication":{"type":"integer","description":"Authentication type should be a value as follows: 0: NONE, 1: Simple, 2: MD5","format":"int32"},"key":{"pattern":"^(?:[A-Za-z0-9]|[-./:_@]){1,8}$","type":"string","description":"Key of VRRP"}}},"OswVrrpDeviceConfigOpenApiVO":{"required":["mac","name","networks","priority","type","vlanInterface"],"type":"object","properties":{"name":{"type":"string","description":"The name of the device"},"mac":{"type":"string","description":"Device Mac"},"priority":{"type":"integer","description":"The device priority should be within the range of 1-254.","format":"int32"},"vlanInterface":{"type":"integer","description":"The Vlan Interface should be within the range of 1-4094.","format":"int32"},"trackedInterface":{"type":"integer","description":"The TrackedInterface should be within the range of 1-4094.","format":"int32"},"reducedPriority":{"type":"integer","description":"The ReducedPriority should be within the range of 1-254.","format":"int32"},"networks":{"maxItems":2,"minItems":0,"type":"array","description":"Store the IPv4 and IPv6 network segments corresponding to the VLAN interface, up to 2 entries are allowed for the networks.","items":{"maxLength":2,"minLength":0,"type":"string","description":"Store the IPv4 and IPv6 network segments corresponding to the VLAN interface, up to 2 entries are allowed for the networks."}},"type":{"type":"string","description":"Device Type"},"stackId":{"type":"string","description":"ID of stack group"}},"description":"Up to 8 entries are allowed for the deviceList, and it cannot be empty."},"OspfProcessAreaNetworkOpenApiVO":{"required":["ip","mask"],"type":"object","properties":{"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The IP address of the network."},"mask":{"type":"integer","description":"Mask should be within the range of 0-32.","format":"int32"}},"description":"Up to 16 entries are allowed for the networkList."},"OspfProcessAreaOpenApiVO":{"required":["areaId","areaType"],"type":"object","properties":{"areaId":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The 32 bit unsigned integer that uniquely identifies the area. It can be in decimal format or dotted decimal format."},"areaType":{"type":"integer","description":"OSPF area type should be a value as follows: 0: Normal, 1: Stub, or 2: NSSA.","format":"int32"},"networkList":{"maxItems":256,"minItems":0,"type":"array","description":"Up to 16 entries are allowed for the networkList.","items":{"$ref":"#/components/schemas/OspfProcessAreaNetworkOpenApiVO"}}},"description":" Up to 16 entries are allowed for the areaList."},"OspfProcessConfigOpenApiVO":{"required":["connectedEnable","deviceName","mac","processId","routerMode","staticEnable"],"type":"object","properties":{"deviceName":{"type":"string","description":"The name of the device"},"mac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"Device Mac"},"processId":{"type":"integer","description":"Process ID should be within the range of 1-65535.","format":"int32"},"routerMode":{"type":"integer","description":"RouterMode, its value should be a value as follows: 0: AUTO, 1: MANUAL.","format":"int32"},"routerId":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Router ID"},"staticEnable":{"type":"boolean","description":"Static routing protocol switch"},"staticMetric":{"type":"integer","description":"Set the metric value to be used as the metric of redistributed routes. It should be within the range of 1-16777214 and the default is equal to Default Metric configured on Basic page.","format":"int32"},"staticMetricType":{"type":"integer","description":"Set the OSPF metric type of redistributed routes. It should be a value as follows: 1: External Type 1, 2: External Type 2. The default is External Type 2.","format":"int32"},"connectedEnable":{"type":"boolean","description":"Direct connection routing protocol switch"},"connectedMetric":{"type":"integer","description":"Set the metric value to be used as the metric of redistributed routes. It should be within the range of 1-16777214 and the default is equal to Default Metric configured on Basic page.","format":"int32"},"connectedMetricType":{"type":"integer","description":"Set the OSPF metric type of redistributed routes. It should be a value as follows: 1: External Type 1, 2: External Type 2. The default is External Type 2.","format":"int32"},"autoCostEnable":{"type":"boolean","description":"enable Auto-Cost Reference Bandwidth."},"autoCost":{"type":"integer","description":"Auto-Cost Reference Bandwidth.","format":"int32"},"vrfId":{"type":"string","description":"VRF ID."},"areaList":{"maxItems":16,"minItems":0,"type":"array","description":" Up to 16 entries are allowed for the areaList.","items":{"$ref":"#/components/schemas/OspfProcessAreaOpenApiVO"}}}},"OspfInterfaceConfigOpenApiVO":{"required":["cost","deviceName","mac"],"type":"object","properties":{"deviceName":{"type":"string","description":"Device Name"},"mac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"Device Mac"},"type":{"type":"integer","description":"OSPF Interface type, 0: VLAN interface; 1: Loopback interface. If null, defaults to VLAN interface (0).","format":"int32"},"vlanInterfaceId":{"type":"string","description":"Vlan Interface ID. Not Null when type is 0."},"vlanInterfaceName":{"type":"string","description":"Vlan Interface Name. Not Null when type is 0."},"vlanId":{"type":"integer","description":"Vlan ID should be within the range of 1–4094. Not Null when type is 0.","format":"int32"},"loopbackInterfaceId":{"type":"string","description":"Loopback Interface ID. Not Null when type is 1."},"loopbackId":{"type":"integer","description":"Loopback ID should be within the range of 1-64. Not Null when type is 1.","format":"int32"},"cost":{"type":"integer","description":"The link cost. OSPF uses this value in computing shortest paths. It should be within the range of 1–65535.","format":"int32"},"networkType":{"type":"integer","description":"Network Type. Not Null when type is 0. It should be a value as follows: 0: Broadcast, 1: Non-Broadcast, 2: Point-to-Multipoint, 3: Point-to-Point. The default network type for Ethernet interfaces is broadcast.","format":"int32"},"passiveEnable":{"type":"boolean","description":"enable passive interface."},"helloInterval":{"type":"integer","description":"The hello interval for the specified interface in seconds. Not Null when type is 0. This parameter must be the same for all routers attached to a network. It should be within the range of 1-65535 seconds and the default is 10 seconds.","format":"int32"},"deadInterval":{"type":"integer","description":"The dead interval for the specified interface in seconds. This specifies how long a router will wait to see a neighbor router's Hello packets before declaring that the router is down. This parameter must be the same for all routers attached to a network. It should be within the range of 1-65535 seconds and the default is 40.","format":"int32"},"authenticationType":{"type":"integer","description":"Authentication Type. Not Null when type is 0. It should be a value as follows: 0: None, 1: Simple, 2: MD5.","format":"int32"},"simpleKey":{"maxLength":8,"minLength":1,"type":"string","description":"Displays the key used for simple authentication, its value should be within the range of 1-8."},"md5KeyId":{"type":"integer","description":"Displays the key ID used for md5 authentication, its value should be within the range of 1-255.","format":"int32"},"md5Key":{"maxLength":16,"minLength":1,"type":"string","description":"Displays the key used for md5 authentication, its value should be within the range of 1-16."}}},"PortForwardingConfig":{"required":["dMZ","forwardIp","from","name","status"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name, name should contain 1 to 64 characters."},"status":{"type":"boolean","description":"Port-forwarding enable status."},"from":{"type":"integer","description":"From corresponds with source IP in web. From should be a value as follows: 0: where; 1: limited address","format":"int32"},"limitedAddresses":{"type":"array","description":"Only for limited address","items":{"type":"string","description":"Only for limited address"}},"interfaceWanPortId":{"type":"array","description":"This field represents WAN port ID. WAN port ID can be obtained from can be obtained from 'Get internet basic info' interface.","items":{"type":"string","description":"This field represents WAN port ID. WAN port ID can be obtained from can be obtained from 'Get internet basic info' interface."}},"virtualWanId":{"type":"array","description":"This field represents Virtual Wan ID. Virtual Wan Id can be obtained from 'Query available virtual WAN list'","items":{"type":"string","description":"This field represents Virtual Wan ID. Virtual Wan Id can be obtained from 'Query available virtual WAN list'"}},"existVirtualWan":{"type":"boolean","description":"Whether Virtual Wan has been configured in current Port Forwarding."},"wanIps":{"type":"array","description":"WAN IPs. Wan IPs can be obtained from 'Get internet ports config' interface","items":{"$ref":"#/components/schemas/PortIpOpenApiVO"}},"existWanIp":{"type":"boolean","description":"Whether WAN IP has been configured in current Port Forwarding. "},"externalPort":{"pattern":"^(([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5]))|((([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5]))-(([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5])))$","type":"string","description":"External port corresponds with source port in web. External port should be within the range of 1–65535. Must be filled in when DMS is false."},"forwardIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Forward IP corresponds with destination IP in web. Forward IP"},"forwardPort":{"pattern":"^(([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5]))|((([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5]))-(([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5])))$","type":"string","description":"Forward port corresponds with destination port in web. Forward port should be 1 or 1-10, within the range of 1–65535. Must be filled in when DMS is false."},"protocol":{"type":"integer","description":"Protocol should be a value as follows: 0: ALL; 1: TCP; 2: UDP. Must be filled in when DMS is false.","format":"int32"},"dMZ":{"type":"boolean","description":"With DMZ enabled, all ports are open and the traffic from external network will be forwarded to the specific destination IP in the LAN."}}},"PortIpOpenApiVO":{"type":"object","properties":{"wanId":{"type":"string","description":"This field represents WAN port ID. WAN port ID can be obtained from can be obtained from 'Get internet basic info' interface."},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP address"}},"description":"WAN IPs. Wan IPs can be obtained from 'Get internet ports config' interface"},"OtoNatOpenApiVO":{"required":["dmz","externalIp","interfaceIds","internalIp","name","status"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name, name should contain 1 to 64 characters."},"status":{"type":"boolean","description":"Status"},"interfaceIds":{"type":"array","description":"This field represents WAN port ID. WAN port ID can be obtained from can be obtained from 'Get internet basic info' interface.","items":{"type":"string","description":"This field represents WAN port ID. WAN port ID can be obtained from can be obtained from 'Get internet basic info' interface."}},"internalIp":{"type":"string","description":"Internal IP"},"externalIp":{"type":"string","description":"External IP"},"dmz":{"type":"boolean","description":"Whether to enable the h323 dmz"},"description":{"pattern":"^$|^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Description should contain 1 to 64 characters."}}},"MlagConfigOpenApiVO":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^[a-zA-z0-9\\_\\-\\@\\:\\/\\.\\+\\#]{1,31}$","type":"string","description":"MLAG group name should be between 1 and 31 characters. Only letters, numbers, and the following symbols are allowed: - . / : @ _ + #"},"membersConfig":{"type":"array","description":"M-LAG group members configuration","items":{"$ref":"#/components/schemas/MlagMemberConfigVO"}}}},"MlagMemberConfigVO":{"required":["dadEnable","mac","peerLinkPorts","priority"],"type":"object","properties":{"mac":{"type":"string","description":"Device Mac."},"priority":{"type":"integer","description":"Priority of the device in the M-LAG group, it must be between 1 and 255.","format":"int32"},"dadEnable":{"type":"boolean","description":"Whether the DAD enable."},"dadLinkPorts":{"type":"array","description":"DAD Link Ports(This parameter is required when DAD is enabled.)","items":{"type":"string","description":"DAD Link Ports(This parameter is required when DAD is enabled.)"}},"dadLocalIp":{"pattern":"^\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b$","type":"string","description":"DAD Local IP"},"dadLocalIpv6":{"pattern":"^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$","type":"string","description":"DAD Local IPv6"},"dadPeerIp":{"pattern":"^\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b$","type":"string","description":"DAD Peer IP"},"dadPeerIpv6":{"pattern":"^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$","type":"string","description":"DAD Peer IPv6"},"peerLinkPorts":{"type":"array","description":"Peer Link Ports(Required parameters)","items":{"type":"string","description":"Peer Link Ports(Required parameters)"}}},"description":"M-LAG group members configuration"},"AutoConfigOpenApiVO":{"required":["location","mobileISP"],"type":"object","properties":{"location":{"type":"integer","description":"Location index, which refers to \"Get location and ISP info\".","format":"int32"},"mobileISP":{"type":"integer","description":"MobileISP index, which refers to \"Get location and ISP info\".","format":"int32"}},"description":"It is required when [configType] is 0."},"DnsConfigOpenApiVO":{"required":["primary"],"type":"object","properties":{"primary":{"type":"string","description":"Primary DNS"},"secondary":{"type":"string","description":"Secondary DNS"}},"description":"It is required when [dnsEnable] is true."},"Ipv4Connection2OpenApiVO":{"required":["secondaryProtoType"],"type":"object","properties":{"secondaryProtoType":{"type":"integer","description":"It should be a value as follows: 0:Static IP; 1:Dynamic IP; 2: None(Only for PPPoE).","format":"int32"},"server":{"type":"string","description":"(Optional) VPN Server/Domain Name. It is required for L2TP/PPTP."},"ipAddress":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"(Optional) It is required when [secondaryProtoType] is 0."},"subnetMask":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"(Optional) It is required when [secondaryProtoType] is 0."},"defaultGateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"(Optional) It is required when [secondaryProtoType] is 0."},"primaryDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"(Optional) It is required when [secondaryProtoType] is 0."},"secondaryDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"(Optional) It is required when [secondaryProtoType] is 0."}}},"Ipv4DhcpOpenApiVO":{"required":["mtu"],"type":"object","properties":{"unicastDhcp":{"type":"boolean","description":"Unicast DHCP"},"primaryDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Primary DNS"},"secondaryDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Secondary DNS"},"hostname":{"pattern":"^[a-zA-Z0-9_-]{0,63}$","type":"string","description":"Host name"},"mtu":{"type":"integer","description":"576-1500, default:1500.","format":"int32"},"wanMultipleIps":{"type":"array","items":{"$ref":"#/components/schemas/WanMultipleIpOpenApiVO"}},"dhcpOptions":{"type":"array","items":{"$ref":"#/components/schemas/WanDhcpOptionOpenApiVO"}}},"description":"It is required when [protoType] is 1."},"Ipv4DsLiteOpenApiVO":{"required":["dslite"],"type":"object","properties":{"dslite":{"type":"integer","description":"Parameter [dslite] should be one of the following values: 0:Auto; 1:Manual; 2:Transix; 3:Xpass; 4:V6 connect.","format":"int32"},"aftrName":{"type":"string","description":"It is required when [dslite] is 1. Address Family Transition Router which should be a domain name or IPV6 address."}},"description":"It is required when [protoType] is 5."},"Ipv4IpoaOpenApiVO":{"required":["defaultGateway","ipAddress","mtu","subnetMask"],"type":"object","properties":{"ipAddress":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP address"},"subnetMask":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string"},"defaultGateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string"},"mtu":{"type":"integer","description":"576-1500, default:1500","format":"int32"},"primaryDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Primary DNS"},"secondaryDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Secondary DNS"},"wanMultipleIps":{"type":"array","items":{"$ref":"#/components/schemas/WanMultipleIpOpenApiVO"}}},"description":"It is required when [protoType] is 8."},"Ipv4L2tpOpenApiVO":{"required":["connectionMode","ipFromIsp","ipv4Connection2","mtu","password","userName"],"type":"object","properties":{"userName":{"pattern":"^[A-Za-z0-9\\`\\~\\!\\@\\#\\$\\&\\*\\(\\)\\-\\=\\_\\+\\[\\]\\{\\}\\;\\:\\'\\\"\\\\\\|\\/\\?\\.\\,\\<\\>\\%\\^\\/]{1,255}$","type":"string"},"password":{"pattern":"^[A-Za-z0-9\\`\\~\\!\\@\\#\\$\\&\\*\\(\\)\\-\\=\\_\\+\\[\\]\\{\\}\\;\\:\\'\\\"\\\\\\|\\/\\?\\.\\,\\<\\>\\%\\^\\/]{1,255}$","type":"string"},"ipFromIsp":{"type":"boolean","description":"Get IP address from ISP."},"primaryDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Primary DNS"},"secondaryDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Secondary DNS"},"connectionMode":{"type":"integer","description":"It should be a value as follows: 0: Connect Automatically; 1: Connect Manually; 2: Time-based.","format":"int32"},"redialInterval":{"type":"integer","description":"It is required when [linkType] is 0. Unit: Second","format":"int32"},"startTime":{"type":"string","description":"It is required when [linkType] is 2. For example, 12:30."},"endTime":{"type":"string","description":"It is required when [linkType] is 2. For example, 12:30."},"mtu":{"type":"integer","description":"576-1500, default:1460","format":"int32"},"mssClampingType":{"type":"integer","description":"0: Disable; 1: Auto; 2: Custom.","format":"int32"},"mssClampingValue":{"type":"integer","description":"It is required when [mssClampingType] is 2, which ranges 532 ~ 1452.","format":"int32"},"ipv4Connection2":{"$ref":"#/components/schemas/Ipv4Connection2OpenApiVO"}},"description":"It is required when [protoType] is 3."},"Ipv4MapEOpenApiVO":{"required":["mape"],"type":"object","properties":{"mape":{"type":"integer","description":"Parameter [mape] should be one of the following values: 0:V6 plus; 1:IPv6 Option; 2:OCN virtual connect.","format":"int32"}},"description":"It is required when [protoType] is 6."},"Ipv4PppoaOpenApiVO":{"required":["connectionMode","ipFromIsp","mru","mssClampingType","mtu","password","userName"],"type":"object","properties":{"userName":{"pattern":"^[A-Za-z0-9\\`\\~\\!\\@\\#\\$\\&\\*\\(\\)\\-\\=\\_\\+\\[\\]\\{\\}\\;\\:\\'\\\"\\\\\\|\\/\\?\\.\\,\\<\\>\\%\\^\\/]{1,255}$","type":"string"},"password":{"pattern":"^[A-Za-z0-9\\`\\~\\!\\@\\#\\$\\&\\*\\(\\)\\-\\=\\_\\+\\[\\]\\{\\}\\;\\:\\'\\\"\\\\\\|\\/\\?\\.\\,\\<\\>\\%\\^\\/]{1,255}$","type":"string"},"ipFromIsp":{"type":"boolean","description":"Get IP address from ISP"},"primaryDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Primary DNS"},"secondaryDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Secondary DNS"},"connectionMode":{"type":"integer","description":"0: Connect Automatically; 1: Connect Manually; 2: Time-based.","format":"int32"},"redialInterval":{"type":"integer","description":"It is required when [linkType] is 0. Unit: Second.","format":"int32"},"startTime":{"type":"string","description":"It is required when [linkType] is 2. For example, 12:30."},"endTime":{"type":"string","description":"It is required when [linkType] is 2. For example, 12:30."},"serviceName":{"pattern":"^[\\041-\\0176]{1,128}$","type":"string","description":"Service Name. Keep it blank unless your ISP requires you to configure it."},"mtu":{"type":"integer","description":"576-1500, default:1492","format":"int32"},"mru":{"type":"integer","description":"576-1500, default:1492","format":"int32"},"mssClampingType":{"type":"integer","description":"It should be a value as follows: 0: Disable, 1: Auto, 2: Custom","format":"int32"},"mssClampingValue":{"type":"integer","description":"(Optional) It is required when [mssClampingType] is 2, which ranges from 532 ~ 1452.","format":"int32"}},"description":"It is required when [protoType] is 7."},"Ipv4PppoeOpenApiVO":{"required":["connectionMode","ipFromIsp","ipv4Connection2","mru","mssClampingType","mtu","password","userName"],"type":"object","properties":{"userName":{"pattern":"^[A-Za-z0-9\\`\\~\\!\\@\\#\\$\\&\\*\\(\\)\\-\\=\\_\\+\\[\\]\\{\\}\\;\\:\\'\\\"\\\\\\|\\/\\?\\.\\,\\<\\>\\%\\^\\/]{1,255}$","type":"string"},"password":{"pattern":"^[A-Za-z0-9\\`\\~\\!\\@\\#\\$\\&\\*\\(\\)\\-\\=\\_\\+\\[\\]\\{\\}\\;\\:\\'\\\"\\\\\\|\\/\\?\\.\\,\\<\\>\\%\\^\\/]{1,255}$","type":"string"},"ipFromIsp":{"type":"boolean","description":"Get IP address from ISP"},"primaryDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Primary DNS"},"secondaryDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Secondary DNS"},"connectionMode":{"type":"integer","description":"0: Connect Automatically; 1: Connect Manually; 2: Time-based.","format":"int32"},"redialInterval":{"type":"integer","description":"It is required when [linkType] is 0. Unit: Second.","format":"int32"},"startTime":{"type":"string","description":"It is required when [linkType] is 2. For example, 12:30."},"endTime":{"type":"string","description":"It is required when [linkType] is 2. For example, 12:30."},"serviceName":{"pattern":"^[\\041-\\0176]{1,128}$","type":"string","description":"Service Name. Keep it blank unless your ISP requires you to configure it."},"mtu":{"type":"integer","description":"576-1500, default:1492","format":"int32"},"mru":{"type":"integer","description":"576-1500, default:1492","format":"int32"},"mssClampingType":{"type":"integer","description":"It should be a value as follows: 0: Disable, 1: Auto, 2: Custom","format":"int32"},"mssClampingValue":{"type":"integer","description":"(Optional) It is required when [mssClampingType] is 2, which ranges from 532 ~ 1452.","format":"int32"},"ipv4Connection2":{"$ref":"#/components/schemas/Ipv4Connection2OpenApiVO"}},"description":"It is required when [protoType] is 2."},"Ipv4PptpOpenApiVO":{"required":["connectionMode","ipFromIsp","ipv4Connection2","mtu","password","userName"],"type":"object","properties":{"userName":{"pattern":"^[A-Za-z0-9\\`\\~\\!\\@\\#\\$\\&\\*\\(\\)\\-\\=\\_\\+\\[\\]\\{\\}\\;\\:\\'\\\"\\\\\\|\\/\\?\\.\\,\\<\\>\\%\\^\\/]{1,255}$","type":"string"},"password":{"pattern":"^[A-Za-z0-9\\`\\~\\!\\@\\#\\$\\&\\*\\(\\)\\-\\=\\_\\+\\[\\]\\{\\}\\;\\:\\'\\\"\\\\\\|\\/\\?\\.\\,\\<\\>\\%\\^\\/]{1,255}$","type":"string"},"ipFromIsp":{"type":"boolean","description":"Get IP address from ISP."},"primaryDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Primary DNS"},"secondaryDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Secondary DNS"},"connectionMode":{"type":"integer","description":"It should be a value as follows: 0: Connect Automatically; 1: Connect Manually; 2: Time-based.","format":"int32"},"redialInterval":{"type":"integer","description":"It is required when [linkType] is 0. Unit: Second","format":"int32"},"startTime":{"type":"string","description":"It is required when [linkType] is 2. For example, 12:30."},"endTime":{"type":"string","description":"It is required when [linkType] is 2. For example, 12:30."},"mtu":{"type":"integer","description":"576-1500, default:1420","format":"int32"},"mssClampingType":{"type":"integer","description":"0: Disable, 1: Auto, 2: Custom","format":"int32"},"mssClampingValue":{"type":"integer","description":"(Optional) It is required when [mssClampingType] is 2, which ranges from 532 ~ 1452.","format":"int32"},"ipv4Connection2":{"$ref":"#/components/schemas/Ipv4Connection2OpenApiVO"}},"description":"It is required when [protoType] is 4."},"Ipv4StaticOpenApiVO":{"required":["defaultGateway","ipAddress","mtu","subnetMask"],"type":"object","properties":{"ipAddress":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP address"},"subnetMask":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string"},"defaultGateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string"},"mtu":{"type":"integer","description":"576-1500, default:1500","format":"int32"},"primaryDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Primary DNS"},"secondaryDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Secondary DNS"},"wanMultipleIps":{"type":"array","items":{"$ref":"#/components/schemas/WanMultipleIpOpenApiVO"}}},"description":"It is required when [protoType] is 0."},"Ipv6DynamicOpenApiVO":{"required":["dnsType","getIpv6Type","prefixEnable"],"type":"object","properties":{"getIpv6Type":{"type":"integer","description":"It should be a value as follows: 0: SLAAC; 1: DHCPv6; 2: specified; 3: auto; 4:non-address.","format":"int32"},"prefixEnable":{"type":"boolean"},"prefixSize":{"type":"integer","description":"It is required when [prefixEnable] is true, which ranges from 48 ~ 64.","format":"int32"},"dnsType":{"type":"integer","description":"DNS Address Type, 0: dynamic, 1: static.","format":"int32"},"primaryDns":{"type":"string","description":"It is required when [dnsType] is 1."},"secondaryDns":{"type":"string","description":"It takes effect when [dnsType] is 1"}},"description":"It is required when protoType is dynamic"},"Ipv6PppoeOpenApiVO":{"required":["dnsType","getIpv6Type","password","pppShare","prefixEnable","userName"],"type":"object","properties":{"pppShare":{"type":"boolean","description":"Share the same PPPoE session with IPv4"},"userName":{"type":"string"},"password":{"type":"string"},"getIpv6Type":{"type":"integer","description":"It should be a value as follows: 0: SLAAC, 1: DHCPv6, 2: specified, 3: auto, 4:non_address, which ranges from 48 ~ 64.","format":"int32"},"prefixEnable":{"type":"boolean"},"prefixSize":{"type":"integer","description":"It is required when [prefixEnable] is true.","format":"int32"},"specificIp":{"type":"string","description":"It is required when [getIpv6Type] is 2."},"dnsType":{"type":"integer","description":"DNS Address Type should be a value as follows: 0: dynamic, 1: static.","format":"int32"},"primaryDns":{"type":"string","description":"It is required when [dnsType] is 1."},"secondaryDns":{"type":"string","description":"It takes effect when [dnsType] is 1."}},"description":"It is required when protoType is PPPoE"},"Ipv6StaticOpenApiVO":{"required":["address","defaultGateway","prefixLen","primaryDns"],"type":"object","properties":{"address":{"type":"string"},"prefixLen":{"type":"integer","description":"It should be within the range of 1–128","format":"int32"},"defaultGateway":{"type":"string"},"primaryDns":{"pattern":"(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\S*$)","type":"string"},"secondaryDns":{"pattern":"(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\S*$)","type":"string"}},"description":"It is required when protoType is static"},"Ipv6TunnelOpenApiVO":{"required":["dnsType"],"type":"object","properties":{"dnsType":{"type":"integer","description":"DNS Address Type should be a value as follows: 0: Get from ISP Dynamically; 1: Static.","format":"int32"},"primaryDns":{"pattern":"(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\S*$)","type":"string","description":"It takes effect when [dnsType] is 1."}},"description":"It is required when protoType is 6to4Tunnel"},"ManuallyConfigOpenApiVO":{"required":["dialNumber"],"type":"object","properties":{"dialNumber":{"type":"string"},"apn":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"}},"description":"It is required when [configType] is 1."},"UsbLteSettingConfigOpenApiVO":{"required":["authType","configType","connectionMode","dnsEnable","mtuSize","portId"],"type":"object","properties":{"portId":{"type":"string","description":"Port ID"},"portDescription":{"type":"string","description":"Port description should contain 1 to 32 characters."},"configType":{"type":"integer","description":"0: Auto; 1：Manually","format":"int32"},"autoConfig":{"$ref":"#/components/schemas/AutoConfigOpenApiVO"},"manuallyConfig":{"$ref":"#/components/schemas/ManuallyConfigOpenApiVO"},"connectionMode":{"type":"integer","description":"1: Connect Automatically, 2: Connect Manually.","format":"int32"},"pin":{"type":"string","description":"It is required when [usbModemMsgId] is 1 or 3."},"authType":{"type":"integer","description":"0:Auto; 1:PAP; 2:CHAP.","format":"int32"},"mtuSize":{"type":"integer","description":"MTU ranges from 576 ~ 1500.","format":"int32"},"dnsEnable":{"type":"boolean","description":"0:off,1:on."},"dhcpOptions":{"type":"array","items":{"$ref":"#/components/schemas/WanDhcpOptionOpenApiVO"}},"dnsConfig":{"$ref":"#/components/schemas/DnsConfigOpenApiVO"}},"description":"USB LTE ports config"},"WanDhcpOptionOpenApiVO":{"type":"object","properties":{"code":{"type":"integer","description":"Dhcp option code","format":"int32"},"type":{"type":"integer","description":"Type should be a value as follows: 0: \"String\"; 1: \"IP Address\"; 2: \"Hex Array\"","format":"int32"},"value":{"type":"string","description":"Dhcp option value"}}},"WanMultipleIpOpenApiVO":{"required":["enable","ip"],"type":"object","properties":{"enable":{"type":"boolean"},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string"}}},"WanPortDslSettingOpenApiVO":{"required":["isp","location","modulationType","portUuid"],"type":"object","properties":{"portName":{"type":"string","description":"Wan port name."},"portUuid":{"type":"string","description":"Wan port UUID."},"portDesc":{"type":"string","description":"Wan port description."},"location":{"type":"string","description":"Your country/region."},"vpi":{"type":"integer","description":"The VPI(0~255) assigned by your ISP to specify the virtual path between endpoints in an ATM network.","format":"int32"},"vci":{"type":"integer","description":"The VCI(1~65535) assigned by your ISP to specify the virtual channel endpoints in an ATM network.","format":"int32"},"encapMode":{"type":"integer","description":"Encap mode assigned by your ISP. 0: LLC, 1: VC-MUX, 2: VC/MUX, 3: 1483 Bridged IP LLC, 4: 1483 Routed IP LLC","format":"int32"},"merEnable":{"type":"boolean","description":"If your ISP requires MER for network connection(e.g., Sky VDSL).MER switch configuration, only configurable when in VDSL mode and DHCP dial-up mode."},"merUsername":{"pattern":"^[^\\s]{1,63}$","type":"string","description":"MER username configuration, only configurable when in VDSL mode and DHCP dial-up mode."},"merPassword":{"pattern":"^[^\\s]{1,63}$","type":"string","description":"MER password configuration, only configurable when in VDSL mode and DHCP dial-up mode."},"isp":{"type":"integer","description":"Your ISP (Internet Service Provider) from the drop-down list,Select Other to customize the settings.","format":"int32"},"modulationType":{"type":"integer","description":"The modulation type used for your DSL connection. 0: VDSL, 1: ADSL.","format":"int32"}},"description":"DSL settings. Only for DSL WAN."},"WanPortIpv4SettingOpenApiVO":{"required":["protoType","qosTagEnable","vlanId"],"type":"object","properties":{"protoType":{"type":"integer","description":"IPv4 connection type should be one of the following values: 0:static; 1:DHCP; 2:PPPoE; 3:L2TP; 4:PPTP; 5:DS-Lite; 6:MAP-E.","format":"int32"},"vlanId":{"type":"integer","description":"VLAN ID should be within the range of 0–4094, 0 means disable.","format":"int32"},"qosTagEnable":{"type":"boolean","description":"802.1Q Tag. It takes effect when [vlanId] is not 0."},"vlanPriority":{"type":"integer","description":"Vlan Priority. It takes effect when [vlanId] is not 0, and it should be within the range of 0–7.","format":"int32"},"ipv4Static":{"$ref":"#/components/schemas/Ipv4StaticOpenApiVO"},"ipv4Dhcp":{"$ref":"#/components/schemas/Ipv4DhcpOpenApiVO"},"ipv4Pppoe":{"$ref":"#/components/schemas/Ipv4PppoeOpenApiVO"},"ipv4L2tp":{"$ref":"#/components/schemas/Ipv4L2tpOpenApiVO"},"ipv4Pptp":{"$ref":"#/components/schemas/Ipv4PptpOpenApiVO"},"ipv4Dslite":{"$ref":"#/components/schemas/Ipv4DsLiteOpenApiVO"},"ipv4Mape":{"$ref":"#/components/schemas/Ipv4MapEOpenApiVO"},"ipv4Pppoa":{"$ref":"#/components/schemas/Ipv4PppoaOpenApiVO"},"ipv4Ipoa":{"$ref":"#/components/schemas/Ipv4IpoaOpenApiVO"}},"description":"Port IPv4 setting"},"WanPortIpv6SettingOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"IPv6 enable."},"protoType":{"type":"integer","description":"IPv6 connection type should be a value as follows: 0: static; 1: dynamic; 2: PPPoE; 3: 6to4Tunnel; 4: bridge.","format":"int32"},"ipv6Dynamic":{"$ref":"#/components/schemas/Ipv6DynamicOpenApiVO"},"ipv6Pppoe":{"$ref":"#/components/schemas/Ipv6PppoeOpenApiVO"},"ipv6Tunnel":{"$ref":"#/components/schemas/Ipv6TunnelOpenApiVO"},"ipv6Static":{"$ref":"#/components/schemas/Ipv6StaticOpenApiVO"}},"description":"Port IPv6 setting"},"WanPortMacSettingOpenApiVO":{"required":["method"],"type":"object","properties":{"method":{"type":"integer","description":"Method of obtaining MAC address. 0：Use Default MAC address; 1: Customize MAC Address.","format":"int32"},"mac":{"type":"string","description":"It is required when [method] is 1."}},"description":"Port MAC setting"},"WanPortSettingOpenApiVO":{"required":["portId","wanPortIpv4Setting","wanPortIpv6Setting","wanPortMacSetting"],"type":"object","properties":{"portId":{"type":"string","description":"Port ID"},"portName":{"type":"string","description":"Port name"},"portDescription":{"type":"string","description":"Port description should contain 1 to 32 characters."},"wanPortIpv4Setting":{"$ref":"#/components/schemas/WanPortIpv4SettingOpenApiVO"},"wanPortIpv6Setting":{"$ref":"#/components/schemas/WanPortIpv6SettingOpenApiVO"},"wanPortMacSetting":{"$ref":"#/components/schemas/WanPortMacSettingOpenApiVO"},"dslSetting":{"$ref":"#/components/schemas/WanPortDslSettingOpenApiVO"}},"description":"WAN ports config"},"WanSettingConfigOpenApiVO":{"type":"object","properties":{"wanPortsConfig":{"type":"array","description":"WAN ports config","items":{"$ref":"#/components/schemas/WanPortSettingOpenApiVO"}},"UsbPortsConfig":{"type":"array","description":"USB LTE ports config","items":{"$ref":"#/components/schemas/UsbLteSettingConfigOpenApiVO"}}}},"DialupSettingOpenApiVO":{"required":["apnMode","networkSearch"],"type":"object","properties":{"networkSearch":{"type":"integer","description":"Network search mode should be a value as follows: 0: auto; 1: manual.","format":"int32"},"isp":{"type":"string","description":"Only for networkSearch mode manual and the ISP from the scan result must be available."},"ispNum":{"type":"integer","description":"Only for networkSearch mode manual and the ISP from the scan result must be available.","format":"int32"},"apnMode":{"type":"integer","description":"Apn mode should be a value as follows: 0: auto; 1: manual.","format":"int32"},"apn":{"type":"string","description":"APN profile ID, only for apnMode manual"}},"description":"Second SIM card's dial-up setting"},"LteWanPortSettingConfigOpenApiVO":{"required":["dataRoaming","dialupSetting","mobileData","networkMode","portId"],"type":"object","properties":{"portId":{"type":"string","description":"Port ID"},"portDescription":{"type":"string","description":"Port description should contain 1 to 32 characters."},"simPriority":{"type":"integer","description":"Set which SIM card is used first. SIM Priority takes effect only when the device is powered on and the priority is changed. If only one SIM card is inserted, this card is used by default.","format":"int32"},"mobileData":{"type":"boolean","description":"mobile data"},"dataRoaming":{"type":"boolean","description":"First SIM card's data roaming"},"networkMode":{"type":"integer","description":"First SIM card's networkMode: 1:3G Only, 2:4G Only, 3:4G Preferred4: 5G-NSA/4G, 5: 5G-SA, 6: 5G/4G/3G","format":"int32"},"bandMode":{"type":"integer","description":"First SIM card's bandMode: 0:auto, 1:manual, only for networkMode 4g Only and 4G Preferred","format":"int32"},"bands":{"type":"array","description":"First SIM card's bands. Only for band mode manual","items":{"type":"string","description":"First SIM card's bands. Only for band mode manual"}},"bands5g":{"type":"array","description":"First SIM card's. Only for band mode manual","items":{"type":"string","description":"First SIM card's. Only for band mode manual"}},"dialupSetting":{"$ref":"#/components/schemas/DialupSettingOpenApiVO"},"failoverTimeout":{"type":"integer","description":"First SIM card's failoverTimeout. Set the dial-up timeout (100 to 3552 seconds). If the connection is not successfully established within the specified time, the gateway will use the other SIM card to connect to the internet.","format":"int32"},"dataRoaming2":{"type":"boolean","description":"Second SIM card's data roaming"},"networkMode2":{"type":"integer","description":"Second SIM card's networkMode: 1:3G Only, 2:4G Only, 3:4G Preferred4: 5G-NSA/4G, 5: 5G-SA, 6: 5G/4G/3G","format":"int32"},"bandMode2":{"type":"integer","description":"Second SIM card's bandMode: 0:auto, 1:manual, only for networkMode 4g Only and 4G Preferred","format":"int32"},"bands2":{"type":"array","description":"Second SIM card's bands. Only for band mode manual","items":{"type":"string","description":"Second SIM card's bands. Only for band mode manual"}},"bands5g2":{"type":"array","description":"Second SIM card's. Only for band mode manual","items":{"type":"string","description":"Second SIM card's. Only for band mode manual"}},"dialupSetting2":{"$ref":"#/components/schemas/DialupSettingOpenApiVO"},"failoverTimeout2":{"type":"integer","description":"Second SIM card's failoverTimeout. Set the dial-up timeout (100 to 3552 seconds). If the connection is not successfully established within the specified time, the gateway will use the other SIM card to connect to the internet.","format":"int32"}}},"InternetBaseConfigOpenApiVO":{"required":["preConfiguration","wanPortList"],"type":"object","properties":{"preConfiguration":{"type":"boolean","description":"All port and port-related(like ACL) configuration will take effect only when the parameter [preConfiguration] is true. The value will always be true when a gateway is in this site."},"wanPortList":{"type":"array","description":"List of enabled WAN port IDs, the valid port IDs can be obtained from \"Get internet basic info\".","items":{"type":"string","description":"List of enabled WAN port IDs, the valid port IDs can be obtained from \"Get internet basic info\"."}},"interval":{"type":"integer","description":"Online detection interval(second). 0 means disable. It should be within the range of 0–3600.","format":"int32"}}},"RemoveBlackListOpenApiVO":{"type":"object","properties":{"stationMac":{"type":"string","description":"MAC address of the device."}}},"OsgLtePinOpenApiVO":{"type":"object","properties":{"type":{"type":"integer","description":"Type of change: 1: Changing the PIN setting, 2: Changing the PIN code.","format":"int32"},"firstTry":{"type":"boolean","description":"Whether the first attempt was successful."},"pinCode":{"type":"string","description":"PIN code."},"pukCode":{"type":"string","description":"PUK code."},"newPinCode":{"type":"string","description":"New PIN code"},"pinSetting":{"$ref":"#/components/schemas/OsgLtePinSettingOpenApiVO"},"simCard":{"type":"integer","description":"When the device supports Dual-SIM card, parameter [simCard] should not be null.1: SIM1; 2: SIM2.","format":"int32"}}},"OsgLtePinSettingOpenApiVO":{"type":"object","properties":{"cardStatus":{"type":"integer","description":"cardStatus: 0:no_sim, 1:unknown, 2:pin_lock, 3:pin_verified, 4:ready, 5:puk_lock, 6:blocked","format":"int32"},"pinLock":{"type":"boolean","description":"Whether the PIN has a lock or not."},"autoUnLock":{"type":"boolean","description":"Whether or not PIN is automatically unlocked."},"simCardUsed":{"type":"integer","description":"When the device supports Dual-SIM card, parameter [simCardUsed] should not be null.1: SIM1; 2: SIM2.","format":"int32"}},"description":"PIN settings."},"OperationResponseOsgLtePinLockResultOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OsgLtePinLockResultOpenApiVO"}}},"OsgLtePinLockResultOpenApiVO":{"type":"object","properties":{"tryPinLimit":{"type":"integer","description":"The number of times PIN code can be tried.","format":"int32"},"tryPinResult":{"type":"boolean","description":"The result of trying the PIN."},"tryPukLimit":{"type":"integer","description":"The number of times PUK code can be tried","format":"int32"},"tryPukResult":{"type":"boolean","description":"The result of trying the PUK."}}},"DialupSettingOpenApiV2VO":{"required":["apnMode","dataRoaming","networkMode","networkSearch"],"type":"object","properties":{"networkSearch":{"type":"integer","description":"Network search mode should be a value as follows: 0: auto; 1: manual.","format":"int32"},"isp":{"type":"string","description":"Only for networkSearch mode manual."},"ispNum":{"type":"integer","description":"Only for networkSearch mode manual.","format":"int32"},"apnMode":{"type":"integer","description":"Apn mode should be a value as follows: 0: auto; 1: manual.","format":"int32"},"apn":{"type":"string","description":"APN profile ID, only for apnMode manual"},"failoverTimeout":{"type":"integer","description":"SIM card's failoverTimeout. Set the dial-up timeout (100 to 3552 seconds). If the connection is not successfully established within the specified time, the gateway will use the other SIM card to connect to the internet.","format":"int32"},"dataRoaming":{"type":"boolean","description":"SIM card's data roaming"},"networkMode":{"type":"integer","description":"SIM card's networkMode: 1:3G Only, 2:4G Only, 3:4G Preferred4: 5G-NSA/4G, 5: 5G-SA, 6: 5G/4G/3G","format":"int32"},"bandMode":{"type":"integer","description":"SIM card's bandMode: 0:auto, 1:manual, only for networkMode 4g Only and 4G Preferred","format":"int32"},"bands":{"type":"array","description":"SIM card's 5g bands. Only for band mode manual","items":{"type":"string","description":"SIM card's 5g bands. Only for band mode manual"}}},"description":"Second SIM card's dial-up setting"},"LteWanPortSettingConfigOpenApiV2VO":{"required":["dialupSetting","mobileData","portUuid"],"type":"object","properties":{"portUuid":{"type":"string","description":"Port Uuid"},"portDesc":{"type":"string","description":"Port description should contain 1 to 32 characters."},"simPriority":{"type":"integer","description":"Set which SIM card is used first. SIM Priority takes effect only when the device is powered on and the priority is changed. If only one SIM card is inserted, this card is used by default.","format":"int32"},"mobileData":{"type":"boolean","description":"mobile data"},"dialupSetting":{"$ref":"#/components/schemas/DialupSettingOpenApiV2VO"},"dialupSetting2":{"$ref":"#/components/schemas/DialupSettingOpenApiV2VO"}}},"DeviceLocationDetailVO":{"type":"object","properties":{"longitude":{"type":"number","description":"Longitude of the device.","format":"double"},"latitude":{"type":"number","description":"Latitude of the device.","format":"double"},"address":{"type":"string","description":"Address of the device."},"timestamp":{"type":"integer","description":"Last GPS fix timestamp","format":"int64"}},"description":"Device location"},"GatewayGeneralConfig":{"required":["ledSetting"],"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"Device name should contain 1 to 128 characters."},"ledSetting":{"type":"integer","description":"Led setting should be a value as follows: 0:off; 1:on; 2:Use Site Settings","format":"int32"},"tagIds":{"type":"array","description":"Tag IDs","items":{"type":"string","description":"Tag IDs"}},"location":{"$ref":"#/components/schemas/DeviceLocationDetailVO"},"snmp":{"$ref":"#/components/schemas/OsgSnmpOpenApiVO"},"rememberDevice":{"type":"integer","format":"int32"}}},"DeviceReplaceSettingVO":{"required":["destinationDeviceKey"],"type":"object","properties":{"destinationDeviceKey":{"type":"string","description":"Device Key of the device."},"username":{"pattern":"^[\\041-\\0176]{1,64}$","type":"string","description":"User Name."},"password":{"pattern":"^[\\041-\\0176]{1,64}$","type":"string","description":"password."}}},"DeviceAccountSettingOpenApiVO":{"required":["password","username"],"type":"object","properties":{"username":{"pattern":"^[\\041-\\0176]{1,64}$","type":"string","description":"Device account username should contain 1 to 64 ASCII characters."},"password":{"pattern":"^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[\\!\\#\\$\\%\\&\\'\\(\\)\\*\\+\\,\\-\\.\\/\\:\\;\\<\\=\\>\\@\\[\\\\\\]\\^\\_\\`\\{\\|\\}\\~])(?!.*[\\00-\\040\\042\\077\\0177]).{10,64}$","type":"string","description":"Device account parameter [password] should contain 10 to 64 ASCII characters. And passwords must be a combination of uppercase letters, lowercase letters, numbers, and special symbols. Symbols such as ! # $ % & * @ ^ are supported.\nThe password should not contain consecutive identical characters.\nUsername and Password should not be the same."}}},"EasyManagedSwitchBatchLoopbackControl":{"required":["switchMacList"],"type":"object","properties":{"switchMacList":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Parameter [switchMacList] should contain at least one switch MAC","items":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Parameter [switchMacList] should contain at least one switch MAC"}},"loopbackDetectEnable":{"type":"boolean","description":"LoopbackDetectEnable"},"stp":{"type":"integer","description":"STP should be a value as follows: 0: OFF 1: STP 2: RSTP 3: MSTP ","format":"int32"},"priority":{"type":"integer","description":"priority","format":"int32"}}},"SwitchBatchLoopbackControl":{"required":["switchMacList"],"type":"object","properties":{"switchMacList":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Parameter [switchMacList] should contain at least one switch MAC","items":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Parameter [switchMacList] should contain at least one switch MAC"}},"loopbackDetectEnable":{"type":"boolean","description":"LoopbackDetectEnable"},"stp":{"type":"integer","description":"STP should be a value as follows: 0: OFF 1: STP 2: RSTP 3: MSTP","format":"int32"},"priority":{"type":"integer","description":"Parameter [priority] should be an integer from 0 to 61440 and divisible by 4096.","format":"int32"},"helloTime":{"type":"integer","description":"helloTime should be between 1 and 10.","format":"int32"},"maxAge":{"type":"integer","description":"maxAge should be between 6 and 40.","format":"int32"},"forwardDelay":{"type":"integer","description":"forwardDelay should be between 4 and 30.","format":"int32"},"txHoldCount":{"type":"integer","description":"txHoldCount should be between 1 and 20.","format":"int32"},"maxHops":{"type":"integer","description":"maxHops should be between 1 and 40.","format":"int32"},"mstp":{"$ref":"#/components/schemas/OswStpMstpConfigOpenApiVO"}}},"BatchUpdateApPowerSavingConfigOpenApiVO":{"required":["apMacList"],"type":"object","properties":{"apMacList":{"type":"array","description":"AP mac list","items":{"type":"string","description":"AP mac list"}},"mode":{"type":"integer","description":"Parameter [mode] is Power Saving Mode of device and should not be null. 0: OFF, 1: Standard( based on the user‑specified time and/or band settings ), 2: Smart, 3: Deep Power‑Saving","format":"int32"},"timeEnable":{"type":"boolean","description":"Power Saving trigger by time config status. True: enable, false: disable."},"startTimeH":{"type":"integer","description":"Start time of trigger by time(unit: hour); It should be within the range of 0–23; This field is required when Parameter [timeEnable] is true.","format":"int32"},"startTimeM":{"type":"integer","description":"Start time of trigger by time(unit: minute); It should be within the range of 0–59; This field is required when Parameter [timeEnable] is true.","format":"int32"},"endTimeH":{"type":"integer","description":"End time of trigger by time(unit: hour); It should be within the range of 0–23; This field is required when Parameter [timeEnable] is true.","format":"int32"},"endTimeM":{"type":"integer","description":"End time of trigger by time(unit: minute); It should be within the range of 0–59; This field is required when Parameter [timeEnable] is true.","format":"int32"},"bandEnable":{"type":"boolean","description":"Parameter [bandEnable] can be TRUE only when [mode] = 1. Power Saving trigger by band config status. True: enable, false: disable."},"bands":{"type":"array","description":"Select bands list config of trigger by band;It should be a value as follows: 0: 2.4GHz; 1: 5GHz; 2: 5G2Hz; 3: 6GHz;This field is required when Parameter [bandEnable] is true;Please note that the band filled in must be supported by the device, otherwise the modified configuration will not take effect properly","items":{"type":"integer","description":"Select bands list config of trigger by band;It should be a value as follows: 0: 2.4GHz; 1: 5GHz; 2: 5G2Hz; 3: 6GHz;This field is required when Parameter [bandEnable] is true;Please note that the band filled in must be supported by the device, otherwise the modified configuration will not take effect properly","format":"int32"}},"idleDuration":{"type":"integer","description":"Idle duration config of trigger by band(unit: minute); It should be within the range of 60–1440; This field is required when Parameter [bandEnable] is true.","format":"int32"}}},"AntSwitchRadioConfig":{"type":"object","properties":{"antMode":{"type":"integer","description":"antenna mode in radio setting. 0:Auto, 1: Built-In, 2: Omni","format":"int32"},"antGain":{"type":"integer","description":"antenna Gain","format":"int32"}}},"BatchUpdateApAntSwitchOpenApiVO":{"type":"object","properties":{"apMacList":{"type":"array","items":{"type":"string"}},"antMode":{"type":"integer","format":"int32"},"antSetting2g":{"$ref":"#/components/schemas/AntSwitchRadioConfig"},"antSetting5g":{"$ref":"#/components/schemas/AntSwitchRadioConfig"},"antSetting5g2":{"$ref":"#/components/schemas/AntSwitchRadioConfig"},"antSetting6g":{"$ref":"#/components/schemas/AntSwitchRadioConfig"}}},"ApUplinkConfigOpenApiVO":{"required":["auto"],"type":"object","properties":{"auto":{"type":"boolean","description":"uplink auto"},"port":{"type":"string","description":"port id"}}},"UpdateApPowerSavingConfigOpenApiVO":{"type":"object","properties":{"mode":{"type":"integer","description":"Parameter [mode] is Power Saving Mode of device and should not be null. 0: OFF, 1: Standard( based on the user‑specified time and/or band settings ), 2: Smart, 3: Deep Power‑Saving","format":"int32"},"timeEnable":{"type":"boolean","description":"Parameter [timeEnable] can be TRUE only when [mode] = 1. Power Saving trigger by time config status. True: enable, false: disable."},"startTimeH":{"type":"integer","description":"Start time of trigger by time(unit: hour); It should be within the range of 0–23; This field is required when Parameter [timeEnable] is true.","format":"int32"},"startTimeM":{"type":"integer","description":"Start time of trigger by time(unit: minute); It should be within the range of 0–59; This field is required when Parameter [timeEnable] is true.","format":"int32"},"endTimeH":{"type":"integer","description":"End time of trigger by time(unit: hour); It should be within the range of 0–23; This field is required when Parameter [timeEnable] is true.","format":"int32"},"endTimeM":{"type":"integer","description":"End time of trigger by time(unit: minute); It should be within the range of 0–59; This field is required when Parameter [timeEnable] is true.","format":"int32"},"bandEnable":{"type":"boolean","description":"Parameter [bandEnable] can be TRUE only when [mode] = 1. Power Saving trigger by band config status. True: enable, false: disable."},"bands":{"type":"array","description":"Select bands list config of trigger by band;It should be a value as follows: 0: 2.4GHz; 1: 5GHz; 2: 5G2Hz; 3: 6GHz;This field is required when Parameter [bandEnable] is true;Please note that the band filled in must be supported by the device, otherwise the modified configuration will not take effect properly","items":{"type":"integer","description":"Select bands list config of trigger by band;It should be a value as follows: 0: 2.4GHz; 1: 5GHz; 2: 5G2Hz; 3: 6GHz;This field is required when Parameter [bandEnable] is true;Please note that the band filled in must be supported by the device, otherwise the modified configuration will not take effect properly","format":"int32"}},"idleDuration":{"type":"integer","description":"Idle duration config of trigger by band(unit: minute); It should be within the range of 60–1440; This field is required when Parameter [bandEnable] is true.","format":"int32"}}},"ApManagementSsidConfig":{"required":["broadcast","name","security","status"],"type":"object","properties":{"status":{"type":"boolean","description":"SSID config status. True: enable, false: disable."},"name":{"type":"string","description":"SSID name. It should contain 1 to 32 UTF-8 characters."},"security":{"type":"integer","description":"SSID security mode; Security should be a value as follows: 0: None; 2: WPA-Enterprise; 3: WPA-Personal. ","format":"int32"},"broadcast":{"type":"boolean","description":"SSID broadcast config status. True: enable, false: disable."},"pskSetting":{"$ref":"#/components/schemas/ApMgtSsidPskSettingOpenApiVO"},"entSetting":{"$ref":"#/components/schemas/ApMgtSsidEnterpriseSettingOpenApiVO"},"vlanSetting":{"$ref":"#/components/schemas/ApMgtSsidVlanSettingOpenApiVO"}}},"ApMgtSsidEnterpriseSettingOpenApiVO":{"required":["encryptionEnt","radiusProfileId","versionEnt"],"type":"object","properties":{"radiusProfileId":{"type":"string","description":"This field represents RADIUS Profile ID. RADIUS Profile(RADIUS Profile Template) can be created using Create a new RADIUS profile(Create a new RADIUS profile template) interface, and RADIUS Profile ID(RADIUS Profile Template ID) can be obtained from Get RADIUS profile list(Get RADIUS profile template list) interface."},"versionEnt":{"type":"integer","description":"WPA-Enterprise version. This is necessary when the value of security is 2(WPA-Enterprise); It should be a value as follows: 1: WPA-Enterprise; 2: WPA2-Enterprise; 3: WPA/WPA2-Enterprise.","format":"int32"},"encryptionEnt":{"type":"integer","description":"WPA-Enterprise encryption. This is necessary when the value of security is 2(WPA-Enterprise); It should be a value as follows: 1: Auto; 3: AES.","format":"int32"}},"description":"WPA-Enterprise SSID config. This is necessary when the value of security is 2(WPA-Enterprise)."},"ApMgtSsidPskSettingOpenApiVO":{"required":["encryptionPsk","securityKey","versionPsk"],"type":"object","properties":{"securityKey":{"type":"string","description":"WPA-Personal SSID password. This is necessary when the value of security is 3(WPA-Personal);It should contain 8-63 printable ASCII characters or 8-63 hexadecimal digits."},"versionPsk":{"type":"integer","description":"WPA-Personal version. This is necessary when the value of security is 3(WPA-Personal); It should be a value as follows: 1: WPA-PSK; 2: WPA2-PSK; 3: WPA/WPA2-PSK.","format":"int32"},"encryptionPsk":{"type":"integer","description":"WPA-Personal encryption. This is necessary when the value of security is 3(WPA-Personal); It should be a value as follows: 1: Auto; 3: AES.","format":"int32"}},"description":"WPA-Personal SSID config. This is necessary when the value of security is 3(WPA-Personal)."},"ApMgtSsidVlanCustomSettingOpenApiVO":{"required":["customMode"],"type":"object","properties":{"customMode":{"type":"integer","description":"If mode=1, this field must be entered.If a device does not support multiple VLANs, the smallest VLAN you configured will be applied to the SSID. customMode should be a value as follows: 0:by Network; 1:by Vlan.","format":"int32"},"lanNetworkId":{"type":"string","description":"lanNetworkId. If support vlan pool, use lanNetworkVlanIds instead. If customMode=1, this filed must be null. If both lanNetwork and lanNetworkVlanIds parameters exist, the vlanId will actually take effect with the lanNetwork with the smallest vlanId in the lanNetworkVlanIds parameter."},"bridgeVlan":{"type":"integer","description":"bridgeVlan. If support vlan pool, use lanNetworkVlanIds instead.  If customMode=1, this filed must be null.","format":"int32"},"vlanId":{"type":"integer","description":"vlanId. If support vlanPool, use vlanPoolIds instead. If customMode=0, this filed must be null. If both the vlanId and vlanPoolIds parameters exist, the vlanId will actually take effect at the minimum value in the vlanPoolIds parameter.","format":"int32"}},"description":"If mode=1, this field must be entered."},"ApMgtSsidVlanSettingOpenApiVO":{"required":["mode"],"type":"object","properties":{"mode":{"type":"integer","description":"should be a value as follows: 0:Default; 1:Custom.","format":"int32"},"customConfig":{"$ref":"#/components/schemas/ApMgtSsidVlanCustomSettingOpenApiVO"}},"description":"SSID VLAN configuration."},"UpdateApTrunkSettingOpenApiVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the device enables LAG. The following situations cause port aggregation to be ineffective: 1. When a specific Uplink Port is selected. 2. When PoE Out is enabled on target ports. 3. When Custom VLAN configurations is configured on target ports. 4. When Status is disabled on target ports."},"mode":{"type":"integer","description":"LAG mode. Mode should be a value as follows: 0：SRC MAC + DST MAC; 1：DST MAC; 2：SRC MAC.","format":"int32"}}},"UpdateChannelLimitConfigOpenApiVO":{"required":["channelLimitType"],"type":"object","properties":{"channelLimitType":{"type":"integer","description":"Channel limit enable status. It should be a value as follows: 0: default, 1: false, 2: true.","format":"int32"}}},"UpdateApChannelConfigOpenApiVO":{"required":["radioEnable","radioId"],"type":"object","properties":{"radioId":{"type":"integer","description":"(Wireless) Radio ID should be a value as follows: 0: 2.4GHz; 1: 5GHz(5GHz-1); 2: 5GHz-2; 3: 6GHz.","format":"int32"},"radioEnable":{"type":"boolean","description":"Enable/Disable radio setting(if false, other params is not required)"},"channel":{"type":"integer","description":"Radios-Channel config; The channel list supported by device can be obtained from interface : Get available channel list of ap; If select auto configuration need to enter 0.","format":"int32"},"channelWidth":{"type":"integer","description":"Radios-Channel width config; The channelWidth list supported by device can be obtained from interface : Get available channel list of ap; If select auto configuration need to enter 0.","format":"int32"}}},"UpdateApAntSwitchConfig":{"type":"object","properties":{"antMode":{"type":"integer","description":"Antenna Mode. 0: Auto, 1: built-In, 2: Omni, 3: Custom","format":"int32"},"antSetting2g":{"$ref":"#/components/schemas/AntSwitchRadioConfig"},"antSetting5g":{"$ref":"#/components/schemas/AntSwitchRadioConfig"},"antSetting5g2":{"$ref":"#/components/schemas/AntSwitchRadioConfig"},"antSetting6g":{"$ref":"#/components/schemas/AntSwitchRadioConfig"}}},"UpdateAfcConfigOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable AFC"}}},"BatchUpdateApLagOpenApiVO":{"required":["apMacList"],"type":"object","properties":{"apMacList":{"type":"array","description":"AP mac list","items":{"type":"string","description":"AP mac list"}},"enable":{"type":"boolean","description":"Whether the device enables LAG. The following situations cause port aggregation to be ineffective: 1. When a specific Uplink Port is selected. 2. When PoE Out is enabled on target ports. 3. When Custom VLAN configurations is configured on target ports. 4. When Status is disabled on target ports."},"mode":{"type":"integer","description":"LAG mode. Mode should be a value as follows: 0：SRC MAC + DST MAC; 1：DST MAC; 2：SRC MAC.","format":"int32"}}},"ApBatchConfigResultVO":{"type":"object","properties":{"configResultList":{"type":"array","description":"Configuration results for devices with partial or complete configuration failures.","items":{"$ref":"#/components/schemas/ApConfigResultVO"}}}},"ApConfigResultBaseSettingVO":{"type":"object","properties":{"errorCode":{"type":"integer","description":"error code.","format":"int32"},"msg":{"type":"string","description":"error msg"}},"description":"vlan tagged setting config result"},"ApConfigResultPortSettingVO":{"type":"object","properties":{"errorCode":{"type":"integer","description":"error code.","format":"int32"},"msg":{"type":"string","description":"error msg"},"lanPort":{"type":"string","description":"lanPort"},"apPortConfigResultSettings":{"$ref":"#/components/schemas/ApPortConfigResultSettingsVO"}},"description":"port setting config result list"},"ApConfigResultRadioSettingVO":{"type":"object","properties":{"errorCode":{"type":"integer","description":"error code.","format":"int32"},"msg":{"type":"string","description":"error msg"},"apRadioConfigResultSetting":{"$ref":"#/components/schemas/ApRadioConfigResultSettingsVO"}},"description":"radio 6g setting config result"},"ApConfigResultSettingsVO":{"type":"object","properties":{"ledSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"rssiLedSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"wifiControlSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"gpsSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"remoteResetSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"disableHwResetSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"enableSlideSwitchSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"lbSetting2g":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"lbSetting5g":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"lbSetting5g1":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"lbSetting5g2":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"lbSetting6g":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"rssiSetting2g":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"rssiSetting5g":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"rssiSetting5g1":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"rssiSetting5g2":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"rssiSetting6g":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"qosSetting2g":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"qosSetting5g":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"qosSetting5g1":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"qosSetting5g2":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"qosSetting6g":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"nonPscSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"ofdmaEnable2g":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"ofdmaEnable5g":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"ofdmaEnable5g1":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"ofdmaEnable5g2":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"ofdmaEnable6g":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"trunkSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"mvlanSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"snmpSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"l3AccessSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"lldpSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"loopbackDetectSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"voipVlanSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"smartAntennaSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"powerSavingSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"antennaGainSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"antSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"antSetting2g":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"antSetting5g":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"antSetting5g2":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"antSetting6g":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"wlanGroupSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"channelLimitSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"afcSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"radioSetting2g":{"$ref":"#/components/schemas/ApConfigResultRadioSettingVO"},"radioSetting5g":{"$ref":"#/components/schemas/ApConfigResultRadioSettingVO"},"radioSetting5g1":{"$ref":"#/components/schemas/ApConfigResultRadioSettingVO"},"radioSetting5g2":{"$ref":"#/components/schemas/ApConfigResultRadioSettingVO"},"radioSetting6g":{"$ref":"#/components/schemas/ApConfigResultRadioSettingVO"},"portSettingList":{"type":"array","description":"port setting config result list","items":{"$ref":"#/components/schemas/ApConfigResultPortSettingVO"}}},"description":"ap config result detail setting."},"ApConfigResultVO":{"type":"object","properties":{"type":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"mac":{"type":"string","description":"Device mac"},"name":{"type":"string","description":"Device name,default value is the mac address of device"},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected;1:Disconnected(Migrating);10:Provisioning;11:Configuring;12:Upgrading;13:Rebooting;14:Connected;15:Connected(Wireless);16:Connected(Migrating);17:Connected(Wireless,Migrating);20:Pending;21:Pending(Wireless);22:Adopting;23:Adopting(Wireless);24:Adopt Failed;25:Adopt Failed(Wireless);26:Managed By Others;27:Managed By Others(Wireless);30:Heartbeat Missed;31:Heartbeat Missed(Wireless);32:Heartbeat Missed(Migrating);33:Heartbeat Missed(Wireless,Migrating);40:Isolated;41:Isolated(Migrating);50:Slice Configuring","format":"int32"},"statusCategory":{"type":"integer","description":"Category of device status,statusCategory should be a value as follows: 0:Disconnected;1:Connected;2:Pending;3:Heartbeat Missed;4:Isolated","format":"int32"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"errorCode":{"type":"integer","description":"error code.","format":"int32"},"msg":{"type":"string","description":"error msg"},"apConfigResultSettings":{"$ref":"#/components/schemas/ApConfigResultSettingsVO"}},"description":"Configuration results for devices with partial or complete configuration failures."},"ApPortConfigResultSettingsVO":{"type":"object","properties":{"statusSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"vlanSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"poeOutSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"bandWidthControlSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"vlanTaggedSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"}},"description":"ap port config result detail setting."},"ApRadioConfigResultSettingsVO":{"type":"object","properties":{"statusSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"wirelessModeSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"channelWidthSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"channel setting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"freq setting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"channelRangeSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"},"txPowerSetting":{"$ref":"#/components/schemas/ApConfigResultBaseSettingVO"}},"description":"ap radio config result detail setting."},"OperationResponseApBatchConfigResultVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApBatchConfigResultVO"}}},"CustomAclOswOpenApiVO":{"required":["mac","vrf"],"type":"object","properties":{"mac":{"type":"string","description":"MAC"},"stackId":{"type":"string","description":"Stack ID"},"vrfId":{"type":"string","description":"VRF ID"},"vrf":{"pattern":"^(?!(\\.|\\.\\.)$)[a-zA-Z0-9.\\-_@+]{1,15}$","type":"string","description":"VRF should be 1 to 15 characters consisting of numbers (0 to 9), uppercase and lowercase letters (A to Z, a to z), and symbols -_@.+ but cannot be . or .. only."}},"description":"Only for bindingType is custom switch vlan, list of selected device"},"Switch ACL ether type entity":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Default:false"},"value":{"pattern":"^[0-9a-fA-F]{4}$","type":"string","description":"Value, if enable is true, value must not be null"}},"description":"Ethertype(4-hex number; 0-9，A-F) is only editable when the Source Type and Destination Type are both selected as MAC Group in the Rule."},"Switch ACL port entity":{"required":["customLagIds","customPortIds","mac","vrf"],"type":"object","properties":{"mac":{"type":"string","description":"MAC"},"stackId":{"type":"string","description":"Stack ID"},"customPortIds":{"uniqueItems":true,"type":"array","description":"Custom port IDs","items":{"type":"integer","description":"Custom port IDs","format":"int32"}},"standardCustomPortIds":{"uniqueItems":true,"type":"array","description":"Custom standard port IDs","items":{"type":"string","description":"Custom standard port IDs"}},"customLagIds":{"uniqueItems":true,"type":"array","description":"Custom lag IDs","items":{"type":"integer","description":"Custom lag IDs","format":"int32"}},"vrfId":{"type":"string","description":"VRF ID"},"vrf":{"pattern":"^(?!(\\.|\\.\\.)$)[a-zA-Z0-9.\\-_@+]{1,15}$","type":"string","description":"VRF should be 1 to 15 characters consisting of numbers (0 to 9), uppercase and lowercase letters (A to Z, a to z), and symbols -_@.+ but cannot be . or .. only."}},"description":"only for bindingType custom ports"},"SwitchACLConfig":{"required":["bindingType","description","destinationType","etherType","policy","protocols","sourceIds","sourceType","status"],"type":"object","properties":{"description":{"pattern":"^[^ ]$|^[^ ].{0,510}[^ ]$","type":"string","description":"ACL rule description, description should contain 1 to 512 characters."},"status":{"type":"boolean","description":"Status should be a value as follows: 0: disable; 1: enable"},"policy":{"type":"integer","description":"Policy should be a value as follows: 0: drop; 1: allow;","format":"int32"},"protocols":{"type":"array","description":"For the values of protocols, refer to section 5.5 of the Open API Access Guide.","items":{"type":"integer","description":"For the values of protocols, refer to section 5.5 of the Open API Access Guide.","format":"int32"}},"sourceIds":{"type":"array","description":"Source IDs, which depends on sourceType, for example: if sourceType is network, sourceIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Source IDs, which depends on sourceType, for example: if sourceType is network, sourceIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."}},"destinationIds":{"type":"array","description":"Source IDs, which depends on destinationType, for example: if destinationType is network, destinationIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Source IDs, which depends on destinationType, for example: if destinationType is network, destinationIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."}},"sourceType":{"type":"integer","description":"SourceType should be a value as follows: 0: network; 1: IP Group; 2: IP-Port Group; 4: SSID; 6: IPv6 Group; 7: IPv6-Port Group","format":"int32"},"destinationType":{"type":"integer","description":"DestinationType should be a value as follows: 0: network; 1: IP Group; 2: IP-Port Group; 6: IPv6 Group; 7: IPv6-Port Group","format":"int32"},"bindingType":{"type":"integer","description":"BindingType should be a value as follows: 0: all ports; 1: custom ports; 2: all switch vlan; 3: custom switch vlan","format":"int32"},"customAclPorts":{"type":"array","description":"Only for bindingType is custom ports, select the custom port or LAG of the device","items":{"$ref":"#/components/schemas/Switch ACL port entity"}},"networkId":{"type":"string","description":"Only for bindingType VLAN"},"bindingBridgeVlan":{"type":"integer","description":"Only for bindingType VLAN and network of bridge VLAN","format":"int32"},"customAclOsws":{"type":"array","description":"Only for bindingType is custom switch vlan, list of selected switch mac","items":{"type":"string","description":"Only for bindingType is custom switch vlan, list of selected switch mac"}},"customAclStacks":{"type":"array","description":"Only for bindingType is custom switch vlan, list of selected stack id","items":{"type":"string","description":"Only for bindingType is custom switch vlan, list of selected stack id"}},"customAclDevices":{"type":"array","description":"Only for bindingType is custom switch vlan, list of selected device","items":{"$ref":"#/components/schemas/CustomAclOswOpenApiVO"}},"etherType":{"$ref":"#/components/schemas/Switch ACL ether type entity"},"timeRangeId":{"type":"string","description":"Time range profile ID"},"biDirectional":{"type":"boolean","description":"Whether to enable the bidirectional, this field required only when creating a new entry"}}},"LanNetworkBrief":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the lan network"},"siteId":{"type":"string","description":"The site ID of the lan network"},"name":{"type":"string","description":"The name of the lan network"},"vlan":{"type":"integer","description":"The vlan number of the lan network","format":"int32"},"vlans":{"type":"string","description":"Batch Vlan IDS."},"purpose":{"type":"string","description":"The purpose of the lan network"},"interfaceIds":{"type":"array","description":"A list of the Interface ID for the lan network","items":{"type":"string","description":"A list of the Interface ID for the lan network"}},"vlanType":{"type":"integer","description":"The type of vlan of the lan network","format":"int32"},"gatewaySubnet":{"type":"string","description":"The Gateway Subnet of the lan network"},"primary":{"type":"boolean","description":"Whether is default lan"},"beginIpLong":{"type":"integer","description":"The long value of the beginning IP of gatewaySubnet","format":"int64"},"endIpLong":{"type":"integer","description":"The long value of the ending IP of gatewaySubnet","format":"int64"},"ipaddrStart":{"type":"string","description":"The starting host IP address of gatewaySubnet"},"ipaddrEnd":{"type":"string","description":"The ending host IP address of gatewaySubnet"},"ipRangeStart":{"type":"integer","description":"The long value of ipaddrStart","format":"int64"},"ipRangeEnd":{"type":"integer","description":"The long value of ipaddrEnd","format":"int64"}},"description":"A list of lan network info for SdWan Member."},"OsgPortStatBrief":{"required":["mode"],"type":"object","properties":{"port":{"type":"integer","description":"The port sequence number of the device.","format":"int32"},"mode":{"type":"integer","description":"The mode whether the port works as a WAN or LAN.","format":"int32"},"name":{"type":"string","description":"The port name of the osg."},"linkStatus":{"type":"integer","description":"The status of link connection.","format":"int32"},"publicIp":{"type":"boolean","description":"Whether the device has a public IP."},"wanIp":{"type":"string","description":"The wan IP of the device."},"portUuid":{"type":"string","description":"The UUID of port."}},"description":"A list of device port status info for SdWan Member."},"SdWanGroup":{"required":["enableNat","memberList","name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the SD-WAN group"},"description":{"type":"string","description":"The description of the SD-WAN group"},"ipPoolStart":{"type":"string","description":"The start of the IP pool of the SD-WAN group, it is recommended to ignore it as it will be generated automatically","deprecated":true},"ipPoolEnd":{"type":"string","description":"The end of the IP pool of the SD-WAN group, it is recommended to ignore it as it will be generated automatically","deprecated":true},"memberList":{"type":"array","description":"A list of members of the SD-WAN group","items":{"$ref":"#/components/schemas/SdWanMemberConfig"}},"linkedSpokes":{"type":"array","description":"A list of linked-spokes of the SD-WAN group","items":{"$ref":"#/components/schemas/SdWanLinkedSpokeConfig"}},"enableNat":{"type":"boolean","description":"Whether the group enable SD-WAN virtual network Map"},"natInfo":{"$ref":"#/components/schemas/SdWanNatInfoConfig"}}},"SdWanLinkedSpokeConfig":{"type":"object","properties":{"deviceMac1":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"The device MAC of one of the two linked-spokes"},"deviceMac2":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"Another device MAC of the two linked-spokes"}},"description":"A list of linked-spokes of the SD-WAN group"},"SdWanMemberConfig":{"required":["deviceMac","role","siteId"],"type":"object","properties":{"role":{"type":"integer","description":"The role of sdWan member, hub or spoke.","format":"int32"},"deviceMac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"The device MAC of the sdWan member."},"siteId":{"type":"string","description":"The ID of the site where the sdWan member is located."},"siteName":{"type":"string","description":"The name of the site where the sdWan member is located."},"wanPortsInfo":{"type":"array","description":"A list of device port status info for SdWan Member.","items":{"$ref":"#/components/schemas/OsgPortStatBrief"}},"lanNetworkInfo":{"type":"array","description":"A list of lan network info for SdWan Member.","items":{"$ref":"#/components/schemas/LanNetworkBrief"}},"publicIp":{"type":"boolean","description":"Whether the sdWan member has a public IP."}},"description":"A list of members of the SD-WAN group"},"SdWanNatInfoConfig":{"type":"object","properties":{"defaultMapNetworkList":{"type":"array","description":"A list of the default mapping network","items":{"type":"string","description":"A list of the default mapping network"}},"customMapNetworkList":{"type":"array","description":"A list of the customized mapping network","items":{"type":"string","description":"A list of the customized mapping network"}},"networkMapList":{"type":"array","description":"A list of the network map item","items":{"$ref":"#/components/schemas/SdWanNatItemConfig"}}},"description":"The NAT info of the SD-WAN group"},"SdWanNatItemConfig":{"required":["gatewaySubnet","siteId"],"type":"object","properties":{"siteId":{"type":"string","description":"The ID of the site"},"lanNetworkId":{"type":"string","description":"The ID of the original network before mapping"},"gatewaySubnet":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\/(?:[0-9]|[1-2][0-9]|3[0-2])$","type":"string","description":"The IP range of the original network before mapping"},"mappedNetwork":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\/(?:[0-9]|[1-2][0-9]|3[0-2])$","type":"string","description":"mapped network"},"networkType":{"type":"integer","description":"Network type, 0/null: LAN network, 1: custom route","format":"int32"}},"description":"A list of the network map item"},"ModifyLanNetworkBrief":{"required":["gatewaySubnet","id","ipaddrEnd","ipaddrStart","name","siteId"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the lan network"},"siteId":{"type":"string","description":"The site ID of the lan network"},"name":{"type":"string","description":"The name of the lan network"},"vlan":{"type":"integer","description":"The vlan number of the lan network","format":"int32"},"gatewaySubnet":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\/(?:[0-9]|[1-2][0-9]|3[0-2])$","type":"string","description":"The Gateway Subnet of the lan network"},"ipaddrStart":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The starting host IP address of gatewaySubnet"},"ipaddrEnd":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The ending host IP address of gatewaySubnet"}}},"ControllerRoleVO":{"type":"object","properties":{"license":{"type":"integer","description":"License permission, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"globalDashboard":{"type":"integer","description":"Dashboard permission in global view. It should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"dashboard":{"type":"integer","description":"Dashboard permission in site view. It should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"devices":{"type":"integer","description":"Devices permission in site view and global view. It should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"adopt":{"type":"integer","description":"Adopt permission should be a value as follows: 0:block; 2:access","format":"int32","deprecated":true},"addDevices":{"type":"integer","description":"Add devices permission should be a value as follows: 0:block; 2:access","format":"int32","deprecated":true},"addAdoptDevice":{"type":"integer","description":"Add and adopt devices permission should be a value as follows: 0:block; 2:access","format":"int32"},"manualUpgrade":{"type":"integer","description":"Manual Upgrade permission should be a value as follows: 0:block; 2:access","format":"int32"},"globalLog":{"type":"integer","description":"Log permission in global view should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"log":{"type":"integer","description":"Log permission in site view should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"licenseBind":{"type":"integer","description":"License bind permission should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"users":{"type":"integer","description":"Users permission in global view should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"roles":{"type":"integer","description":"Roles permission in global view should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"samlUsers":{"type":"integer","description":"Saml users permission in global view should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"samlRoles":{"type":"integer","description":"Saml roles permission in global view should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"samlSsos":{"type":"integer","description":"Saml ssos permission in global view should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"globalSetting":{"type":"integer","description":"Settings permission in global view should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"exportData":{"type":"integer","description":"Export data permission in site view should be a value as follows: 0:block; 2:access","format":"int32"},"globalExportData":{"type":"integer","description":"Export data permission in global view should be a value as follows: 0:block; 2:access","format":"int32"},"exportGlobalLog":{"type":"integer","description":"Export global log data permission in global view should be a value as follows: 0:block; 2:access","format":"int32"},"globalCluster":{"type":"integer","description":"Cluster permission in global view. 0:block; 1:view only; 2:modify","format":"int32"},"hotspot":{"type":"integer","description":"Hotspot permission should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"statics":{"type":"integer","description":"Statics permission in site view should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"map":{"type":"integer","description":"Map permission in site view should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"clients":{"type":"integer","description":"Clients permission in site view should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"insight":{"type":"integer","description":"Insight permission in site view should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"report":{"type":"integer","description":"Network report permission in site view should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"network":{"type":"integer","description":"Site network settings permission in site view -> settings should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32","deprecated":true},"deviceAccount":{"type":"integer","description":"Device account permission in site view -> site settings should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"anomaly":{"type":"integer","description":"Anomaly permission in global view should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"analyze":{"type":"integer","description":"Tools permission in global view. Only for hardware controller should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"siteAnalyze":{"type":"integer","description":"Tools in site view should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"globalSecurity":{"type":"integer","description":"Security permission in global view should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"globalWebhook":{"type":"integer","description":"Webhook in global view should be a value as follows: 0:block; 1:view only; 2:modify, only for pro controller","format":"int32"},"globalMapToken":{"type":"integer","description":"MapToken in global view should be a value as follows: 0:block; 1:view only; 2:modify, only for pro controller","format":"int32"},"siteTemplate":{"type":"integer","description":"SiteTemplate in global view should be a value as follows: 0:block; 1:view only; 2:modify, only for pro controller","format":"int32"},"firmwareManager":{"type":"integer","description":"FirmwareManager in global view should be a value as follows: 0:block; 1:view only; 2:modify, only for pro controller","format":"int32"},"sdWan":{"type":"integer","description":"SD-WAN in global view should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"siteHome":{"type":"integer","description":"Site home permission in site view. 0:block; 1:view only; 2:modify","format":"int32","deprecated":true},"deviceRecovery":{"type":"integer","description":"Device recovery permission in site view. 0:block; 1:view only; 2:modify","format":"int32"},"siteNetwork":{"type":"integer","description":"Network config page permission in site view. 0:block; 1:view only; 2:modify","format":"int32"},"siteDevice":{"type":"integer","description":"Device config page permission in site view. 0:block; 1:view only; 2:modify","format":"int32"},"siteMaintain":{"type":"integer","description":"Maintenance page permission in site view. 0:block; 1:view only; 2:modify","format":"int32"},"aiAssi":{"type":"integer","description":"AI assistant permission. 0:block; 1:view only; 2:modify","format":"int32"}},"description":"Role privilege"},"ModifyControllerRoleVO":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"Role name should contain 1 to 128 characters."},"privilege":{"$ref":"#/components/schemas/ControllerRoleVO"}}},"ModifyMspUserVO":{"required":["allCustomer","customerRoleId","name","roleId"],"type":"object","properties":{"name":{"pattern":"^(?![+=@-])[\\041-\\0176]$|^(?![+=@-])[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"User name. When creating cloud user, you should set TP-LINK ID. It should contain 1 to 128 ASCII characters and start with letters, numbers, and underscores."},"password":{"pattern":"^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[\\!\\#\\$\\%\\&\\'\\(\\)\\*\\+\\,\\-\\.\\/\\:\\;\\<\\=\\>\\@\\[\\\\\\]\\^\\_\\`\\{\\|\\}\\~])(?!.*[\\00-\\040\\042\\077\\0177]).{8,128}$","type":"string","description":"Password of local user. User can only modify his child local user's password. It should contain 8 to 128 ASCII characters.And password must be a combination of uppercase letters, lowercase letters, numbers, and special symbols. Symbols such as ! # $ % & * @ ^ are supported."},"email":{"type":"string","description":"Email of user"},"customerRoleId":{"type":"string","description":"Customer role ID of msp user"},"allCustomer":{"type":"boolean","description":"All customers including new created customer"},"customers":{"uniqueItems":true,"type":"array","description":"Customer ID list of msp user","items":{"type":"string","description":"Customer ID list of msp user"}},"alert":{"type":"boolean","description":"Alert email"},"roleId":{"type":"string","description":"Role ID of user"},"forceModify":{"type":"boolean","description":"Force modify"},"temporaryEnable":{"type":"boolean","description":"Whether the user wants to enable the temporary worker permission"},"startTime":{"type":"integer","description":"The start time of the user's validity period. time range: start timestamp (Millisecond).","format":"int64"},"endTime":{"type":"integer","description":"The end time of the user's validity period. time range: end timestamp (Millisecond).","format":"int64"}}},"MspExternalUserGroupOpenApiVO":{"required":["allCustomer","customerRoleId","name","roleId"],"type":"object","properties":{"name":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"Msp external user group name should contain 1 to 128 characters."},"roleId":{"type":"string","description":"Msp role ID which can be obtained from 'Get msp role list' interface."},"customerRoleId":{"type":"string","description":"Customer role ID which can be obtained from 'Get customer list' interface."},"allCustomer":{"type":"boolean","description":"Whether having all customer permissions."},"customers":{"uniqueItems":true,"type":"array","description":"The customer IDs that can be accessed. Effective when allCustomer is false.","items":{"type":"string","description":"The customer IDs that can be accessed. Effective when allCustomer is false."}},"temporaryEnable":{"type":"boolean","description":"Whether the user wants to enable the temporary worker permission"},"startTime":{"type":"integer","description":"The start time of the user's validity period. time range: start timestamp (Millisecond).","format":"int64"},"endTime":{"type":"integer","description":"The end time of the user's validity period. time range: end timestamp (Millisecond).","format":"int64"}}},"ModifyRoleVO":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"Role name should contain 1 to 128 ASCII characters."},"privilege":{"$ref":"#/components/schemas/RoleVO"}}},"RoleVO":{"type":"object","properties":{"mspDashboard":{"type":"integer","description":"msp dashboard, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspDevice":{"type":"integer","description":"msp device, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspLog":{"type":"integer","description":"msp log, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspLicense":{"type":"integer","description":"msp license, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspLicenseBind":{"type":"integer","description":"msp license bind, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspUsers":{"type":"integer","description":"msp user, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspRoles":{"type":"integer","description":"msp role, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspSamlUsers":{"type":"integer","description":"saml users in msp view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspSamlRoles":{"type":"integer","description":"saml roles in msp view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspSamlSsos":{"type":"integer","description":"saml ssos in msp view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspSetting":{"type":"integer","description":"msp setting, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspExportData":{"type":"integer","description":"export data in msp view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspAdopt":{"type":"integer","description":"msp adopt in msp view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32","deprecated":true},"mspAddDevices":{"type":"integer","description":"msp add devices in msp view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32","deprecated":true},"mspAddAdoptDevice":{"type":"integer","description":"msp add and adopt devices in msp view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspWebhook":{"type":"integer","description":"msp webhook in msp view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspSites":{"type":"integer","description":"msp sites in msp view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspCluster":{"type":"integer","description":"msp cluster, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"globalDashboard":{"type":"integer","description":"dashboard in global view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"dashboard":{"type":"integer","description":"dashboard, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"devices":{"type":"integer","description":"devices, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"adopt":{"type":"integer","description":"adopt, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32","deprecated":true},"addDevices":{"type":"integer","description":"add devices in global/customer view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32","deprecated":true},"addAdoptDevice":{"type":"integer","description":"add and adopt devices in global/customer view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"globalLog":{"type":"integer","description":"log in global view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"manualUpgrade":{"type":"integer","description":"manual upgrade in global view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"log":{"type":"integer","description":"log in site view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"license":{"type":"integer","description":"license, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"licenseBind":{"type":"integer","description":"license bind, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"users":{"type":"integer","description":"users in global view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"roles":{"type":"integer","description":"roles in global view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"samlUsers":{"type":"integer","description":"saml users in global view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"samlRoles":{"type":"integer","description":"saml roles in global view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"samlSsos":{"type":"integer","description":"saml ssos in global view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"globalSetting":{"type":"integer","description":"settings in global view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"exportData":{"type":"integer","description":"export data in site view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"globalExportData":{"type":"integer","description":"export data in global view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"exportGlobalLog":{"type":"integer","description":"export global log data in global view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"globalCluster":{"type":"integer","description":"cluster in global view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"hotspot":{"type":"integer","description":"hotspot, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"statics":{"type":"integer","description":"statics, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"map":{"type":"integer","description":"map, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"clients":{"type":"integer","description":"clients, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"insight":{"type":"integer","description":"insight, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"report":{"type":"integer","description":"network report, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"network":{"type":"integer","description":"site network settings, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32","deprecated":true},"deviceAccount":{"type":"integer","description":"device account, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"anomaly":{"type":"integer","description":"anomaly, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"analyze":{"type":"integer","description":"analyze, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"siteAnalyze":{"type":"integer","description":"analyze in site view, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"globalSecurity":{"type":"integer","description":"security, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"globalWebhook":{"type":"integer","description":"Webhook, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"globalMapToken":{"type":"integer","description":"Map Token, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"siteTemplate":{"type":"integer","description":"Site Template, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"globalFirmware":{"type":"integer","description":"Firmware Manager, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"sdWan":{"type":"integer","description":"SD-WAN, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"siteHome":{"type":"integer","description":"Site Home Manager","format":"int32","deprecated":true},"deviceRecovery":{"type":"integer","description":"Device Recovery, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"siteNetwork":{"type":"integer","description":"Network Config Page, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"siteDevice":{"type":"integer","description":"Device Config Page, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"siteMaintain":{"type":"integer","description":"Maintenance Page, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"aiAssi":{"type":"integer","description":"AI Assistant, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"}},"description":"Role privilege"},"GatewayMspConfigGeneral":{"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"Device name should contain 1 to 128 characters."}}},"RoleDetailOpenApiVO":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"Role name should contain 1 to 128 ASCII characters."},"type":{"type":"integer","description":"Role Type should be a value as follows: 0: standard; 1: customer; 2: msp.","format":"int32"},"defaultRole":{"type":"boolean","description":"Whether role is default role."},"source":{"type":"integer","description":"Role created resource. It should be a value as follows: 0: default; 1:create by standard controller or customer controller; 2: create by MSP","format":"int32"},"privilege":{"$ref":"#/components/schemas/RoleVO"},"hasAllPrivilege":{"type":"boolean","description":"Whether role has all site privilege."},"owner":{"type":"boolean","description":"Whether role is owner."}}},"IPSubnetsVO":{"required":["ip","mask"],"type":"object","properties":{"ip":{"type":"string","description":"IP address, should be a valid IP format"},"mask":{"type":"integer","description":"IP mask, mask should be within the range of 1-32","format":"int32"},"description":{"pattern":"^$|^[^ ]$|^[^ ].{0,510}[^ ]$","type":"string","description":"Description should contain 1 to 512 characters."}},"description":"User remote subnets of the VPN user."},"VpnUserConfigVO":{"type":"object","properties":{"username":{"type":"string","description":"Username of the VPN user."},"password":{"type":"string","description":"Password of the VPN user."},"protocol":{"type":"integer","description":"Protocol should be a value as follows: 0: L2TP or PPTP; 1: openVPN; 2: SSL VPN.","format":"int32"},"servers":{"type":"array","description":"Servers of the VPN user. Server can be created using 'Create client-to-site VPN server' interface, and server ID can be obtained from 'Get client-to-site VPN server list' interface.","items":{"type":"string","description":"Servers of the VPN user. Server can be created using 'Create client-to-site VPN server' interface, and server ID can be obtained from 'Get client-to-site VPN server list' interface."}},"clientMode":{"type":"integer","description":"Client mode should be a value as follows: 0: Client-To-Site, 1: Site-To-Site.","format":"int32"},"maxConnections":{"type":"integer","description":"Max connections should be within the range of 1–100.","format":"int32"},"userRemoteSubnets":{"type":"array","description":"User remote subnets of the VPN user.","items":{"$ref":"#/components/schemas/IPSubnetsVO"}},"localIp":{"type":"string","description":"Local IP of the VPN user."},"groupId":{"type":"string","description":"Group ID of the SSL VPN user. User group can be created using 'Create SSL VPN user group' interface, and User Group ID can be obtained from 'Get user group list for SSL VPN server' interface."},"status":{"type":"boolean","description":"Status of the SSL VPN user."},"validity":{"type":"string","description":"Validity of the SSL VPN user. The format is Month/Day/Year, for example 08/20/2022."}}},"OperationResponseVpnUserBriefVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VpnUserBriefVO"}}},"VpnUserBriefVO":{"type":"object","properties":{"id":{"type":"string","description":"ID of the VPN."},"name":{"type":"string","description":"VPN name."}}},"TopologyMultiSiteQueryOpenApiVO":{"required":["siteIds"],"type":"object","properties":{"siteIds":{"maxItems":100,"minItems":1,"type":"array","description":"List of siteId to query.","items":{"maxLength":100,"minLength":1,"type":"string","description":"List of siteId to query."}}}},"ClientAggHealthDTO":{"type":"object","properties":{"good":{"type":"integer","description":"The Quantity of Good Clients","format":"int32"},"fair":{"type":"integer","description":"The Quantity of Fair Clients","format":"int32"},"poor":{"type":"integer","description":"The Quantity of Poor Clients","format":"int32"},"noData":{"type":"integer","description":"The Quantity of noData Clients","format":"int32"}},"description":"Client Health"},"LanPort":{"type":"object","properties":{"port":{"type":"string","description":"Port Id"},"name":{"type":"string","description":"Port Name"},"status":{"type":"integer","description":"Port Status","format":"int32"},"internetState":{"type":"integer","description":"Port Internet State","format":"int32"},"onlineDetection":{"type":"integer","description":"Port Online Detection","format":"int32"},"linkSpeed":{"type":"integer","description":"Link Speed","format":"int32"},"duplex":{"type":"integer","description":"Duplex","format":"int32"}},"description":"Lan Port List"},"OperationResponseListOperationResponseTopologyOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/OperationResponseTopologyOpenApiVO"}}}},"OperationResponseTopologyOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/TopologyOpenApiVO"}}},"OswUpInfo":{"type":"object","properties":{"port":{"$ref":"#/components/schemas/WiredPortDTO"},"upLinkPort":{"$ref":"#/components/schemas/WiredPortDTO"},"linkSpeed":{"type":"integer","description":"LinkSpeed","format":"int32"},"duplex":{"type":"integer","description":"Duplex","format":"int32"}},"description":"Upper Info of Switch"},"TopologyOpenApiEdgeVO":{"type":"object","properties":{"upLinkMac":{"type":"string","description":"UpLink Mac"},"downLinkMac":{"type":"string","description":"DownLink Mac"},"blockedVlans":{"type":"string","description":"Blocked Vlans"},"blockedType":{"type":"integer","description":"Blocked Type","format":"int32"},"blocked":{"type":"boolean","description":"Blocked Or Not"},"remainBlockNum":{"type":"integer","description":"Remain Block Num","format":"int32"},"upLinkPort":{"$ref":"#/components/schemas/WiredPortV3DTO"},"port":{"$ref":"#/components/schemas/WiredPortV3DTO"},"remainBlockedPortList":{"type":"array","description":"Remain Blocked PortList","items":{"$ref":"#/components/schemas/TopologyOpenApiEdgeVO"}}},"description":"Topology Edges"},"TopologyOpenApiNodeVO":{"type":"object","properties":{"type":{"type":"string","description":"Device Type"},"name":{"type":"string","description":"Device Name"},"mac":{"type":"string","description":"Device Mac"},"model":{"type":"string","description":"Device Model"},"modelVersion":{"type":"string","description":"Device ModelVersion"},"deviceSeriesType":{"type":"integer","description":"Device Series Type","format":"int32"},"clientCount":{"type":"integer","description":"Client Count","format":"int32"},"healthScore":{"type":"integer","description":"Health Score","format":"int32"},"clientHealth":{"$ref":"#/components/schemas/ClientAggHealthDTO"},"wiredUpLink":{"$ref":"#/components/schemas/WireUpLink"},"wirelessUpLink":{"$ref":"#/components/schemas/WirelessUpLink"},"rdMode2g":{"type":"string","description":"rdMode2g"},"channel2g":{"type":"integer","description":"channel2g","format":"int32"},"rdMode5g":{"type":"string","description":"rdMode5g"},"channel5g":{"type":"integer","description":"channel5g","format":"int32"},"rdMode5g2":{"type":"string","description":"rdMode5g2"},"channel5g2":{"type":"integer","description":"channel5g2","format":"int32"},"rdMode6g":{"type":"string","description":"rdMode6g"},"channel6g":{"type":"integer","description":"channel6g","format":"int32"},"support5g2":{"type":"boolean","description":"support5g2"},"wanPorts":{"type":"array","description":"Wan Port List","items":{"$ref":"#/components/schemas/WanPort"}},"lanPorts":{"type":"array","description":"Lan Port List","items":{"$ref":"#/components/schemas/LanPort"}},"stackGroup":{"type":"boolean","description":"Stack Group"},"stackId":{"type":"string","description":"Stack Id"},"upperPort":{"$ref":"#/components/schemas/OswUpInfo"}},"description":"Topology Nodes"},"TopologyOpenApiVO":{"type":"object","properties":{"siteId":{"type":"string","description":"Site ID"},"topologyNodes":{"type":"array","description":"Topology Nodes","items":{"$ref":"#/components/schemas/TopologyOpenApiNodeVO"}},"topologyEdges":{"type":"array","description":"Topology Edges","items":{"$ref":"#/components/schemas/TopologyOpenApiEdgeVO"}},"lastUpdateTime":{"type":"integer","description":"Last Update Time","format":"int64"}}},"WanPort":{"type":"object","properties":{"port":{"type":"string","description":"Port Id"},"name":{"type":"string","description":"Port Name"},"status":{"type":"integer","description":"Port Status","format":"int32"},"internetState":{"type":"integer","description":"Port Internet State","format":"int32"},"onlineDetection":{"type":"integer","description":"Port Online Detection","format":"int32"},"linkSpeed":{"type":"integer","description":"Link Speed","format":"int32"},"duplex":{"type":"integer","description":"Duplex","format":"int32"},"healthLevel":{"type":"integer","description":"Health Level","format":"int32"},"wireless":{"type":"boolean","description":"Whether the port is wireless."},"txRate":{"type":"integer","description":"Rx Rate","format":"int64"}},"description":"Wan Port List"},"WireUpLink":{"type":"object","properties":{"upLinkPort":{"$ref":"#/components/schemas/WiredPortDTO"},"port":{"$ref":"#/components/schemas/WiredPortDTO"},"linkSpeed":{"type":"integer","description":"LinkSpeed","format":"int32"},"duplex":{"type":"integer","description":"Duplex","format":"int32"},"isFiberOptic":{"type":"boolean","description":"Fiber Optic"}},"description":"Wired UpLink Info"},"WiredPortDTO":{"type":"object","properties":{"port":{"type":"integer","description":"Port Id","format":"int32"},"standardPort":{"type":"string","description":"Standard Port of Stack"},"lagId":{"type":"integer","description":"Lag Id","format":"int32"},"lagPorts":{"type":"array","description":"Lag Ports","items":{"type":"integer","description":"Lag Ports","format":"int32"}},"standardLagPorts":{"type":"array","description":"Standard Lag Ports of Stack","items":{"type":"string","description":"Standard Lag Ports of Stack"}},"name":{"type":"string","description":"Name of the port"},"multiSwitchNum":{"type":"integer","description":"Multi Switch Num","format":"int32"},"uplinkName":{"type":"string","description":"Uplink Name"},"multiSwitchRole":{"type":"integer","description":"Multi Switch Role","format":"int32"}},"description":"UpLink Device's Port"},"WiredPortV3DTO":{"type":"object","properties":{"port":{"type":"string","description":"Port Id"},"standardPort":{"type":"string","description":"Standard Port of Stack"},"lagId":{"type":"string","description":"Lag Id"},"mlagId":{"type":"string","description":"Mlag Id"},"poePower":{"type":"integer","description":"Poe Power","format":"int64","deprecated":true},"poePowerDecimal":{"type":"number","description":"Poe Power In Decimal","format":"double"},"lagPorts":{"type":"array","description":"Lag Ports","items":{"type":"integer","description":"Lag Ports","format":"int32"}},"mlagPorts":{"type":"array","description":"Mlag Ports","items":{"type":"integer","description":"Mlag Ports","format":"int32"}},"standardLagPorts":{"type":"array","description":"Standard Lag Ports of Stack","items":{"type":"string","description":"Standard Lag Ports of Stack"}},"standardMlagPorts":{"type":"array","description":"Standard Mlag Ports of Stack","items":{"type":"string","description":"Standard Mlag Ports of Stack"}},"name":{"type":"string","description":"Name of the port"},"multiSwitchNum":{"type":"integer","description":"Multi Switch Num","format":"int32"},"uplinkName":{"type":"string","description":"Uplink Name"},"multiSwitchRole":{"type":"integer","description":"Multi Switch Role","format":"int32"}},"description":"Downlink Port"},"WirelessUpLink":{"type":"object","properties":{"txRate":{"type":"string","description":"Tx Rate"},"rxRate":{"type":"string","description":"Rx Rate"},"tx":{"type":"integer","description":"Tx","format":"int32"},"rx":{"type":"integer","description":"Rx","format":"int32"},"rssi":{"type":"integer","description":"Rssi","format":"int32"},"rssiPercent":{"type":"number","description":"Rssi Percent","format":"float"}},"description":"Wireless UpLink Info"},"AuthenticationParamOpenApiVO":{"required":["id","value"],"type":"object","properties":{"id":{"type":"integer","description":"EAP authentication parameter identifier.<br />Parameter id should be a value as follows: [2: None-EAP Inner Authentication Type; 3: Inner Authentication EAP Method Type; 5: Credential Type; 6: Tunneled EAP Method Credential Type]","format":"int32"},"value":{"type":"integer","description":"Authentication parameters.<br />When id = 2, parameter value should be a value as follows:[1:PAP;2:CHAP;3:MSCHAP;4:MSCHAPV2].<br />When id = 3, parameter value should be a value as follows:[0:None;1:Identity;2:Notification;5:One-Time Password (OTP);6:Generic Token Card (GTC);13:EAP-TLS;18:GSM Subscriber Identity Modules (EAP-SIM);21:EAP-TTLS;23:EAP-AKA Authentication;25:PEAP;28:CRYPTOCard;29:EAP-MSCHAP-V2]<br />When id = 5, parameter value should be a value as follows:[1:SIM;2:USIM;3:NFC Secure Element;4:Hardware Token;5:Softoken;6:Certificate;7:username/password;8:None;10:Vendor Specific]<br />When id = 6, parameter value should be a value as follows:[1:SIM;2:USIM;3:NFC Secure Element;4:Hardware Token;5:Softoken;6:Certificate;7:username/password;9:Anonymous;10:Vendor Specific].","format":"int32"}},"description":"Authentication Param list, configure the EAP authentication parameter identifier and authentication parameters.<br />Note: Up to 4 entries are allowed for the Authentication Param list."},"BandSteerOpenApiVO":{"required":["mode"],"type":"object","properties":{"mode":{"type":"integer","description":"should be a value as follows: 0:Disable; 1:Prefer 5GHz/6GHz; 2:Balance; 3:Use site setting.","format":"int32"}},"description":"SSID Band Steer config."},"CondBroadcastCtrlVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"enable"},"condition":{"type":"integer","description":"0: uplink down, 1: Internet down.","format":"int32"},"upTime":{"type":"integer","description":"SSID Uplink Time","format":"int32"},"downTime":{"type":"integer","description":"SSID Downlink Time","format":"int32"}},"description":"Condition Broadcast Control config."},"CreateSsidV2OpenApiVO":{"required":["band","name","security"],"type":"object","properties":{"name":{"type":"string","description":"SSID name. It should contain 1 to 32 UTF-8 characters."},"deviceType":{"type":"integer","description":"SSID device type, identify which devices this SSID will take effect; The lowest bit indicates whether [EAP] is included, the second low bit indicates whether [Gateway] is included, 1 means included while 0 means not included; For example, 3(11) means that EAP/Gateway is enabled, 1(01) means that EAP is enabled.","format":"int32"},"band":{"type":"integer","description":"SSID band. The lowest bit indicates whether 2.4G is included; the second lowest bit indicates whether 5G is included; the third lowest bit indicates whether 6G is included; 1 means included while 0 means not included. For example, 7(111) means that 2G/5G/6G are enabled; 1(001) means that 2G is enabled. (When 5G is included，it means 5G/5G1/5G2 are enabled.)","format":"int32"},"ssidEnable":{"type":"boolean","description":"SSID Enable status. True: enable, false: disable."},"chooseDevices":{"type":"integer","description":"select all devices or not. 0 means select all devices, 1 means not select all devices.","format":"int32"},"apGroupIds":{"type":"array","description":"AP Group ID list that the SSID is associated with. Supports binding to multiple AP groups.","items":{"type":"string","description":"AP Group ID list that the SSID is associated with. Supports binding to multiple AP groups."}},"guestNetEnable":{"type":"boolean","description":"SSID guest network config status. True: enable, false: disable.\nWith this option enabled, the guest network will prevent wireless clients on the same AP from communicating with each other. This may restrain the functions of AirPlay, ChromeCast, Sonos devices, screen mirroring, and wireless printers."},"security":{"type":"integer","description":"SSID security mode; Security should be a value as follows: 0: None; 2: WPA-Enterprise; 3: WPA-Personal; 4: PPSK without RADIUS; 5: PPSK with RADIUS.","format":"int32"},"oweEnable":{"type":"boolean","description":"Opportunistic Wireless Encryption, also known as Enhanced Open, is a certification provided by the Wi-Fi Alliance as part of the WPA3 wireless security standard. OWE will enable two wireless VAPs per radio, one for access of OWE-supported stations, and one for access of other stations. An SSID with OWE enabled will be counted as two SSID entries for 2G and 5G."},"broadcast":{"type":"boolean","description":"SSID broadcast config status. True: enable, false: disable."},"vlanEnable":{"type":"boolean","description":"SSID VLAN config status. True: enable, false: disable."},"vlanId":{"type":"integer","description":"SSID VLAN ID. This field is required when Parameter [vlanEnable] is true; It should be within the range of 1–4094.","format":"int32"},"pskSetting":{"$ref":"#/components/schemas/SsidPskSettingOpenApiVO"},"entSetting":{"$ref":"#/components/schemas/SsidEnterpriseSettingOpenApiVO"},"ppskSetting":{"$ref":"#/components/schemas/SsidPpskSettingOpenApiVO"},"mloEnable":{"type":"boolean","description":"SSID MLO config status. True: enable, false: disable."},"pmfMode":{"type":"integer","description":"SSID PMF mode. It should be a value as follows: 1: Mandatory; 2: Capable; 3: Disable.","format":"int32"},"enable11r":{"type":"boolean","description":"SSID 802.11r config status. True: enable, false: disable."},"hidePwd":{"type":"boolean","description":"If this field is true, the SSID password will be hidden."},"greEnable":{"type":"boolean","description":"SSID EoGre Tunnel config status. True: enable, false: disable. This configuration can be enabled only when the [VPN - EoGre Tunnel] global config is enabled;"},"vlanSetting":{"$ref":"#/components/schemas/SsidVlanSettingOpenApiVO"},"prohibitWifiShare":{"type":"boolean","description":"SSID prohibitWifiShare config status. True: enable, false: disable."},"clientRateLimit":{"$ref":"#/components/schemas/RateLimitSettingOpenApiVO"},"ssidRateLimit":{"$ref":"#/components/schemas/RateLimitSettingOpenApiVO"},"ssidWlanSchedule":{"$ref":"#/components/schemas/SsidWlanScheduleOpenApiVO"},"ssidRateControl":{"$ref":"#/components/schemas/SsidRateControlOpenApiVO"},"ssidMacFilter":{"$ref":"#/components/schemas/SsidMacFilterOpenApiVO"},"ssidMulticast":{"$ref":"#/components/schemas/SsidMultiCastOpenApiVO"},"ssidDhcpOption":{"$ref":"#/components/schemas/BandSteerOpenApiVO"},"hotspotV2Setting":{"$ref":"#/components/schemas/HotspotV2SettingOpenApiVO"},"wifiCallingEnable":{"type":"boolean","description":"SSID Wifi Calling config status. True: enable, false: disable."},"wifiCallingId":{"type":"string","description":"The ID of the Wi-Fi calling profile bound to the SSID. When parameter [wifiCallingEnable] is true, it should not be null."},"enhancedIotConnectivity":{"type":"boolean","description":"SSID Enhanced IoT Connectivity config status. True: enable, false: disable. This configuration can be enabled only when the 5GHz and 6GHz bands are disabled, the parameters [versionEnt] and [versionPsk] are not set to 4, and the following configurations are disabled: [hotspotV2Enable], [bandSteer], [arpCastEnable], [loadBalance], [enable11r], [gikRekeyPskEnable], [pmfMode], [mloEnable]."},"CondBroadcastCtrl":{"$ref":"#/components/schemas/CondBroadcastCtrlVO"}}},"CustomRateLimitSettingOpenApiVO":{"required":["downLimitEnable","upLimitEnable"],"type":"object","properties":{"downLimitEnable":{"type":"boolean","description":"Whether to limit downlink speed; This field is required when select custom setting. True: enable, false: disable."},"downLimit":{"type":"integer","description":"Downlink speed limit value. When the value of Parameter [downLimitType] is 0(Kbps), downLimit should be within the range of 1–10485760; when the value of Parameter [downLimitType] is 1(Mbps), downLimit should be within the range of 1-10240.","format":"int32"},"downLimitType":{"type":"integer","description":"Downlink speed limit unit config; DownLimitType should be a value as follows: 0: Kbps; 1: Mbps.","format":"int32"},"upLimitEnable":{"type":"boolean","description":"Whether to limit uplink speed; This field is required when select custom setting. True: enable, false: disable."},"upLimit":{"type":"integer","description":"Uplink speed limit value. When the value of Parameter [upLimitType] is 0(Kbps), upLimit should be within the range of 1–10485760; when the value of Parameter [upLimitType] is 1(Mbps), upLimit should be within the range of 1-10240.","format":"int32"},"upLimitType":{"type":"integer","description":"Uplink speed limit unit config; UpLimitType should be a value as follows: 0: Kbps; 1: Mbps.","format":"int32"}},"description":"Rate limit custom setting"},"EapMethodOpenApiVO":{"required":["method","param"],"type":"object","properties":{"method":{"type":"integer","description":"EAP authentication method supported by the NAI realm.<br />Parameter method should be a value as follows:[0:None;1:Identity;2:Notification;5:One-Time Password (OTP);6:Generic Token Card (GTC);13:EAP-TLS;18:GSM Subscriber Identity Modules (EAP-SIM);21:EAP-TTLS;23:EAP-AKA Authentication;25:PEAP;28:CRYPTOCard;29:EAP-MSCHAP-V2]","format":"int32"},"param":{"maxItems":4,"minItems":0,"type":"array","description":"Authentication Param list, configure the EAP authentication parameter identifier and authentication parameters.<br />Note: Up to 4 entries are allowed for the Authentication Param list.","items":{"$ref":"#/components/schemas/AuthenticationParamOpenApiVO"}}},"description":"EAP Method list.<br />Note: Up to 4 entries are allowed for the EAP Method list."},"HotspotV2SettingOpenApiVO":{"required":["hotspotV2Enable"],"type":"object","properties":{"hotspotV2Enable":{"type":"boolean","description":"Whether Hotspot2.0 is enabled.<br />If hotspot2.0 is disabled, other parameters in Hotspot2.0 will be invalid."},"networkType":{"type":"integer","description":"Specify the 802.11u network type.<br /> Parameter networkType should be a value as follows: [0: Private network; 1: Private network with guest access; 2: Chargeable public network; 3: Free public network; 4: Personal device network; 5: Emergency services only network; 14: Test or experimental; 15: Wildcard].","format":"int32"},"plmnId":{"maxItems":6,"minItems":0,"type":"array","description":"PLMN ID list, enter PLMN ID of 802.11u 3GPP cellular network.<br />Note: Up to 6 entries are allowed for the PLMN ID list.","items":{"$ref":"#/components/schemas/PlmnIdOpenApiVO"}},"roamingConsortiumOi":{"maxItems":3,"minItems":0,"type":"array","description":"Roaming Consortium Oi list, enter the 802.11u roaming organization identifiers.<br />Note: Up to 3 entries are allowed for the Roaming Consortium Oi list.","items":{"$ref":"#/components/schemas/RoamingConsortiumOiOpenApiVO"}},"operatorDomain":{"pattern":"^$|^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?$","type":"string","description":"Enter the domain name of the hotspot operator.<br />For example, www.omadanetworks.com."},"dgafDisable":{"type":"boolean","description":"Whether to enable DGAF(downstream group-addressed forwarding) disable mode.<br />In DGAF disable mode, the AP will not forward downstream multicast and broadcast packets."},"heSsid":{"pattern":"^$|^[A-F0-9]{1}[02468ACE]{1}([-][A-F0-9]{2}){5}$","type":"string","description":"Homogenous Extended Service Set Identifier, it is used to identify the same type of ESS network set.<br />Note: HESSID should be consistent with one of the BSSIDs of the APs in the zone."},"internet":{"type":"boolean","description":"Internet access support status (network reachability), which indicates that the network is allowed to access the Internet."},"availabilityIpv4":{"type":"integer","description":"Available type information of IPv4 addresses.<br />Parameter availabilityIpv4 should be a value as follows: [0: Address type not available; 1: Public IPv4 address available; 2: Port-restricted IPv4 address available; 3: Single NATed private IPv4 address available; 4: Double NATed private IPv4 address available; 5: Port-restricted IPv4 address and single NATed IPv4 address available; 6: Port-restricted IPv4 address and double NATed IPv4 address available; 7: Availability of the address type is not known].","format":"int32"},"availabilityIpv6":{"type":"integer","description":"Available type information of IPv6 addresses.<br /> Parameter availabilityIpv6 should be a value as follows: [0: Address type not available; 1: Address type available; 2: Availability of the address type not known].","format":"int32"},"operatorFriendly":{"pattern":"^$|^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,62}[\\041-\\0176]$","type":"string","description":"Hotspot network operator friendly name.<br />Note:Parameter operatorFriendly should contain between 1 and 64 visible ASCII characters, with no Spaces at the beginning and end, and Spaces in between."},"venueInfo":{"$ref":"#/components/schemas/VenueInfoOpenApiVO"},"realmList":{"maxItems":10,"minItems":0,"type":"array","description":"Add a profile to identify and describe a NAI (Network Access Identifier) realm accessible using the AP, and the method that this NAI realm uses for authentication.<br />Note: Up to 10 entries are allowed for the NAI Realm list.","items":{"$ref":"#/components/schemas/RealmOpenApiVO"}}},"description":"Hotspot 2.0 is a WFA (Wi-Fi Alliance) technical specification based on IEEE 802.11u protocol.<br />It provides a simplified mechanism for wireless clients to discover and connect to suitable networks and switch seamlessly between mobile networks and wireless networks."},"PlmnIdOpenApiVO":{"type":"object","properties":{"value":{"type":"string","description":"Public Land Mobile Network ID.<br />Note: It should be between 10000 and 999999."}},"description":"PLMN ID list, enter PLMN ID of 802.11u 3GPP cellular network.<br />Note: Up to 6 entries are allowed for the PLMN ID list."},"RateLimitSettingOpenApiVO":{"type":"object","properties":{"profileId":{"type":"string","description":"This field represents RateLimit Profile ID. RateLimit Profile can be created using Create rate limit profile interface, and RateLimit Profile ID can be obtained from Get rate limit profile list interface.(The validity priority is higher than the custom setting)"},"customSetting":{"$ref":"#/components/schemas/CustomRateLimitSettingOpenApiVO"}},"description":"SSID rate limit config."},"RealmOpenApiVO":{"required":["eap","encoding","name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the NAI realm. Usually the domain name of the service provider.<br />Note: It should contain 1 to 64 UTF-8 characters."},"encoding":{"type":"integer","description":"Encoding format.<br />Parameter encoding should be a value as follows:[0:RFC4282;1:UTF-8].","format":"int32"},"eap":{"maxItems":4,"minItems":0,"type":"array","description":"EAP Method list.<br />Note: Up to 4 entries are allowed for the EAP Method list.","items":{"$ref":"#/components/schemas/EapMethodOpenApiVO"}}},"description":"Add a profile to identify and describe a NAI (Network Access Identifier) realm accessible using the AP, and the method that this NAI realm uses for authentication.<br />Note: Up to 10 entries are allowed for the NAI Realm list."},"RoamingConsortiumOiOpenApiVO":{"type":"object","properties":{"value":{"pattern":"^([0-9A-Fa-f]{2}[-]){2}[0-9A-Fa-f]{2}$|^([0-9A-Fa-f]{2}[-]){4}[0-9A-Fa-f]{2}$","type":"string","description":"Roaming Consortium Operator Identifier.<br />Note: Roaming Consortium Oi should conform to XX-XX-XX or XX-XX-XX-XX-XX format(Hexadecimal)."}},"description":"Roaming Consortium Oi list, enter the 802.11u roaming organization identifiers.<br />Note: Up to 3 entries are allowed for the Roaming Consortium Oi list."},"SsidDhcpOptionOpenApiVO":{"type":"object","properties":{"dhcpEnable":{"type":"boolean","description":"SSID DHCP Option 82 global config status. True: enable, false: disable."},"format":{"type":"integer","description":"SSID DHCP Option 82 format config; It should be a value as follows: 0: ASCII; 1: Binary.","format":"int32"},"delimiter":{"type":"string","description":"SSID DHCP Option 82 delimiter config (A single arbitrary ASCII character is acceptable)."},"circuitId":{"type":"array","description":"SSID DHCP Option 82 Circuit-ID config. Circuit-ID is an array formed in the selected order, with each array element corresponding to the following enumeration values: 1: VLAN-ID; 2: AP Radio Mac-Address; 3: SSID-Type; 4: SSID-Name; 5: AP Ethernet MAC address; 6: Site-Name. As in the example [3,1,2,4], the following enumeration values are selected sequentially on the page: SSID-Type, VLAN-ID, AP Radio Mac-Address and SSID-Name.","items":{"type":"integer","description":"SSID DHCP Option 82 Circuit-ID config. Circuit-ID is an array formed in the selected order, with each array element corresponding to the following enumeration values: 1: VLAN-ID; 2: AP Radio Mac-Address; 3: SSID-Type; 4: SSID-Name; 5: AP Ethernet MAC address; 6: Site-Name. As in the example [3,1,2,4], the following enumeration values are selected sequentially on the page: SSID-Type, VLAN-ID, AP Radio Mac-Address and SSID-Name.","format":"int32"}},"remoteId":{"type":"array","description":"SSID DHCP Option 82 Remote-ID config. Remote-ID is an array formed in the selected order, with each array element corresponding to the following enumeration values: 1: VLAN-ID; 2: AP Radio Mac-Address; 3: SSID-Type; 4: SSID-Name; 5: AP Ethernet MAC address; 6: Site-Name. As in the example [3,1,2,4], the following enumeration values are selected sequentially on the page: SSID-Type, VLAN-ID, AP Radio Mac-Address and SSID-Name.","items":{"type":"integer","description":"SSID DHCP Option 82 Remote-ID config. Remote-ID is an array formed in the selected order, with each array element corresponding to the following enumeration values: 1: VLAN-ID; 2: AP Radio Mac-Address; 3: SSID-Type; 4: SSID-Name; 5: AP Ethernet MAC address; 6: Site-Name. As in the example [3,1,2,4], the following enumeration values are selected sequentially on the page: SSID-Type, VLAN-ID, AP Radio Mac-Address and SSID-Name.","format":"int32"}}},"description":"SSID DhcpOption config."},"SsidEnterpriseSettingOpenApiVO":{"required":["encryptionEnt","gikRekeyEntEnable","radiusProfileId","versionEnt"],"type":"object","properties":{"radiusProfileId":{"type":"string","description":"This field represents RADIUS Profile ID. RADIUS Profile(RADIUS Profile Template) can be created using Create a new RADIUS profile(Create a new RADIUS profile template) interface, and RADIUS Profile ID(RADIUS Profile Template ID) can be obtained from Get RADIUS profile list(Get RADIUS profile template list) interface."},"versionEnt":{"type":"integer","description":"WPA-Enterprise version. This is necessary when the value of security is 2(WPA-Enterprise); It should be a value as follows: 1: WPA-Enterprise; 2: WPA2-Enterprise; 3: WPA/WPA2-Enterprise; 4.WPA3-Enterprise.","format":"int32"},"encryptionEnt":{"type":"integer","description":"WPA-Enterprise encryption. This is necessary when the value of security is 2(WPA-Enterprise); It should be a value as follows: 1: Auto; 3: AES; 4: AES-GCM 256; 5:AES-CNSA; 6:CCMP_128; When versionEnt is WPA3-Enterprise, Parameter [encryptionEnt] must be AES/AES-GCM 256/AES-CNSA/CCMP-128, and if ssid only enable 6G or contains 6G and enable mlo, Parameter [encryptionEnt] can not be AES.","format":"int32"},"gikRekeyEntEnable":{"type":"boolean","description":"WPA-Enterprise SSID group key update period config status. True: enable, false: disable."},"rekeyEntInterval":{"type":"integer","description":"WPA-Enterprise SSID group key update period interval config. When the value of Parameter [intervalEntType] is 0(Seconds), it should be within the range of 30-86400; when the value of Parameter [intervalEntType] is 1(Minutes), it should be within the range of 1-1440; when the value of Parameter [intervalEntType] is 2(Hours), it should be within the range of 1-24.","format":"int32"},"intervalEntType":{"type":"integer","description":"WPA-Enterprise SSID group key update period interval unit config. It should be a value as follows: 0: Seconds; 1: Minutes; 2: Hours.","format":"int32"},"nasIdMode":{"type":"integer","description":"Indicates the status of nasid under enterprise-level encryption. It should be a value as follows: 0: default (TP LINK: MAC Address), 1: follow device name, 2: custom.","format":"int32"},"nasId":{"type":"string","description":"This field is necessary when the nasIdMode type is custom."}},"description":"WPA-Enterprise SSID config. This is necessary when the value of security is 2(WPA-Enterprise)."},"SsidMacFilterOpenApiVO":{"type":"object","properties":{"macFilterEnable":{"type":"boolean","description":"SSID MAC Filter global config status. True: enable, false: disable."},"policy":{"type":"integer","description":"SSID MAC Filter policy config mode; It should be a value as follows: 0: Deny List, 1: Allow List.","format":"int32"},"macFilterId":{"type":"string","description":"This field represents MAC Group Profile ID. MAC Group Profile can be created using Create a new group profile interface, and MAC Group Profile ID can be obtained from Get group profile list by type interface."},"ouiProfileIdList":{"type":"array","description":"This field represents OUI Profile ID list. OUI Profile can be created using Create OUI profile interface, and OUI Profile ID can be obtained from Get OUI profile summary list interface.","items":{"type":"string","description":"This field represents OUI Profile ID list. OUI Profile can be created using Create OUI profile interface, and OUI Profile ID can be obtained from Get OUI profile summary list interface."}}},"description":"SSID Mac Filter config."},"SsidMultiCastOpenApiVO":{"type":"object","properties":{"multiCastEnable":{"type":"boolean","description":"Whether to enable multicast to unicast, which is enabled by default. True: enable, false: disable."},"ipv6CastEnable":{"type":"boolean","description":"Whether to enable IPv6 multicast to unicast, which is enabled by default. True: enable, false: disable."},"channelUtil":{"type":"integer","description":"This item indicates that when the channel utilization reaches the threshold, multicast will no longer be converted to unicast, the default threshold is 100, and the value should be within the range of 0-100.","format":"int32"},"arpCastEnable":{"type":"boolean","description":"Whether to enable ARP cast to unicast, which is enabled by default. True: enable, false: disable."},"filterEnable":{"type":"boolean","description":"Whether to enable the multicast filter switch, which is disabled by default. True: enable, false: disable."},"filterMode":{"type":"integer","description":"This item indicates the status of the filtering protocol. The lowest bit indicates whether IGMP is enabled; the second lowest bit indicates whether MDNS is enabled; and the third lowest bit indicates whether Others is enabled. 1 means enable while 0 means disable. For example, 7(111) means that all are enabled; 1(001) means that only IGMP is enabled. ","format":"int32"},"macGroupId":{"type":"string","description":"This field represents MAC Group Profile ID. MAC Group Profile can be created using Create a new group profile interface, and MAC Group Profile ID can be obtained from Get group profile list by type interface."}},"description":"SSID Multicast config."},"SsidPpskSettingOpenApiVO":{"type":"object","properties":{"ppskProfileId":{"type":"string","description":"This field represents PPSK Profile ID; This is necessary when the value of security is 4(PPSK without RADIUS); PPSK Profile(PPSK Profile Template) can be created using Create PPSK profile interface(Create PPSK profile template interface), and PPSK Profile ID(PPSK Profile Template ID) can be obtained from Get PPSK profiles list(Get PPSK profile templates list) interface."},"radiusProfileId":{"type":"string","description":"This field represents RADIUS Profile ID; This is necessary when the value of security is 5(PPSK with RADIUS); RADIUS Profile(RADIUS Profile Template) can be created using Create a new RADIUS profile(Create a new RADIUS profile template) interface, and RADIUS Profile ID(RADIUS Profile Template ID) can be obtained from Get RADIUS profile list(Get RADIUS profile template list) interface."},"macFormat":{"type":"integer","description":"MAC address format. This is necessary when the value of security is 5(PPSK with RADIUS); It should be a value as follows: 0: aabbccddeeff; 1: aa-bb-cc-dd-ee-ff; 2: aa:bb:cc:dd:ee:ff; 3: AABBCCDDEEFF; 4: AA-BB-CC-DD-EE-FF; 5: AA:BB:CC:DD:EE:FF.","format":"int32"},"nasId":{"pattern":"^$|^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"NAS ID. This is necessary when the value of security is 5(PPSK with RADIUS); It should contain 1 to 64 characters."},"type":{"type":"integer","description":"Authentication type. This is necessary when the value of security is 5(PPSK with RADIUS); It should be a value as follows: 0: Mac Auth(Generic RADIUS with bound MAC); 1: EKMS(This configuration applies to the Pro Site of the Omada Pro Controller only); 2: Generic RADIUS with unbound MAC(This configuration applies to the Pro Site of the Omada Pro Controller only).","format":"int32"}},"description":"PPSK without RADIUS/PPSK without RADIUS SSID config. This is necessary when the value of security is 4(PPSK without RADIUS), 5(PPSK with RADIUS)."},"SsidPskSettingOpenApiVO":{"required":["encryptionPsk","gikRekeyPskEnable","versionPsk"],"type":"object","properties":{"securityKey":{"type":"string","description":"WPA-Personal SSID password. This is necessary when the value of security is 3(WPA-Personal);It should contain 8-63 printable ASCII characters or 8-63 hexadecimal digits."},"versionPsk":{"type":"integer","description":"WPA-Personal version. This is necessary when the value of security is 3(WPA-Personal); It should be a value as follows: 1: WPA-PSK; 2: WPA2-PSK; 3: WPA/WPA2-PSK; 4: WPA2-PSK/WPA3-SAE (or WPA3-SAE for 6 GHz-only SSIDs). The value must be 4 for 6 GHz-enabled SSIDs.","format":"int32"},"encryptionPsk":{"type":"integer","description":"WPA-Personal encryption. This is necessary when the value of security is 3(WPA-Personal); It should be a value as follows: 1: Auto; 3: AES; When versionPsk is WPA3-SAE, Parameter [encryptionPsk] must be AES.","format":"int32"},"gikRekeyPskEnable":{"type":"boolean","description":"WPA-Personal SSID group key update period config status. True: enable, false: disable."},"rekeyPskInterval":{"type":"integer","description":"WPA-Personal SSID group key update period interval config. When the value of Parameter [intervalPskType] is 0 (Seconds), it should be within the range of 30-86400; when the value of Parameter [intervalPskType] is 1 (Minutes), it should be within the range of 1-1440; when the value of Parameter [intervalPskType] is 2 (Hours), it should be within the range of 1-24.","format":"int32"},"intervalPskType":{"type":"integer","description":"WPA-Personal SSID group key update period interval unit config. It should be a value as follows: 0: Seconds; 1: Minutes; 2: Hours.","format":"int32"}},"description":"WPA-Personal SSID config. This is necessary when the value of security is 3(WPA-Personal), 4(PPSK without RADIUS), 5(PPSK with RADIUS)."},"SsidRateControlOpenApiVO":{"required":["rate2gCtrlEnable","rate5gCtrlEnable"],"type":"object","properties":{"rate2gCtrlEnable":{"type":"boolean","description":"Whether to enable 2.4GHz Data Rate Control"},"lowerDensity2g":{"type":"number","description":"2.4GHz Data Rate Control lower density value(Unit: Mbps); It should be a value as follows: [1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54]."},"higherDensity2g":{"type":"integer","description":"2.4GHz Data Rate Control higher density value(Unit: Mbps); It should be a value as follows: [54].","format":"int32"},"cckRatesDisable":{"type":"boolean","description":"Whether to disable 2G CCK Rates. If this field is true, Parameter [lowerDensity2g] can not enter the following values: [1, 2, 5.5, 11]."},"clientRatesRequire2g":{"type":"boolean","description":"Whether to require clients to use rates at or above the specified value of 2.4GHz Data Rate Control."},"sendBeacons2g":{"type":"boolean","description":"Whether to enable send beacons at 1Mbps of 2.4GHz Data Rate Control."},"rate5gCtrlEnable":{"type":"boolean","description":"Whether to enable 5GHz Data Rate Control."},"lowerDensity5g":{"type":"integer","description":"5GHz Data Rate Control lower density value(Unit: Mbps); It should be a value as follows: [6, 9, 12, 18, 24, 36, 48, 54].","format":"int32"},"higherDensity5g":{"type":"integer","description":"5GHz Data Rate Control higher density value(Unit: Mbps); It should be a value as follows: [54].","format":"int32"},"clientRatesRequire5g":{"type":"boolean","description":"Whether to require clients to use rates at or above the specified value of 5GHz Data Rate Control."},"sendBeacons5g":{"type":"boolean","description":"Whether to enable send beacons at 6Mbps of 5GHz Data Rate Control."},"manageRateControl2gEnable":{"type":"boolean","description":"Whether to enable 2GHz Manage Rate Control."},"manageRateControl2g":{"type":"number","description":"2.4GHz Manage Rate Control value(Unit: Mbps); It should be a value as follows: [1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54]."},"manageRateControl5gEnable":{"type":"boolean","description":"Whether to enable 5GHz Manage Rate Control."},"manageRateControl5g":{"type":"integer","description":"5GHz Manage Rate Control value(Unit: Mbps); It should be a value as follows: [6, 9, 12, 18, 24, 36, 48, 54].","format":"int32"}},"description":"SSID Rate Control config."},"SsidVlanCustomSettingOpenApiVO":{"required":["customMode"],"type":"object","properties":{"customMode":{"type":"integer","description":"If mode=1, this field must be entered.If a device does not support multiple VLANs, the smallest VLAN you configured will be applied to the SSID. customMode should be a value as follows: 0:by Network; 1:by Vlan.","format":"int32"},"lanNetworkId":{"type":"string","description":"lanNetworkId. If support vlan pool, use lanNetworkVlanIds instead. If customMode=1, this filed must be null. If both lanNetwork and lanNetworkVlanIds parameters exist, the vlanId will actually take effect with the lanNetwork with the smallest vlanId in the lanNetworkVlanIds parameter."},"bridgeVlan":{"type":"integer","description":"bridgeVlan. If support vlan pool, use lanNetworkVlanIds instead.  If customMode=1, this filed must be null.","format":"int32"},"vlanId":{"type":"integer","description":"vlanId. If support vlanPool, use vlanPoolIds instead. If customMode=0, this filed must be null. If both the vlanId and vlanPoolIds parameters exist, the vlanId will actually take effect at the minimum value in the vlanPoolIds parameter.","format":"int32"},"lanNetworkVlanIds":{"type":"object","additionalProperties":{"type":"array","description":"Indicates the mapping between the lanNetworkId and the vlanId, and if the lanNetwork corresponds to a bridgeVlan, multiple vlanIds may correspond.  If customMode=1, this filed must be null. Cbc Pro does not support this filed.","items":{"type":"integer","description":"Indicates the mapping between the lanNetworkId and the vlanId, and if the lanNetwork corresponds to a bridgeVlan, multiple vlanIds may correspond.  If customMode=1, this filed must be null. Cbc Pro does not support this filed.","format":"int32"}},"description":"Indicates the mapping between the lanNetworkId and the vlanId, and if the lanNetwork corresponds to a bridgeVlan, multiple vlanIds may correspond.  If customMode=1, this filed must be null. Cbc Pro does not support this filed."},"vlanPoolIds":{"type":"string","description":"When customMode=1 needs to have a value.  If customMode=0, this filed must be null. Cbc Pro does not support this filed."}},"description":"If mode=1, this field must be entered."},"SsidVlanSettingOpenApiVO":{"required":["mode"],"type":"object","properties":{"mode":{"type":"integer","description":"should be a value as follows: 0:Default; 1:Custom.","format":"int32"},"customConfig":{"$ref":"#/components/schemas/SsidVlanCustomSettingOpenApiVO"}},"description":"This field is required when Parameter [vlanEnable] is true. Field to set the SSID VLAN configuration. "},"SsidWlanScheduleOpenApiVO":{"type":"object","properties":{"wlanScheduleEnable":{"type":"boolean","description":"SSID WLAN schedule global config status. True: enable, false: disable."},"action":{"type":"integer","description":"0 means radio off, indicating the Wi-Fi function is off during the selected period; 1 means radio on, indicating the Wi-Fi function is on during the selected period.","format":"int32"},"scheduleId":{"type":"string","description":"This field represents Time Range Profile ID. Time Range Profile can be created using Create time range profile interface, and Time Range Profile ID can be obtained from Get time range profile list interface."}},"description":"SSID WLAN Schedule config."},"VenueInfoOpenApiVO":{"required":["group","type"],"type":"object","properties":{"group":{"type":"integer","description":"Venue Group.Parameter group should be a value as follows: [0: Unspecified; 1: Assembly; 2: Business; 3: Educational; 4: Factory and Industrial; 5: Institutional; 6: Mercantile; 7: Residential; 8: Storage; 9: Utility and Miscellaneous; 10: Vehicular; 11: Outdoor]","format":"int32"},"type":{"type":"integer","description":"Venue Type.When Venue Group = 0, type should be a value as follows:[0: Unspecified]When Venue Group = 1, type should be a value as follows:[0: Unspecified Assembly;1: Arena;2: Stadium;3: Passenger Terminal (e.g., airport, bus, ferry, train station);4: Amphitheater;5: Amusement Park;6: Place of Worship;7: Convention Center;8: Library;9: Museum;10: Restaurant;11: Theater;12: Bar;13: Coffee Shop;14: Zoo or Aquarium;15: Emergency Coordination Center]When Venue Group = 2, type should be a value as follows:[0: Unspecified Business;1: Doctor or Dentist office;2: Bank;3: Fire Station;4: Police Station;5: Post Office;6: Professional Office;7: Research and Development Facility;8: Attorney Office]When Venue Group = 3, type should be a value as follows:[0: Unspecified Educational;1: School,Primary;2: School, Secondary;3: University or College;]When Venue Group = 4, type should be a value as follows:[0: Unspecified Factory and Industrial;1: Factory]When Venue Group = 5, type should be a value as follows:[0: Unspecified Institutional;1: Hospital;2: Long-Term Care Facility (e.g. Nursing home, Hospice, etc.);3: Alchohol and Drug Re-habilitation Center;4: Group Home;5: Prison or Jail;]When Venue Group = 6, type should be a value as follows:[0: Unspecified Mercantile;1: Retail Store;2: Grocery Market;3: Automotive Service Station;4: Shopping Mall;5: Gas Station;]When Venue Group = 7, type should be a value as follows:[0: Unspecified Residential;1: Private Residence;2: Hotel or Motel;3: Dormitory;4: Boarding House;]When Venue Group = 8, type should be a value as follows:[0: Unspecified Storage]When Venue Group = 9, type should be a value as follows:[0: Unspecified Utility and Miscellaneous]When Venue Group = 10, type should be a value as follows:[0: Unspecified Vehicular;1: Automobile or Truck;2: Airplane;3: Bus;4: Ferry;5: Ship or Boat;6: Train;7: Motor Bike;]When Venue Group = 11, type should be a value as follows:[0: Unspecified Outdoor;1: Muni-mesh Network;2: City Park;3: Rest Area;4: Traffic Control;5: Bus Stop;6: Kiosk]","format":"int32"},"name":{"pattern":"^$|^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,62}[\\041-\\0176]$","type":"string","description":"Network’s venue name, identifying the physical location of the network.<br />Note: It should contain between 1 and 64 visible ASCII characters, with no Spaces at the beginning and end, and Spaces in between."}},"description":"Indicates the venue information using the combination of the network's venue group and venue type (using the international building code)."},"OswDeviceTemplateIdListVO":{"type":"object","properties":{"switchDeviceTemplateIdList":{"type":"array","items":{"type":"string"}}}},"LanNetworkOpenApiV2GridVOLanNetworkSplitOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/LanNetworkSplitOpenApiVO"}},"supportMultiVlan":{"type":"boolean","description":"Whether multi vlan configuration is supported of the lan netowrk."},"supportRA":{"type":"boolean","description":"Whether Router Advertisement configuration is supported of the lan netowrk."},"supportCustomDhcpOption":{"type":"boolean","description":"Whether custom DHCP option configuration is supported of the lan netowrk."},"supportDhcpNextServer":{"type":"boolean","description":"Whether DHCP Next Server is supported of the lan network."},"supportArpDetection":{"type":"boolean","description":"Whether ARP Detection is supported of the lan network."},"dhcpRangePoolSize":{"type":"integer","description":"The size of DHCP range pool supported by the lan network DHCP.","format":"int32"}}},"LanNetworkSplitOpenApiVO":{"required":["name"],"type":"object","properties":{"id":{"type":"string","description":"LAN network ID"},"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"LAN network name should contain 1 to 128 characters."},"vlanType":{"type":"integer","description":"When purpose is interface, VLANType should be a value as follows: 0: Single; 1: Multiple","format":"int32"},"vlan":{"type":"integer","description":"Vlan should be within the range of 1-4090.","format":"int32"},"primary":{"type":"boolean","description":"Primary"}},"description":"LanNetworkSplitOpenApiVO"},"OperationResponseLanNetworkOpenApiV2GridVOLanNetworkSplitOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/LanNetworkOpenApiV2GridVOLanNetworkSplitOpenApiVO"}}},"BandCtrlVO":{"required":["egressEnable","ingressEnable"],"type":"object","properties":{"egressEnable":{"type":"boolean","description":"Egress enable status"},"egressLimit":{"type":"integer","description":"EgressLimit","format":"int32"},"egressUnit":{"type":"integer","description":"EgressUnit should be a value as follows: 1: Kbps and 2: Mbps","format":"int32"},"ingressEnable":{"type":"boolean","description":"Ingress enable status"},"ingressLimit":{"type":"integer","description":"IngressLimit","format":"int32"},"ingressUnit":{"type":"integer","description":"IngressUnit should be a value as follows: 1: Kbps and 2: Mbps","format":"int32"}},"description":"BandCtrl"},"DhcpL2RelayVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"Enable"},"format":{"type":"integer","description":"Format should be a value as follows: 0: normal, 1: private","format":"int32"}},"description":"DHCPL2RelaySettings"},"LanProfileSettingOpenApiVO":{"required":["bandWidthCtrlType","dot1x","lldpMedEnable","loopbackDetectEnable","name","poe","portIsolationEnable","spanningTreeEnable"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Name should contain 1 to 128 characters."},"poe":{"type":"integer","description":"PoE should be a value as follows: 0: off, 1: on, 2: \"do not modify\"","format":"int32"},"vlanConfigEnable":{"type":"boolean","description":"Vlan configuration enable status"},"networkTagsSetting":{"type":"integer","description":"network Tags configuration mode should be a value as follows: 0:allow all, 1:block all, 2:custom","format":"int32"},"nativeNetworkId":{"type":"string","description":"Native Network ID, Native Network cannot be selected from Tagged Networks or Untagged Networks."},"nativeBridgeVlan":{"type":"integer","description":"Native Network Bridge Vlan.","format":"int32"},"tagNetworkIds":{"type":"array","description":"Tag Network IDs","items":{"type":"string","description":"Tag Network IDs"}},"tagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Tag Network Bridge Vlan Map","items":{"type":"integer","description":"Tag Network Bridge Vlan Map","format":"int32"}},"description":"Tag Network Bridge Vlan Map"},"untagNetworkIds":{"type":"array","description":"Untag Network IDs","items":{"type":"string","description":"Untag Network IDs"}},"untagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Untag Network Bridge Vlan Map","items":{"type":"integer","description":"Untag Network Bridge Vlan Map","format":"int32"}},"description":"Untag Network Bridge Vlan Map"},"voiceNetworkEnable":{"type":"boolean","description":"Indicates whether voice network is enabled"},"voiceNetworkId":{"type":"string","description":"Voice Network ID"},"voiceBridgeVlan":{"type":"integer","description":"Voice Network Bridge Vlan","format":"int32"},"voiceDscpEnable":{"type":"boolean","description":"Indicates whether voice DSCP is enabled"},"voiceDscp":{"type":"integer","description":"Voice DSCP","format":"int32"},"esEnable":{"type":"boolean","description":"ES enable status"},"esTaggedModified":{"type":"boolean","description":"Indicates whether ES Tagged is modified"},"esEnableTaggedNetworkIds":{"type":"array","description":"ES enable tagged network ids","items":{"type":"string","description":"ES enable tagged network ids"}},"dot1x":{"type":"integer","description":"Dot1x should be a value as follows: 0: force unauthorized, 1: force authorized, 2:auto","format":"int32"},"portIsolationEnable":{"type":"boolean","description":"Port-isolation enable status"},"lldpMedEnable":{"type":"boolean","description":"LLDP-MED enable status"},"bandWidthCtrlType":{"type":"integer","description":"BandWidthCtrlType should be a value as follows: 0: off, 1: rate limit, 2: storming control","format":"int32"},"stormCtrl":{"$ref":"#/components/schemas/StormCtrlVO"},"bandCtrl":{"$ref":"#/components/schemas/BandCtrlVO"},"spanningTreeEnable":{"type":"boolean","description":"SpanningTree enable status"},"spanningTreeSetting":{"$ref":"#/components/schemas/SpanningTreeSettingVO"},"loopbackDetectEnable":{"type":"boolean","description":"LoopbackDetect enable status"},"eeeEnable":{"type":"boolean","description":"EEE enable status"},"flowControlEnable":{"type":"boolean","description":"FlowControl enable status"},"loopbackDetectVlanBasedEnable":{"type":"boolean","description":"LoopbackDetectVLANBased enable status"},"igmpFastLeaveEnable":{"type":"boolean","description":"Indicates whether igmp fast leave is enabled"},"mldFastLeaveEnable":{"type":"boolean","description":"Indicates whether mld fast leave is enabled"},"dhcpL2RelaySettings":{"$ref":"#/components/schemas/DhcpL2RelayVO"},"fastLeaveEnable":{"type":"boolean","description":"IGMP Snooping fast leave enable status"},"dot1pPriority":{"type":"integer","description":"802.1p Priority","format":"int32"},"trustMode":{"type":"integer","description":"Trust mode","format":"int32"}}},"StormCtrlVO":{"required":["action","broadcastEnable","multicastEnable","unknownUnicastEnable"],"type":"object","properties":{"rateMode":{"type":"integer","description":"RateMode should be a value as follows: 0: ratio; 1: kbps","format":"int32"},"unknownUnicastEnable":{"type":"boolean","description":"Unknown-Unicast enable status"},"unknownUnicast":{"type":"integer","description":"Unknown-Unicast","format":"int32"},"multicastEnable":{"type":"boolean","description":"Multicast enable status"},"multicast":{"type":"integer","description":"Multicast","format":"int32"},"broadcastEnable":{"type":"boolean","description":"Broadcast enable status"},"broadcast":{"type":"integer","description":"Broadcast","format":"int32"},"action":{"type":"integer","description":"Action should be a value as follows: 0: drop(default), 1: shutdown","format":"int32"},"recoverTime":{"type":"integer","description":"Recover Time should be within the range of 1-3600, default 3600","format":"int32"}},"description":"StormCtrl"},"ResponseIdVO":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the response."}}},"BatchIsolateInterfaceOpenApiVO":{"type":"object","properties":{"ids":{"type":"array","description":"A list of network Id which is selected to isolate or de-isolate.","items":{"type":"string","description":"A list of network Id which is selected to isolate or de-isolate."}},"isolation":{"type":"boolean","description":"The isolation status after batch isolate or de-isolate."},"selectAll":{"type":"boolean","description":"Whether select all networks."}}},"CreateSsidOpenApiVO":{"required":["band","broadcast","deviceType","enable11r","guestNetEnable","hidePwd","mloEnable","name","pmfMode","security","vlanEnable"],"type":"object","properties":{"name":{"type":"string","description":"SSID name. It should contain 1 to 32 UTF-8 characters."},"deviceType":{"type":"integer","description":"SSID device type, identify which devices this SSID will take effect; The lowest bit indicates whether [EAP] is included, the second low bit indicates whether [Gateway] is included, 1 means included while 0 means not included; For example, 3(11) means that EAP/Gateway is enabled, 1(01) means that EAP is enabled.","format":"int32"},"ssidEnable":{"type":"boolean","description":"SSID enable status. True: enable, false: disable."},"chooseDevices":{"type":"integer","description":"description = select all devices or not. 0 means select all devices, 1 means not select all devices.","format":"int32"},"apGroupIds":{"type":"array","description":"AP Group ID list that the SSID is associated with. Supports binding to multiple AP groups.","items":{"type":"string","description":"AP Group ID list that the SSID is associated with. Supports binding to multiple AP groups."}},"band":{"type":"integer","description":"SSID band. The lowest bit indicates whether 2.4G is included; the second lowest bit indicates whether 5G is included; the third lowest bit indicates whether 6G is included; 1 means included while 0 means not included. For example, 7(111) means that 2G/5G/6G are enabled; 1(001) means that 2G is enabled. (When 5G is included，it means 5G/5G1/5G2 are enabled.)","format":"int32"},"guestNetEnable":{"type":"boolean","description":"SSID guest network config status. True: enable, false: disable."},"security":{"type":"integer","description":"SSID security mode; Security should be a value as follows: 0: None; 2: WPA-Enterprise; 3: WPA-Personal; 4: PPSK without RADIUS; 5: PPSK with RADIUS.","format":"int32"},"broadcast":{"type":"boolean","description":"SSID broadcast config status. True: enable, false: disable."},"vlanEnable":{"type":"boolean","description":"SSID VLAN config status. True: enable, false: disable."},"vlanId":{"type":"integer","description":"SSID VLAN ID. This field is required when Parameter [vlanEnable] is true; It should be within the range of 1–4094. If the field vlanSetting is entered, this field must be null.","format":"int32"},"pskSetting":{"$ref":"#/components/schemas/SsidPskSettingOpenApiVO"},"entSetting":{"$ref":"#/components/schemas/SsidEnterpriseSettingOpenApiVO"},"ppskSetting":{"$ref":"#/components/schemas/SsidPpskSettingOpenApiVO"},"mloEnable":{"type":"boolean","description":"SSID MLO config status. True: enable, false: disable."},"pmfMode":{"type":"integer","description":"SSID PMF mode. It should be a value as follows: 1: Mandatory; 2: Capable; 3: Disable.","format":"int32"},"enable11r":{"type":"boolean","description":"SSID 802.11r config status. True: enable, false: disable."},"hidePwd":{"type":"boolean","description":"If this field is true, the SSID password will be hidden."},"greEnable":{"type":"boolean","description":"SSID EoGre Tunnel config status. True: enable, false: disable. This configuration can be enabled only when the [VPN - EoGre Tunnel] global config is enabled;(This configuration applies to the Pro Site of the Omada Pro Controller only)."},"vlanSetting":{"$ref":"#/components/schemas/SsidVlanSettingOpenApiVO"},"prohibitWifiShare":{"type":"boolean","description":"SSID prohibitWifiShare config status. True: enable, false: disable."},"wifiCallingEnable":{"type":"boolean","description":"SSID Wifi Calling config status. True: enable, false: disable."},"wifiCallingId":{"type":"string","description":"The ID of the Wi-Fi calling profile bound to the SSID. When parameter [wifiCallingEnable] is true, it should not be null."},"enhancedIotConnectivity":{"type":"boolean","description":"SSID Enhanced IoT Connectivity config status. True: enable, false: disable. This configuration can be enabled only when the 5GHz and 6GHz bands are disabled, the parameters [versionEnt] and [versionPsk] are not set to 4, and the following configurations are disabled: [hotspotV2Enable], [bandSteer], [arpCastEnable], [loadBalance], [enable11r], [gikRekeyPskEnable], [pmfMode], [mloEnable]."},"CondBroadcastCtrl":{"$ref":"#/components/schemas/CondBroadcastCtrlVO"}}},"CreateSsidResultVO":{"type":"object","properties":{"id":{"type":"string","description":"SSID ID"}}},"OperationResponseCreateSsidResultVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CreateSsidResultVO"}}},"VpnUserRequest":{"required":["password","servers","username"],"type":"object","properties":{"username":{"type":"string","description":"Username of the VPN user."},"password":{"type":"string","description":"Password of the VPN user."},"protocol":{"type":"integer","description":"Protocol should be a value as follows: 0: L2TP or PPTP; 1: openVPN.","format":"int32"},"clientMode":{"type":"integer","description":"Client mode should be a value as follows: 0: Client-To-Site, 1: Site-To-Site.","format":"int32"},"maxConnections":{"type":"integer","description":"Max connections should be within the range of 1–100.","format":"int32"},"userRemoteSubnets":{"type":"array","description":"User remote subnets of the VPN user.","items":{"$ref":"#/components/schemas/IPSubnetsVO"}},"servers":{"type":"array","description":"Servers of the VPN user. Server can be created using 'Create client-to-site VPN server' interface, and server ID can be obtained from 'Get client-to-site VPN server list' interface.","items":{"type":"string","description":"Servers of the VPN user. Server can be created using 'Create client-to-site VPN server' interface, and server ID can be obtained from 'Get client-to-site VPN server list' interface."}},"localIp":{"type":"string","description":"Local IP of the VPN user."}}},"IPsecFailoverSettingOpenApiVO":{"type":"object","properties":{"failover":{"type":"boolean","description":"Indicates whether to use the IPSec failover."},"backupWan":{"type":"string","description":"Backup WAN of the IPSec failover."},"failback":{"type":"boolean","description":"Failback of the IPSec failover."},"failbackTime":{"type":"integer","description":"Failback time should be within the range of 10–3600s.","format":"int32"}},"description":"Setting of the IPSec failover."},"SiteToSiteManualWgPeerConfigVO":{"required":["keepAlive","name","remoteSubnet","serverPublicKey","status"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"The name of WireGuard peer should contain 1 to 64 characters."},"status":{"type":"boolean","description":"Status of the VPN."},"serverPublicKey":{"pattern":"^[0-9a-zA-Z+/]{43}=$","type":"string","description":"The public key of WireGuard VPN must have 44 character of base64 and end with '='."},"remoteIp":{"pattern":"^$|^(((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})$)|(^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?$)","type":"string","description":"Remote IP of the VPN"},"servicePort":{"type":"integer","description":"Service port should be within the range of 1–65535.","format":"int32"},"preSharedKey":{"pattern":"^$|^[0-9a-zA-Z+/]{43}=$","type":"string","description":"The preSharedKey of WireGuard peer must have 44 character of base64 and end with '='."},"remoteSubnet":{"type":"array","description":"IP/MASK address list of client WireGuard peer allowed.","items":{"type":"string","description":"IP/MASK address list of client WireGuard peer allowed."}},"keepAlive":{"type":"integer","description":"The keepalive second of WireGuard peer should be within the range of 0-65535.","format":"int32"},"comment":{"pattern":"^$|^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"The comment of WireGuard peer should contain 0 to 128 characters."}},"description":"List of Site-To-Site manual WireGuard peer Configuration."},"VpnAdvancedSettingOpenApiVO":{"type":"object","properties":{"keyExchangeVersion":{"type":"integer","description":"Key exchange version should be a value as follows: 0: IKEv1; 1: IKEv2.","format":"int32"},"phase1Proposal1":{"type":"integer","description":"Phase1 proposal1 should be a value as follows: 0: MD5; 1: SHA1; 2: SHA256; 3: SHA384; 4: SHA512.","format":"int32"},"phase1Proposal2":{"type":"integer","description":"Phase1 proposal2 should be a value as follows: 0: DES; 1: 3DES; 2: AES128; 3: AES192; 4: AES256.","format":"int32"},"phase1Proposal3":{"type":"integer","description":"Phase1 proposal3 should be a value as follows: 0: DH1; 1: DH2; 2: DH5; 3: DH14; 4: DH15; 5: DH16; 6: DH19; 7: DH20; 8: DH21; 9: DH25; 10: DH26.","format":"int32"},"exchangeMode":{"type":"integer","description":"Exchange mode should be a value as follows: 0: Main Mode; 1: Aggressive Mode.","format":"int32"},"negotiationMode":{"type":"integer","description":"Negotiation mode should be a value as follows: 0: Initiator; 1: Aggressive Mode.","format":"int32"},"localIdType":{"type":"integer","description":"Local ID type should be a value as follows: 0: IP Address; 1: Name.","format":"int32"},"localName":{"type":"string","description":"Local name of the VPN advanced setting."},"remoteIdType":{"type":"integer","description":"Remote ID type should be a value as follows: 0: IP Address; 1: Name.","format":"int32"},"remoteName":{"type":"string","description":"Remote name of the VPN advanced setting."},"saLifetime":{"type":"integer","description":"SA lifetime of the VPN advanced setting should be within the range of 60-604800 seconds.","format":"int32"},"dpd":{"type":"boolean","description":"DPD of the VPN advanced setting."},"dpdInterval":{"type":"integer","description":"DPD interval of the VPN advanced setting should be within the range of 1-300 seconds.","format":"int32"},"encapsulationMode":{"type":"integer","description":"Encapsulation mode should be a value as follows: 0: Tunnel Mode; 1: Transport Mode.","format":"int32"},"phase2Proposal1":{"type":"integer","description":"Phase2 proposal1 should be a value as follows: 0: AH; 1: ESP.","format":"int32"},"phase2Proposal2":{"type":"integer","description":"Phase2 proposal2 should be a value as follows: 0: MD5; 1: SHA1; 2: SHA256; 3: SHA384; 4:SHA512.","format":"int32"},"phase2Proposal3":{"type":"integer","description":"Phase2 proposal3 should be a value as follows: 0: DES; 1: 3DES; 2: AES128; 3: AES192; 4: AES256.","format":"int32"},"pfs":{"type":"integer","description":"PFS should be a value as follows: 0: None; 1: dh1; 2: dh2; 3: dh5; 14: dh14; 15: dh15.","format":"int32"},"saLifetime2":{"type":"integer","description":"SA lifetime2 of the VPN advanced setting should be within the range of 120-604800 seconds.","format":"int32"}},"description":"Advanced setting list of the VPN, only for IPSec type."},"VpnIPSubnetsOpenApiVO":{"required":["ip","mask"],"type":"object","properties":{"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP address, should be a valid IP format."},"mask":{"type":"integer","description":"IP mask, mask should be within the range of 0-32.","format":"int32"}},"description":"Custom networks of the VPN."},"VpnSiteToSiteManualConfigOpenApiVO":{"required":["advancedSetting","mtu","name","preSharedKey","privateKey","remoteIp","remoteSubnet","servicePort","status","tunnelIp","vpnType","wans"],"type":"object","properties":{"name":{"pattern":"^[a-zA-Z0-9_]{1,63}$","type":"string","description":"Name should contain 1 to 63 characters."},"status":{"type":"boolean","description":"Status of the VPN."},"vpnType":{"type":"integer","description":"Vpn type should be a value as follows: 2: IPSec; 4: WireGuard.","format":"int32"},"mtu":{"type":"integer","description":"The MTU of WireGuard VPN should be within the range of 576-1440.","format":"int32"},"servicePort":{"type":"integer","description":"Service port should be within the range of 1–65535.","format":"int32"},"tunnelIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP address."},"privateKey":{"pattern":"^[0-9a-zA-Z+/]{43}=$","type":"string","description":"The private key of WireGuard VPN must have 44 character of base64 and end with '='."},"peers":{"type":"array","description":"List of Site-To-Site manual WireGuard peer Configuration.","items":{"$ref":"#/components/schemas/SiteToSiteManualWgPeerConfigVO"}},"wans":{"type":"array","description":"WAN list of the VPN, only for Manual IPSec type. WAN port ID can be obtained from 'Get internet basic info' interface.","items":{"type":"string","description":"WAN list of the VPN, only for Manual IPSec type. WAN port ID can be obtained from 'Get internet basic info' interface."}},"failoverSetting":{"$ref":"#/components/schemas/IPsecFailoverSettingOpenApiVO"},"remoteIp":{"pattern":"^$|^(((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})$)|(^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?$)","type":"string","description":"Remote IP of the VPN."},"remoteSubnet":{"type":"array","description":"Remote subnet of the VPN.","items":{"type":"string","description":"Remote subnet of the VPN."}},"preSharedKey":{"pattern":"^[\\x21-\\x7E]+$","type":"string","description":"Pre-shared key of the VPN."},"networkType":{"type":"integer","description":"Network type should be a value as follows: 0: network list; 1: custom networks.","format":"int32"},"networkList":{"type":"array","description":"Network list of the VPN. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Network list of the VPN. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface."}},"customNetwork":{"type":"array","description":"Custom networks of the VPN.","items":{"$ref":"#/components/schemas/VpnIPSubnetsOpenApiVO"}},"existCustomNetwork":{"type":"boolean","description":"Whether Local Network Type is Custom."},"advancedSetting":{"$ref":"#/components/schemas/VpnAdvancedSettingOpenApiVO"}}},"VpnSiteToSiteAutoConfigOpenApiVO":{"required":["name","remoteSite","status","vpnType"],"type":"object","properties":{"name":{"pattern":"^[a-zA-Z0-9_]{1,63}$","type":"string","description":"Name should contain 1 to 63 characters."},"status":{"type":"boolean","description":"Status of the VPN."},"vpnType":{"type":"integer","description":"Vpn type should be a value as follows: 2: IPSec; 4: WireGuard.","format":"int32"},"remoteSite":{"type":"string","description":"Remote site of the VPN."}}},"RadiusAuthSettingOpenApiVO":{"required":["authType","defaultGroup","overTime","profileId","repeatTime"],"type":"object","properties":{"profileId":{"type":"string","description":"Profile ID. LDAP profile can be created using 'Create a new LDAP profile' interface, and LDAP profile ID can be obtained from 'Get LDAP profile list' interface. Radius profile can be created using 'Create a new RADIUS profile' interface, and RADIUS profile ID can be obtained from 'Get RADIUS profile list' interface."},"defaultGroup":{"type":"string","description":"Only for SSL VPN. Default user group ID for the user on the LDAP/Radius server. User group can be created using 'Create SSL VPN user group' interface, and user group ID can be obtained from 'Get user group list for SSL VPN server' interface."},"authType":{"type":"integer","description":"Authtype should be a value as follows: 0：PAP; 1:CHAP.","format":"int32"},"repeatTime":{"type":"integer","description":"Repeat time should be within the range of 1–10.","format":"int32"},"overTime":{"type":"integer","description":"Request Timeout, 1~60(s).","format":"int32"},"nasIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"NAS IP"}},"description":"It is required for SSL VPN when parameter [authType] is 2."},"ServerWireGuardClientsConfigVO":{"required":["interfaceIp","name","privateKey"],"type":"object","properties":{"name":{"type":"string","description":"Client name."},"interfaceIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP address."},"privateKey":{"pattern":"^[0-9a-zA-Z+/]{43}=$","type":"string","description":"The private key of WireGuard VPN must have 44 character of base64 and end with '='."},"preSharedKey":{"pattern":"^$|^[0-9a-zA-Z+/]{43}=$","type":"string","description":"The preSharedKey of WireGuard peer must have 44 character of base64 and end with '='."},"allowedAddressStatus":{"type":"boolean","description":"When parameter [allowedAddressStatus] is false, server WireGuard peer allowed address is client interface IP."},"allowedAddress":{"type":"array","description":"IP/MASK address list of server WireGuard peer allowed.","items":{"type":"string","description":"IP/MASK address list of server WireGuard peer allowed."}}},"description":"WireGuard clients."},"VpnBaseAuthSettingOpenApiVO":{"required":["defaultGroup","profileId"],"type":"object","properties":{"profileId":{"type":"string","description":"Profile ID. LDAP profile can be created using 'Create a new LDAP profile' interface, and LDAP profile ID can be obtained from 'Get LDAP profile list' interface. Radius profile can be created using 'Create a new RADIUS profile' interface, and RADIUS profile ID can be obtained from 'Get RADIUS profile list' interface."},"defaultGroup":{"type":"string","description":"Only for SSL VPN. Default user group ID for the user on the LDAP/Radius server. User group can be created using 'Create SSL VPN user group' interface, and user group ID can be obtained from 'Get user group list for SSL VPN server' interface."}},"description":"It is required for SSL VPN when parameter [authType] is 1."},"VpnServerConfigOpenApiVO":{"required":["advancedSetting","exitAtIdle","ipLockSetting","keepAlive","mtu","name","nameLockSetting","preSharedKey","privateKey","remoteIp","servicePort","serviceType","status","vpnType","vpnUserList","wans"],"type":"object","properties":{"name":{"pattern":"^[a-zA-Z0-9_]{1,63}$","type":"string","description":"Name should contain 1 to 63 characters."},"status":{"type":"boolean","description":"Status of the VPN."},"vpnType":{"type":"integer","description":"Vpn type should be a value as follows: 0: L2TP; 1: PPTP; 2: IPSec; 3: OpenVPN; 4: WireGuard; 5: SSL VPN.","format":"int32"},"wans":{"type":"array","description":"WAN list of the VPN. WAN port ID can be obtained from 'Get internet basic info' interface.","items":{"type":"string","description":"WAN list of the VPN. WAN port ID can be obtained from 'Get internet basic info' interface."}},"servicePort":{"type":"integer","description":"Service port should be within the range of 1–65535.","format":"int32"},"customServer":{"type":"boolean","description":"Enable custom server."},"customServerAddress":{"pattern":"^$|^(((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})$)|(^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?$)","type":"string","description":"When parameter [customServer] is enable, parameter [customServerAddress] should be IPv4 address or FQDN."},"ipPoolType":{"type":"integer","description":"IP pool type should be a value as follows: 0: Ip Address/Mask; 1: Ip Address Range.","format":"int32"},"ipPoolStart":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The start IP of the IP pool."},"ipPoolEnd":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The end IP of the IP pool."},"ipPool":{"$ref":"#/components/schemas/IPSubnetsVO"},"mtu":{"type":"integer","description":"The MTU of WireGuard VPN should be within the range of 576-1440.","format":"int32"},"keepAlive":{"type":"integer","description":"The keepalive second of WireGuard peer should be within the range of 0-65535.","format":"int32"},"privateKey":{"pattern":"^[0-9a-zA-Z+/]{43}=$","type":"string","description":"The private key of WireGuard VPN must have 44 character of base64 and end with '='."},"dnsStatus":{"type":"boolean","description":"Dns auto status."},"dns1":{"pattern":"^(?:(?:(25[0-5]|2[0-4]\\d|[01]?\\d\\d?)\\.){3}(25[0-5]|2[0-4]\\d|[01]?\\d\\d?))?$","type":"string","description":"Primary DNS of the VPN."},"dns2":{"pattern":"^(?:(?:(25[0-5]|2[0-4]\\d|[01]?\\d\\d?)\\.){3}(25[0-5]|2[0-4]\\d|[01]?\\d\\d?))?$","type":"string","description":"Secondary DNS of the VPN."},"clients":{"type":"array","description":"WireGuard clients.","items":{"$ref":"#/components/schemas/ServerWireGuardClientsConfigVO"}},"tunnelMode":{"type":"integer","description":"Tunnel mode(only for server OpenVPN) should be a value as follows: 0: split; 1: full.","format":"int32"},"networkType":{"type":"integer","description":"Network type should be a value as follows: 0: network list; 1: custom networks.","format":"int32"},"networkList":{"type":"array","description":"Network list of the VPN. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Network list of the VPN. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface."}},"customNetwork":{"type":"array","description":"Custom networks of the VPN.","items":{"$ref":"#/components/schemas/VpnIPSubnetsOpenApiVO"}},"accountAuth":{"type":"boolean","description":"Whether enable account password of the VPN, only for server OpenVPN."},"authMode":{"type":"integer","description":"Authentication mode should be a value as follows: 0: Local; 1: LDAP; 2:RADIUS.","format":"int32"},"radiusSetting":{"$ref":"#/components/schemas/RadiusAuthSettingOpenApiVO"},"ldapSetting":{"$ref":"#/components/schemas/VpnBaseAuthSettingOpenApiVO"},"ldapProfile":{"type":"string","description":"It is required when parameter [authType] is 1."},"serviceType":{"type":"integer","description":"Service type of the Open VPN should be a value as follows: 0: UDP; 1: TCP.","format":"int32"},"remoteIp":{"pattern":"^$|^(((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})$)|(^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?$)","type":"string","description":"Remote IP of the VPN."},"encryption":{"type":"integer","description":"Encryption should be a value as follows: 0: Encrypted; 1: Unencrypted; 2: Auto.","format":"int32"},"preSharedKey":{"pattern":"^[\\x21-\\x7E]+$","type":"string","description":"Pre-shared key of the VPN."},"advancedSetting":{"$ref":"#/components/schemas/VpnAdvancedSettingOpenApiVO"},"nameLockSetting":{"$ref":"#/components/schemas/LockSettingOpenApiVO"},"ipLockSetting":{"$ref":"#/components/schemas/LockSettingOpenApiVO"},"exitAtIdle":{"type":"boolean","description":"Whether to exit when idle.  It is required when parameter [status] is true."},"exitTime":{"type":"integer","description":"Exit time should be within the range of 5–3600(s). It is required when parameter [exitAtIdle] is true.","format":"int32"},"totalTraffic":{"type":"boolean","description":"Whether to proxy all traffic. It is required when parameter [status] is true."},"vpnUserList":{"type":"array","description":"VPN user ID list.","items":{"type":"string","description":"VPN user ID list."}}}},"VpnCertificateOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"ID of the VPN certificate."},"fileName":{"type":"string","description":"File name of the VPN certificate."}},"description":"VPN configuration of the VPN."},"VpnClientConfigOpenApiVO":{"required":["name","remoteIp","serverPublicKey","servicePort","setup","status","vpnConfiguration","vpnType","wans"],"type":"object","properties":{"name":{"pattern":"^[a-zA-Z0-9_]{1,63}$","type":"string","description":"Name should contain 1 to 63 characters."},"status":{"type":"boolean","description":"Status of the VPN."},"vpnType":{"type":"integer","description":"Vpn type should be a value as follows: 0: L2TP; 1: PPTP; 3: OpenVPN; 4: WireGuard.","format":"int32"},"wans":{"type":"array","description":"WAN list of the VPN. WAN port ID can be obtained from 'Get internet basic info' interface.","items":{"type":"string","description":"WAN list of the VPN. WAN port ID can be obtained from 'Get internet basic info' interface."}},"setup":{"type":"integer","description":"Wire Guard setup should be a value as follows: 0: file; 1: manual.","format":"int32"},"tunnelIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The local IP address of WireGuard VPN."},"servicePort":{"type":"integer","description":"Service port should be within the range of 1–65535.","format":"int32"},"mtu":{"type":"integer","description":"The MTU of WireGuard VPN should be within the range of 576-1440.","format":"int32"},"keepAlive":{"type":"integer","description":"The keepalive second of WireGuard peer should be within the range of 0-65535.","format":"int32"},"clientPort":{"type":"integer","description":"Client port should be within the range of 1–65535.","format":"int32"},"privateKey":{"pattern":"^[0-9a-zA-Z+/]{43}=$","type":"string","description":"The private key of WireGuard VPN must have 44 character of base64 and end with '='."},"serverPublicKey":{"pattern":"^[0-9a-zA-Z+/]{43}=$","type":"string","description":"The public key of WireGuard VPN must have 44 character of base64 and end with '='."},"dns1":{"type":"string","description":"Primary DNS of the VPN."},"dns2":{"type":"string","description":"Secondary DNS of the VPN."},"networkType":{"type":"integer","description":"Network type should be a value as follows: 0: network list; 1: custom networks.","format":"int32"},"networkList":{"type":"array","description":"Network list of the VPN. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Network list of the VPN. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface."}},"customNetwork":{"type":"array","description":"Custom networks of the VPN.","items":{"$ref":"#/components/schemas/VpnIPSubnetsOpenApiVO"}},"remoteIp":{"pattern":"^$|^(((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})$)|(^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?$)","type":"string","description":"Remote IP of the VPN"},"remoteSubnet":{"type":"array","description":"Remote subnet of the VPN.","items":{"type":"string","description":"Remote subnet of the VPN."}},"encryption":{"type":"integer","description":"Encryption should be a value as follows: 0: Encrypted; 1: Unencrypted; 2: Auto.","format":"int32"},"preSharedKey":{"pattern":"^$|^[0-9a-zA-Z+/]{43}=$","type":"string","description":"Pre-shared key of the VPN."},"workingMode":{"type":"integer","description":"Working Mode should be a value as follow: 0:NAT 1:Routing.","format":"int32"},"openVpnMode":{"type":"integer","description":"OpenVPN mode should be a value as follows: 0: certification; 1: certification+account.","format":"int32"},"clientUsername":{"pattern":"^[-A-Za-z0-9`~!@#$&*()=+\\[\\][\\\\\\\\\\\\\\\\]{};:'\\\\\\\\\\\\\\\"|/?.,<>%^_]{1,64}$","type":"string","description":"Client username of the VPN."},"clientPassword":{"pattern":"^[A-Za-z0-9`~!@#$&*()_=+\\[\\][\\\\\\\\]{};:'\\\\\\\"|/?.,<>%^\\\\\\\\/-]{1,128}$","type":"string","description":"Client password of the VPN."},"vpnConfiguration":{"$ref":"#/components/schemas/VpnCertificateOpenApiVO"},"allowedServerAddress":{"type":"array","description":"Wire Guard allowed server address.","items":{"type":"string","description":"Wire Guard allowed server address."}}}},"TopologyRootNode":{"type":"object","properties":{"type":{"type":"string","description":"Root Node Type, which can only be one of the following three types: switch, olt and other."},"mac":{"type":"string","description":"Root Node MAC address, like AA-BB-CC-DD-EE-FF."},"specificType":{"type":"integer","description":"MultiSwitch Node SpecificType, which can only be one of the following two types: 0:Mlag and 1:Vrrp.","format":"int32"},"macList":{"type":"array","description":"MultiSwitch Node MAC list.","items":{"type":"string","description":"MultiSwitch Node MAC list."}},"discoveryMode":{"type":"integer","description":"Discovery Mode, which can only be one of the following two types: 0:Manual and 1:Auto.","format":"int32"}},"description":"Root Node Mac In Topology."},"ClientsQueryMacAndFilterType":{"type":"object","properties":{"mac":{"type":"string","description":"Device mac"},"filterType":{"type":"string","description":"Filter type"}},"description":"Topology clients query mac and filter type."},"TopologyClientsQuery":{"type":"object","properties":{"deviceMacs":{"type":"array","description":"Device macs.","items":{"$ref":"#/components/schemas/ClientsQueryMacAndFilterType"}}},"description":"Topology clients query request body."},"OperationResponseListTopologyDeviceClients":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/TopologyDeviceClients"}}}},"TopologyClientConnectedNetwork":{"type":"object","properties":{"networkId":{"type":"string","description":"Network ID."},"name":{"type":"string","description":"Network name."},"vlanId":{"type":"integer","description":"Vlan Id, for vlan or single vlan interface, ranges from 1 to 4090.","format":"int32"},"vlanIds":{"type":"array","description":"Vlan Ids, for multiple vlan interface, for network .","items":{"type":"integer","description":"Vlan Ids, for multiple vlan interface, for network .","format":"int32"}}},"description":"Network that client connected."},"TopologyClientConnectedSsid":{"type":"object","properties":{"id":{"type":"string","description":"SSID ID."},"name":{"type":"string","description":"SSID Name."},"vlanEnable":{"type":"boolean","description":"Whether the SSID enable vlan."},"vlanIds":{"type":"array","description":"Vlan ID while SSID enable vlan.","items":{"type":"integer","description":"Vlan ID while SSID enable vlan.","format":"int32"}},"clientVlanId":{"type":"integer","description":"Client Report Vlan Id.","format":"int32"}},"description":"SSID that client connected."},"TopologyClientNode":{"type":"object","properties":{"mac":{"type":"string","description":"Client MAC address, like AA-BB-CC-DD-EE-FF."},"name":{"type":"string","description":"Client Name."},"ip":{"type":"string","description":"Client Ip."},"wireless":{"type":"boolean","description":"Whether the client is wireless."},"guest":{"type":"boolean","description":"Whether the client is a guest."},"type":{"type":"string","description":"Client Type."},"vendor":{"type":"string","description":"Client Vendor."},"model":{"type":"string","description":"Client Model."},"devTxRate":{"type":"integer","description":"Realtime txRate","format":"int64"},"devRxRate":{"type":"integer","description":"Realtime rxRate","format":"int64"},"healthScore":{"type":"integer","description":"Client health score.","format":"int32"},"wiredUpInfo":{"$ref":"#/components/schemas/TopologyClientWiredUpInfo"},"wirelessUpInfo":{"$ref":"#/components/schemas/TopologyClientWirelessUpInfo"},"connectedNetwork":{"$ref":"#/components/schemas/TopologyClientConnectedNetwork"},"connectedSsid":{"$ref":"#/components/schemas/TopologyClientConnectedSsid"}},"description":"Client In Topology."},"TopologyClientUplinkPort":{"type":"object","properties":{"port":{"type":"integer","description":"Real Port Number or Port Number of Lag.","format":"int32"},"name":{"type":"string","description":"Name of the Port."},"standardPort":{"type":"string","description":"Standard Port of Stack, for Uplink Device is Stack."},"lagId":{"type":"integer","description":"Lag Id.","format":"int32"},"poePower":{"type":"number","description":"Poe power, unit: W.","format":"double","deprecated":true},"poePowerDecimal":{"type":"number","description":"Poe Power Decimal, unit: W.","format":"double"},"lagPorts":{"type":"array","description":"Lag Ports.","items":{"type":"integer","description":"Lag Ports.","format":"int32"}},"standardLagPorts":{"type":"array","description":"Standard Lag Ports.","items":{"type":"string","description":"Standard Lag Ports."}}},"description":"Uplink port information while connection is wired."},"TopologyClientWiredUpInfo":{"type":"object","properties":{"port":{"$ref":"#/components/schemas/TopologyClientUplinkPort"},"upLinkPort":{"$ref":"#/components/schemas/WiredPortV3DTO"},"linkSpeed":{"type":"integer","description":"Link Speed, it should be a value as follows: 1:10Mbps, 2:100Mbps, 3:1000Mbps, 4:2.5Gbps, 5:10Gbps, 6:5Gbps, 7:25Gbps.","format":"int32"},"duplex":{"type":"integer","description":"Duplex, it should be a value as follows: 1:Half Duplex.","format":"int32"}},"description":"Client uplink information while connection is wired."},"TopologyClientWirelessLinkInfo":{"type":"object","properties":{"radioId":{"type":"integer","description":"RadioId, it should be a value as follows: 0:2G, 1:5G, 2:5G2, 3:6G.","format":"int32"},"channel":{"type":"integer","description":"Channel.","format":"int32"},"rssi":{"type":"integer","description":"Signal strength, unit: dBm","format":"int32"}},"description":"Client wireless link information."},"TopologyClientWirelessUpInfo":{"type":"object","properties":{"ssid":{"type":"string","description":"Ssid."},"radio":{"type":"integer","description":"Radio, it should be a value as follows: 0:2G, 1:5G, 2:5G2, 3:6G.","format":"int32"},"channel":{"type":"integer","description":"Channel.","format":"int32"},"rssi":{"type":"integer","description":"Signal strength, unit: dBm","format":"int32"},"support5g2":{"type":"boolean","description":"Whether the device supports the 5G2 frequency band."},"multiLink":{"type":"array","description":"Client link information while client connects to multiple frequency bands.","items":{"$ref":"#/components/schemas/TopologyClientWirelessLinkInfo"}}},"description":"Client uplink information while connection is wireless."},"TopologyDeviceClients":{"type":"object","properties":{"clientGroup":{"type":"array","description":"Client Group.","items":{"$ref":"#/components/schemas/TopologyClientNode"}},"devMac":{"type":"string","description":"Device Mac."}},"description":"Clients In Device."},"StatQueryVO":{"required":["attrs","end","start"],"type":"object","properties":{"start":{"type":"integer","description":"Start time, number of seconds from UTC0 1970/01/01","format":"int64"},"end":{"type":"integer","description":"end time, number of seconds from UTC0 1970/01/01","format":"int64"},"attrs":{"type":"array","description":"Attributes to be queried. Attributes not included in attrs will return a value of 0 or be omitted. The supported attrs and response fields depend on the device type and statistic granularity. For details, refer to section 5.9.1 Device Statistics of the Open API Access Guide.","items":{"type":"string","description":"Attributes to be queried. Attributes not included in attrs will return a value of 0 or be omitted. The supported attrs and response fields depend on the device type and statistic granularity. For details, refer to section 5.9.1 Device Statistics of the Open API Access Guide."}},"ports":{"type":"array","description":"The ports in the lag. Each item is Integer, for example: [1, 2].","items":{"type":"integer","description":"The ports in the lag. Each item is Integer, for example: [1, 2].","format":"int32"}},"standardPorts":{"type":"array","description":"Statistics of the selected ports would be queried , the param is valid when stacking","items":{"type":"string","description":"Statistics of the selected ports would be queried , the param is valid when stacking"}},"oltPorts":{"type":"array","description":"Statistics of the selected ports of olt would be queried.","items":{"type":"string","description":"Statistics of the selected ports of olt would be queried."}}}},"BaseDeviceStatDTO":{"type":"object","properties":{"time":{"type":"integer","description":"sampling moment","format":"int64"},"cpu":{"type":"integer","description":"Utilization of cpu","format":"int32"},"mem":{"type":"integer","description":"Utilization of memory","format":"int32"},"rebootTimes":{"type":"integer","description":"reboot times","format":"int32"},"mac":{"type":"string","description":"the mac of the device"}}},"OperationResponseBaseDeviceStatDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/BaseDeviceStatDTO"}}},"BatchConfigIotBtIbeaconV2OpenApiVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the Bluetooth Advertising setting.(Disable by default)"},"measurePower":{"type":"integer","description":"RSSI Calibration Value. The parameter [measurePower] is used to input the RSSI measured at a 1-meter distance from the device, enabling positioning functionality.(-65 by default)","format":"int32"},"advInterval":{"type":"integer","description":"Advertising interval in milliseconds.(500 by default)","format":"int32"},"uuid":{"type":"string","description":"The UUID (Universally Unique Identifier) of the advertising ibeacon packet."},"major":{"type":"string","description":"The major value of adverting ibeacon packet, indicating a larger group."},"minor":{"type":"string","description":"The minor value of adverting ibeacon packet, indicating a smaller group."}},"description":"Ibeacon config."},"BatchModifyIbeaconV2OpenApiVO":{"type":"object","properties":{"config":{"$ref":"#/components/schemas/BatchConfigIotBtIbeaconV2OpenApiVO"},"ids":{"uniqueItems":true,"type":"array","description":"A set of Bluetooth Advertising entry ids to be modified.","items":{"type":"string","description":"A set of Bluetooth Advertising entry ids to be modified."}}}},"NetworkReportScheduleVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean"},"tab":{"type":"integer","format":"int32"},"tabIdList":{"type":"array","items":{"type":"string"}},"reportName":{"type":"string"},"reportType":{"type":"integer","format":"int32"},"emailList":{"type":"array","items":{"type":"string"}},"time":{"type":"integer","format":"int64"},"cards":{"type":"string"},"timingType":{"type":"integer","format":"int32"},"hour":{"type":"integer","format":"int32"},"minute":{"type":"integer","format":"int32"},"dayOfWeek":{"type":"integer","format":"int32"},"dayOfMonth":{"type":"integer","format":"int32"},"monthOfYear":{"type":"integer","format":"int32"}}},"ReportExportV2":{"required":["end","reportName","reportType","start","tabIdList"],"type":"object","properties":{"start":{"type":"integer","description":"The report start time","format":"int64"},"end":{"type":"integer","description":"The report end time","format":"int64"},"reportName":{"type":"string","description":"The report name"},"reportType":{"type":"integer","description":"The report type. 0 : pdf, 1 : csv.","format":"int32"},"tabIdList":{"type":"array","description":"The tab need to export","items":{"type":"string","description":"The tab need to export"}},"emailList":{"type":"array","description":"The email list to send report","items":{"type":"string","description":"The email list to send report"}}}},"NetworkReportScheduleLaterVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean"},"tab":{"type":"integer","format":"int32"},"tabIdList":{"type":"array","items":{"type":"string"}},"cards":{"type":"string"},"reportName":{"type":"string"},"reportType":{"type":"integer","format":"int32"},"emailList":{"type":"array","items":{"type":"string"}},"minute":{"type":"integer","format":"int32"},"hour":{"type":"integer","format":"int32"},"time":{"type":"integer","format":"int64"},"start":{"type":"integer","format":"int64"},"end":{"type":"integer","format":"int64"}}},"PPSKExpirationVO":{"type":"object","properties":{"type":{"type":"integer","description":"Expiration type, should be a value as follows: 0: Never expire. 1: PPSK can be used between the effective time and expiration time. 2: PPSK can be used after a period of time of creation. 3: PPSK can be used during designated time periods every day","format":"int32"},"effectiveTime":{"type":"integer","description":"The timestamp when the PPSK takes effect, unit: millisecond. When parameter [type] is 1, parameter [effectiveTime] is required","format":"int64"},"expirationTime":{"type":"integer","description":"The timestamp of the expiration of PPSK, unit: millisecond. When parameter [type] is 1, parameter [expirationTime] is required","format":"int64"},"duration":{"type":"integer","description":"Duration of one use. When parameter [type] is 2, parameter [duration] is required","format":"int32"},"durationUnit":{"type":"integer","description":"Unit of  parameter [duration], should be a value as follows: 0: hour, 1: day, 2: week. When parameter [type] is 2, parameter [duration] is required","format":"int32"},"dayStartHour":{"type":"integer","description":"The hour of start time, should be within the range of 0-23. When parameter [type] is 3, parameter [dayStartHour] is required","format":"int32"},"dayStartMin":{"type":"integer","description":"The minute of start time, should be within the range of 0-59 When parameter [type] is 3, parameter [dayStartMin] is required","format":"int32"},"dayEndHour":{"type":"integer","description":"The hour of end time, should be within the range of 0-23 When parameter [type] is 3, parameter [dayEndHour] is required","format":"int32"},"dayEndMin":{"type":"integer","description":"The minute of end time, should be within the range of 0-59 When parameter [type] is 3, parameter [dayEndMin] is required","format":"int32"}},"description":"PPSK Profile expiration time config."},"PPSKRateLimitSettingVO":{"type":"object","properties":{"rateLimitProfileId":{"type":"string","description":"This field represents Rate limit profile ID. Rate limit profile can be created using 'Create rate limit profile' interface, and Rate limit profile ID can be obtained from 'Get rate limit profile list' interface"},"downLimitEnable":{"type":"boolean","description":"Whether to limit downlink speed; This field is required when select custom setting. True: enable, false: disable."},"downLimit":{"type":"integer","description":"Downlink speed limit value. When the value of Parameter [downLimitType] is 0(Kbps), downLimit should be within the range of 1–10485760; when the value of Parameter [downLimitType] is 1(Mbps), downLimit should be within the range of 1-10240.","format":"int32"},"downLimitType":{"type":"integer","description":"Downlink speed limit unit config; DownLimitType should be a value as follows: 0: Kbps; 1: Mbps.","format":"int32"},"upLimitEnable":{"type":"boolean","description":"Whether to limit uplink speed; This field is required when select custom setting. True: enable, false: disable."},"upLimit":{"type":"integer","description":"Uplink speed limit value. When the value of Parameter [upLimitType] is 0(Kbps), upLimit should be within the range of 1–10485760; when the value of Parameter [upLimitType] is 1(Mbps), upLimit should be within the range of 1-10240.","format":"int32"},"upLimitType":{"type":"integer","description":"Uplink speed limit unit config; UpLimitType should be a value as follows: 0: Kbps; 1: Mbps.","format":"int32"}},"description":"PPSK Profile Rate Limit config."},"PpskProfile V2":{"required":["autoCreatePsks","profileName"],"type":"object","properties":{"profileName":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,62}[^ ]$","type":"string","description":"PPSK Profile Name, should contain 1 to 64 characters."},"autoCreatePsks":{"type":"boolean","description":"Whether to enable auto create psks"},"ppsk":{"type":"array","description":"This field is required when Parameter [autoCreatePsks] is false; PPSK List In the PPSK Profile","items":{"$ref":"#/components/schemas/PpskSetting V2"}},"number":{"type":"integer","description":"This field is required when Parameter [autoCreatePsks] is true; Generate Number, should be within the range of 1-1024.","format":"int32"},"prefix":{"pattern":"^[a-zA-z0-9'!\"#$%&()*,./:;?^_`\\[\\]{|}~<>\\ ][\\041-\\0176]{0,59}$","type":"string","description":"This field is required when Parameter [autoCreatePsks] is true; PSK Name Prefix, should contain 1 to 60 visible ASCII characters."},"length":{"type":"integer","description":"This field is required when Parameter [autoCreatePsks] is true; PSK Password Length, should be within the range of 8-63.","format":"int32"},"vlan":{"type":"integer","description":"This field is required when Parameter [autoCreatePsks] is true; PSK Bound Vlan, should be within the range of 1-4094.","format":"int32"},"vlanPool":{"type":"string","description":"This field is required when Parameter [autoCreatePsks] is true; PSK Bound Vlan range, should be like: 10-1000."},"vlanInterval":{"maximum":4093,"minimum":0,"type":"integer","description":"This field is required when Parameter [autoCreatePsks] is true; The interval of vlan when auto creating psk","format":"int32"},"rateLimit":{"$ref":"#/components/schemas/PPSKRateLimitSettingVO"},"expiration":{"$ref":"#/components/schemas/PPSKExpirationVO"}},"description":"PPSK Profile Setting."},"PpskSetting V2":{"required":["name","psk"],"type":"object","properties":{"name":{"pattern":"^[a-zA-z0-9'!\"#$%&()*,./:;?^_`\\[\\]{|}~<>\\ ][\\041-\\0176]{0,63}$","type":"string","description":"PPSK Name, should contain 1 to 64 characters."},"psk":{"pattern":"^([A-Za-z0-9\\p{Punct} ]{8,63}|[0-9a-fA-F]{8,63})$","type":"string","description":"Password, should contain 8 to 63 visible ASCII characters."},"mac":{"pattern":"^([0-9A-F][02468ACE](:[0-9A-F]{2}){5})|([0-9a-f][02468ace](:[0-9a-f]{2}){5})|([0-9A-F][02468ACE](-[0-9A-F]{2}){5})|([0-9a-f][02468ace](-[0-9a-f]{2}){5})|([0-9A-F][02468ACE]([0-9A-F]{2}){5})|([0-9a-f][02468ace]([0-9a-f]{2}){5})$","type":"string","description":"Mac Bound With PSK.The MAC format requires the use of numbers and uppercase letters and connectors, such as AA-BB-CC-00-11-22."},"vlan":{"type":"integer","description":"Vlan Bound With PSK, should be within the range of 1-4094.","format":"int32"}},"description":"This field is required when Parameter [autoCreatePsks] is false; PPSK List In the PPSK Profile"},"OperationResponseResponseIdVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ResponseIdVO"}}},"LanNetworkOpenApiV2VO":{"required":["igmpSnoopEnable","name","purpose"],"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"LAN network name should contain 1 to 128 characters."},"purpose":{"type":"integer","description":"LAN network purpose should be a value as follows: 0: VLAN; 1: interface","format":"int32"},"interfaceIds":{"type":"array","description":"Gateway LAN port IDs, which are acquired from \"Check WAN/LAN status\"","items":{"type":"string","description":"Gateway LAN port IDs, which are acquired from \"Check WAN/LAN status\""}},"vlanType":{"type":"integer","description":"When purpose is interface, VLANType should be a value as follows: 0: Single; 1: Multiple","format":"int32"},"vlans":{"pattern":"^[\\d|\\d-\\d]+(,[\\d|\\d-\\d]+)*$","type":"string","description":"When purpose is \"interface\" and VLANType is 1, batch create VLANs. VLAN format: 200, 1-100."},"vlan":{"type":"integer","description":"Only Valid when vlanType is 0. Vlan should be within the range of 1-4094.","format":"int32"},"application":{"type":"integer","description":"Effective device type should be a value as follows: 0: Gateway and Switch; 1: Switch","format":"int32"},"gatewaySubnet":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])/(\\d|((1|2)\\d)|(30))\\b","type":"string","description":"When purpose is interface, gateway subnet is needed. Format: IP/Mask"},"dhcpSettingsVO":{"$ref":"#/components/schemas/DhcpSettingConfig"},"domain":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"The domain of this network"},"igmpSnoopEnable":{"type":"boolean","description":"Enable IGMP snooping"},"mldSnoopEnable":{"type":"boolean","description":"Enable MLD snooping"},"dhcpL2RelayEnable":{"type":"boolean","description":"The switch of DHCP L2 relay"},"dhcpGuard":{"$ref":"#/components/schemas/Dhcp Servers setting"},"dhcpv6Guard":{"$ref":"#/components/schemas/Dhcpv6 Servers setting"},"lanNetworkIpv6Config":{"$ref":"#/components/schemas/Lan network IPV6 config"},"allLan":{"type":"boolean","description":"When Internet pre-config is closed or Internet pre-config is Universal, allLAN is \"true\"; after adopting gateway, allLAN is \"false\"."},"qosQueueEnable":{"type":"boolean","description":"The switch of QoS queue."},"queueId":{"type":"integer","description":"QoS queue Id.","format":"int32"},"subnetOverrideEnable":{"type":"boolean","description":"The switch status of DHCP Settings Overrides."}},"description":"LANNetworkOpenApiVO"},"ClientQueryDataOpenApiVO":{"required":["page","pageSize"],"type":"object","properties":{"page":{"type":"integer","description":"Start from 1.","format":"int32"},"pageSize":{"type":"integer","description":"It should be within the range of 1–1000.","format":"int32"},"sorts":{"type":"object","additionalProperties":{"maxLength":1,"minLength":0,"type":"string","description":"Sort rule, key: sort field, value: sort direction, value parameter may be one of asc or desc.Optional parameter."},"description":"Sort rule, key: sort field, value: sort direction, value parameter may be one of asc or desc.Optional parameter."},"searchKey":{"maxLength":128,"minLength":1,"type":"string","description":"Fuzzy query parameters, support field name, mac, ip."},"filters":{"$ref":"#/components/schemas/ClientQueryFiltersOpenApiVO"},"scope":{"type":"integer","description":"Scope of clients to query, 0: all, 1: online(default), 2:offline, 3:blocked.","format":"int32"}}},"ClientQueryFiltersOpenApiVO":{"type":"object","properties":{"wireless":{"type":"boolean","description":"Filter by wireless, This filter will not affect clientStat result."},"ipcNvr":{"type":"boolean","description":"Filter by ipcNvr, This filter will not affect clientStat result. true : filter by client type IPC or NVR, false or null: NOT filter by client type."},"ipExist":{"type":"boolean","description":"Filter by ipExist. true : Filter clients with existing IP addresses, false or null: unfiltered client."},"guest":{"type":"array","description":"Filter by guest, effective only when wireless is true.","items":{"type":"boolean","description":"Filter by guest, effective only when wireless is true."}},"radioId":{"type":"array","description":"Filter by radio Id. 0 : 2.4G, 1 : 5G-1, 2 : 5G-2, 3 : 6G","items":{"type":"integer","description":"Filter by radio Id. 0 : 2.4G, 1 : 5G-1, 2 : 5G-2, 3 : 6G","format":"int32"}},"deviceMac":{"type":"array","description":"Filter by the mac of connected device.","items":{"type":"string","description":"Filter by the mac of connected device."}},"device":{"type":"array","description":"Filter by the name of connected device.","items":{"type":"string","description":"Filter by the name of connected device."}},"deviceType":{"type":"array","description":"Filter by the type of client.","items":{"type":"string","description":"Filter by the type of client."}},"model":{"type":"string","description":"Filter by the model."},"vendor":{"type":"array","description":"Filter by vendor.","items":{"type":"string","description":"Filter by vendor."}},"ssid":{"type":"array","description":"Filter by ssid.","items":{"type":"string","description":"Filter by ssid."}},"network":{"type":"array","description":"Filter by lan network name.","items":{"type":"string","description":"Filter by lan network name."}},"vid":{"type":"string","description":"Filter by VLAN id, vid should be a string like 1,100-200."},"timeStart":{"type":"integer","description":"Filter by lastSeen.","format":"int64"},"timeEnd":{"type":"integer","description":"Filter by lastSeen.","format":"int64"},"authStatus":{"type":"array","description":"Filter by authStatus, 0: CONNECTED, 1: PENDING, 2: AUTHED, 3: AUTH_FREE","items":{"type":"integer","description":"Filter by authStatus, 0: CONNECTED, 1: PENDING, 2: AUTHED, 3: AUTH_FREE","format":"int32"}},"authType":{"maxLength":128,"minLength":1,"type":"string","description":"Filter by authentication type"},"sourceTime":{"type":"integer","description":"Filter by history health data.","format":"int64"},"health":{"type":"integer","description":"Filter by health score, 0:No Data, 1 : poor 2 : fair 3 : good","format":"int32"}},"description":"Filters of the query."},"ApBriefInfoVO":{"type":"object","properties":{"name":{"type":"string","description":"AP name."},"mac":{"type":"string","description":"AP MAC, for example: AA-AA-AA-AA-AA-AA."}},"description":"AP name and MAC info list."},"AuthInfoOpenApiVO":{"type":"object","properties":{"authType":{"type":"integer","description":"Auth type should be a value as follows: 0: No Auth; 1: Simple Password; 2: External Radius; 3: Voucher; 4: External Portal Server; 5: Local User; 6: SMS; 7: Facebook; 8: Hotspot Radius; 9: Mac Auth (with fail over); 10: Admin auth; 12: Form auth; 15: LDAP","format":"int32"},"info":{"type":"string","description":"Auth brief information"}},"description":"Client portal authentication information"},"Client Ip Setting":{"required":["useFixedAddr"],"type":"object","properties":{"useFixedAddr":{"type":"boolean","description":"Whether to use the specified IP."},"netId":{"type":"string","description":"LAN network ID."},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Client IP."},"serverType":{"type":"string","description":"DHCP Sever Type."},"serverMac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"DHCP Server Mac."},"serverStackId":{"type":"string","description":"DHCP Sever Stack ID."}},"description":"Client IP setting."},"Client Lock To Ap Setting":{"type":"object","properties":{"enable":{"type":"boolean","description":"Lock to AP enable."},"aps":{"type":"array","description":"AP name and MAC info list.","items":{"$ref":"#/components/schemas/ApBriefInfoVO"}}},"description":"Client lock to ap setting."},"Client Multifrequency Info":{"type":"object","properties":{"radioId":{"type":"integer","description":"Radio ID should be a value as follows: 0: 2.4GHz; 1: 5GHz-1; 2:5GHz-2; 3: 6GHz.","format":"int32"},"wifiMode":{"type":"integer","description":"Wi-Fi mode should be a value as follows: 0: 11a; 1: 11b; 2: 11g; 3: 11na; 4: 11ng; 5: 11ac; 6: 11axa; 7: 11axg.","format":"int32"},"channel":{"type":"integer","description":"(Wireless)  Actual channel.","format":"int32"},"rxRate":{"type":"integer","description":"(Wireless) Uplink negotiation rate (Kbit/s).","format":"int64"},"txRate":{"type":"integer","description":"(Wireless) Downlink negotiation rate (Kbit/s).","format":"int64"},"powerSave":{"type":"boolean","description":"(Wireless)  true: Power save mode enabled."},"rssi":{"type":"integer","description":"(Wireless) Signal strength, unit: dBm.","format":"int32"},"snr":{"type":"integer","description":"(Wireless) Signal Noise Ratio.","format":"int32"},"signalLevel":{"type":"integer","description":"(Wireless) Signal strength percentage should be within the range of 0-100.","format":"int32"},"signalRank":{"type":"integer","description":"(Wireless) Signal strength level should be within the range of 0-5.","format":"int32"},"upPacket":{"type":"integer","description":"Number of upstream packets.","format":"int64"},"downPacket":{"type":"integer","description":"Number of downstream packets.","format":"int64"},"trafficDown":{"type":"integer","description":"Downstream traffic (Byte).","format":"int64"},"trafficUp":{"type":"integer","description":"Upstream traffic (Byte).","format":"int64"},"activity":{"type":"integer","description":"Real-time downlink rate (Byte/s).","format":"int64"},"signalLevelAndRank":{"type":"integer","format":"int32","writeOnly":true}},"description":"(Wireless) Client multifrequency info list."},"ClientGridVOOpenApi Client Info":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OpenApi Client Info"}},"clientStat":{"$ref":"#/components/schemas/ClientStatVO"},"clientTypeStat":{"$ref":"#/components/schemas/ClientTypeStatVO"}}},"ClientStatVO":{"type":"object","properties":{"total":{"type":"integer","format":"int32"},"wireless":{"type":"integer","format":"int32"},"wired":{"type":"integer","format":"int32"},"numOffline":{"type":"integer","format":"int64"},"num2g":{"type":"integer","format":"int32"},"num5g":{"type":"integer","format":"int32"},"num6g":{"type":"integer","format":"int32"},"numUser":{"type":"integer","format":"int32"},"numGuest":{"type":"integer","format":"int32"},"ipc":{"type":"integer","format":"int32"},"numWirelessUser":{"type":"integer","format":"int32"},"numWirelessGuest":{"type":"integer","format":"int32"},"num2gUser":{"type":"integer","format":"int32"},"num5gUser":{"type":"integer","format":"int32"},"num6gUser":{"type":"integer","format":"int32"},"num2gGuest":{"type":"integer","format":"int32"},"num5gGuest":{"type":"integer","format":"int32"},"num6gGuest":{"type":"integer","format":"int32"},"poor":{"type":"integer","format":"int32"},"fair":{"type":"integer","format":"int32"},"noData":{"type":"integer","format":"int32"},"good":{"type":"integer","format":"int32"}}},"ClientTypeStatVO":{"type":"object","properties":{"total":{"type":"integer","format":"int32"},"mobile":{"type":"integer","format":"int32"},"office":{"type":"integer","format":"int32"},"camera":{"type":"integer","format":"int32"},"audioVideo":{"type":"integer","format":"int32"},"smartHome":{"type":"integer","format":"int32"},"network":{"type":"integer","format":"int32"},"other":{"type":"integer","format":"int32"}}},"OpenApi Client Info":{"type":"object","properties":{"id":{"type":"string","description":"Client ID."},"mac":{"type":"string","description":"Client MAC Address."},"name":{"type":"string","description":"Client Name, alias."},"hostName":{"type":"string","description":"Host name, device name."},"vendor":{"type":"string","description":"Vendor."},"deviceType":{"type":"string","description":"Device Type: iphone, ipod, android, pc, printer, tv..."},"deviceCategory":{"type":"string","description":"Device Category: loT, TV, computer, phone..."},"osName":{"type":"string","description":"Device system version."},"model":{"type":"string","description":"Model of client device."},"ip":{"type":"string","description":"IP Address."},"ipv6List":{"type":"array","description":"IPv6 Address.","items":{"type":"string","description":"IPv6 Address."}},"connectType":{"type":"integer","description":"Connect type should be a value as follows: 0: wireless guest; 1: wireless user; 2: wired user.","format":"int32"},"connectDevType":{"type":"string","description":"connect device type should be a value as follows: ap, switch, gateway."},"connectedToWirelessRouter":{"type":"boolean","description":"true: Client is connecting to a wireless router."},"wireless":{"type":"boolean","description":"true: Wireless device (connectDevType=ap);  false: Not wireless device(connectDevType=switch or gateway)."},"ssid":{"type":"string","description":"(Wireless)  SSID name."},"signalLevel":{"type":"integer","description":"(Wireless) Signal strength percentage should be within the range of 0-100.","format":"int32"},"healthScore":{"type":"integer","description":"1~3: poor; 4~7: fair; 0: no data; 8~10 good.","format":"int32"},"signalRank":{"type":"integer","description":"(Wireless) Signal strength level should be within the range of 0-5.","format":"int32"},"wifiMode":{"type":"integer","description":"(Wireless) Wifi mode should be a value as follows: 0: 11a; 1: 11b; 2: 11g; 3: 11na; 4: 11ng; 5: 11ac; 6: 11axa; 7: 11axg; 8: 11beg; 9: 11bea.","format":"int32"},"apName":{"type":"string","description":"(Wireless)  AP Name."},"apMac":{"type":"string","description":"(Wireless)  AP MAC Address."},"radioId":{"type":"integer","description":"(Wireless) Radio ID should be a value as follows: 0: 2.4GHz; 1: 5GHz-1; 2:5GHz-2; 3: 6GHz.","format":"int32"},"channel":{"type":"integer","description":"(Wireless)  Actual channel.","format":"int32"},"rxRate":{"type":"integer","description":"(Wireless) Uplink negotiation rate (Kbit/s).","format":"int64"},"txRate":{"type":"integer","description":"(Wireless) Downlink negotiation rate (Kbit/s).","format":"int64"},"powerSave":{"type":"boolean","description":"(Wireless)  true: Power save mode enabled."},"rssi":{"type":"integer","description":"(Wireless) Signal strength, unit: dBm.","format":"int32"},"snr":{"type":"integer","description":"(Wireless) Signal Noise Ratio.","format":"int32"},"switchMac":{"type":"string","description":"(Wired, connectDevType=switch)  Switch MAC address."},"switchName":{"type":"string","description":"(Wired, connectDevType=switch)  Switch name."},"supportLocate":{"type":"boolean","description":"Whether the client supports locate.True when the client is wired connected to a switch or stack that supports locate port."},"locateEnable":{"type":"boolean","description":"Whether locate function is enabled"},"gatewayMac":{"type":"string","description":"(Wired, connectDevType=gateway)  Gateway MAC Address."},"gatewayName":{"type":"string","description":"(Wired, connectDevType=gateway)  Gateway name."},"vid":{"type":"integer","description":"(Wired) vlan.","format":"int32"},"networkName":{"type":"string","description":"(Wired) Network name."},"dot1xIdentity":{"type":"string","description":"(Wired) 802.1x authentication identity."},"dot1xVlan":{"type":"integer","description":"(Wired) Network name corresponding to the VLAN obtained by 802.1x D-VLAN.","format":"int32"},"port":{"type":"integer","description":"(Wired) Port ID.","format":"int32"},"portName":{"type":"string","description":"(Wired) Port name."},"lagId":{"type":"integer","description":"(Wired) LAG ID. Exists only when the client is connected to the LAG.","format":"int32"},"switchPortsInLag":{"uniqueItems":true,"type":"array","description":"Switch ports in Lag. Exists only when lagId exists and stackId is null","items":{"type":"integer","description":"Switch ports in Lag. Exists only when lagId exists and stackId is null","format":"int32"}},"stPortsInLag":{"uniqueItems":true,"type":"array","description":"Standard switch ports in Lag. Exists only when lagId exists and stackId exists","items":{"type":"string","description":"Standard switch ports in Lag. Exists only when lagId exists and stackId exists"}},"activity":{"type":"integer","description":"Real-time downlink rate (Byte/s).","format":"int64"},"uploadActivity":{"type":"integer","description":"Real-time uplink rate (Byte/s).","format":"int64"},"trafficDown":{"type":"integer","description":"Downstream traffic (Byte).","format":"int64"},"trafficUp":{"type":"integer","description":"Upstream traffic (Byte).","format":"int64"},"uptime":{"type":"integer","description":"Up time (unit: s).","format":"int64"},"lastSeen":{"type":"integer","description":"Last found time, timestamp (ms).","format":"int64"},"authStatus":{"type":"integer","description":"Authentication status should be a value as follows: 0: CONNECTED // Access without any authentication method; 1: PENDING // Access to Portal, but authentication failed; 2: AUTHORIZED // Pass through portal, pass other authentication without portal; 3: AUTH-FREE // No portal authentication required.","format":"int32"},"blocked":{"type":"boolean","description":"Whether the client is blocked."},"guest":{"type":"boolean","description":"(Wireless) Whether it is Guest (used to display the wireless Guest client icon)."},"active":{"type":"boolean","description":"Whether the client is online."},"manager":{"type":"boolean","description":"Whether it is the client currently being managed."},"ipSetting":{"$ref":"#/components/schemas/Client Ip Setting"},"downPacket":{"type":"integer","description":"Number of downstream packets.","format":"int64"},"upPacket":{"type":"integer","description":"Number of upstream packets.","format":"int64"},"rateLimit":{"$ref":"#/components/schemas/Rate Limit Setting of Client"},"clientLockToApSetting":{"$ref":"#/components/schemas/Client Lock To Ap Setting"},"support5g2":{"type":"boolean","description":"Whether the client is connecting under 5g2."},"multiLink":{"type":"array","description":"(Wireless) Client multifrequency info list.","items":{"$ref":"#/components/schemas/Client Multifrequency Info"}},"unit":{"type":"integer","description":"Unit ID.","format":"int32"},"standardPort":{"type":"string","description":"Standard port."},"systemName":{"type":"string","description":"Device system name."},"description":{"type":"string","description":"Device description."},"capabilities":{"type":"array","description":"One or more of the following values: Station、DOCSIS cable device、Telephone、Router、WLAN access point、Bridge、Repeater、other.","items":{"type":"string","description":"One or more of the following values: Station、DOCSIS cable device、Telephone、Router、WLAN access point、Bridge、Repeater、other."}},"blockDisable":{"type":"boolean","description":"Block client disabled, default value: false."},"dhcpLeaseTime":{"type":"integer","description":"DHCP lease time, unit seconds","format":"int64"},"stackableSwitch":{"type":"boolean","description":"Whether the connected device is a stackable switch."},"stackId":{"type":"string","description":"Stack Id"},"stackName":{"type":"string","description":"Stack name"},"ppskProfileName":{"type":"string","description":"(Wireless)  SSID PPSK profile name"},"incidentNum":{"type":"integer","description":"Number of anomaly incidents in the last 10 minutes.","format":"int32"},"authInfo":{"type":"array","description":"Client portal authentication information","items":{"$ref":"#/components/schemas/AuthInfoOpenApiVO"}}}},"OperationResponseClientGridVOOpenApi Client Info":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ClientGridVOOpenApi Client Info"}}},"Rate Limit Setting of Client":{"type":"object","properties":{"rateLimitId":{"type":"string","description":"Rate limit profile ID. Nullable when ratelimit type is custom."},"enable":{"type":"boolean","description":"Rate limit enable."},"upEnable":{"type":"boolean","description":"Up limit enable."},"upUnit":{"type":"integer","description":"Up limit unit should be a value as follows: 1: Kbps; 2: Mbps.","format":"int32"},"upLimit":{"type":"integer","description":"Up limit should be within the range of 1–1024.","format":"int64"},"downEnable":{"type":"boolean","description":"Down limit enable."},"downUnit":{"type":"integer","description":"Down limit unit should be a value as follows: 1: Kbps; 2: Mbps.","format":"int32"},"downLimit":{"type":"integer","description":"Down limit should be within the range of 1–1024.","format":"int64"}},"description":"RateLimit setting."},"RFScanCommand":{"type":"object","properties":{"radioIdList":{"type":"array","description":"Parameter [radioIdList] indicates the set of frequency bands for radio frequency scan. The value range of each element in the list should be between 0 and 3. 0: 2.4GHz, 1: 5GHz, 2: 5GHz-2, 3: 6GHz. This parameter takes effect only when the device supports selecting bands for radio frequency scan; If the device does not support selecting bands, or if this parameter is not passed or is an empty list, the device will perform radio frequency scan for all its frequency bands.","items":{"type":"integer","description":"Parameter [radioIdList] indicates the set of frequency bands for radio frequency scan. The value range of each element in the list should be between 0 and 3. 0: 2.4GHz, 1: 5GHz, 2: 5GHz-2, 3: 6GHz. This parameter takes effect only when the device supports selecting bands for radio frequency scan; If the device does not support selecting bands, or if this parameter is not passed or is an empty list, the device will perform radio frequency scan for all its frequency bands.","format":"int32"}}}},"OperationResponseVpnCertificateVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VpnCertificateVO"}}},"VpnCertificateVO":{"type":"object","properties":{"id":{"type":"string"},"fileName":{"type":"string"},"remoteIp":{"type":"string"},"servicePort":{"type":"integer","format":"int32"},"openVpnMode":{"type":"integer","format":"int32"},"privateKey":{"type":"string"},"publicKey":{"type":"string"},"serverPublicKey":{"type":"string"},"preSharedKey":{"type":"string"},"localIp":{"type":"string"},"dns1":{"type":"string"},"dns2":{"type":"string"},"allowedServerAddress":{"type":"array","items":{"type":"string"}},"keepAlive":{"type":"integer","format":"int32"}}},"ExportMessage":{"required":["endTime","format","startTime","type"],"type":"object","properties":{"type":{"type":"integer","description":"Message parameter [type] should be 0 or 1. 0:inbox; 1:outbox.","format":"int32"},"format":{"type":"integer","description":"Message parameter [format] should be 0 or 1. 0:csv; 1:xlsx.","format":"int32"},"startTime":{"type":"integer","description":"The timeStamp of the message start time.","format":"int64"},"endTime":{"type":"integer","description":"The timeStamp of the message end time.","format":"int64"},"simCard":{"type":"integer","description":"When the device supports Dual-SIM cardm parameter [simCard] should be 1 or 2. 1: SIM1; 2: SIM2.","format":"int32"}}},"OpenApiWebhookSettingAddVO":{"required":["name","retryPolicy","template","urlList"],"type":"object","properties":{"name":{"type":"string","description":"Webhook name. It should contain 1 to 128 characters."},"urlList":{"type":"array","description":"Webhook URL List. Up to 3 entries are allowed for the URL list","example":" [http(s)://webhook.site/4a566f9e-0b77-42e2-9a34-a78]","items":{"type":"string","description":"Webhook URL List. Up to 3 entries are allowed for the URL list","example":" [http(s)://webhook.site/4a566f9e-0b77-42e2-9a34-a78]"}},"retryPolicy":{"type":"integer","description":"Webhook retry policy. It should be a value as follows: 0:None, 1:Important (Up to 5 retries over 60 minutes), 2:Critical (Up to 5 retries over 24 hours)","format":"int32"},"shardedSecret":{"type":"string","description":"Webhook Sharded Secret. It should contain 0 to 128 characters."},"template":{"type":"integer","description":"Webhook template, it should be a value as follow: 0:Omada template, 1:Google chat template. Example: 0. ","format":"int32"}}},"OpenApiWebhookSettingTestVO":{"required":["name","template","urlList"],"type":"object","properties":{"name":{"type":"string","description":"Webhook name. It should contain 1 to 128 characters."},"shardedSecret":{"type":"string","description":"Webhook Sharded Secret. It should contain 0 to 128 characters."},"urlList":{"type":"array","description":"Webhook URL List. Up to 3 entries are allowed for the URL list","example":"[http(s)://webhook.site/4a566f9e-0b77-42e2-9a34-a78]","items":{"type":"string","description":"Webhook URL List. Up to 3 entries are allowed for the URL list","example":"[http(s)://webhook.site/4a566f9e-0b77-42e2-9a34-a78]"}},"template":{"type":"integer","description":"Webhook template, it should be a value as follow: 0:Omada template, 1:Google chat template. Example: 0. ","format":"int32"}}},"CreateUserVO":{"required":["allSite","name","roleId","type"],"type":"object","properties":{"type":{"type":"integer","description":"Type of user should be a value as follows: 0: local user; 1: cloud user.","format":"int32"},"roleId":{"type":"string","description":"This field represents Role ID. Role can be created using 'Create new role' interface, and Role ID can be obtained from 'Get role list' interface."},"name":{"pattern":"^(?![+=@-])[\\041-\\0176]$|^(?![+=@-])[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"User name should contain 1 to 128 characters and start with letters, numbers, and underscores. When creating cloud user, you should set TP-LINK ID."},"password":{"pattern":"^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[\\!\\#\\$\\%\\&\\'\\(\\)\\*\\+\\,\\-\\.\\/\\:\\;\\<\\=\\>\\@\\[\\\\\\]\\^\\_\\`\\{\\|\\}\\~])(?!.*[\\00-\\040\\042\\077\\0177]).{8,128}$","type":"string","description":"Password of local user should contain 8 to 128 characters. And password must be a combination of uppercase letters, lowercase letters, numbers, and special symbols. Symbols such as ! # $ % & * @ ^ are supported."},"email":{"type":"string","description":"Email of user."},"alert":{"type":"boolean","description":"Whether this user wants to receive alert, event, and incident emails. Make sure the email is not null."},"incidentNotification":{"type":"boolean","description":"Incident notification, this field is deprecated, please use alert field instead.","deprecated":true},"sites":{"uniqueItems":true,"type":"array","description":"User site privilege list","items":{"type":"string","description":"User site privilege list"}},"allSite":{"type":"boolean","description":"Whether user has all site permission, including new created site."},"temporaryEnable":{"type":"boolean","description":"Whether the user wants to enable the temporary worker permission"},"startTime":{"type":"integer","description":"The start time of the user's validity period. time range: start timestamp (Millisecond).","format":"int64"},"endTime":{"type":"integer","description":"The end time of the user's validity period. time range: end timestamp (Millisecond).","format":"int64"},"sitePrivileges":{"type":"array","description":"User site privileges","items":{"$ref":"#/components/schemas/CreateSitePrivilegeVO"}}}},"CreateUserResultVO":{"type":"object","properties":{"userId":{"type":"string","description":"User ID"}}},"OperationResponseCreateUserResultVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CreateUserResultVO"}}},"FeedbackOpenApiVO":{"required":["content","level"],"type":"object","properties":{"level":{"type":"integer","description":"The rating of the controller service is in the range of 1~5.","format":"int32"},"content":{"maxLength":5000,"minLength":0,"type":"string","description":"Feedback and evaluation of the controller service."}}},"ModelBaseInfo":{"required":["modelTypeInfo"],"type":"object","properties":{"modelTypeInfo":{"$ref":"#/components/schemas/ModelTypeInfoOpenApiVO"},"currentVersion":{"type":"array","description":"Model version list, software version, such as \"2.5.0 Build 20190118 Rel. 64821\".","items":{"type":"string","description":"Model version list, software version, such as \"2.5.0 Build 20190118 Rel. 64821\"."}}},"description":"Model base information list, include Model type information and currentVersion list"},"ModelTypeInfoOpenApiVO":{"required":["compoundModel","showModel"],"type":"object","properties":{"showModel":{"type":"string","description":"Model complex displayed on the front end, you can also get this field throw: \"Get the model of the specified site\""},"compoundModel":{"type":"string","description":"Model complex used on the backend, you can also get this field throw: \"Get the model of the specified site\""}},"description":"Model type information."},"ModelUpgradeSiteReqInfo":{"required":["currentPage","currentPageSize","models"],"type":"object","properties":{"currentPage":{"type":"integer","description":"Start page number. Start from 1.","format":"int32"},"currentPageSize":{"type":"integer","description":"Number of entries per page. It should be within the range of 1–100.","format":"int32"},"models":{"type":"array","description":"Model base information list, include Model type information and currentVersion list","items":{"$ref":"#/components/schemas/ModelBaseInfo"}}}},"ModelUpgradeSiteInfo":{"type":"object","properties":{"currentPage":{"type":"integer","description":"Start page number. Start from 1.","format":"int32"},"currentPageSize":{"type":"integer","description":"Number of entries per page. It should be within the range of 1–100.","format":"int32"},"totalRows":{"type":"integer","description":"Total rows.","format":"int32"},"allSiteIds":{"type":"array","description":"All siteIDs in the query result.","items":{"type":"string","description":"All siteIDs in the query result."}},"data":{"type":"array","description":"Site basic information on one page.","items":{"$ref":"#/components/schemas/SiteBasicInfo"}}}},"OperationResponseModelUpgradeSiteInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ModelUpgradeSiteInfo"}}},"SiteBasicInfo":{"type":"object","properties":{"id":{"type":"string","description":"Site ID"},"name":{"type":"string","description":"Site name"}},"description":"Site basic information on one page."},"ModelUpgradeInfo":{"required":["modelList","selectType"],"type":"object","properties":{"modelList":{"type":"array","description":"The selected model list.","items":{"type":"string","description":"The selected model list."}},"selectType":{"type":"string","description":"SelectType should be a value as follows: all: select all; include: include selected modelList; exclude: all but exclude selected modelList."}}},"OperationResponsePlanUpgradeModelInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PlanUpgradeModelInfo"}}},"PlanUpgradeModelInfo":{"type":"object","properties":{"modelList":{"type":"array","items":{"$ref":"#/components/schemas/ModelUpgradeInfo"}}}},"PlanUpgradeCreateInfo":{"required":["modelList","scheduleType","sites"],"type":"object","properties":{"sites":{"type":"array","description":"List of site ID selected by the user","items":{"type":"string","description":"List of site ID selected by the user"}},"year":{"type":"integer","description":"The year selected by the user","format":"int32"},"monthOfYear":{"type":"integer","description":"The month of the year selected by the user, It should be within the range of 1-12","format":"int32"},"dayOfMonth":{"type":"integer","description":"The day of the month selected by the user, It should be within the range of 1-31","format":"int32"},"hour":{"type":"integer","description":"The hour of the day selected by the user, It should be within the range of 0-23","format":"int32"},"minute":{"type":"integer","description":"The minute in the hour selected by the user, It should be within the range of 0-59","format":"int32"},"modelList":{"type":"array","description":"List of model selected for planned upgrade","items":{"$ref":"#/components/schemas/PlanUpgradeSelectedModel"}},"scheduleType":{"type":"integer","description":"The type of upgrade execution time, where 0 represents now and 1 represents the specified time","format":"int32"}}},"PlanUpgradeSelectedModel":{"required":["currentVersion","modelTypeInfo","targetVersion"],"type":"object","properties":{"modelTypeInfo":{"$ref":"#/components/schemas/ModelTypeInfoOpenApiVO"},"currentVersion":{"type":"array","description":"Selected model version list, software version, such as \"2.5.0 Build 20190118 Rel. 64821\".","items":{"type":"string","description":"Selected model version list, software version, such as \"2.5.0 Build 20190118 Rel. 64821\"."}},"targetVersion":{"type":"string","description":"Target version."}},"description":"List of model selected for planned upgrade"},"OperationResponseCreateUpgradePlanResinfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/createUpgradePlanResinfo"}}},"createUpgradePlanResinfo":{"type":"object","properties":{"upgradeIdList":{"type":"array","description":"Upgrade ID list","items":{"type":"string","description":"Upgrade ID list"}}}},"ModelFwReleaseNoteReqInfo":{"required":["oemId"],"type":"object","properties":{"oemId":{"type":"string","description":"ID, you can also get this field throw: \"Get the firmware pool list\""}}},"ModelFwOemReleaseNoteInfo":{"type":"object","properties":{"releaseNotes":{"type":"array","description":"Release Notes information for a firmware series","items":{"$ref":"#/components/schemas/ModelFwVersionReleaseNoteInfo"}}}},"ModelFwVersionReleaseNoteInfo":{"type":"object","properties":{"currentVersion":{"type":"string","description":"Current version number, such as \"2.5.0 Build 20190118 Rel. 64821\""},"releaseNote":{"type":"string","description":"Current version of releaseNote"},"previousVersion":{"type":"string","description":"Previous version number"},"nextVersion":{"type":"string","description":"The version number of the subsequent version"}},"description":"Release Notes information for a firmware series"},"OperationResponseModelFwOemReleaseNoteInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ModelFwOemReleaseNoteInfo"}}},"UpgradeSiteModelReqInfo":{"type":"object","properties":{"siteIds":{"type":"array","description":"List collection of siteID","items":{"type":"string","description":"List collection of siteID"}}}},"OperationResponseUpgradeSiteModelInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/UpgradeSiteModelInfo"}}},"UpgradeSiteModelInfo":{"type":"object","properties":{"modelTypeInfos":{"type":"array","description":"List of model type selected by the user","items":{"$ref":"#/components/schemas/ModelTypeInfoOpenApiVO"}}}},"EditUploadFirmwareInfo":{"type":"object","properties":{"description":{"type":"string","description":"Description of firmware"},"targetEnable":{"type":"boolean","description":"Do the sites set up specified firmware, it should be a value as follows: true, false"},"targetSites":{"type":"array","description":"Target sites ID, it exists when \"targetEnable\" is true","items":{"type":"string","description":"Target sites ID, it exists when \"targetEnable\" is true"}}}},"AutoCheckUpgradeCreateInfo":{"required":["channel","modelTypeInfos","occurrence","siteIds"],"type":"object","properties":{"modelTypeInfos":{"type":"array","description":"List of model type selected by the user, and it should not be null","items":{"$ref":"#/components/schemas/ModelTypeInfoOpenApiVO"}},"siteIds":{"type":"array","description":"List of sites selected by the user, and it should not be null","items":{"type":"string","description":"List of sites selected by the user, and it should not be null"}},"occurrence":{"$ref":"#/components/schemas/UpgradeBaseScheduleTimeOpenApiVO"},"channel":{"type":"integer","description":"Channel should be a value as follows: 0: stable; 1: Release Candidate(RC); 2: Beta, and it should not be null","format":"int32"}}},"UpgradeBaseScheduleTimeOpenApiVO":{"required":["hour","minute","timingType"],"type":"object","properties":{"timingType":{"type":"integer","description":"Time type should be a value as follows: 1:Daily; 2:Weekly; 3:Monthly; 4:yearly","format":"int32"},"dayOfWeek":{"type":"integer","description":"It should be within the range of 0(Sunday)~6(Saturday). Required when parameter [timingType] is 2.","format":"int32"},"dayOfMonth":{"type":"integer","description":"It should be within the range of 1~31. Required when parameter [timingType] is 3 or 4.","format":"int32"},"monthOfYear":{"type":"integer","description":"It should be within the range of 1~12. Required when parameter [timingType] is 4.","format":"int32"},"hour":{"type":"integer","description":"It should be within the range of 0~23","format":"int32"},"minute":{"type":"integer","description":"It should be within the range of 0~59","format":"int32"}},"description":"Periodic execution time, and it should not be null"},"OperationResponseCreateAutoCheckResInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/createAutoCheckResInfo"}}},"createAutoCheckResInfo":{"type":"object","properties":{"autoCheckId":{"type":"string","description":"AutoCheck ID"}}},"LocalOwnerConfirmVO":{"required":["password","username"],"type":"object","properties":{"username":{"type":"string","description":"local owner username"},"password":{"type":"string","description":"local owner password"}}},"CreateSiteTemplateEntity":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,62}[^ ]$","type":"string","description":"Name of the site template should contain 1 to 64 characters."},"type":{"type":"integer","description":"This param has been deprecated. Please do not use it.","format":"int32"},"settings":{"type":"array","description":"Settings of the site template support. Optional settings are as follows: AIRFPlaning, firewall, wirelessIdsIps, siteCLI, abnormal, sim, log, auditLogs, applicationControl, servicesRebootSchedule, servicesPortSchedule","items":{"type":"string","description":"Settings of the site template support. Optional settings are as follows: AIRFPlaning, firewall, wirelessIdsIps, siteCLI, abnormal, sim, log, auditLogs, applicationControl, servicesRebootSchedule, servicesPortSchedule"}}}},"CreateWlanGroupOpenApiVO":{"required":["clone","name"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"WLAN group name should contain 1 to 128 characters."},"clone":{"type":"boolean","description":"Whether to clone SSID list from other WLAN group."},"clonedWlanId":{"type":"string","description":"WLAN group ID that needs to be cloned. Parameter [clonedWlanId] should not be null when Parameter [clone] is true."}}},"ApGroupNameVO":{"type":"object","properties":{"id":{"type":"string","description":"AP Group ID"},"name":{"type":"string","description":"AP Group Name"}},"description":"Map of AP Group ID to AP Group name"},"AuthenticationParamVO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"value":{"type":"integer","format":"int32"}}},"BandSteerVO":{"type":"object","properties":{"mode":{"type":"integer","format":"int32"}}},"DhcpOption82SettingVO":{"type":"object","properties":{"dhcpEnable":{"type":"boolean"},"format":{"type":"integer","format":"int32"},"delimiter":{"pattern":"^[\\040-\\0176]$","type":"string"},"circuitId":{"type":"array","items":{"type":"integer","format":"int32"}},"remoteId":{"type":"array","items":{"type":"integer","format":"int32"}}}},"EapMethodVO":{"type":"object","properties":{"method":{"type":"integer","format":"int32"},"param":{"maxItems":4,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/AuthenticationParamVO"}}}},"HotspotV2SettingVO":{"required":["hotspotV2Enable"],"type":"object","properties":{"hotspotV2Enable":{"type":"boolean"},"networkType":{"type":"integer","format":"int32"},"plmnId":{"maxItems":6,"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/PlmnIdVO"}},"roamingConsortiumOi":{"maxItems":3,"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/RoamingConsortiumOiVO"}},"operatorDomain":{"pattern":"^$|^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?$","type":"string"},"dgaf":{"type":"boolean"},"heSsid":{"pattern":"^$|^[A-F0-9]{1}[02468ACE]{1}([-][A-F0-9]{2}){5}$","type":"string"},"internet":{"type":"boolean"},"availabilityIpv4":{"type":"integer","format":"int32"},"availabilityIpv6":{"type":"integer","format":"int32"},"operatorFriendly":{"pattern":"^$|^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,62}[\\041-\\0176]$","type":"string"},"venueInfo":{"$ref":"#/components/schemas/VenueInfoVO"},"realmList":{"maxItems":10,"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/RealmVO"}}}},"LoadBalanceVO":{"type":"object","properties":{"enable":{"type":"boolean"}}},"MultiCastSettingVO":{"type":"object","properties":{"multiCastEnable":{"type":"boolean"},"channelUtil":{"type":"integer","format":"int32"},"arpCastEnable":{"type":"boolean"},"ipv6CastEnable":{"type":"boolean"},"filterEnable":{"type":"boolean"},"filterMode":{"type":"integer","format":"int32"},"macGroupId":{"type":"string"}}},"PPSKSettingVO":{"type":"object","properties":{"ppskProfileId":{"type":"string"},"radiusProfileId":{"type":"string"},"macFormat":{"type":"integer","format":"int32"},"nasId":{"type":"string"},"type":{"type":"integer","format":"int32"},"registerPageId":{"type":"string"}}},"PlmnIdVO":{"type":"object","properties":{"value":{"type":"string"}}},"PskSettingVO":{"type":"object","properties":{"versionPsk":{"type":"integer","format":"int32"},"encryptionPsk":{"type":"integer","format":"int32"},"gikRekeyPskEnable":{"type":"boolean"},"rekeyPskInterval":{"type":"integer","format":"int32"},"intervalPskType":{"type":"integer","format":"int32"},"securityKey":{"type":"string"}}},"RateAndBeaconCtrlVO":{"type":"object","properties":{"rate2gCtrlEnable":{"type":"boolean"},"lowerDensity2g":{"type":"number"},"higherDensity2g":{"type":"integer","format":"int32"},"cckRatesDisable":{"type":"boolean"},"clientRatesRequire2g":{"type":"boolean"},"sendBeacons2g":{"type":"boolean","deprecated":true},"rate5gCtrlEnable":{"type":"boolean"},"lowerDensity5g":{"type":"integer","format":"int32"},"higherDensity5g":{"type":"integer","format":"int32"},"clientRatesRequire5g":{"type":"boolean"},"sendBeacons5g":{"type":"boolean","deprecated":true},"manageRateControl2gEnable":{"type":"boolean"},"manageRateControl2g":{"type":"number"},"manageRateControl5gEnable":{"type":"boolean"},"manageRateControl5g":{"type":"integer","format":"int32"},"rate6gCtrlEnable":{"type":"boolean","deprecated":true},"lowerDensity6g":{"type":"integer","format":"int32","deprecated":true},"higherDensity6g":{"type":"integer","format":"int32","deprecated":true},"clientRatesRequire6g":{"type":"boolean","deprecated":true},"sendBeacons6g":{"type":"boolean","deprecated":true}}},"RateLimitSettingVO":{"type":"object","properties":{"rateLimitId":{"type":"string"},"downLimitEnable":{"type":"boolean"},"downLimit":{"type":"integer","format":"int32"},"downLimitType":{"type":"integer","format":"int32"},"upLimitEnable":{"type":"boolean"},"upLimit":{"type":"integer","format":"int32"},"upLimitType":{"type":"integer","format":"int32"}}},"RealmVO":{"type":"object","properties":{"name":{"type":"string"},"encoding":{"type":"integer","format":"int32"},"eap":{"maxItems":4,"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/EapMethodVO"}}}},"RoamingConsortiumOiVO":{"type":"object","properties":{"value":{"pattern":"^([0-9A-Fa-f]{2}[-]){2}[0-9A-Fa-f]{2}$|^([0-9A-Fa-f]{2}[-]){4}[0-9A-Fa-f]{2}$","type":"string"}}},"SsidVO":{"required":["macFilterEnable","name","rateLimit","wlanScheduleEnable"],"type":"object","properties":{"id":{"type":"string"},"idInt":{"type":"integer","format":"int32"},"index":{"type":"integer","format":"int64"},"name":{"type":"string"},"site":{"type":"string"},"wlanId":{"type":"string","deprecated":true},"apGroupIds":{"type":"array","items":{"type":"string"}},"ssidEnable":{"type":"boolean"},"chooseDevices":{"type":"integer","description":"select all devices or not. 0 means select all devices, 1 means not select all devices.","format":"int32"},"selectApGroupType":{"pattern":"all|include|exclude","type":"string","description":"selectApGroupType should be a value as follows: all, include, exclude."},"deviceTypeChanged":{"type":"integer","description":"1: cancel gateway but still can send AP, 2: no effective device","format":"int32"},"apGroupNum":{"type":"integer","description":"Number of AP Group associated with this SSID","format":"int32"},"apGroupNameMap":{"type":"array","description":"Map of AP Group ID to AP Group name","items":{"$ref":"#/components/schemas/ApGroupNameVO"}},"apNum":{"type":"integer","description":"Number of APs associated with this SSID","format":"int32"},"overrideNum":{"type":"integer","description":"Number of SSIDs that override this SSID","format":"int64"},"clientNum":{"type":"integer","description":"Number of clients currently connected to this SSID","format":"int64"},"traffic":{"type":"integer","description":"Total traffic on this SSID","format":"int64"},"band":{"type":"integer","format":"int32"},"guestNetEnable":{"type":"boolean"},"security":{"type":"integer","format":"int32"},"broadcast":{"type":"boolean"},"vlanEnable":{"type":"boolean","deprecated":true},"vlanId":{"type":"integer","format":"int32","deprecated":true},"portalEnable":{"type":"boolean"},"portalId":{"type":"string"},"portalName":{"type":"string"},"accessEnable":{"type":"boolean"},"rateLimit":{"$ref":"#/components/schemas/RateLimitSettingVO"},"ssidRateLimit":{"$ref":"#/components/schemas/RateLimitSettingVO"},"wpaSetting":{"$ref":"#/components/schemas/WpaSettingVO"},"pskSetting":{"$ref":"#/components/schemas/PskSettingVO"},"wlanScheduleEnable":{"type":"boolean"},"action":{"type":"integer","format":"int32"},"scheduleId":{"type":"string"},"macFilterType":{"type":"integer","format":"int32"},"macFilterEnable":{"type":"boolean"},"policy":{"type":"integer","format":"int32"},"macFilterId":{"type":"string"},"ouiProfileIdList":{"type":"array","items":{"type":"string"}},"rateAndBeaconCtrl":{"$ref":"#/components/schemas/RateAndBeaconCtrlVO"},"ppskSetting":{"$ref":"#/components/schemas/PPSKSettingVO"},"enable11r":{"type":"boolean"},"pmfMode":{"type":"integer","format":"int32"},"multiCastSetting":{"$ref":"#/components/schemas/MultiCastSettingVO"},"greEnable":{"type":"boolean"},"mloEnable":{"type":"boolean"},"dhcpOption82":{"$ref":"#/components/schemas/DhcpOption82SettingVO"},"hidePwd":{"type":"boolean"},"deviceType":{"type":"integer","format":"int32"},"wanAccess":{"type":"boolean"},"prohibitWifiShare":{"type":"boolean"},"resource":{"type":"integer","format":"int32"},"oweEnable":{"type":"boolean"},"vlanSetting":{"$ref":"#/components/schemas/SsidVlanSettingVO"},"bandSteeringForMultiBand":{"$ref":"#/components/schemas/BandSteerVO"},"loadBalance":{"$ref":"#/components/schemas/LoadBalanceVO"},"hotspotV2Setting":{"$ref":"#/components/schemas/HotspotV2SettingVO"},"featureDescription":{"type":"array","items":{"$ref":"#/components/schemas/FeatureInfoVO"}},"wifiCallingEnable":{"type":"boolean"},"wifiCallingId":{"type":"string"},"enhancedIotConnectivity":{"type":"boolean"},"condBroadcastCtrl":{"$ref":"#/components/schemas/CondBroadcastCtrlVO"},"fromApp":{"type":"boolean"}}},"SsidVlanCustomSettingVO":{"required":["customMode"],"type":"object","properties":{"customMode":{"type":"integer","format":"int32"},"lanNetworkId":{"type":"string"},"lanNetworkVlanIds":{"type":"object","additionalProperties":{"type":"array","items":{"type":"integer","format":"int32"}}},"bridgeVlan":{"type":"integer","format":"int32"},"vlanId":{"type":"integer","format":"int32"},"vlanPoolIds":{"type":"string"}}},"SsidVlanSettingVO":{"required":["mode"],"type":"object","properties":{"mode":{"type":"integer","format":"int32"},"customConfig":{"$ref":"#/components/schemas/SsidVlanCustomSettingVO"},"currentVlanId":{"type":"integer","format":"int32"},"currentVlanIds":{"type":"string"}}},"VenueInfoVO":{"type":"object","properties":{"group":{"type":"integer","format":"int32"},"type":{"type":"integer","format":"int32"},"name":{"pattern":"^$|^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,62}[\\041-\\0176]$","type":"string"}}},"WpaSettingVO":{"type":"object","properties":{"versionEnt":{"type":"integer","format":"int32"},"encryptionEnt":{"type":"integer","format":"int32"},"gikRekeyEnable":{"type":"boolean"},"rekeyInterval":{"type":"integer","format":"int32"},"intervalType":{"type":"integer","format":"int32"},"radiusProfileId":{"type":"string"},"mode":{"type":"integer","format":"int32"},"nasId":{"type":"string"}}},"VoipContactPersonSettings":{"type":"object","properties":{"firstName":{"pattern":"^[A-Za-z0-9]{0,64}$","type":"string","description":"The firstName of contact person. It should contain 0 to 64 characters."},"lastName":{"pattern":"^[A-Za-z0-9]{0,64}$","type":"string","description":"The lastName of contact person. It should contain 0 to 64 characters."},"privatePhoneNumber":{"type":"string","description":"The privatePhoneNumber of contact person."},"workPhoneNumber":{"type":"string","description":"The workPhoneNumber of contact person."},"mobilePhoneNumber":{"type":"string","description":"The mobilePhoneNumber of contact person."},"speedDialEnable":{"type":"boolean","description":"Whether to enable the speedDial."},"speedDialNumberType":{"type":"integer","description":"speedDialNumberType should be a value as follows: 0: Private Phone Number; 1: Work Phone Number; 2: Mobile Phone Number.","format":"int32"},"speedDialNumber":{"type":"string","description":"The speedDialNumber of contact person."}}},"VoipTelephoneBookBatchSetting":{"required":["contactIds","forceDelete","selectType"],"type":"object","properties":{"contactIds":{"type":"array","description":"Delete the contact ID of contact person.","items":{"type":"string","description":"Delete the contact ID of contact person."}},"selectType":{"pattern":"all|include|exclude","type":"string","description":"SpeedDialNumberType should be a value as follows: all, include, exclude."},"forceDelete":{"type":"boolean","description":"Other configurations depending on selected contacts (call forwarding rules for instance) will be deleted together if this field is true. Otherwise, a pre-check will be executed and an error message will be returned when this contact is already used in some other configurations."}}},"VoipCallLogEnableSetting":{"required":["callLogEnable"],"type":"object","properties":{"callLogEnable":{"type":"boolean","description":"Whether to enable the call log."}}},"CallForwardingRule":{"required":["condition","destNumber","enable","type"],"type":"object","properties":{"omadacId":{"type":"string","description":"Omadac ID"},"siteId":{"type":"string","description":"Site ID"},"ruleId":{"type":"string","description":"Call forwarding rule id"},"enable":{"type":"boolean","description":"Enable this rule or not"},"condition":{"type":"integer","description":"Forwarding condition. 0- no answer, 1- unconditional","format":"int32"},"type":{"type":"integer","description":"The call type to be forwarded. 0: All Incoming Calls - If this option is selected, all incoming calls will be forwarded.\n1: Calls to the Telephone Number - If this option is selected, select a telephone number from the list. Any incoming calls to this number will be forwarded.\n2: Calls to the Phone - If this option is selected, select a telephony device from the list. Any incoming calls to this device will be forwarded.\n3: Calls from a Person in the Telephone Book - If this option is selected, select a contact from the list. Any incoming calls from this contact will be forwarded.\n4: Calls from the Telephone Number - If this option is selected, enter a specific telephone number. Any incoming calls from this number will be forwarded.","format":"int32"},"toNumbers":{"type":"array","description":"Any incoming calls to these numbers will be forwarded.","items":{"type":"string","description":"Any incoming calls to these numbers will be forwarded."}},"toDevices":{"type":"array","description":"Any incoming calls to these devices will be forwarded.","items":{"type":"integer","description":"Any incoming calls to these devices will be forwarded.","format":"int32"}},"fromPersons":{"type":"array","description":"Any incoming calls from these contacts will be forwarded.","items":{"type":"string","description":"Any incoming calls from these contacts will be forwarded."}},"fromNumbers":{"type":"array","description":"Any incoming calls from these numbers will be forwarded.","items":{"type":"string","description":"Any incoming calls from these numbers will be forwarded."}},"forwardVia":{"type":"string","description":"\"Auto\" by default."},"destNumber":{"type":"string","description":"The Destination Telephone Number that incoming calls will be redirected to."}}},"AddCallForwardingRuleResp":{"type":"object","properties":{"ruleId":{"type":"string","description":"Call Forwarding rule id."}}},"OperationResponseAddCallForwardingRuleResp":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AddCallForwardingRuleResp"}}},"UrlFilteringOpenApiVO":{"required":["filterMode","mode","name","policy","sourceIds","sourceType","status","type"],"type":"object","properties":{"type":{"pattern":"gateway|ap","type":"string","description":"Type should be a value as follows: \"gateway\"; \"ap\"."},"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name should contain 1 to 64 characters."},"status":{"type":"boolean","description":"Status of the URL filtering."},"policy":{"type":"integer","description":"Policy should be a value as follows: 0: drop; 1: allow.","format":"int32"},"sourceType":{"type":"integer","description":"Source type should be a value as follows: 0: network; 1: IP group; 2: SSID.","format":"int32"},"sourceIds":{"type":"array","description":"Source IDs of the URL filtering. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface. IP group can be created using 'Create a new group profile' interface, and IP group ID can be obtained from 'Get group profile list' interface. SSID can be created using 'Create new SSID' interface, and SSID ID can be obtained from 'Get SSID list' interface.","items":{"type":"string","description":"Source IDs of the URL filtering. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface. IP group can be created using 'Create a new group profile' interface, and IP group ID can be obtained from 'Get group profile list' interface. SSID can be created using 'Create new SSID' interface, and SSID ID can be obtained from 'Get SSID list' interface."}},"mode":{"type":"integer","description":"Mode should be a value as follows: 0: URL Path; 1: keywords(Only for gateway).","format":"int32"},"urls":{"type":"array","description":"URLs of the URL filtering, eg: www.google.com.","items":{"type":"string","description":"URLs of the URL filtering, eg: www.google.com."}},"keywords":{"type":"array","description":"Keywords of the URL filtering.","items":{"type":"string","description":"Keywords of the URL filtering."}},"filterMode":{"type":"integer","description":"filterMode should be a value as follows: 0: URL; 1: category.","format":"int32"},"scenarioMode":{"type":"integer","description":"scenarioMode should be a value as follows:0: Custom  1: Family 2：Work 3：Education 4：Guest.","format":"int32"},"categories":{"type":"object","additionalProperties":{"type":"array","description":"categories of the URL filtering, TreeMap<String, List<String>> categories","items":{"type":"string","description":"categories of the URL filtering, TreeMap<String, List<String>> categories"}},"description":"categories of the URL filtering, TreeMap<String, List<String>> categories"},"timeRange":{"type":"string","description":"timeRange of the URL filtering, TimeSchedule"}}},"OperationResponseResIdOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ResIdOpenApiVO"}}},"ResIdOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"ID of the created object"}}},"CreateTimeRangeProfileOpenApiVO":{"required":["dayMode","name","timeList"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Time range profile name should contain 1 to 64 characters."},"dayMode":{"type":"integer","description":"Time range profile day mode; It should be a value as follows: 0: Every Day, 1: Weekday, 2: Weekend, 3: Customized","format":"int32"},"customDayMode":{"$ref":"#/components/schemas/CustomDayModeOpenApiVO"},"timeList":{"type":"array","description":"Time range profile schedule time config","items":{"$ref":"#/components/schemas/ScheduleTimeOpenApiVO"}}}},"StpInstanceDetailVO":{"required":["stp"],"type":"object","properties":{"stp":{"type":"integer","description":"stp, 1: STP / 2: RSTP / 3: MSTP / 4: RPVST / 0: OFF","format":"int32"},"id":{"type":"integer","description":"instance ID","format":"int32"},"vlan":{"type":"integer","description":"instance vlanId","format":"int32"}}},"OswPmtudVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"The Switch of Path MTU Discovery."}}},"CreatePortTagOpenApiVO":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Port label name should contain 1 to 128 ASCII characters."}}},"PortTagOpenApiVO":{"required":["name","tagId"],"type":"object","properties":{"tagId":{"type":"string","description":"Port label ID"},"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Port label name should contain 1 to 128 ASCII characters."},"resource":{"type":"integer","description":"Data Source. Resource should be a value as follows: 0: new created; 1: from template; 2: override","format":"int32"}}},"OswMacListVO":{"required":["switchMacList"],"type":"object","properties":{"switchMacList":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Switch Mac List","items":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Switch Mac List"}}}},"OswDetailOpenApiVO":{"required":["networkId","vlan"],"type":"object","properties":{"macs":{"type":"array","description":"The collection of macs of the general switches.","items":{"type":"string","description":"The collection of macs of the general switches."}},"stackIds":{"type":"array","description":"The collection of stack ids of the stack switches.","items":{"type":"string","description":"The collection of stack ids of the stack switches."}},"networkId":{"type":"string","description":"Network ID."},"vlan":{"type":"integer","description":"VLAN ID.","format":"int32"}}},"DeviceOuiModeVO":{"required":["deviceMac"],"type":"object","properties":{"deviceMac":{"type":"string"},"deviceName":{"type":"string"},"stackName":{"type":"string"},"type":{"type":"string"},"model":{"type":"string"},"modelVersion":{"type":"string"},"portList":{"type":"array","items":{"type":"integer","format":"int32"}},"stackId":{"type":"string"},"stackPortList":{"type":"array","items":{"type":"string"}},"lagList":{"type":"array","items":{"type":"integer","format":"int32"}},"lagInfo":{"type":"array","items":{"$ref":"#/components/schemas/LagInfoVO"}},"lanList":{"type":"array","items":{"type":"string"}}}},"LagInfoVO":{"type":"object","properties":{"lagId":{"type":"integer","format":"int32"},"ports":{"type":"array","items":{"type":"integer","format":"int32"}},"name":{"type":"string"},"mlagEnable":{"type":"boolean"}},"description":"Device Lag Infos"},"MlagMsgVO":{"type":"object","properties":{"mlagId":{"type":"string","description":"M-LAG ID"},"mlagName":{"type":"string","description":"M-LAG Group Name"},"role":{"type":"integer","description":"M-LAG Role, 0: Unknown, 1: Primary, 2: Secondary","format":"int32"},"priority":{"type":"integer","description":"M-LAG Priority","format":"int32"},"dadLinkPort":{"uniqueItems":true,"type":"array","description":"Set of DAD Link Ports","items":{"type":"integer","description":"Set of DAD Link Ports","format":"int32"}},"peerLinkPort":{"uniqueItems":true,"type":"array","description":"Set of Peer Link Ports","items":{"type":"integer","description":"Set of Peer Link Ports","format":"int32"}}},"description":"The mlag info if it belongs to a mlag."},"OswDeviceMiscVO":{"type":"object","properties":{"portNum":{"type":"integer","description":"Port Num","format":"int32"}},"description":"Device Misc"},"OswPortVO":{"type":"object","properties":{"id":{"type":"string","description":"ID"},"port":{"type":"integer","description":"Port","format":"int32"},"standardPort":{"$ref":"#/components/schemas/OswStandPortVO"},"configStack":{"type":"boolean","description":"Indicates whether the current port is configured as a stack port (joined a stack aggregation group)"},"stackPortsGroupIndex":{"type":"integer","description":"Number of the stacking port aggregation group to join","format":"int32"},"switchId":{"type":"string","description":"Switch ID to which the port belongs"},"switchMac":{"type":"string","description":"Switch Mac to which the port belongs"},"site":{"type":"string","description":"Site to which the port belongs"},"name":{"type":"string","description":"Port Name"},"disable":{"type":"boolean","description":"Indicates whether to disable the port"},"type":{"type":"integer","description":"Type should be a value as follows: 1: Copper; 2: Combo; 3: SFP","format":"int32"},"maxSpeed":{"type":"integer","description":"MaxSpeed should be a value as follows: 1: 10Mbps; 2: 100Mbps; 3: 1000Mbps; 4: 2.5Gbps; 5: 10Gbps","format":"int32"},"tagIds":{"type":"array","description":"Port label ID List","items":{"type":"string","description":"Port label ID List"}},"tagName":{"type":"string","description":"Port label Name"},"networkMode":{"type":"integer","description":"Network Mode should be a value as follows: 0: Trunk, 1: Access","format":"int32"},"nativeNetworkId":{"type":"string","description":"Native Network ID, Native Network cannot be selected from Tagged Networks or Untagged Networks."},"nativeBridgeVlan":{"type":"integer","description":"Native Network Bridge Vlan.","format":"int32"},"networkTagsSetting":{"type":"integer","description":"Network Tags Setting should be a value as follows: 0: Allow All; 1: Block All; 2: Custom","format":"int32"},"tagNetworkIds":{"type":"array","description":"Tag Network IDs","items":{"type":"string","description":"Tag Network IDs"}},"tagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Tag Network Bridge Vlan Map","items":{"type":"integer","description":"Tag Network Bridge Vlan Map","format":"int32"}},"description":"Tag Network Bridge Vlan Map"},"untagNetworkIds":{"type":"array","description":"Untag Network IDs","items":{"type":"string","description":"Untag Network IDs"}},"untagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Untag Network Bridge Vlan Map","items":{"type":"integer","description":"Untag Network Bridge Vlan Map","format":"int32"}},"description":"Untag Network Bridge Vlan Map"},"voiceNetworkEnable":{"type":"boolean","description":"Voice network enable status"},"voiceNetworkId":{"type":"string","description":"Voice Network ID"},"voiceBridgeVlan":{"type":"integer","description":"Voice Network Bridge Vlan","format":"int32"},"voiceDscpEnable":{"type":"boolean","description":"Voice DSCP enable status"},"voiceDscp":{"type":"integer","description":"Voice DSCP","format":"int32"},"profileId":{"type":"string","description":"Lan Profile ID"},"profileName":{"type":"string","description":"Lan Profile Name"},"profileOverrideEnable":{"type":"boolean","description":"Indicates whether to enable Profile Override before v6.2.10; Indicates the fill mode of port configuration after v6.2.10: true: custom; false: follow profile"},"profileVlanOverrideEnable":{"type":"boolean","description":"Indicates the fill mode of vlan configuration: true: custom; false: follow profile"},"operation":{"type":"string","description":"Operation should be a value as follows: SWITCHING; MIRRORING; AGGREGATING"},"mirroredPorts":{"type":"array","description":"Monitored Port","items":{"$ref":"#/components/schemas/MirroredPort"}},"mirroredLags":{"type":"array","description":"Monitored LAG","items":{"$ref":"#/components/schemas/MirroredLag"}},"aggregatingPorts":{"uniqueItems":true,"type":"array","description":"Aggregated ports (including this port), non-null only in aggregating mode","items":{"type":"integer","description":"Aggregated ports (including this port), non-null only in aggregating mode","format":"int32"}},"allAggregatingPorts":{"uniqueItems":true,"type":"array","description":"All ports in the aggregating state on the Switch","items":{"type":"integer","description":"All ports in the aggregating state on the Switch","format":"int32"}},"allMirroringPorts":{"uniqueItems":true,"type":"array","description":"All ports in the mirroring state on the Switch","items":{"type":"integer","description":"All ports in the mirroring state on the Switch","format":"int32"}},"allMirroredPorts":{"uniqueItems":true,"type":"array","description":"All mirrored ports on the Switch","items":{"type":"integer","description":"All mirrored ports on the Switch","format":"int32"}},"allMlagPeerLinkPorts":{"uniqueItems":true,"type":"array","description":"All ports configured with M-LAG PeerLink on the Switch","items":{"type":"integer","description":"All ports configured with M-LAG PeerLink on the Switch","format":"int32"}},"allMlagDadPorts":{"uniqueItems":true,"type":"array","description":"All ports configured with M-LAG DAD on the Switch","items":{"type":"integer","description":"All ports configured with M-LAG DAD on the Switch","format":"int32"}},"allAggregatingStPorts":{"uniqueItems":true,"type":"array","description":"All aggregating ports of the current Stack","items":{"$ref":"#/components/schemas/OswStandPortVO"}},"allMirroringStPorts":{"uniqueItems":true,"type":"array","description":"All mirroring ports of the current Stack","items":{"$ref":"#/components/schemas/OswStandPortVO"}},"allMirroredStPorts":{"uniqueItems":true,"type":"array","description":"All mirrored ports of the current Stack","items":{"$ref":"#/components/schemas/OswStandPortVO"}},"lagSetting":{"$ref":"#/components/schemas/OswLagVO"},"linkSpeed":{"type":"integer","description":"Link Speed should be a value as follows: 0: auto; 1: 10M; 2: 100M; 3: 1000M; 4: 10G","format":"int32"},"duplex":{"type":"integer","description":"Duplex should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"},"igmpSnoopingEnable":{"type":"boolean","description":"Indicates whether IGMP Snooping is enabled"},"dot1x":{"type":"integer","description":"Dot1x should be a value as follows: 0: Force unauthorized; 1: Force authorized; 2: Auto","format":"int32"},"madUsed":{"type":"boolean","description":"Mad Used"},"esEnableAllProfileCanAdd":{"type":"boolean","description":"Indicates whether es enable of all profile can continue to add VLANs"},"supportPoe":{"type":"boolean","description":"Indicates whether PoE is supported"},"supportLocate":{"type":"boolean","description":"Whether the port support locate."},"poeDisplayType":{"type":"integer","description":"PoeDisplayType should be a value as follows: -1: Not Support POE; 0: Support POE; 1: POE(4W); 2: POE(7W); 3: POE(15.4W); 4: POE+(30W); 5: POE++(45W); 6: POE++(60W); 7: POE++(75W); 8: POE++(90W); 9: POE++(100W).","format":"int32"},"poe":{"type":"integer","description":"PoE switch should be a value as follows: 0: Off; 1: 802.3at/af","format":"int32"},"bandWidthCtrlType":{"type":"integer","description":"BandWidth Control should be a value as follows: 0: Off; 1: Rate Limit; 2: Storming Control","format":"int32"},"bandCtrl":{"$ref":"#/components/schemas/OswBandCtrlVO"},"stormCtrl":{"$ref":"#/components/schemas/OswStormCtrlVO"},"lldpMedEnable":{"type":"boolean","description":"Indicates whether LLDP MED is enabled"},"topoNotifyEnable":{"type":"boolean","description":"Indicates whether to enable topology change notification"},"spanningTreeEnable":{"type":"boolean","description":"Indicates whether SpanningTree is enabled"},"spanningTreeSetting":{"$ref":"#/components/schemas/SpanningTreeSettingVO"},"loopbackDetectEnable":{"type":"boolean","description":"Indicates whether loopbackDetect port based is enabled"},"loopbackDetectVlanBasedEnable":{"type":"boolean","description":"Indicates whether loopbackDetect vlan based is enabled"},"igmpFastLeaveEnable":{"type":"boolean","description":"Indicates whether IGMP fast leave is enabled"},"mldFastLeaveEnable":{"type":"boolean","description":"Indicates whether MLD fast leave is enabled"},"portIsolationEnable":{"type":"boolean","description":"Indicates whether port isolation is enabled"},"portStatus":{"$ref":"#/components/schemas/OswPortStatusVO"},"speed":{"type":"integer","description":"Port Speed should be a value as follows: 1: 10Mbps; 2: 100Mbps; 3: 1000Mbps; 4: 10Gbps","format":"int32"},"lagStatus":{"$ref":"#/components/schemas/OswLagStatusVO"},"portCap":{"uniqueItems":true,"type":"array","description":"Port Capability","items":{"$ref":"#/components/schemas/OswLinkCapVO"}},"portSpeedCap":{"uniqueItems":true,"type":"array","description":"Port Speed Capability","items":{"$ref":"#/components/schemas/OswPortSpeedCapVO"}},"eeeEnable":{"type":"boolean","description":"Indicates whether EEE is enabled"},"flowControlEnable":{"type":"boolean","description":"Indicates whether flow control is enabled"},"extendModeSupport":{"type":"boolean","description":"Indicates whether extend mode is supported"},"extendModeEnable":{"type":"boolean","description":"Indicates whether extendMode is enabled"},"fastLeaveEnable":{"type":"boolean","description":"Indicates whether igmpSnooping fastLeave is enabled"},"dhcpL2RelaySettings":{"$ref":"#/components/schemas/OswPortDhcpL2RelayVO"},"dot1pPriority":{"type":"integer","description":"Dot1p Priority","format":"int32"},"trustMode":{"type":"integer","description":"TrustMode should be a value as follows: 0: Untrusted; 1: Trust 802.1p; 2: Trust DSCP","format":"int32"},"qosSupport":{"type":"boolean","description":"Indicates whether the device port supports modifying qos configuration"},"esQosSupport":{"type":"boolean","description":"Indicates whether the ES device port supports modification of QoS configuration"},"qosQueueEnable":{"type":"boolean","description":"Indicates whether the ES device port has enabled the Qos scheduling queue configuration"},"queueId":{"type":"integer","description":"ES Qos scheduling queue ID","format":"int32"},"networkConflict":{"type":"boolean","description":"Indicates whether the VLAN configuration activated on the port is inconsistent with the VLAN configuration in the Profile."},"resource":{"type":"integer","description":"Data Source. Resource should be a value as follows: 0: new created; 1: from template; 2: override","format":"int32"},"portAlertEnable":{"type":"boolean","description":"Indicates whether Port Alert is enabled"},"fecSupport":{"type":"boolean","description":"Indicates whether the port supports FEC configuration"},"fecCap":{"uniqueItems":true,"type":"array","description":"All LinkSpeed&FECMode combinations supported by the port","items":{"$ref":"#/components/schemas/OswFecCapVO"}},"fecMode":{"type":"integer","description":"FEC Mode, sourced from FecModeEnum. 0 - Reserved; 1 - FEC-OFF (Off); 2 - FEC-RS528; 3 - FEC-RS544; 4 - FEC-AUTO; 5 - FEC-BASER","format":"int32"},"fecLinkPeerApplyEnable":{"type":"boolean","description":"Indicates whether the same FEC mode is applied to the link peer"},"configMlagPeerLink":{"type":"boolean","description":"Indicates whether the port is configured with M-LAG Peer Link"},"configMlagDad":{"type":"boolean","description":"Indicates whether the port is configured with M-LAG DAD Link"},"mlagPeerAllPortsConfigInfo":{"$ref":"#/components/schemas/OswMlagPeerAllPortsConfigInfoVO"},"locateEnable":{"type":"boolean","description":"Whether locate function is enabled"},"usedFunctions":{"type":"array","description":"List of functions that use this port","items":{"type":"string","description":"List of functions that use this port"}},"isCopper":{"type":"boolean","description":"Whether the port is copper when the port is combo."},"ouiBasedVlanNetworks":{"$ref":"#/components/schemas/OswPortOuiBasedVlanVO"}},"description":"The infos of ports."},"OuiBasedVlanDeviceInfoVO":{"type":"object","properties":{"name":{"type":"string","description":"Device name,default value is the mac address of device"},"mac":{"type":"string","description":"Device mac"},"type":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"status":{"type":"integer","description":"Device status. The value must be one of the following: 0: Disconnected; 1: Disconnected (Migrating); 10: Provisioning; 11: Configuring; 12: Upgrading; 13: Rebooting; 14: Connected; 15: Connected (Wireless); 16: Connected (Migrating); 17: Connected (Wireless, Migrating); 20: Pending; 21: Pending (Wireless); 22: Adopting; 23: Adopting (Wireless); 24: Adoption Failed; 25: Adoption Failed (Wireless); 26: Managed by Others; 27: Managed by Others (Wireless); 30: Heartbeat Missed; 31: Heartbeat Missed (Wireless); 32: Heartbeat Missed (Migrating); 33: Heartbeat Missed (Wireless, Migrating); 40: Isolated; 41: Isolated (Migrating); 50: Slice Configuring","format":"int32"},"statusCategory":{"type":"integer","description":"Device Status Category","format":"int32"},"active":{"type":"boolean","description":"Specifies whether the device is currently in an active state."},"oldFirmwareUsed":{"type":"string","description":"The old firmware used by the device."},"oldFirmwareDevice":{"type":"boolean","description":"Whether the device is an old firmware device."},"ouiBasedVlanVersion":{"type":"integer","description":"Specifies the OUI-based VLAN version: 0 indicates the feature is unsupported, while 1, 2, and 3 represent versions v1, v2, and v3 respectively.","format":"int32"},"ip":{"type":"string","description":"IP Address"},"version":{"type":"string","description":"The version."},"addedInAdvanced":{"type":"boolean","description":"Specifies whether the device was added offline in advance. A value of true indicates that the device was pre-added offline and has not yet been adopted."},"lagList":{"type":"array","description":"The lag list of the switch device.","items":{"type":"integer","description":"The lag list of the switch device.","format":"int32"}},"deviceMisc":{"$ref":"#/components/schemas/OswDeviceMiscVO"},"lags":{"type":"array","description":"Device Lag Infos","items":{"$ref":"#/components/schemas/LagInfoVO"}},"lanList":{"type":"array","description":"Lan list.","items":{"type":"string","description":"Lan list."}},"ssidIds":{"type":"array","description":"The ssid list ap device used.","items":{"type":"string","description":"The ssid list ap device used."}},"deviceSeriesType":{"type":"integer","description":"DeviceSeriesType should be a value as follows: 0:advanced; 1:pro","format":"int32"},"stack":{"type":"boolean","description":"Parameter [stack] indicates whether the device supports stacking."},"unit":{"type":"integer","description":"Unit ID.","format":"int32"},"stackPorts":{"type":"array","description":"Stack ports info.","items":{"$ref":"#/components/schemas/OswStackPortGroupVO"}},"ports":{"type":"array","description":"The infos of ports.","items":{"$ref":"#/components/schemas/OswPortVO"}},"stackMsg":{"$ref":"#/components/schemas/StackMsgVO"},"mlagMsg":{"$ref":"#/components/schemas/MlagMsgVO"},"es":{"type":"boolean","description":"Whether it is Agile Series Switch"},"customPorts":{"type":"array","description":"The ports that has some vlan not included in port vlan.","items":{"type":"integer","description":"The ports that has some vlan not included in port vlan.","format":"int32"}},"customLagIds":{"type":"array","description":"The lag ids that has some vlan not included in port vlan.","items":{"type":"integer","description":"The lag ids that has some vlan not included in port vlan.","format":"int32"}},"supportLayout":{"type":"boolean","description":"Whether the device supports reporting port layout information."}}},"OuiBasedVlanRuleVO":{"required":["enable","name","ruleCombine","type"],"type":"object","properties":{"id":{"type":"string"},"enable":{"type":"boolean"},"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string"},"mode":{"type":"integer","format":"int32"},"type":{"type":"integer","format":"int32"},"ruleInterface":{"type":"array","items":{"type":"integer","format":"int32"}},"ssidList":{"type":"array","items":{"$ref":"#/components/schemas/SsidOuiModeVO"}},"ssidIdList":{"type":"array","items":{"type":"string"}},"deviceList":{"type":"array","items":{"$ref":"#/components/schemas/DeviceOuiModeVO"}},"ruleCombine":{"type":"array","items":{"$ref":"#/components/schemas/VlanOuiModeVO"}},"excludeDeviceList":{"type":"array","items":{"$ref":"#/components/schemas/OuiBasedVlanDeviceInfoVO"}},"resource":{"type":"integer","format":"int32"}}},"SsidOuiModeVO":{"type":"object","properties":{"ssidId":{"type":"string"},"ssidName":{"type":"string"}}},"StackMsgVO":{"type":"object","properties":{"stackId":{"type":"string","description":"Stack ID"},"stackName":{"type":"string","description":"Stack name"},"unit":{"type":"integer","description":"Stack unit ID","format":"int32"},"priority":{"type":"integer","description":"Stack priority","format":"int32"},"masterMac":{"type":"string","description":"Stack masterMac"},"stackStatus":{"type":"integer","description":"StackStatus should be a value as follows: 0: normal; 1: abnormal; 2: stack not ready","format":"int32"},"abnormalReason":{"type":"integer","description":"Causes of abnormal","format":"int32"},"stackPorts":{"type":"array","description":"The stack port that has been configured on the current unit","items":{"$ref":"#/components/schemas/OswStackPortGroupVO"}},"accountVrfId":{"type":"string","description":"The VRF ID for account traffic"},"authVrfId":{"type":"string","description":"The VRF ID for auth traffic"}},"description":"The stack info if it belongs to a stack."},"VlanOuiModeVO":{"required":["ouiProfileId","priority","vlanId"],"type":"object","properties":{"vlanId":{"type":"integer","format":"int32"},"priority":{"type":"integer","format":"int32"},"ouiProfileId":{"type":"string"},"ouiProfileName":{"type":"string"}}},"OperationResponseOuiBasedVlanOswPortNetworkTagsSettingVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OuiBasedVlanOswPortNetworkTagsSettingVO"}}},"OuiBasedVlanOswPortNetworkTagsSettingVO":{"type":"object","properties":{"hasAllowAllNetworkTags":{"type":"boolean","description":"Whether exist at least one port or lag with allow all network tags."}}},"CreateProviderProfileEntity":{"required":["profileName","providerSettings"],"type":"object","properties":{"profileName":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Provider profile name"},"providerSettings":{"$ref":"#/components/schemas/ProviderSettingVO"}}},"PortSettingVO":{"type":"object","properties":{"registrarPort":{"type":"integer","description":"When parameter [provider] is 0, parameter [registrarPort] has a default value of [5060]. In other cases, parameter [registrarPort] is always 5060.","format":"int32"},"sipProxy":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Parameter [sipProxy] should not be null when parameter [provider] is 6. When parameter [provider] is 0, parameter [sipProxy] has a default value of [0.0.0.0]. In other cases, parameter [sipProxy] is always [0.0.0.0]."},"sipProxyPort":{"type":"integer","description":"When parameter [provider] is 0, parameter [sipProxyPort] has a default value of [5060]. In other cases, parameter [sipProxyPort] is always 5060.","format":"int32"},"outboundProxy":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"When parameter [provider] is 0, parameter [outboundProxy] has a default value of [0.0.0.0]. In other cases, parameter [outboundProxy] is always [0.0.0.0]."},"outboundProxyPort":{"type":"integer","description":"When parameter [provider] is 0, parameter [outboundProxyPort] has a default value of [5060]. In other cases, parameter [outboundProxyPort] is always 5060.","format":"int32"},"viaOutboundProxy":{"type":"boolean","description":"When parameter [provider] is 0, parameter [viaOutboundProxy] has a default value of [true]. In other cases, parameter [viaOutboundProxy] is always true."}},"description":"Parameter [portSettings] should not be null when parameter [provider] is 6."},"ProviderSettingVO":{"required":["provider"],"type":"object","properties":{"provider":{"type":"integer","description":"The telephony providers supported. The range is between 0 and 13. 0: Other Provider; 1: 1 & 1 Internet; 2: Congstar; 3: Vodafone/Arcor; 4: DUS.net; 5: Easybell; 6: Kabel Deutschland; 7: QSC/Q-DSL home; 8: Sipgate.de; 9: Sipgate Team; 10: Sipload; 11: Ventengo; 12: Telekom; 13: Bellsip. The default value is 0.","format":"int32"},"registrarAddress":{"type":"string","description":"When parameter [provider] is a value in[0, 6], parameter [registrarAddress] should not be null."},"username":{"type":"string","description":"When parameter [provider] is a value in [0, 2, 4, 5, 8, 9, 10, 11, 12, 13], parameter [username] should not be null."},"password":{"type":"string"},"portSettings":{"$ref":"#/components/schemas/PortSettingVO"}},"description":"Telephony provider settings"},"CreateDigitMapProfileEntity":{"required":["digitMap","profileName"],"type":"object","properties":{"profileName":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Digit map profile name"},"digitMap":{"type":"string","description":"Digit map"}}},"DeleteDigitMapProfileEntity":{"required":["profileId","skipConfirm"],"type":"object","properties":{"profileId":{"type":"string","description":"Profile ID. Default digit map profile cannot be deleted."},"skipConfirm":{"type":"boolean","description":"skipConfirm indicates whether to skip the query of the devices bound to digit map profile. false: Not to skip the query. true: Skip the query and delete the digit map profile corresponding to the profileId."}}},"OperationResponseListProfilesBindedDeviceInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ProfilesBindedDeviceInfo"}}}},"ProfilesBindedDeviceInfo":{"type":"object","properties":{"id":{"type":"string"},"deviceName":{"type":"string","description":"Device name."},"deviceMac":{"type":"string","description":"Device MAC."},"model":{"type":"string","description":"Device model name"},"modelVersion":{"type":"string","description":"Device model version"},"type":{"type":"string","description":"Device type"},"profileNames":{"type":"array","description":"Profile names binded to the device.","items":{"type":"string","description":"Profile names binded to the device."}}}},"CreateCallBlockingProfileEntity":{"required":["profileName"],"type":"object","properties":{"profileName":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Call blocking profile name"},"incomingCallsBlockingEnable":{"type":"boolean","description":"Enable incoming calls blocking or not. The default value is false."},"incomingCallsBlocking":{"$ref":"#/components/schemas/IncomingCallsBlockingVO"},"outgoingCallsBlockingEnable":{"type":"boolean","description":"Enable outgoing calls blocking or not. The default value is false."},"outgoingCallsBlocking":{"$ref":"#/components/schemas/OutgoingCallsBlockingVO"}}},"IncomingCallsBlockingVO":{"type":"object","properties":{"types":{"type":"array","description":"Incoming calls blocking types. 0 means specific number, 1 means anonymous number.","items":{"type":"integer","description":"Incoming calls blocking types. 0 means specific number, 1 means anonymous number.","format":"int32"}},"numberList":{"type":"array","description":"Field [numberList] is required when the value of field [types] contains 0.","items":{"type":"string","description":"Field [numberList] is required when the value of field [types] contains 0."}}},"description":"Incoming calls blocking rules. Rules are valid if and only if parameter [incomingCallsBlockingEnable] equals true."},"OutgoingCallsBlockingVO":{"type":"object","properties":{"types":{"type":"array","description":"Outgoing calls blocking types. 0 means mobile, 1 means landline, 2 means long distance, 3 means international, 4 means calls with specific number prefix.","items":{"type":"integer","description":"Outgoing calls blocking types. 0 means mobile, 1 means landline, 2 means long distance, 3 means international, 4 means calls with specific number prefix.","format":"int32"}},"prefixList":{"type":"array","description":"Field [prefixList] is required when the value of field [types] contains 4.","items":{"type":"string","description":"Field [prefixList] is required when the value of field [types] contains 4."}}},"description":"Outgoing calls blocking rules. Rules are valid if and only if parameter [outgoingCallsBlockingEnable] equals true."},"VirtualWanConfigOpenApiVO":{"required":["name","physicalWanId","virtualWanIpv4Setting"],"type":"object","properties":{"name":{"pattern":"^[A-Za-z0-9\\_]+$","type":"string","description":"Virtual WAN name should contain 1 to 128 characters. Only letters, digits and underscores are allowed."},"physicalWanId":{"type":"string","description":"Physical WAN ID. Physical WAN ID can be obtained from 'Get internet basic info' interface. Physical WAN ID. Physical WAN ID can be obtained from 'Get internet basic info' interface. Only DSL WAN, Ethernet WAN, and SFP WAN support virtual WAN configuration."},"virtualWanIpv4Setting":{"$ref":"#/components/schemas/VirtualWanIpv4SettingConfigOpenApiVO"},"virtualWanDsl":{"$ref":"#/components/schemas/VirtualWanDslOpenApiVO"},"wanPortMacSetting":{"$ref":"#/components/schemas/VirtualWanMacSettingOpenApiVO"}},"description":"VirtualWanConfig"},"VirtualWanDslOpenApiVO":{"required":["isp","location","modulationType"],"type":"object","properties":{"vpi":{"type":"integer","description":"The VPI(0~255) assigned by your ISP to specify the virtual path between endpoints in an ATM network.","format":"int32"},"vci":{"type":"integer","description":"The VCI(1~65535) assigned by your ISP to specify the virtual channel endpoints in an ATM network.","format":"int32"},"encapMode":{"type":"integer","description":"Encap mode assigned by your ISP. 0: LLC, 1: VC-MUX, 2: VC/MUX, 3: 1483 Bridged IP LLC, 4: 1483 Routed IP LLC.","format":"int32"},"location":{"type":"string","description":"Your country/region."},"merEnable":{"type":"boolean","description":"If your ISP requires MER for network connection(e.g., Sky VDSL).MER switch configuration, only configurable when in VDSL mode and DHCP dial-up mode."},"merUsername":{"pattern":"^[^\\s]{1,63}$","type":"string","description":"MER username configuration, only configurable when in VDSL mode and DHCP dial-up mode."},"merPassword":{"pattern":"^[^\\s]{1,63}$","type":"string","description":"MER password configuration, only configurable when in VDSL mode and DHCP dial-up mode."},"isp":{"type":"integer","description":"Your ISP (Internet Service Provider) from the drop-down list,Select Other to customize the settings.","format":"int32"},"modulationType":{"type":"integer","description":"The modulation type used for your DSL connection. 0: VDSL, 1: ADSL.","format":"int32"}},"description":"VirtualWanDslOpenApiVO"},"VirtualWanIpv4Connection2OpenApiVO":{"required":["proto"],"type":"object","properties":{"mainProto":{"type":"string","description":"The main virtual WAN IPv4 proto type, use static, dhcp, pppoe."},"proto":{"type":"string","description":"The second virtual WAN IPv4 proto type, use static, dhcp, pppoe."},"server":{"type":"string","description":"VPN server IP/domain."},"ipaddr":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP address."},"netmask":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Subnet mask."},"gateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Gateway IP."},"dns1":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Primary DNS server."},"dns2":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Secondary DNS server."}},"description":"VirtualWanIpv4Connection2OpenApiVO"},"VirtualWanIpv4DhcpOpenApiVO":{"required":["mtu"],"type":"object","properties":{"unicast":{"type":"string","description":"Subnet mask of virtual WAN."},"dns1":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Primary DNS server."},"dns2":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Secondary DNS server."},"hostname":{"pattern":"^[a-zA-Z0-9_-]{0,63}$","type":"string","description":"Host name. Parameter [hostname] should be up to 63 characters long and can only use numbers, letters, and hyphen."},"mtu":{"type":"integer","description":"Parameter [mtu] should be a value between 576 and 1500.","format":"int32"},"dhcpOptions":{"type":"array","description":"Virtual WAN custom DHCP options.","items":{"$ref":"#/components/schemas/custom DHCP Options"}}},"description":"VirtualWanIpv4DhcpOpenApiVO"},"VirtualWanIpv4IpoaOpenApiVO":{"required":["gateway","ipaddr","mtu","netmask"],"type":"object","properties":{"ipaddr":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP address."},"netmask":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Subnet mask."},"gateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Gateway IP."},"mtu":{"type":"integer","description":"Parameter [mtu] should be a value between 576 and 1500.","format":"int32"},"dns1":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Primary DNS server."},"dns2":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Secondary DNS server."},"wanMultipleIps":{"type":"array","items":{"$ref":"#/components/schemas/VirtualWanMultipleIpVO"}}},"description":"VirtualWanIpv4IpoaOpenApiVO"},"VirtualWanIpv4PppoaOpenApiVO":{"required":["ipFromIsp","linkType","mru","mssClampingType","mtu","password","redialInterval","userName"],"type":"object","properties":{"ipaddr":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP address."},"userName":{"pattern":"^[A-Za-z0-9\\`\\~\\!\\@\\#\\$\\&\\*\\(\\)\\-\\=\\_\\+\\[\\]\\{\\}\\;\\:\\'\\\"\\\\\\|\\/\\?\\.\\,\\<\\>\\%\\^\\/]{1,255}$","type":"string","description":"Username. Parameter [userName] should contain 1 to 255 ASCII characters."},"password":{"pattern":"^[A-Za-z0-9\\`\\~\\!\\@\\#\\$\\&\\*\\(\\)\\-\\=\\_\\+\\[\\]\\{\\}\\;\\:\\'\\\"\\\\\\|\\/\\?\\.\\,\\<\\>\\%\\^\\/]{1,255}$","type":"string","description":"Password. Parameter [password] should contain 1 to 255 ASCII characters."},"ipFromIsp":{"type":"string","description":"Get IP address from ISP."},"gateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Gateway IP."},"linkType":{"type":"string","description":"Connection Mode. Parameter [linkType] should be as follows: auto: Connect Automatically; demand: Connect Manually; time: Time-based."},"redialInterval":{"type":"integer","description":"It is required when [linkType] is 0. Unit: Second.","format":"int32"},"startTime":{"type":"string","description":"It is required when [linkType] is 2. For example, 12:30."},"endTime":{"type":"string","description":"It is required when [linkType] is 2. For example, 12:30."},"service":{"pattern":"^[\\041-\\0176]{1,128}$","type":"string","description":"Parameter [service] should be 1 ~ 128 visible ASCII characters."},"netmask":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Subnet mask."},"mtu":{"type":"integer","description":"Parameter [mtu] should be a value between 576 and 1492.","format":"int32"},"mru":{"type":"integer","description":"Parameter [mru] should be a value between 576 and 1492.","format":"int32"},"dns1":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Primary DNS server."},"dns2":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Secondary DNS server."},"connect":{"type":"string"},"mssClampingType":{"type":"integer","description":"It should be a value as follows: 0: Disable, 1: Auto, 2: Custom.","format":"int32"},"mssClampingValue":{"type":"integer","description":"It is required when [mssClampingType] is 2, which ranges 532 ~ 1452.","format":"int32"}},"description":"VirtualWanIpv4PppoaOpenApiVO"},"VirtualWanIpv4PppoeOpenApiVO":{"required":["ipFromIsp","ipv4Connection2","linkType","mru","mssClampingType","mtu","password","redialInterval","userName"],"type":"object","properties":{"ipaddr":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP address."},"userName":{"pattern":"^[A-Za-z0-9\\`\\~\\!\\@\\#\\$\\&\\*\\(\\)\\-\\=\\_\\+\\[\\]\\{\\}\\;\\:\\'\\\"\\\\\\|\\/\\?\\.\\,\\<\\>\\%\\^\\/]{1,255}$","type":"string","description":"Username. Parameter [userName] should contain 1 to 255 ASCII characters."},"password":{"pattern":"^[A-Za-z0-9\\`\\~\\!\\@\\#\\$\\&\\*\\(\\)\\-\\=\\_\\+\\[\\]\\{\\}\\;\\:\\'\\\"\\\\\\|\\/\\?\\.\\,\\<\\>\\%\\^\\/]{1,255}$","type":"string","description":"Password. Parameter [password] should contain 1 to 255 ASCII characters."},"ipFromIsp":{"type":"string","description":"Get IP address from ISP."},"gateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Gateway IP."},"linkType":{"type":"string","description":"Connection Mode. Parameter [linkType] should be as follows: auto: Connect Automatically; demand: Connect Manually; time: Time-based."},"redialInterval":{"type":"integer","description":"It is required when [linkType] is auto. Unit: Second","format":"int32"},"startTime":{"type":"string","description":"It is required when [linkType] is 2. For example, 12:30."},"endTime":{"type":"string","description":"It is required when [linkType] is 2. For example, 12:30."},"service":{"pattern":"^[\\041-\\0176]{1,128}$","type":"string","description":"Service name. Keep parameter [service] blank unless your ISP requires you to configure it."},"netmask":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Subnet mask."},"mtu":{"type":"integer","description":"Parameter [mtu] should be a value between 576 and 1492","format":"int32"},"mru":{"type":"integer","description":"Parameter [mru] should be a value between 576 and 1492","format":"int32"},"dns1":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Primary DNS"},"dns2":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Secondary DNS"},"ipv4Connection2":{"$ref":"#/components/schemas/VirtualWanIpv4Connection2OpenApiVO"},"mssClampingType":{"type":"integer","format":"int32"},"mssClampingValue":{"type":"integer","format":"int32"}},"description":"VirtualWanIpv4PppoeOpenApiVO"},"VirtualWanIpv4SettingConfigOpenApiVO":{"required":["proto","qosTagEnable","vlanId"],"type":"object","properties":{"proto":{"type":"string","description":"Virtual WAN IPv4 protocol type: static, dhcp, pppoe for all connections; pppoa and ipoa options are only available for ADSL modulation connections. The configuration for the selected protocol type is required and must not be empty (e.g., ipv4Static for static)."},"vlanId":{"type":"integer","description":"Vlan ID. Parameter [vlanId] should between 1 and 4094.","format":"int32"},"vlanPriority":{"type":"integer","description":"Vlan Priority. It takes effect when [vlanId] is not 0, and it should be within the range of 0–7.","format":"int32"},"qosTagEnable":{"type":"boolean","description":"Whether to enable 802.1Q Tag."},"qosTag":{"type":"integer","description":"Qos Tag. Parameter [qosTag] should between 0 and 7.","format":"int32"},"ipv4Static":{"$ref":"#/components/schemas/VirtualWanIpv4StaticOpenApiVO"},"ipv4Dhcp":{"$ref":"#/components/schemas/VirtualWanIpv4DhcpOpenApiVO"},"ipv4Pppoe":{"$ref":"#/components/schemas/VirtualWanIpv4PppoeOpenApiVO"},"ipv4Pppoa":{"$ref":"#/components/schemas/VirtualWanIpv4PppoaOpenApiVO"},"ipv4Ipoa":{"$ref":"#/components/schemas/VirtualWanIpv4IpoaOpenApiVO"}},"description":"VirtualWanIpv4SettingConfigOpenApiVO"},"VirtualWanIpv4StaticOpenApiVO":{"required":["gateway","ipaddr","mtu","netmask"],"type":"object","properties":{"ipaddr":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP address."},"netmask":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Subnet mask."},"gateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Gateway IP."},"mtu":{"type":"integer","description":"Parameter [mtu] should be a value between 576 and 1500.","format":"int32"},"dns1":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Primary DNS."},"dns2":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Secondary DNS."}},"description":"VirtualWanIpv4StaticOpenApiVO"},"VirtualWanMacSettingOpenApiVO":{"required":["method"],"type":"object","properties":{"method":{"type":"string","description":"Parameter [method] should be set or recover. Set: Customize MAC address; Recover: Use default MAC address."},"mac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"Device MAC. When [method] is set, parameter [mac] should not be empty."}},"description":"VirtualWanMacSettingOpenApiVO"},"VirtualWanMultipleIpVO":{"required":["IP","enable"],"type":"object","properties":{"enable":{"type":"boolean"},"IP":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string"}}},"ModifySpeedTestV2SettingOpenApiVO":{"required":["autoSpeedTest"],"type":"object","properties":{"autoSpeedTest":{"type":"boolean","description":"Whether enable scheduled speed testing."},"timingType":{"type":"integer","description":"The timing type of speed test setting: 1:Daily, 2:Weekly, 3:Monthly.","format":"int32"},"hour":{"type":"integer","description":"Start time of speed test(unit: hour); It should be within the range of 0~23.","format":"int32"},"minute":{"type":"integer","description":"Start time of speed test(unit: minute); It should be within the range of 0~59.","format":"int32"},"dayOfWeek":{"type":"array","description":"It is required when [timingType] is 2. The value should be within the range of 0(Sunday)~6(Saturday).","items":{"type":"integer","description":"It is required when [timingType] is 2. The value should be within the range of 0(Sunday)~6(Saturday).","format":"int32"}},"dayOfMonth":{"type":"array","description":"It is required when [timingType] is 3. The value should be within the range of 1~31.","items":{"type":"integer","description":"It is required when [timingType] is 3. The value should be within the range of 1~31.","format":"int32"}}}},"ApMdnsRuleOpenApiVO":{"required":["clientVlan","serviceVlan"],"type":"object","properties":{"serviceVlan":{"type":"string","description":"Services Network VLAN. ServiceVlan should be within the range of 1 to 4094. Enter only one VLAN. This configuration is used for MDNS Rules where the band VLAN type is \"By VLAN ID\"."},"clientVlan":{"pattern":"^[\\d|\\d-\\d]+(,[\\d|\\d-\\d]+)*$","type":"string","description":"Client Network VLAN. ClientVlan should be within the range of 1 to 4094. Enter one or multiple VLANs. For example: 1,2-100. This configuration is used for MDNS Rules where the band VLAN type is \"By VLAN ID\"."}},"description":"MDNS rule by VLAN ID config, valid when parameter [type] is 0"},"CreateMdnsRuleTemplateOpenApiVO":{"required":["name","profileIds","status"],"type":"object","properties":{"name":{"type":"string","description":"MDNS rule name. Name should contain 1 to 64 characters"},"status":{"type":"boolean","description":"MDNS rule enable status"},"profileIds":{"type":"array","description":"This field represents Bonjour service profile ID. Bonjour Service Profile can be created using 'Create new Bonjour Service' interface, and Bonjour service profile ID can be obtained from 'Get Bonjour Service list' interface","items":{"type":"string","description":"This field represents Bonjour service profile ID. Bonjour Service Profile can be created using 'Create new Bonjour Service' interface, and Bonjour service profile ID can be obtained from 'Get Bonjour Service list' interface"}},"type":{"type":"integer","description":"MDNS rule band VLAN type. Type should be a value as follows: 0: By VLAN ID, 1: By Network","format":"int32"},"ap":{"$ref":"#/components/schemas/ApMdnsRuleOpenApiVO"},"osg":{"$ref":"#/components/schemas/OsgMdnsRuleTemplateOpenApiVO"}}},"OsgMdnsRuleTemplateOpenApiVO":{"required":["clientNetworks","serviceNetworks"],"type":"object","properties":{"serviceNetworks":{"type":"array","description":"LAN Network ID list of selected service networks. LAN Network can be created using 'Create LAN network template' interface, and LAN Network ID can be obtained from 'Get LAN network template list' interface","items":{"type":"string","description":"LAN Network ID list of selected service networks. LAN Network can be created using 'Create LAN network template' interface, and LAN Network ID can be obtained from 'Get LAN network template list' interface"}},"clientNetworks":{"type":"array","description":"LAN Network ID list of selected client networks. LAN Network can be created using 'Create LAN network template' interface, and LAN Network ID can be obtained from 'Get LAN network template list' interface","items":{"type":"string","description":"LAN Network ID list of selected client networks. LAN Network can be created using 'Create LAN network template' interface, and LAN Network ID can be obtained from 'Get LAN network template list' interface"}}},"description":"MDNS rule by network config, valid when parameter [type] is 1"},"CreateDdnsOpenApiVO":{"required":["interfacePortId","password","service","status","username"],"type":"object","properties":{"service":{"type":"integer","description":"Dynamic DNS service type. Service should be a value as follows: 0: DynDNS, 1: NO-IP, 2: Peanuthull, 3: Comexe, 4: Custom, 5: TP-Link DDNS","format":"int32"},"status":{"type":"boolean","description":"Dynamic DNS enable status"},"interfacePortId":{"type":"string","description":"This field represents interface Port ID"},"username":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"Dynamic DNS username. Username should contain 1 to 128 characters"},"password":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"Dynamic DNS password. Password should contain 1 to 128 characters"},"domainName":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"Dynamic DNS domainName, valid when parameter [service] is 0, 1 or 4"},"interval":{"$ref":"#/components/schemas/DdnsIntervalOpenApiVO"},"updateUrl":{"type":"string","description":"Dynamic DNS updateUrl, valid when parameter [service] is 4. Update URL must contain [USERNAME], [PASSWORD] and [DOMAIN], and Update-URL will be applied to all custom entries"}}},"DdnsIntervalOpenApiVO":{"type":"object","properties":{"updateInterval":{"type":"integer","description":"Dynamic DNS update interval, unit: hour. UpdateInterval should be a value as follows: 0, 1, 6, 12, 24, 48 or 72","format":"int32"},"customInterval":{"type":"integer","description":"Dynamic DNS custom interval, valid when parameter [server] is 0, 1 or 4, unit: minute. CustomInterval should be within the range of 1-60","format":"int32"}},"description":"Dynamic DNS interval configuration. You can configure one of two intervals, when parameter [service] is 2 or 3, you can only choose [updateInterval] to configure, when parameter [service] is 5, you don’t need to configure interval."},"CertProfileRequestOpenApiVO":{"required":["format","name","type"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Cert profile name, name should contain 1 to 64 characters."},"type":{"type":"integer","description":"Cert profile type, type should be a value as follows: 0: CA Cert; 1: Client Cert..","format":"int32"},"format":{"type":"integer","description":"Cert profile format, format should be a value as follows: 0: X509; 1: DER.","format":"int32"},"caCertFileId":{"type":"string","description":"CA Certificate file id, it's obtained from the interface 'uploadCaCertFile'; When type = 0, Parameter [caCertFileId] should not be null."},"clientCertFileId":{"type":"string","description":"Client certificate file id, it's obtained from the interface 'uploadClientCertFile'; When type = 1, Parameter [clientCertFileId] should not be null."},"privateKeyFileId":{"type":"string","description":"Client private key file id, it's obtained from the interface 'UploadClientPrivateKeyFile'; When type = 1, Parameter [privateKeyFileId] should not be null."},"privateKeyPassword":{"type":"string","description":"Client private key password; When type = 1, Parameter [privateKeyPassword] is an optional input."}},"description":"CertProfileRequestOpenApiVO"},"SessionLimitRuleTemplateOpenApiVO":{"required":["maxSession","name","sourceType","status"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name should contain 1 to 64 characters."},"status":{"type":"boolean","description":"Status of the session limit rule."},"sourceType":{"type":"integer","description":"Source type should be a value as follows: 0: network; 1: IP group; 2: IP.","format":"int32"},"sourceIds":{"type":"array","description":"Source IDs of the session limit rule, only for network and IP group type.Network can be created using 'Create LAN network template' interface, and network ID can be obtained from 'Get LAN network template list' interface. IP group can be created using 'Create a new group profile template' interface, and IP group ID can be obtained from 'Get group profile template list' interface.","items":{"type":"string","description":"Source IDs of the session limit rule, only for network and IP group type.Network can be created using 'Create LAN network template' interface, and network ID can be obtained from 'Get LAN network template list' interface. IP group can be created using 'Create a new group profile template' interface, and IP group ID can be obtained from 'Get group profile template list' interface."}},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP of the session limit rule."},"maxSession":{"type":"integer","description":"Max sessions should be within the range of 1–999999.","format":"int32"}}},"PolicyRoutingDragSortIndexOpenApiVO":{"required":["indexes"],"type":"object","properties":{"indexes":{"type":"object","additionalProperties":{"type":"integer","description":"The order in which items take effect, this object is a Map, the key is item ID and the value is the index you want to set.","format":"int32"},"description":"The order in which items take effect, this object is a Map, the key is item ID and the value is the index you want to set."}}},"SiteRememberDeviceSetting":{"type":"object","properties":{"remember":{"type":"boolean","description":"Site remember device."}},"description":"Site remember device setting"},"CreateRateLimitProfileOpenApiVO":{"required":["downLimitEnable","name","upLimitEnable"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Rate limit profile name should contain 1 to 64 characters."},"downLimitEnable":{"type":"boolean","description":"Whether to enable download limit"},"downLimit":{"type":"integer","description":"Download limit(Unit: Kbps), this field is required when parameter [downLimitEnable] is true; It should be within the range of 1–10485760.","format":"int64"},"upLimitEnable":{"type":"boolean","description":"Whether to enable upload limit"},"upLimit":{"type":"integer","description":"Upload limit(Unit: Kbps), this field is required when parameter [upLimitEnable] is true; It should be within the range of 1–10485760.","format":"int64"}}},"QosBwcOpenApiVO":{"required":["classRatio","direction","inBandwidth","outBandwidth","outPrioritization","status","udpBandwidthCtrl","wan"],"type":"object","properties":{"wan":{"type":"string","description":"The ID of WAN port to which this Bandwidth Control applies. Each WAN port can only be configured with one rule. WAN ID can be obtained from 'Get WAN ports info for Gateway QoS' interface."},"status":{"type":"boolean","description":"The status of Bandwidth Control rule, valid values are true or false."},"udpBandwidthCtrl":{"type":"boolean","description":"The UDP Bandwidth Control of Bandwidth Control rule, valid values are true or false."},"udpRatio":{"type":"integer","description":"The Limited Bandwidth Ratio of Bandwidth Control rule. It should be within the range of 0-100 when parameter [udpBandwidthCtrl] is true.","format":"int32"},"outPrioritization":{"type":"boolean","description":"The Outbound TCP ACK Prioritize of Bandwidth Control rule, valid values are true or false."},"direction":{"type":"integer","description":"The direction value selected in the Direction configuration should be a value as follows: 0: Inbound; 1: Outbound; 2: Both.","format":"int32"},"inBandwidth":{"type":"integer","description":"The Inbound Bandwidth of Bandwidth Control rule should be within the range of 100-1000000.","format":"int32"},"outBandwidth":{"type":"integer","description":"The Outbound Bandwidth of Bandwidth Control rule should be within the range of 100-1000000.","format":"int32"},"classRatio":{"type":"array","description":"The ratio of class type, value's format is [class1 ratio, class2 ratio, class3 ratio, others ratio], and the total sum should be 100.","items":{"type":"integer","description":"The ratio of class type, value's format is [class1 ratio, class2 ratio, class3 ratio, others ratio], and the total sum should be 100.","format":"int32"}}}},"CarrierOpenApiVO":{"type":"object","properties":{"carrierName":{"type":"string","description":"Carrier Name."},"epdgs":{"type":"array","description":"epdgs","items":{"$ref":"#/components/schemas/EPDGOpenApiVO"}}},"description":"carrierList"},"CreateWifiCallingProfileOpenApiVO":{"type":"object","properties":{"name":{"type":"string","description":"Wi-Fi Calling Profile Name. It should contain 1 to 32 UTF-8 characters."},"description":{"type":"string","description":"Description of the Wi-Fi calling profile. It should contain 1 to 32 UTF-8 characters."},"carrierList":{"type":"array","description":"carrierList","items":{"$ref":"#/components/schemas/CarrierOpenApiVO"}}}},"EPDGOpenApiVO":{"type":"object","properties":{"qosPriority":{"type":"integer","description":"QOS Priority","format":"int32"},"type":{"type":"integer","description":"Type. Such as: 0: domain, 1:ip.","format":"int32"},"domain":{"type":"string","description":"Domain. If parameter [type] is 0, it should not be null."},"ip":{"type":"string","description":"Ip. If parameter [type] is 1, it should not be null."}},"description":"epdgs"},"CopyWifiCallingProfileOpenApiVO":{"type":"object","properties":{"name":{"type":"string","description":"Wi-Fi Calling Profile Name"}}},"CreateRadiusProfileOpenApiVO":{"required":["authServer","name","radiusAccountingEnable","wirelessVlanAssignment"],"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,62}[^ ]$","type":"string","description":"Radius profile name should contain 1 to 64 characters"},"authServer":{"type":"array","description":"Radius authentication server list","items":{"$ref":"#/components/schemas/RadiusAuthServerOpenApiVO"}},"radiusAccountingEnable":{"type":"boolean","description":"Radius accounting enable status"},"interimUpdateEnable":{"type":"boolean","description":"When radius accounting enables, interval update enable status"},"interimUpdateInterval":{"type":"integer","description":"When interval update enables, interval update duration, unit: second. InterimUpdateInterval should be within the range of 60-86400","format":"int32"},"acctServer":{"type":"array","description":"Radius accounting server list, valid when parameter [radiusAccountingEnable] is true","items":{"$ref":"#/components/schemas/RadiusAcctServerOpenApiVO"}},"wirelessVlanAssignment":{"type":"boolean","description":"VLAN assignment for wireless network enable status"},"coaEnable":{"type":"boolean","description":"Radius CoA enable status"},"coaPassword":{"type":"string","description":"Radius CoA password, required when parameter [coaEnable] is true. CoaPassword should contain 1 to 128 characters. The question mark (?), double quote (\"), percent sign (%), and backslash (\\) may cause the RADIUS function to fail and are not recommended."},"requireMessageAuthenticator":{"type":"boolean","description":"Message-Authenticator enable status"}}},"RadiusAcctServerOpenApiVO":{"required":["accountingServerIp","accountingServerPort","accountingServerPwd"],"type":"object","properties":{"accountingServerIp":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"Radius Accounting Server IP.In Pro Site of the Omada Pro Controller, [accountingServerIp] should be a valid IP or domain address. In Omada Controller and Basic Site of the Omada Pro Controller, [accountingServerIp] should be a valid IP address."},"accountingServerPort":{"type":"integer","description":"Radius Accounting port. AccountingServerPort should be within the range of 1-65535","format":"int32"},"accountingServerPwd":{"type":"string","description":"Radius Accounting password,The question mark (?), double quote (\"), percent sign (%), and backslash (\\) may cause the RADIUS function to fail and are not recommended."},"radSecEnable":{"type":"boolean","description":"Radius RadSec enable status"},"caCert":{"type":"string","description":"CA certification profile id"},"clientCert":{"type":"string","description":"Client certification profile id"}},"description":"Radius accounting server list, valid when parameter [radiusAccountingEnable] is true"},"RadiusAuthServerOpenApiVO":{"required":["radiusPort","radiusPwd","radiusServerIp"],"type":"object","properties":{"radiusServerIp":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"Radius authentication server IP. In Pro Site of the Omada Pro Controller, [radiusServerIp] should be a valid IP or domain address. In Omada Controller and Basic Site of the Omada Pro Controller, [radiusServerIp] should be a valid IP address."},"radiusPort":{"type":"integer","description":"Radius authentication server port, radiusPort should be within the range of 1-65535","format":"int32"},"radiusPwd":{"pattern":"^[\\041-\\0176]{1,128}$","type":"string","description":"Radius authentication server password, radiusPwd should contain 1 to 64 characters,The question mark (?), double quote (\"), percent sign (%), and backslash (\\) may cause the RADIUS function to fail and are not recommended."},"radSecEnable":{"type":"boolean","description":"Radius RadSec enable status"},"caCert":{"type":"string","description":"CA certification profile id"},"clientCert":{"type":"string","description":"Client certification profile id"}},"description":"Radius authentication server list"},"CreateRadiusUserOpenApiVO":{"required":["type"],"type":"object","properties":{"type":{"type":"integer","description":"Type of Build-in RADIUS profile user, 0: user auth; 1: MAC auth","format":"int32"},"userInfo":{"$ref":"#/components/schemas/RadiusUserInfoOpenApiVO"},"macAddress":{"type":"string","description":"MAC address, required when parameter [type] is 1. Should be a valid MAC address format"},"upRateLimit":{"type":"integer","description":"Build-in RADIUS profile user uplink rate limit, unit: Kbps. UpRateLimit should be within the range of 1-10485760","format":"int64"},"downRateLimit":{"type":"integer","description":"Build-in RADIUS profile user downlink rate limit, unit: Kbps. DownRateLimit should be within the range of 1-10485760","format":"int64"},"upLimit":{"type":"integer","description":"Build-in RADIUS profile user uplink traffic limit, unit: MB. UpLimit should be within the range of 1-10485760","format":"int64"},"downLimit":{"type":"integer","description":"Build-in RADIUS profile user downlink traffic limit, unit: MB. DownLimit should be within the range of 1-10485760","format":"int64"},"vlanId":{"type":"integer","description":"VLAN ID. VlanId should be within the range of 1-4096","format":"int32"},"timeout":{"type":"integer","description":"Session timeout, unit: second","format":"int32"},"description":{"type":"string","description":"Description of radius user, should contain 1 to 256 characters"}}},"RadiusUserInfoOpenApiVO":{"required":["password","username"],"type":"object","properties":{"username":{"pattern":"^[\\x21-\\x7e]{1,64}$","type":"string","description":"Build-in RADIUS profile user name. Username should contain 1 to 64 characters"},"password":{"pattern":"^[\\x21-\\x7e]{1,64}$","type":"string","description":"Build-in RADIUS profile user password. Password should contain 1 to 64 characters"}},"description":"User name and password, required when parameter [type] is 0."},"CreateLdapProfileOpenApiVO":{"required":["baseDn","bindType","cn","dstPort","name","server","status","useSsl"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"LDAP profile name. Name should contain 1 to 64 characters"},"status":{"type":"boolean","description":"LDAP profile enable status"},"bindType":{"type":"integer","description":"Type of LDAP bind. BindType should be a value as follows: 0: Simple Mode; 1: Anonymous Mode; 2: Regular Mode","format":"int32"},"server":{"type":"string","description":"LDAP server address"},"dstPort":{"type":"integer","description":"LDAP server listening port. dstPort should be within the range of 0-65535. When SSL is not enabled, it is generally 389, and when SSL is enabled, it is generally 636","format":"int32"},"useSsl":{"type":"boolean","description":"LDAP server enable ssl status"},"cn":{"type":"string","description":"LDAP server common name, for example: cn, uid. Cn should contain 1 to 64 characters"},"baseDn":{"type":"string","description":"LDAP server base distinguish name, for example: dc=xxx,dc=com. BaseDn should contain 1 to 512 characters."},"groupDn":{"type":"string","description":"LDAP server group distinguish name, optional when parameter [type] is 1 or 2. For example: ou=xxx,dc=xxx,dc=com. GroupDn should contain 1 to 512 characters"},"filter":{"type":"string","description":"Additional filter, optional when parameter [type] is 1 or 2. For example: ou=xxx. Filter should contain 1 to 512 characters"},"regularDn":{"type":"string","description":"Regular Dn, required when parameter [type] is 2. RegularDn should contain 1 to 256 characters"},"regularPassword":{"type":"string","description":"Regular Password, required when parameter [type] is 2. RegularPassword should contain 1 to 256 characters"}}},"CreateGroupOpenApiVO":{"required":["name","type"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Group profile name. Name should contain 1 to 64 characters"},"type":{"type":"integer","description":"Type of group profile, type should be a value as follows: 0: IP Group; 1: IP Port Group; 2: MAC Group; 3: IPv6 Group; 4: IPv6 Port Group; 5: Country Group; 7: Domain Group;","format":"int32"},"ipList":{"type":"array","description":"IP subnet info list. [type] value of 0 or 1 is required","items":{"$ref":"#/components/schemas/IPSubnetsOpenApiVO"}},"ipv6List":{"type":"array","description":"IPv6 subnet info list. [type] value of 3 or 4 is required","items":{"$ref":"#/components/schemas/IPv6SubnetsOpenApiVO"}},"portType":{"type":"integer","description":"Port type, portType should be a value as follows: 0: port range 1: port mask. [type] value of 1 or 4 is required","format":"int32"},"portList":{"type":"array","description":"Port list. [portType] value of 0 is required. PortList should be within the range of 0-65535, e.g. 80 or 80-100","items":{"type":"string","description":"Port list. [portType] value of 0 is required. PortList should be within the range of 0-65535, e.g. 80 or 80-100"}},"portMaskList":{"type":"array","description":"Port mask list. [portType] value of 1 is required","items":{"$ref":"#/components/schemas/PortMaskOpenApiVO"}},"macAddressList":{"type":"array","description":"MAC address list. [type] value of 2 is required","items":{"$ref":"#/components/schemas/CreateMacAddressOpenApiVO"}},"countryList":{"type":"array","description":"Country list. [type] value of 5 is required. For the values of countryList, refer to 'Country Name' section 5.4.1 of the Open API Access Guide","items":{"type":"string","description":"Country list. [type] value of 5 is required. For the values of countryList, refer to 'Country Name' section 5.4.1 of the Open API Access Guide"}},"description":{"pattern":"^$|^[^ ]$|^[^ ].{0,510}[^ ]$","type":"string","description":"Description should contain 1 to 256 characters. [type] value of 5 is required"},"domainNamePort":{"type":"array","description":"Domain info. Handle situations where there are ports, [type] value of 7 is required","items":{"$ref":"#/components/schemas/DomainOpenApiVO"}}}},"CreateMacAddressOpenApiVO":{"required":["macAddress"],"type":"object","properties":{"name":{"type":"string","description":"MAC address name, name should contain 1 to 128 characters"},"macAddress":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"MAC address, should be a valid MAC address format, e.g. AA-BB-CC-DD-11-22"}},"description":"MAC address list. [type] value of 2 is required"},"DomainOpenApiVO":{"required":["address"],"type":"object","properties":{"address":{"type":"string","description":"Domain address, should be a valid domain address"},"port":{"type":"string","description":"Domain port, port should be within the range of 0-65535 or empty, e.g. 80,80-100"},"description":{"pattern":"^$|^[^ ]$|^[^ ].{0,510}[^ ]$","type":"string","description":"Domain description, description should contain 1 to 512 characters."}},"description":"Domain info. Handle situations where there are ports, [type] value of 7 is required"},"IPSubnetsOpenApiVO":{"required":["ip","mask"],"type":"object","properties":{"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP address, should be a valid IP format"},"mask":{"type":"integer","description":"IP mask, mask should be within the range of 1-32","format":"int32"},"description":{"pattern":"^$|^[^ ]$|^[^ ].{0,510}[^ ]$","type":"string","description":"IP description, description should contain 1 to 512 characters."}},"description":"IP subnet info list. [type] value of 0 or 1 is required"},"IPv6SubnetsOpenApiVO":{"required":["ip","prefix"],"type":"object","properties":{"ip":{"pattern":"(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\S*$)","type":"string","description":"IPv6 address, should be a valid IPv6 format"},"prefix":{"type":"integer","description":"IPv6 prefix, prefix should be within the range of 1-128","format":"int32"},"description":{"pattern":"^$|^[^ ]$|^[^ ].{0,510}[^ ]$","type":"string","description":"IPv6 description, description should contain 1 to 512 characters."}},"description":"IPv6 subnet info list. [type] value of 3 or 4 is required"},"PortMaskOpenApiVO":{"required":["mask","port"],"type":"object","properties":{"port":{"type":"integer","description":"Port should be within the range of 0-65535","format":"int32"},"mask":{"pattern":"^[0-9a-fA-F]{4}$","type":"string","description":"Port mask should be 4 hex number(0-9, A-F), e.g. 0000 or FFFF"}},"description":"Port mask list. [portType] value of 1 is required"},"PpskProfile":{"required":["ppsk","profileName"],"type":"object","properties":{"profileName":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,62}[^ ]$","type":"string","description":"PPSK Profile Name, should contain 1 to 64 characters."},"ppsk":{"type":"array","description":"PPSK List In the PPSK Profile","items":{"$ref":"#/components/schemas/PpskSetting"}},"type":{"type":"integer","description":"This field has been deprecated since version 6.1. PPSK Profile type: 0：PPSK Without RADIUS;Cloud Based Controller only support PPSK Without RADIUS.","format":"int32"},"rateLimit":{"$ref":"#/components/schemas/PPSKRateLimitSettingVO"},"expiration":{"$ref":"#/components/schemas/PPSKExpirationVO"}},"description":"PPSK Profile Setting."},"PpskSetting":{"required":["name","psk"],"type":"object","properties":{"name":{"pattern":"^[a-zA-z0-9'!\"#$%&()*,./:;?^_`\\[\\]{|}~<>\\ ][\\041-\\0176]{0,63}$","type":"string","description":"PPSK Name, should contain 1 to 64 characters."},"psk":{"pattern":"^([A-Za-z0-9\\p{Punct} ]{8,63}|[0-9a-fA-F]{8,63})$","type":"string","description":"Password, should contain 8 to 63 visible ASCII characters."},"mac":{"pattern":"^([0-9A-F][02468ACE](:[0-9A-F]{2}){5})|([0-9a-f][02468ace](:[0-9a-f]{2}){5})|([0-9A-F][02468ACE](-[0-9A-F]{2}){5})|([0-9a-f][02468ace](-[0-9a-f]{2}){5})|([0-9A-F][02468ACE]([0-9A-F]{2}){5})|([0-9a-f][02468ace]([0-9a-f]{2}){5})$","type":"string","description":"Mac Bound With PSK.The MAC format requires the use of numbers and uppercase letters and connectors, such as AA-BB-CC-00-11-22."},"vlan":{"type":"integer","description":"Vlan Bound With PSK, should be within the range of 1-4094.","format":"int32"}},"description":"PPSK Profile's PPSK Setting."},"PpskAutoCreateSetting":{"required":["length","number","prefix"],"type":"object","properties":{"number":{"type":"integer","description":"Generate Number, should be within the range of 1-1024.","format":"int32"},"prefix":{"pattern":"^[a-zA-z0-9'!\"#$%&()*,./:;?^_`\\[\\]{|}~<>\\ ][\\041-\\0176]{0,59}$","type":"string","description":"PSK Name Prefix, should contain 1 to 60 visible ASCII characters."},"length":{"type":"integer","description":"PSK Password Length, should be within the range of 8-63.","format":"int32"},"vlan":{"type":"integer","description":"PSK Bound Vlan, should be within the range of 1-4094.","format":"int32"}},"description":"Auto Create PPSK Setting."},"PSK":{"required":["name","psk"],"type":"object","properties":{"name":{"pattern":"^[a-zA-z0-9'!\"#$%&()*,./:;?^_`\\[\\]{|}~<>\\ ][\\041-\\0176]{0,63}$","type":"string","description":"PSK Name"},"psk":{"pattern":"^([A-Za-z0-9\\p{Punct} ]{8,63}|[0-9a-fA-F]{8,63})$","type":"string","description":"Password"},"vlan":{"maximum":4094,"minimum":1,"type":"integer","description":"Vlan Bound With PSK","format":"int32"}},"description":"Auto Created PSKs."},"AdvertisementSetting":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Advertisement enable."},"pictureIds":{"type":"array","description":"Picture ID list, Up to 5 entries are allowed for the pictureIds list.","items":{"type":"string","description":"Picture ID list, Up to 5 entries are allowed for the pictureIds list."}},"totalDuration":{"type":"integer","description":"Advertisement totalDuration, should be within the range of 1–30, time unit is second.","format":"int32"},"pictureInterval":{"type":"integer","description":"Advertisement picture interval, should be within the range of 1–10, time unit is second.","format":"int32"},"skipEnable":{"type":"boolean","description":"Whether allow users to skip the advertisement."},"skipDelay":{"type":"integer","description":"Skip delay, should be within the range of 1–10, time unit is second.","format":"int32"}},"description":"Advertisement Setting."},"AuthTimeoutSetting":{"type":"object","properties":{"customTimeout":{"type":"integer","description":"Custom timeout should be within the range of 1 - 1,000,000 min or 1 - 10,000 hour or 1 - 1,000 day.","format":"int32"},"customTimeoutUnit":{"type":"integer","description":"Timeout unit, should be a value as follows: 1: min; 2: hour; 3: day.","format":"int32"}},"description":"Auth Timeout Setting."},"BgPicCoordinatesOfLibraryOpenApiVO":{"type":"object","properties":{"width":{"type":"integer","description":"Width of background picture coordinates.","format":"int32"},"height":{"type":"integer","description":"Height of background picture coordinates.","format":"int32"},"left":{"type":"integer","description":"Left of background picture coordinates.","format":"int32"},"top":{"type":"integer","description":"Top of background picture coordinates.","format":"int32"}},"description":"Library mobile background picture coordinates."},"ExternalRadiusSetting":{"required":["authMode","nasId","portalCustom","radiusProfileId"],"type":"object","properties":{"radiusProfileId":{"type":"string","description":"RADIUS profile ID."},"authMode":{"type":"integer","description":"RADIUS auth mode, should be a value as follows: 1: PAP; 2: CHAP","format":"int32"},"nasId":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"RADIUS Attribute: NasID, should contain 1 to 64 characters."},"portalCustom":{"type":"integer","description":"Portal customization, should be a value as follows: 1: Local Web Portal; 2: External Web Portal.","format":"int32"},"externalUrlScheme":{"pattern":"http|https","type":"string","description":"External URL scheme, required when [portalCustom] is 2, value could be 'http' or 'https'."},"externalUrl":{"pattern":"^(([-a-zA-Z0-9@:%._+~#=]{2,256}\\.[a-z]{2,63})|((?!255\\.255\\.255\\.255)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\.)){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))((:([1-9]|[1-9]\\d|[1-9]\\d{2}|[1-9]\\d{3}|[1-5]\\d{4}|6[0-4]\\d{3}|65[0-4]\\d{2}|655[0-2]\\d|6553[0-5]))?)(/([-a-zA-Z0-9@:%_+.~#?&//=]*))?$","type":"string","description":"External URL, required when [portalCustom] is 2"},"disconnectReq":{"type":"boolean","description":"Whether to support disconnect messages."},"receiverPort":{"type":"integer","description":"Port for listening to disconnect messages, should be within the range of 1–65535.","format":"int32"}},"description":"External RADIUS Portal Setting."},"ExternalServerPortalSetting":{"required":["hostType"],"type":"object","properties":{"hostType":{"type":"integer","description":"Host type, should be a value as follows: 1: IP; 2: URL","format":"int32"},"serverIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Server IP, required when [hostType] is 1, pattern as \"xx.xx.xx.xx\"."},"serverPort":{"type":"integer","description":"Server port, required when [hostType] is 1, from 1 to 65535.","format":"int32"},"serverUrlScheme":{"pattern":"http|https","type":"string","description":"Server url scheme, required when [hostType] is 2, value is http or https."},"serverUrl":{"pattern":"^(([-a-zA-Z0-9@:%._+~#=]{2,256}\\.[a-z]{2,63})|((?!255\\.255\\.255\\.255)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\.)){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))((:([1-9]|[1-9]\\d|[1-9]\\d{2}|[1-9]\\d{3}|[1-5]\\d{4}|6[0-4]\\d{3}|65[0-4]\\d{2}|655[0-2]\\d|6553[0-5]))?)(/([-a-zA-Z0-9@:%_+.~#?&//=]*))?$","type":"string","description":"Server url, required when [hostType] is 2."}},"description":"External Server Portal Setting."},"GoogleOAuthSettingOpenApiVO":{"required":["clientId","clientSecret"],"type":"object","properties":{"clientId":{"pattern":"^\\S{0,256}$","type":"string","description":"Google OAuth client ID"},"clientSecret":{"pattern":"^\\S{0,256}$","type":"string","description":"Google OAuth client secret"}},"description":"Google OAuth setting, required when [authType] is 16 and social auth [enabledTypes] contains 17."},"HotspotRadiusSetting":{"required":["authMode","authTimeout","nasId","radiusProfileId"],"type":"object","properties":{"radiusProfileId":{"type":"string","description":"RADIUS profile ID."},"authMode":{"type":"integer","description":"RADIUS auth mode, should be a value as follows: 1: PAP; 2: CHAP","format":"int32"},"nasId":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"RADIUS Attribute: NasID, should contain 1 to 64 characters."},"authTimeout":{"$ref":"#/components/schemas/AuthTimeoutSetting"},"disconnectReq":{"type":"boolean","description":"Whether to support disconnect messages."},"receiverPort":{"type":"integer","description":"Port for listening to disconnect messages, should be within the range of 1–65535.","format":"int32"}},"description":"Hotspot RADIUS Portal Setting."},"HotspotSetting":{"required":["enabledTypes"],"type":"object","properties":{"enabledTypes":{"type":"array","description":"Hotspot enabled auth types, should be a value as follows: 3: Voucher, 5: Local User, 8: Hotspot RADIUS, 6: Sms, 12: Form Auth.","items":{"type":"integer","description":"Hotspot enabled auth types, should be a value as follows: 3: Voucher, 5: Local User, 8: Hotspot RADIUS, 6: Sms, 12: Form Auth.","format":"int32"}}},"description":"Hotspot types setting."},"ImportedPortalPageOpenApiVO":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"Imported portal page ID. Imported portal page can be uploaded using 'Import portal page' interface "}},"description":"Imported portal page, required when parameter [pageType] is 2"},"LdapSetting":{"required":["ldapProfileId","portalCustom"],"type":"object","properties":{"ldapProfileId":{"type":"string","description":"LDAP profile ID. Ldap profile can be  created using 'Create a new LDAP profile' ('Create a new LDAP profile template') interface, and LDAP profile ID can be obtained from 'Get LDAP profile list' ('Get LDAP profile template list') interface"},"portalCustom":{"type":"integer","description":"Portal customization, should be a value as follows: 1: use local; 2: use external","format":"int32"},"externalUrlScheme":{"pattern":"http|https","type":"string","description":"External URL scheme, should be a value as follows: http ; https. Required when portalCustom is 2."},"externalUrl":{"pattern":"^(([-a-zA-Z0-9@:%._+~#=]{2,256}\\.[a-z]{2,63})|((?!255\\.255\\.255\\.255)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\.)){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))((:([1-9]|[1-9]\\d|[1-9]\\d{2}|[1-9]\\d{3}|[1-5]\\d{4}|6[0-4]\\d{3}|65[0-4]\\d{2}|655[0-2]\\d|6553[0-5]))?)(/([-a-zA-Z0-9@:%_+.~#?&//=]*))?$","type":"string","description":"External URL. Required when portalCustom is 2."}},"description":"Ldap Portal Setting."},"NoAuthSetting":{"required":["dailyLimitEnable"],"type":"object","properties":{"dailyLimitEnable":{"type":"boolean","description":"If enabled, authentication can only be performed once a day."}},"description":"No Auth Portal Setting."},"PortalCustomizeOpenApiVO":{"required":["copyrightEnable","defaultLanguage","logoDisplay","termsOfServiceEnable","welcomeEnable"],"type":"object","properties":{"defaultLanguage":{"type":"integer","description":"The controller automatically adjusts the language displayed on the Portal page according to the system language of the clients.If the language is not supported, the controller will use the default language specified here.<br/>1: en_US (English); 3: cs_CZ (Český); 4: de_DE (Deutsch); 5: da_DK (Dansk); 6: el_GR (ελληνικά);<br/>7: fr_FR (Français); 8: es_ES (Español); 9: nl_NL (Nederlands); 10: it_IT (Italiano); 11: pl_PL (Polski);<br/>12: pt_PT (Português); 13: ru_RU (Русский); 14: sv_SE (Svenska); 15: tr_TR (Türkçe);<br/>16: ar_SA (لغة عربية); <br/>17: ja_JP (日本語); 18: zh_TW (中文(繁體)); 19: th_TH (ไทย); 20: vi_VN (Tiếng Việt); 21: ko_KR (한국어)","format":"int32"},"backgroundPictureId":{"type":"string","description":"Background picture ID"},"logoPictureId":{"type":"string","description":"Logo picture ID"},"logoDisplay":{"type":"boolean","description":"Whether to display the default logo."},"inputBoxColor":{"pattern":"^#[0-9A-Fa-f]{6}$","type":"string","description":"Input box color. Hex color code such as: #ffffff."},"inputBoxOpacity":{"type":"integer","description":"Input box opacity, should be within the range of 0–100.","format":"int32"},"inputTextColor":{"pattern":"^#[0-9A-Fa-f]{6}$","type":"string","description":"Input text color. Hex color code such as: #ffffff."},"inputTextOpacity":{"type":"integer","description":"Input text opacity, should be within the range of 0–100.","format":"int32"},"buttonColor":{"pattern":"^#[0-9A-Fa-f]{6}$","type":"string","description":"Button color. Hex color code such as: #ffffff."},"buttonOpacity":{"type":"integer","description":"Button opacity, should be within the range of 0–100.","format":"int32"},"buttonTextColor":{"pattern":"^#[0-9A-Fa-f]{6}$","type":"string","description":"Button text color. Hex color code such as: #ffffff."},"buttonTextOpacity":{"type":"integer","description":"Button text opacity, should be within the range of 0–100.","format":"int32"},"buttonText":{"pattern":"^[^ ]$|^[^ ].{0,30}[^ ]$","type":"string","description":"Button text, should contain 0 to 32 characters, default value is \"Log In\"."},"formAuthButtonText":{"pattern":"^[^ ]$|^[^ ].{0,30}[^ ]$","type":"string","description":"Form auth button text, should contain 0 to 32 characters, required when [authType] is 11 and hotspot [enabledTypes] contains 12.Default value is \"Take the Survey\"."},"welcomeEnable":{"type":"boolean","description":"Whether to display the welcome info"},"welcomeInformation":{"pattern":"^.{1,256}$","type":"string","description":"Welcome Information, should contain 1 to 31 characters."},"welcomeTextColor":{"pattern":"^#[0-9A-Fa-f]{6}$","type":"string","description":"Welcome text color. Hex color code such as: #ffffff."},"welcomeTextOpacity":{"type":"integer","description":"Welcome text opacity, should be within the range of 0–100.","format":"int32"},"welcomeTextFontSize":{"type":"integer","description":"Welcome text font size, should be within the range of 12–18.","format":"int32"},"termsOfServiceEnable":{"type":"boolean","description":"Whether to display terms of service."},"termsOfServiceText":{"type":"string","description":"Terms of service text, should contain 0 to 512 characters."},"termsOfServiceFontSize":{"type":"integer","description":"Terms of service text font size, should be within the range of 12–18.","format":"int32"},"termsOfServiceUrlTexts":{"maxItems":3,"minItems":0,"type":"array","description":"Terms of service url texts, match the termsOfServiceText and turn the matching characters into an openable link, Up to 3 entries are allowed for the list.","items":{"$ref":"#/components/schemas/TermsOfServiceUrlVO"}},"copyrightEnable":{"type":"boolean","description":"Whether to dispaly the copyright."},"copyright":{"type":"string","description":"Copyright text, should contain 0 to 200 characters."},"copyrightTextColor":{"pattern":"^#[0-9A-Fa-f]{6}$","type":"string","description":"Copyright text color. Hex color code such as: #ffffff."},"copyrightTextOpacity":{"type":"integer","description":"Copyright text opacity, should be within the range of 0–100.","format":"int32"},"copyrightTextFontSize":{"type":"integer","description":"Copyright text font size, should be within the range of 12–18.","format":"int32"},"redirectionCountDownEnable":{"type":"boolean","description":"Whether to show redirection countdown after authorized."},"advertisement":{"$ref":"#/components/schemas/AdvertisementSetting"},"bgPicCoordinatesOfLibrary":{"$ref":"#/components/schemas/BgPicCoordinatesOfLibraryOpenApiVO"},"mobileBgPicCoordinatesOfLibrary":{"$ref":"#/components/schemas/BgPicCoordinatesOfLibraryOpenApiVO"},"bodyContainerEnable":{"type":"boolean","description":"Whether to enable body container."},"termsOfServiceTextColor":{"type":"string","description":"Terms of service text color. Hex color code such as: #ffffff."},"termsOfServiceTextOpacity":{"type":"integer","description":"Terms of service text opacity, should be within the range of 0–100.","format":"int32"},"bodyContainerType":{"type":"integer","description":"Type of body container, 0: none; 1: half; 2: all","format":"int32"},"bodyContainerColor":{"pattern":"^#[0-9A-Fa-f]{6}$","type":"string","description":"Body container color. Hex color code such as: #ffffff."},"bodyContainerOpacity":{"type":"integer","description":"Body container opacity, should be within the range of 0–100.","format":"int32"},"bodyContainerRadius":{"type":"integer","description":"Body container radius, should be within the range of 0–30.","format":"int32"},"bodyContainerBgBlurEnable":{"type":"boolean","description":"Whether to enable body container background blur."},"bodyContainerBgBlur":{"type":"integer","description":"Body container background blurriness, should be within the range of 0–10.","format":"int32"},"inputBoxRadius":{"type":"integer","description":"Input box radius, should be within the range of 0–30.","format":"int32"},"inputBoxBorderColor":{"pattern":"^#[0-9A-Fa-f]{6}$","type":"string","description":"Input box border color. Hex color code such as: #ffffff."},"inputBoxBorderOpacity":{"type":"integer","description":"Input box border opacity, should be within the range of 0–100.","format":"int32"},"backgroundMaskEnable":{"type":"boolean","description":"Whether to enable multiple language."},"backgroundMaskColor":{"pattern":"^#[0-9A-Fa-f]{6}$","type":"string","description":"Background mask color. Hex color code such as: #ffffff."},"backgroundMaskOpacity":{"type":"integer","description":"Background mask opacity, should be within the range of 0–100.","format":"int32"},"buttonRadius":{"type":"integer","description":"Button radius, should be within the range of 0–30.","format":"int32"},"logoHorizontalPosition":{"type":"integer","description":"Position of logo horizontal, 0: left; 1: medium; 2: right","format":"int32"},"descriptionText":{"type":"string","description":"Description text, should contain 0 to 256 characters."},"descriptionTextColor":{"pattern":"^#[0-9A-Fa-f]{6}$","type":"string","description":"Description text color. Hex color code such as: #ffffff."},"descriptionTextOpacity":{"type":"integer","description":"Description text opacity, should be within the range of 0–100.","format":"int32"},"descriptionTextFontSize":{"type":"integer","description":"Description text font size, should be within the range of 12–18.","format":"int32"},"backgroundPictureIndex":{"type":"integer","description":"Index of library background picture, should be within the range of 0-5.","format":"int32"},"pcAlign":{"type":"integer","description":"Position of pc align, 0: left; 1: medium; 2: right","format":"int32"},"enableDeviceSpecificBg":{"type":"boolean","description":"Whether to use different images in mobile and PC devices"},"languageSelectorTextColor":{"pattern":"^#[0-9A-Fa-f]{6}$","type":"string","description":"Language Selector text color. Hex color code such as: #ffffff."},"languageSelectorTextOpacity":{"type":"integer","description":"Language Selector text opacity, should be within the range of 0–100.","format":"int32"}},"description":"Portal Customize, required when parameter [pageType] is 1 or null"},"PortalSetting":{"required":["authTimeout","authType","enable","httpsRedirectEnable","landingPage","name"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Portal Name, should contain 1 to 128 characters"},"enable":{"type":"boolean","description":"Portal Enable"},"ssidList":{"type":"array","description":"SSID ID list bound with this Portal. SSID can be created using 'Create new SSID' ('Create new SSID template') interface, and SSID ID can be obtained from 'Get SSID list' ('Get SSID template list') interface","items":{"type":"string","description":"SSID ID list bound with this Portal. SSID can be created using 'Create new SSID' ('Create new SSID template') interface, and SSID ID can be obtained from 'Get SSID list' ('Get SSID template list') interface"}},"networkList":{"type":"array","description":"Lan network ID list bound with this Portal. LAN Network can be created using 'Create LAN network' ('Create LAN network template') interface, and LAN Network ID can be obtained from 'Get LAN network list' ('Get LAN network template list') interface","items":{"type":"string","description":"Lan network ID list bound with this Portal. LAN Network can be created using 'Create LAN network' ('Create LAN network template') interface, and LAN Network ID can be obtained from 'Get LAN network list' ('Get LAN network template list') interface"}},"authType":{"type":"integer","description":"Auth Type, should be a value as follows: <br/>0：No Authentication; 1：Simple Password;<br/>2: External RADIUS Server; 4：External Portal Server;<br/>11：Hotspot; 15: Ldap; 16: Social Login","format":"int32"},"authTimeout":{"$ref":"#/components/schemas/AuthTimeoutSetting"},"httpsRedirectEnable":{"type":"boolean","description":"With this option enabled, unauthenticated clients will be redirected to the Portal page when they are trying to browse HTTPS websites."},"landingPage":{"type":"integer","description":"LandingPage enum: 1: Redirect to the original URL, 2: Redirect to Promotional URL, 3: Redirect to Logout Page. <br/>With The Original URL selected, clients are directed to the URL they request for after they pass Portal authentication. <br/>With The Promotional URL selected, clients are directed to the specified URL here after they pass Portal authentication. <br/>With The Logout Page selected, clients are directed to the Portal Logout Page after they pass Portal authentication. ","format":"int32"},"landingUrlScheme":{"pattern":"http|https","type":"string","description":"If Parameter [landingPage] is 2(Redirect to Promotional URL),this Parameter is requested, content is http or https."},"landingUrl":{"pattern":"^(([-a-zA-Z0-9@:%._+~#=]{2,256}\\.[a-z]{2,63})|((?!255\\.255\\.255\\.255)((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\.)){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)))((:([1-9]|[1-9]\\d|[1-9]\\d{2}|[1-9]\\d{3}|[1-5]\\d{4}|6[0-4]\\d{3}|65[0-4]\\d{2}|655[0-2]\\d|6553[0-5]))?)(/([-a-zA-Z0-9@:%_+.~#?&//=]*))?$","type":"string","description":"If Parameter [landingPage] is 2(Redirect to Promotional URL),this Parameter is requested."},"noAuth":{"$ref":"#/components/schemas/NoAuthSetting"},"simplePassword":{"$ref":"#/components/schemas/SimplePasswordSetting"},"hotspot":{"$ref":"#/components/schemas/HotspotSetting"},"socialLogin":{"$ref":"#/components/schemas/SocialLoginSettingOpenApiVO"},"google":{"$ref":"#/components/schemas/GoogleOAuthSettingOpenApiVO"},"sms":{"$ref":"#/components/schemas/SmsSetting"},"portalFormId":{"type":"string","description":"Portal form ID, required when [authType] is 11 and hotspot [enabledTypes] contains 12."},"hotspotRadius":{"$ref":"#/components/schemas/HotspotRadiusSetting"},"externalPortal":{"$ref":"#/components/schemas/ExternalServerPortalSetting"},"externalRadius":{"$ref":"#/components/schemas/ExternalRadiusSetting"},"ldap":{"$ref":"#/components/schemas/LdapSetting"},"pageType":{"type":"integer","description":"Page type, should be a value as follows: 1: Use default page, 2: use uploaded page. When [pageType] is null, it defaults to 1","format":"int32"},"importedPortalPage":{"$ref":"#/components/schemas/ImportedPortalPageOpenApiVO"},"portalCustomize":{"$ref":"#/components/schemas/PortalCustomizeOpenApiVO"}},"description":"Portal Setting."},"SimplePasswordSetting":{"required":["password"],"type":"object","properties":{"password":{"pattern":"^.{1,128}$","type":"string","description":"Auth password, should contain 1 to 128 characters."}},"description":"Simple Password Portal Setting."},"SmsSetting":{"required":["authTimeout","authToken","phoneNum","sid","userLimitEnable"],"type":"object","properties":{"sid":{"type":"string","description":"Twilio SID"},"authToken":{"type":"string","description":"Twilio auth token"},"phoneNum":{"pattern":"\\+?\\d{6,}","type":"string","description":"Twilio phone number. String value, should contain at least 6 digits such as \"+123456\"."},"userLimitEnable":{"type":"boolean","description":"Whether to control the limit of authentication for the same phone number."},"userLimit":{"type":"integer","description":"User limit with the same phone number, should be within the range of 1–10. Required when parameter [userLimitEnable] is true.","format":"int32"},"authTimeout":{"$ref":"#/components/schemas/AuthTimeoutSetting"},"countryCode":{"pattern":"^$|^\\+(93|374|994|973|880|975|673|855|86|670|995|852|91|62|98|964|972|81|962|850|82|965|996|856|961|853|60|960|976|95|977|968|92|970|63|974|7|966|65|94|963|886|992|66|90|90|993|971|998|84|967|355|376|43|375|32|387|359|3491|385|357|420|45|372|298|358|33|49|350|30|36|354|353|39|371|423|370|352|389|356|373|377|382|31|47|48|351|40|378|381|421|386|34|46|41|380|44|379|213|244|229|267|226|257|237|3491|238|236|235|269|242|243|253|20|240|291|251|241|220|233|224|245|225|254|266|231|218|261|265|223|222|230|212|258|264|227|234|262|250|239|221|248|232|252|27|211|34|249|268|255|228|216|256|260|263|1684|61|682|679|689|1671|692|691|687|64|1670|680|675|685|677|676|688|678|1684|1264|1268|297|247|1|1246|501|1441|1|1345|506|53|1767|1809|1809201|503|299|1473|590|1671|502|509|504|1876|596|52|1664|599|505|1670|507|1787|1869|1758|508|1784|1868|1649|1|1284|1340|54|591|55|56|57|593|500|594|592|595|51|597|598|58|383)$","type":"string","description":"Preset Contry code. String value such as \"+86\"."}},"description":"Sms Portal Setting."},"SocialLoginSettingOpenApiVO":{"required":["enabledTypes"],"type":"object","properties":{"enabledTypes":{"type":"array","description":"Social login enabled types, should be a value as follows: 17: Google.","items":{"type":"integer","description":"Social login enabled types, should be a value as follows: 17: Google.","format":"int32"}}},"description":"Social login setting, required when Parameter[authType] is 16. Should be a value as follows:<br/>17: Google"},"TermsOfServiceUrlVO":{"required":["content","text"],"type":"object","properties":{"content":{"type":"string","description":"Terms of service URL content."},"text":{"pattern":"^.{1,100}$","type":"string","description":"Terms of service URL title."},"index":{"type":"integer","description":"Index of hyperlink position.","format":"int32"}},"description":"Terms of service url texts, match the termsOfServiceText and turn the matching characters into an openable link, Up to 3 entries are allowed for the list."},"OperationResponsePortal Picture Info":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Portal Picture Info"}}},"Portal Picture Info":{"type":"object","properties":{"id":{"type":"string","description":"Portal picture ID"},"fileName":{"type":"string","description":"File name"},"url":{"type":"string","description":"File URL"}}},"ImportedPortalPageResOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Imported portal page file ID"},"fileName":{"type":"string","description":"Imported portal page file name"}}},"OperationResponseImportedPortalPageResOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ImportedPortalPageResOpenApiVO"}}},"SelectPortBindingVO":{"required":["assignIpDeviceType","vlanType"],"type":"object","properties":{"portIsolationEnable":{"type":"boolean","description":"Enable Port Isolation, only valid when creating network."},"flowControlEnable":{"type":"boolean","description":"Enable Flow Control, only valid when creating network."},"tagIds":{"uniqueItems":true,"type":"array","description":"Tag ID List","items":{"type":"string","description":"Tag ID List"}},"deviceList":{"type":"array","description":"Device List","items":{"$ref":"#/components/schemas/PortBindingVO"}},"internetPorts":{"type":"array","description":"Internet Ports","items":{"type":"string","description":"Internet Ports"}},"vlanType":{"type":"integer","description":"Network type, It should be a value as follows : 0:single vlan 1:multi vlan","format":"int32"},"vlan":{"type":"integer","description":"vlan, only valid when vlanType is 0 (single vlan)","format":"int32"},"vlans":{"type":"string","description":"vlans, only valid when vlanType is 1 (multi vlan). VLAN format: 200, 1-100."},"assignIpDeviceType":{"type":"integer","description":"Assign Ip Device Type. It should be a value as follows: 1: gateway 2: switch 0: third-party","format":"int32"},"assignIpDeviceMac":{"type":"string","description":"Assign Ip Device Mac."},"assignIpStackId":{"type":"string","description":"Assign Ip Stack Id, only valid when assigned ip device is a stack."}}},"OperationResponseListString":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"type":"string"}}}},"DhcpIpVO":{"type":"object","properties":{"ip":{"type":"string","description":"DHCP Server IP, like 192.168.0.1."},"netmask":{"type":"string","description":"Parameter [netmask] should not within the range of 1-30"}},"description":"The dhcp ip and mask info obtained from device."},"DhcpSettingInfo":{"type":"object","properties":{"enable":{"type":"boolean","description":"When value is true, DHCP server is enabled"},"ipRangePool":{"type":"array","description":"The list of DHCP Range, which size can't be more than \"dhcpRangePoolSize\", \"dhcpRangePoolSize\" can be obtained from 'Get LAN network list' interface.","items":{"$ref":"#/components/schemas/DhcpRangeOpenApiVO"}},"ipRangeStart":{"type":"integer","description":"The specific format value of Gateway Subnet start IP","format":"int64"},"ipRangeEnd":{"type":"integer","description":"The specific format value of Gateway Subnet End IP","format":"int64"},"dhcpns":{"type":"string","description":"Setup DHCP server: \"auto\" or \"manual\""},"priDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"When DHCPs are \"manual\", primary DNS Server."},"sndDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"When DHCPs are \"manual\", second DNS Server."},"leasetime":{"type":"integer","description":"Leasetime should be within the range of 2-10080","format":"int32"},"gateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Manual Setup of DHCP Gateway IP"},"dhcpNextServer":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The dhcpNextServer should be valid IP address, which is used in optional set next DHCP server."},"dhcpPoolMask":{"type":"integer","format":"int32"},"options":{"type":"array","description":"User custom DHCP options","items":{"$ref":"#/components/schemas/custom DHCP Options"}}},"description":"Configure DHCP settings"},"LanNetworkQueryOpenApiV3VO":{"required":["deviceType","igmpSnoopEnable","name","purpose"],"type":"object","properties":{"id":{"type":"string","description":"LAN network ID"},"site":{"type":"string","description":"Site ID"},"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"LAN network name should contain 1 to 128 characters."},"purpose":{"type":"integer","description":"LAN network purpose should be a value as follows: 0: VLAN; 1: interface","format":"int32"},"interfaceIds":{"type":"array","description":"Gateway LAN port IDs (acquired from \"Check WAN/LAN status\")","items":{"type":"string","description":"Gateway LAN port IDs (acquired from \"Check WAN/LAN status\")"}},"vlanType":{"type":"integer","description":"When purpose is interface, VLANType should be a value as follows: 0: Single; 1: Multiple","format":"int32"},"vlans":{"pattern":"^[\\d|\\d-\\d]+(,[\\d|\\d-\\d]+)*$","type":"string","description":"When purpose is interface and VLANType is 1, batch create VLANs. VLAN format: 200, 1-100."},"application":{"type":"integer","description":"Effective device type should be a value as follows: 0: Gateway and Switch; 1: Switch","format":"int32"},"isolation":{"type":"boolean","description":"Whether network isolated."},"vlan":{"type":"integer","description":"Only Valid when vlanType is 0. Vlan should be within the range of 1-4094.","format":"int32"},"gatewaySubnet":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])/(\\d|((1|2)\\d)|(30))\\b","type":"string","description":"When purpose is interface, gateway subnet is needed. Format: IP/Mask"},"dhcpSettings":{"$ref":"#/components/schemas/DhcpSettingInfo"},"domain":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"The domain of this network"},"igmpSnoopEnable":{"type":"boolean","description":"Enable IGMP snooping"},"fastLeaveEnable":{"type":"boolean","description":"IGMP Snooping fast leave enable status"},"mldSnoopEnable":{"type":"boolean","description":"Enable MLD snooping"},"dhcpv6Guard":{"$ref":"#/components/schemas/Dhcpv6 Servers setting"},"dhcpL2RelayEnable":{"type":"boolean","description":"The switch of DHCP L2 relay"},"dhcpGuard":{"$ref":"#/components/schemas/Dhcp Servers setting"},"portal":{"type":"boolean","description":"Show portal is enabled or not"},"portalId":{"type":"string","description":"Show portal ID"},"portalName":{"type":"string","description":"Show related portal name"},"accessControlRule":{"type":"boolean","description":"Show AccessControlRule is enabled or not"},"rateLimit":{"type":"boolean","description":"Show RateLimit is enabled or not"},"lanNeworkIpv6Config":{"$ref":"#/components/schemas/Lan network IPV6 config"},"allLan":{"type":"boolean","description":"When Internet pre-config is closed or Internet pre-config is Universal, allLAN is \"true\"; after adopting gateway, allLAN is \"false\"."},"resource":{"type":"integer","description":"Resource is a value as follows: 0: new created; 1: from template; 2: override","format":"int32"},"origName":{"type":"string","description":"Original name"},"arpDetectionEnable":{"type":"boolean","description":"Enable arp detection. Only valid when deviceType is 1 and gateway supports this feature."},"qosQueueEnable":{"type":"boolean","description":"The switch of QoS queue."},"queueId":{"type":"integer","description":"QoS queue Id.","format":"int32"},"existMultiVlan":{"type":"boolean","description":"Whether VLAN Type is Multiple."},"existRA":{"type":"boolean","description":"Whether RA has been configured."},"existCustomDhcpOption":{"type":"boolean","description":"Whether custom DHCP Options has been configured."},"existDhcpNextServer":{"type":"boolean","description":"Whether DHCP Next Server has been configured."},"existArpDetection":{"type":"boolean","description":"Whether Arp Detection is configured."},"existNetworkIsolation":{"type":"boolean","description":"Whether Network Isolation is configured."},"deviceType":{"type":"integer","description":"DHCP Server Device type. It should be a value as follows: 0:External Device 1:gateway 2:switch 3:none","format":"int32"},"deviceMac":{"type":"string","description":"DHCP Server Device mac. Only valid when deviceType is 1 or 2. When deviceType is 1, deviceMac can be empty when there is no gateway in the site."},"stackId":{"type":"string","description":"DHCP Server Device stackId. Only valid when deviceType is 2 and the selected device is stack"},"ip":{"$ref":"#/components/schemas/OswIpSettingBriefOpenapiVO"},"mode":{"type":"integer","description":"DHCP mode. 0: None 1: DHCP Server 2: DHCP Relay. Only valid when deviceType is 2.","format":"int32"},"vrfId":{"type":"string","description":"VRF ID"},"dhcpServer":{"$ref":"#/components/schemas/OswDhcpServerOpenApiVO"},"dhcpRelay":{"$ref":"#/components/schemas/OswDhcpRelayOpenApiVO"},"dhcpIp":{"$ref":"#/components/schemas/DhcpIpVO"},"state":{"type":"integer","description":"Network delivering state. It should be a value as follows: 0: not in delivering 1:delivering 2. deliver done","format":"int32"},"totalIpNum":{"type":"integer","description":"Total ip num","format":"int64"},"dhcpServerNum":{"type":"integer","description":"The number of dhcp server devices in effect, Only valid when vlanType is 0.","format":"int32"},"subnetOverrideEnable":{"type":"boolean","description":"Subnet override enable status"},"subnetOverride":{"type":"boolean","description":"Subnet override"},"primary":{"type":"boolean","description":"Primary"}},"description":"LANNetworkQueryOpenApiVO"},"OperationResponseLanNetworkQueryOpenApiV3VO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/LanNetworkQueryOpenApiV3VO"}}},"SelectMacsWithVlanVO":{"required":["macs","vlanType"],"type":"object","properties":{"macs":{"type":"array","description":"Device mac list for Site Setting or device template ID list for Site Template Setting","items":{"type":"string","description":"Device mac list for Site Setting or device template ID list for Site Template Setting"}},"vlanType":{"type":"integer","description":"Network type, It should be a value as follows : 0:single vlan 1:multi vlan","format":"int32"},"vlan":{"type":"integer","description":"vlan, only valid when vlanType is 0 (single vlan)","format":"int32"},"vlans":{"type":"string","description":"vlans, only valid when vlanType is 1 (multi vlan). VLAN format: 200, 1-100."}}},"DeviceBriefVO":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"mac":{"type":"string","description":"Mac"},"model":{"type":"string","description":"Model"},"modelVersion":{"type":"string","description":"Model version"},"type":{"type":"string","description":"Type"},"statusCategory":{"type":"integer","description":"Device status category, 0: Disconnected, 1: Connected, 2: Pending,3: Heartbeat Missed, 4: Isolated","format":"int32"},"ip":{"type":"string","description":"IP"},"isClient":{"type":"boolean","description":"It indicates whether the device is client."},"deviceType":{"type":"string","description":"Only valid when the device is client. It indicates the device type."}},"description":"The upper device of the port"},"OperationResponseListSelectDeviceForVlanTemplateVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/SelectDeviceForVlanTemplateVO"}}}},"SelectDeviceForVlanTemplateVO":{"type":"object","properties":{"name":{"type":"string","description":"Device Name."},"mac":{"type":"string","description":"Device mac for Site Setting or Device template ID for Site Template Setting"},"mode":{"type":"string","description":"Device Model."},"modelVersion":{"type":"string","description":"Device Model Version."},"type":{"type":"string","description":"Device type should be a value as follows: 1:gateway;  2:switch"},"compatible":{"type":"integer","description":"Device firmware and controller compatibility type.Compatible should be a value as follows: 0:COMPATIBLE; 1:HIGH_MAJOR_VER; 2:LOW_MAJOR_VER; 3:HIGH_MINOR_VER; 4:LOW_MINOR_VER; 7:HIGH_COMPONENT_VER; 10:DEVICE_NOT_COMPATIBLE; 11:HIGH_ADOPT_COMMPONENT; 12:DEVICE_CATEGORY_NOT_COMPATIBLE; 14:DEVICE_NOT_COMPATIBLE_IN_CLUSTER","format":"int32"},"ports":{"type":"array","description":"Device Ports","items":{"$ref":"#/components/schemas/SelectPortForVlanVO"}},"lags":{"type":"array","description":"Switch Lags, only valid when type is 2.","items":{"$ref":"#/components/schemas/SelectLagForVlanVO"}},"addedInAdvanced":{"type":"boolean","description":"Whether the device is added in advanced."}}},"SelectLagForVlanVO":{"type":"object","properties":{"name":{"type":"string","description":"Name."},"Enable":{"type":"boolean","description":"Whether the port is affected."},"selectByUser":{"type":"boolean","description":"Whether the port is selected by user."},"unSelectByUser":{"type":"boolean","description":"Whether the auto-select port is unselected by user."},"defaultVlan":{"type":"integer","description":"The vlan of default network.","format":"int32"},"editEnable":{"type":"boolean","description":"Whether the port is selectable."},"needConfirm":{"type":"boolean","description":"Whether the port needs confirm for binding non-default vlan."},"needConfirmCascadePort":{"type":"boolean","description":"Whether the port needs confirm for being cascade port."},"controllerLinkedPort":{"type":"boolean","description":"Whether the port is connected to the Controller."},"autoSelect":{"type":"boolean","description":"Whether the port needs to be automatically selected."},"reasons":{"type":"array","description":"Only valid when editEnable is false. It indicates the reason why the port is not selectable.Each Item should be a value as follows: -2: The port has been added to LAG. Lag member port can not be selected; -8: The port is wan port. Wan port can not be selected; -10: The AP’s LAN port cannot be configured; -12: The port's tags setting is not custom and therefore it can not be selected when creating multi vlan; -13: The port is stack port. Stack port can not be selected; -14: The number of VLANs has reached the limit of the Easy Managed Switch.","items":{"type":"integer","description":"Only valid when editEnable is false. It indicates the reason why the port is not selectable.Each Item should be a value as follows: -2: The port has been added to LAG. Lag member port can not be selected; -8: The port is wan port. Wan port can not be selected; -10: The AP’s LAN port cannot be configured; -12: The port's tags setting is not custom and therefore it can not be selected when creating multi vlan; -13: The port is stack port. Stack port can not be selected; -14: The number of VLANs has reached the limit of the Easy Managed Switch.","format":"int32"}},"downlinkDevices":{"type":"array","description":"The downlink devices of the port","items":{"$ref":"#/components/schemas/DeviceBriefVO"}},"upperDevice":{"$ref":"#/components/schemas/DeviceBriefVO"},"nativeIsDefault":{"type":"boolean","description":"It indicates whether the native network of the port is default."},"nativeNetworkVlan":{"type":"integer","description":"The native network vlan of the port.","format":"int32"},"nativeNetworkName":{"type":"string","description":"The native network name of the port."},"oswPortNetworkTagsSetting":{"type":"integer","description":"The port network tag setting. 0:allow all, 1:block all, 2:custom","format":"int32"},"needConfirmVoiceNetwork":{"type":"boolean","description":"When creating single vlan and the port's voice network is enabled, needConfirmVoiceNetwork is true."},"id":{"type":"integer","description":"Lag ID","format":"int32"},"ports":{"type":"array","description":"The ports in the lag. Each item is Integer, for example: [1, 2].","items":{"type":"integer","description":"The ports in the lag. Each item is Integer, for example: [1, 2].","format":"int32"}},"stPorts":{"type":"array","description":"The ports in the lag. Each item is String, for example: [\"1/0/1\", \"1/0/2\"].","items":{"type":"string","description":"The ports in the lag. Each item is String, for example: [\"1/0/1\", \"1/0/2\"]."}},"mlagEnable":{"type":"boolean","description":"Indicates whether M-LAG port is enabled"}},"description":"Switch Lags, only valid when type is 2."},"SelectPortForVlanVO":{"type":"object","properties":{"name":{"type":"string","description":"Name."},"Enable":{"type":"boolean","description":"Whether the port is affected."},"selectByUser":{"type":"boolean","description":"Whether the port is selected by user."},"unSelectByUser":{"type":"boolean","description":"Whether the auto-select port is unselected by user."},"defaultVlan":{"type":"integer","description":"The vlan of default network.","format":"int32"},"editEnable":{"type":"boolean","description":"Whether the port is selectable."},"needConfirm":{"type":"boolean","description":"Whether the port needs confirm for binding non-default vlan."},"needConfirmCascadePort":{"type":"boolean","description":"Whether the port needs confirm for being cascade port."},"controllerLinkedPort":{"type":"boolean","description":"Whether the port is connected to the Controller."},"autoSelect":{"type":"boolean","description":"Whether the port needs to be automatically selected."},"reasons":{"type":"array","description":"Only valid when editEnable is false. It indicates the reason why the port is not selectable.Each Item should be a value as follows: -2: The port has been added to LAG. Lag member port can not be selected; -8: The port is wan port. Wan port can not be selected; -10: The AP’s LAN port cannot be configured; -12: The port's tags setting is not custom and therefore it can not be selected when creating multi vlan; -13: The port is stack port. Stack port can not be selected; -14: The number of VLANs has reached the limit of the Easy Managed Switch.","items":{"type":"integer","description":"Only valid when editEnable is false. It indicates the reason why the port is not selectable.Each Item should be a value as follows: -2: The port has been added to LAG. Lag member port can not be selected; -8: The port is wan port. Wan port can not be selected; -10: The AP’s LAN port cannot be configured; -12: The port's tags setting is not custom and therefore it can not be selected when creating multi vlan; -13: The port is stack port. Stack port can not be selected; -14: The number of VLANs has reached the limit of the Easy Managed Switch.","format":"int32"}},"downlinkDevices":{"type":"array","description":"The downlink devices of the port","items":{"$ref":"#/components/schemas/DeviceBriefVO"}},"upperDevice":{"$ref":"#/components/schemas/DeviceBriefVO"},"nativeIsDefault":{"type":"boolean","description":"It indicates whether the native network of the port is default."},"nativeNetworkVlan":{"type":"integer","description":"The native network vlan of the port.","format":"int32"},"nativeNetworkName":{"type":"string","description":"The native network name of the port."},"oswPortNetworkTagsSetting":{"type":"integer","description":"The port network tag setting. 0:allow all, 1:block all, 2:custom","format":"int32"},"needConfirmVoiceNetwork":{"type":"boolean","description":"When creating single vlan and the port's voice network is enabled, needConfirmVoiceNetwork is true."},"portId":{"type":"string","description":"ID, for example: \"1/0/1\" (for switch port), \"3_e3f176e1c95a49849477636c43a49d3f\" (for gateway port)."},"id":{"type":"integer","description":"port number, for example: 1","format":"int32"},"type":{"type":"integer","description":"Type. 1: Copper, 2: Combo, 3: SFP","format":"int32"},"mode":{"type":"integer","description":"Mode, 0:WAN,1:LAN;","format":"int32"},"configMlagDad":{"type":"boolean","description":"Whether the port is configured as a mlag dad port."},"configMlagPeerLink":{"type":"boolean","description":"Whether the port is configured as a mlag peer-link port."},"lagId":{"type":"integer","description":"Lag ID. It indicates the lag id of the port when the port is in a lag.","format":"int32"},"isCopper":{"type":"boolean","description":"Whether the port is copper when the port is combo."}},"description":"Device Ports"},"OperationResponseVlanPreConfigOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VlanPreConfigOpenApiVO"}}},"SelectDeviceForVlanVO":{"type":"object","properties":{"name":{"type":"string","description":"Device Name."},"mac":{"type":"string","description":"Device Mac."},"mode":{"type":"string","description":"Device Model."},"modelVersion":{"type":"string","description":"Device Model Version."},"type":{"type":"string","description":"Device type, 1: gateway  2: switch"},"es":{"type":"boolean","description":"Whether the switch is Agile Series Switch"},"statusCategory":{"type":"integer","description":"Device status category, 0: Disconnected, 1: Connected, 2: Pending,3: Heartbeat Missed, 4: Isolated","format":"int32"},"compatible":{"type":"integer","description":"Device firmware and controller compatibility type.Compatible should be a value as follows: 0:COMPATIBLE;1:HIGH_MAJOR_VER;2:LOW_MAJOR_VER;3:HIGH_MINOR_VER;4:LOW_MINOR_VER;7:HIGH_COMPONENT_VER;10:DEVICE_NOT_COMPATIBLE;11:HIGH_ADOPT_COMMPONENT;12:DEVICE_CATEGORY_NOT_COMPATIBLE;14:DEVICE_NOT_COMPATIBLE_IN_CLUSTER","format":"int32"},"ports":{"type":"array","description":"Device Ports","items":{"$ref":"#/components/schemas/SelectPortForVlanVO"}},"lags":{"type":"array","description":"Switch Lags, only valid when type is 2.","items":{"$ref":"#/components/schemas/SelectLagForVlanVO"}},"addedInAdvanced":{"type":"boolean","description":"Whether the device is added in advanced."},"manuallySelect":{"type":"boolean","description":"Whether the device is manually selected."},"esAllowAllPortExceed":{"type":"boolean","description":"It indicates whether there exists allow all port of Agile Series Switch that can only use partly of currently creating vlans"},"replacedDevice":{"type":"boolean","description":"It indicates whether the switch is the dhcp server device that is replaced in the first step"},"mlagPeerDeviceMac":{"type":"string","description":"Mlag peer device mac, only valid when the device is in a mlag group."},"supportLayout":{"type":"boolean","description":"Whether the device supports reporting port layout information."}},"description":"Affected device list"},"SelectStackForVlanVO":{"type":"object","properties":{"stackId":{"type":"string","description":"Stack ID"},"stackName":{"type":"string","description":"Stack Name"},"masterMac":{"type":"string","description":"Master mac"},"status":{"type":"integer","description":"Stack Status should be a value as follows: 0: normal; 1: abnormal; 2: stack not ready","format":"int32"},"members":{"type":"array","description":"Stack Members","items":{"$ref":"#/components/schemas/SelectStackMemberForVlanVO"}},"lags":{"type":"array","description":"Lags","items":{"$ref":"#/components/schemas/SelectStackLagForVlanVO"}},"manuallySelect":{"type":"boolean","description":"Whether the stack is manually selected."},"replacedDevice":{"type":"boolean","description":"It indicates whether the stack is the dhcp server device that is replaced in the first step"}},"description":"Affected stack list"},"SelectStackLagForVlanVO":{"type":"object","properties":{"name":{"type":"string","description":"Name."},"Enable":{"type":"boolean","description":"Whether the port is affected."},"selectByUser":{"type":"boolean","description":"Whether the port is selected by user."},"unSelectByUser":{"type":"boolean","description":"Whether the auto-select port is unselected by user."},"defaultVlan":{"type":"integer","description":"The vlan of default network.","format":"int32"},"editEnable":{"type":"boolean","description":"Whether the port is selectable."},"needConfirm":{"type":"boolean","description":"Whether the port needs confirm for binding non-default vlan."},"needConfirmCascadePort":{"type":"boolean","description":"Whether the port needs confirm for being cascade port."},"controllerLinkedPort":{"type":"boolean","description":"Whether the port is connected to the Controller."},"autoSelect":{"type":"boolean","description":"Whether the port needs to be automatically selected."},"reasons":{"type":"array","description":"Only valid when editEnable is false. It indicates the reason why the port is not selectable.Each Item should be a value as follows: -2: The port has been added to LAG. Lag member port can not be selected; -8: The port is wan port. Wan port can not be selected; -10: The AP’s LAN port cannot be configured; -12: The port's tags setting is not custom and therefore it can not be selected when creating multi vlan; -13: The port is stack port. Stack port can not be selected; -14: The number of VLANs has reached the limit of the Easy Managed Switch.","items":{"type":"integer","description":"Only valid when editEnable is false. It indicates the reason why the port is not selectable.Each Item should be a value as follows: -2: The port has been added to LAG. Lag member port can not be selected; -8: The port is wan port. Wan port can not be selected; -10: The AP’s LAN port cannot be configured; -12: The port's tags setting is not custom and therefore it can not be selected when creating multi vlan; -13: The port is stack port. Stack port can not be selected; -14: The number of VLANs has reached the limit of the Easy Managed Switch.","format":"int32"}},"downlinkDevices":{"type":"array","description":"The downlink devices of the port","items":{"$ref":"#/components/schemas/DeviceBriefVO"}},"upperDevice":{"$ref":"#/components/schemas/DeviceBriefVO"},"nativeIsDefault":{"type":"boolean","description":"It indicates whether the native network of the port is default."},"nativeNetworkVlan":{"type":"integer","description":"The native network vlan of the port.","format":"int32"},"nativeNetworkName":{"type":"string","description":"The native network name of the port."},"oswPortNetworkTagsSetting":{"type":"integer","description":"The port network tag setting. 0:allow all, 1:block all, 2:custom","format":"int32"},"needConfirmVoiceNetwork":{"type":"boolean","description":"When creating single vlan and the port's voice network is enabled, needConfirmVoiceNetwork is true."},"id":{"type":"integer","description":"Lag ID","format":"int32"},"ports":{"type":"array","description":"The ports in the lag. Each item is Integer, for example: [1, 2].","items":{"type":"integer","description":"The ports in the lag. Each item is Integer, for example: [1, 2].","format":"int32"}},"stPorts":{"type":"array","description":"The ports in the lag. Each item is String, for example: [1/0/1, 1/0/2].","items":{"type":"string","description":"The ports in the lag. Each item is String, for example: [1/0/1, 1/0/2]."}}},"description":"Lags"},"SelectStackMemberForVlanVO":{"type":"object","properties":{"name":{"type":"string","description":"Device Name"},"mac":{"type":"string","description":"Device Mac"},"model":{"type":"string","description":"Device Model"},"modeVersion":{"type":"string","description":"Device Model Version"},"unit":{"type":"integer","description":"Stack member's unit","format":"int32"},"statusCategory":{"type":"integer","description":"Device status category, 0: Disconnected, 1: Connected, 2: Pending,3: Heartbeat Missed, 4: Isolated","format":"int32"},"compatible":{"type":"integer","description":"Device firmware and controller compatibility type.Compatible should be a value as follows: 0:COMPATIBLE;1:HIGH_MAJOR_VER;2:LOW_MAJOR_VER;3:HIGH_MINOR_VER;4:LOW_MINOR_VER;7:HIGH_COMPONENT_VER;10:DEVICE_NOT_COMPATIBLE;11:HIGH_ADOPT_COMMPONENT;12:DEVICE_CATEGORY_NOT_COMPATIBLE;14:DEVICE_NOT_COMPATIBLE_IN_CLUSTER","format":"int32"},"addedInAdvanced":{"type":"boolean","description":"Whether the device is added in advanced."},"ports":{"type":"array","description":"Ports","items":{"$ref":"#/components/schemas/SelectStackMemberPortForVlanVO"}}},"description":"Stack Members"},"SelectStackMemberPortForVlanVO":{"type":"object","properties":{"name":{"type":"string","description":"Name."},"Enable":{"type":"boolean","description":"Whether the port is affected."},"selectByUser":{"type":"boolean","description":"Whether the port is selected by user."},"unSelectByUser":{"type":"boolean","description":"Whether the auto-select port is unselected by user."},"defaultVlan":{"type":"integer","description":"The vlan of default network.","format":"int32"},"editEnable":{"type":"boolean","description":"Whether the port is selectable."},"needConfirm":{"type":"boolean","description":"Whether the port needs confirm for binding non-default vlan."},"needConfirmCascadePort":{"type":"boolean","description":"Whether the port needs confirm for being cascade port."},"controllerLinkedPort":{"type":"boolean","description":"Whether the port is connected to the Controller."},"autoSelect":{"type":"boolean","description":"Whether the port needs to be automatically selected."},"reasons":{"type":"array","description":"Only valid when editEnable is false. It indicates the reason why the port is not selectable.Each Item should be a value as follows: -2: The port has been added to LAG. Lag member port can not be selected; -8: The port is wan port. Wan port can not be selected; -10: The AP’s LAN port cannot be configured; -12: The port's tags setting is not custom and therefore it can not be selected when creating multi vlan; -13: The port is stack port. Stack port can not be selected; -14: The number of VLANs has reached the limit of the Easy Managed Switch.","items":{"type":"integer","description":"Only valid when editEnable is false. It indicates the reason why the port is not selectable.Each Item should be a value as follows: -2: The port has been added to LAG. Lag member port can not be selected; -8: The port is wan port. Wan port can not be selected; -10: The AP’s LAN port cannot be configured; -12: The port's tags setting is not custom and therefore it can not be selected when creating multi vlan; -13: The port is stack port. Stack port can not be selected; -14: The number of VLANs has reached the limit of the Easy Managed Switch.","format":"int32"}},"downlinkDevices":{"type":"array","description":"The downlink devices of the port","items":{"$ref":"#/components/schemas/DeviceBriefVO"}},"upperDevice":{"$ref":"#/components/schemas/DeviceBriefVO"},"nativeIsDefault":{"type":"boolean","description":"It indicates whether the native network of the port is default."},"nativeNetworkVlan":{"type":"integer","description":"The native network vlan of the port.","format":"int32"},"nativeNetworkName":{"type":"string","description":"The native network name of the port."},"oswPortNetworkTagsSetting":{"type":"integer","description":"The port network tag setting. 0:allow all, 1:block all, 2:custom","format":"int32"},"needConfirmVoiceNetwork":{"type":"boolean","description":"When creating single vlan and the port's voice network is enabled, needConfirmVoiceNetwork is true."},"portId":{"type":"string","description":"ID, for example: \"1/0/1\""},"id":{"type":"integer","description":"port number, for example: 1","format":"int32"},"type":{"type":"integer","description":"Type. 1: Copper, 2: Combo, 3: SFP","format":"int32"},"configStack":{"type":"boolean","description":"Whether the port is configured as a stack port."},"madEnable":{"type":"boolean"},"lagId":{"type":"integer","description":"Lag ID. It indicates the lag id of the port when the port is in a lag.","format":"int32"}},"description":"Ports"},"VlanPreConfigOpenApiVO":{"type":"object","properties":{"lanNetwork":{"$ref":"#/components/schemas/LanNetworkQueryOpenApiV3VO"},"affectedDeviceList":{"type":"array","description":"Affected device list","items":{"$ref":"#/components/schemas/SelectDeviceForVlanVO"}},"affectedStackList":{"type":"array","description":"Affected stack list","items":{"$ref":"#/components/schemas/SelectStackForVlanVO"}},"deviceConfig":{"$ref":"#/components/schemas/SelectPortBindingBriefVO"},"networkSegmentChanged":{"type":"boolean","description":"Indicate whether the network segment change when modifying network"},"totalAffectedDeviceNum":{"type":"integer","description":"Indicate total affected devices num, including devices with ports that have Network Tags Setting set to Allow all","format":"int32"}},"description":"VlanPreConfigOpenApiVO"},"AutoSelectDeviceForVlanVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device Mac"},"stackId":{"type":"string","description":"Stack Id, only valid when the device is stack."},"deletable":{"type":"boolean","description":"It indicates whether the device is deletable."},"confirmType":{"type":"integer","description":"It should be a value as follows: 1: need confirm when deleting gateway","format":"int32"}},"description":"Auto select device list."},"AutoSelectDevicesForVlanVO":{"type":"object","properties":{"deviceList":{"type":"array","description":"Auto select device list.","items":{"$ref":"#/components/schemas/AutoSelectDeviceForVlanVO"}}}},"OperationResponseAutoSelectDevicesForVlanVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AutoSelectDevicesForVlanVO"}}},"AutoEffectDeviceForVlanVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device Mac"},"stackId":{"type":"string","description":"Stack Id, only valid when the device is stack."},"dhcpMode":{"type":"integer","description":"It should be a value as follows, 0:None  1:DHCP Server 2:DHCP Relay","format":"int32"}},"description":"Auto effect device list."},"AutoEffectDevicesForVlanVO":{"type":"object","properties":{"deviceList":{"type":"array","description":"Auto effect device list.","items":{"$ref":"#/components/schemas/AutoEffectDeviceForVlanVO"}}}},"OperationResponseAutoEffectDevicesForVlanVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AutoEffectDevicesForVlanVO"}}},"CreateVlanParamOpenApiVO":{"required":["deviceConfig","lanNetwork"],"type":"object","properties":{"lanNetwork":{"$ref":"#/components/schemas/LanNetworkOpenApiV3VO"},"deviceConfig":{"$ref":"#/components/schemas/SelectPortBindingBriefVO"}},"description":"CreateVlanParamOpenApiVO"},"New IPS allow list entry":{"type":"object","properties":{"direction":{"type":"integer","description":"The location of the target that can trigger the threat, direction should be a value as follows:0: both 1: source, 2: destination.","format":"int32"},"trafficType":{"type":"integer","description":"Exempt the category of objects (targets) that can trigger the threat, trafficType should be a value as follows: 0: IP Address, 1: Network, 2: Subnet.","format":"int32"},"ipAddress":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The value of the trafficType is 0, indicating IP address."},"network":{"type":"string","description":"The value of the trafficType is 1, indicating LAN network ID."},"subnet":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])/([1-9]|((1|2)\\d)|(30|31|32))\\b","type":"string","description":"The value of the trafficType is 2, indicating subnet."}}},"BatchSyncSitesOpenApiVO":{"required":["siteIds"],"type":"object","properties":{"siteIds":{"uniqueItems":true,"type":"array","description":"Site IDs to sync with site template.","items":{"type":"string","description":"Site IDs to sync with site template."}}}},"MacFiltering":{"required":["filterMode","name","type"],"type":"object","properties":{"id":{"type":"string","description":"ID of the MAC filtering entity."},"name":{"type":"string","description":"Name of the MAC filtering entity."},"filterMode":{"type":"integer","description":"Filter mode should be a value as follows: 0: allow; 1: deny.","format":"int32"},"type":{"type":"integer","description":"Type should be a value as follows: 0: macAddresses; 1: macGroupIds.","format":"int32"},"macAddresses":{"type":"array","description":"MAC addresses of the MAC filtering entity.","items":{"$ref":"#/components/schemas/OsgMacFilterAddressOpenApiVO"}},"macGroupIds":{"type":"array","description":"MAC groups of the MAC filtering entity. MAC group can be created using 'Create a new group profile' interface, and MAC group ID can be obtained from 'Get group profile list' interface.","items":{"type":"string","description":"MAC groups of the MAC filtering entity. MAC group can be created using 'Create a new group profile' interface, and MAC group ID can be obtained from 'Get group profile list' interface."}}}},"OsgMacFilterAddressOpenApiVO":{"required":["macAddress"],"type":"object","properties":{"macAddress":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"MAC address of the MAC filtering address."},"name":{"type":"string","description":"Name of the MAC filtering address."}},"description":"MAC addresses of the MAC filtering entity."},"LanDnsOpenApiVO":{"required":["domain","enable","name","type"],"type":"object","properties":{"enable":{"type":"boolean","description":"off:false, on: true"},"name":{"maxLength":128,"minLength":1,"type":"string","description":"Name of Lan Dns Item"},"domain":{"pattern":"(?=^.{1,128}$)[a-zA-Z0-9][-a-zA-Z0-9]{0,62}(\\.[a-zA-Z0-9][-a-zA-Z0-9]{0,62})+","type":"string","description":"Enter the domain name."},"aliases":{"maxItems":7,"minItems":0,"type":"array","description":"If a server provides different services and has multiple domain names, you can configure them in the Alias Domain Name.","items":{"maxLength":7,"minLength":0,"type":"string","description":"If a server provides different services and has multiple domain names, you can configure them in the Alias Domain Name."}},"type":{"type":"integer","description":"There are three options, IP:0, CNAME:1, and FORWARD:2.","format":"int32"},"ipAddresses":{"maxItems":32,"minItems":0,"type":"array","description":"When the Type is IP, it is the IPv4 address of the returned DNS response.","items":{"maxLength":32,"minLength":0,"type":"string","description":"When the Type is IP, it is the IPv4 address of the returned DNS response."}},"ipv6Addresses":{"maxItems":32,"minItems":0,"type":"array","description":"When the Type is IP, it is the IPv6 address of the returned DNS response.","items":{"maxLength":32,"minLength":0,"type":"string","description":"When the Type is IP, it is the IPv6 address of the returned DNS response."}},"cname":{"pattern":"(?=^.{1,128}$)[a-zA-Z0-9][-a-zA-Z0-9]{0,62}(\\.[a-zA-Z0-9][-a-zA-Z0-9]{0,62})+","type":"string","description":"When Type is CNAME, set the domain name to which Domain Name and Alias Domain Name need to be mapped."},"dnsServers":{"maxItems":2,"minItems":0,"type":"array","description":"When the Type is FORWARD, set the Domain Name and Alias Domain Name to be forwarded to a specific DNS Server, up to two DNS Servers can be configured.","items":{"maxLength":2,"minLength":0,"type":"string","description":"When the Type is FORWARD, set the Domain Name and Alias Domain Name to be forwarded to a specific DNS Server, up to two DNS Servers can be configured."}},"lanNetworkIds":{"type":"array","description":"The ids of Lan Network. When the Type is IP or CNAME, it is the LAN network to which the rule applies.","items":{"type":"string","description":"The ids of Lan Network. When the Type is IP or CNAME, it is the LAN network to which the rule applies."}},"customTtl":{"type":"boolean","description":"When custom TTL is activated, TTL will take effect as custom value. Otherwise, TTL will take effect as default(3600)."},"ttl":{"type":"integer","description":"The amount of time DNS information is allowed to be cached. The range of TTL should be 1-86400. It is recommended to use the default TTL for each record.","format":"int32"}}},"Create VLANs":{"required":["igmpSnoopEnable","name","vlans"],"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"LAN network name should contain 1 to 128 characters."},"vlans":{"pattern":"^[\\d|\\d-\\d]+(,[\\d|\\d-\\d]+)*$","type":"string","description":"Support batch VLAN creation. VLAN format: 200, 1-100."},"igmpSnoopEnable":{"type":"boolean","description":"Enable IGMP snooping"},"dhcpL2RelayEnable":{"type":"boolean","description":"The switch of DHCP L2 relay"},"dhcpGuard":{"$ref":"#/components/schemas/Dhcp Servers setting"},"mldSnoopEnable":{"type":"boolean","description":"Enable MLD snooping"},"dhcpv6Guard":{"$ref":"#/components/schemas/Dhcpv6 Servers setting"},"application":{"type":"integer","description":"Effective device type should be a value as follows: 0: Gateway and Switch; 1: Switch","format":"int32"}}},"LanProfileConfigOpenApiVO":{"required":["bandWidthCtrlType","dot1x","lldpMedEnable","loopbackDetectEnable","name","nativeNetworkId","poe","portIsolationEnable","spanningTreeEnable"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Name should contain 1 to 128 characters."},"poe":{"type":"integer","description":"PoE should be a value as follows: 0: off, 1: on, 2: \"do not modify\"","format":"int32"},"nativeNetworkId":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Native network ID, Native Network cannot be selected from Tagged Networks or Untagged Networks."},"tagNetworkIds":{"type":"array","description":"Tag network IDs","items":{"type":"string","description":"Tag network IDs"}},"untagNetworkIds":{"type":"array","description":"Untag network IDs","items":{"type":"string","description":"Untag network IDs"}},"voiceNetworkId":{"type":"string","description":"Voice Network ID"},"dot1x":{"type":"integer","description":"Dot1x should be a value as follows: 0: force unauthorized, 1: force authorized, 2:auto","format":"int32"},"portIsolationEnable":{"type":"boolean","description":"Port-isolation enable status"},"lldpMedEnable":{"type":"boolean","description":"LLDP-MED enable status"},"bandWidthCtrlType":{"type":"integer","description":"BandWidthCtrlType should be a value as follows: 0: off, 1: rate limit, 2: storming control","format":"int32"},"stormCtrl":{"$ref":"#/components/schemas/StormCtrlVO"},"bandCtrl":{"$ref":"#/components/schemas/BandCtrlVO"},"spanningTreeEnable":{"type":"boolean","description":"SpanningTree enable status"},"spanningTreeSetting":{"$ref":"#/components/schemas/SpanningTreeSettingVO"},"loopbackDetectEnable":{"type":"boolean","description":"LoopbackDetect enable status"},"eeeEnable":{"type":"boolean","description":"EEE enable status"},"flowControlEnable":{"type":"boolean","description":"FlowControl enable status"},"loopbackDetectVlanBasedEnable":{"type":"boolean","description":"LoopbackDetectVLANBased enable status"},"igmpFastLeaveEnable":{"type":"boolean","description":"Indicates whether igmp fast leave is enabled"},"mldFastLeaveEnable":{"type":"boolean","description":"Indicates whether mld fast leave is enabled"},"dhcpL2RelaySettings":{"$ref":"#/components/schemas/DhcpL2RelayVO"},"fastLeaveEnable":{"type":"boolean","description":"IGMP Snooping fast leave enable status"},"dot1pPriority":{"type":"integer","description":"802.1p Priority","format":"int32"},"trustMode":{"type":"integer","description":"Trust mode","format":"int32"}}},"DhcpSettingsConfigTemplateOpenApiVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"When value is true, DHCP server is enabled"},"ipRangePool":{"type":"array","description":"The list of DHCP Range, which size can't be more than \"dhcpRangePoolSize\", \"dhcpRangePoolSize\" can be obtained from 'Get LAN network template list' interface.","items":{"$ref":"#/components/schemas/DhcpRangeOpenApiVO"}},"dhcpns":{"type":"string","description":"Setup DHCP server: \"auto\" or \"manual\""},"priDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"When DHCPs are \"manual\", primary DNS Server."},"sndDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"When DHCPs are \"manual\", second DNS Server."},"leasetime":{"type":"integer","description":"Leasetime should be within the range of 2-10080","format":"int32"},"gateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Manual Setup of DHCP Gateway IP"},"dhcpPoolMask":{"type":"integer","format":"int32"},"options":{"type":"array","description":"User custom DHCP options","items":{"$ref":"#/components/schemas/custom DHCP Options"}}},"description":"Configure DHCP settings"},"LanNetworkIpv6ConfigTemplateOpenApiVO":{"required":["enable","proto"],"type":"object","properties":{"proto":{"type":"integer","description":"The IPv6 Connection Type of LAN port. Proto should be a value as follows:  0: \"none\" (Default); 1: \"DHCPv6\"; 2: \"SLAAC+Stateless DHCP\"; 3: \"SLAAC+RDNSS\"; 4: \"passthrough\"","format":"int32"},"enable":{"type":"integer","description":"IPv6 enable should be a value as follows: 0: Disable (Default); 1: Enable","format":"int32"},"dhcpv6":{"$ref":"#/components/schemas/Dhcpv6 Setting"},"slaac":{"$ref":"#/components/schemas/SlaacTemplateOpenApiVO"},"rdnss":{"$ref":"#/components/schemas/SlaacTemplateOpenApiVO"},"ra":{"$ref":"#/components/schemas/Ra Setting"}},"description":"LAN network IPv6 config"},"LanNetworkTemplateOpenApiVO":{"required":["igmpSnoopEnable","name","purpose"],"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"LAN network name should contain 1 to 128 characters."},"purpose":{"type":"integer","description":"LAN network purpose should be a value as follows: 0: VLAN; 1: interface","format":"int32"},"interfaceIds":{"type":"array","description":"Gateway LAN port IDs, which are acquired from \"Check WAN/LAN status\"","items":{"type":"string","description":"Gateway LAN port IDs, which are acquired from \"Check WAN/LAN status\""}},"vlanType":{"type":"integer","description":"When purpose is interface, VLANType should be a value as follows: 0: Single; 1: Multiple","format":"int32"},"vlans":{"pattern":"^[\\d|\\d-\\d]+(,[\\d|\\d-\\d]+)*$","type":"string","description":"When purpose is \"interface\" and VLANType is 1, batch create VLANs. VLAN format: 200, 1-100."},"vlan":{"type":"integer","description":"Only Valid when vlanType is 0. Vlan should be within the range of 1-4094.","format":"int32"},"application":{"type":"integer","description":"Effective device type should be a value as follows: 0: Gateway and Switch; 1: Switch","format":"int32"},"gatewaySubnet":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])/(\\d|((1|2)\\d)|(30))\\b","type":"string","description":"When purpose is interface, gateway subnet is needed. Format: IP/Mask"},"dhcpSettingsVO":{"$ref":"#/components/schemas/DhcpSettingsConfigTemplateOpenApiVO"},"domain":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"The domain of this network"},"igmpSnoopEnable":{"type":"boolean","description":"Enable IGMP snooping"},"mldSnoopEnable":{"type":"boolean","description":"Enable MLD snooping"},"dhcpL2RelayEnable":{"type":"boolean","description":"The switch of DHCP L2 relay"},"dhcpGuard":{"$ref":"#/components/schemas/Dhcp Servers setting"},"dhcpv6Guard":{"$ref":"#/components/schemas/Dhcpv6 Servers setting"},"lanNeworkIpv6Config":{"$ref":"#/components/schemas/LanNetworkIpv6ConfigTemplateOpenApiVO"},"allLan":{"type":"boolean","description":"When Internet pre-config is closed or Internet pre-config is Universal, allLAN is \"true\"; after adopting gateway, allLAN is \"false\"."}},"description":"LANNetworkTemplateOpenApiVO"},"SlaacTemplateOpenApiVO":{"type":"object","properties":{"prefix":{"type":"string","description":"Address prefix"},"preId":{"type":"integer","description":"Prefix ID should be within the range of 0-127","format":"int32"},"dnsv6":{"type":"integer","description":"DHCP Name Server, should be a value as follows: 0: \"auto\"; 1: \"manual\"","format":"int32"},"priDns":{"type":"string","description":"Primary DHCP Name Server, only effective for DNSv6 \"manual\""},"sndDns":{"type":"string","description":"Secondary DHCP Name Server, only effective for dnsv6 \"manual\""}},"description":"Lan network proto: SLAAC+Stateless DHCP mode or SLAAC+RDNSS mode"},"DevicePortVO":{"type":"object","properties":{"mac":{"type":"string","description":"The unique identification of one device."},"deviceName":{"type":"string","description":"The name of one device."},"deviceType":{"type":"string","description":"Device type:ap, gateway, switch, olt"},"deviceModel":{"type":"string","description":"Model of device,for example:EAP225"},"deviceModelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"stackId":{"type":"string","description":"The stack id of devices."},"stackName":{"type":"string","description":"The name of the stacking devices."},"oswStack":{"$ref":"#/components/schemas/OswStackInfoVO"},"staticRouterPorts":{"type":"array","description":"The collection of static router ports related to one device.","items":{"$ref":"#/components/schemas/PortVO"}},"forbiddenRouterPorts":{"type":"array","description":"The collection of forbidden router ports related to one device.","items":{"$ref":"#/components/schemas/PortVO"}}},"description":"The collection of related devices."},"IgmpConfigVO":{"type":"object","properties":{"networkId":{"type":"string","description":"The primary id of the network."},"networkName":{"type":"string","description":"The name of the network.Name should contain 1 to 128 characters."},"vlan":{"type":"integer","description":"The vlan of the network.The vlan should be within the range of 1 to 4090.","format":"int32"},"mac":{"type":"string","description":"The unique identification of the device."},"deviceName":{"type":"string","description":"The name of the device."},"deviceType":{"type":"string","description":"Device type:ap, gateway, switch, olt"},"deviceModel":{"type":"string","description":"Model of device,for example:EAP225"},"deviceModelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"stackId":{"type":"string","description":"The id of the stacking devices."},"stackName":{"type":"string","description":"The name of the stacking devices."},"oswStack":{"$ref":"#/components/schemas/OswStackInfoVO"},"queryInterval":{"type":"integer","description":"The time interval for the IGMP query to send query messages (unit: s).","format":"int32"},"maximumResponseTime":{"type":"integer","description":"The maximum response time of the host to the general query message (unit: s).","format":"int32"},"lastMemberQueryInterval":{"type":"integer","description":"The time interval for the device to send a specific group of query messages (unit: s).","format":"int32"},"lastMemberQueryCount":{"type":"integer","description":"The number of specific group query messages sent by the device.","format":"int32"},"generalQuerySourceIp":{"pattern":"^\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b$","type":"string","description":"The source IP of the general query message sent."}},"description":"The querier configs for IGMP snooping(ipv4)."},"LanMulticastVO":{"type":"object","properties":{"id":{"type":"string","description":"The primary id of the multicast snooping."},"name":{"type":"string","description":"The name of the multicast snooping."},"networks":{"type":"array","description":"The collection of snooping network ids related to this multicast snooping config.","items":{"$ref":"#/components/schemas/NetworkVO"}},"protocol":{"type":"integer","description":"When multicast snooping value 0,then represents the IGMP snooping type,else if value 1,then represents MLD snooping type.","format":"int32"},"unknownMulticastRule":{"type":"integer","description":"When it selects 0,then send forward, it selects 1,then discard info, it selects 2,then route port first.","format":"int32"},"unknownMulticastExceptDevice":{"$ref":"#/components/schemas/UnknownMulticastConfigVO"},"floodKnownEnable":{"type":"boolean","description":"Whether open flood known protocols."},"querierEnable":{"type":"boolean","description":"Whether open querier."},"routerPortEnable":{"type":"boolean","description":"Whether open manual router port config."},"resource":{"type":"integer","description":"resource","format":"int32"},"routerPorts":{"type":"array","description":"The specific list of router ports info,including network, devices and the ports on them.","items":{"$ref":"#/components/schemas/RouterPortVO"}},"snoopConfig":{"$ref":"#/components/schemas/SnoopConfigVO"},"igmpQueriers":{"type":"array","description":"The querier configs for IGMP snooping(ipv4).","items":{"$ref":"#/components/schemas/IgmpConfigVO"}},"mldQueriers":{"type":"array","description":"The querier configs for MLD snooping(ipv6).","items":{"$ref":"#/components/schemas/MldConfigVO"}}}},"MldConfigVO":{"type":"object","properties":{"networkId":{"type":"string","description":"The primary id of the network."},"networkName":{"type":"string","description":"The name of the network.Name should contain 1 to 128 characters."},"vlan":{"type":"integer","description":"The vlan of the network.The vlan should be within the range of 1 to 4090.","format":"int32"},"mac":{"type":"string","description":"The unique identification of the device."},"deviceName":{"type":"string","description":"The name of the device."},"deviceType":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"deviceModel":{"type":"string","description":"Model of device,for example:EAP225"},"deviceModelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"stackId":{"type":"string","description":"The id of the stacking devices."},"stackName":{"type":"string","description":"The name of the stacking devices."},"oswStack":{"$ref":"#/components/schemas/OswStackInfoVO"},"queryInterval":{"type":"integer","description":"The time interval for the MLD query to send query messages (unit: s).","format":"int32"},"maximumResponseTime":{"type":"integer","description":"The maximum response time of the host to the general query message (unit: s).","format":"int32"},"lastMemberQueryInterval":{"type":"integer","description":"The time interval for the device to send a specific group of query messages (unit: s).","format":"int32"},"lastMemberQueryCount":{"type":"integer","description":"The number of specific group query messages sent by the device.","format":"int32"},"generalQuerySourceIp":{"pattern":"^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\s*$","type":"string","description":"The source IP of the general query message sent."}},"description":"The querier configs for MLD snooping(ipv6)."},"MulticastExceptDeviceVO":{"type":"object","properties":{"stackId":{"type":"string","description":"Stack Id"},"stackName":{"type":"string","description":"Stack name"},"mac":{"type":"string","description":"Device mac"},"deviceName":{"type":"string","description":"Device name,default value is the mac address of device"},"deviceType":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"deviceModel":{"type":"string","description":"Model of device,for example:EAP225"},"deviceModelVersion":{"type":"string","description":"Model version of device,for example:3.0"}},"description":"report suppression except device list"},"NetworkVO":{"type":"object","properties":{"networkId":{"type":"string","description":"The id for the network."},"networkName":{"type":"string","description":"The name of the network."},"vlanType":{"type":"integer","description":"0:Single, 1:Multiple(Bridge Vlan)","format":"int32"},"vlan":{"type":"integer","description":"The vlan of one network that multicast config used.","format":"int32"}},"description":"The collection of snooping network ids related to this multicast snooping config."},"OswStackInfoVO":{"type":"object","properties":{"stackId":{"type":"string","description":"The stack id of the stack device."},"stackName":{"type":"string","description":"The stack name of the stack device."},"masterMac":{"type":"string","description":"The mac of the master device of the stack device."},"members":{"type":"array","description":"The members of the stack device.","items":{"$ref":"#/components/schemas/StackMemberVO"}}},"description":"The osw stack."},"PortVO":{"type":"object","properties":{"port":{"type":"integer","description":"The port id of the device port.","format":"int32"},"standardPort":{"type":"string","description":"The stand port id of the device port."},"lagId":{"type":"integer","description":"(Wired) LAG ID. Exists only when the client is connected to the LAG","format":"int32"}},"description":"The collection of forbidden router ports related to one device."},"ReportSuppressionConfigVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"enable"},"deviceList":{"type":"array","description":"report suppression except device list","items":{"$ref":"#/components/schemas/MulticastExceptDeviceVO"}}},"description":"reportSuppressionExceptDevice"},"RouterPortVO":{"type":"object","properties":{"networkId":{"type":"string","description":"The unique identification of one network."},"networkName":{"type":"string","description":"The name of network."},"vlan":{"type":"integer","description":"The vlan of the network.","format":"int32"},"devices":{"type":"array","description":"The collection of related devices.","items":{"$ref":"#/components/schemas/DevicePortVO"}},"staticRouterPortsNum":{"type":"integer","description":"The total num of static router ports related to this network.","format":"int32"},"forbiddenRouterPortsNum":{"type":"integer","description":"The total num of forbidden router ports related to this network.","format":"int32"}},"description":"The specific list of router ports info,including network, devices and the ports on them."},"SnoopConfigVO":{"type":"object","properties":{"reportSuppressionEnable":{"type":"boolean","description":"Indicates whether to enable message suppression."},"reportSuppressionExceptDevice":{"$ref":"#/components/schemas/ReportSuppressionConfigVO"},"memberPortAgingTime":{"type":"integer","description":"The aging time of member ports (unit: s).","format":"int32"},"routerPortAgingTime":{"type":"integer","description":"The aging time of the routing port (unit: s).","format":"int32"},"leaveTime":{"type":"integer","description":"The time it takes to remove the port from the group after receiving the outbound message (unit: s).","format":"int32"}},"description":"The snoop config model."},"StackMemberVO":{"type":"object","properties":{"mac":{"type":"string","description":"The unique identification of the device."},"deviceName":{"type":"string","description":"The name of the device."},"deviceType":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"deviceModel":{"type":"string","description":"Model of device,for example:EAP225"},"deviceModelVersion":{"type":"string","description":"Model version of device,for example:3.0"}},"description":"The members of the stack device."},"UnKnownMulticastExceptDeviceVO":{"type":"object","properties":{"stackId":{"type":"string","description":"Stack Id"},"stackName":{"type":"string","description":"Stack name"},"mac":{"type":"string","description":"Device mac"},"deviceName":{"type":"string","description":"Device name,default value is the mac address of device"},"deviceType":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"deviceModel":{"type":"string","description":"Model of device,for example:EAP225"},"deviceModelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"type":{"type":"integer","description":"UnknownMulticastRule type","format":"int32"}},"description":"unknown multicast except device list"},"UnknownMulticastConfigVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"enable"},"deviceList":{"type":"array","description":"unknown multicast except device list","items":{"$ref":"#/components/schemas/UnKnownMulticastExceptDeviceVO"}}},"description":"UnknownMulticastConfigVO."},"IPMacBinding":{"required":["interfaceId","interfaceType","ip","mac","status"],"type":"object","properties":{"description":{"pattern":"^$|^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Description should contain 1 to 64 characters."},"mac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"MAC of the IP MAC binding entity."},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP of the IP MAC binding entity."},"status":{"type":"boolean","description":"Status of the IP MAC binding entity."},"interfaceType":{"type":"integer","description":"Interface type should be a value as follows: 0: WAN; 1: LAN interface.","format":"int32"},"interfaceId":{"type":"string","description":"Interface ID. WAN port ID can be obtained from 'Get internet basic info' interface. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."},"exportToDhcpReservation":{"type":"boolean","description":"Whether to export to the DhcpReservation table. This subsection is deprecated.","deprecated":true},"supportExport":{"type":"boolean","description":"Whether could export to the DhcpReservation table. This subsection is deprecated.","deprecated":true},"enableExportToDhcpReservation":{"type":"boolean","description":"Whether to enable export to the DhcpReservation table."}}},"batchIds":{"required":["ids"],"type":"object","properties":{"ids":{"uniqueItems":true,"type":"array","description":"When selectType is set to all, the ids do not need to be passed and all entries are processed, when selectType is set to include, the id entries contained in the ids are processed, when selectType is set to exclude, the id entries that are not contained in the ids are processed","items":{"type":"string","description":"When selectType is set to all, the ids do not need to be passed and all entries are processed, when selectType is set to include, the id entries contained in the ids are processed, when selectType is set to exclude, the id entries that are not contained in the ids are processed"}},"selectType":{"pattern":"all|include|exclude","type":"string","description":"SelectType all, include or exclude"},"searchKey":{"type":"string","description":"Fuzzy query parameters, support field: voucher code"}},"description":"Batch select IDS"},"deviceTemplateAdd":{"type":"object","properties":{"templateName":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"The name of device template."},"deviceType":{"type":"string","description":"The type of device."},"model":{"type":"string","description":"The model name of device."},"modelVersion":{"type":"string","description":"The model version of device.For example: 1.0"},"templateSettings":{"type":"array","description":"The configurable modules of device. For Access Series/ Aggregation/ Campus Switches: 1:port; 2:vlanInterface; 3:staticRoute; 6:general; 7:loopbackControl. For Agile Series Switches: 1:port; 5:ipSetting; 6:general; 7:loopbackControl. For only Wireless Gateways: 2:radios; 3:wlans; 5:advanced. For only 4G/5G Gateways: 7:sim_statistics; 8:sms_settings. For all Gateways: 1:port; 4:general; 9:routing; 10:nat; 11:bandwidth_control; 12:acl; 13:session_limit; 14:gateway_qos; 15:url_filtering; 16:application_control; 17:ids_ips; 18:firewall; 19:dns; 20:upnp; 21:iptv; 23:advanced_general; 24:mac_filtering.","items":{"type":"integer","description":"The configurable modules of device. For Access Series/ Aggregation/ Campus Switches: 1:port; 2:vlanInterface; 3:staticRoute; 6:general; 7:loopbackControl. For Agile Series Switches: 1:port; 5:ipSetting; 6:general; 7:loopbackControl. For only Wireless Gateways: 2:radios; 3:wlans; 5:advanced. For only 4G/5G Gateways: 7:sim_statistics; 8:sms_settings. For all Gateways: 1:port; 4:general; 9:routing; 10:nat; 11:bandwidth_control; 12:acl; 13:session_limit; 14:gateway_qos; 15:url_filtering; 16:application_control; 17:ids_ips; 18:firewall; 19:dns; 20:upnp; 21:iptv; 23:advanced_general; 24:mac_filtering.","format":"int32"}}}},"BatchBindDeviceOpenApiVO":{"type":"object","properties":{"devices":{"maxItems":1000,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/DeviceBindBriefOpenApiVO"}}}},"DeviceBindBriefOpenApiVO":{"required":["mac","siteId"],"type":"object","properties":{"mac":{"type":"string","description":"The mac address of device, like AA-BB-CC-DD-EE-FF."},"siteId":{"type":"string","description":"The ID of target site."}}},"BatchBindDeviceResultOpenApiVO":{"type":"object","properties":{"successedDevices":{"type":"array","description":"Devices with successful operation.","items":{"$ref":"#/components/schemas/DeviceBindResultOpenApiVO"}},"failedDevices":{"type":"array","description":"Devices with failed operation.","items":{"$ref":"#/components/schemas/DeviceBindResultOpenApiVO"}}}},"DeviceBindResultOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"The mac address of device, like AA-BB-CC-DD-EE-FF."},"siteId":{"type":"string","description":"The ID of target site."},"errorCode":{"type":"integer","description":"The error code for failed operation.","format":"int32"},"msg":{"type":"string","description":"The message for failed operation."}},"description":"Devices with failed operation."},"OperationResponseBatchBindDeviceResultOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/BatchBindDeviceResultOpenApiVO"}}},"CopySiteTemplateOpenApiVO":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,62}[^ ]$","type":"string","description":"Name of the site should contain 1 to 64 characters."}}},"CopySiteResultVO":{"type":"object","properties":{"id":{"type":"string","description":"Copied site ID ."}}},"BatchCopySiteTemplateOpenApiVO":{"required":["name","targetOmadacs"],"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,62}[^ ]$","type":"string","description":"Name of the site should contain 1 to 64 characters."},"targetOmadacs":{"maxItems":10,"minItems":0,"uniqueItems":true,"type":"array","description":"The target Customer ID needs to be obtained from the interface \"Obtain the customer ID with permission to modify site templates\".","items":{"maxLength":10,"minLength":0,"type":"string","description":"The target Customer ID needs to be obtained from the interface \"Obtain the customer ID with permission to modify site templates\"."}}}},"CopySiteTemplateOpenApiResultVO":{"type":"object","properties":{"successNum":{"type":"integer","description":"Number of successful copies.","format":"int32"},"failNum":{"type":"integer","description":"Number of failed copies.","format":"int32"},"errorCustomers":{"type":"array","description":"Copy failed customer related information.","items":{"$ref":"#/components/schemas/SiteCopyResultVO"}}}},"OperationResponseCopySiteTemplateOpenApiResultVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CopySiteTemplateOpenApiResultVO"}}},"SiteCopyResultVO":{"type":"object","properties":{"customerId":{"type":"string","description":"Copying failed customer's customerId."},"customerName":{"type":"string","description":"Copying failed customer's customerName."},"errorCode":{"type":"integer","description":"Copying failed customer's errorCode.","format":"int32"}},"description":"Copy failed customer related information."},"ModifyCliTemplateOpenApiVO":{"required":["cliConfig","deviceType","name"],"type":"object","properties":{"name":{"type":"string","description":"CLI configuration name, it should be within the range of 1 - 64 characters"},"deviceType":{"type":"string","description":"Device type for CLI configuration application, it should be a value as follows: switch."},"description":{"type":"string","description":"CLI configuration description, it should be within the range of 0 - 256 characters."},"cliConfig":{"type":"string","description":"CLI configuration content"}},"description":"Modify the CLI template configuration entry"},"BindSiteOpenApiVO":{"required":["siteId"],"type":"object","properties":{"siteId":{"type":"string","description":"Site ID to bind."},"switches":{"type":"array","description":"Switch choose for binding device template.","items":{"$ref":"#/components/schemas/DeviceBindOpenApiVO"}}}},"DeviceBindOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF."},"deviceTemplateId":{"type":"string","description":"Switch device template ID."}},"description":"Switch choose for binding device template."}," BatchUnbindSites":{"required":["siteIds"],"type":"object","properties":{"siteIds":{"uniqueItems":true,"type":"array","description":"The IDs of target sites.","items":{"type":"string","description":"The IDs of target sites."}}}},"BandwidthControlRule":{"required":["downstreamBandwidth","downstreamBandwidthUnit","mode","name","sourceIds","status","upstreamBandwidth","upstreamBandwidthUnit","wanPortIds"],"type":"object","properties":{"id":{"type":"string","description":"ID of the bandwidth control rule."},"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name should contain 1 to 64 characters."},"index":{"type":"integer","description":"Index of the bandwidth control rule.","format":"int32"},"status":{"type":"boolean","description":"Status of the bandwidth control rule."},"sourceType":{"type":"integer","description":"Source type should be a value as follows: 0: network; 1: IP group.","format":"int32"},"sourceIds":{"type":"array","description":"Source IDs of the bandwidth control rule. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface. IP group can be created using 'Create a new group profile' interface, and IP group ID can be obtained from 'Get group profile list' interface.","items":{"type":"string","description":"Source IDs of the bandwidth control rule. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface. IP group can be created using 'Create a new group profile' interface, and IP group ID can be obtained from 'Get group profile list' interface."}},"wanPortIds":{"type":"array","description":"WAN port IDs of the bandwidth control rule.WAN port ID can be obtained from 'Get internet basic info' interface.","items":{"type":"string","description":"WAN port IDs of the bandwidth control rule.WAN port ID can be obtained from 'Get internet basic info' interface."}},"upstreamBandwidth":{"type":"integer","description":"Upstream bandwidth should be within the range of 1–9999999.","format":"int32"},"upstreamBandwidthUnit":{"type":"integer","description":"Upstream bandwidth unit should be a value as follows: 1: Kbps, 2: Mbps.","format":"int32"},"downstreamBandwidth":{"type":"integer","description":"Downstream bandwidth should be within the range of 1–9999999.","format":"int32"},"downstreamBandwidthUnit":{"type":"integer","description":"Downstream bandwidth unit should be a value as follows: 1: Kbps, 2: Mbps.","format":"int32"},"mode":{"type":"integer","description":"Mode should be a value as follows: 0: share; 1: individual.","format":"int32"}}},"AddRuleEntity":{"required":["applications","qos","ruleName","schedule","selectType"],"type":"object","properties":{"ruleName":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"Rule name. It should be 1 - 128 characters"},"schedule":{"type":"string","description":"Schedule profile ID, which can be queried by request： Get time range profile list."},"qos":{"type":"boolean","description":"Enable qos. true:enable / false:disable"},"qosClass":{"type":"integer","description":"The Class value selected in the Qos Class configuration, required when qos is enable. Valid values is 0: Others, 1: Class 1, 2: Class 2, 3: Class 3.","format":"int32"},"applications":{"type":"array","description":"Application ID list can be obtained from 'Get application list' interface.","items":{"type":"integer","description":"Application ID list can be obtained from 'Get application list' interface.","format":"int32"}},"selectType":{"type":"string","description":"Select type of applications. include: include selected applications, exclude: all but exclude selected applications, all: include all applications."}}},"ApplicationEntity":{"type":"object","properties":{"applicationName":{"type":"string","description":"Application name"},"applicationId":{"type":"integer","description":"Application ID","format":"int32"},"description":{"type":"string","description":"Description of application"},"family":{"type":"string","description":"Family of application"}},"description":"Application list"},"OperationResponseRuleResultEntity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/RuleResultEntity"}}},"RuleResultEntity":{"type":"object","properties":{"ruleName":{"type":"string","description":"Rule name"},"ruleId":{"type":"integer","description":"Rule ID","format":"int32"},"schedule":{"type":"string","description":"Schedule profile ID"},"qos":{"type":"boolean","description":"Enable qos. true:enable / false:disable"},"qosClass":{"type":"integer","description":"Qos class category","format":"int32"},"applications":{"type":"array","description":"Application list","items":{"$ref":"#/components/schemas/ApplicationEntity"}}}},"OperationResponseRestrictionResultEntity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/RestrictionResultEntity"}}},"RestrictionResultEntity":{"type":"object","properties":{"networkName":{"type":"string","description":"Network name. It should be the name of LAN network, can be obtained from 'Get LAN network list' interface."},"filterId":{"type":"integer","description":"Filter ID can be obtained from 'Get filter list' interface.","format":"int32"},"restrictionId":{"type":"integer","description":"Restriction ID","format":"int32"},"filter":{"type":"string","description":"Filter name"},"subnet":{"type":"string","description":"Subnet"},"subnetIpv6":{"type":"string","description":"Subnet Ipv6"},"vlan":{"type":"integer","description":"Vlan ID","format":"int32"},"vlans":{"type":"string","description":"Vlan IDS"}}},"AddFilterEntity":{"required":["description","filterName","rules"],"type":"object","properties":{"filterName":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"Filter name. It should be 1 - 128 characters"},"description":{"pattern":"^.{1,128}$","type":"string","description":"Description of filter. It should be 1 - 128 characters"},"rules":{"type":"array","description":"Rule ID list can be obtained from 'Get rule list' interface.","items":{"type":"integer","description":"Rule ID list can be obtained from 'Get rule list' interface.","format":"int32"}}}},"FilterEntity":{"type":"object","properties":{"filterName":{"type":"string","description":"Filter name"},"filterId":{"type":"integer","description":"Filter ID","format":"int32"},"description":{"type":"string","description":"Description of filter"},"rules":{"type":"array","description":"Rule list","items":{"$ref":"#/components/schemas/RuleEntity"}}}},"OperationResponseFilterEntity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/FilterEntity"}}},"RuleEntity":{"type":"object","properties":{"ruleName":{"type":"string","description":"Rule name"},"ruleId":{"type":"integer","description":"Rule ID","format":"int32"}},"description":"Rule list"},"CreateApGroupOpenApiVO":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"AP group name should contain 1 to 128 characters."},"apMacs":{"type":"array","description":"List of AP device MAC addresses bound to this AP group. Can be empty.","items":{"type":"string","description":"List of AP device MAC addresses bound to this AP group. Can be empty."}}}},"AddApGroupResultVO":{"type":"object","properties":{"id":{"type":"string","description":"AP Group ID"}}},"OperationResponseAddApGroupResultVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AddApGroupResultVO"}}},"DragSortIndexOpenapiVO":{"required":["indexes","type"],"type":"object","properties":{"type":{"type":"string","description":"\"gateway\" or \"switch\" or \"eap\""},"indexes":{"type":"object","additionalProperties":{"type":"integer","description":"The order in which items take effect, this object is a Map, the key is item ID and the value is the index you want to set.","format":"int32"},"description":"The order in which items take effect, this object is a Map, the key is item ID and the value is the index you want to set."}},"description":"DragSort index entity"},"DragSortIndexTemplateOpenapiVO":{"required":["indexes","type"],"type":"object","properties":{"type":{"type":"string","description":"\"gateway\" or \"eap\""},"indexes":{"type":"object","additionalProperties":{"type":"integer","description":"The order in which items take effect, this object is a Map, the key is item ID and the value is the index you want to set.","format":"int32"},"description":"The order in which items take effect, this object is a Map, the key is item ID and the value is the index you want to set."}},"description":"DragSort index entity template"},"CreateSiteEntity":{"required":["deviceAccountSetting","name","region","scenario","timeZone"],"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,62}[^ ]$","type":"string","description":"Name of the site should contain 1 to 64 characters."},"type":{"type":"integer","description":"Type of the site should be 0 or 1, and 0 means basic site, 1 means pro site.","format":"int32"},"region":{"type":"string","description":"Country/Region of the site; For the values of region, refer to the abbreviation of the ISO country code; For example, you need to input \"United States\" for the United States of America."},"timeZone":{"type":"string","description":"For the values of the timezone of the site, refer to section 5.1 of the Open API Access Guide."},"scenario":{"type":"string","description":"For the values of the scenario of the site, refer to result of the interface for Get scenario list."},"tagIds":{"uniqueItems":true,"type":"array","description":"Site tag ID, Site tag ID can be created using \"Create new site tag\" interface, and site tag ID can be obtained from \"Get site tag list\" interface","items":{"type":"string","description":"Site tag ID, Site tag ID can be created using \"Create new site tag\" interface, and site tag ID can be obtained from \"Get site tag list\" interface"}},"longitude":{"type":"number","description":"Longitude of the site should be within the range of -180 - 180.","format":"double"},"latitude":{"type":"number","description":"Latitude of the site should be within the range of -90 - 90.","format":"double"},"address":{"type":"string","description":"Address of the site"},"deviceAccountSetting":{"$ref":"#/components/schemas/DeviceAccountSettingOpenApiVO"},"supportES":{"type":"boolean","description":"Whether the site supports adopting Agile Series Switches"},"supportL2":{"type":"boolean","description":"Whether the site supports adopting Non-Agile Series Switches"}}},"QuickCreateSsidOpenApiVO":{"required":["band","security","ssidName"],"type":"object","properties":{"apGroupIds":{"type":"array","description":"AP Group ID list.","items":{"type":"string","description":"AP Group ID list."}},"chooseDevices":{"type":"integer","description":"select all devices or not. 0 means select all devices, 1 means not select all devices.","format":"int32"},"wlanId":{"type":"string","description":"WLAN ID"},"ssidName":{"type":"string","description":"SSID name. It should contain 1 to 32 UTF-8 characters."},"band":{"type":"integer","description":"SSID band. The lowest bit indicates whether 2.4G is included; the second lowest bit indicates whether 5G is included; the third lowest bit indicates whether 6G is included; 1 means included while 0 means not included. For example, 7(111) means that 2G/5G/6G are enabled; 1(001) means that 2G is enabled. (When 5G is included，it means 5G/5G1/5G2 are enabled.)","format":"int32"},"deviceType":{"type":"integer","description":"SSID device type, identify which devices this SSID will take effect; The lowest bit indicates whether [EAP] is included, the second low bit indicates whether [Gateway] is included, 1 means included while 0 means not included; For example, 3(11) means that EAP/Gateway is enabled, 1(01) means that EAP is enabled.","format":"int32"},"security":{"type":"integer","description":"SSID security mode; Security should be a value as follows: 0: None; 2: WPA-Enterprise; 3: WPA-Personal; ","format":"int32"},"securityKey":{"type":"string","description":"WPA-Personal SSID password. This is necessary when the value of security is 3(WPA-Personal);It should contain 8-63 printable ASCII characters or 8-63 hexadecimal digits."},"guestNetEnable":{"type":"boolean","description":"SSID guest network config status. True: enable, false: disable.\nWith this option enabled, the guest network will prevent wireless clients on the same AP from communicating with each other. This may restrain the functions of AirPlay, ChromeCast, Sonos devices, screen mirroring, and wireless printers."},"radiusProfileId":{"type":"string","description":"This field represents RADIUS Profile ID. RADIUS Profile(RADIUS Profile Template) can be created using Create a new RADIUS profile(Create a new RADIUS profile template) interface, and RADIUS Profile ID(RADIUS Profile Template ID) can be obtained from Get RADIUS profile list(Get RADIUS profile template list) interface."}}},"WifiDeviceAndClientQueryVO":{"required":["time"],"type":"object","properties":{"time":{"type":"integer","description":"Time(unit:ms)","format":"int64"},"searchKey":{"type":"string","description":"Fuzzy query parameters, support field name,mac"},"sorts":{"type":"object","additionalProperties":{"type":"string","description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field."},"description":"Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field."},"topK":{"type":"integer","description":"The topK elements, which must be less than 100","format":"int32"}}},"AccessCapacityInfoVO":{"type":"object","properties":{"mac":{"type":"string","description":"Mac address"},"ip":{"type":"string","description":"ip"},"model":{"type":"string","description":"Device model name with version"},"modelVersion":{"type":"string","description":"Model version of device, for example:3.0"},"deviceName":{"type":"string","description":"Device name"},"deviceType":{"type":"string","description":"Device type"},"connectionClientCount":{"type":"integer","description":"The number of client connected to the device","format":"int32"}}},"ChannelInterInfoVO":{"type":"object","properties":{"mac":{"type":"string","description":"Mac address"},"ip":{"type":"string","description":"ip"},"model":{"type":"string","description":"Device model name with version"},"modelVersion":{"type":"string","description":"Model version of device, for example:3.0"},"deviceName":{"type":"string","description":"Device name"},"deviceType":{"type":"string","description":"Device type"},"channelInterf":{"type":"integer","description":"Channel interference rate","format":"int32"},"channelInterf2g":{"type":"integer","description":"Channel interference rate","format":"int32"},"channelInterf5g":{"type":"integer","description":"Channel interference rate","format":"int32"},"channelInterf6g":{"type":"integer","description":"Channel interference rate","format":"int32"},"noiseFloor2g":{"type":"integer","description":"Noise floor of 2.4g","format":"int32"},"noiseFloor5g":{"type":"integer","description":"Noise floor of 5g","format":"int32"},"noiseFloor6g":{"type":"integer","description":"Noise floor of 6g","format":"int32"}}},"ChannelUtilInfoVO":{"type":"object","properties":{"mac":{"type":"string","description":"Mac address"},"ip":{"type":"string","description":"ip"},"model":{"type":"string","description":"Device model name with version"},"modelVersion":{"type":"string","description":"Model version of device, for example:3.0"},"deviceName":{"type":"string","description":"Device name"},"deviceType":{"type":"string","description":"Device type"},"channelUtil":{"type":"integer","description":"Channel utilization rate","format":"int32"},"channelUtil2g":{"type":"integer","description":"Channel 2g utilization rate","format":"int32"},"channelUtil5g":{"type":"integer","description":"Channel 5g utilization rate","format":"int32"},"channelUtil6g":{"type":"integer","description":"Channel 6g utilization rate","format":"int32"}}},"ClientAccessTimeInfoVO":{"type":"object","properties":{"mac":{"type":"string","description":"Mac address"},"ip":{"type":"string","description":"ip"},"clientName":{"type":"string","description":"Client name"},"deviceType":{"type":"string","description":"Client-connected device type"},"clientType":{"type":"string","description":"Client type for icon display (e.g. Mobile, Laptop, IPC)"},"clientModel":{"type":"string","description":"Client model for icon display"},"totalTime":{"type":"integer","description":"Total access time, only including associationTime now","format":"int32"},"associationTime":{"type":"integer","description":"Association time","format":"int32"},"authTime":{"type":"integer","description":"Authorization time","format":"int32"},"dhcpTime":{"type":"integer","description":"DHCP time","format":"int32"},"dnsTime":{"type":"integer","description":"DNS time","format":"int32"},"incidents":{"type":"integer","description":"Incident counts","format":"int32"}}},"RssiInfoVO":{"type":"object","properties":{"mac":{"type":"string","description":"Mac address"},"ip":{"type":"string","description":"ip"},"clientName":{"type":"string","description":"Client name"},"deviceType":{"type":"string","description":"Client-connected device type"},"clientType":{"type":"string","description":"Client type for icon display (e.g. Mobile, Laptop, IPC)"},"clientModel":{"type":"string","description":"Client model for icon display"},"connectDeviceName":{"type":"string","description":"Client-connected device name"},"connectDeviceMac":{"type":"string","description":"Client-connected device mac"},"ssid":{"type":"string","description":"ssid"},"rssi":{"type":"integer","description":"rssi","format":"int32"}}},"WifiClientInfoVO":{"type":"object","properties":{"accessTimeList":{"type":"array","items":{"$ref":"#/components/schemas/ClientAccessTimeInfoVO"}},"channelUtilList":{"type":"array","items":{"$ref":"#/components/schemas/ChannelUtilInfoVO"}},"channelInterfList":{"type":"array","items":{"$ref":"#/components/schemas/ChannelInterInfoVO"}},"accessCapacityList":{"type":"array","items":{"$ref":"#/components/schemas/AccessCapacityInfoVO"}},"rssiList":{"type":"array","items":{"$ref":"#/components/schemas/RssiInfoVO"}}}},"IspScanStartOpenApiVO":{"required":["portUuid"],"type":"object","properties":{"portUuid":{"type":"string","description":"The ID of the port."},"simCard":{"type":"integer","description":"When the device supports Dual-SIM card, parameter [simCard] should not be null.1: SIM1; 2: SIM2.","format":"int32"}}},"BandScanStart":{"required":["portUuid"],"type":"object","properties":{"portUuid":{"type":"string","description":"The ID of the port."},"simCard":{"type":"integer","description":"When the device supports Dual-SIM card, parameter [simCard] should not be null.1: SIM1; 2: SIM2.","format":"int32"},"mode":{"type":"integer","description":"Band mode. 1: 4G scan; 2: 5G scan.","format":"int32"}}},"PortBandwidthVO":{"type":"object","properties":{"portUuid":{"type":"string","description":"Port uuid."},"rxBandwidth":{"type":"integer","description":"Set down link bandwidth.","format":"int64"},"txBandwidth":{"type":"integer","description":"Set up link bandwidth.","format":"int64"}},"description":"Set port bandwidth info list."},"WanPortBandwidthVO":{"type":"object","properties":{"bandwidths":{"type":"array","description":"Set port bandwidth info list.","items":{"$ref":"#/components/schemas/PortBandwidthVO"}}}},"VpnUser":{"type":"object","properties":{"id":{"type":"string","description":"ID of the VPN user."},"username":{"type":"string","description":"Username of the VPN user."},"password":{"type":"string","description":"Password of the VPN user."},"protocol":{"type":"integer","description":"Protocol should be a value as follows: 0: L2TP or PPTP; 1: openVPN.","format":"int32"},"clientMode":{"type":"integer","description":"Client mode should be a value as follows: 0: Client-To-Site, 1: Site-To-Site.","format":"int32"},"maxConnections":{"type":"integer","description":"Max connections should be within the range of 1–100.","format":"int32"},"userRemoteSubnets":{"type":"array","description":"User remote subnets of the VPN user.","items":{"$ref":"#/components/schemas/IPSubnetsVO"}},"servers":{"type":"array","description":"Servers of the VPN user. Server can be created using 'Create client-to-site VPN server' interface, and server ID can be obtained from 'Get client-to-site VPN server list' interface.","items":{"type":"string","description":"Servers of the VPN user. Server can be created using 'Create client-to-site VPN server' interface, and server ID can be obtained from 'Get client-to-site VPN server list' interface."}},"localIp":{"type":"string","description":"Local IP of the VPN user."},"serverNames":{"type":"string","description":"Server names of the VPN user."}}},"SslVpnUserConfigOpenApiVO":{"required":["concurrentNumber","name","password","status","validity"],"type":"object","properties":{"groupId":{"type":"string","description":"Group ID of the SSL VPN user. User group can be created using 'Create SSL VPN user group' interface, and User Group ID can be obtained from 'Get user group list for SSL VPN server' interface."},"name":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,18}[\\041-\\0176]$","type":"string","description":"Name of the SSL VPN user should contain 1 to 20 characters."},"status":{"type":"boolean","description":"Status of the SSL VPN user"},"password":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,62}[\\041-\\0176]$","type":"string","description":"Password of the SSL VPN user should contain 1 to 64 characters."},"validity":{"type":"string","description":"Validity of the SSL VPN user. The format is Month/Day/Year, for example 08/20/2022"},"concurrentNumber":{"type":"integer","description":"Concurrent number of the SSL VPN user should be within the range of 1–100","format":"int32"}}},"SslVpnUserGroupConfigOpenApiVO":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,18}[\\041-\\0176]$","type":"string","description":"Name of the SSL VPN user group should contain 1 to 20 characters."},"radiusAttribute":{"type":"string","description":"Attribute value used for radius authentication. It should contain 1 to 20 characters."},"ldapAttribute":{"type":"string","description":"Attribute value used for LDAP authentication. It should contain 1 to 20 characters."},"resourceGroupList":{"type":"array","description":"Resource group ID list of the SSL VPN user group. Resource group can be created using 'Create SSL VPN resource group' interface, and Resource group ID can be obtained from 'Get resource group list for SSL VPN server' interface.","items":{"type":"string","description":"Resource group ID list of the SSL VPN user group. Resource group can be created using 'Create SSL VPN resource group' interface, and Resource group ID can be obtained from 'Get resource group list for SSL VPN server' interface."}}}},"SslVpnResourceConfigOpenApiVO":{"required":["name","type"],"type":"object","properties":{"name":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,18}[\\041-\\0176]$","type":"string","description":"Name of the SSL VPN resource should contain 1 to 20 characters."},"type":{"type":"integer","description":"Type of the SSL VPN resource should be a value as follows: 0: IP; 1: domain.","format":"int32"},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP of the SSL VPN resource, exists when type is 0."},"mask":{"type":"string","description":"Mask of the SSL VPN resource, exists when type is 0."},"domain":{"type":"string","description":"Domain of the SSL VPN resource, exists when type is 1."},"protocol":{"type":"integer","description":"Protocol of the SSL VPN resource should be a value as follows: 0:All; 1:TCP; 2:UDP; 3:TCP/UDP; 4:ICMP; 5:Other","format":"int32"},"srcPortStart":{"type":"integer","description":"Start source port of the SSL VPN resource, exists when protocol is TCP or UDP. It should be within the range of 0–65535","format":"int32"},"srcPortEnd":{"type":"integer","description":"End source port of the SSL VPN resource, exists when protocol is TCP or UDP. It should be within the range of 0–65535","format":"int32"},"dstPortStart":{"type":"integer","description":"Start destination port of the SSL VPN resource, exists when protocol is TCP or UDP. It should be within the range of 0–65535","format":"int32"},"dstPortEnd":{"type":"integer","description":"End destination port of the SSL VPN resource, exists when protocol is TCP or UDP. It should be within the range of 0–65535","format":"int32"},"icmpType":{"type":"integer","description":"ICMP type of the SSL VPN resource, exists when protocol is ICMP. It should be within the range of 0–255","format":"int32"},"icmpCode":{"type":"integer","description":"ICMP code of the SSL VPN resource, exists when protocol is ICMP. It should be within the range of 0–255","format":"int32"},"otherProtocol":{"type":"integer","description":"Other protocol of the SSL VPN resource. It should be within the range of 1–255.","format":"int32"}}},"SslVpnResourceGroupConfigOpenApiVO":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,18}[\\041-\\0176]$","type":"string","description":"Name of the SSL VPN resource group should contain 1 to 20 characters."},"resourcesList":{"type":"array","description":"Resources ID list of the SSL VPN resource group","items":{"type":"string","description":"Resources ID list of the SSL VPN resource group"}}}},"SslVpnLockConfigOpenApiVO":{"required":["totalLockTime","type"],"type":"object","properties":{"type":{"type":"integer","description":"Type of the SSL VPN lock should be a value as follows: 0:username; 1:IP","format":"int32"},"username":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,18}[\\041-\\0176]$","type":"string","description":"Username of the SSL VPN lock. It is required when parameter [type] is 0."},"ip":{"type":"string","description":"IP of the SSL VPN lock. It is required when parameter [type] is 1."},"totalLockTime":{"type":"integer","description":"Total lock time of the SSL VPN lock should be within the range of 1–1080(min).","format":"int32"}}},"SiteToSiteVpn":{"required":["name","siteVpnType","status"],"type":"object","properties":{"id":{"type":"string","description":"ID of the VPN."},"name":{"pattern":"^[a-zA-Z0-9_]{1,63}$","type":"string","description":"Name should contain 1 to 63 characters."},"siteVpnType":{"type":"integer","description":"Site VPN type should be a value as follows: 0: Auto IPSec; 1: Manual IPSec.","format":"int32"},"status":{"type":"boolean","description":"Status of the VPN."},"remoteSite":{"type":"string","description":"Remote site of the VPN, only for Auto IPSec type."},"remoteIp":{"type":"string","description":"Remote IP of the VPN, only for Manual IPSec type."},"remoteSubnet":{"type":"array","description":"Remote subnet of the VPN, only for Manual IPSec type.","items":{"$ref":"#/components/schemas/IPSubnetsVO"}},"networkType":{"type":"integer","description":"Network type should be a value as follows: 0: network list; 1: custom networks.","format":"int32"},"networkList":{"type":"array","description":"Network list of the VPN, only for Manual IPSec type. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Network list of the VPN, only for Manual IPSec type. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface."}},"customNetwork":{"type":"array","description":"Custom networks of the VPN, only for Manual IPSec type.","items":{"$ref":"#/components/schemas/IPSubnetsVO"}},"preSharedKey":{"type":"string","description":"Pre-shared key of the VPN, only for Manual IPSec type."},"wan":{"type":"array","description":"WAN list of the VPN, only for Manual IPSec type. WAN port ID can be obtained from 'Get internet basic info' interface.","items":{"type":"string","description":"WAN list of the VPN, only for Manual IPSec type. WAN port ID can be obtained from 'Get internet basic info' interface."}},"advancedSetting":{"$ref":"#/components/schemas/VpnAdvancedSettingOpenApiVO"}}},"IPsecFailover configuration":{"required":["candidates","name","primary"],"type":"object","properties":{"id":{"type":"string","description":"ID of the IPSec failover."},"name":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,62}[\\041-\\0176]$","type":"string","description":"Name should contain 1 to 64 characters."},"primary":{"type":"string","description":"Primary of the IPSec failover. IPsec VPN can be created using 'Create site-to-site VPN' interface, and ID can be obtained from 'Get site-to-site VPN list' interface."},"candidates":{"type":"array","description":"Candidates of the IPSec failover. IPsec VPN can be created using 'Create site-to-site VPN' interface, and ID can be obtained from 'Get site-to-site VPN list' interface.","items":{"type":"string","description":"Candidates of the IPSec failover. IPsec VPN can be created using 'Create site-to-site VPN' interface, and ID can be obtained from 'Get site-to-site VPN list' interface."}},"failback":{"type":"boolean","description":"Failback of the IPSec failover."},"failbackTime":{"type":"integer","description":"Failback time should be within the range of 10–3600s.","format":"int32"}}},"VpnDefaultValueReqVO":{"required":["type"],"type":"object","properties":{"type":{"type":"integer","description":"Parameter [type] should be a value as follows: 0, name; 1, port; 2, tunnelIp.","format":"int32"},"usage":{"type":"integer","description":"Parameter [usage] should not be null when parameter [type] is name. Parameter [usage] should be a value as follows: 0, server; 1, client; 2, site-to-site.","format":"int32"},"vpnType":{"type":"integer","description":"Parameter [vpnType] should not be null when parameter [type] is port. Parameter [vpnType] should be a value as follows: 3, Open VPN; 4, Wire Guard; 5, SSL VPN.","format":"int32"}}},"OperationResponseVpnDefaultValueRespVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VpnDefaultValueRespVO"}}},"VpnDefaultValueRespVO":{"type":"object","properties":{"vpnName":{"type":"object","additionalProperties":{"type":"string","description":"Default VPN name for each VPN type."},"description":"Default VPN name for each VPN type."},"port":{"type":"integer","description":"Default service port.","format":"int32"},"tunnelIp":{"type":"string","description":"Default tunnel IP for Wire Guard."}}},"ClientToSiteVpnServer":{"required":["clientVpnType","ipPool","name","wan"],"type":"object","properties":{"id":{"type":"string","description":"ID of the VPN."},"name":{"pattern":"^[a-zA-Z0-9_]{1,63}$","type":"string","description":"Name should contain 1 to 63 characters."},"status":{"type":"boolean","description":"Status of the VPN."},"accountPassword":{"type":"boolean","description":"Account password of the VPN, only for server OpenVPN."},"tunnelMode":{"type":"integer","description":"Tunnel mode(only for server OpenVPN)should be a value as follows: 0: split; 1: full.","format":"int32"},"openVpnMode":{"type":"integer","description":"OpenVPN mode should be a value as follows: 0: certification; 1: certification+account.","format":"int32"},"remoteIp":{"type":"string","description":"Remote IP of the VPN"},"networkType":{"type":"integer","description":"Network type should be a value as follows: 0: network list; 1: custom networks.","format":"int32"},"networkList":{"type":"array","description":"Network list of the VPN. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Network list of the VPN. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface."}},"customNetwork":{"type":"array","description":"Custom networks of the VPN.","items":{"$ref":"#/components/schemas/IPSubnetsVO"}},"preSharedKey":{"type":"string","description":"Pre-shared key of the VPN."},"wan":{"type":"array","description":"WAN list of the VPN. WAN port ID can be obtained from 'Get internet basic info' interface.","items":{"type":"string","description":"WAN list of the VPN. WAN port ID can be obtained from 'Get internet basic info' interface."}},"clientVpnType":{"type":"integer","description":"Client Vpn type should be a value as follows: 0: L2TP; 1: PPTP; 2: IPSec; 3: OpenVPN.","format":"int32"},"encryption":{"type":"integer","description":"Encryption should be a value as follows: 0: Encrypted; 1: Unencrypted.","format":"int32"},"ipPoolType":{"type":"integer","description":"IP pool type should be a value as follows: 0: Ip Address/Mask; 1: Ip Address Range.","format":"int32"},"ipPoolStart":{"type":"string","description":"The start IP of the IP pool."},"ipPoolEnd":{"type":"string","description":"The end IP of the IP pool."},"ipPool":{"$ref":"#/components/schemas/IPSubnetsVO"},"primaryDns":{"type":"string","description":"Primary DNS of the VPN."},"secondaryDns":{"type":"string","description":"Secondary DNS of the VPN."},"serviceType":{"type":"integer","description":"Service type of the VPN.","format":"int32"},"servicePort":{"type":"integer","description":"Service port should be within the range of 1–65535.","format":"int32"},"authMode":{"type":"integer","description":"Authentication mode should be a value as follows: 0: Local; 1: LDAP.","format":"int32"},"advancedSetting":{"$ref":"#/components/schemas/VpnAdvancedSettingOpenApiVO"}}},"ClientToSiteVpnClient":{"required":["clientVpnType","name","wan"],"type":"object","properties":{"id":{"type":"string","description":"ID of the VPN."},"name":{"pattern":"^[a-zA-Z0-9_]{1,63}$","type":"string","description":"Name should contain 1 to 63 characters."},"status":{"type":"boolean","description":"Status of the VPN."},"mode":{"type":"integer","description":"Mode(only for server OpenVPN) should be a value as follows: 0: certification; 1: certification+account.","format":"int32"},"remoteSite":{"type":"string","description":"Remote site of the VPN."},"remoteIp":{"type":"string","description":"Remote IP of the VPN. Get whether supports domain from interface 'Get client-to-site VPN client list'."},"remoteSubnet":{"type":"array","description":"Remote subnet of the VPN.","items":{"$ref":"#/components/schemas/IPSubnetsVO"}},"networkType":{"type":"integer","description":"Network type should be a value as follows: 0: network list; 1: custom networks.","format":"int32"},"networkList":{"type":"array","description":"Network list of the VPN. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Network list of the VPN. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface."}},"customNetwork":{"type":"array","description":"Custom networks of the VPN.","items":{"$ref":"#/components/schemas/IPSubnetsVO"}},"preSharedKey":{"type":"string","description":"Pre-shared key of the VPN."},"wan":{"type":"array","description":"WAN list of the VPN. WAN port ID can be obtained from 'Get internet basic info' interface.","items":{"type":"string","description":"WAN list of the VPN. WAN port ID can be obtained from 'Get internet basic info' interface."}},"clientVpnType":{"type":"integer","description":"Client Vpn type should be a value as follows: 0: L2TP; 1: PPTP; 2: IPSec; 3: OpenVPN.","format":"int32"},"openVpnTunnelMode":{"type":"integer","description":"OpenVPN tunnel mode should be a value as follows: 0: split; 1: full.","format":"int32"},"openVpnMode":{"type":"integer","description":"OpenVPN mode should be a value as follows: 0: certification; 1: certification+account.","format":"int32"},"serviceType":{"type":"integer","description":"Service type should be a value as follows: 0: UDP; 1: TCP.","format":"int32"},"servicePort":{"type":"integer","description":"Service port should be within the range of 1–65535.","format":"int32"},"encryption":{"type":"integer","description":"Encryption should be a value as follows: 0: Encrypted; 1: Unencrypted.","format":"int32"},"workingMode":{"type":"integer","description":"Working mode should be a value as follows: 0: NAT; 1: Routing.","format":"int32"},"clientUserName":{"maxLength":64,"minLength":1,"type":"string","description":"Client username should contain 1 to 64 characters."},"clientPassword":{"maxLength":64,"minLength":1,"type":"string","description":"Client password should contain 1 to 64 characters."},"vpnConfiguration":{"$ref":"#/components/schemas/VpnCertificateOpenApiVO"}}},"VpnValueAvailableVO":{"required":["type"],"type":"object","properties":{"type":{"type":"integer","description":"Parameter [type] should be a value as follows: 0, name; 1, port.","format":"int32"},"usage":{"type":"integer","description":"Parameter [usage] should not be null when [type] is name. Parameter [usage] should be a value as follows: 0, server; 1, client; 2: site-to-site.","format":"int32"},"name":{"pattern":"^[a-zA-Z0-9_]{1,63}$","type":"string","description":"VPN name. Parameter [name] should not be null when [type] is name."},"port":{"type":"integer","description":"Parameter [port] should not be null when [type] is port.","format":"int32"},"vpnType":{"type":"integer","description":"Vpn type should be a value as follows: 0: L2TP; 1: PPTP; 2: IPSec; 3: OpenVPN; 4: WireGuard; 5: SSL VPN.","format":"int32"},"wan":{"type":"string","description":"WAN of the VPN."},"serviceType":{"type":"integer","description":"Service type of the Open VPN should be a value as follows: 0: UDP; 1: TCP.","format":"int32"},"id":{"type":"string","description":"VPN ID."}}},"BatchSelectVpnVO":{"type":"object","properties":{"ids":{"type":"array","description":"ID list of batch selected VPNs.","items":{"type":"string","description":"ID list of batch selected VPNs."}},"searchKey":{"type":"string","description":"The keywords of the searchIt is effected when [selectAll] is 'true'."},"selectAll":{"type":"boolean","description":"Indicates whether to select all VPNs for deletion. The behavior depends on the combination with 'ids': 1: If selectAll is true and ids is not empty: perform a reverse selection (excluding the specified IDs). 2: If selectAll is true and ids is empty: select all VPNs. 3: If selectAll is false and ids is not empty: select only the specified VPNs in the ID list."},"usage":{"type":"integer","description":"Parameter [usage] should be a value as follows: 0, Server; 1, Client; 2, Site-To-Site.","format":"int32"}}},"OperationResponseVpnListUsedFunctionOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VpnListUsedFunctionOpenApiVO"}}},"VpnListUsedFunctionOpenApiVO":{"type":"object","properties":{"vpnList":{"type":"array","description":"List of VPNs that have used the function.","items":{"$ref":"#/components/schemas/VpnUsedFunctionOpenApiVO"}}}},"VpnUsedFunctionOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"ID of the VPN."},"name":{"type":"string","description":"VPN name."},"functions":{"type":"array","description":"List of functions used by VPN.","items":{"type":"string","description":"List of functions used by VPN."}}},"description":"List of VPNs that have used the function."},"AP Info":{"type":"object","properties":{"wiredUpLink":{"$ref":"#/components/schemas/Wired Up Link Info"},"wirelessUpLink":{"$ref":"#/components/schemas/Wireless Up Link Info"}},"description":"AP info, exists when deviceType is 0."},"AP Multi link info":{"type":"object","properties":{"radioId":{"type":"integer","description":"Radio ID should be a value as follows: 0: 2.4GHz; 1: 5GHz-1; 2:5GHz-2; 3: 6GHz.","format":"int32"},"channel":{"type":"integer","description":"(Wireless)  Actual channel.","format":"int32"},"rssi":{"type":"integer","description":"Signal strength, unit: dBm.","format":"int32"},"trafficDown":{"type":"integer","description":"Downstream traffic (Byte).","format":"int64"},"trafficUp":{"type":"integer","description":"Upstream traffic (Byte).","format":"int64"},"txRate":{"type":"integer","description":"Downlink negotiation rate (Kbit/s)","format":"int64"},"rxRate":{"type":"integer","description":"Uplink negotiation rate (Kbit/s)","format":"int64"}},"description":"Multi link info (MLO)"},"Client Node Info":{"type":"object","properties":{"mac":{"type":"string","description":"Client MAC Address."},"name":{"type":"string","description":"Client name."},"ip":{"type":"string","description":"Client IP."},"wireless":{"type":"boolean","description":"true: Wireless client;  false: Not wireless client"},"guest":{"type":"boolean","description":"(Wireless) Whether it is Guest (used to display the wireless Guest client icon)."},"clientType":{"type":"string","description":"Client Type: iphone, ipod, android, pc, printer, tv..."},"upDeviceType":{"type":"integer","description":"Uplink device type, 0: AP; 1: Switch; 2: Gateway.","format":"int32"},"authStatus":{"type":"integer","description":"Authentication status should be a value as follows: <br/>0: CONNECTED // Access without any authentication method; <br/>1: PENDING // Access to Portal, but authentication failed; <br/>2: AUTHORIZED // Pass through portal, pass other authentication without portal; <br/>3: AUTH-FREE // No portal authentication required.","format":"int32"},"model":{"type":"string","description":"Model of client device."},"manager":{"type":"boolean","description":"Whether it is the device currently accessing the Controller itself."},"devTxRate":{"type":"integer","description":"Client real-time uploadRate","format":"int64"},"devRxRate":{"type":"integer","description":"Client real-time downloadRate","format":"int64"},"healthScore":{"type":"integer","description":"Health Score, 1~3: poor; 4~7: fair; 0: no data; 8~10 good.","format":"int32"},"upOswInfo":{"$ref":"#/components/schemas/Uplink Switch Info"},"upApInfo":{"$ref":"#/components/schemas/Uplink AP Info"},"downlinkNodes":{"type":"array","description":"Downlink nodes, exists when client is other gateway","items":{"$ref":"#/components/schemas/Device Node Info"}}},"description":"Client node info."},"Client Topology Nodes Info":{"type":"object","properties":{"nodeType":{"type":"integer","description":"Node type, 0: device; 1: client.","format":"int32"},"clientNode":{"$ref":"#/components/schemas/Client Node Info"},"deviceNode":{"$ref":"#/components/schemas/Device Node Info"},"client":{"type":"boolean"}}},"Device Node Info":{"type":"object","properties":{"deviceType":{"type":"integer","description":"Device type, 0: AP; 1: Switch; 2: Gateway.","format":"int32"},"name":{"type":"string","description":"Device name"},"mac":{"type":"string","description":"Device MAC"},"model":{"type":"string","description":"Device model name"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"showModel":{"type":"string","description":"Device model name with version"},"ip":{"type":"string","description":"Device IP"},"ipv6List":{"type":"array","description":"Device IPv6 list","items":{"type":"string","description":"Device IPv6 list"}},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected;1:Disconnected(Migrating);10:Provisioning;11:Configuring;12:Upgrading;13:Rebooting;14:Connected;15:Connected(Wireless);16:Connected(Migrating);17:Connected(Wireless,Migrating);20:Pending;21:Pending(Wireless);22:Adopting;23:Adopting(Wireless);24:Adopt Failed;25:Adopt Failed(Wireless);26:Managed By Others;27:Managed By Others(Wireless);30:Heartbeat Missed;31:Heartbeat Missed(Wireless);32:Heartbeat Missed(Migrating);33:Heartbeat Missed(Wireless,Migrating);40:Isolated;41:Isolated(Migrating);50:Slice Configuring","format":"int32"},"statusCategory":{"type":"integer","description":"Device status should be a value as follows: 0: Disconnected; 1: Connected; 2: Pending; 3: Heartbeat Missed; 4: Isolated","format":"int32"},"devTxRate":{"type":"integer","description":"Device real-time uploadRate","format":"int64"},"devRxRate":{"type":"integer","description":"Device real-time downloadRate","format":"int64"},"stackGroup":{"type":"boolean","description":"Stack Group"},"stackId":{"type":"string","description":"Stack Id"},"healthScore":{"type":"integer","description":"1~3: poor; 4~7: fair; 0: no data; 8~10 good.","format":"int32"},"apInfo":{"$ref":"#/components/schemas/AP Info"},"switchInfo":{"$ref":"#/components/schemas/Switch Info"},"gatewayInfo":{"$ref":"#/components/schemas/Gateway Info"},"ap":{"type":"boolean"},"osw":{"type":"boolean"},"osg":{"type":"boolean"}},"description":"Device Node info."},"Gateway Info":{"type":"object","properties":{"upPort":{"$ref":"#/components/schemas/WiredPortV3DTO"},"upLinkPort":{"$ref":"#/components/schemas/WiredPortV3DTO"},"linkSpeed":{"type":"integer","description":"LinkSpeed: 1:10Mbps, 2:100Mbps, 3:1000Mbps, 4:2.5Gbps, 5:10Gbps.","format":"int32"},"duplex":{"type":"integer","description":"Duplex: 1:Half, 2:Full.","format":"int32"},"rxDropPkts":{"type":"integer","description":"Rx Dropped Packets","format":"int64"},"txDropPkts":{"type":"integer","description":"Tx Dropped Packets","format":"int64"},"rxErrPkts":{"type":"integer","description":"Rx Error Packets","format":"int64"},"txErrPkts":{"type":"integer","description":"Tx Error Packets","format":"int64"}},"description":"Gateway info, exists when deviceType is 2."},"OperationResponseListClient Topology Nodes Info":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/Client Topology Nodes Info"}}}},"Switch Info":{"type":"object","properties":{"upPort":{"$ref":"#/components/schemas/WiredPortV3DTO"},"upLinkPort":{"$ref":"#/components/schemas/WiredPortV3DTO"},"linkSpeed":{"type":"integer","description":"LinkSpeed: 1:10Mbps, 2:100Mbps, 3:1000Mbps, 4:2.5Gbps, 5:10Gbps.","format":"int32"},"duplex":{"type":"integer","description":"Duplex: 1:Half, 2:Full.","format":"int32"},"rxDropPkts":{"type":"integer","description":"Rx Dropped Packets","format":"int64"},"txDropPkts":{"type":"integer","description":"Tx Dropped Packets","format":"int64"},"rxErrPkts":{"type":"integer","description":"Rx Error Packets","format":"int64"},"txErrPkts":{"type":"integer","description":"Tx Error Packets","format":"int64"}},"description":"Switch info, exists when deviceType is 1."},"Uplink AP Info":{"type":"object","properties":{"port":{"type":"integer","description":"Client connected port.","format":"int32"},"name":{"type":"string","description":"Client connected port name."},"lagId":{"type":"integer","description":"Lag Id","format":"int32"},"channel":{"type":"integer","description":"Connected actual channel.","format":"int32"},"ssid":{"type":"string","description":"Connected SSID name."},"radio":{"type":"integer","description":"Radio ID, 0: 2.4GHz; 1: 5GHz-1; 2:5GHz-2; 3: 6GHz.","format":"int32"},"support5g2":{"type":"boolean","description":"Whether the AP support 5G2 radio."},"rssi":{"type":"integer","description":"Signal strength, unit: dBm.","format":"int32"},"trafficDown":{"type":"integer","description":"Downstream traffic (Byte).","format":"int64"},"trafficUp":{"type":"integer","description":"Upstream traffic (Byte).","format":"int64"},"txRate":{"type":"integer","description":"Downlink negotiation rate (Kbit/s)","format":"int64"},"rxRate":{"type":"integer","description":"Uplink negotiation rate (Kbit/s)","format":"int64"},"multiLink":{"type":"array","description":"Multi link info (MLO)","items":{"$ref":"#/components/schemas/AP Multi link info"}}},"description":"Uplink AP info, exists when parameter [upDeviceType] is 0."},"Uplink Switch Info":{"type":"object","properties":{"port":{"type":"integer","description":"Client connected port.","format":"int32"},"standardPort":{"type":"string","description":"Standard Port of Stack"},"lagId":{"type":"string","description":"Lag Id"},"linkSpeed":{"type":"integer","description":"Port link speed, 1: 10Mbps; 2: 100Mbps; 3: 1000Mbps; 4: 2.5Gbps; 5: 10Gbps.","format":"int32"},"duplex":{"type":"integer","description":"Duplex: 1:Half; 2:Full.","format":"int32"},"trafficDown":{"type":"integer","description":"Downstream traffic (Byte).","format":"int64"},"trafficUp":{"type":"integer","description":"Upstream traffic (Byte).","format":"int64"}},"description":"Uplink switch info, exists when parameter [upDeviceType] is 1."},"Wired Up Link Info":{"type":"object","properties":{"upPort":{"$ref":"#/components/schemas/WiredPortV3DTO"},"upLinkPort":{"$ref":"#/components/schemas/WiredPortV3DTO"},"linkSpeed":{"type":"integer","description":"Uplink port linkSpeed, linkSpeed should be a value as follows: 0: Auto; 1: 10M; 2: 100M; 3: 1000M; 4: 2500M; 5: 10G; 6: 5G; 7: 25G, 8: 100G.","format":"int32"},"duplex":{"type":"integer","description":"Duplex mode, should be a value as follows: 0: Auto; 1: Half; 2: Full.","format":"int32"},"rxDropPkts":{"type":"integer","description":"Rx Dropped Packets","format":"int64"},"txDropPkts":{"type":"integer","description":"Tx Dropped Packets","format":"int64"},"rxErrPkts":{"type":"integer","description":"Rx Error Packets","format":"int64"},"txErrPkts":{"type":"integer","description":"Tx Error Packets","format":"int64"}},"description":"Exists when connected to upper level device via wired connection"},"Wireless Up Link Info":{"type":"object","properties":{"txRate":{"type":"string","description":"Tx Rate"},"rxRate":{"type":"string","description":"Rx Rate"},"rssi":{"type":"integer","description":"Rssi","format":"int32"},"rssiPercent":{"type":"integer","description":"Rssi percent","format":"int32"},"rxDropPkts":{"type":"integer","description":"Rx Dropped Packets","format":"int64"},"txDropPkts":{"type":"integer","description":"Tx Dropped Packets","format":"int64"},"rxErrPkts":{"type":"integer","description":"Rx Error Packets","format":"int64"},"txErrPkts":{"type":"integer","description":"Tx Error Packets","format":"int64"},"snr":{"type":"integer","description":"Wireless P2P Ap Snr","format":"int32"}},"description":"Exists when connected to upper level device via wireless connection"},"Client Stat Query":{"required":["endSec","startSec"],"type":"object","properties":{"startSec":{"type":"integer","description":"Start timestamp, unit: second.","format":"int64"},"endSec":{"type":"integer","description":"End timestamp, unit: second.","format":"int64"}}},"Client Multi Link Info":{"type":"object","properties":{"radioId":{"type":"integer","description":"(Wireless) Radio ID should be a value as follows: 0: 2.4GHz; 1: 5GHz; 2:5GHz-2; 3: 6GHz","format":"int32"},"signal":{"type":"integer","description":"(Wireless) Signal strength, unit: dBm.","format":"int32"}},"description":"(MLO) Client multi link info."},"Client Statistical Data Detail":{"type":"object","properties":{"mac":{"type":"string","description":"Client MAC Address."},"wireless":{"type":"boolean","description":"true: Wireless client;  false: Not wireless client"},"time":{"type":"integer","description":"The statistical data collected timestamp, unit: second.","format":"int64"},"down":{"type":"integer","description":"Downstream traffic (Byte).","format":"int64"},"up":{"type":"integer","description":"Upstream traffic (Byte).","format":"int64"},"downRate":{"type":"integer","description":"Downlink rate (Byte/s).","format":"int64"},"upRate":{"type":"integer","description":"Uplink rate (Byte/s).","format":"int64"},"txR":{"type":"integer","description":"(Wireless) Downlink negotiation rate (bit/s).","format":"int64"},"rxR":{"type":"integer","description":"(Wireless) Uplink negotiation rate (bit/s).","format":"int64"},"signal":{"type":"integer","description":"(Wireless) Signal strength, unit: dBm.","format":"int32"},"radioId":{"type":"integer","description":"(Wireless) Radio ID should be a value as follows: 0: 2.4GHz; 1: 5GHz; 2:5GHz-2; 3: 6GHz","format":"int32"},"txFP":{"type":"integer","description":"Number of downstream failed packets.","format":"int64"},"multiLinks":{"type":"array","description":"(MLO) Client multi link info.","items":{"$ref":"#/components/schemas/Client Multi Link Info"}}},"description":"Client Statistical Data Detail list."},"Client Statistical Data Detail Result":{"type":"object","properties":{"totalDown":{"type":"integer","description":"Client total downstream traffic (Byte).","format":"int64"},"totalUp":{"type":"integer","description":"Client total upstream traffic (Byte).","format":"int64"},"avgDownRate":{"type":"integer","description":"Average downlink rate (Byte/s).","format":"int64"},"avgUpRate":{"type":"integer","description":"Average uplink rate (Byte/s).","format":"int64"},"avgTxR":{"type":"integer","description":"(Wireless) Average downlink negotiation rate (bit/s).","format":"int64"},"avgRxR":{"type":"integer","description":"(Wireless) Average uplink negotiation rate (bit/s).","format":"int64"},"avgSignal":{"type":"object","additionalProperties":{"type":"integer","description":"(Wireless) Average signal on each channel, the key is radioId(0: 2.4GHz; 1: 5GHz-1; 2:5GHz-2; 3: 6GHz), the value is average signal(unit: dBm).","format":"int32"},"description":"(Wireless) Average signal on each channel, the key is radioId(0: 2.4GHz; 1: 5GHz-1; 2:5GHz-2; 3: 6GHz), the value is average signal(unit: dBm)."},"totalTxFP":{"type":"integer","description":"Total number of downstream failed packets.","format":"int64"},"stats":{"type":"array","description":"Client Statistical Data Detail list.","items":{"$ref":"#/components/schemas/Client Statistical Data Detail"}}}},"OperationResponseClient Statistical Data Detail Result":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Client Statistical Data Detail Result"}}},"BatchApplyOswNetworkOpenApi":{"required":["applyList"],"type":"object","properties":{"applyList":{"type":"array","description":"Batch config networks status.","items":{"$ref":"#/components/schemas/OswNetworkBaseOpenApi"}}}},"OswNetworkBaseOpenApi":{"required":["id","vlan"],"type":"object","properties":{"id":{"type":"string","description":"Network ID"},"vlan":{"type":"integer","description":"VLAN ID.","format":"int32"},"status":{"type":"boolean","description":"Enable status of the network vlan. Note: this field only takes effect when toggling switch status on the Interface list page and is ignored by other switch network edit APIs."}},"description":"Batch config networks status."},"OswIpSettingOpenApiVO":{"required":["mode"],"type":"object","properties":{"mode":{"type":"integer","description":"IP Setting mode. Static:0, DHCP:1","format":"int32"},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Static IP for mode 0, like 192.168.0.1"},"gateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Gateway, like 192.168.137.1"},"netmask":{"pattern":"(254|252|248|240|224|192|128).0.0.0|255.(254|252|248|240|224|192|128|0).0.0|255.255.(254|252|248|240|224|192|128|0).0|255.255.255.(254|252|248|240|224|192|128|0)","type":"string","description":"IP Mask, like 255.255.255.0"},"preDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Primary DNS Server, like 127.0.0.1"},"secDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Second DNS Server, link 127.0.0.1"},"fallback":{"type":"boolean","description":"The switch of fallback ip for mode 1."},"fallbackIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Fallback ip for dhcp mode when fallback is enabled."},"fallbackMask":{"pattern":"(254|252|248|240|224|192|128|0).0.0.0|255.(254|252|248|240|224|192|128|0).0.0|255.255.(254|252|248|240|224|192|128|0).0|255.255.255.(254|252|248|240|224|192|128|0)","type":"string","description":"Fallback mask for dhcp mode when fallback is enabled."},"fallbackGate":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Fallback gateway for dhcp mode when fallback is enabled."},"option12":{"type":"string","description":"option12"},"useFixedAddr":{"type":"boolean","description":"The switch of Address reservation for dhcp mode."},"netId":{"type":"string","description":"The LAN Network for Address reservation when useFixedAddr is enabled. Obtain the id from \"Get LAN network list\""},"dhcpIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The IP for Address reservation when useFixedAddr is enabled."},"serverType":{"type":"string","description":"The Type of DHCP Server for Address reservation when useFixedAddr is enabled."},"serverMac":{"type":"string","description":"The Mac of DHCP Server for Address reservation when useFixedAddr is enabled."},"serverStackId":{"type":"string","description":"The Stack ID of DHCP Server for Address reservation when useFixedAddr is enabled."},"confirmConflict":{"type":"boolean","description":"Enable IP-MAC Conflict Detection or not."}},"description":"Network IP setting."},"OswIpv6SettingOpenApiVO":{"required":["mode"],"type":"object","properties":{"mode":{"pattern":"dynamic|static","type":"string","description":"Ipv6Setting parameter [mode] should be \"dynamic\" or \"static\""},"dnsMode":{"type":"integer","description":"DNS mode for dynamic mode, 0: Get Dynamic DNS, 1: Use the Following DNS Addresses.","format":"int32"},"priDns":{"pattern":"(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\S*$)","type":"string","description":"Primary DNS, like 2001:4860:4860::8888"},"sndDns":{"pattern":"(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\S*$)","type":"string","description":"Second DNS, like 2001:4860:4860::8844"},"ipv6Addr":{"pattern":"(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\S*$)","type":"string","description":"IPv6 Address for static mode, like 2001:4860:4860::8888"},"prefixLen":{"type":"integer","description":"Prefix Length for static mode, which should be within the range of 1–128","format":"int32"}},"description":"Network IPV6 setting."},"OswNetworkOpenApi":{"required":["id","mode","mvlan","vlan"],"type":"object","properties":{"id":{"type":"string","description":"Network ID"},"vlan":{"type":"integer","description":"VLAN ID.","format":"int32"},"status":{"type":"boolean","description":"Enable status of the network vlan. Note: this field only takes effect when toggling switch status on the Interface list page and is ignored by other switch network edit APIs."},"mvlan":{"type":"boolean","description":"Indicate the vlan is management vlan or not."},"name":{"type":"string","description":"Switch network name."},"ip":{"$ref":"#/components/schemas/OswIpSettingOpenApiVO"},"ipv6Enable":{"type":"boolean","description":"Enable IPV6 or not."},"ipv6":{"$ref":"#/components/schemas/OswIpv6SettingOpenApiVO"},"mode":{"type":"integer","description":"DHCP mode. 0: None, mode 1: DHCP Server, mode 2: DHCP Relay","format":"int32"},"dhcpServer":{"$ref":"#/components/schemas/OswDhcpServerOpenApiVO"},"dhcpRelay":{"$ref":"#/components/schemas/OswDhcpRelayOpenApiVO"},"vrfId":{"type":"string","description":"VRF ID"},"mtu":{"type":"integer","description":"MTU, MTU value should be less than or equal to the jumbo value","format":"int32"}}},"OswPoeRecoverOpenApiVO":{"required":["ports"],"type":"object","properties":{"ports":{"type":"array","description":"Please select the ports to perform PoE recovery. For example, [1, 2, 3].","items":{"type":"integer","description":"Please select the ports to perform PoE recovery. For example, [1, 2, 3].","format":"int32"}}}},"OperationResponseOswPoeResultOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswPoeResultOpenApiVO"}}},"OswPoeResultOpenApiVO":{"type":"object","properties":{"process":{"type":"integer","description":"PoE recovery progress.","format":"int32"},"deviceResult":{"$ref":"#/components/schemas/PoeRecoverDeviceOpenApiVO"}}},"PoeRecoverDeviceOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device MAC address."},"status":{"type":"integer","description":"Device status: 0 - success, 1 - failed.","format":"int32"},"successPorts":{"type":"array","description":"List of ports that PoE recovery succeeded.","items":{"type":"string","description":"List of ports that PoE recovery succeeded."}},"failPorts":{"type":"object","additionalProperties":{"type":"string","description":"List of ports that PoE recovery failed."},"description":"List of ports that PoE recovery failed."},"selectPorts":{"type":"array","description":"The selected ports for poe recover.","items":{"type":"string","description":"The selected ports for poe recover."}}},"description":"PoE recovery result returned by devices."},"OperationResponseOswLoopbackInterfaceResultOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswLoopbackInterfaceResultOpenApiVO"}}},"OswLoopbackInterfaceResultOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Loopback interface ID"}}},"MultiOswPortSelectVO":{"required":["selectAll","switchList"],"type":"object","properties":{"switchList":{"type":"array","description":"Switches Port And Lag List","items":{"$ref":"#/components/schemas/OswPortLagListVO"}},"selectAll":{"type":"boolean","description":"Indicates whether select all switch ports.false: include selected switch ports and lags in Parameter [switchList], true: all switch ports and lags but exclude selected switch ports and lags in Parameter [switchList]."},"searchKey":{"type":"string","description":"The keywords of the searchIt is effected when [selectAll] is 'true'."},"filters":{"type":"object","additionalProperties":{"type":"object","description":"Filter conditions in the form of Map.It is effected when [selectAll] is 'true', filter key is the filter field and the value is the filter content.Filter fields include: [connectedStatus], [networkMode], [poeDisplayType], [linkSpeed], [duplex],[switchMac], [switchStatusCategory], [switchSupportPoe], [nativeNetworkId], [networkTagsSetting], [profileId], [operation], [tagIds]."},"description":"Filter conditions in the form of Map.It is effected when [selectAll] is 'true', filter key is the filter field and the value is the filter content.Filter fields include: [connectedStatus], [networkMode], [poeDisplayType], [linkSpeed], [duplex],[switchMac], [switchStatusCategory], [switchSupportPoe], [nativeNetworkId], [networkTagsSetting], [profileId], [operation], [tagIds]."}}},"OswPortLagListVO":{"required":["mac"],"type":"object","properties":{"mac":{"type":"string","description":"Switch Mac"},"portList":{"type":"array","description":"Port List","items":{"$ref":"#/components/schemas/OswStandPortVO"}},"lagList":{"type":"array","description":"LAG List","items":{"type":"integer","description":"LAG List","format":"int32"}},"stackId":{"type":"string","description":"Stack ID"},"unit":{"type":"integer","description":"Unit","format":"int32"}},"description":"Switches Port And Lag List"},"LagCapVO":{"type":"object","properties":{"lacpModSupport":{"type":"boolean","description":"Lacp Mod Support"},"lagHashAlgSupport":{"type":"boolean","description":"Lag Hash Algorithm Support"},"lagHashAlgs":{"type":"array","description":"Support Lag Hash Algorithms, 0: SRC_MAC; 1: DST_MAC; 2: SRC_MAC_DST_MAC; 3: SRC_IP; 4: DST_IP; 5: SRC_IP_DST_IP","items":{"type":"integer","description":"Support Lag Hash Algorithms, 0: SRC_MAC; 1: DST_MAC; 2: SRC_MAC_DST_MAC; 3: SRC_IP; 4: DST_IP; 5: SRC_IP_DST_IP","format":"int32"}}},"description":"Capability of lag"},"OperationResponseListOswDetailBatchSelectedVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/OswDetailBatchSelectedVO"}}}},"OswDetailBatchSelectedVO":{"type":"object","properties":{"type":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"mac":{"type":"string","description":"Device mac"},"name":{"type":"string","description":"Device name,default value is the mac address of device"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"compoundModel":{"type":"string","description":"Model complex used in the backend.Ap：model+(country)+modelVersion,  EAP225(EU) v3.0 Ap: specialModel+modelVersion, EAP225-Outdoor-1a20a950b8d950e8 v1.0  Gateway/Switch：model+modelVersion, Osg v3.0"},"showModel":{"type":"string","description":"Model complex shown in the front end.Ap：model+(country)+modelVersion,EAP225(EU) v3.0  Gateway/Switch：model+modelVersion,Osg v3.0"},"specialModel":{"type":"string","description":"Special device model,for example:EAP225-Outdoor-1a20a950b8d950e8"},"firmwareVersion":{"type":"string","description":"Version of firmware,for example:2.5.0 Build 20190118 Rel. 64821"},"version":{"type":"string","description":"Simplified version of firmware,for example:2.5.0"},"hwVersion":{"type":"string","description":"Version of hardware,for example 1.0"},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected;1:Disconnected(Migrating);10:Provisioning;11:Configuring;12:Upgrading;13:Rebooting;14:Connected;15:Connected(Wireless);16:Connected(Migrating);17:Connected(Wireless,Migrating);20:Pending;21:Pending(Wireless);22:Adopting;23:Adopting(Wireless);24:Adopt Failed;25:Adopt Failed(Wireless);26:Managed By Others;27:Managed By Others(Wireless);30:Heartbeat Missed;31:Heartbeat Missed(Wireless);32:Heartbeat Missed(Migrating);33:Heartbeat Missed(Wireless,Migrating);40:Isolated;41:Isolated(Migrating);50:Slice Configuring","format":"int32"},"statusCategory":{"type":"integer","description":"Category of device status,statusCategory should be a value as follows: 0:Disconnected;1:Connected;2:Pending;3:Heartbeat Missed;4:Isolated","format":"int32"},"es":{"type":"boolean","description":"Whether the switch is Agile Series Switch"},"site":{"type":"string","description":"Site of the device"},"siteName":{"type":"string","description":"Site name of the device"},"omadacId":{"type":"string","description":"OmadacId of the device"},"compatible":{"type":"integer","description":"Device firmware and controller compatibility type.Compatible should be a value as follows: 0:COMPATIBLE;1:HIGH_MAJOR_VER;2:LOW_MAJOR_VER;3:HIGH_MINOR_VER;4:LOW_MINOR_VER;7:HIGH_COMPONENT_VER;10:DEVICE_NOT_COMPATIBLE;11:HIGH_ADOPT_COMMPONENT;12:DEVICE_CATEGORY_NOT_COMPATIBLE;14:DEVICE_NOT_COMPATIBLE_IN_CLUSTER","format":"int32"},"supportAnomaly":{"type":"boolean","description":"Whether the device firmware support intelligent anomaly detection"},"supportLocatePort":{"type":"boolean","description":"Whether the device supports locating port"},"active":{"type":"boolean","description":"whether to active the device(cloud base exclusive)"},"licenseStatus":{"type":"integer","description":"License status(cloud base exclusive).LicenseStatus should be a value as follows: 0:unActive 1:Unbind 2:Expired 3:active","format":"int32"},"dueTime":{"type":"integer","description":"Expire timestamp of license(cloud base exclusive)","format":"int64"},"dueTimeLeft":{"type":"integer","description":"Milliseconds from the current moment to the expiration time(cloud base exclusive)","format":"int64"},"licenseId":{"type":"string","description":"License key on detail page of device(cloud base exclusive)"},"licenseUnbindingLimit":{"type":"integer","description":"Remaining unbind count for license on detail Page of device(cloud base exclusive)","format":"int32"},"initialUnbindingLimit":{"type":"integer","description":"Initial unbind count for license(cloud base exclusive)","format":"int32"},"category":{"type":"string","description":"Category of license"},"forgetId":{"type":"string","description":"Forget ID of device"},"sn":{"type":"string","description":"SN code of device"},"eost":{"type":"integer","description":"End of service time of device(CBC exclusive)","format":"int64"},"eos":{"type":"integer","description":"End of support time of device(CBC exclusive)","format":"int64"},"inWhitelist":{"type":"boolean","description":"Whether the device is in white list"},"location":{"$ref":"#/components/schemas/DeviceLocationDetailVO"},"addedInAdvanced":{"type":"boolean","description":"Whether the device is added in advanced."},"customId":{"type":"string","description":"Customer ID"},"customName":{"type":"string","description":"Customer name"},"moveSiteId":{"type":"string","description":"Record that the device is in a moveSite operation; if it is null, then it is not in the moveSite operation."},"remember":{"type":"boolean","description":"Whether to remember the device(deprecated)","deprecated":true},"rememberDevice":{"type":"integer","description":"Whether to remember the device.RememberDevice should be a value as follows: 0:off, 1:on, 2: follow site","format":"int32"},"description":{"type":"string","description":"Description of the device"},"disableHwReset":{"type":"boolean","description":"Whether to disable hardware reset"},"templateId":{"type":"string","description":"ID of the template bound to the device"},"templateName":{"type":"string","description":"Name of the template bound to the device"},"boundSiteTemplate":{"type":"boolean","description":"Whether the site where the device is located is bound to a site template"},"deviceTemplateAvailable":{"type":"boolean","description":"Whether there is an available device template for the device; it is false if the model is not supported or the site template has not created the corresponding device template."},"boundDeviceTemplate":{"type":"boolean","description":"Whether the device is bound to device template"},"siteTemplateName":{"type":"string","description":"Template name bound to the site"},"siteTemplateId":{"type":"string","description":"Template ID bound to the site"},"deviceSeriesType":{"type":"integer","description":"Device series type.DeviceSeriesType should be a value as follows: 0:advanced;1:pro","format":"int32"},"resource":{"type":"integer","description":"Data source.Resource should be a value as follows: 0:new created;1:from template;2:override","format":"int32"},"ecspFirstVersion":{"type":"integer","description":"Ecsp first version","format":"int32"},"latestVersion":{"type":"string","description":"Latest firmware version"},"replaceDeviceInfo":{"$ref":"#/components/schemas/DeviceReplaceSettingVO"},"deviceMisc":{"$ref":"#/components/schemas/OswDeviceMiscVO"},"devCap":{"$ref":"#/components/schemas/OswDevCapVO"},"ports":{"type":"array","description":"Port List","items":{"$ref":"#/components/schemas/OswPortVO"}},"lags":{"type":"array","description":"Lag List","items":{"$ref":"#/components/schemas/OswLagVO"}},"uplink":{"$ref":"#/components/schemas/OswUplinkVO"},"unit":{"type":"integer","description":"Unit ID","format":"int32"},"stackPorts":{"type":"array","description":"Stack Port List","items":{"$ref":"#/components/schemas/OswStackPortGroupVO"}},"stackMsg":{"$ref":"#/components/schemas/StackMsgVO"}}},"OswDevCapVO":{"type":"object","properties":{"maxMirrorGroup":{"type":"integer","description":"Max Mirror Group","format":"int32"},"maxMirroredPort":{"type":"integer","description":"Max Mirrored Port","format":"int32"},"maxLagNum":{"type":"integer","description":"Max Lag Num","format":"int32"},"maxLagMember":{"type":"integer","description":"Max Lacp Member","format":"int32"},"poePortNum":{"type":"integer","description":"Poe Port Num","format":"int32"},"mstpInsNum":{"type":"integer","description":"Mstp Instance Num","format":"int32"},"mstpInsNo":{"type":"integer","description":"Mstp Max InstanceId","format":"int32"},"rpvstInsNum":{"type":"integer","description":"Max Rpvst Instance Num","format":"int32"},"vlanIfNum":{"type":"integer","description":"Vlan Interface Num","format":"int32"},"poeSupport":{"type":"boolean","description":"Poe Support"},"supportFan":{"type":"boolean","description":"Support Fan"},"supportBt":{"type":"boolean","description":"Support Poe Bt"},"jumboSupport":{"type":"boolean","description":"Jumbo Support"},"jumboOddSupport":{"type":"boolean","description":"Jumbo Odd Support"},"supportMulticast":{"type":"boolean","description":"Whether support multicast"},"supportEsMulticast":{"type":"boolean","description":"Whether Agile Series Switch support multicast"},"supportDhcpSnoop":{"type":"boolean","description":"Whether support dhcp snoop"},"supportArpDetect":{"type":"boolean","description":"Whether support arp detect"},"supportImpb":{"type":"boolean","description":"Whether support impb"},"supportLayout":{"type":"boolean","description":"Whether the device supports reporting port layout information."},"lagCap":{"$ref":"#/components/schemas/LagCapVO"},"fecSupport":{"type":"boolean","description":"FEC Support"},"eeeSupport":{"type":"boolean","description":"eee Support"},"flowControlSupport":{"type":"boolean","description":"FlowControl Support"},"stormRateModeSupport":{"type":"boolean","description":"StormControl RateMode Support"},"igmpFastLeaveSupport":{"type":"boolean","description":"Igmp FastLeve Support"},"loopbackVlanBasedSupport":{"type":"boolean","description":"Loopback Detect Vlan Based Support"},"dhcpL2RelaySupport":{"type":"boolean","description":"Dhcp L2 Relay Support"},"ospfSupport":{"type":"boolean","description":"OSPF Support"},"ospfDeadIntervalSupport":{"type":"boolean","description":"OSPF Dead Interval Support "},"ospfAutoCostRefSupport":{"type":"boolean","description":"OSPF Process Auto-Cost Reference Bandwidth Support"},"ospfPassiveSupport":{"type":"boolean","description":"OSPF Interface Passive Support"},"loopbackInterfaceSupport":{"type":"boolean","description":"Loopback Interface Support"},"loopbackInterfaceCreateSupport":{"type":"boolean","description":"Loopback Interface Create Support"},"pmtudSupport":{"type":"boolean","description":"Path MTU Discovery Support"},"mtuInVlanSupport":{"type":"boolean","description":"MTU In VLAN Support"},"qosSupport":{"type":"boolean","description":"QoS Support"},"esQosSupport":{"type":"boolean","description":"Agile Series Switch QoS Support"},"qosForVlanSupport":{"type":"boolean","description":"Qos for Vlan Support"},"ddmSupport":{"type":"boolean","description":"DDM Support"},"ipcDetectSupport":{"type":"boolean","description":"IPC Detect Support"},"customDhcpOptionSupport":{"type":"boolean","description":"Custom DHCP Option Support"},"voiceNetworkSupport":{"type":"boolean","description":"Voice Network Support"},"voiceDscpSupport":{"type":"boolean","description":"Voice DSCP Support"},"snmpSupport":{"type":"boolean","description":"SNMP Support"},"sfpBeginNum":{"type":"integer","description":"SFP Begin Num","format":"int32"},"sfpNum":{"type":"integer","description":"SFP Num","format":"int32"},"vrrpSupport":{"type":"boolean","description":"Vrrp Support"},"stpSupport":{"type":"boolean","description":"STP Support"},"stpExtendSupport":{"type":"boolean","description":"STP Extend Support"},"esStpExtendSupport":{"type":"boolean","description":"ES STP Extend Support"},"rpvstExtendSupport":{"type":"boolean","description":"RPVST Extend Support"},"mstpPortSupport":{"type":"boolean","description":"MSTP Port Support"},"mstpGetActiveSupport":{"type":"boolean","description":"MSTP Get Active Support"},"mirrorSupport":{"type":"boolean","description":"Mirror Support"},"uplinkSupport":{"type":"boolean","description":"Uplink Support"},"gponSupport":{"type":"boolean","description":"Gpon Support"},"networkCheckSupport":{"type":"boolean","description":"Network Check Support"},"pingSupport":{"type":"boolean","description":"Ping Support"},"tracerouteSupport":{"type":"boolean","description":"Traceroute Support"},"dnsLoopUpSupport":{"type":"boolean","description":"DNS Loop Up Support"},"arpTableSupport":{"type":"boolean","description":"Arp Table Support"},"packetCaptureSupport":{"type":"boolean","description":"Packet Capture Support"},"terminalSupport":{"type":"boolean","description":"Terminal Support"},"cableTestSupport":{"type":"boolean","description":"Cable Test Support"},"domainPingSupport":{"type":"boolean","description":"Domain Ping Support"},"domainTraceRouteSupport":{"type":"boolean","description":"Domain Trace Route Support"},"dhcpRangeSupport":{"type":"boolean","description":"Whether the device supports DHCP server address pool"},"dhcpReservationSupport":{"type":"boolean","description":"Whether the device supports DHCP reservation"},"supportGetDhcpClientTable":{"type":"boolean","description":"Whether the device supports getting DHCP client table via get message"},"supportGetDhcpServerInfo":{"type":"boolean","description":"Whether the device supports getting DHCP server info via get message"},"supportGetVlanIfInfo":{"type":"boolean","description":"Whether the device supports getting VLAN interface info via get message"},"dhcpServerPoolNum":{"type":"integer","description":"DHCP Server Pool Num","format":"int32"},"dhcpRelayIfNum":{"type":"integer","description":"DHCP Relay Interface Num","format":"int32"},"dhcpManualBindNum":{"type":"integer","description":"DHCP Manual Bind Num","format":"int32"},"ipv4StaticRouteNum":{"type":"integer","description":"IPv4 Static Route Num","format":"int32"},"ipv6StaticRouteNum":{"type":"integer","description":"IPv6 Static Route Num","format":"int32"},"staticRouteNum":{"type":"integer","description":"Static Route Num","format":"int32"},"supportEsHealth":{"type":"boolean","description":"Whether the device supports ES health check"},"supportRelayMultiServer":{"type":"boolean","description":"Whether the device supports DHCP relay multi Server"},"supportTpclResInfo":{"type":"boolean","description":"Whether the device supports returning TPCL resource information"},"maxRelayServerNum":{"type":"integer","description":"Max DHCP relay server num","format":"int32"},"ouiBasedVlanSupport":{"type":"boolean","description":"Oui Based Vlan Support"},"ouiBasedVlanESSupport":{"type":"boolean","description":"Oui Based Vlan Support"},"locatePortSupport":{"type":"boolean","description":"Locate port Support"},"supportClearCounters":{"type":"boolean","description":"Whether the device supports clear counters"},"cliSupport":{"type":"boolean","description":"CLI Support"},"supportConfigSync":{"type":"boolean","description":"Whether the device supports config sync"},"supportRunningConfig":{"type":"boolean","description":"Whether the device supports showing running config"},"needFullSync":{"type":"boolean","description":"Need full sync"},"maxStackGroupNumber":{"type":"integer","description":"Max Stack Group Number","format":"int32"},"maxStackUnitNumber":{"type":"integer","description":"Max Stack Unit Number","format":"int32"},"stkableGroupId":{"type":"integer","description":"Stackable Group ID","format":"int32"},"stkVer":{"type":"string","description":"Stack Version"},"vrfNum":{"type":"integer","description":"VRF Num","format":"int32"},"mlagGroupId":{"type":"integer","description":"MLAG Group ID","format":"int32"},"mlagVersion":{"type":"string","description":"MLAG Version"},"supportVrf":{"type":"boolean","description":"Whether the device supports VRF"},"supportSdm":{"type":"boolean","description":"Whether the device supports SDM"},"supportMlag":{"type":"boolean","description":"Whether the device supports MLAG"},"supportMad":{"type":"boolean","description":"Whether the device supports MAD"},"stackPortCap":{"type":"object","additionalProperties":{"type":"array","description":"Stack Port Capability","items":{"type":"string","description":"Stack Port Capability"}},"description":"Stack Port Capability"},"supportGetOspfNeighborTable":{"type":"boolean","description":"Whether the device supports getting OSPF neighbor table via get message"}},"description":"Capability of device"},"ClearCountersVO":{"required":["portList"],"type":"object","properties":{"portList":{"maxItems":2147483647,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/PortParamVO"}}}},"PortParamVO":{"required":["port","switchMac"],"type":"object","properties":{"port":{"type":"integer","format":"int32"},"switchMac":{"type":"string"}}},"OperationResponseString":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"string"}}},"OperationResponseListSelectedOswBriefVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/SelectedOswBriefVO"}}}},"OswStackDataVO":{"type":"object","properties":{"stackId":{"type":"string"},"stackName":{"type":"string"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"showModel":{"type":"string","description":"Model complex shown in the front end.Ap：model+(country)+modelVersion,EAP225(EU) v3.0  Gateway/Switch：model+modelVersion,Osg v3.0"},"masterMac":{"type":"string"},"unSelectedablePorts":{"type":"array","description":"The unSelectedable ports of the device.","items":{"$ref":"#/components/schemas/PortVO"}},"stackStatus":{"type":"integer","format":"int32"},"abnormalReason":{"type":"integer","format":"int32"},"member":{"type":"array","items":{"type":"object"}},"lags":{"type":"array","items":{"$ref":"#/components/schemas/OswLagStatusVO"}},"supportCustomDhcpOption":{"type":"boolean"},"supportDhcpRange":{"type":"boolean"},"supportVrf":{"type":"boolean"},"supportAutoAddVlan":{"type":"boolean"},"devCap":{"$ref":"#/components/schemas/OswDevCapVO"},"customStandardPorts":{"type":"array","description":"The standard ports that has some vlan not included in port vlan.","items":{"type":"string","description":"The standard ports that has some vlan not included in port vlan."}},"customLagIds":{"type":"array","description":"The lag ids that has some vlan not included in port vlan.","items":{"type":"integer","description":"The lag ids that has some vlan not included in port vlan.","format":"int32"}},"supportLayout":{"type":"boolean","description":"Whether the device supports reporting port layout information."}},"description":"oswStackData"},"SelectedOswBriefVO":{"type":"object","properties":{"name":{"type":"string","description":"Switch name."},"mac":{"type":"string","description":"Switch mac address."},"model":{"type":"string","description":"Switch model."},"modelVersion":{"type":"string","description":"Switch model version."},"showModel":{"type":"string","description":"Switch show model."},"statusCategory":{"type":"integer","description":"Switch status category.","format":"int32"},"status":{"type":"integer","description":"Switch status.","format":"int32"},"stackDevice":{"type":"boolean","description":"Indicate whether this device is a stacked device."},"devCap":{"$ref":"#/components/schemas/OswDevCapVO"},"ports":{"type":"array","description":"Switch port List.","items":{"$ref":"#/components/schemas/OswPortVO"}},"lags":{"type":"array","description":"Switch lag List.","items":{"$ref":"#/components/schemas/OswLagVO"}},"oswStackData":{"$ref":"#/components/schemas/OswStackDataVO"}}},"DeviceClientStatQueryOpenApiVO":{"required":["attrs","end","start"],"type":"object","properties":{"start":{"type":"integer","description":"Start timestamp, in seconds, such as 1682000000","format":"int64"},"end":{"type":"integer","description":"End timestamp, in seconds, such as 1682000000","format":"int64"},"attrs":{"type":"array","description":"Attribute list to get.","items":{"type":"string","description":"Attribute list to get."}}}},"DeviceClientStatVO":{"type":"object","properties":{"clients":{"type":"integer","format":"int32"},"time":{"type":"integer","format":"int64"}}},"OperationResponseListDeviceClientStatVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/DeviceClientStatVO"}}}},"OswStatQueryOpenApiDTO":{"required":["attrs","end","start"],"type":"object","properties":{"start":{"type":"integer","description":"Start time, number of seconds from UTC0 1970/01/01","format":"int64"},"end":{"type":"integer","description":"End time, number of seconds from UTC0 1970/01/01","format":"int64"},"attrs":{"type":"array","description":"Attributes to be queried. Attributes not included in attrs will return a value of 0. Item of attrs should be a value as follows: mem, cpu, tx, rx, txRate, rxRate, txPkts, rxPkts, txBroadPkts, rxBroadPkts, txMultiPkts, rxMultiPkts, dropPkts, txErrPkts, rxErrPkts","items":{"type":"string","description":"Attributes to be queried. Attributes not included in attrs will return a value of 0. Item of attrs should be a value as follows: mem, cpu, tx, rx, txRate, rxRate, txPkts, rxPkts, txBroadPkts, rxBroadPkts, txMultiPkts, rxMultiPkts, dropPkts, txErrPkts, rxErrPkts"}},"ports":{"type":"array","description":"Statistics of the selected ports of Switch would be queried.","items":{"type":"integer","description":"Statistics of the selected ports of Switch would be queried.","format":"int32"}}}},"OperationResponseOswStatOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswStatOpenApiVO"}}},"OswPortStatOpenApiVO":{"type":"object","properties":{"port":{"type":"integer","description":"Port of Switch","format":"int32"},"tx":{"type":"integer","description":"Transmit traffic of the port, in bytes","format":"int64"},"rx":{"type":"integer","description":"Receive traffic of the port, in bytes","format":"int64"},"txRate":{"type":"integer","description":"Transmit rate, byte/s","format":"int64"},"rxRate":{"type":"integer","description":"Receive rate, byte/s","format":"int64"},"txPkts":{"type":"integer","description":"Transmit packets of the port","format":"int64"},"rxPkts":{"type":"integer","description":"Receive receive packets of the port","format":"int64"},"txBroadPkts":{"type":"integer","description":"Transmit broadcast packets","format":"int64"},"rxBroadPkts":{"type":"integer","description":"Receive broadcast packets","format":"int64"},"txMultiPkts":{"type":"integer","description":"Transmit multicast packets","format":"int64"},"rxMultiPkts":{"type":"integer","description":"Receive multicast packets","format":"int64"},"dropPkts":{"type":"integer","description":"Drop packets","format":"int64"},"txErrPkts":{"type":"integer","description":"Transmit error packets","format":"int64"},"rxErrPkts":{"type":"integer","description":"Receive error packets","format":"int64"}},"description":"Traffic information of ports"},"OswStatDetailOpenApiVO":{"type":"object","properties":{"time":{"type":"integer","description":"sampling moment","format":"int64"},"cpu":{"type":"integer","description":"Utilization of cpu","format":"int32"},"mem":{"type":"integer","description":"Utilization of memory","format":"int32"},"ports":{"type":"array","description":"Traffic information of ports","items":{"$ref":"#/components/schemas/OswPortStatOpenApiVO"}}},"description":"Detailed traffic information of ports"},"OswStatOpenApiVO":{"type":"object","properties":{"portMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/PortStatVO"},"description":"Port total traffic map"},"statList":{"type":"array","description":"Detailed traffic information of ports","items":{"$ref":"#/components/schemas/OswStatDetailOpenApiVO"}},"switchType":{"type":"integer","description":"Type of Switch should be a value as follows: 0:Non-Agile Series Switch, 1:Agile Series Switch","format":"int32"}}},"PortStatVO":{"type":"object","properties":{"rx":{"type":"integer","description":"Total receive traffic of the port, in bytes","format":"int64"},"tx":{"type":"integer","description":"Total transmit traffic of the port, in bytes","format":"int64"},"all":{"type":"integer","description":"Total traffic of the port, in bytes","format":"int64"}},"description":"Port total traffic map"},"OswStackStatQueryVO":{"required":["attrs","end","interval","start"],"type":"object","properties":{"start":{"type":"integer","description":"Start time, number of seconds from UTC0 1970/01/01","format":"int64"},"end":{"type":"integer","description":"End time, number of seconds from UTC0 1970/01/01","format":"int64"},"attrs":{"type":"array","description":"Attributes to be queried. Attributes not included in attrs will return a value of 0.Item of attrs should be a value as follows: mem, cpu, tx, rx, txRate, rxRate, txPkts, rxPkts, txBroadPkts, rxBroadPkts, txMultiPkts, rxMultiPkts, dropPkts, txErrPkts, rxErrPkts","items":{"type":"string","description":"Attributes to be queried. Attributes not included in attrs will return a value of 0.Item of attrs should be a value as follows: mem, cpu, tx, rx, txRate, rxRate, txPkts, rxPkts, txBroadPkts, rxBroadPkts, txMultiPkts, rxMultiPkts, dropPkts, txErrPkts, rxErrPkts"}},"interval":{"type":"integer","description":"Interval should be a value as follows: 0:5min, 1:hourly, 2:daily","format":"int32"}}},"OperationResponseListOswStackDetailStatVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/OswStackDetailStatVO"}}}},"OswStackDetailIntPropertyDTO":{"type":"object","properties":{"unit":{"type":"integer","description":"Unit ID","format":"int32"},"value":{"type":"integer","description":"Value","format":"int32"}},"description":"Memory Utilization information"},"OswStackDetailLongPropertyDTO":{"type":"object","properties":{"unit":{"type":"integer","description":"Unit ID","format":"int32"},"value":{"type":"integer","description":"Value","format":"int64"}},"description":"Receive error packets information"},"OswStackDetailStatVO":{"type":"object","properties":{"time":{"type":"integer","description":"Time","format":"int64"},"cpu":{"type":"array","description":"Cpu Utilization information","items":{"$ref":"#/components/schemas/OswStackDetailIntPropertyDTO"}},"mem":{"type":"array","description":"Memory Utilization information","items":{"$ref":"#/components/schemas/OswStackDetailIntPropertyDTO"}},"dropPkts":{"type":"array","description":"Drop Packets information","items":{"$ref":"#/components/schemas/OswStackDetailLongPropertyDTO"}},"txErrPkts":{"type":"array","description":"Transmit error packets information","items":{"$ref":"#/components/schemas/OswStackDetailLongPropertyDTO"}},"rxErrPkts":{"type":"array","description":"Receive error packets information","items":{"$ref":"#/components/schemas/OswStackDetailLongPropertyDTO"}}}},"OswStackStatQueryOpenApiDTO":{"required":["attrs","end","start"],"type":"object","properties":{"start":{"type":"integer","description":"Start time, number of seconds from UTC0 1970/01/01","format":"int64"},"end":{"type":"integer","description":"End time, number of seconds from UTC0 1970/01/01","format":"int64"},"attrs":{"type":"array","description":"Attributes to be queried. Attributes not included in attrs will return a value of 0. Item of attrs should be a value as follows: mem, cpu, tx, rx, txRate, rxRate, txPkts, rxPkts, txBroadPkts, rxBroadPkts, txMultiPkts, rxMultiPkts, dropPkts, txErrPkts, rxErrPkts","items":{"type":"string","description":"Attributes to be queried. Attributes not included in attrs will return a value of 0. Item of attrs should be a value as follows: mem, cpu, tx, rx, txRate, rxRate, txPkts, rxPkts, txBroadPkts, rxBroadPkts, txMultiPkts, rxMultiPkts, dropPkts, txErrPkts, rxErrPkts"}},"standardPorts":{"type":"array","description":"Statistics of the selected ports of Stack would be queried.","items":{"type":"string","description":"Statistics of the selected ports of Stack would be queried."}}}},"OperationResponseListOswStackMemberStatVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/OswStackMemberStatVO"}}}},"OswPortStatDTO":{"type":"object","properties":{"port":{"type":"integer","format":"int32"},"standardPort":{"type":"string"},"tx":{"type":"integer","format":"int64"},"rx":{"type":"integer","format":"int64"},"txRate":{"type":"integer","format":"int64"},"rxRate":{"type":"integer","format":"int64"},"txPkts":{"type":"integer","format":"int64"},"rxPkts":{"type":"integer","format":"int64"},"txBroadPkts":{"type":"integer","format":"int64"},"rxBroadPkts":{"type":"integer","format":"int64"},"txMultiPkts":{"type":"integer","format":"int64"},"rxMultiPkts":{"type":"integer","format":"int64"},"dropPkts":{"type":"integer","format":"int64"},"txErrPkts":{"type":"integer","format":"int64"},"rxErrPkts":{"type":"integer","format":"int64"},"linkDownCnt":{"type":"integer","format":"int32"}}},"OswStackMemberStatVO":{"type":"object","properties":{"unit":{"type":"integer","description":"Unit ID","format":"int32"},"mac":{"type":"string","description":"Device mac"},"portMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/PortStatVO"},"description":"Port total traffic map"},"statList":{"type":"array","description":"Detailed traffic information of ports","items":{"$ref":"#/components/schemas/OswStatDTO"}}}},"OswStatDTO":{"type":"object","properties":{"time":{"type":"integer","description":"sampling moment","format":"int64"},"cpu":{"type":"integer","description":"Utilization of cpu","format":"int32"},"mem":{"type":"integer","description":"Utilization of memory","format":"int32"},"rebootTimes":{"type":"integer","description":"reboot times","format":"int32"},"mac":{"type":"string","description":"the mac of the device"},"ports":{"type":"array","items":{"$ref":"#/components/schemas/OswPortStatDTO"}},"poeUtil":{"type":"integer","format":"int32"},"poePower":{"type":"integer","format":"int32"}},"description":"Detailed traffic information of ports"},"OltStatQueryOpenApiDTO":{"required":["attrs","end","start"],"type":"object","properties":{"start":{"type":"integer","description":"Start time, number of seconds from UTC0 1970/01/01","format":"int64"},"end":{"type":"integer","description":"End time, number of seconds from UTC0 1970/01/01","format":"int64"},"attrs":{"type":"array","description":"Attributes to be queried. Attributes not included in attrs will return a value of 0.Item of attrs should be a value as follows: mem, cpu, up, down, onuCount, tx, rx, txRate, rxRate, txPackets, rxPackets, txBroadcastPackets, rxBroadcastPackets, txMulticastPackets, rxMulticastPackets","items":{"type":"string","description":"Attributes to be queried. Attributes not included in attrs will return a value of 0.Item of attrs should be a value as follows: mem, cpu, up, down, onuCount, tx, rx, txRate, rxRate, txPackets, rxPackets, txBroadcastPackets, rxBroadcastPackets, txMulticastPackets, rxMulticastPackets"}},"oltPorts":{"type":"array","description":"Statistics of the selected ports of Olt would be queried.","items":{"type":"string","description":"Statistics of the selected ports of Olt would be queried."}}}},"OltPortStatOpenApiVO":{"type":"object","properties":{"port":{"type":"string","description":"Port of OLT"},"tx":{"type":"integer","description":"Transmit traffic of the port, in bytes","format":"int64"},"rx":{"type":"integer","description":"Receive traffic of the port, in bytes","format":"int64"},"txPackets":{"type":"integer","description":"Transmit packets of the port","format":"int64"},"rxPackets":{"type":"integer","description":"Receive receive packets of the port","format":"int64"},"txBroadcastPackets":{"type":"integer","description":"Transmit broadcast packets","format":"int64"},"rxBroadcastPackets":{"type":"integer","description":"Receive broadcast packets","format":"int64"},"txMulticastPackets":{"type":"integer","description":"Transmit multicast packets","format":"int64"},"rxMulticastPackets":{"type":"integer","description":"Receive multicast packets","format":"int64"},"txRate":{"type":"number","description":"Transmit rate, byte/s","format":"double"},"rxRate":{"type":"number","description":"Receive rate, byte/s","format":"double"}},"description":"Traffic information of ports"},"OltStatDetailOpenApiVO":{"type":"object","properties":{"onuCount":{"type":"integer","description":"Number of ONU","format":"int32"},"up":{"type":"integer","description":"Uplink traffic","format":"int64"},"down":{"type":"integer","description":"Downlink traffic","format":"int64"},"time":{"type":"integer","description":"sampling moment","format":"int64"},"cpu":{"type":"integer","description":"Utilization of cpu","format":"int32"},"mem":{"type":"integer","description":"Utilization of memory","format":"int32"},"ports":{"type":"array","description":"Traffic information of ports","items":{"$ref":"#/components/schemas/OltPortStatOpenApiVO"}}},"description":"Detailed traffic information of ports"},"OltStatOpenApiVO":{"type":"object","properties":{"portMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/PortStatVO"},"description":"Port total traffic map"},"statList":{"type":"array","description":"Detailed traffic information of ports","items":{"$ref":"#/components/schemas/OltStatDetailOpenApiVO"}}}},"OperationResponseOltStatOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OltStatOpenApiVO"}}},"DDMStatusRequestVO":{"type":"object","properties":{"portList":{"type":"array","description":"Port list of device","items":{"type":"string","description":"Port list of device"}}}},"DDMStatusResultVO":{"type":"object","properties":{"port":{"type":"string","description":"OLT optical ports, including Ethernet optical ports and PON ports."},"temperature":{"type":"string","description":"Temperature of the port optical module."},"temperature(Fahrenheit)":{"type":"number","description":"Temperature(Fahrenheit) of the port optical module.","format":"double"},"temperatureFlag":{"type":"integer","description":"Port optical module temperature alert information.","format":"int32"},"voltage":{"type":"string","description":"Port optical module voltage."},"voltageFlag":{"type":"integer","description":"Port optical module voltage alert information.","format":"int32"},"biasCurrent":{"type":"string","description":"Port optical module bias current."},"biasCurrentFlag":{"type":"integer","description":"Port optical module bias current alert information.","format":"int32"},"txPower(dbm)":{"type":"string","description":"Port optical module transmission power(dbm)."},"txPower(mW)":{"type":"number","description":"Port optical module transmission power(mW).","format":"double"},"txPowerFlag":{"type":"integer","description":"Port optical module transmission power alert information.","format":"int32"},"rxPower(dbm)":{"type":"string","description":"Port optical module received power(dbm)."},"rxPower(mW)":{"type":"number","description":"Port optical module received power(mW).","format":"double"},"rxPowerFlag":{"type":"integer","description":"Port optical module received power alert information.","format":"int32"},"transmitFault":{"type":"integer","description":"Weather the signal from the remote optical module is distorted","format":"int32"},"lossOfSignal":{"type":"boolean","description":"Whether the local optical module signal is distorted."},"dataReady":{"type":"boolean","description":"Whether the port optical module is in an available state."}}},"OperationResponseListDDMStatusResultVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/DDMStatusResultVO"}}}},"ClientTrafficFilterOpenApiVO":{"type":"object","properties":{"network":{"type":"string","description":"Network name"},"vlanId":{"type":"string","description":"VLAN ID. The VLAN ID range is 1–4096 or Untag."}},"description":"Client traffic filtering condition"},"ClientTrafficOpenApiQueryDataV2VO":{"required":["page","pageSize"],"type":"object","properties":{"page":{"type":"integer","description":"Start from 1.","format":"int32"},"pageSize":{"type":"integer","description":"It should be within the range of 1–100.","format":"int32"},"sorts":{"type":"object","additionalProperties":{"type":"string","description":"Sort rule, key: sort field, value: sort direction, value parameter may be one of asc or desc."},"description":"Sort rule, key: sort field, value: sort direction, value parameter may be one of asc or desc."},"filters":{"type":"object","additionalProperties":{"type":"object","description":"Filter [family] in the form of Map. When the value of the [family] key is empty, return an empty result."},"description":"Filter [family] in the form of Map. When the value of the [family] key is empty, return an empty result."},"start":{"type":"integer","description":"Start timestamp, in seconds, such as 1682000000","format":"int64"},"end":{"type":"integer","description":"End timestamp, in seconds, such as 1682000000","format":"int64"},"clientTrafficFilters":{"type":"array","description":"Client traffic filtering condition","items":{"$ref":"#/components/schemas/ClientTrafficFilterOpenApiVO"}}}},"ApplicationUpDownTrafficDetailOpenApiVO":{"type":"object","properties":{"up":{"type":"integer","description":"Up traffic.","format":"int64"},"down":{"type":"integer","description":"Down traffic.","format":"int64"},"upPacket":{"type":"integer","description":"Number of upstream packets","format":"int64"},"downPacket":{"type":"integer","description":"Number of downstream packets","format":"int64"},"applicationId":{"type":"integer","description":"Application ID.","format":"int32"},"applicationName":{"type":"string","description":"Application name, such as: Microsoft Bing, Baidu and Microsoft Services."}},"description":"Application uplink and downlink traffic data."},"CategoryUpDownTrafficDetailOpenApiVO":{"type":"object","properties":{"up":{"type":"integer","description":"Up traffic.","format":"int64"},"down":{"type":"integer","description":"Down traffic.","format":"int64"},"upPacket":{"type":"integer","description":"Number of upstream packets","format":"int64"},"downPacket":{"type":"integer","description":"Number of downstream packets","format":"int64"},"familyId":{"type":"integer","description":"Family ID.","format":"int32"},"familyName":{"type":"string","description":"Family name. Such as: Enterprise Services, Conference and Business."}},"description":"Application uplink and downlink categories."},"ClientTrafficGridVOClientUpDownTrafficDetailOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClientUpDownTrafficDetailOpenApiVO"}},"clientTrafficFilters":{"type":"array","items":{"$ref":"#/components/schemas/ClientTrafficFilterOpenApiVO"}}}},"ClientUpDownTrafficDetailOpenApiVO":{"type":"object","properties":{"clientMac":{"type":"string","description":"The mac of the client."},"clientName":{"type":"string","description":"The name of the client."},"type":{"type":"string","description":"Type of client."},"manager":{"type":"boolean","description":"Whether it is the client currently being managed."},"up":{"type":"integer","description":"Up traffic.","format":"int64"},"down":{"type":"integer","description":"Down traffic.","format":"int64"},"applications":{"type":"array","description":"Application uplink and downlink traffic data.","items":{"$ref":"#/components/schemas/ApplicationUpDownTrafficDetailOpenApiVO"}},"categories":{"type":"array","description":"Application uplink and downlink categories.","items":{"$ref":"#/components/schemas/CategoryUpDownTrafficDetailOpenApiVO"}},"network":{"type":"string","description":"Network name."},"vlanId":{"type":"string","description":"VLAN ID. The VLAN ID range is 1–4096 or Untag."}}},"OperationResponseClientTrafficGridVOClientUpDownTrafficDetailOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ClientTrafficGridVOClientUpDownTrafficDetailOpenApiVO"}}},"OswVrfVO":{"required":["ipv4Enable","ipv6Enable","vrf"],"type":"object","properties":{"id":{"type":"string","description":"VRF ID. This parameter is not required for creation or modification."},"vrf":{"pattern":"^(?!(\\.|\\.\\.)$)[a-zA-Z0-9.\\-_@+]{1,15}$","type":"string","description":"VRF name, it should be 1 to 15 characters consisting of numbers (0 to 9), uppercase and lowercase letters (A to Z, a to z), and symbols -_@.+ but cannot be . or .. only."},"ipv4Enable":{"type":"boolean","description":"Whether to enable ipv4. Ipv4Enable should be true"},"ipv6Enable":{"type":"boolean","description":"Whether to enable ipv6"}}},"DeviceRememberConfig":{"type":"object","properties":{"remember":{"type":"integer","description":"The remember configuration of the device, 0 means disable, 1 means enable, 2 means follow site.","format":"int32"}}},"BatchStackPortSettingOpenApiVO":{"required":["unitList"],"type":"object","properties":{"unitList":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Unit List","items":{"$ref":"#/components/schemas/OswStackUnitVO"}},"name":{"pattern":"^[^ ?\"]$|^[^ ?\"][^?\"]{0,126}[^ ?\"]$","type":"string","description":"Port name"},"profileId":{"type":"string","description":"Lan Profile ID"},"profileOverrideEnable":{"type":"boolean","description":"Indicates whether to enable Profile Override"},"operation":{"pattern":"switching","type":"string","description":"Operation should be a value as follows: SWITCHING; "},"linkSpeed":{"type":"integer","description":"LinkSpeed should be a value as follows: 0: Auto; 1: 10M; 2: 100M; 3: 1000M; 4: 2500M; 5: 10G; 6: 5G; 7: 25G; 8: 100G; 9: 40G.","format":"int32"},"duplex":{"type":"integer","description":"Duplex should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"},"dot1x":{"type":"integer","description":"Dot1x should be a value as follows: 0: Force unauthorized; 1: Force authorized; 2: Auto","format":"int32"},"poe":{"type":"integer","description":"PoE switch should be a value as follows: 0: Off; 1: 802.3at/af","format":"int32"},"bandWidthCtrlType":{"type":"integer","description":"BandWidthCtrlType should be a value as follows: 0: Off; 1: Rate Limit; 2: Storming Control","format":"int32"},"bandCtrl":{"$ref":"#/components/schemas/OswBandCtrlVO"},"stormCtrl":{"$ref":"#/components/schemas/OswStormCtrlVO"},"lldpMedEnable":{"type":"boolean","description":"LLDP-MED enable status"},"spanningTreeEnable":{"type":"boolean","description":"SpanningTree enable status"},"spanningTreeSetting":{"$ref":"#/components/schemas/SpanningTreeSettingVO"},"loopbackDetectEnable":{"type":"boolean","description":"LoopbackDetect enable status"},"loopbackDetectVlanBasedEnable":{"type":"boolean","description":"LoopbackDetectVLANBased enable status"},"igmpFastLeaveEnable":{"type":"boolean","description":"Indicates whether igmp fast leave is enabled"},"mldFastLeaveEnable":{"type":"boolean","description":"Indicates whether mld fast leave is enabled"},"portIsolationEnable":{"type":"boolean","description":"Port-isolation enable status"},"eeeEnable":{"type":"boolean","description":"EEE enable status"},"flowControlEnable":{"type":"boolean","description":"FlowControl enable status"},"fastLeaveEnable":{"type":"boolean","description":"Indicates whether igmpSnooping fastLeave is enabled"},"dhcpL2RelaySettings":{"$ref":"#/components/schemas/OswPortDhcpL2RelayVO"},"dot1pPriority":{"type":"integer","description":"Dot1p Priority","format":"int32"},"trustMode":{"type":"integer","description":"TrustMode should be a value as follows: 0: Untrusted; 1: Trust 802.1p; 2: Trust DSCP","format":"int32"}}},"OswStackUnitVO":{"required":["mac","portList","unit"],"type":"object","properties":{"mac":{"type":"string","description":"Device mac"},"unit":{"type":"integer","description":"Unit","format":"int32"},"portList":{"type":"array","description":"Port List","items":{"$ref":"#/components/schemas/OswStandPortVO"}}},"description":"Unit List"},"BatchApplyStackNetworkOpenApiVO":{"required":["networks"],"type":"object","properties":{"networks":{"type":"array","description":"Batch config networks status.","items":{"$ref":"#/components/schemas/OswNetworkBaseOpenApi"}}}},"QuotaDataSettingOpenApiVO":{"required":["limit","type"],"type":"object","properties":{"used":{"type":"number","description":"The amount of data usage (KB) in current billing cycle.","format":"float"},"type":{"type":"integer","description":"Billing cycle type should be a value as follows: 0:total; 1:monthly.","format":"int32"},"startDate":{"type":"integer","description":"Start date of monthly billing cycle type, valid date should be within the range of 1–31.","format":"int32"},"limit":{"type":"boolean","description":"Quota limit is enabled/disabled."},"credit":{"type":"number","description":"The amount of data allowance in current billing cycle.","format":"float"},"creditUnit":{"type":"integer","description":"Unit for data allowance should be a value as follows: 2:MB; 3:GB.","format":"int32"},"alert":{"type":"boolean","description":"SMS alert for usage is enabled/disabled."},"usage":{"type":"integer","description":"SMS alert for usage when reach percentage of allowance, valid date should be within the range of 0–100.","format":"int32"},"countryCode":{"maxLength":2,"minLength":2,"type":"string","description":"Country code should contain 2 characters. Country code must be entered when entering the calling code. For the values of Country code, refer to section 5.4.1 of the Open API Access Guide."},"callingCode":{"maxLength":5,"minLength":2,"type":"string","description":"Calling code should contain 2 to 5 characters. Calling code must be entered when entering the country code. For the values of Calling code, refer to section 5.4.1 of the Open API Access Guide."},"phone":{"pattern":"\\d{1,20}","type":"string","description":"The phone number to receive SMS alerts."}},"description":"Data quota setting."},"QuotaSmsSettingOpenApiVO":{"required":["limit","type"],"type":"object","properties":{"used":{"type":"integer","description":"The amount of SMS in current billing cycle.","format":"int32"},"type":{"type":"integer","description":"Billing cycle type should be a value as follows: 0:total; 1:monthly.","format":"int32"},"startDate":{"type":"integer","description":"Start date of monthly billing cycle type, valid date should be within the range of 1–31.","format":"int32"},"limit":{"type":"boolean","description":"Quota limit is enabled/disabled."},"credit":{"type":"integer","description":"The amount of data allowance in current billing cycle, valid date should be within the range of 0–100000.","format":"int32"},"alert":{"type":"boolean","description":"SMS alert for usage is enabled/disabled."},"usage":{"type":"integer","description":"SMS alert for usage when reach percentage of allowance, valid date should be within the range of 0–100.","format":"int32"},"countryCode":{"maxLength":2,"minLength":2,"type":"string","description":"Country code should contain 2 characters. Country code must be entered when entering the calling code. For the values of Country code, refer to section 5.4.1 of the Open API Access Guide."},"callingCode":{"maxLength":5,"minLength":2,"type":"string","description":"Calling code should contain 2 to 5 characters. Calling code must be entered when entering the country code. For the values of Calling code, refer to section 5.4.1 of the Open API Access Guide."},"phone":{"pattern":"\\d{1,20}","type":"string","description":"The phone number to receive SMS alerts."}},"description":"SMS quota setting."},"SendMessage":{"required":["receiver","type"],"type":"object","properties":{"callingCode":{"pattern":"\\+\\d{1,4}","type":"string","description":"Calling code should contain 2 to 5 characters. Calling code must be entered when entering the country code. For the values of Calling code, refer to section 5.4.1 of the Open API Access Guide."},"receiver":{"pattern":"\\d{1,20}","type":"string","description":"Receiver number."},"type":{"type":"integer","description":"Send type. 0: formal; 1: test","format":"int32"},"content":{"type":"string","description":"When parameter [type] is 0, parameter [content] should not be null."},"test":{"$ref":"#/components/schemas/SimQuotaSetting"},"simCard":{"type":"integer","description":"When the device supports Dual-SIM card, parameter [simCard] shoud not be null.1: SIM1; 2: SIM2.","format":"int32"}}},"SimQuotaSetting":{"type":"object","properties":{"dataSetting":{"$ref":"#/components/schemas/QuotaDataSettingOpenApiVO"},"smsSetting":{"$ref":"#/components/schemas/QuotaSmsSettingOpenApiVO"},"simCard":{"type":"integer","description":"When device supports Dual-SIM card, using parameter [simCard] to point which card to configure. 1: SIM1; 2:SIM2.","format":"int32"},"cardStatus":{"type":"integer","description":"Sim card status.","format":"int32"},"resource":{"type":"integer","description":"Sim quota setting creation resource,such as: 0: new created, 1: from template, 2: override.","format":"int32"}},"description":"When parameter [type] is 0, parameter [content] should not be null."},"OperateMessage":{"required":["operation","type"],"type":"object","properties":{"type":{"type":"integer","description":"Message Type. 0: inbox; 1: outbox.","format":"int32"},"operation":{"type":"integer","description":"Operation Type. 1:delete; 2:read; 3:clear.","format":"int32"},"ids":{"type":"array","description":"Message ID list. When parameter [operation] is 1 or 2, parameter [ids] should not be null.","items":{"type":"integer","description":"Message ID list. When parameter [operation] is 1 or 2, parameter [ids] should not be null.","format":"int32"}},"simCard":{"type":"integer","description":"When the device supports Dual-SIM card, parameter [simCard] should not be null.1: SIM1; 2: SIM2.","format":"int32"}}},"CorrectSimQuota":{"type":"object","properties":{"data":{"type":"number","description":"The amount of data usage(KB) in current billing cycle.","format":"float"},"sms":{"type":"integer","description":"The amount of SMS in current billing cycle, valid date should be within the range of 0–100000.","format":"int32"},"simCard":{"type":"integer","description":"When device supports Dual-SIM card, using parameter [simCard] to point which card to configure. 1: SIM1; 2:SIM2.","format":"int32"}}},"DeleteTelephoneNumber":{"required":["forceDelete"],"type":"object","properties":{"forceDelete":{"type":"boolean","description":"Other configurations depending on this number (call forwarding rules for instance) will be deleted together if this field is true. Otherwise, a pre-check will be executed and an error message will be returned when this number is already used in some other configurations."}}},"BindNumberList":{"required":["bindNumberList"],"type":"object","properties":{"bindNumberList":{"type":"array","description":"The list of telephone number without status.","items":{"$ref":"#/components/schemas/TelephoneNumberWithoutStatusOpenApiVO"}}}},"TelephoneNumberWithoutStatusOpenApiVO":{"required":["deviceMac","number","profileId"],"type":"object","properties":{"phoneNumberId":{"type":"string","description":"The phoneNumber ID of telephone number."},"profileId":{"type":"string","description":"Provider profile ID used to bind phone numbers."},"prefix":{"type":"string","description":"The prefix of telephone number. When the provider in the provider profile is 1&1 Internet, Vodafone/Arcor, QSC/Q-DSL home, or Telekom, parameter [prefix] is required. When the provider is easybell, parameter [prefix] value is always 0049. In other cases, parameter [prefix] value is always null."},"number":{"type":"string","description":"The number of telephone number."},"deviceMac":{"type":"string","description":"Device MAC."},"username":{"type":"string","description":"Username."},"password":{"type":"string","description":"Password."}},"description":"The list of telephone number without status."},"ConfirmBindedDevicesEntity":{"required":["profileIds","skipConfirm"],"type":"object","properties":{"profileIds":{"type":"array","description":"Provider profile IDs","items":{"type":"string","description":"Provider profile IDs"}},"skipConfirm":{"type":"boolean","description":"skipConfirm indicates whether to skip the query of the devices bound to provider profiles. false: Not to skip the query. true: Skip the query and delete the provider profiles corresponding to the profileIds."}}},"DeleteCallBlockingProfileEntity":{"required":["profileId","skipConfirm"],"type":"object","properties":{"profileId":{"type":"string","description":"Profile ID"},"skipConfirm":{"type":"boolean","description":"skipConfirm indicates whether to skip the query of the devices bound to call blocking profile. false: Not to skip the query. true: Skip the query and delete the call blocking profile corresponding to the profileId."}}},"CreateMdnsRuleOpenApiVO":{"required":["name","profileIds","status"],"type":"object","properties":{"name":{"type":"string","description":"MDNS rule name. Name should contain 1 to 64 characters"},"status":{"type":"boolean","description":"MDNS rule enable status"},"profileIds":{"type":"array","description":"This field represents Bonjour service profile ID. Bonjour Service Profile can be created using 'Create new Bonjour Service' interface, and Bonjour service profile ID can be obtained from 'Get Bonjour Service list' interface","items":{"type":"string","description":"This field represents Bonjour service profile ID. Bonjour Service Profile can be created using 'Create new Bonjour Service' interface, and Bonjour service profile ID can be obtained from 'Get Bonjour Service list' interface"}},"type":{"type":"integer","description":"MDNS rule band VLAN type. Type should be a value as follows: 0: By VLAN ID, 1: By Network","format":"int32"},"ap":{"$ref":"#/components/schemas/ApMdnsRuleOpenApiVO"},"osg":{"$ref":"#/components/schemas/OsgMdnsRuleOpenApiVO"}}},"OsgMdnsRuleOpenApiVO":{"required":["clientNetworks","serviceNetworks"],"type":"object","properties":{"serviceNetworks":{"type":"array","description":"LAN Network ID list of selected service networks. This configuration is used for MDNS Rules where the band VLAN type is \"By Network\". LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface","items":{"type":"string","description":"LAN Network ID list of selected service networks. This configuration is used for MDNS Rules where the band VLAN type is \"By Network\". LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface"}},"clientNetworks":{"type":"array","description":"LAN Network ID list of selected client networks.  This configuration is used for MDNS Rules where the band VLAN type is \"By Network\". LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface","items":{"type":"string","description":"LAN Network ID list of selected client networks.  This configuration is used for MDNS Rules where the band VLAN type is \"By Network\". LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface"}}},"description":"MDNS rule by network config, valid when parameter [type] is 1"},"BatchSelectMacsVO":{"required":["selectType"],"type":"object","properties":{"macs":{"type":"array","description":"When selectType is set to all, the macs do not need to be passed and all entries are processed, when selectType is set to include, the mac entries contained in the macs are processed, when selectType is set to exclude, the mac entries that are not contained in the macs are processed","items":{"type":"string","description":"When selectType is set to all, the macs do not need to be passed and all entries are processed, when selectType is set to include, the mac entries contained in the macs are processed, when selectType is set to exclude, the mac entries that are not contained in the macs are processed"}},"selectType":{"pattern":"all|include|exclude","type":"string","description":"SelectType all, include or exclude"}},"description":"Selected Macs"},"DhcpReservationFilterVO":{"required":["selectMacs"],"type":"object","properties":{"selectMacs":{"$ref":"#/components/schemas/BatchSelectMacsVO"},"sortMap":{"type":"object","additionalProperties":{"type":"string","description":"Sort Direction. The keys that can be sorted are:mac, ip, net_name, description, status, clientName, name, value is asc or desc"},"description":"Sort Direction. The keys that can be sorted are:mac, ip, net_name, description, status, clientName, name, value is asc or desc"},"netId":{"type":"string","description":"Lan Network IDs"},"type":{"type":"string","description":"Device types for which IP is reserved"},"searchKey":{"type":"string","description":"Search Key"}}},"CreateDhcpReservationOpenApiVO":{"required":["mac","netId","status"],"type":"object","properties":{"netId":{"type":"string","description":"This field represents LAN Network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface"},"mac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"Device MAC address, format: AA-BB-CC-11-22-33"},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Reserved IP address"},"options":{"type":"array","description":"Advanced DHCP options","items":{"$ref":"#/components/schemas/custom DHCP Options"}},"description":{"pattern":"^$|^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"Description of DHCP reservation. Description should contain 1 to 128 characters"},"status":{"type":"boolean","description":"DHCP reservation enable status"},"confirmConflict":{"type":"boolean","description":"True when creating an entry with IP and IP-MAC Binding conflicts confirmed"},"serverType":{"type":"string","description":"Dhcp Server Device Type"},"serverMac":{"type":"string","description":"Dhcp Server Device Mac"},"serverStackId":{"type":"string","description":"Dhcp Server Stack ID"}}},"ExportDhcpReservationOpenApiVO":{"required":["interfaceId"],"type":"object","properties":{"interfaceId":{"type":"string","description":"This field represents LAN Network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface"}}},"DhcpUserFilterVO":{"required":["selectIps","selectMacs"],"type":"object","properties":{"selectMacs":{"$ref":"#/components/schemas/BatchSelectMacsVO"},"selectIps":{"type":"array","description":"Selected Ips","items":{"type":"string","description":"Selected Ips"}},"netId":{"type":"string","description":"Lan Network IDs"},"serverMac":{"type":"string","description":"Dhcp Server Macs"},"serverStackId":{"type":"string","description":"Dhcp Server StackIds"},"type":{"type":"string","description":"Filter Type of Dhcp User: \"device\", \"client\" or \"device, client\""},"searchKey":{"type":"string","description":"Search Key"},"sorts":{"type":"object","additionalProperties":{"type":"string","description":"Sort rule, key: sort field, value: sort direction, value parameter may be one of asc or desc."},"description":"Sort rule, key: sort field, value: sort direction, value parameter may be one of asc or desc."}}},"DhcpReservationErrorVO":{"type":"object","properties":{"errorMap":{"type":"object","additionalProperties":{"type":"integer","description":"Error details when importing some entries fails: 0: The imported MAC entries conflict; 1: The server device's user list has reached its limit.","format":"int32"},"description":"Error details when importing some entries fails: 0: The imported MAC entries conflict; 1: The server device's user list has reached its limit."}}},"OperationResponseDhcpReservationErrorVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DhcpReservationErrorVO"}}},"CertProfileFileIdVO":{"type":"object","properties":{"fileId":{"type":"string","description":"Certificate profile file id."}},"description":"CertProfileFileIdVO"},"MailServerOpenApiVO":{"required":["auth","receiver","sender","ssl"],"type":"object","properties":{"id":{"type":"string","description":"Mail server ID."},"sender":{"type":"string","description":"The email address of the sender."},"receiver":{"type":"string","description":"The email address of the receiver, which can be the same as or different from the sender's email address."},"ssl":{"type":"boolean","description":"Enable this feature, and the data will be transmitted based on the SSL protocol."},"smtpServer":{"type":"string","description":"Enter the domain name or IP address of the SMTP server."},"smtpPort":{"type":"integer","description":"Enter the port used by the SMTP server according to the instructions of your email service provider.","format":"int32"},"auth":{"type":"boolean","description":"Enable this feature if the login of the mailbox requires a username and authorization code."},"username":{"type":"string","description":"When Authentication is enabled, enter your email address as the username."},"authCode":{"type":"string","description":"When Authentication is enabled, enter the authorization code that enables a third party to log in to the mailbox. Note that the authorization code is not the mailbox's password."},"resource":{"type":"integer","description":"Mail server setting creation resource, such as: 0: new created, 1: from template, 2: override.","format":"int32"}}},"BatchConfigIotBtIbeaconOpenApiVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the Bluetooth Advertising setting.(Disable by default)"},"transmitPower":{"type":"integer","description":"Broadcast transmission power.<br />The parameter [transmitPower] should be a value as follows:[-20, -18, -15, -12, -10, -9, -6, -5, -3, 0, 1, 2, 3, 4, 5, 14, 15, 16, 17, 18, 19, 20].(0 by default)","format":"int32","deprecated":true},"measurePower":{"type":"integer","description":"RSSI Calibration Value. The parameter [measurePower] is used to input the RSSI measured at a 1-meter distance from the device, enabling positioning functionality.(-65 by default)","format":"int32"},"advInterval":{"type":"integer","description":"Advertising interval in milliseconds.(500 by default)","format":"int32"},"uuid":{"type":"string","description":"The UUID (Universally Unique Identifier) of the advertising ibeacon packet."},"major":{"type":"string","description":"The major value of adverting ibeacon packet, indicating a larger group."},"minor":{"type":"string","description":"The minor value of adverting ibeacon packet, indicating a smaller group."}},"description":"Ibeacon config."},"BatchModifyIbeaconOpenApiVO":{"type":"object","properties":{"config":{"$ref":"#/components/schemas/BatchConfigIotBtIbeaconOpenApiVO"},"ids":{"uniqueItems":true,"type":"array","description":"A set of Bluetooth Advertising entry ids to be modified.","items":{"type":"string","description":"A set of Bluetooth Advertising entry ids to be modified."}}}},"ModifyDisasterModeOpenApiVO":{"type":"object","properties":{"status":{"type":"integer","description":"Format should be a value as follows: 1: disaster mode enable; 2: disaster mode disable","format":"int32"}}},"SessionLimitRuleOpenApiVO":{"required":["maxSession","name","sourceType","status"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name should contain 1 to 64 characters."},"status":{"type":"boolean","description":"Status of the session limit rule."},"sourceType":{"type":"integer","description":"Source type should be a value as follows: 0: network; 1: IP group; 2: IP.","format":"int32"},"sourceIds":{"type":"array","description":"Source IDs of the session limit rule, only for network and IP group type.Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface. IP group can be created using 'Create a new group profile' interface, and IP group ID can be obtained from 'Get group profile list' interface.","items":{"type":"string","description":"Source IDs of the session limit rule, only for network and IP group type.Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface. IP group can be created using 'Create a new group profile' interface, and IP group ID can be obtained from 'Get group profile list' interface."}},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP of the session limit rule."},"maxSession":{"type":"integer","description":"Max sessions should be within the range of 1–999999.","format":"int32"}}},"ExcludeApDeleteOpenApiVO":{"type":"object","properties":{"selectType":{"type":"string","description":"The value of parameter [selectType] must be in [all, include, exclude]."},"macs":{"type":"array","description":"MAC list. When parameter [selectType] is 'all', it should be null.When parameter [selectType] is 'include', it means the MAC list that needs to be included.When parameter [selectType] is 'exclude', it means the MAC list that needs to be excluded.","items":{"type":"string","description":"MAC list. When parameter [selectType] is 'all', it should be null.When parameter [selectType] is 'include', it means the MAC list that needs to be included.When parameter [selectType] is 'exclude', it means the MAC list that needs to be excluded."}}}},"ReportCardQueryVO":{"type":"object","properties":{"omadacId":{"type":"string","description":"omadacId"},"siteId":{"type":"string","description":"site id"},"start":{"type":"integer","description":"start time, unit: seconds","format":"int64"},"end":{"type":"integer","description":"end time, unit: seconds","format":"int64"},"cards":{"type":"array","description":"card info","items":{"$ref":"#/components/schemas/TabCardVO"}},"requestToken":{"type":"string"},"token":{"type":"string"}}},"TabCardVO":{"type":"object","properties":{"type":{"type":"string","description":"card type enum: overviewSummary,clientConnectionTrend,internet,network,alertSummary,gatewaySummary,ispLoad,switchStatus,switchAlertReboot,topSwitchCpuMemory,topSwitchByTrafficAndPoePower,poePowerTrend,wirelessTraffic,apStatus,topApByTrafficAndClient,topApByInterference,topApByRtAndDrop,topApByCpuAndMemory,topSsidByTraffic,clientsOverview, clientsAssociationActivities,clientsWithOnboardingTimes,topClient,appCategories,topApplicationByTraffic","example":"overviewSummary"},"topK":{"type":"integer","description":"topK: 5, 10, 20","format":"int32","example":5}},"description":"card info"},"ActivityBaseVO":{"type":"object","properties":{"time":{"type":"integer","description":"time","format":"int64"},"upload":{"type":"integer","description":"tx traffic of internet","format":"int64"},"download":{"type":"integer","description":"rx traffic of internet","format":"int64"},"wiredCount":{"type":"integer","description":"number of wireless device","format":"int64"},"wirelessCount":{"type":"integer","description":"number of wireless device","format":"int64"},"totalData":{"type":"integer","description":"total traffic","format":"int64"}}},"AlertSummaryTrendVO":{"type":"object","properties":{"alertSummary":{"$ref":"#/components/schemas/AlertSummaryVO"},"alertTrend":{"type":"array","description":"Alert trend","items":{"$ref":"#/components/schemas/TrendBaseVO"}}}},"AlertSummaryVO":{"type":"object","properties":{"totalGradeAlerts":{"type":"integer","description":"Number of alerts: sum by alert level","format":"int64"},"totalTypeAlerts":{"type":"integer","description":"Number of alerts: sum by alert type","format":"int64"},"infoAlerts":{"type":"integer","description":"Number of info alerts","format":"int64"},"errorAlerts":{"type":"integer","description":"Number of error alerts","format":"int64"},"warningAlerts":{"type":"integer","description":"Number of warning alerts","format":"int64"},"clientAlerts":{"type":"integer","description":"Number of client alerts","format":"int64"},"operationAlerts":{"type":"integer","description":"Number of operation alerts","format":"int64"},"deviceAlerts":{"type":"integer","description":"Number of device alerts","format":"int64"},"systemAlerts":{"type":"integer","description":"Number of system alerts","format":"int64"},"criticalAlerts":{"type":"integer","description":"Number of critical alerts","format":"int64"}},"description":"Alert summary"},"AlertVO":{"type":"object","properties":{"totalAlerts":{"type":"integer","description":"Total number of alerts","format":"int64"},"infoAlerts":{"type":"integer","description":"Total number of info alerts","format":"int64"},"warningAlerts":{"type":"integer","description":"Total number of warning alerts","format":"int64"},"errorAlerts":{"type":"integer","description":"Total number of error alerts","format":"int64"},"criticalAlerts":{"type":"integer","description":"Total number of critical alerts","format":"int64"}},"description":"Gateway alert"},"ApInterferenceVO":{"type":"object","properties":{"device":{"type":"string","description":"Device name"},"model":{"type":"string","description":"Device model"},"modelVersion":{"type":"string","description":"Device model version"},"type":{"type":"string","description":"Device type should be a value as follows: ap."},"interference":{"type":"integer","description":"Degree of interference. interference = interUtil/(interUtil+txUtil+rxUtil)","format":"int32"},"interUtil":{"type":"integer","description":"Channel interference rate","format":"int32"},"txUtil":{"type":"integer","description":"Transmit channel utilization","format":"int32"},"rxUtil":{"type":"integer","description":"Receive channel utilization","format":"int32"}}},"ApUtilizationVO":{"type":"object","properties":{"topApByCpuUtility":{"type":"array","items":{"$ref":"#/components/schemas/TopModelBaseVO"}},"topApByMemoryUtility":{"type":"array","items":{"$ref":"#/components/schemas/TopModelBaseVO"}}}},"AppCategoryTrafficsVO":{"type":"object","properties":{"categories":{"type":"array","items":{"$ref":"#/components/schemas/CategoryTrafficDetailVO"}},"totalTraffic":{"type":"integer","description":"total traffic","format":"int64"}}},"CardInfoVO":{"type":"object","properties":{"overviewSummary":{"$ref":"#/components/schemas/OverViewSummaryVO"},"trafficSummary":{"$ref":"#/components/schemas/TrafficSummaryVO"},"trafficDistribution":{"$ref":"#/components/schemas/TrafficDistributionVO"},"alertSummary":{"$ref":"#/components/schemas/AlertSummaryTrendVO"},"deviceStatus":{"type":"array","items":{"$ref":"#/components/schemas/OnlineOfflineVO"}},"deviceHealthTrend":{"type":"array","items":{"$ref":"#/components/schemas/DeviceHealthVO"}},"network":{"$ref":"#/components/schemas/NetworkVO"},"gatewaySummary":{"$ref":"#/components/schemas/GatewaySummaryVO"},"ispLoad":{"type":"array","description":"ISP Load","items":{"$ref":"#/components/schemas/IspLoadVO"}},"switchAlertReboot":{"$ref":"#/components/schemas/SwitchAlertRebootVO"},"topSwitchByTrafficAndPoePower":{"$ref":"#/components/schemas/TopSwitchVO"},"topSwitchCpuMemory":{"$ref":"#/components/schemas/SwitchUtilizationVO"},"poePowerTrend":{"type":"array","items":{"$ref":"#/components/schemas/PoePowerTrendVO"}},"switchStatus":{"type":"array","items":{"$ref":"#/components/schemas/OnlineOfflineVO"}},"switchHealthTrend":{"type":"array","items":{"$ref":"#/components/schemas/DeviceHealthVO"}},"wanHealthTrend":{"type":"array","items":{"$ref":"#/components/schemas/WanHealthTrendVO"}},"wirelessTraffic":{"$ref":"#/components/schemas/WirelessTrafficVO"},"wifiHealth":{"$ref":"#/components/schemas/WifiHealthVO"},"topApByTrafficAndClient":{"$ref":"#/components/schemas/TopApByTrafficAndClientVO"},"topApByCpuAndMemory":{"$ref":"#/components/schemas/ApUtilizationVO"},"topApByInterference":{"$ref":"#/components/schemas/TopApByInterferenceVO"},"topApByRtAndDrop":{"$ref":"#/components/schemas/TopApByRtDropVO"},"topSsidByTraffic":{"type":"array","items":{"$ref":"#/components/schemas/TopSsidTrafficVO"}},"apStatus":{"type":"array","items":{"$ref":"#/components/schemas/OnlineOfflineVO"}},"wirelessTrafficSingle":{"$ref":"#/components/schemas/WirelessTrafficSingleVO"},"apHealth":{"type":"array","items":{"$ref":"#/components/schemas/DeviceHealthVO"}},"clientTraffic":{"$ref":"#/components/schemas/Client traffic info"},"clientConnectionTrend":{"$ref":"#/components/schemas/Client Connection Trend"},"clientsOverview":{"$ref":"#/components/schemas/Client statistics overview"},"clientsAssociationActivities":{"type":"array","description":"Clients association activities with time.","items":{"$ref":"#/components/schemas/Client Association Activities"}},"clientsWithOnboardingTimes":{"$ref":"#/components/schemas/Clients With OnBoarding Times"},"topClient":{"$ref":"#/components/schemas/Top traffic and uptime clients"},"appCategories":{"$ref":"#/components/schemas/AppCategoryTrafficsVO"},"topApplicationByTraffic":{"type":"array","items":{"$ref":"#/components/schemas/TopApplicationByTrafficVO"}},"internet":{"$ref":"#/components/schemas/NetworkActivityVO"},"clientHealthTrend":{"type":"array","items":{"$ref":"#/components/schemas/ClientHealthTrendVO"}},"clientsRssi":{"type":"array","description":"Clients RSSI distribution trend","items":{"$ref":"#/components/schemas/RssiDistributionVO"}},"clientsSnr":{"type":"array","description":"Clients SNR distribution trend","items":{"$ref":"#/components/schemas/SnrDistributionVO"}},"clientsDataRate":{"type":"array","description":"Clients data rate distribution trend","items":{"$ref":"#/components/schemas/DataRateDistributionVO"}},"topApByConnFailure":{"$ref":"#/components/schemas/TopApByConnFailureVO"},"topSwitchByPacket":{"$ref":"#/components/schemas/TopSwitchByPacketVO"}}},"CategoryTrafficDetailVO":{"type":"object","properties":{"familyId":{"type":"integer","description":"category id","format":"int32"},"familyName":{"type":"string","description":"category name"},"traffic":{"type":"integer","description":"traffic","format":"int64"},"percent":{"type":"integer","description":"percent","format":"int32"}}},"Client Association Activities":{"type":"object","properties":{"lessThan1sNum":{"type":"integer","description":"Number of clients with association time less than 1 second.","format":"int32"},"from1To3sNum":{"type":"integer","description":"Number of clients with association time less than 3 seconds and greater than or equal to 1 second.","format":"int32"},"from3To12sNum":{"type":"integer","description":"Number of clients with association time less than 12 seconds and greater than or equal to 3 second.","format":"int32"},"moreThan12sNum":{"type":"integer","description":"Number of clients with association time greater than or equal to 12 second.","format":"int32"},"time":{"type":"integer","description":"Timestamp, unit is second.","format":"int64"}},"description":"Clients association activities with time."},"Client Connection Summary":{"type":"object","properties":{"totalClients":{"type":"integer","description":"Total client number.","format":"int32"},"wirelessClients":{"type":"integer","description":"Total wireless client number.","format":"int32"},"wiredClients":{"type":"integer","description":"Total wired client number.","format":"int32"}},"description":"Summary of client count statistics."},"Client Connection Trend":{"type":"object","properties":{"clientConnectionSummary":{"$ref":"#/components/schemas/Client Connection Summary"},"clientConnectionTrend":{"type":"array","description":"Client connection trend with time.","items":{"$ref":"#/components/schemas/Client count statistics with time"}}},"description":"Client connection trend."},"Client count statistics with time":{"type":"object","properties":{"time":{"type":"integer","description":"Timestamp, unit is second.","format":"int64"},"totalClients":{"type":"integer","description":"The number of all clients.","format":"int32"},"wirelessClients":{"type":"integer","description":"The number of all wireless clients.","format":"int32"},"wiredClients":{"type":"integer","description":"The number of all wired clients.","format":"int32"}},"description":"Client connection trend with time."},"Client statistics overview":{"type":"object","properties":{"totalClientsNum":{"type":"integer","description":"Total number of all clients.","format":"int32"},"clients2gNum":{"type":"integer","description":"Total number of wireless clients in the 2G band.","format":"int32"},"clients5gNum":{"type":"integer","description":"Total number of wireless clients in the 5G band.","format":"int32"},"clients6gNum":{"type":"integer","description":"Total number of wireless clients in the 6G band.","format":"int32"},"wiredClientsNum":{"type":"integer","description":"Total number of all wired clients.","format":"int32"},"wirelessClientsNum":{"type":"integer","description":"Total number of all wireless clients.","format":"int32"},"averageClientNum":{"type":"integer","description":"Average client number of each day.","format":"int32"},"averageClientTraffic":{"type":"integer","description":"Average traffic of each client.","format":"int64"},"clientsSsidDistribution":{"$ref":"#/components/schemas/Ssid distribution"}},"description":"Client statistics overview."},"Client traffic info":{"type":"object","properties":{"totalTraffic":{"type":"integer","description":"Total traffic of all clients.","format":"int64"},"wiredClientsTraffic":{"type":"integer","description":"Total traffic of all wired clients.","format":"int64"},"clients2gTraffic":{"type":"integer","description":"Total traffic of wireless clients in the 2G band.","format":"int64"},"clients5gTraffic":{"type":"integer","description":"Total traffic of wireless clients in the 5G band.","format":"int64"},"clients6gTraffic":{"type":"integer","description":"Total traffic of wireless clients in the 6G band.","format":"int64"},"wiredClientsNum":{"type":"integer","description":"The number of all wired clients.","format":"int32"},"clients2gNum":{"type":"integer","description":"The number of wireless clients in the 2G band.","format":"int32"},"clients5gNum":{"type":"integer","description":"The number of wireless clients in the 5G band.","format":"int32"},"clients6gNum":{"type":"integer","description":"The number of wireless clients in the 6G band.","format":"int32"}},"description":"Client traffic info."},"ClientHealthCategoryVO":{"type":"object","properties":{"health":{"$ref":"#/components/schemas/HealthDistributionVO"},"incident":{"$ref":"#/components/schemas/IncidentVO"}},"description":"Wired client health"},"ClientHealthTrendVO":{"type":"object","properties":{"time":{"type":"integer","description":"Timestamp","format":"int64"},"total":{"type":"integer","description":"Total client count","format":"int32"},"good":{"type":"integer","description":"Good health count","format":"int32"},"average":{"type":"integer","description":"Fair health count","format":"int32"},"poor":{"type":"integer","description":"Poor health count","format":"int32"},"noData":{"type":"integer","description":"No data count","format":"int32"},"wireless":{"$ref":"#/components/schemas/ClientHealthCategoryVO"},"wired":{"$ref":"#/components/schemas/ClientHealthCategoryVO"}}},"Clients With OnBoarding Times":{"type":"object","properties":{"lessThan2sNum":{"type":"integer","description":"Number of clients with association time less than 2 seconds.","format":"int32"},"from2To4sNum":{"type":"integer","description":"Number of clients with association time less than 4 seconds and greater than or equal to 2 seconds.","format":"int32"},"from4To6sNum":{"type":"integer","description":"Number of clients with association time less than 6 seconds and greater than or equal to 4 seconds.","format":"int32"},"from6To8sNum":{"type":"integer","description":"Number of clients with association time less than 8 seconds and greater than or equal to 6 seconds.","format":"int32"},"from8To10sNum":{"type":"integer","description":"Number of clients with association time less than 10 seconds and greater than or equal to 8 seconds.","format":"int32"},"moreThan10sNum":{"type":"integer","description":"Number of clients with association time greater than or equal to 10 seconds.","format":"int32"},"fails":{"type":"integer","description":"Number of clients with failed association,","format":"int32"},"lessThan10sPercent":{"type":"integer","description":"Percentage of association time less than 10 seconds.","format":"int32"}},"description":"Client distribution with association times."},"ConnFailureApVO":{"type":"object","properties":{"device":{"type":"string","description":"Device name"},"model":{"type":"string","description":"Device model"},"modelVersion":{"type":"string","description":"Device model version"},"type":{"type":"string","description":"Device type"},"mac":{"type":"string","description":"Device mac"},"failureRate":{"type":"integer","description":"Connection failure percentage (0-100)","format":"int32"},"failureNum":{"type":"integer","description":"Connection failure count","format":"int32"},"successNum":{"type":"integer","description":"Connection success count","format":"int32"}},"description":"Top AP by connection failure on 6G band"},"DataRateDistributionVO":{"type":"object","properties":{"time":{"type":"integer","description":"Timestamp in seconds","format":"int64"},"dataRateAboveWifi4":{"type":"array","description":"802.11n/ac/ax speed distribution: [>=72, [12,72), <12] Mbps","items":{"type":"integer","description":"802.11n/ac/ax speed distribution: [>=72, [12,72), <12] Mbps","format":"int32"}},"dataRateBelowWifi4":{"type":"array","description":"802.11a/b/g speed distribution: [>=21, [12,21), <12] Mbps","items":{"type":"integer","description":"802.11a/b/g speed distribution: [>=21, [12,21), <12] Mbps","format":"int32"}}},"description":"Clients data rate distribution trend"},"DeviceHealthVO":{"type":"object","properties":{"time":{"type":"integer","description":"Timestamp","format":"int64"},"total":{"type":"integer","description":"Total number of devices","format":"int32"},"good":{"type":"integer","description":"Number of devices with good health status","format":"int32"},"poor":{"type":"integer","description":"Number of devices with poor health status","format":"int32"},"noData":{"type":"integer","description":"Number of devices with no health data","format":"int32"},"incidentDetail":{"$ref":"#/components/schemas/IncidentVO"}}},"GatewayCpuMemUtilListVO":{"type":"object","properties":{"time":{"type":"integer","description":"Timestamp, in seconds, such as 1682000000","format":"int64"},"cpuUtil":{"type":"integer","description":"Device CPU utilization rate","format":"int32"},"memUtil":{"type":"integer","description":"Device memory utilization rate","format":"int32"}},"description":"Gateway CPU and memory utilization"},"GatewaySummaryVO":{"type":"object","properties":{"gatewayAlert":{"$ref":"#/components/schemas/AlertVO"},"gatewayUltilization":{"type":"array","description":"Gateway CPU and memory utilization","items":{"$ref":"#/components/schemas/GatewayCpuMemUtilListVO"}}},"description":"Gateway summary"},"HealthDistributionVO":{"type":"object","properties":{"total":{"type":"integer","description":"Total count","format":"int32"},"good":{"type":"integer","description":"Good count","format":"int32"},"average":{"type":"integer","description":"Average count","format":"int32"},"poor":{"type":"integer","description":"Poor count","format":"int32"},"noData":{"type":"integer","description":"No data count","format":"int32"}},"description":"Health distribution"},"IncidentVO":{"type":"object","properties":{"total":{"type":"integer","description":"Total incident count","format":"int32"},"critical":{"type":"integer","description":"Critical incident count","format":"int32"},"error":{"type":"integer","description":"Error incident count","format":"int32"},"warning":{"type":"integer","description":"Warning incident count","format":"int32"},"info":{"type":"integer","description":"Info incident count","format":"int32"}},"description":"Incident statistics"},"IspLoadStatVO":{"type":"object","properties":{"totalRate":{"type":"integer","description":"WAN port rate (rxR+txR)","format":"int64"},"latency":{"type":"integer","description":"WAN latency, when mode is WAN and device is connected, Unit: ms","format":"int32"},"time":{"type":"integer","description":"Timestamp, in seconds, such as 1682000000","format":"int64"},"totalTraffic":{"type":"integer","description":"Upstream and downstream traffic","format":"int64"},"upTraffic":{"type":"integer","description":"Upstream traffic","format":"int64"},"downTraffic":{"type":"integer","description":"Downstream traffic","format":"int64"}},"description":"WAN port ISP load stat data list"},"IspLoadVO":{"type":"object","properties":{"portId":{"type":"integer","description":"Port ID","format":"int32"},"portName":{"type":"string","description":"Port Name"},"defaultWan":{"type":"boolean","description":"Whether it is the default WAN port"},"data":{"type":"array","description":"WAN port ISP load stat data list","items":{"$ref":"#/components/schemas/IspLoadStatVO"}}},"description":"ISP Load"},"Longest uptime client info":{"type":"object","properties":{"name":{"type":"string","description":"Client name."},"mac":{"type":"string","description":"Client MAC."},"type":{"type":"string","description":"Client type."},"totalDuration":{"type":"integer","description":"Client uptime, unit is second.","format":"int64"}},"description":"Longest uptime clients."},"NameRebootVO":{"type":"object","properties":{"name":{"type":"string","description":"Switch name"},"rebootTimes":{"type":"integer","description":"Reboot times","format":"int32"}}},"NetworkActivityVO":{"type":"object","properties":{"totalTraffic":{"type":"integer","description":"total traffic","format":"int64"},"totalUpload":{"type":"integer","description":"total tx traffic","format":"int64"},"totalDownload":{"type":"integer","description":"total rx traffic","format":"int64"},"activityList":{"type":"array","items":{"$ref":"#/components/schemas/ActivityBaseVO"}},"existData":{"type":"boolean","description":"mark whether the data exists"},"totalWiredCount":{"type":"integer","description":"total number of wired client","format":"int32"},"totalWirelessCount":{"type":"integer","description":"total number of wireless client","format":"int32"},"totalClientCount":{"type":"integer","description":"total number of client","format":"int32"}}},"OnlineOfflineVO":{"type":"object","properties":{"time":{"type":"integer","description":"time","format":"int64"},"total":{"type":"integer","description":"total number of device","format":"int32"},"online":{"type":"integer","description":"total number of online device","format":"int32"},"offline":{"type":"integer","description":"total number of offline device","format":"int32"}}},"OperationResponseCardInfoVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CardInfoVO"}}},"OverViewSummaryVO":{"type":"object","properties":{"siteHealthScore":{"type":"integer","description":"site health score","format":"int32"},"wifiHealthScore":{"type":"integer","description":"Wi-Fi health score","format":"int32"},"deviceHealthScore":{"type":"integer","description":"device health score","format":"int32"},"clientHealthScore":{"type":"integer","description":"client health score","format":"int32"},"wanHealthScore":{"type":"integer","description":"wan health score","format":"int32"},"totalDevices":{"type":"integer","description":"total number of device","format":"int64"},"totalGateways":{"type":"integer","description":"total number of gateway","format":"int64"},"totalSwitches":{"type":"integer","description":"total number of switch","format":"int64"},"totalAps":{"type":"integer","description":"total number of ap","format":"int64"},"totalOlts":{"type":"integer","description":"total number of olt","format":"int64"},"totalNvrs":{"type":"integer","description":"total number of nvr","format":"int64"},"totalIpcs":{"type":"integer","description":"total number of ipc","format":"int64"},"wiredClients":{"type":"integer","description":"total number of wired client","format":"int64"},"wirelessClients":{"type":"integer","description":"total number of wireless client","format":"int64"},"totalClients":{"type":"integer","description":"total number of client","format":"int64"},"totalTraffic":{"type":"integer","description":"total traffic","format":"int64"},"wiredTraffic":{"type":"integer","description":"total traffic of wired device","format":"int64"},"wirelessTraffic":{"type":"integer","description":"total traffic of wireless device","format":"int64"}}},"PoePowerTrendVO":{"type":"object","properties":{"time":{"type":"integer","description":"Timestamp","format":"int64"},"poePowerTotal":{"type":"integer","description":"Total power of POE","format":"int64"}}},"RssiDistributionVO":{"type":"object","properties":{"time":{"type":"integer","description":"Timestamp in seconds","format":"int64"},"rssiDistribution":{"type":"array","description":"RSSI distribution: [>=−65dBm, [−72,−65), <−72dBm]","items":{"type":"integer","description":"RSSI distribution: [>=−65dBm, [−72,−65), <−72dBm]","format":"int32"}}},"description":"Clients RSSI distribution trend"},"SSID stat":{"type":"object","properties":{"ssid":{"type":"string","description":"SSID name."},"clientsNum":{"type":"integer","description":"Client number.","format":"int32"}},"description":"The total client number of other SSIDs."},"SnrDistributionVO":{"type":"object","properties":{"time":{"type":"integer","description":"Timestamp in seconds","format":"int64"},"snrDistribution":{"type":"array","description":"SNR distribution: [>=15, [10,15), <10]","items":{"type":"integer","description":"SNR distribution: [>=15, [10,15), <10]","format":"int32"}}},"description":"Clients SNR distribution trend"},"Ssid distribution":{"type":"object","properties":{"firstSsid":{"$ref":"#/components/schemas/SSID stat"},"secondSsid":{"$ref":"#/components/schemas/SSID stat"},"thirdSsid":{"$ref":"#/components/schemas/SSID stat"},"fourthSsid":{"$ref":"#/components/schemas/SSID stat"},"fifthSsid":{"$ref":"#/components/schemas/SSID stat"},"otherSsid":{"$ref":"#/components/schemas/SSID stat"}},"description":"Distribution of the number of clients on SSID."},"SwitchAlertRebootVO":{"type":"object","properties":{"switchAlert":{"$ref":"#/components/schemas/SwitchAlertVO"},"switchRebootTimes":{"$ref":"#/components/schemas/SwitchRebootTimesVO"}}},"SwitchAlertVO":{"type":"object","properties":{"totalAlerts":{"type":"integer","description":"Total number of alerts","format":"int64"},"infoAlerts":{"type":"integer","description":"Total number of info alerts","format":"int64"},"warningAlerts":{"type":"integer","description":"Total number of warning alerts","format":"int64"},"errorAlerts":{"type":"integer","description":"Total number of error alerts","format":"int64"},"criticalAlerts":{"type":"integer","description":"Total number of critical alerts","format":"int64"}},"description":"Switch alert"},"SwitchPacketErrorVO":{"type":"object","properties":{"device":{"type":"string","description":"Device name"},"model":{"type":"string","description":"Device model"},"modelVersion":{"type":"string","description":"Device model version"},"mac":{"type":"string","description":"Device mac"},"type":{"type":"string","description":"Device type"},"portCnt":{"type":"integer","description":"Total number of ports","format":"int32"},"errPortCnt":{"type":"integer","description":"Number of ports with error packets","format":"int32"},"errPkts":{"type":"integer","description":"Total number of error packets","format":"int64"}},"description":"Top switches by packet error"},"SwitchPacketLossVO":{"type":"object","properties":{"device":{"type":"string","description":"Device name"},"model":{"type":"string","description":"Device model"},"modelVersion":{"type":"string","description":"Device model version"},"mac":{"type":"string","description":"Device mac"},"type":{"type":"string","description":"Device type"},"portCnt":{"type":"integer","description":"Total number of ports","format":"int32"},"pktsLossPortCnt":{"type":"integer","description":"Number of ports with packet loss","format":"int32"},"lossPkts":{"type":"integer","description":"Total number of lost packets","format":"int64"}},"description":"Top switches by packet loss"},"SwitchRebootTimesVO":{"type":"object","properties":{"totalSwitchTimes":{"type":"integer","description":"Switch total reboot times","format":"int32"},"firstSwitch":{"$ref":"#/components/schemas/NameRebootVO"},"secondSwitch":{"$ref":"#/components/schemas/NameRebootVO"},"thirdSwitch":{"$ref":"#/components/schemas/NameRebootVO"},"fourthSwitch":{"$ref":"#/components/schemas/NameRebootVO"},"fifthSwitch":{"$ref":"#/components/schemas/NameRebootVO"},"otherSwitch":{"$ref":"#/components/schemas/NameRebootVO"}},"description":"Switch reboot times"},"SwitchUtilizationVO":{"type":"object","properties":{"topSwitchCpu":{"type":"array","items":{"$ref":"#/components/schemas/TopModelBaseVO"}},"topSwitchMemory":{"type":"array","items":{"$ref":"#/components/schemas/TopModelBaseVO"}}}},"Top traffic and uptime clients":{"type":"object","properties":{"activeClients":{"type":"array","description":"Top traffic clients.","items":{"$ref":"#/components/schemas/Top traffic client info"}},"longestUptimeClients":{"type":"array","description":"Longest uptime clients.","items":{"$ref":"#/components/schemas/Longest uptime client info"}}},"description":"Top traffic and uptime clients."},"Top traffic client info":{"type":"object","properties":{"name":{"type":"string","description":"Client name."},"mac":{"type":"string","description":"Client MAC."},"type":{"type":"string","description":"Client type."},"traffic":{"type":"integer","description":"Client traffic, unit is Byte.","format":"int64"},"trafficPercent":{"type":"integer","description":"Percentage of this client's traffic to total traffic","format":"int32"}},"description":"Top traffic clients."},"TopApByConnFailureVO":{"type":"object","properties":{"topAp2gFailList":{"type":"array","description":"Top AP by connection failure on 2G band","items":{"$ref":"#/components/schemas/ConnFailureApVO"}},"topAp5gFailList":{"type":"array","description":"Top AP by connection failure on 5G band","items":{"$ref":"#/components/schemas/ConnFailureApVO"}},"topAp6gFailList":{"type":"array","description":"Top AP by connection failure on 6G band","items":{"$ref":"#/components/schemas/ConnFailureApVO"}},"needTip":{"type":"boolean","description":"Not supported by the firmware on some devices"}},"description":"Top AP by connection failure"},"TopApByInterferenceVO":{"type":"object","properties":{"topAp2gInterList":{"type":"array","items":{"$ref":"#/components/schemas/ApInterferenceVO"}},"topAp5gInterList":{"type":"array","items":{"$ref":"#/components/schemas/ApInterferenceVO"}},"topAp6gInterList":{"type":"array","items":{"$ref":"#/components/schemas/ApInterferenceVO"}}}},"TopApByRtDropVO":{"type":"object","properties":{"topApByRt":{"type":"array","items":{"$ref":"#/components/schemas/TopModelBaseVO"}},"topApByDrop":{"type":"array","items":{"$ref":"#/components/schemas/TopModelBaseVO"}}}},"TopApByTrafficAndClientVO":{"type":"object","properties":{"topApByTrafficMax":{"type":"array","items":{"$ref":"#/components/schemas/TopModelBaseVO"}},"topApByTrafficMin":{"type":"array","items":{"$ref":"#/components/schemas/TopModelBaseVO"}},"topApByClientMax":{"type":"array","items":{"$ref":"#/components/schemas/TopModelBaseVO"}},"topApByClientMin":{"type":"array","items":{"$ref":"#/components/schemas/TopModelBaseVO"}}}},"TopApplicationByTrafficVO":{"type":"object","properties":{"applicationId":{"type":"integer","description":"application id","format":"int32"},"applicationName":{"type":"string","description":"application name"},"familyId":{"type":"integer","description":"category id","format":"int32"},"familyName":{"type":"string","description":"category name"},"traffic":{"type":"integer","description":"traffic","format":"int64"},"trafficPercent":{"type":"integer","description":"percent of traffic","format":"int32"},"down":{"type":"integer","description":"rx traffic","format":"int64"},"up":{"type":"integer","description":"tx traffic","format":"int64"}}},"TopModelBaseVO":{"type":"object","properties":{"device":{"type":"string","description":"Device name"},"model":{"type":"string","description":"Device model"},"modelVersion":{"type":"string","description":"Device model version"},"ip":{"type":"string","description":"Device IP"},"modelType":{"type":"string"},"type":{"type":"string","description":"Device type should be a value as follows: ap; switch"},"status":{"type":"integer","description":"Device status should be a value as follows: 0:DISCONNECTED, 1:CONNECTED, 2:PENDING, 3:HEARTBEAT MISSED, 4: ISOLATED","format":"int32"},"health":{"type":"integer","description":"Device health core","format":"int32"},"mac":{"type":"string","description":"Device mac"},"util":{"type":"integer","description":"Utilization","format":"int64"},"traffic":{"type":"integer","description":"Total traffic","format":"int64"},"ratio":{"type":"integer","description":"Percent","format":"int64"},"poePower":{"type":"integer","description":"POE power","format":"int64"},"clientCount":{"type":"integer","description":"Count of clients","format":"int64"}}},"TopSsidTrafficVO":{"type":"object","properties":{"ssid":{"type":"string","description":"ssid name"},"security":{"type":"string","description":"security"},"channel":{"type":"string","description":"channel"},"traffic":{"type":"integer","description":"total traffic","format":"int64"},"trafficRatio":{"type":"integer","description":"traffic percentage","format":"int32"},"clientCount":{"type":"integer","description":"number of client","format":"int64"},"averageSingalStrength":{"type":"integer","description":"average signal strength","format":"int64"}}},"TopSwitchByPacketVO":{"type":"object","properties":{"topPacketLoss":{"type":"array","description":"Top switches by packet loss","items":{"$ref":"#/components/schemas/SwitchPacketLossVO"}},"topPacketError":{"type":"array","description":"Top switches by packet error","items":{"$ref":"#/components/schemas/SwitchPacketErrorVO"}},"needTip":{"type":"boolean","description":"Not supported by the firmware on some devices"}},"description":"Top switch by packet loss and error"},"TopSwitchVO":{"type":"object","properties":{"topSwitchByTraffic":{"type":"array","items":{"$ref":"#/components/schemas/TopModelBaseVO"}},"topSwitchByPoePower":{"type":"array","items":{"$ref":"#/components/schemas/TopModelBaseVO"}}}},"TrafficDistributionListVO":{"type":"object","properties":{"time":{"type":"integer","description":"time","format":"int64"},"wirelessData":{"type":"integer","description":"wireless traffic","format":"int64"},"wiredData":{"type":"integer","description":"wired traffic","format":"int64"},"totalData":{"type":"integer","description":"total traffic","format":"int64"}},"description":"traffic data point"},"TrafficDistributionVO":{"type":"object","properties":{"totalTraffic":{"type":"integer","description":"total traffic","format":"int64"},"wiredTraffic":{"type":"integer","description":"traffic of wired device","format":"int64"},"wirelessTraffic":{"type":"integer","description":"traffic of wireless device","format":"int64"},"trafficDistribution":{"type":"array","description":"traffic data point","items":{"$ref":"#/components/schemas/TrafficDistributionListVO"}}}},"TrafficSummaryListVO":{"type":"object","properties":{"time":{"type":"integer","description":"time","format":"int64"},"txData":{"type":"integer","description":"tx traffic","format":"int64"},"rxData":{"type":"integer","description":"rx traffic","format":"int64"},"totalData":{"type":"integer","description":"total traffic","format":"int64"}},"description":"traffic data point"},"TrafficSummaryVO":{"type":"object","properties":{"totalTraffic":{"type":"integer","description":"total traffic","format":"int64"},"txTraffic":{"type":"integer","description":"tx traffic","format":"int64"},"rxTraffic":{"type":"integer","description":"rx traffic","format":"int64"},"trafficSummary":{"type":"array","description":"traffic data point","items":{"$ref":"#/components/schemas/TrafficSummaryListVO"}}}},"TrendBaseVO":{"type":"object","properties":{"time":{"type":"integer","description":"timestamp","format":"int64"},"count":{"type":"integer","description":"Number of trend","format":"int32"}},"description":"Alert trend"},"WanHealthTrendVO":{"type":"object","properties":{"portId":{"type":"string","description":"Port Id"},"portName":{"type":"string","description":"Port name"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WanScoreVO"}}}},"WanScoreVO":{"type":"object","properties":{"time":{"type":"integer","description":"timestamp","format":"int64"},"score":{"type":"integer","description":"WAN health score","format":"int32"}}},"WifiHealthVO":{"type":"object","properties":{"accessTimeScore":{"type":"integer","description":"Wireless client association time score","format":"int32"},"channelUtilScore":{"type":"integer","description":"AP channel utility score","format":"int32"},"channelInterUtilScore":{"type":"integer","description":"AP channel interference score","format":"int32"},"accessCapacityScore":{"type":"integer","description":"AP Access capacity score","format":"int32"},"rssiScore":{"type":"integer","description":"RSSI score","format":"int32"},"supportAccessCapacity":{"type":"boolean","description":"support AP Access capacity score"},"wirelessClientQualityScore":{"type":"integer","description":"Wireless client quality score (onboarding time)","format":"int32"}}},"WirelessSummaryVO":{"type":"object","properties":{"total":{"type":"integer","description":"total traffic","format":"int64"},"rxTotal":{"type":"integer","description":"rx traffic","format":"int64"},"txTotal":{"type":"integer","description":"tx traffic","format":"int64"},"wireless2gTotal":{"type":"integer","description":"2g traffic","format":"int64"},"wireless2gRx":{"type":"integer","description":"2g client rx traffic","format":"int64"},"wireless2gTx":{"type":"integer","description":"2g client tx traffic","format":"int64"},"wireless5gTotal":{"type":"integer","description":"5g traffic","format":"int64"},"wireless5gRx":{"type":"integer","description":"5g client rx traffic","format":"int64"},"wireless5gTx":{"type":"integer","description":"5g client tx traffic","format":"int64"},"wireless6gTotal":{"type":"integer","description":"6g traffic","format":"int64"},"wireless6gRx":{"type":"integer","description":"6g client rx traffic","format":"int64"},"wireless6gTx":{"type":"integer","description":"6g client tx traffic","format":"int64"}}},"WirelessTrafficSingleVO":{"type":"object","properties":{"totalTraffic":{"type":"integer","description":"total traffic","format":"int64"},"rxTraffic":{"type":"integer","description":"client rx traffic","format":"int64"},"txTraffic":{"type":"integer","description":"client tx traffic","format":"int64"},"trafficTrend":{"type":"array","items":{"$ref":"#/components/schemas/WirelessTrafficTrendVO"}}}},"WirelessTrafficTrendVO":{"type":"object","properties":{"time":{"type":"integer","description":"time","format":"int64"},"totalTraffic":{"type":"integer","description":"total traffic","format":"int64"},"rxTraffic":{"type":"integer","description":"client rx traffic","format":"int64"},"txTraffic":{"type":"integer","description":"client tx traffic","format":"int64"},"wirelessCount":{"type":"integer","description":"number of wireless device","format":"int32"},"wiredCount":{"type":"integer","description":"number of wired device","format":"int32"}}},"WirelessTrafficVO":{"type":"object","properties":{"wirelessSummary":{"$ref":"#/components/schemas/WirelessSummaryVO"},"wireless2gTraffic":{"type":"array","items":{"$ref":"#/components/schemas/WirelessTrafficTrendVO"}},"wireless5gTraffic":{"type":"array","items":{"$ref":"#/components/schemas/WirelessTrafficTrendVO"}},"wireless6gTraffic":{"type":"array","items":{"$ref":"#/components/schemas/WirelessTrafficTrendVO"}},"totalTraffic":{"type":"array","items":{"$ref":"#/components/schemas/WirelessTrafficTrendVO"}}}},"NatTraversalTunnelOpenApiVO":{"required":["appType","localAddress","localPort","name"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name of the remote access tunnel."},"localAddress":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP address of the local target device."},"localPort":{"type":"integer","description":"Port of the local target device's service.","format":"int32"},"duration":{"type":"integer","description":"Valid duration time of the remote access tunnel, 1-24 hours.","format":"int32"},"appType":{"type":"string","description":"App type of the remote access tunnel for the local target device. HTTP, HTTPS, SSH, TELNET."},"openStatus":{"type":"boolean","description":"If open the remote access tunnel after create."},"localMac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"Mac of the local target device."},"clientManager":{"type":"boolean","description":"Client's manager of the remote access tunnel for the client."},"clientName":{"type":"string","description":"Client's name of the remote access tunnel for the client."},"clientDeviceType":{"type":"string","description":"Client's type of the remote access tunnel for the client."},"clientModel":{"type":"string","description":"Client's model of the remote access tunnel for the client."},"tunnelEntryType":{"type":"integer","description":"Entry of the remote access tunnel.1: custom tunnel 2: device tunnel 3:device detail 4:client detail","format":"int32"},"autoLogin":{"type":"boolean","description":"If the remote access tunnel enabled auto login. true: Auto login is enabled; false: Auto login is disabled."}}},"QueryDeviceListOpenApiVO":{"required":["macs"],"type":"object","properties":{"macs":{"type":"array","description":"The device MAC address list.","items":{"type":"string","description":"The device MAC address list."}}}},"OperationResponseQueryDeviceListOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/QueryDeviceListOpenApiVO"}}},"DeletePSKsOpenApiVO":{"required":["ppskNameList"],"type":"object","properties":{"ppskNameList":{"type":"array","description":"PSK names that need to be deleted to the PPSK Profile","items":{"type":"string","description":"PSK names that need to be deleted to the PPSK Profile"}}}},"AddPSKsOpenApiVO":{"required":["ppskList"],"type":"object","properties":{"ppskList":{"type":"array","description":"PSK entries that need to be added to the PPSK Profile","items":{"$ref":"#/components/schemas/PpskSetting"}}}},"Applied Config":{"type":"object","properties":{"appliedConfig":{"type":"integer","description":"The value of parameter [appliedConfig] should be 1 or 2. 1: apply recommended config. 2: apply previous config.","format":"int32"}}},"Batch Delete PlanningHistory":{"type":"object","properties":{"type":{"type":"string","description":"Delete policy, all: delete all history, include: delete history in ids, exclude: exclude history in ids."},"ids":{"type":"array","description":"HistoryId list","items":{"type":"string","description":"HistoryId list"}},"start":{"type":"integer","description":"Start time of the history to be deleted(millisecond timestamp)","format":"int64"},"end":{"type":"integer","description":"End time of the history to be deleted(millisecond timestamp)","format":"int64"},"filter_mode":{"type":"integer","description":"filtermode should be a value as follows: 1: rfPlanningHistory mode is manual; 2:rfPlanningHistory mode is adaptive","format":"int32"}}},"BatchOspfProcessOpenApiVO":{"required":["processIdList","selectType"],"type":"object","properties":{"processIdList":{"type":"array","description":"List of Process ID","items":{"type":"string","description":"List of Process ID"}},"selectType":{"type":"integer","description":"Select Type, it should be a value as follows: 1: SELECT ALL, 2: SELECT INCLUDE, 3: SELECT EXCLUDE.","format":"int32"},"searchKey":{"type":"string","description":"SearchKey"}}},"BatchOspfInterfaceOpenApiVO":{"required":["interfaceIdList","selectType"],"type":"object","properties":{"interfaceIdList":{"type":"array","description":"List of Interface ID","items":{"type":"string","description":"List of Interface ID"}},"selectType":{"type":"integer","description":"Select Type, it should be a value as follows: 1: SELECT ALL, 2: SELECT INCLUDE, 3: SELECT EXCLUDE.","format":"int32"},"searchKey":{"type":"string","description":"SearchKey"}}},"DeviceRebootAppDTO":{"required":["mac","saveCurrentConfig"],"type":"object","properties":{"mac":{"type":"string","description":"List of device keys for devices to be restarted."},"saveCurrentConfig":{"type":"integer","description":"Whether to save the current configuration.","format":"int32"},"slots":{"type":"array","description":"Slot ID list should be within the range of 1 to 4","items":{"type":"integer","description":"Slot ID list should be within the range of 1 to 4","format":"int32"}},"issu":{"type":"integer","description":"Perform non-disruptive software upgrades, first upgrading the backup control board, then switching the primary and backup roles, and subsequently upgrading the other control board. Issu should be a value as follows: 1:ENABLE;0:DISABLE, effective only on the primary control board.","format":"int32"},"rebootId":{"type":"string","description":"Generated device batch restart ID."},"token":{"type":"string","description":"User token"},"controlType":{"type":"integer","description":"Types of user access to the Omada Controller, such as local web access, etc.","format":"int32"},"status":{"type":"integer","description":"Status","format":"int32"},"statusCategory":{"type":"integer","description":"Status category.StatusCategory should be a value as follows:0:Disconnected;1:Connected;2:Pending;3:Heartbeat Missed;4:Isolated.","format":"int32"}}},"OperationResponseDeviceRebootAppDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceRebootAppDTO"}}},"SystemInfoAppModifyDTO":{"type":"object","properties":{"deviceName":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"Device name should contain 1-32 bits numbers, Upper and lower letters, -@_:/. ."},"deviceLocation":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"Device location should contain 1-32 bits numbers, Upper and lower letters, -@_:/. ."},"contactInformation":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"Contact information should contain 1-32 bits numbers, Upper and lower letters, -@_:/. ."}}},"DeviceResponseBodyVoid":{"type":"object","properties":{"deviceType":{"type":"string","description":"deviceType should be a value as follows:ap,gateway,switch,pro ap,pro gateway,pro switch,festa ap,festa gateway,festa switch,ems,olt,onu.","enum":["ap","gateway","switch","pro ap","pro gateway","pro switch","festa ap","festa gateway","festa switch","ems","olt","onu"]},"errcode":{"type":"integer","description":"Device error code.","format":"int32"},"message":{"type":"string","description":"Device error message"},"data":{"type":"object","description":"Device configuration information.If the type of data is 'Object',ignore this field"}}},"ManagementSystemInterfaceDTO":{"type":"object","properties":{"systemInterfaces":{"type":"array","description":"Management System Interfaces.","items":{"$ref":"#/components/schemas/SystemInterfaceDTO"}}}},"SystemInterfaceDTO":{"required":["interfaceType"],"type":"object","properties":{"interfaceId":{"type":"integer","description":"Management System Interface ID, its value should be within the range of 0-3.","format":"int32"},"interfaceType":{"type":"string","description":"Interface Type should be a value as follows: MANAGEMENT, NONE, VLAN, ROUTED_PORT, PORT_CHANNEL.","enum":["MANAGEMENT","NONE","VLAN","ROUTED_PORT","PORT_CHANNEL"]},"interfaceValue":{"type":"string","description":"Interface Value"}},"description":"Management System Interfaces."},"ServicePortModifyDTO":{"required":["adminStatus","index","onuId","statisticPerformance"],"type":"object","properties":{"ponPortId":{"type":"integer","description":"PonPortId should be within the range of 1 to 16","format":"int32"},"ponPortStr":{"type":"string","description":"String form of pon port"},"svlan":{"type":"integer","description":"SVlan should be within the range of 1 to 4095","format":"int32"},"gemPortId":{"type":"integer","description":"GemPortId should be within the range of 1 to 1023","format":"int32"},"userVlan":{"type":"integer","description":"UserVlan should be within the range of 0 to 4095","format":"int32"},"userVlanPriority":{"type":"integer","description":"UserVlanPriority should be within the range of -1 to 7","format":"int32"},"tagAction":{"type":"string","description":"TagAction should be a value as follows:DEFAULT,TRANSPARENT,TRANSLATE,TRANSLATE_AND_ADD,ADD_DOUBLE","enum":["DEFAULT","TRANSPARENT","TRANSLATE","TRANSLATE_AND_ADD","ADD_DOUBLE"]},"innerVlan":{"type":"integer","description":"InnerVlan should be within the range of 0 to 4095","format":"int32"},"innerVlanPriority":{"type":"integer","description":"InnerVlanPriority should be within the range of -1 to 7","format":"int32"},"etherType":{"type":"string","description":"EtherType should be a value as follows:NONE,IPV4OE,IPV6OE,PPPOE","enum":["NONE","IPV4OE","IPV6OE","PPPOE"]},"inboundTrafficProfileId":{"type":"integer","description":"InboundTrafficProfileId should be within the range of 0 to 512","format":"int32"},"outboundTrafficProfileId":{"type":"integer","description":"OutboundTrafficProfileId should be within the range of 0 to 512","format":"int32"},"index":{"type":"integer","description":"Service port ID should be within the range of 1 to 8100","format":"int32"},"description":{"pattern":"^[a-z0-9A-Z-@_:/.]{0,32}$","type":"string","description":"Description of service port.Description should contain 1 to 32 characters including numbers, Upper and lower letters, -@_:/. ."},"onuId":{"type":"integer","description":"Onu ID should be within the range of 0 to 127","format":"int32"},"adminStatus":{"type":"string","description":"The enable status of the service flows matched by this Service Port. AdminStatus should be a value as follows: DISABLE,ENABLE. Default value: ENABLE.","enum":["DISABLE","ENABLE"]},"statisticPerformance":{"type":"string","description":"The traffic statistics switch status for the service flows matched by this Service Port. StatisticPerformance should be a value as follows: DISABLE,ENABLE. Default value: DISABLE.","enum":["DISABLE","ENABLE"]}}},"OperationResponseDeviceResponseBodyVoid":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceResponseBodyVoid"}}},"IntIdListRequest":{"required":["ids"],"type":"object","properties":{"ids":{"type":"array","description":"ID list","items":{"type":"integer","description":"ID list","format":"int32"}}}},"ServicePortAddDTO":{"required":["adminStatus","batchConfig","onuId","statisticPerformance"],"type":"object","properties":{"ponPortId":{"type":"integer","description":"PonPortId should be within the range of 1 to 16","format":"int32"},"ponPortStr":{"type":"string","description":"String form of pon port"},"svlan":{"type":"integer","description":"SVlan should be within the range of 1 to 4095","format":"int32"},"gemPortId":{"type":"integer","description":"GemPortId should be within the range of 1 to 1023","format":"int32"},"userVlan":{"type":"integer","description":"UserVlan should be within the range of 0 to 4095","format":"int32"},"userVlanPriority":{"type":"integer","description":"UserVlanPriority should be within the range of -1 to 7","format":"int32"},"tagAction":{"type":"string","description":"TagAction should be a value as follows:DEFAULT,TRANSPARENT,TRANSLATE,TRANSLATE_AND_ADD,ADD_DOUBLE","enum":["DEFAULT","TRANSPARENT","TRANSLATE","TRANSLATE_AND_ADD","ADD_DOUBLE"]},"innerVlan":{"type":"integer","description":"InnerVlan should be within the range of 0 to 4095","format":"int32"},"innerVlanPriority":{"type":"integer","description":"InnerVlanPriority should be within the range of -1 to 7","format":"int32"},"etherType":{"type":"string","description":"EtherType should be a value as follows:NONE,IPV4OE,IPV6OE,PPPOE","enum":["NONE","IPV4OE","IPV6OE","PPPOE"]},"inboundTrafficProfileId":{"type":"integer","description":"InboundTrafficProfileId should be within the range of 0 to 512","format":"int32"},"outboundTrafficProfileId":{"type":"integer","description":"OutboundTrafficProfileId should be within the range of 0 to 512","format":"int32"},"index":{"type":"integer","description":"ID of service port.Index should be within the range of 1 to 8100","format":"int32"},"batchConfig":{"type":"boolean","description":"Whether it is batch addition.Default value:false"},"description":{"pattern":"^[a-z0-9A-Z-@_:/.]{0,32}$","type":"string","description":"Description of service port.Description should be 1-32 characters, including letters, numbers, and symbols (-@_:/.)."},"onuId":{"type":"string","description":"OnuId should be within the range of 0 to 127"},"adminStatus":{"type":"string","description":"The enable status of the service flows matched by this Service Port. AdminStatus should be a value as follows: DISABLE,ENABLE. Default value: ENABLE.","enum":["DISABLE","ENABLE"]},"statisticPerformance":{"type":"string","description":"The traffic statistics switch status for the service flows matched by this Service Port. StatisticPerformance should be a value as follows: DISABLE,ENABLE. Default value: DISABLE.","enum":["DISABLE","ENABLE"]}}},"StatisticConfigDTO":{"type":"object","properties":{"autoRefresh":{"type":"string","description":"AutoRefresh should be a value as follows:DISABLE,ENABLE","enum":["DISABLE","ENABLE"]},"refreshInterval":{"type":"integer","description":"RefreshInterval should be within the range of 3 to 300","format":"int32"}}},"TrafficProfileModifyDTO":{"required":["innerPriority","priority","priorityPolicy","priorityValue","rateLimitStatus","trafficId"],"type":"object","properties":{"name":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"Name of the traffic profile. No user configuration is automatically generated by the device. The name should contain 1 to 32 characters, including upper and lower letters, numbers, and symbols (-@_:/.)."},"rateLimitStatus":{"type":"string","description":"Whether to enable rate limit.RateLimitStatus should be a value as follows:DISABLE,ENABLE.ENABLE by default.When enabled, CIR must be configured, while CBS, PIR, and PBS parameters are optional.When disabled, the CIR, CBS, PIR, and PBS parameters are grayed out and cannot be configured.","enum":["DISABLE","ENABLE"]},"cirValue":{"type":"integer","description":"CirValue should be within the range of 128 to 10240000","format":"int32"},"cbsValue":{"type":"integer","description":"CbsValue should be within the range of 2000 to 10240000","format":"int32"},"pirValue":{"type":"integer","description":"PirValue should be within the range of 128 to 10240000","format":"int32"},"pbsValue":{"type":"integer","description":"PbsValue should be within the range of 2000 to 10240000","format":"int32"},"priority":{"type":"string","description":"Priority type of the traffic profile.Priority should be a value as follows:ASSIGNED,USER_COS","enum":["ASSIGNED","USER_COS"]},"priorityValue":{"type":"integer","description":"Priority value of the traffic profile.PriorityValue should be within the range of 0 to 7","format":"int32"},"innerPriority":{"type":"string","description":"Inner priority type of the traffic profile,innerPriority should be a value as follows ASSIGNED, NONE, USER_COS, USER_INNER_COS","enum":["ASSIGNED","NONE","USER_COS","USER_INNER_COS"]},"innerPriorityValue":{"type":"integer","description":"Inner priority value of the traffic profile.InnerPriorityValue should be within the range of 0 to 7","format":"int32"},"priorityPolicy":{"type":"string","description":"Traffic priority policy should be a value as follows:LOCAL_SETTING, TAG_IN_PACKAGE, TAG_IN_INGRESS_PACKAGE","enum":["LOCAL_SETTING","TAG_IN_PACKAGE","TAG_IN_INGRESS_PACKAGE"]},"isInUse":{"type":"boolean","description":"Whether the Traffic Profile is in use; if it is in use, it cannot be deleted."},"trafficId":{"type":"integer","description":"Traffic profile ID.TrafficId should be within the range of 1 to 512","format":"int32"}}},"DeviceResponseBodyTrafficProfileDeleteResultDTO":{"type":"object","properties":{"deviceType":{"type":"string","description":"deviceType should be a value as follows:ap,gateway,switch,pro ap,pro gateway,pro switch,festa ap,festa gateway,festa switch,ems,olt,onu.","enum":["ap","gateway","switch","pro ap","pro gateway","pro switch","festa ap","festa gateway","festa switch","ems","olt","onu"]},"errcode":{"type":"integer","description":"Device error code.","format":"int32"},"message":{"type":"string","description":"Device error message"},"data":{"$ref":"#/components/schemas/TrafficProfileDeleteResultDTO"}}},"OperationResponseDeviceResponseBodyTrafficProfileDeleteResultDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceResponseBodyTrafficProfileDeleteResultDTO"}}},"TrafficProfileDeleteResultDTO":{"type":"object","properties":{"profilesInUse":{"type":"array","description":"A list of Traffic Profile IDs that failed to delete due to being in use.","items":{"type":"integer","description":"A list of Traffic Profile IDs that failed to delete due to being in use.","format":"int32"}}},"description":"Device configuration information.If the type of data is 'Object',ignore this field"},"TrafficProfileDTO":{"required":["innerPriority","priority","priorityPolicy","priorityValue","rateLimitStatus","trafficId"],"type":"object","properties":{"name":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"Name of the traffic profile. No user configuration is automatically generated by the device. The name should contain 1 to 32 characters, including upper and lower letters, numbers, and symbols (-@_:/.)."},"rateLimitStatus":{"type":"string","description":"Whether to enable rate limit.RateLimitStatus should be a value as follows:DISABLE,ENABLE.ENABLE by default.When enabled, CIR must be configured, while CBS, PIR, and PBS parameters are optional.When disabled, the CIR, CBS, PIR, and PBS parameters are grayed out and cannot be configured.","enum":["DISABLE","ENABLE"]},"cirValue":{"type":"integer","description":"CirValue should be within the range of 128 to 10240000","format":"int32"},"cbsValue":{"type":"integer","description":"CbsValue should be within the range of 2000 to 10240000","format":"int32"},"pirValue":{"type":"integer","description":"PirValue should be within the range of 128 to 10240000","format":"int32"},"pbsValue":{"type":"integer","description":"PbsValue should be within the range of 2000 to 10240000","format":"int32"},"priority":{"type":"string","description":"Priority type of the traffic profile.Priority should be a value as follows:ASSIGNED,USER_COS","enum":["ASSIGNED","USER_COS"]},"priorityValue":{"type":"integer","description":"Priority value of the traffic profile.PriorityValue should be within the range of 0 to 7","format":"int32"},"innerPriority":{"type":"string","description":"Inner priority type of the traffic profile,innerPriority should be a value as follows ASSIGNED, NONE, USER_COS, USER_INNER_COS","enum":["ASSIGNED","NONE","USER_COS","USER_INNER_COS"]},"innerPriorityValue":{"type":"integer","description":"Inner priority value of the traffic profile.InnerPriorityValue should be within the range of 0 to 7","format":"int32"},"priorityPolicy":{"type":"string","description":"Traffic priority policy should be a value as follows:LOCAL_SETTING, TAG_IN_PACKAGE, TAG_IN_INGRESS_PACKAGE","enum":["LOCAL_SETTING","TAG_IN_PACKAGE","TAG_IN_INGRESS_PACKAGE"]},"isInUse":{"type":"boolean","description":"Whether the Traffic Profile is in use; if it is in use, it cannot be deleted."},"trafficId":{"type":"integer","description":"Traffic profile ID.TrafficId should be within the range of 1 to 512","format":"int32"}}},"DeviceResponseBodyTrafficProfileAddResultDTO":{"type":"object","properties":{"deviceType":{"type":"string","description":"deviceType should be a value as follows:ap,gateway,switch,pro ap,pro gateway,pro switch,festa ap,festa gateway,festa switch,ems,olt,onu.","enum":["ap","gateway","switch","pro ap","pro gateway","pro switch","festa ap","festa gateway","festa switch","ems","olt","onu"]},"errcode":{"type":"integer","description":"Device error code.","format":"int32"},"message":{"type":"string","description":"Device error message"},"data":{"$ref":"#/components/schemas/TrafficProfileAddResultDTO"}}},"OperationResponseDeviceResponseBodyTrafficProfileAddResultDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceResponseBodyTrafficProfileAddResultDTO"}}},"TrafficProfileAddResultDTO":{"type":"object","properties":{"name":{"type":"string","description":"Name of the traffic profile."},"trafficId":{"type":"integer","description":"Traffic profile ID","format":"int32"}},"description":"Device configuration information.If the type of data is 'Object',ignore this field"},"OntPortVlanConfigAddItemDTO":{"required":["svlan","vlanMode"],"type":"object","properties":{"vlanMode":{"type":"string","description":"Vlan mode should not be null,vlanMode should be a value as follows:TRANSLATION,QINQ,TRUNK","enum":["TRANSLATION","QINQ","TRUNK"]},"svlan":{"type":"integer","description":"SVlan ID should be within the range of 1 to 4095 and should not be null","format":"int32"},"spriority":{"type":"integer","description":"SVlan priority should be within the range of -2 to 7","format":"int32"},"cvlan":{"type":"integer","description":"CVlan ID should be within the range of 1 to 4095","format":"int32"},"cpriority":{"type":"integer","description":"CVlan priority should be within the range of -1 to 7","format":"int32"}},"description":"Config item add list"},"OntPortVlanConfigItemDTO":{"required":["id","svlan","vlanMode"],"type":"object","properties":{"id":{"type":"integer","description":"Vlan ID should not be null","format":"int32"},"vlanMode":{"type":"string","description":"Vlan mode should not be null,vlanMode should be a value as follows:TRANSLATION,QINQ,TRUNK","enum":["TRANSLATION","QINQ","TRUNK"]},"svlan":{"type":"integer","description":"SVlan ID should be within the range of 1 to 4095 and should not be null","format":"int32"},"spriority":{"type":"integer","description":"SVlan priority should be within the range of -2 to 7","format":"int32"},"cvlan":{"type":"integer","description":"CVlan ID should be within the range of 1 to 4095","format":"int32"},"cpriority":{"type":"integer","description":"CVlan priority should be within the range of -1 to 7","format":"int32"}},"description":"Config item edit list"},"OntPotsPortModifyDTO":{"required":["vlanConfigMode"],"type":"object","properties":{"serviceId":{"type":"integer","description":"The associated Service Profile ID","format":"int32"},"vlanConfigMode":{"type":"string","description":"Vlan config mode.VlanConfigMode should be a value as follows:TRANSPARENT,OTHERS","enum":["TRANSPARENT","OTHERS"]},"configItemAddList":{"type":"array","description":"Config item add list","items":{"$ref":"#/components/schemas/OntPortVlanConfigAddItemDTO"}},"configItemDeleteList":{"type":"array","description":"Config item delete list","items":{"type":"integer","description":"Config item delete list","format":"int32"}},"configItemEditList":{"type":"array","description":"Config item edit list","items":{"$ref":"#/components/schemas/OntPortVlanConfigItemDTO"}}}},"OntEthPortIGMPForwardDTO":{"required":["igmpForwardMode"],"type":"object","properties":{"igmpForwardMode":{"type":"string","description":"IgmpForwardMode should not be null,igmpForwardMode should be a value as follows:UNCONCERN,TRANSLATION,DEFAULT,TRANSPARENT","enum":["UNCONCERN","TRANSLATION","DEFAULT","TRANSPARENT"]},"vlan":{"type":"integer","description":"Vlan should be within the range of 1 to 4095","format":"int32"},"priority":{"type":"integer","description":"Priority should be within the range of -1 to 7","format":"int32"}},"description":"IgmpForward"},"OntEthPortModifyDTO":{"required":["portId"],"type":"object","properties":{"serviceId":{"type":"integer","description":"The associated Service Profile ID","format":"int32"},"portId":{"type":"integer","description":"Port ID","format":"int32"},"vlanConfig":{"$ref":"#/components/schemas/OntEthPortVlanConfigModifyDTO"},"priorityPolicy":{"type":"string","description":"Priority policy should be a value as follows:UNCONCERN,ASSIGNED,COPY_COS","enum":["UNCONCERN","ASSIGNED","COPY_COS"]},"igmpForward":{"$ref":"#/components/schemas/OntEthPortIGMPForwardDTO"},"maxMacCount":{"type":"integer","description":"MaxMacCount should be within the range of 0 to 255","format":"int32"},"qinQ":{"type":"string","description":"QinQ mode,qinQ should be a value as follows:UNCONCERN,DISABLE,ENABLE","enum":["UNCONCERN","DISABLE","ENABLE"]},"tlsVlan":{"type":"string","description":"Tls vlan"}}},"OntEthPortVlanConfigModifyDTO":{"required":["vlanConfigMode"],"type":"object","properties":{"vlanConfigMode":{"type":"string","enum":["TRANSPARENT","OTHERS"]},"configItemAddList":{"type":"array","items":{"$ref":"#/components/schemas/OntPortVlanConfigAddItemDTO"}},"configItemDeleteList":{"type":"array","items":{"type":"integer","format":"int32"}},"configItemEditList":{"type":"array","items":{"$ref":"#/components/schemas/OntPortVlanConfigItemDTO"}}},"description":"Configure the VLAN TAG processing mode of the ONT port"},"ServiceProfileModifyDTO":{"required":["multicastForward","serviceId"],"type":"object","properties":{"serviceId":{"type":"integer","description":"Service profile ID should be within the range of 1 to 512 ","format":"int32"},"name":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"Name of the service profile. No user configuration is automatically generated by the device. The name should contain 1 to 32 characters, including upper and lower letters, numbers, and symbols (-@_:/.)."},"ethNum":{"type":"integer","description":"Number of eth port.EthNum should be within the range of -1 to 24.-1 indicates that the number of ports is adaptive. The default value is -1.","format":"int32"},"maxAdaptiveEthNum":{"type":"integer","description":"Set the maximum number of automatically recognized ETH ports.When ethNum is set to -1, a prompt will appear.MaxAdaptiveEthNum should be within the range of 0 to 24","format":"int32"},"potsNum":{"type":"integer","description":"Number of ONU pots.PotsNum should be within the range of -1 to 8.-1 indicates that the number of ports is adaptive. The default value is -1.","format":"int32"},"maxAdaptivePotsNum":{"type":"integer","description":"Set the maximum number of automatically recognized potsWhen potsNum is set to -1, a prompt will appear.MaxAdaptivePotsNum should be within the range of 0 to 4","format":"int32"},"macLearning":{"type":"string","description":"Enable/disable ONT MAC address learning function. MacLearning should be a value as follows:DISABLE,ENABLE","enum":["DISABLE","ENABLE"]},"multicastMode":{"type":"string","description":"Set the multicast mode of the ONT. MulticastMode should be a value as follows:UNCONCERN,IGMP_SNOOPING,OLT_CONTROL","enum":["UNCONCERN","IGMP_SNOOPING","OLT_CONTROL"]},"multicastForward":{"type":"string","description":"Set the multicast packet forwarding mode of the ONT. NativeVlan should be a value as follows:UNCONCERN,TAGGED,UNTAGGED","enum":["UNCONCERN","TAGGED","UNTAGGED"]},"taggedType":{"type":"string","description":"TaggedType should be a value as follows:TRANSPARENT,TRANSLATION","enum":["TRANSPARENT","TRANSLATION"]},"taggedVlanId":{"type":"integer","description":"TaggedVlanId should be within the range of 1–4094","format":"int32"},"nativeVlan":{"type":"string","description":"The ONT's concern for Native VLAN .NativeVlan should be a value as follows:UNCONCERN,CONCERN","enum":["UNCONCERN","CONCERN"]}}},"DeviceResponseBodyServiceProfileDeleteResultDTO":{"type":"object","properties":{"deviceType":{"type":"string","description":"deviceType should be a value as follows:ap,gateway,switch,pro ap,pro gateway,pro switch,festa ap,festa gateway,festa switch,ems,olt,onu.","enum":["ap","gateway","switch","pro ap","pro gateway","pro switch","festa ap","festa gateway","festa switch","ems","olt","onu"]},"errcode":{"type":"integer","description":"Device error code.","format":"int32"},"message":{"type":"string","description":"Device error message"},"data":{"$ref":"#/components/schemas/ServiceProfileDeleteResultDTO"}}},"OperationResponseDeviceResponseBodyServiceProfileDeleteResultDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceResponseBodyServiceProfileDeleteResultDTO"}}},"ServiceProfileDeleteResultDTO":{"type":"object","properties":{"profilesInUse":{"type":"array","description":"List of Service Profile IDs that failed to delete due to being in use.","items":{"type":"integer","description":"List of Service Profile IDs that failed to delete due to being in use.","format":"int32"}}},"description":"Device configuration information.If the type of data is 'Object',ignore this field"},"ServiceProfileDTO":{"required":["ethNum","macLearning","multicastForward","multicastMode","nativeVlan","potsNum","serviceId"],"type":"object","properties":{"serviceId":{"type":"integer","description":"Service profile ID should be within the range of 1 to 512 ","format":"int32"},"isInUse":{"type":"boolean","description":"Whether the service profile is in use"},"name":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"Name of the service profile. No user configuration is automatically generated by the device. The name should contain 1 to 32 characters, including upper and lower letters, numbers, and symbols (-@_:/.)."},"ethNum":{"type":"integer","description":"Number of eth port.EthNum should be within the range of -1 to 24.-1 indicates that the number of ports is adaptive. The default value is -1.","format":"int32"},"maxAdaptiveEthNum":{"type":"integer","description":"Set the maximum number of automatically recognized ETH ports.When ethNum is set to -1, a prompt will appear.MaxAdaptiveEthNum should be within the range of 0 to 24","format":"int32"},"potsNum":{"type":"integer","description":"Number of ONU pots.PotsNum should be within the range of -1 to 8.-1 indicates that the number of ports is adaptive. The default value is -1.","format":"int32"},"maxAdaptivePotsNum":{"type":"integer","description":"Set the maximum number of automatically recognized potsWhen potsNum is set to -1, a prompt will appear.MaxAdaptivePotsNum should be within the range of 0 to 4","format":"int32"},"macLearning":{"type":"string","description":"Enable/disable ONT MAC address learning function. MacLearning should be a value as follows:DISABLE,ENABLE","enum":["DISABLE","ENABLE"]},"nativeVlan":{"type":"string","description":"The ONT's concern for Native VLAN .NativeVlan should be a value as follows:UNCONCERN,CONCERN","enum":["UNCONCERN","CONCERN"]},"multicastMode":{"type":"string","description":"Set the multicast mode of the ONT. MulticastMode should be a value as follows:UNCONCERN,IGMP_SNOOPING,OLT_CONTROL","enum":["UNCONCERN","IGMP_SNOOPING","OLT_CONTROL"]},"multicastForward":{"type":"string","description":"Set the multicast packet forwarding mode of the ONT. NativeVlan should be a value as follows:UNCONCERN,TAGGED,UNTAGGED","enum":["UNCONCERN","TAGGED","UNTAGGED"]},"taggedType":{"type":"string","description":"TaggedType should be a value as follows:TRANSPARENT,TRANSLATION","enum":["TRANSPARENT","TRANSLATION"]},"taggedVlanId":{"type":"integer","description":"TaggedVlanId should be within the range of 1–4094","format":"int32"},"onuBindNum":{"type":"integer","description":"The number of ONU/ONT instances that use this Service template.","format":"int32"}}},"DeviceResponseBodyServiceProfileDTO":{"type":"object","properties":{"deviceType":{"type":"string","description":"deviceType should be a value as follows:ap,gateway,switch,pro ap,pro gateway,pro switch,festa ap,festa gateway,festa switch,ems,olt,onu.","enum":["ap","gateway","switch","pro ap","pro gateway","pro switch","festa ap","festa gateway","festa switch","ems","olt","onu"]},"errcode":{"type":"integer","description":"Device error code.","format":"int32"},"message":{"type":"string","description":"Device error message"},"data":{"$ref":"#/components/schemas/ServiceProfileDTO"}}},"OperationResponseDeviceResponseBodyServiceProfileDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceResponseBodyServiceProfileDTO"}}},"ServicePortProfileModifyDTO":{"required":["servicePortProfileId"],"type":"object","properties":{"servicePortProfileId":{"type":"string","description":"Service port template ID. The servicePortProfileId should be within the range of 1 to 512, E.g.,1. It can be obtained from \"Get service port profile list\" interface."},"servicePortProfileName":{"type":"string","description":"Name of the service port template. No user configuration is automatically generated by the device. The name should contain 1 to 32 characters, including upper and lower letters, numbers, and symbols (-@_:/.)."}}},"ServicePortProfileDetailDTO":{"required":["adminStatus","creationMode","entriesNumber","etherType","gemId","inUse","inboundTrafficProfileId","innerVlan","innerVlanPriority","outboundTrafficProfileId","servicePortId","servicePortProfileId","statisticPerformance","svlan","tagAction","userVlan","userVlanPriority"],"type":"object","properties":{"servicePortId":{"type":"string","description":"Service port profile ID. The servicePortProfileId should be within the range of 1 to 127."},"servicePortProfileId":{"type":"string","description":"Service template ID. The servicePortProfileId should be within the range of 1 to 127. It can be obtained from \"Get service port profile list\""},"svlan":{"type":"integer","description":"Bound network VLAN ID after automatic flow creation. The svlan should be within the range of 1-4094.","format":"int32"},"gemId":{"type":"integer","description":"Gem Port ID for automatic flow creation. The gemPort should be within the range of 1-1023.","format":"int32"},"userVlan":{"type":"integer","description":"User VLAN ID for automatic flow creation. The userVlan should be within the range of 0-4094.","format":"int32"},"userVlanPriority":{"type":"integer","description":"User VLAN priority. The userVlanPriority should be within the range of -1 to 7, -1 indicating not configuring the item.","format":"int32"},"tagAction":{"type":"string","description":"VLAN TAG operation after automatic flow creation  ","enum":["DEFAULT","TRANSPARENT","TRANSLATE","TRANSLATE_AND_ADD","ADD_DOUBLE"]},"innerVlan":{"type":"integer","description":"Inner VLAN ID for automatic flow creation. This parameter is associated with tagAction. When tagAction is TRANSLATE_AND_ADD/ADD_DOUBLE, this parameter is valid. The innerVlan should be within the range of 0-4094, -1 indicating not configuring the item. ","format":"int32"},"innerVlanPriority":{"type":"integer","description":"Inner VLAN priority. This parameter is associated with tagAction. When tagAction is TRANSLATE_AND_ADD/ADD_DOUBLE, this parameter is valid. The innerVlanPriority should be within the range of -1 to 7, -1 indicating not configuring the item.","format":"int32"},"etherType":{"type":"string","description":"Message type ","enum":["NONE","IPV4OE","IPV6OE","PPPOE"]},"inboundTrafficProfileId":{"type":"integer","description":"Inbound traffic profile ID. The inboundTrafficProfileId should be within the range of 1-1023, -1 indicating not configuring the item.","format":"int32"},"outboundTrafficProfileId":{"type":"integer","description":"Outbound traffic profile ID. The outboundTrafficProfileId should be within the range of 1-1023, -1 indicating not configuring the item.","format":"int32"},"statisticPerformance":{"type":"string","description":"Whether to enable traffic flow statistics ","enum":["DISABLE","ENABLE"]},"adminStatus":{"type":"string","description":"Whether to enable traffic flow ","enum":["DISABLE","ENABLE"]},"description":{"type":"string","description":"Service port description. Description should contain 1-32 characters, including uppercase and lowercase letters, numbers, and symbols(-@_:/.)."},"creationMode":{"type":"string","description":"The creation mode ","enum":["MANUAL","AUTO"]},"entriesNumber":{"type":"integer","description":"Service port amount. The entriesNumber should be within the range of 0 to 127.","format":"int32"},"inUse":{"type":"string","description":"Indicate whether the profile has been used ","enum":["DISABLE","ENABLE"]}}},"ServicePortProfileDetailDeleteDTO":{"type":"object","properties":{"servicePortId":{"maxItems":50,"minItems":1,"type":"array","description":"Service port ID List. It can be obtained from\"Get service port profile detail list\" interface. Up to 50 entries are allowed for the ids list. ","items":{"maxLength":50,"minLength":1,"type":"string","description":"Service port ID List. It can be obtained from\"Get service port profile detail list\" interface. Up to 50 entries are allowed for the ids list. "}},"servicePortProfileId":{"type":"string","description":"Service port profile ID. The servicePortProfileId should be within the range of 1 to 127. It can be obtained from \"Get service port profile detail\"."}}},"ServicePortProfileDeleteDTO":{"type":"object","properties":{"keys":{"maxItems":50,"minItems":1,"type":"array","description":"Service port profile Id. The service port profile ID should be within the range of 1 to 512 and it can be obtained from \"Get service port profile list\" interface. Up to 50 entries are allowed for the ids list.","items":{"maxLength":50,"minLength":1,"type":"string","description":"Service port profile Id. The service port profile ID should be within the range of 1 to 512 and it can be obtained from \"Get service port profile list\" interface. Up to 50 entries are allowed for the ids list."}}}},"DeviceResponseBodyServicePortProfileModifyDTO":{"type":"object","properties":{"deviceType":{"type":"string","description":"deviceType should be a value as follows:ap,gateway,switch,pro ap,pro gateway,pro switch,festa ap,festa gateway,festa switch,ems,olt,onu.","enum":["ap","gateway","switch","pro ap","pro gateway","pro switch","festa ap","festa gateway","festa switch","ems","olt","onu"]},"errcode":{"type":"integer","description":"Device error code.","format":"int32"},"message":{"type":"string","description":"Device error message"},"data":{"$ref":"#/components/schemas/ServicePortProfileModifyDTO"}}},"OperationResponseDeviceResponseBodyServicePortProfileModifyDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceResponseBodyServicePortProfileModifyDTO"}}},"TcontModifyDTO":{"required":["tcontId"],"type":"object","properties":{"tcontId":{"type":"integer","description":"T-cont ID should be within the range of 1 to 127 and should not be null","format":"int32"},"lineProfileId":{"type":"integer","description":"The ID of the associated Line Profile,lineProfile should be within the range of 1 to 512.","format":"int32"},"dbaId":{"type":"integer","description":"The DBA template ID bound to the T-cont. DbaId should be within the range of 0 to 512. Currently existing DBA templates, including DBA system templates, can also be referenced by the T-cont.","format":"int32"}}},"TcontDeleteDTO":{"required":["ids"],"type":"object","properties":{"ids":{"type":"array","description":"ID list","items":{"type":"integer","description":"ID list","format":"int32"}},"lineProfileId":{"type":"integer","description":"The ID of the associated Line Profile,lineProfile should be within the range of 1 to 512.","format":"int32"}}},"DeviceResponseBodyTcontDeleteResultDTO":{"type":"object","properties":{"deviceType":{"type":"string","description":"deviceType should be a value as follows:ap,gateway,switch,pro ap,pro gateway,pro switch,festa ap,festa gateway,festa switch,ems,olt,onu.","enum":["ap","gateway","switch","pro ap","pro gateway","pro switch","festa ap","festa gateway","festa switch","ems","olt","onu"]},"errcode":{"type":"integer","description":"Device error code.","format":"int32"},"message":{"type":"string","description":"Device error message"},"data":{"$ref":"#/components/schemas/TcontDeleteResultDTO"}}},"OperationResponseDeviceResponseBodyTcontDeleteResultDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceResponseBodyTcontDeleteResultDTO"}}},"TcontDeleteResultDTO":{"type":"object","properties":{"tcontsInUse":{"type":"array","description":" List of T-cont IDs that failed to delete because they are in use.","items":{"type":"integer","description":" List of T-cont IDs that failed to delete because they are in use.","format":"int32"}}},"description":"Device configuration information.If the type of data is 'Object',ignore this field"},"TcontDTO":{"required":["dbaId","tcontId"],"type":"object","properties":{"tcontId":{"type":"integer","description":"T-cont ID should be within the range of 1 to 127 and should not be null","format":"int32"},"lineProfileId":{"type":"integer","description":"The ID of the associated Line Profile,lineProfile should be within the range of 1 to 512.","format":"int32"},"dbaId":{"type":"integer","description":"The DBA template ID bound to the T-cont. DbaId should be a within the range of 0 to 512. Currently existing DBA templates, including DBA system templates, can also be referenced by the T-cont.","format":"int32"},"gemPortIds":{"type":"array","description":"A list of GEM Port IDs bound to this T-Cont.","items":{"type":"integer","description":"A list of GEM Port IDs bound to this T-Cont.","format":"int32"}},"isInUse":{"type":"boolean","description":"Whether the T-cont has been used. If it has been used, it cannot be deleted. True indicates it has been used, while false indicates it has not been used. "}}},"GemPortModifyDTO":{"required":["gemPortId"],"type":"object","properties":{"gemPortId":{"type":"integer","description":"Gem port ID should be within the range of 1 to 1023","format":"int32"},"lineProfileId":{"type":"integer","description":"The ID of the associated Line Profile,lineProfile should be within the range of 1 to 512.","format":"int32"},"tcontId":{"type":"integer","description":"The ID of the T-cont to which the Gem Port is bound. TcontId should be a current existing T-cont ID.","format":"int32"},"encrypt":{"type":"string","description":"Whether to enable data encryption feature. Encrypt should be a value as follows:ENABLE;DISABLE. Default value: DISABLE.","enum":["DISABLE","ENABLE"]}}},"GemPortDeleteDTO":{"required":["ids"],"type":"object","properties":{"ids":{"type":"array","description":"ID list","items":{"type":"integer","description":"ID list","format":"int32"}},"lineProfileId":{"type":"integer","description":"The ID of the associated Line Profile,lineProfile should be within the range of 1 to 512.","format":"int32"}}},"DeviceResponseBodyGemPortDeleteResultDTO":{"type":"object","properties":{"deviceType":{"type":"string","description":"deviceType should be a value as follows:ap,gateway,switch,pro ap,pro gateway,pro switch,festa ap,festa gateway,festa switch,ems,olt,onu.","enum":["ap","gateway","switch","pro ap","pro gateway","pro switch","festa ap","festa gateway","festa switch","ems","olt","onu"]},"errcode":{"type":"integer","description":"Device error code.","format":"int32"},"message":{"type":"string","description":"Device error message"},"data":{"$ref":"#/components/schemas/GemPortDeleteResultDTO"}}},"GemPortDeleteResultDTO":{"type":"object","properties":{"gemPortsInUse":{"type":"array","description":"The list of Gem Port ID that failed to delete due to being in use.","items":{"type":"integer","description":"The list of Gem Port ID that failed to delete due to being in use.","format":"int32"}}},"description":"Device configuration information.If the type of data is 'Object',ignore this field"},"OperationResponseDeviceResponseBodyGemPortDeleteResultDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceResponseBodyGemPortDeleteResultDTO"}}},"GemPortDTO":{"required":["encrypt","gemPortId","tcontId"],"type":"object","properties":{"gemPortId":{"type":"integer","description":"Gem port ID should be within the range of 1 to 1023","format":"int32"},"lineProfileId":{"type":"integer","description":"The ID of the associated Line Profile,lineProfile should be within the range of 1 to 512.","format":"int32"},"isInUse":{"type":"boolean","description":"Whether the Gem Port is in use: if it is in use, deletion is not allowed. true indicates it is in use, while false indicates it is not in use. This field should not be provided."},"tcontId":{"type":"integer","description":"The ID of the T-cont to which the Gem Port is bound. TcontId should be s current existing T-cont ID.","format":"int32"},"encrypt":{"type":"string","description":"Whether to enable data encryption feature. Encrypt should be a value as follows: ENABLE;DISABLE. Default value: DISABLE.","enum":["DISABLE","ENABLE"]},"gemMappingId":{"type":"array","description":"Gem Mapping Id using the gem port should be null","items":{"type":"integer","description":"Gem Mapping Id using the gem port should be null","format":"int32"}}}},"GemMappingModifyDTO":{"required":["gemMappingId","gemPortId"],"type":"object","properties":{"gemMappingId":{"type":"integer","description":"GemMappingId should be within the range of 1 to 8,and should not be null","format":"int32"},"lineProfileId":{"type":"integer","description":"The ID of the associated Line Profile,lineProfileId should be within the range of 1 to 512.","format":"int32"},"gemPortId":{"type":"integer","description":"Gem port ID should be within the range of 1 to 1023","format":"int32"},"vlanType":{"type":"string","description":"The mapping relationship between Gem Port and VLAN is valid when the Line Profile's mappingMode is set to: Vlan, Vlan-Priority, Port-Vlan, or Port-VLAN-Priority. VlanType should be a value as follows: TAGGED;UNTAGGED, with the default value being TAGGED.","enum":["TAGGED","UNTAGGED","VLAN_TRANSPARENT"]},"vlanId":{"type":"integer","description":"VLAN ID is valid when the vlanType is set to Tagged. VlanId should be within the range of 1 to 4094.","format":"int32"},"priority":{"type":"integer","description":"The mapping relationship between Gem Port and 802.1p priority.It is valid when the Line Profile's mappingMode is set to: Priority, Vlan-Priority, Port-Priority, or Port-VLAN-Priority. Priority should be within the range of 0 to 7.","format":"int32"},"portMappingType":{"type":"string","description":"The mapping relationship between Gem Port and ONT Port ID is valid when the Line Profile's mappingMode is set to: Port, Port-Vlan, Port-Priority, or Port-Vlan-Priority. PortMappingType should be a value as follows: ETH, with the default value being ETH.","enum":["ETH","POTS"]},"portId":{"type":"integer","description":"The mapped ONT port ID is valid when the portMappingType has a value. When portMappingType is ETH, portId should be within the range of 1 to 24.","format":"int32"}}},"GemMappingDeleteDTO":{"required":["gemMappingList"],"type":"object","properties":{"lineProfileId":{"type":"integer","description":"The ID of the associated Line Profile,lineProfileId should be within the range of 1 to 512.","format":"int32"},"gemMappingList":{"type":"array","description":"gemMappingList","items":{"$ref":"#/components/schemas/GemMappingDeleteItem"}}}},"GemMappingDeleteItem":{"required":["gemMappingId","gemPortId"],"type":"object","properties":{"gemPortId":{"type":"integer","description":"Gem port ID should be within the range of 1 to 1023","format":"int32"},"gemMappingId":{"type":"integer","description":"GemMappingId should be within the range of 1 to 8,and should not be null","format":"int32"}},"description":"gemMappingList"},"GemMappingDTO":{"required":["gemMappingId","gemPortId"],"type":"object","properties":{"gemMappingId":{"type":"integer","description":"GemMappingId should be within the range of 1 to 8,and should not be null","format":"int32"},"lineProfileId":{"type":"integer","description":"The ID of the associated Line Profile should be within the range of 1 to 512.","format":"int32"},"gemPortId":{"type":"integer","description":"Gem port ID should be within the range of 1 to 1023","format":"int32"},"vlanType":{"type":"string","description":"The mapping relationship between Gem Port and VLAN is valid when the Line Profile's mappingMode is set to: Vlan, Vlan-Priority, Port-Vlan, or Port-VLAN-Priority. VlanType should be a value as follows: TAGGED;UNTAGGED, with the default value being TAGGED.","enum":["TAGGED","UNTAGGED","VLAN_TRANSPARENT"]},"vlanId":{"type":"integer","description":"VLAN ID is valid when the vlanType is set to Tagged. VlanId should be within the range of 1 to 4094.","format":"int32"},"priority":{"type":"integer","description":"The mapping relationship between Gem Port and 802.1p priority.It is valid when the Line Profile's mappingMode is set to: Priority, Vlan-Priority, Port-Priority, or Port-VLAN-Priority. Priority should be within the range of 0 to 7.","format":"int32"},"portMappingType":{"type":"string","description":"The mapping relationship between Gem Port and ONT Port ID is valid when the Line Profile's mappingMode is set to: Port, Port-Vlan, Port-Priority, or Port-Vlan-Priority. PortMappingType should be a value as follows:ETH;POTS, with the default value being ETH.","enum":["ETH","POTS"]},"portId":{"type":"integer","description":"The mapped ONT port ID is valid when the portMappingType has a value. When portMappingType is ETH, portId should be within the range of 1 to 24.","format":"int32"}}},"LineProfileModifyDTO":{"required":["lineProfileId"],"type":"object","properties":{"lineProfileId":{"type":"integer","description":"LineProfileId should be within the range of 1 to 512","format":"int32"},"name":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"The name of the Line template, an optional configuration. If not configured by the user, it will be automatically generated by the device. Name should contain 1 to 32 characters including digits, upper and lower letters, and the following six characters: -@_:/. . It can be left empty; if empty, it will be assigned automatically by the device."},"upstreamFEC":{"type":"string","description":"Enable/Disable Upstream FEC feature. UpStreamFEC should be a value as follows: DISABLE;ENABLE. Default value: DISABLE.","enum":["DISABLE","ENABLE"]},"mappingMode":{"type":"string","description":"Mapping method for the ONT. MappingMode should be a value as follows: VLAN, PRIORITY, VLAN_PRIORITY, PORT, PORT_VLAN, PORT_PRIORITY, PORT_VLAN_PRIORITY. Default value: VLAN.","enum":["VLAN","PRIORITY","VLAN_PRIORITY","PORT","PORT_VLAN","PORT_PRIORITY","PORT_VLAN_PRIORITY"]},"omccEncrypt":{"type":"string","description":"Whether to enable OMCC encryption feature: when OMCC encryption is enabled, OMCI messages will be encrypted; otherwise, they will not be encrypted. OmccEncrypt should be a value as follows: ENABLE;DISABLE. Default value: DISABLE.","enum":["DISABLE","ENABLE"]}}},"DeviceResponseBodyLineProfileDeleteResultDTO":{"type":"object","properties":{"deviceType":{"type":"string","description":"deviceType should be a value as follows:ap,gateway,switch,pro ap,pro gateway,pro switch,festa ap,festa gateway,festa switch,ems,olt,onu.","enum":["ap","gateway","switch","pro ap","pro gateway","pro switch","festa ap","festa gateway","festa switch","ems","olt","onu"]},"errcode":{"type":"integer","description":"Device error code.","format":"int32"},"message":{"type":"string","description":"Device error message"},"data":{"$ref":"#/components/schemas/LineProfileDeleteResultDTO"}}},"LineProfileDeleteResultDTO":{"type":"object","properties":{"profilesInUse":{"type":"array","description":"A list of Line Profile IDs that failed to delete because they are in use.","items":{"type":"integer","description":"A list of Line Profile IDs that failed to delete because they are in use.","format":"int32"}}},"description":"Device configuration information.If the type of data is 'Object',ignore this field"},"OperationResponseDeviceResponseBodyLineProfileDeleteResultDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceResponseBodyLineProfileDeleteResultDTO"}}},"LineProfileDTO":{"required":["lineProfileId","mappingMode","upstreamFEC"],"type":"object","properties":{"lineProfileId":{"type":"integer","description":"ID of line profile should be within the range of 1 to 512 and should not be null","format":"int32"},"name":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"The name of the Line template, an optional configuration. If not configured by the user, it will be automatically generated by the device. Name should contain 1 to 32 characters including digits, upper and lower letters, and the following six characters: -@_:/. . It can be left empty; if empty, it will be assigned automatically by the device."},"isSystemProfile":{"type":"boolean","description":"IsSystemProfile should be null, because it's generated by device."},"isInUse":{"type":"boolean","description":"Whether the Line Profile is in use: if it is in use, deletion is not allowed. True indicates it is in use, while false indicates it is not in use. This field should not be provided"},"upstreamFEC":{"type":"string","description":"Enable/Disable Upstream FEC feature. UpstreamFEC should be a value as follows: DISABLE;ENABLE.","enum":["DISABLE","ENABLE"]},"mappingMode":{"type":"string","description":"Mapping method for the ONT. MappingMode should be a value as follows: VLAN, PRIORITY, VLAN_PRIORITY, PORT, PORT_VLAN, PORT_PRIORITY, PORT_VLAN_PRIORITY. Default value: VLAN.","enum":["VLAN","PRIORITY","VLAN_PRIORITY","PORT","PORT_VLAN","PORT_PRIORITY","PORT_VLAN_PRIORITY"]},"omccEncrypt":{"type":"string","description":"Whether to enable OMCC encryption feature: when OMCC encryption is enabled, OMCI messages will be encrypted; otherwise, they will not be encrypted. OmccEncrypt should be a value as follows: ENABLE;DISABLE. Default value: ENABLE.","enum":["DISABLE","ENABLE"]},"tcontNum":{"type":"integer","description":"The number of T-conts created under this Line template is non-configurable.","format":"int64"},"gemPortNum":{"type":"integer","description":"The number of gem ports created under this Line template is non-configurable.","format":"int64"}}},"DeviceResponseBodyLineProfileDTO":{"type":"object","properties":{"deviceType":{"type":"string","description":"deviceType should be a value as follows:ap,gateway,switch,pro ap,pro gateway,pro switch,festa ap,festa gateway,festa switch,ems,olt,onu.","enum":["ap","gateway","switch","pro ap","pro gateway","pro switch","festa ap","festa gateway","festa switch","ems","olt","onu"]},"errcode":{"type":"integer","description":"Device error code.","format":"int32"},"message":{"type":"string","description":"Device error message"},"data":{"$ref":"#/components/schemas/LineProfileDTO"}}},"OperationResponseDeviceResponseBodyLineProfileDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceResponseBodyLineProfileDTO"}}},"DBAProfileModifyDTO":{"required":["dbaId"],"type":"object","properties":{"dbaId":{"type":"integer","description":"DBA ID should be within the range of 1 to 512 and should not be null","format":"int32"},"name":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"Name of DBA profile should contain 1 to 32 characters including digits, upper and lower letters, and the following six characters: -@_:/. ."},"type":{"type":"string","description":"DBA bandwidth allocation methods.Type should be a value as follows: FIX, ASSURE, MAX, ASSURE_MAX, and FIX_ASSURE_MAX. The default value is FIX.","enum":["FIX","ASSURE","MAX","ASSURE_MAX","FIX_ASSURE_MAX"]},"fix":{"type":"integer","description":"The value for fixed bandwidth is required when the Type is set to FIX or FIX_ASSURE_MAX. Fix should be within the range of 128 to 720000, with the unit in kbit/s.","format":"int32"},"assure":{"type":"integer","description":"The value for guaranteed bandwidth is required when the Type is set to ASSURE, ASSURE_MAX, or FIX_ASSURE_MAX. Assure should be within the range of 128 to 1200000, with the unit in kbit/s.","format":"int32"},"max":{"type":"integer","description":"The value for maximum bandwidth is required when the Type is set to MAX, ASSURE_MAX, or FIX_ASSURE_MAX. Max should be within the range of 128 to 1244160, with the unit in kbit/s.","format":"int32"}}},"DBAProfileDeleteResultDTO":{"type":"object","properties":{"profilesInUse":{"type":"array","description":"List of DBA Profile IDs that failed to delete due to being in use.","items":{"type":"integer","description":"List of DBA Profile IDs that failed to delete due to being in use.","format":"int32"}}},"description":"Device configuration information.If the type of data is 'Object',ignore this field"},"DeviceResponseBodyDBAProfileDeleteResultDTO":{"type":"object","properties":{"deviceType":{"type":"string","description":"deviceType should be a value as follows:ap,gateway,switch,pro ap,pro gateway,pro switch,festa ap,festa gateway,festa switch,ems,olt,onu.","enum":["ap","gateway","switch","pro ap","pro gateway","pro switch","festa ap","festa gateway","festa switch","ems","olt","onu"]},"errcode":{"type":"integer","description":"Device error code.","format":"int32"},"message":{"type":"string","description":"Device error message"},"data":{"$ref":"#/components/schemas/DBAProfileDeleteResultDTO"}}},"OperationResponseDeviceResponseBodyDBAProfileDeleteResultDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceResponseBodyDBAProfileDeleteResultDTO"}}},"DBAProfileDTO":{"required":["dbaId","type"],"type":"object","properties":{"dbaId":{"type":"integer","description":"DBA ID should be within the range of 1 to 512 and should not be null","format":"int32"},"name":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"The name of the DBA template.Name should contain 1 to 32 characters including digits, letters, and the following six characters: -@_:/. ."},"isSystemProfile":{"type":"boolean","description":"IsSystemProfile should be null, because it's generated by device."},"isInUse":{"type":"boolean","description":"Whether the DBA profile is in use.DBA Profile cannot be deleted if it has already been used. A value of true indicates that it has been used, while false indicates that it has not been used. If this field is not provided, the default value is false."},"type":{"type":"string","description":"DBA bandwidth allocation methods.Type should be a value as follows: FIX, ASSURE, MAX, ASSURE_MAX, and FIX_ASSURE_MAX. The default value is FIX.","enum":["FIX","ASSURE","MAX","ASSURE_MAX","FIX_ASSURE_MAX"]},"fix":{"type":"integer","description":"The value for fixed bandwidth is required when the Type is set to FIX or FIX_ASSURE_MAX.Fix should be within the range of 128 to 720000, with the unit in kbit/s.","format":"int32"},"assure":{"type":"integer","description":"The value for guaranteed bandwidth is required when the Type is set to ASSURE, ASSURE_MAX, or FIX_ASSURE_MAX. Assure should be within the range of 128 to 1200000, with the unit in kbit/s.","format":"int32"},"max":{"type":"integer","description":"The value for maximum bandwidth is required when the Type is set to MAX, ASSURE_MAX, or FIX_ASSURE_MAX. Max should be within the range of 128 to 1244160, with the unit in kbit/s.","format":"int32"},"tcontNum":{"type":"integer","description":"The number of T-conts using this DBA template is not configurable and will be returned upon inquiry.","format":"int64"}},"description":"Device configuration information.If the type of data is 'Object',ignore this field"},"DeviceResponseBodyDBAProfileDTO":{"type":"object","properties":{"deviceType":{"type":"string","description":"deviceType should be a value as follows:ap,gateway,switch,pro ap,pro gateway,pro switch,festa ap,festa gateway,festa switch,ems,olt,onu.","enum":["ap","gateway","switch","pro ap","pro gateway","pro switch","festa ap","festa gateway","festa switch","ems","olt","onu"]},"errcode":{"type":"integer","description":"Device error code.","format":"int32"},"message":{"type":"string","description":"Device error message"},"data":{"$ref":"#/components/schemas/DBAProfileDTO"}}},"OperationResponseDeviceResponseBodyDBAProfileDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceResponseBodyDBAProfileDTO"}}},"PonPortBatchModifyDTO":{"required":["dtos"],"type":"object","properties":{"dtos":{"type":"array","items":{"$ref":"#/components/schemas/PonPortModifyDTO"}}}},"PonPortModifyDTO":{"required":["autoDetectInterval","keyExchangePeriod","maxDistance","minDistance","portId"],"type":"object","properties":{"portId":{"type":"string","description":"Port ID"},"status":{"type":"string","description":"Whether to enable the laser for the PON port.Status should be a value as follows:DISABLE,ENABLE.","enum":["DISABLE","ENABLE"]},"downstreamFEC":{"type":"string","description":"Whether to start downstream FEC function of the port.DownstreamFEC should be a value as follows:DISABLE,ENABLE.","enum":["DISABLE","ENABLE"]},"keyExchangePeriod":{"type":"integer","description":"Configure the downstream encryption ONT key update time. KeyExchangePeriod should be within the range of 0 to 60 minutes, where 0 means key update is disabled.","format":"int32"},"dbaCalculateMode":{"type":"string","description":"Configure the DBA calculation cycle mode. DbaCalculateMode should be a value as follows: MIN_DELAY:In minimum delay mode, the DBA calculation cycle is related to the number of T-CONTs. The more T-CONTs there are, the longer the calculation cycle. Under the premise that the bandwidth can complete the calculation, it is advisable to use as few calculation cycles as possible. When dealing with TDM services, the minimum delay mode must be selected; MAX_BW:In maximum bandwidth utilization mode, the DBA calculation cycle is allocated over multiple frames, with each frame lasting 125 µs. This method is suitable when the service does not have high delay requirements.","enum":["MIN_DELAY","MAX_BW"]},"maxDistance":{"type":"integer","description":"The maximum logical distance of the ONT.MaxDistance should be within the range of 1 to 60 (km). The difference between the maximum logical distance and the minimum logical distance must not exceed 40 km.","format":"int32"},"minDistance":{"type":"integer","description":"The minimum logical distance of the ONT.MinDistance should be within the range of 1 to 40 (km). The difference between the maximum logical distance and the minimum logical distance must not exceed 40 km.","format":"int32"},"longLaserOnuAutoDetect":{"type":"string","description":"Whether to enable port rogue ONU automatic detection function.LongLaserOnuAutoDetect should be a value as follows:DISABLE,ENABLE.Default value:DISABLE","enum":["DISABLE","ENABLE"]},"autoDetectInterval":{"type":"integer","description":"Set the interval time for port traffic ONU detection, unit: minutes.AutoDetectInternal should be within the range of 1 to 100.Default value:15","format":"int32"},"longLaserOnuAutoIsolate":{"type":"string","description":"Whether to enable port rogue ONU automatic isolation function.LongLaserOnuAutoIsolate should be a value as follows:DISABLE,ENABLE.Default value:DISABLE","enum":["DISABLE","ENABLE"]}}},"DeviceResponseBodyReactivePonPortDTO":{"type":"object","properties":{"deviceType":{"type":"string","description":"deviceType should be a value as follows:ap,gateway,switch,pro ap,pro gateway,pro switch,festa ap,festa gateway,festa switch,ems,olt,onu.","enum":["ap","gateway","switch","pro ap","pro gateway","pro switch","festa ap","festa gateway","festa switch","ems","olt","onu"]},"errcode":{"type":"integer","description":"Device error code.","format":"int32"},"message":{"type":"string","description":"Device error message"},"data":{"$ref":"#/components/schemas/ReactivePonPortDTO"}}},"OperationResponseDeviceResponseBodyReactivePonPortDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceResponseBodyReactivePonPortDTO"}}},"ReactivePonPortDTO":{"type":"object","properties":{"reactiveStatus":{"type":"string","description":"Whether there are ports that need to be reactivated.ReactiveStatus should be a value as follows:DISABLE:Indicates that there are no ports that need to be reactivated;ENABLE:Reading the port data indicates which ports need to be activated.","enum":["DISABLE","ENABLE"]},"ponPorts":{"type":"array","description":"Port list to be activated","items":{"type":"string","description":"Port list to be activated"}}},"description":"Device configuration information.If the type of data is 'Object',ignore this field"},"StringKeyListRequest":{"required":["keys"],"type":"object","properties":{"keys":{"type":"array","description":"String key list","items":{"type":"string","description":"String key list"}}}},"OnuActivationConfigDTO":{"required":["authenticationMethod","keys","lineProfile","serviceProfile"],"type":"object","properties":{"keys":{"type":"array","description":"Entry identifier list","items":{"type":"string","description":"Entry identifier list"}},"onuId":{"type":"integer","description":"Onu ID should be within the range of 0 to 127","format":"int32"},"authenticationMethod":{"type":"string","description":"Authentication mode used by the automatically discovered ONU.AuthenticationMethod should be a value as follows:PASSWORD_AUTH,SN_AUTH,LOID_AUTH,SN_AND_PASSWORD_AUTH,LOID_AND_PASSWORD_AUTH","enum":["PASSWORD_AUTH","SN_AUTH","LOID_AUTH","SN_AND_PASSWORD_AUTH","LOID_AND_PASSWORD_AUTH"]},"lineProfile":{"type":"string","description":"Line profile id bound to the ONU"},"serviceProfile":{"type":"string","description":"Service profile id bound to the ONU"},"description":{"type":"string","description":"Display the configured port description.Only 1-32 bits numbers, Upper and lower letters, -@_:/. are allowed."},"discoveryMode":{"type":"string","description":"ONU auto discovery mode.DiscoveryMode should be a value as follows:ALWAYS_ON,ONCE_ON ","enum":["ALWAYS_ON","ONCE_ON"]},"reRegisterAuthentication":{"type":"string","description":"Re-Register-Authentication"},"servicePortProfile":{"type":"string","description":"Service port profile id bound to the ONU"}}},"AutofindConfigDTO":{"required":["agingTimeStatus","autofindInterval"],"type":"object","properties":{"ponPort":{"type":"string","description":"Pon port collection.e.g.,'GPON 1/1/1'、'GPON 1/1/1-3'、'GPON 1/1/1-3,GPON 1/1/5,GPON 1/1/7-8'"},"agingTimeStatus":{"type":"string","description":"Configure the DDM (Digital Diagnostic Monitoring) feature enable status for the optical port.AgingTimeStatus should be a value as follows:TIMEOUT,NO_AGING","enum":["TIMEOUT","NO_AGING"]},"agingTime":{"type":"integer","description":"Configure the actions corresponding to received DDM messages on the optical port.If aging time status is 'No-Aging',AgingTime should be null;If aging time status is 'Timeout',AgingTime should not be null and should be within the range of 100 to 300s.","format":"int32"},"autofindInterval":{"type":"integer","description":"Auto find interval should be within the range of 1 to 10s","format":"int32"}}},"PonAutoAuthenticationRuleConfigEditDTO":{"required":["key","lineProfile","ponPort","ruleId","serviceProfile"],"type":"object","properties":{"key":{"type":"string","description":"Identifier of entry"},"ponPort":{"type":"string","description":"Pon port.e.g.GPON 1/0/1"},"ruleId":{"type":"integer","description":"Rule ID should be within the range of 1 to 128","format":"int32"},"equipId":{"type":"string","description":"Matched ONT ID.EquipId should contain 1 to 20 characters in ASCII (from \\x21 to \\x7e)."},"vendorId":{"type":"string","description":"Matched ONU vendor ID.VendorId should contain 1 to 4 characters in ASCII (from \\x21 to \\x7e)."},"softwareVersion":{"type":"string","description":"Software version should contain 1 to 14 characters, consisting of:Uppercase and lowercase letters,Digits,Special characters: -, @, _, :, /, ."},"lineProfile":{"type":"string","description":"Line profile id"},"lineProfileName":{"type":"string","description":"Line profile name"},"serviceProfile":{"type":"string","description":"Service profile id"},"serviceProfileName":{"type":"string","description":"Service profile name"},"servicePortProfile":{"type":"string","description":"Service port profile id bound to the ONU"}}},"PonAutoAuthenticationRuleConfigDeleteDTO":{"required":["keys","ponPort"],"type":"object","properties":{"ponPort":{"type":"string","description":"Pon port.e.g.GPON 1/0/1"},"keys":{"type":"array","description":"Entry identifier list","items":{"type":"string","description":"Entry identifier list"}}}},"PonAutoAuthenticationRuleConfigDTO":{"required":["lineProfile","ponPort","serviceProfile"],"type":"object","properties":{"key":{"type":"string","description":"Identifier of entry"},"ponPort":{"type":"string","description":"Pon port.e.g.GPON 1/0/1"},"ruleId":{"type":"integer","description":"Rule ID should be within the range of 1 to 128","format":"int32"},"equipId":{"type":"string","description":"Matched ONT ID.EquipId should contain 1 to 20 characters in ASCII (from \\x21 to \\x7e)."},"vendorId":{"type":"string","description":"Matched ONU vendor ID.VendorId should contain 1 to 4 characters in ASCII (from \\x21 to \\x7e)."},"softwareVersion":{"type":"string","description":"Software version should contain 1 to 14 characters, consisting of:Uppercase and lowercase letters,Digits,Special characters: -, @, _, :, /, ."},"lineProfile":{"type":"string","description":"Line profile id bound to the ONU"},"lineProfileName":{"type":"string","description":"Line profile name"},"serviceProfile":{"type":"string","description":"ServiceProfile id bound to the ONU"},"serviceProfileName":{"type":"string","description":"Service profile name"},"servicePortProfile":{"type":"string","description":"Service port profile id bound to the ONU"}}},"PonAutoAuthenticationConfigDTO":{"required":["ponPort"],"type":"object","properties":{"ponPort":{"type":"string","description":"Pon port.e.g.GPON 1/0/1"},"autoAuthenticationStatus":{"type":"string","description":"Auto authentication status should be a value as follows:ENABLE,DISABLE","enum":["DISABLE","ENABLE"]},"onuMatchMode":{"type":"string","description":"ONU match mode of automatic authentication.OnuMatchMode should be a value as follows:ALL_ONU,EQUID_AUTH,EQUID_SWVER_AUTH,VENDOR_AUTH","enum":["ALL_ONU","EQUID_AUTH","EQUID_SWVER_AUTH","VENDOR_AUTH"]},"authenticationMethod":{"type":"string","description":"Authentication mode used by the automatically discovered ONU.AuthenticationMethod should be a value as follows:PASSWORD_AUTH,SN_AUTH,LOID_AUTH,SN_AND_PASSWORD_AUTH,LOID_AND_PASSWORD_AUTH","enum":["PASSWORD_AUTH","SN_AUTH","LOID_AUTH","SN_AND_PASSWORD_AUTH","LOID_AND_PASSWORD_AUTH"]},"discoveryMode":{"type":"string","description":"ONU auto discovery mode.DiscoveryMode should be a value as follows:ALWAYS_ON,ONCE_ON ","enum":["ALWAYS_ON","ONCE_ON"]},"reRegisterAuthentication":{"type":"string","description":"Re-Register-Authentication"}}},"AutoAuthenticationConfigDTO":{"required":["autoAuthenticationStatus"],"type":"object","properties":{"autoAuthenticationStatus":{"type":"string","description":"Auto authentication status should be a value as follows:ENABLE,DISABLE","enum":["DISABLE","ENABLE"]}}},"AuthenticationConfigEditDTO":{"required":["key","portId"],"type":"object","properties":{"key":{"type":"string","description":"Identifier of entry"},"portId":{"type":"string","description":"Pon port ID.e.g.GPON 1/0/1"},"onuId":{"type":"integer","description":"ONU ID,This parameter is optional. If not specified, the system will automatically allocate the smallest available ONU number under the current port.OnuId should be within the range of 0 to 127","format":"int32"},"authenticationConfigInfo":{"$ref":"#/components/schemas/AuthenticationConfigInfoDTO"}}},"AuthenticationConfigInfoDTO":{"required":["authenticationMethod","lineProfile","serviceProfile"],"type":"object","properties":{"authenticationMethod":{"type":"string","description":"Authentication mode used by the automatically discovered ONU.AuthenticationMethod should be a value as follows:PASSWORD_AUTH,SN_AUTH,LOID_AUTH,SN_AND_PASSWORD_AUTH,LOID_AND_PASSWORD_AUTH","enum":["PASSWORD_AUTH","SN_AUTH","LOID_AUTH","SN_AND_PASSWORD_AUTH","LOID_AND_PASSWORD_AUTH"]},"passwordType":{"type":"string","description":"Indicates the password type reported by the automatic discovery of the ONT.PasswordType should be a value as follows：ASCII,HEX","enum":["ASCII","HEX"]},"password":{"pattern":"^[\\x21-\\x7e]{1,10}|[0-9a-fA-F ]{1,20}$","type":"string","description":"Automatic discovery ONT Authentication Password.Password should contain 1 to 10 characters in ASCII (from \\x21 to \\x7e) or 1 to 20 characters in hexadecimal."},"discoveryMode":{"type":"string","description":"ONU auto discovery mode.DiscoveryMode should be a value as follows:ALWAYS_ON,ONCE_ON ","enum":["ALWAYS_ON","ONCE_ON"]},"serialNumber":{"type":"string","description":"SerialNumber of ONU, serialNumber should contain 12, 13, or 16 characters, in the format XXXXXXXXXXXX,XXXX-XXXXXXXX,XXXXXXXXXXXXXXXX.When the serialNumber contains 16 characters, the first 8 characters will be grouped into pairs of two, resulting in 4 hexadecimal characters, and each hexadecimal character must fall within the range of 0x21 to 0x7E."},"loid":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"Loid set by automatic discovery of the ONT, loid should be 1-32 characters, including letters, numbers, and symbols (-@_:/.)."},"loidPassword":{"type":"string","description":"Loid password set by automatic discovery of the ONT,loidPassword should be ASCII characters from \\x21 to \\x7e"},"reRegisterAuthentication":{"type":"string","description":"Re-Register-Authentication"},"lineProfile":{"type":"string","description":"Line profile id bound to the ONU"},"serviceProfile":{"type":"string","description":"Service profile id bound to the ONU"},"servicePortProfile":{"type":"string","description":"Service port profile id bound to the ONU"},"description":{"type":"string","description":"Display the configured port description.Only 1-32 bits numbers, Upper and lower letters, -@_:/. are allowed."},"onlineStatus":{"type":"string","description":"Online status should be a value as follows:DISABLE,ENABLE"},"adminStatus":{"type":"string","description":"Admin status of ONU.AdminStatus should be a value as follows:ACTIVE,DEACTIVE"},"configStatus":{"type":"string","description":"Whether OLT has successfully delivered configurations to ONU.ConfigStatus should be a value as follows:FAILED,SUCCESS"}},"description":"OUN authentication information"},"OnuAdminStatusEditDTO":{"required":["adminStatus","keys"],"type":"object","properties":{"adminStatus":{"type":"string","description":"Admin status should be a value as follows:ACTIVATE,DEACTIVATE","enum":["ACTIVATE","DEACTIVATE","ACTIVATED","DEACTIVATED"]},"keys":{"type":"array","description":"Entry identifier list","items":{"type":"string","description":"Entry identifier list"}}}},"AuthenticationConfigAddDTO":{"required":["portId"],"type":"object","properties":{"portId":{"type":"string","description":"Pon port ID.e.g.GPON 1/0/1"},"onuId":{"type":"integer","description":"ONU ID,This parameter is optional. If not specified, the system will automatically allocate the smallest available ONU number under the current port.OnuId should be within the range of 0 to 127","format":"int32"},"authenticationConfigInfo":{"$ref":"#/components/schemas/AuthenticationConfigInfoDTO"}}},"OnuInformationRebootRequestDTO":{"required":["rebootRequestList"],"type":"object","properties":{"rebootRequestList":{"type":"array","description":"Reboot request list","items":{"$ref":"#/components/schemas/SingleOnuRebootRequestDTO"}}}},"SingleOnuRebootRequestDTO":{"type":"object","properties":{"equipmentId":{"type":"string","description":"ONT device ID should contain 1 to 20 characters in ASCII code from \\x21 to \\x7e."},"key":{"type":"string","description":"Identifier of ONU"},"macAddress":{"type":"string","description":"Mac address of ONU"}},"description":"Reboot request list"},"DeviceResponseBodyListSingleOnuRebootResponseDTO":{"type":"object","properties":{"deviceType":{"type":"string","description":"deviceType should be a value as follows:ap,gateway,switch,pro ap,pro gateway,pro switch,festa ap,festa gateway,festa switch,ems,olt,onu.","enum":["ap","gateway","switch","pro ap","pro gateway","pro switch","festa ap","festa gateway","festa switch","ems","olt","onu"]},"errcode":{"type":"integer","description":"Device error code.","format":"int32"},"message":{"type":"string","description":"Device error message"},"data":{"type":"array","description":"Device configuration information.If the type of data is 'Object',ignore this field","items":{"$ref":"#/components/schemas/SingleOnuRebootResponseDTO"}}}},"OperationResponseDeviceResponseBodyListSingleOnuRebootResponseDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceResponseBodyListSingleOnuRebootResponseDTO"}}},"SingleOnuRebootResponseDTO":{"type":"object","properties":{"status":{"type":"integer","description":"ONU reboot status.Status should be a value as follows:0:success.1:fail","format":"int32"},"statusCategory":{"type":"integer","description":"Category of device status,statusCategory should be a value as follows: 0:Disconnected;1:Connected;2:Pending;3:Heartbeat Missed;4:Isolated","format":"int32"},"mac":{"type":"string","description":"Mac address of ONU"}},"description":"Device configuration information.If the type of data is 'Object',ignore this field"},"OnuInformationDescriptionEditConfigDTO":{"required":["key","onuDescription"],"type":"object","properties":{"key":{"type":"string","description":"Identifier of ONU"},"onuDescription":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"ONU description should contain 1 to 32 characters, including uppercase and lowercase letters, numbers, and the symbols -@_:/. "}}},"OnuInformationAdminStatusEditConfigDTO":{"required":["adminStatus","keys"],"type":"object","properties":{"keys":{"type":"array","description":"ONU identifier list","items":{"type":"string","description":"ONU identifier list"}},"adminStatus":{"type":"string","description":"Admin status should be a value as follows:ACTIVATE,DEACTIVATE","enum":["ACTIVATE","DEACTIVATE","ACTIVATED","DEACTIVATED"]}}},"OnuIsolationStatusDTO":{"type":"object","properties":{"isolateAllVlan":{"type":"string","description":"Whether to isolate all ONUs within the VLANs.IsolateAllVlan should be a value as follows:DISABLE,ENABLE.Effective only when onuIsolation is set to ENABLE.","enum":["DISABLE","ENABLE"]},"vlanList":{"type":"string","description":"vlanList should be a value as follows: \"1,3-5,7\".Effective only when onuIsolation is ENABLE and isolateAllVlan is DISABLE."},"onuIsolation":{"type":"string","enum":["DISABLE","ENABLE"]}}},"OnuGlobalConfigStatusEditDTO":{"required":["onuIsolation"],"type":"object","properties":{"onuIsolation":{"type":"string","description":"Whether to enable ONU isolation,onuIsolation should be a value as follows:ENABLE,DISABLE","enum":["DISABLE","ENABLE"]}}},"AutoServicePortDTO":{"type":"object","properties":{"ponPortId":{"type":"integer","description":"PonPortId should be within the range of 1 to 16","format":"int32"},"ponPortStr":{"type":"string","description":"String form of pon port"},"svlan":{"type":"integer","description":"SVlan should be within the range of 1 to 4095","format":"int32"},"gemPortId":{"type":"integer","description":"GemPortId should be within the range of 1 to 1023","format":"int32"},"userVlan":{"type":"integer","description":"UserVlan should be within the range of 0 to 4095","format":"int32"},"userVlanPriority":{"type":"integer","description":"UserVlanPriority should be within the range of -1 to 7","format":"int32"},"tagAction":{"type":"string","description":"TagAction should be a value as follows:DEFAULT,TRANSPARENT,TRANSLATE,TRANSLATE_AND_ADD,ADD_DOUBLE","enum":["DEFAULT","TRANSPARENT","TRANSLATE","TRANSLATE_AND_ADD","ADD_DOUBLE"]},"innerVlan":{"type":"integer","description":"InnerVlan should be within the range of 0 to 4095","format":"int32"},"innerVlanPriority":{"type":"integer","description":"InnerVlanPriority should be within the range of -1 to 7","format":"int32"},"etherType":{"type":"string","description":"EtherType should be a value as follows:NONE,IPV4OE,IPV6OE,PPPOE","enum":["NONE","IPV4OE","IPV6OE","PPPOE"]},"inboundTrafficProfileId":{"type":"integer","description":"InboundTrafficProfileId should be within the range of 0 to 512","format":"int32"},"outboundTrafficProfileId":{"type":"integer","description":"OutboundTrafficProfileId should be within the range of 0 to 512","format":"int32"},"autoMode":{"type":"string","description":"AutoMOde should be a value as follows:Disable,Enable","enum":["DISABLE","ENABLE"]}}},"EthUnit1PortAppDTO":{"required":["port"],"type":"object","properties":{"port":{"type":"string","description":"OLT physical port"},"mediaType":{"type":"integer","description":"Port media type","format":"int32"},"description":{"pattern":"^[a-z0-9A-Z-@_:/.]{0,32}$","type":"string","description":"Display the configured port description.Description should contain 1-32 bits numbers, Upper and lower letters, -@_:/. ."},"status":{"type":"integer","description":"Port switch status.Status should be a value as follows:0:DISABLE;1:ENABLE","format":"int32"},"speed":{"type":"integer","description":"Port speed negotiation mode.Speed should be a value as follows:0;10;100;1000;2500;10000.0 represents Auto, and all other values are in Mbps.","format":"int32"},"duplex":{"type":"integer","description":"Port duplex negotiation mode.Duplex should be a value as follows: 2:FULL,0:AUTO","format":"int32"},"flowControl":{"type":"integer","description":"Port flow control function switch.FlowControl should be a value as follows: 0:DISABLE;1:ENABLE","format":"int32"},"lag":{"type":"string","description":"The LAG to which the port belongs."},"speedLink":{"type":"integer","description":"Port speed negotiation mode: 0 represents Auto, and all other values are in Mbps.","format":"int32"},"duplexLink":{"type":"integer","description":"Actual port duplex mode.DuplexLink should be a value as follows: 0:DISABLE;1:ENABLE","format":"int32"},"linkStatus":{"type":"integer","description":"Connection status of the PON port. LinkStatus should be a value as follows:0:LINK_DOWN;1:LINK_UP","format":"int32"},"type":{"type":"integer","description":"Port type.Type should be null.Type is a value as follows:0:COPPER;1:COMBO;2:SFP;3:SFP+;4:RJ45","format":"int32"},"speedMax":{"type":"integer","description":"The maximum rate that this port can achieve, in Mbps.SpeedMax should be null","format":"int32"}}},"EthUnit1PortAppListDTO":{"required":["dtos"],"type":"object","properties":{"dtos":{"type":"array","items":{"$ref":"#/components/schemas/EthUnit1PortAppDTO"}}}},"EthLagPortAppDTO":{"required":["lag"],"type":"object","properties":{"lag":{"type":"string","description":"ID of LAG"},"description":{"pattern":"^[a-z0-9A-Z-@_:/.]{0,32}$","type":"string","description":"Description of port"},"status":{"type":"integer","description":"Port switch status.Status should be a value as follows:0:DISABLE;1:ENABLE","format":"int32"},"speed":{"type":"integer","description":"Port speed negotiation mode. speed should be a value as follows: 0;10;100;1000;2500;10000.0 represents Auto, and all other values are in Mbps.","format":"int32"},"duplex":{"type":"integer","description":"Port duplex negotiation mode.Duplex should be a value as follows: 2:FULL,0:AUTO","format":"int32"},"flowControl":{"type":"integer","description":"Port flow control function switch.FlowControl should be a value as follows: 0:DISABLE;1:ENABLE","format":"int32"}}},"EthLagPortAppListDTO":{"required":["dtos"],"type":"object","properties":{"dtos":{"type":"array","items":{"$ref":"#/components/schemas/EthLagPortAppDTO"}}}},"SelectStacksWithVlanVO":{"required":["stackIds","vlanType"],"type":"object","properties":{"stackIds":{"type":"array","description":"Stack ID List.","items":{"type":"string","description":"Stack ID List."}},"vlanType":{"type":"integer","description":"Network type, It should be a value as follows : 0:single vlan 1:multi vlan","format":"int32"},"vlan":{"type":"integer","description":"vlan, only valid when vlanType is 0 (single vlan)","format":"int32"},"vlans":{"type":"string","description":"vlans, only valid when vlanType is 1 (multi vlan). VLAN format: 200, 1-100."}}},"OperationResponseListSelectStackForVlanVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/SelectStackForVlanVO"}}}},"CheckFailedDeviceInfoForVlanVO":{"type":"object","properties":{"mac":{"type":"string","description":"check failed device mac"},"stackId":{"type":"string","description":"check failed stack id"},"errorCode":{"$ref":"#/components/schemas/ResErrorCodeVO"}}},"OperationResponseListCheckFailedDeviceInfoForVlanVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/CheckFailedDeviceInfoForVlanVO"}}}},"ResErrorCodeVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"}},"description":"Error code"},"OperationResponseListSelectDeviceForVlanVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/SelectDeviceForVlanVO"}}}},"QueryOswDateByNetworkVO":{"type":"object","properties":{"currentPage":{"type":"integer","format":"int32"},"currentPageSize":{"type":"integer","format":"int32"},"sorts":{"type":"object","additionalProperties":{"type":"string"}},"searchKey":{"type":"string"},"filters":{"type":"object","additionalProperties":{"type":"object"}},"searchField":{"type":"string"},"multiSearchMap":{"type":"object","additionalProperties":{"type":"string"}},"asyncColumns":{"type":"string"},"lanNetworkIds":{"type":"array","items":{"type":"string"}}}},"GridVOOswDataVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OswDataVO"}}}},"OperationResponseGridVOOswDataVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOswDataVO"}}},"OswDataVO":{"type":"object","properties":{"stackId":{"type":"string","description":"Stack Id"},"stackName":{"type":"string","description":"Stack name"},"unit":{"type":"integer","description":"Unit","format":"int32"},"stackOswData":{"$ref":"#/components/schemas/OswStackDataVOOswDataVO"},"mac":{"type":"string","description":"Device mac"},"name":{"type":"string","description":"Device name,default value is the mac address of device"},"type":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"showModel":{"type":"string","description":"Model complex shown in the front end.Ap：model+(country)+modelVersion,EAP225(EU) v3.0  Gateway/Switch：model+modelVersion,Osg v3.0"},"unSelectedablePorts":{"type":"array","description":"The unSelectedable ports of the device.","items":{"$ref":"#/components/schemas/PortVO"}},"portNum":{"type":"integer","description":"The number of ports of one device.","format":"int32"},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected;1:Disconnected(Migrating);10:Provisioning;11:Configuring;12:Upgrading;13:Rebooting;14:Connected;15:Connected(Wireless);16:Connected(Migrating);17:Connected(Wireless,Migrating);20:Pending;21:Pending(Wireless);22:Adopting;23:Adopting(Wireless);24:Adopt Failed;25:Adopt Failed(Wireless);26:Managed By Others;27:Managed By Others(Wireless);30:Heartbeat Missed;31:Heartbeat Missed(Wireless);32:Heartbeat Missed(Migrating);33:Heartbeat Missed(Wireless,Migrating);40:Isolated;41:Isolated(Migrating);50:Slice Configuring","format":"int32"},"uplink":{"$ref":"#/components/schemas/OswUplinkVO"},"ports":{"type":"array","description":"Port List","items":{"$ref":"#/components/schemas/OswPortVO"}},"lags":{"type":"array","description":"Lag List","items":{"$ref":"#/components/schemas/OswLagVO"}},"networkNotAssociatedStandardPorts":{"type":"array","description":"The ports not associated with network.","items":{"$ref":"#/components/schemas/OswStandPortVO"}},"networkNotAssociatedLags":{"type":"array","description":"The lags not associated with network.","items":{"type":"integer","description":"The lags not associated with network.","format":"int32"}},"dhcpSnoopPorts":{"type":"array","description":"The ports dhcp snooping selected.","items":{"$ref":"#/components/schemas/PortVO"}}}},"OswStackDataVOOswDataVO":{"type":"object","properties":{"stackId":{"type":"string"},"stackName":{"type":"string"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"showModel":{"type":"string","description":"Model complex shown in the front end.Ap：model+(country)+modelVersion,EAP225(EU) v3.0  Gateway/Switch：model+modelVersion,Osg v3.0"},"masterMac":{"type":"string"},"unSelectedablePorts":{"type":"array","description":"The unSelectedable ports of the device.","items":{"$ref":"#/components/schemas/PortVO"}},"stackStatus":{"type":"integer","format":"int32"},"abnormalReason":{"type":"integer","format":"int32"},"member":{"type":"array","items":{"$ref":"#/components/schemas/OswDataVO"}},"lags":{"type":"array","items":{"$ref":"#/components/schemas/OswLagStatusVO"}},"supportCustomDhcpOption":{"type":"boolean"},"supportDhcpRange":{"type":"boolean"},"supportVrf":{"type":"boolean"},"supportAutoAddVlan":{"type":"boolean"},"devCap":{"$ref":"#/components/schemas/OswDevCapVO"},"customStandardPorts":{"type":"array","description":"The standard ports that has some vlan not included in port vlan.","items":{"type":"string","description":"The standard ports that has some vlan not included in port vlan."}},"customLagIds":{"type":"array","description":"The lag ids that has some vlan not included in port vlan.","items":{"type":"integer","description":"The lag ids that has some vlan not included in port vlan.","format":"int32"}},"supportLayout":{"type":"boolean","description":"Whether the device supports reporting port layout information."}},"description":"stackOswData"},"VlanNetworkVlansVO":{"type":"object","properties":{"vlanIds":{"type":"array","description":"vlan list. The parameter is defined as an array of integers. However, the current implementation accepts non-array inputs (e.g., a single integer or a numeric string) and will treat them as a single-element array. For consistency and future compatibility, please provide `vlanIds` as an array","items":{"type":"integer","description":"vlan list. The parameter is defined as an array of integers. However, the current implementation accepts non-array inputs (e.g., a single integer or a numeric string) and will treat them as a single-element array. For consistency and future compatibility, please provide `vlanIds` as an array","format":"int32"}}}},"OperationResponseVlanNetworkDeviceSupportInfoVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VlanNetworkDeviceSupportInfoVO"}}},"VlanNetworkDevicePortSupportVO":{"type":"object","properties":{"port":{"type":"string","description":"Port Id"},"standardPort":{"type":"string","description":"Standard Port of Stack"},"lagId":{"type":"string","description":"Lag Id"},"mlagId":{"type":"string","description":"Mlag Id"},"support":{"type":"boolean","description":"Indicate whether the port support current vlan."}},"description":"Port list"},"VlanNetworkDeviceSupportInfoVO":{"type":"object","properties":{"devicePortSupportVlan":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/VlanNetworkDeviceSupportVO"},"description":"The map key is device mac. The map value is the device info"}}},"VlanNetworkDeviceSupportVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device mac"},"type":{"type":"string","description":"Device type.It should be a value as follows: gateway, switch, ap, olt"},"portList":{"type":"array","description":"Port list","items":{"$ref":"#/components/schemas/VlanNetworkDevicePortSupportVO"}},"stackId":{"type":"string","description":"Stack ID, only valid when the device is stack"}},"description":"The map key is device mac. The map value is the device info"},"NetworkReportScheduleOpenApiVO":{"required":["cards","emailList","enable","hour","minute","reportName","reportType","tab","timingType"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable periodic report generation and sending."},"tab":{"type":"integer","description":"Report tab, 0-summary, 1-wireless summary, 2-wired summary, 3-wireless devices,4-wired devices, 5-ssid, 6-client.","format":"int32"},"reportName":{"type":"string","description":"Parameter [reportName] should be a string of 1 to 64 characters without any space at the beginning or end."},"reportType":{"type":"integer","description":"Type of the file to be exported [0:PDF,1:CSV].","format":"int32"},"emailList":{"type":"array","description":"Email List. Example:[\"11@qq.com\",\"11@qq.com\"]. If 'enable' is false, the parameter must be [].","items":{"type":"string","description":"Email List. Example:[\"11@qq.com\",\"11@qq.com\"]. If 'enable' is false, the parameter must be []."}},"cards":{"type":"string","description":"According to the Tab, fill in the cards parameter with the corresponding string. The string is a json array whose elements represent a single card. The type and granularity parameters for the cards cannot be removed. Only the granularity value can be changed, which can be 0/1/2 [0:5min, 1:hourly, 2:daily].Summary:\"[{\\\"type\\\":\\\"apSummary\\\"},{\\\"type\\\":\\\"ssidSummary\\\"},{\\\"type\\\":\\\"bandSummary\\\"},{\\\"type\\\":\\\"switchSummary\\\"},{\\\"type\\\":\\\"deviceSummary\\\"},{\\\"type\\\":\\\"clientsSummary\\\"},{\\\"type\\\":\\\"trafficSummary\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"trafficDistribution\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"alertSummary\\\"},{\\\"type\\\":\\\"eventSummary\\\"},{\\\"type\\\":\\\"appFlowSummary\\\"}]\";Wireless Summary:\"[{\\\"type\\\":\\\"onlineOfflineAp\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"apSummary\\\"},{\\\"type\\\":\\\"ssidSummary\\\"},{\\\"type\\\":\\\"bandSummary\\\"},{\\\"type\\\":\\\"topTrafficAp\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topClientNumAp\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"apAlert\\\"},{\\\"type\\\":\\\"apRebootTimes\\\"},{\\\"type\\\":\\\"wirelessOverview\\\"},{\\\"type\\\":\\\"wirelessTxRxTraffic\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"wirelessBandTraffic\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"wirelessClientsActivities\\\",\\\"granularity\\\":0}]\";Wired Summary:\"[{\\\"type\\\":\\\"wiredOverview\\\"},{\\\"type\\\":\\\"ispLoad\\\"},{\\\"type\\\":\\\"onlineOfflineSwitch\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"wiredClientsActivities\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"switchSummary\\\"},{\\\"type\\\":\\\"topTrafficSwitch\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topPoeUtilSwitch\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topPoePowerSwitch\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topClientNumSwitch\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"switchAlert\\\"},{\\\"type\\\":\\\"switchRebootTimes\\\"}]\";Wireless Devices:\"[{\\\"type\\\":\\\"onlineOfflineAp\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"apSummary\\\"},{\\\"type\\\":\\\"topTrafficAp\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topCpuUtilAp\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topMemUtilAp\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topClientNumAp\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"apAlert\\\"},{\\\"type\\\":\\\"apRebootTimes\\\"}]\";Wired Devices:\"[{\\\"type\\\":\\\"onlineOfflineSwitch\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"switchSummary\\\"},{\\\"type\\\":\\\"gatewayCpuMemUtil\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topTrafficSwitch\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topCpuUtilSwitch\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topMemUtilSwitch\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topClientNumSwitch\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"switchAlert\\\"},{\\\"type\\\":\\\"switchRebootTimes\\\"}]\";SSID:\"[{\\\"type\\\":\\\"ssidSummary\\\"},{\\\"type\\\":\\\"topTrafficSsid\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topClientNumSsid\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"ssidNumActivities\\\",\\\"granularity\\\":0}]\";Clients:\"[{\\\"type\\\":\\\"clientDistribution\\\"},{\\\"type\\\":\\\"clientNumActivities\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"wirelessClientsActivities\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"guestNumActivities\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topClientNumAp\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topClientNumSwitch\\\",\\\"granularity\\\":0}]\";"},"timingType":{"type":"integer","description":"Frequency of executing schedule task Daily(1), Weekly(2), Monthly(3).","format":"int32"},"hour":{"type":"integer","description":"The value ranges from 0 to 23.","format":"int32"},"minute":{"type":"integer","description":"The value ranges from 0 to 59.","format":"int32"},"dayOfWeek":{"type":"integer","description":"If timing type is weekly, enter and only enter [dayOfWeek].The value ranges from 0 to 6.('0' indicate Sunday)","format":"int32"},"dayOfMonth":{"type":"integer","description":"If timing type is monthly, enter and only enter [dayOfMonth].The value ranges from 1 to 31. Schedule will fail on the day of the monthif you select 29th,30th,31th but the month doesn't have these days.","format":"int32"}}},"NetworkReportScheduleLaterOpenApiVO":{"required":["cards","emailList","enable","end","hour","minute","reportName","reportType","start","tab","time"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable periodic report generation and sending."},"tab":{"type":"integer","description":"Report tab, 0-summary, 1-wireless summary, 2-wired summary, 3-wireless devices,4-wired devices, 5-ssid, 6-client.","format":"int32"},"cards":{"type":"string","description":"According to the Tab, fill in the cards parameter with the corresponding json string. The string is a json array whose elements represent a single card. The type and granularity parameters for the cards cannot be removed. Only the granularity value can be changed, which can be 0/1/2 [0:5min, 1:hourly, 2:daily].Summary:\"[{\\\"type\\\":\\\"apSummary\\\"},{\\\"type\\\":\\\"ssidSummary\\\"},{\\\"type\\\":\\\"bandSummary\\\"},{\\\"type\\\":\\\"switchSummary\\\"},{\\\"type\\\":\\\"deviceSummary\\\"},{\\\"type\\\":\\\"clientsSummary\\\"},{\\\"type\\\":\\\"trafficSummary\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"trafficDistribution\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"alertSummary\\\"},{\\\"type\\\":\\\"eventSummary\\\"},{\\\"type\\\":\\\"appFlowSummary\\\"}]\";Wireless Summary:\"[{\\\"type\\\":\\\"onlineOfflineAp\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"apSummary\\\"},{\\\"type\\\":\\\"ssidSummary\\\"},{\\\"type\\\":\\\"bandSummary\\\"},{\\\"type\\\":\\\"topTrafficAp\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topClientNumAp\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"apAlert\\\"},{\\\"type\\\":\\\"apRebootTimes\\\"},{\\\"type\\\":\\\"wirelessOverview\\\"},{\\\"type\\\":\\\"wirelessTxRxTraffic\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"wirelessBandTraffic\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"wirelessClientsActivities\\\",\\\"granularity\\\":0}]\";Wired Summary:\"[{\\\"type\\\":\\\"wiredOverview\\\"},{\\\"type\\\":\\\"ispLoad\\\"},{\\\"type\\\":\\\"onlineOfflineSwitch\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"wiredClientsActivities\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"switchSummary\\\"},{\\\"type\\\":\\\"topTrafficSwitch\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topPoeUtilSwitch\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topPoePowerSwitch\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topClientNumSwitch\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"switchAlert\\\"},{\\\"type\\\":\\\"switchRebootTimes\\\"}]\";Wireless Devices:\"[{\\\"type\\\":\\\"onlineOfflineAp\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"apSummary\\\"},{\\\"type\\\":\\\"topTrafficAp\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topCpuUtilAp\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topMemUtilAp\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topClientNumAp\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"apAlert\\\"},{\\\"type\\\":\\\"apRebootTimes\\\"}]\";Wired Devices:\"[{\\\"type\\\":\\\"onlineOfflineSwitch\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"switchSummary\\\"},{\\\"type\\\":\\\"gatewayCpuMemUtil\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topTrafficSwitch\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topCpuUtilSwitch\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topMemUtilSwitch\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topClientNumSwitch\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"switchAlert\\\"},{\\\"type\\\":\\\"switchRebootTimes\\\"}]\";SSID:\"[{\\\"type\\\":\\\"ssidSummary\\\"},{\\\"type\\\":\\\"topTrafficSsid\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topClientNumSsid\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"ssidNumActivities\\\",\\\"granularity\\\":0}]\";Clients:\"[{\\\"type\\\":\\\"clientDistribution\\\"},{\\\"type\\\":\\\"clientNumActivities\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"wirelessClientsActivities\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"guestNumActivities\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topClientNumAp\\\",\\\"granularity\\\":0},{\\\"type\\\":\\\"topClientNumSwitch\\\",\\\"granularity\\\":0}]\";"},"reportName":{"pattern":"^[a-zA-Z0-9_&\\- ]{1,64}$","type":"string","description":"Report Name."},"reportType":{"type":"integer","description":"Type of the file to be exported [0:PDF,1:CSV].","format":"int32"},"emailList":{"type":"array","description":"Email List. Example:[\"11@qq.com\",\"11@qq.com\"]","items":{"type":"string","description":"Email List. Example:[\"11@qq.com\",\"11@qq.com\"]"}},"minute":{"type":"integer","description":"The value ranges from 0 to 59.","format":"int32"},"hour":{"type":"integer","description":"The value ranges from 0 to 23.","format":"int32"},"time":{"type":"integer","description":"The timestamp of the year, month, and day is generated.","format":"int64"},"start":{"type":"integer","description":"The start timestamp of the query for the data needed to generate the report.","format":"int64"},"end":{"type":"integer","description":"The end timestamp of the query for the data needed to generate the report.","format":"int64"}}},"UnbindDeviceOpenApiVO":{"required":["deviceMacs"],"type":"object","properties":{"deviceMacs":{"uniqueItems":true,"type":"array","description":"Unbind device mac list, like AA-BB-CC-DD-EE-FF","items":{"type":"string","description":"Unbind device mac list, like AA-BB-CC-DD-EE-FF"}}}},"UnbindDeviceRespVO":{"type":"object","properties":{"mac":{"type":"string"},"status":{"type":"integer","description":"Unbind device status should be a value as follows: 0: success;-1: failed","format":"int32"},"licenseId":{"type":"string","description":"License ID"},"licenseType":{"type":"string","description":"License type should be a value as follows: 1year; 2years; 3years; 4years; 5years; others; trial(Cloud Based Controller), permanent; trial(Local Controller)"},"category":{"type":"string","description":"Category should be a value as follows: ap; l2Switch; l3Switch; gateway"}}},"SetTagOpenApiVO":{"required":["tagIds"],"type":"object","properties":{"macs":{"uniqueItems":true,"type":"array","description":"Device MAC list, like AA-BB-CC-DD-EE-FF","items":{"type":"string","description":"Device MAC list, like AA-BB-CC-DD-EE-FF"}},"tagIds":{"uniqueItems":true,"type":"array","description":"Tag ID list","items":{"type":"string","description":"Tag ID list"}}}},"BatchTagRespOpenApiVO":{"type":"object","properties":{"batchTagResult":{"type":"array","description":"batch set tag result","items":{"$ref":"#/components/schemas/SetTagResultOpenApiVO"}}}},"SetTagResultOpenApiVO":{"type":"object","properties":{"mac":{"type":"string"},"status":{"type":"integer","description":"0: success, 1: failed","format":"int32"}},"description":"batch set tag result"},"RollingUpgradeRequest":{"type":"object","properties":{"macs":{"type":"array","description":"MAC list of devices. E.g. AA-BB-CC-DD-11-22","items":{"type":"string","description":"MAC list of devices. E.g. AA-BB-CC-DD-11-22"}}}},"OperationResponseUpgradeTask":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/UpgradeTask"}}},"UpgradeTask":{"type":"object","properties":{"taskId":{"type":"string","description":"Task ID"}}},"UpgradeRequest":{"type":"object","properties":{"macs":{"type":"array","description":"MAC list of devices","items":{"type":"string","description":"MAC list of devices"}},"fileId":{"type":"string","description":"Firmware ID for upgrade"}}},"UnbindDeviceSnOpenApiVO":{"required":["sns"],"type":"object","properties":{"sns":{"uniqueItems":true,"type":"array","description":"Unbind device serial number list, serial number should contains 13 characters.","items":{"type":"string","description":"Unbind device serial number list, serial number should contains 13 characters."}}}},"UnbindDeviceSnRespVO":{"type":"object","properties":{"sn":{"type":"string"},"status":{"type":"integer","description":"unbind device status(0: success;-1: failed;)","format":"int32"},"licenseId":{"type":"string","description":"License ID"},"licenseType":{"type":"string","description":"1year, 2years, 3years, 4years, 5years, others, trial"},"category":{"type":"string","description":"ap, l2Switch, l3Switch, gateway"}}},"AddDeviceBySnOpenApiVO":{"type":"object","properties":{"sn":{"pattern":"^[A-Z0-9]{13}$","type":"string","description":"Device serial number. It should contains 13 characters."},"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"Device name should contain 1 to 128 characters."},"username":{"type":"string","description":"Device username. It should contain 1 to 128 characters."},"password":{"type":"string","description":"Device password. It should contain 1 to 128 characters."}},"description":"Add devices list"},"DeviceListAddBySnOpenApiVO":{"required":["devices"],"type":"object","properties":{"devices":{"type":"array","description":"Add devices list","items":{"$ref":"#/components/schemas/AddDeviceBySnOpenApiVO"}}}},"DeviceAddRespOpenApiVO":{"type":"object","properties":{"operateId":{"type":"string","description":"Operation ID used for progress query"}}},"OperationResponseDeviceAddRespOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceAddRespOpenApiVO"}}},"ActiveDeviceSnOpenApiVO":{"required":["activePairList","category"],"type":"object","properties":{"activePairList":{"type":"array","items":{"$ref":"#/components/schemas/ActivePairSnOpenApiDTO"}},"category":{"type":"string","description":"It should be a value as follows: basic; ap; l2Switch; l3Switch; gateway"}}},"ActivePairSnOpenApiDTO":{"required":["licenseType","sn"],"type":"object","properties":{"sn":{"type":"string","description":"Device serial number. It should contains 13 characters."},"licenseType":{"type":"string","description":"License type should be a value as follows: 1year; 2years; 3years; 4years; 5years; others; trial"},"licenseId":{"type":"string","description":"License ID"}}},"ActiveDeviceSnRespVO":{"type":"object","properties":{"sn":{"type":"string"},"status":{"type":"integer","description":"Active device status should be a value as follows: 0: success; -1: failed; -2002: device already active; -2003: license not enough; -2011: license category not match device;) ","format":"int32"}}},"AddDeviceByDevicekeyOpenApiVO":{"type":"object","properties":{"deviceKey":{"type":"string","description":"device key(QR code)"},"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"device name(Parameter [name] should be 1 ~ 128 characters)"},"username":{"type":"string","description":"device username"},"password":{"type":"string","description":"device password"}},"description":"add devices list"},"DeviceListAddByDevicekeyOpenApiVO":{"required":["devices"],"type":"object","properties":{"devices":{"type":"array","description":"add devices list","items":{"$ref":"#/components/schemas/AddDeviceByDevicekeyOpenApiVO"}}}},"ActiveDeviceOpenApiVO":{"required":["activePairList","category"],"type":"object","properties":{"activePairList":{"type":"array","items":{"$ref":"#/components/schemas/ActivePairOpenApiDTO"}},"category":{"type":"string","description":"It should be a value as follows: basic; ap; l2Switch; l3Switch; gateway"}}},"ActivePairOpenApiDTO":{"required":["deviceMac","licenseType"],"type":"object","properties":{"deviceMac":{"type":"string","description":"Device MAC address, like AA-BB-CC-DD-EE-FF"},"licenseType":{"type":"string","description":"License type should be a value as follows: Cloud Based Controller(1year, 2years, 3years, 4years, 5years, others, trial); Local Controller(trial, permanent);"},"licenseId":{"type":"string","description":"License ID"}}},"ActiveDeviceRespVO":{"type":"object","properties":{"mac":{"type":"string"},"status":{"type":"integer","description":"active device status(0: success;-2002: device already active;-2003: license not enough;-2011: license category not match device;)","format":"int32"}}},"MonitorDevice":{"required":["mac"],"type":"object","properties":{"id":{"type":"string","description":"The monitor device Id"},"customId":{"type":"string","description":"The device Id"},"name":{"type":"string","description":"The device name"},"mac":{"type":"string","description":"The device mac"},"ip":{"type":"string","description":"The device ip"},"deviceType":{"type":"integer","description":"The device type","format":"int32"},"type":{"type":"string","description":"The device type.Such as: ap, switch, gateway"},"showModel":{"type":"string","description":"The device showModel"},"specialModel":{"type":"string","description":"The device specialModel"},"model":{"type":"string","description":"The device model"},"modelVersion":{"type":"string","description":"The device modelVersion"},"modelModelVersion":{"type":"string","description":"The device modelModelVersion"},"clientFlag":{"type":"boolean","description":"Whether the device is a client"},"statusCategory":{"type":"integer","description":"Whether the device is online","format":"int32"},"clientType":{"type":"string","description":"Client type"},"monitoringStatus":{"type":"integer","description":"The device monitoringStatus","format":"int32"},"recoveryCycles":{"type":"integer","description":"The device recoveryCycles","format":"int32"},"uplinkDevice":{"$ref":"#/components/schemas/UplinkDevice"},"eligibleFlag":{"type":"boolean","description":"Whether the device can be monitored"},"notEligibleReason":{"type":"string","description":"The reason of the device can't be monitored"}},"description":"The device to be verified whether it can be monitored"},"UplinkDevice":{"type":"object","properties":{"mac":{"type":"string","description":"The device UplinkDevice mac"},"uplinkPort":{"type":"string","description":"The device UplinkDevice port"},"name":{"type":"string","description":"The device UplinkDevice name"},"deviceType":{"type":"integer","description":"The device UplinkDevice deviceType","format":"int32"},"type":{"type":"string","description":"The device UplinkDevice type.Such as: ap, switch, gateway"},"uplinkType":{"type":"integer","description":"The device link type","format":"int32"},"showModel":{"type":"string","description":"The device UplinkDevice showModel"},"model":{"type":"string","description":"The device UplinkDevice model"},"modelVersion":{"type":"string","description":"The device UplinkDevice modelVersion"},"standardPort":{"type":"string","description":"The device Uplink Device standardPort"},"port":{"type":"string","description":"The device Uplink Device port number"},"unit":{"type":"integer","description":"The device Uplink StackDevice unit","format":"int32"},"stackId":{"type":"string","description":"The device Uplink StackDevice StackId"},"stackName":{"type":"string","description":"The device Uplink StackDevice StackName"},"isStack":{"type":"boolean","description":"Whether The device Uplink StackDevice is Stack or not"}},"description":"The device uplinkDevice"},"VerifyDevice":{"type":"object","properties":{"monitorDevice":{"$ref":"#/components/schemas/MonitorDevice"}}},"AddMonitorDeviceList":{"type":"object","properties":{"addDeviceList":{"type":"array","description":"The device to be added to the monitor list","items":{"$ref":"#/components/schemas/MonitorDevice"}}}},"ClientUplinkDevice":{"type":"object","properties":{"mac":{"type":"string","description":"The client UplinkDevice mac"},"uplinkPort":{"type":"string","description":"The client UplinkDevice port"},"standardPort":{"type":"string","description":"The client UplinkDevice standard port"},"name":{"type":"string","description":"The client UplinkDevice name"},"deviceType":{"type":"integer","description":"The client UplinkDevice deviceType","format":"int32"},"type":{"type":"string","description":"The client UplinkDevice type.Such as: ap, switch, gateway"},"uplinkType":{"type":"integer","description":"The client link type","format":"int32"},"showModel":{"type":"string","description":"The client UplinkDevice showModel"},"model":{"type":"string","description":"The client UplinkDevice model"},"modelVersion":{"type":"string","description":"The client UplinkDevice modelVersion"},"port":{"type":"string","description":"The client Uplink Device port number"},"unit":{"type":"integer","description":"The client Uplink StackDevice unit","format":"int32"},"stackId":{"type":"string","description":"The client Uplink StackDevice StackId"},"stackName":{"type":"string","description":"The client Uplink StackDevice StackName"},"isStack":{"type":"boolean","description":"Whether The client Uplink StackDevice is Stack or not"}},"description":"The client uplinkDevice"},"MonitorClient":{"required":["mac"],"type":"object","properties":{"id":{"type":"string","description":"The monitor client Id"},"customId":{"type":"string","description":"The client Id"},"name":{"type":"string","description":"The client name"},"mac":{"type":"string","description":"The client mac"},"ip":{"type":"string","description":"The client ip"},"deviceType":{"type":"integer","description":"The client type","format":"int32"},"type":{"type":"string","description":"The client type.Such as: ap, switch, gateway"},"showModel":{"type":"string","description":"The client showModel"},"specialModel":{"type":"string","description":"The client specialModel"},"model":{"type":"string","description":"The client model"},"modelVersion":{"type":"string","description":"The client modelVersion"},"modelModelVersion":{"type":"string","description":"The client modelModelVersion"},"clientFlag":{"type":"boolean","description":"Whether the device is a client"},"statusCategory":{"type":"integer","description":"Whether the client is online","format":"int32"},"monitoringStatus":{"type":"integer","description":"The client monitoringStatus","format":"int32"},"recoveryCycles":{"type":"integer","description":"The client recoveryCycles","format":"int32"},"ClientUplinkDevice":{"$ref":"#/components/schemas/ClientUplinkDevice"},"eligibleFlag":{"type":"boolean","description":"Whether the client can be monitored"},"notEligibleReason":{"type":"string","description":"The reason of the client can't be monitored"}},"description":"The client to be verified whether it can be monitored"},"VerifyClientVO":{"type":"object","properties":{"monitorClient":{"$ref":"#/components/schemas/MonitorClient"}}},"AddMonitorClientList":{"type":"object","properties":{"addClientList":{"type":"array","description":"The client to be added to the monitor list","items":{"$ref":"#/components/schemas/MonitorClient"}}}},"ResolveSiteLogListOpenApiVO":{"required":["endTime","selectType","startTime"],"type":"object","properties":{"logs":{"type":"array","description":"Select the logs to resolve; Log ID list can be obtained from 'Get site alert log list' interface.","items":{"type":"string","description":"Select the logs to resolve; Log ID list can be obtained from 'Get site alert log list' interface."}},"selectType":{"type":"string","description":"Select type of logs. include: include selected logs, exclude: all but exclude selected logs, all: include all logs(Parameter [logs] need input '[]')."},"startTime":{"type":"integer","description":"The start timeStamp of the resolve site alert log, unit: MS.","format":"int64"},"endTime":{"type":"integer","description":"The end timeStamp of the resolve site alert log, unit: MS.","format":"int64"},"filterModule":{"type":"string","description":"The module of the resolve site alert log; It is required when [selectType] is 'all', filterModule should be a value as follows: 'System' or 'Device'."}}},"LicenseAutoRenewOpenApiVO":{"required":["autoRenew"],"type":"object","properties":{"autoRenew":{"type":"boolean","description":"Auto-Renewal,the licenses for active devices will be automatically renewed when they expire."}}},"LanNetworkOpenApiVO":{"required":["igmpSnoopEnable","name","purpose"],"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"LAN network name should contain 1 to 128 characters."},"purpose":{"type":"integer","description":"LAN network purpose, 0: VLAN, 1: interface","format":"int32"},"isolation":{"type":"boolean","description":"Whether isolate this network."},"interfaceIds":{"type":"array","description":"Gateway LAN port IDs, which are acquired from \"Check WAN/LAN status\"","items":{"type":"string","description":"Gateway LAN port IDs, which are acquired from \"Check WAN/LAN status\""}},"vlanType":{"type":"integer","description":"When purpose is interface, VLANType is valid. 0: Single; 1: Multiple","format":"int32"},"vlans":{"pattern":"^[\\d|\\d-\\d]+(,[\\d|\\d-\\d]+)*$","type":"string","description":"When purpose is \"interface\" and VLANType is 1, batch create VLANs. VLAN format: 200, 1-100."},"vlan":{"type":"integer","description":"When purpose is \"VLAN\" or purpose is \"interface\" and VLANType is 0, create VLAN, which ranges from 1 to 4090.","format":"int32"},"application":{"type":"integer","description":"Effective device type, 0: Gateway, Switch; 1: Switch","format":"int32"},"gatewaySubnet":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])/(\\d|((1|2)\\d)|(30))\\b","type":"string","description":"When purpose is interface, gateway subnet is needed. Format: IP/Mask"},"dhcpSettingsVO":{"$ref":"#/components/schemas/dhcp settings"},"domain":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"The domain of this network"},"igmpSnoopEnable":{"type":"boolean","description":"Enable IGMP snooping"},"mldSnoopEnable":{"type":"boolean","description":"Enable MLD snooping"},"dhcpL2RelayEnable":{"type":"boolean","description":"The switch of DHCP L2 relay"},"dhcpGuard":{"$ref":"#/components/schemas/Dhcp Servers setting"},"dhcpv6Guard":{"$ref":"#/components/schemas/Dhcpv6 Servers setting"},"lanNeworkIpv6Config":{"$ref":"#/components/schemas/Lan network IPV6 config"},"allLan":{"type":"boolean","description":"When Internet pre-config is closed or Internet pre-config is Universal, allLAN is \"true\"; after adopting gateway, allLAN is \"false\"."}},"description":"LANNetworkOpenApiVO"},"dhcp settings":{"type":"object","properties":{"enable":{"type":"boolean","description":"When value is true, DHCP server is enabled"},"ipaddrStart":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"DHCP Range Start IP. Must use ipRangePool field If want to configure multiple DHCP Ranges."},"ipaddrEnd":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"DHCP Range End IP. Must use ipRangePool field If want to configure multiple DHCP Ranges."},"ipRangeStart":{"type":"integer","description":"The specific format value of Gateway Subnet start IP","format":"int64"},"ipRangeEnd":{"type":"integer","description":"The specific format value of Gateway Subnet End IP","format":"int64"},"dhcpns":{"type":"string","description":"Setup DHCP server: \"auto\" or \"manual\""},"priDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"When DHCPs are \"manual\", primary DNS Server."},"sndDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"When DHCPs are \"manual\", second DNS Server."},"leasetime":{"type":"integer","description":"Valid value is from 2 to 2880","format":"int32"},"gateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Manual Setup of DHCP Gateway IP"},"hostIP":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"DHCP Omada Controller IP"},"option60":{"pattern":"^[\\041-\\0176]{0,50}$","type":"string","description":"Option60 should be between 0 and 50, which is used to optionally identify the vendor type and configuration of a DHCP client."},"option66":{"pattern":"^[\\041-\\0176]{0,128}$","type":"string","description":"The Option66 should be between 0 and 128, which specifies the TFTP server information and supports a single TFTP server IP address."},"option138":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The option138 should be valid IP address, which is used in discovering the devices by the Omada controller."},"dhcpNextServer":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The dhcpNextServer should be valid IP address, which is used in optional set next DHCP server."},"dhcpPoolMask":{"type":"integer","format":"int32"},"options":{"type":"array","description":"User custom DHCP options","items":{"$ref":"#/components/schemas/custom DHCP Options"}}},"description":"Configure DHCP settings"},"QueryUseNativeNetworkOswOpenApiVO":{"required":["page","pageSize"],"type":"object","properties":{"page":{"type":"integer","description":"Start from 1.","format":"int32"},"pageSize":{"type":"integer","description":"It should be within the range of 1–1000.","format":"int32"},"selectAll":{"type":"boolean","description":"Select all VLAN networks"},"ids":{"type":"array","description":"List of VLAN and Interface network IDs. The valid network IDs can be obtained from \"Get LAN network list\". When selectAll is true, it means select all except specified IDs; When selectAll is false, it means select specified IDs.","items":{"type":"string","description":"List of VLAN and Interface network IDs. The valid network IDs can be obtained from \"Get LAN network list\". When selectAll is true, it means select all except specified IDs; When selectAll is false, it means select specified IDs."}}},"description":"QueryUseNativeNetworkOswOpenApiVO"},"GridVOUseProfileOswOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UseProfileOswOpenApiVO"}}}},"OperationResponseGridVOUseProfileOswOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOUseProfileOswOpenApiVO"}}},"UseProfileOswOpenApiVO":{"type":"object","properties":{"name":{"type":"string","description":"Switch name"},"mac":{"type":"string","description":"Switch MAC address, like AA-BB-CC-DD-EE-FF"},"model":{"type":"string","description":"Device model"},"modelVersion":{"type":"string","description":"Device model version"},"ip":{"type":"string","description":"Device IP address"}},"description":"UseProfileOswOpenApiVO"},"QueryUseNativeNetworkOswV2OpenApiVO":{"required":["page","pageSize"],"type":"object","properties":{"page":{"type":"integer","description":"Start from 1.","format":"int32"},"pageSize":{"type":"integer","description":"It should be within the range of 1–1000.","format":"int32"},"selectType":{"pattern":"all|include|exclude","type":"string","description":"selectType should be a value as follows: all: select all; include: include ids; exclude: exclude ids."},"ids":{"type":"array","description":"List of VLAN and Interface network IDs. The valid network IDs can be obtained from \"Get LAN network list\".","items":{"type":"string","description":"List of VLAN and Interface network IDs. The valid network IDs can be obtained from \"Get LAN network list\"."}}},"description":"QueryUseNativeNetworkOswV2OpenApiVO"},"Delete Ips Threat":{"type":"object","properties":{"threatId":{"type":"array","description":"IPS threatId and Time list.","items":{"$ref":"#/components/schemas/Ips operate threatId and time"}}}},"Ips operate threatId and time":{"required":["id","time"],"type":"object","properties":{"time":{"type":"integer","description":"Timestamp, in seconds, such as 1682000000","format":"int64"},"id":{"type":"string","description":"Threat ID"}},"description":"IPS threatId and Time list."},"Ips Operate Threat":{"required":["type"],"type":"object","properties":{"threatId":{"type":"array","description":"IPS signature type should be a value as follows: 0: all traffic; 1: packet tracking respectively.","items":{"$ref":"#/components/schemas/Ips operate threatId and time"}},"type":{"type":"integer","description":"IPS Operate Threat type should be a value as follows: 0: block; 1:isolate device; 2: signature Suppression; 3: allow","format":"int32","example":1},"signatureSuppression":{"$ref":"#/components/schemas/SignatureSuppression"},"blockName":{"type":"string","description":"IPS block name should not be empty when type is 0 or 1.","example":"blockName"}}},"SignatureSuppression":{"required":["type"],"type":"object","properties":{"type":{"type":"integer","description":"Type should be a value as follow: 0: all traffic; 1: packet tracking.","format":"int32","example":1},"direction":{"type":"integer","description":"Direction should be a value as follow: 0: both direction; 1: source direction; 2: destination direction","format":"int32","example":1},"trackBy":{"type":"integer","description":"TrackBy should be a value as follow: 0: ip address; 1: subnet","format":"int32","example":0},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IPS signature traffic source. If parameter [trackBy] is 0, parameter [ip] is needed. ","example":"192.168.0.1"},"subnet":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])/([1-9]|((1|2)\\d)|(30|31|32))\\b","type":"string","description":"IPS signature traffic source. If parameter [trackBy] is 1, parameter [subnet] is needed.","example":"192.168.0.0/24"}},"description":"Signature suppression configuration"},"CheckIpMacBindingExportToDhcpReservationOpenApiVO":{"required":["interfaceId","ip","mac"],"type":"object","properties":{"mac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"MAC of the IP MAC binding entity."},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP of the IP MAC binding entity."},"interfaceId":{"type":"string","description":"Interface ID. WAN port ID can be obtained from 'Get internet basic info' interface. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."},"imbId":{"type":"string","description":"IP-MAC binding entry ID."}}},"OsgModelOpenApiVO":{"required":["modelId"],"type":"object","properties":{"modelId":{"type":"integer","description":"It refers to function \"Get supported gateway model list for pre-configuration\".","format":"int32"}}},"IntelliRecoverSetting":{"type":"object","properties":{"id":{"type":"string","description":"The intelli recover setting Id."},"autoFlag":{"type":"boolean","description":"Auto recovering flag"},"firstRebootPoeInterval":{"type":"integer","description":"First reboot uplinkDevice poe interval","format":"int32"},"limitNum":{"type":"integer","description":"The limit reboot uplinkDevice poe number","format":"int32"},"rebootPoeInterval":{"type":"integer","description":"Retry reboot uplinkDevice poe interval","format":"int32"}}},"SelectIdsOpenApiVO":{"required":["groupId","type"],"type":"object","properties":{"type":{"type":"integer","description":"Select type. It should be a value as follows: 0: Represents selecting all vouchers in the voucher group, this selection does not pass parameter [ids]. 1: Parameter [ids] includes the IDs of vouchers in the voucher group to be selected. 2: Parameter [ids] includes the IDs of vouchers in the voucher group not to be selected","format":"int32"},"ids":{"type":"array","description":"ID list of vouchers. Voucher can be created using 'Create Voucher Group' interface, and Voucher ID can be obtained from 'Get Voucher Group Detail' interface","items":{"type":"string","description":"ID list of vouchers. Voucher can be created using 'Create Voucher Group' interface, and Voucher ID can be obtained from 'Get Voucher Group Detail' interface"}},"groupId":{"type":"string","description":"Voucher Group ID. Voucher group can be created using 'Create Voucher Group' interface, and Voucher Group ID can be obtained from 'Get Voucher Group list' interface"},"searchKey":{"type":"string","description":"Fuzzy query parameters, support field: voucher code"},"status":{"type":"integer","description":"voucher status filter query parameters. It should be a value as follows: 0: Unused vouchers, 1: In use vouchers, 2: Expired vouchers","format":"int32"}}},"OperationResponseListVoucherBriefOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/VoucherBriefOpenApiVO"}}}},"VoucherBriefOpenApiVO":{"type":"object","properties":{"code":{"type":"string","description":"Voucher code"},"limitType":{"type":"integer","description":"The limitations of the voucher. It should be a value as follows: 0: Limited Usage Counts, 1: Limited Online Users, 2: Unlimited","format":"int32"},"limitNum":{"type":"integer","description":"The number of limitations. It should be within the range of 1–999. If Parameter [limitType] is 0 or 1, [limitNum] should not be null.When Parameter [limitType] is 0, [limitNum] represents the maximum number of times this voucher can be used.When Parameter [limitType] is 1, [limitNum] represents the maximum number of users this voucher can be used at the same time.","format":"int32"},"durationType":{"type":"integer","description":"The duration type of the voucher. It should be a value as follows: 0: Client duration, each client expires after the duration is used. 1: Voucher duration, after reaching the voucher duration, clients using the voucher will expire","format":"int32"},"duration":{"type":"integer","description":"Duration of one use, unit: minute. It should be within the range of 1–14400000.","format":"int64"},"unitPrice":{"type":"string","description":"Price of single voucher. It should be within the range of 1–999999999"},"currency":{"type":"string","description":"Currency Short Code of voucher. For the values of Currency Short Code, refer to section 5.4.2 of the Open API Access Guide."},"validity":{"type":"string","description":"The validity period information of the voucher"},"printComments":{"type":"string","description":"Print comments of the voucher"},"ssidNameList":{"type":"array","description":"Ssid name for voucher","items":{"type":"string","description":"Ssid name for voucher"}},"networkNameList":{"type":"array","description":"Network name for voucher","items":{"type":"string","description":"Network name for voucher"}},"patternType":{"type":"integer","description":"Voucher pattern type. 0: Logo, 1: Title, 3: Disabled","format":"int32"},"picId":{"type":"string","description":"Voucher logo picture ID"},"title":{"type":"string","description":"Title for voucher"},"position":{"type":"integer","description":"Position for logo or title","format":"int32"},"logoSize":{"type":"integer","description":"Size of logo on the pattern of the voucher. It should be within the range of 12-18.","format":"int32"},"titleSize":{"type":"integer","description":"Size of title on the pattern of the voucher. It should be within the range of 50-175","format":"int32"}}},"CreateVoucherGroupOpenApiVO":{"required":["amount","applyToAllPortals","codeForm","codeLength","duration","durationType","limitType","name","rateLimit","timingType","trafficLimitEnable"],"type":"object","properties":{"name":{"type":"string","description":"Voucher group name. It should contain 1-32 characters"},"amount":{"type":"integer","description":"The amount of vouchers created. It should be within the range of 1-5000","format":"int32"},"codeLength":{"type":"integer","description":"The length of voucher code. It should be within the range of 6–10.","format":"int32"},"codeForm":{"uniqueItems":true,"type":"array","description":"The character types contained in the voucher code. It should be a value as follows: 0: Number, 1: Letter. For example, [0] indicates that the code only contains numbers; [0, 1] indicates that the code contains numbers and letters","items":{"type":"integer","description":"The character types contained in the voucher code. It should be a value as follows: 0: Number, 1: Letter. For example, [0] indicates that the code only contains numbers; [0, 1] indicates that the code contains numbers and letters","format":"int32"}},"limitType":{"type":"integer","description":"The limitations of the voucher. It should be a value as follows: 0: Limited Usage Counts, 1: Limited Online Users, 2: Unlimited","format":"int32"},"limitNum":{"type":"integer","description":"The number of limitations. It should be within the range of 1–999. If Parameter [limitType] is 0 or 1, [limitNum] should not be null.When Parameter [limitType] is 0, [limitNum] represents the maximum number of times this voucher can be used.When Parameter [limitType] is 1, [limitNum] represents the maximum number of users this voucher can be used at the same time.","format":"int32"},"durationType":{"type":"integer","description":"The duration type of the voucher. It should be a value as follows: 0: Client duration, each client expires after the duration is used. 1: Voucher duration, after reaching the voucher duration, clients using the voucher will expire","format":"int32"},"duration":{"type":"integer","description":"Duration of one use, unit: minute. It should be within the range of 1–14400000.","format":"int64"},"timingType":{"type":"integer","description":"The timing type of the voucher. It should be a value as follows: 0: Timing by time, clients can use vouchers for specified time duration. 1: Timing by usage, clients can use vouchers for the duration of actual usage","format":"int32"},"rateLimit":{"$ref":"#/components/schemas/RateLimitOpenApiVO"},"trafficLimitEnable":{"type":"boolean","description":"Whether to enable traffic limit"},"trafficLimit":{"type":"integer","description":"Traffic limit in MB. It should be within the range of 1–10485760","format":"int64"},"trafficLimitFrequency":{"type":"integer","description":"Frequency of traffic limit should be a value as follows: 0: total; 1: daily; 2: weekly; 3: monthly.","format":"int32"},"unitPrice":{"type":"integer","description":"Price of single voucher. It should be within the range of 1–999999999","format":"int64"},"currency":{"type":"string","description":"Currency Short Code of voucher. For the values of Currency Short Code, refer to section 5.4.2 of the Open API Access Guide."},"applyToAllPortals":{"type":"boolean","description":"Is the voucher effective for all portals, including all newly created portals"},"portals":{"type":"array","description":"Bound portal ID list. Portal can be created using 'Add portal' interface, and portal ID can be obtained from 'Get portal list in a site' interface","items":{"type":"string","description":"Bound portal ID list. Portal can be created using 'Add portal' interface, and portal ID can be obtained from 'Get portal list in a site' interface"}},"expirationTime":{"type":"integer","description":"The timestamp of the expiration of the voucher, unit: millisecond. When parameter [validityType] is 1, parameter [expirationTime] is required","format":"int64"},"effectiveTime":{"type":"integer","description":"The timestamp when the voucher takes effect, unit: millisecond. When parameter [validityType] is 1, parameter [effectiveTime] is required","format":"int64"},"logout":{"type":"boolean","description":"Whether the voucher support portal logout functionality"},"description":{"type":"string","description":"Description of the voucher group"},"printComments":{"type":"string","description":"Print comments of the voucher group"},"validityType":{"type":"integer","description":"The validity type of the voucher. It should be a value as follows: 0: Voucher can be used at any time, parameter [effectiveTime], [expirationTime] and [schedule] should be null. 1: Voucher can be used between the effective time and expiration time, parameter [effectiveTime] and [expirationTime] should not be null, parameter [schedule] should be null. 2: Voucher can be used within a specified time period by schedule, parameter [effectiveTime] and [expirationTime] should be null, parameter [schedule] should not be null","format":"int32"},"schedule":{"$ref":"#/components/schemas/VoucherScheduleOpenApiVO"}}},"CustomRateLimitOpenApiVO":{"required":["downLimitEnable","upLimitEnable"],"type":"object","properties":{"downLimitEnable":{"type":"boolean","description":"Whether to enable downlink speed limit."},"downLimit":{"type":"integer","description":"Downlink speed limit in Kbps. The value of limit should be within the range of 0–10485760(Kbps).","format":"int64"},"upLimitEnable":{"type":"boolean","description":"Whether to enable uplink speed limit."},"upLimit":{"type":"integer","description":"Uplink speed limit in Kbps. The value of limit should be within the range of 0–10485760(Kbps).","format":"int64"}},"description":"Custom configuration rate limit."},"RateLimitOpenApiVO":{"required":["mode"],"type":"object","properties":{"mode":{"type":"integer","description":"Mode of configure rate limit should be a value as follows: 0: customRateLimit; 1: rateLimitProfileId.","format":"int32"},"rateLimitProfileId":{"type":"string","description":"This field represents Rate limit profile ID. Rate limit profile can be created using 'Create rate limit profile' interface, and Rate limit profile ID can be obtained from 'Get rate limit profile list' interface"},"customRateLimit":{"$ref":"#/components/schemas/CustomRateLimitOpenApiVO"}},"description":"When configuring rate limit, can only configure one of rateLimitProfileId or customRateLimit"},"VoucherScheduleOpenApiVO":{"required":["type"],"type":"object","properties":{"type":{"type":"integer","description":"The type of schedule. It should be a value as follows: 0: Limit time by daily, 1: Limit time by weekly","format":"int32"},"dailyStartHour":{"type":"integer","description":"The hour of start time, should be within the range of 0-23. When parameter [type] is 0, parameter [dailyStartHour] is required","format":"int32"},"dailyStartMin":{"type":"integer","description":"The minute of start time, should be within the range of 0-59 When parameter [type] is 0, parameter [dailyStartMin] is required","format":"int32"},"dailyEndHour":{"type":"integer","description":"The hour of end time, should be within the range of 0-23 When parameter [type] is 0, parameter [dailyEndHour] is required","format":"int32"},"dailyEndMin":{"type":"integer","description":"The minute of end time, should be within the range of 0-59 When parameter [type] is 0, parameter [dailyEndMin] is required","format":"int32"},"weeklyEnableDays":{"uniqueItems":true,"type":"array","description":"The effective days of week, array number should be within the range of 1-7, 1 represents Monday, 2 represents Tuesday... 7 represents Sunday. When parameter [type] is 1, parameter [weeklyEnableDays] is required","items":{"type":"integer","description":"The effective days of week, array number should be within the range of 1-7, 1 represents Monday, 2 represents Tuesday... 7 represents Sunday. When parameter [type] is 1, parameter [weeklyEnableDays] is required","format":"int32"}}},"description":"Specified time period that voucher can be used. When parameter [validityType] is 2, parameter [schedule] is required"},"CreatedResIdOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"ID of the created object."}}},"OperationResponseCreatedResIdOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CreatedResIdOpenApiVO"}}},"SelectVoucherGroupOpenApiVO":{"required":["type"],"type":"object","properties":{"type":{"type":"integer","description":"Select type. It should be a value as follows: 0: Represents selecting all voucher groups, this selection does not pass parameter [groupIds]. 1: Parameter [groupIds] includes the IDs of the voucher groups to be selected. 2: Parameter [groupIds] includes the IDs of the voucher groups not to be selected","format":"int32"},"groupIds":{"type":"array","description":"ID list of voucher groups. Voucher group can be created using 'Create Voucher Group' interface, and Voucher Group ID can be obtained from 'Get Voucher Group list' interface","items":{"type":"string","description":"ID list of voucher groups. Voucher group can be created using 'Create Voucher Group' interface, and Voucher Group ID can be obtained from 'Get Voucher Group list' interface"}},"searchKey":{"type":"string","description":"Fuzzy query parameters, support field: voucher group name, voucher code"},"timeStart":{"type":"integer","description":"End timestamp filter query parameters, unit: MS","format":"int64"}}},"AuthTimeOpenApiVO":{"required":["authTimeout"],"type":"object","properties":{"authTimeout":{"type":"integer","description":"Validity period should be a value as follows: 0: Custom; 1: 30 Minutes; 2: 1 Hour; 3: 2 Hours; 4: 4 Hours; 5: 8 Hours; 6: 1 Day; 7: 7 Days integer.","format":"int32"},"customTimeout":{"type":"integer","description":"Custom timeout should be within the range of 1 ~ 1,000,000 minutes(when parameter[customTimeoutUnit] value is 1), or 1 ~ 10,000 hours(when parameter[customTimeoutUnit] value is 2), or 1 ~ 1,000 days(when parameter[customTimeoutUnit] value is 3).","format":"int32"},"customTimeoutUnit":{"type":"integer","description":"Custom timeout unit should be a value as follows: 1: min; 2: hour; 3: day.","format":"int32"}},"description":"Authentication timeout time. Display when enabled, otherwise no display."},"CreateFormAuthOpenApiVO":{"required":["authTimeout","cardList","name","note","published","title"],"type":"object","properties":{"title":{"type":"string","description":"Form title (display for the authentication user). It should contain 1-2000 characters."},"name":{"type":"string","description":"Form name (display for the controller user). It should contain 1-2000 characters."},"note":{"type":"string","description":"Note should contain 1-2000 characters."},"authTimeout":{"$ref":"#/components/schemas/AuthTimeOpenApiVO"},"cardList":{"type":"array","description":"Form card list.","items":{"$ref":"#/components/schemas/FormAuthCardOpenApiVO"}},"published":{"type":"boolean","description":"Whether to publish."}},"description":"Survey authentication"},"FormAuthCardOpenApiVO":{"required":["choices","required","title","type"],"type":"object","properties":{"type":{"type":"integer","description":"Card type should be a value as follows: 0: single choice (single choice); 1: multiple choice (multiple choice); 2: ComboBox (drop-down menu); 3: input (input box); 4: score (score); 5: prompt frame","format":"int32"},"required":{"type":"boolean","description":"Indicates whether the card is required (cardType is 5, meaningless in the prompt box)."},"title":{"type":"string","description":"Title should contain 1-2000 characters"},"choices":{"type":"array","description":"Drop-down menu or list of options for multiple-choice questions (exist if and only if cardType is 0, 1, 2), excluding questions with other options. Choices should contain 1-2000 characters","items":{"type":"string","description":"Drop-down menu or list of options for multiple-choice questions (exist if and only if cardType is 0, 1, 2), excluding questions with other options. Choices should contain 1-2000 characters"}},"others":{"type":"string","description":"The question of the other options. Exists if and only if type is 0, 1. Others should contain 1-2000 characters"},"scoreNotes":{"type":"array","description":"The prompt text corresponding to different scores of the scoring card. Exists when the cardType is 4 and needs to be transmitted in order. The subscript 0 corresponds to the score 1.","items":{"type":"string","description":"The prompt text corresponding to different scores of the scoring card. Exists when the cardType is 4 and needs to be transmitted in order. The subscript 0 corresponds to the score 1."}}},"description":"Form card list."},"Form Auth Result Selector":{"required":["type"],"type":"object","properties":{"type":{"pattern":"^(all|include|exclude)$","type":"string","description":"Type of Selection, allowed values: all, include, exclude."},"ids":{"type":"array","description":"IDs of Selected Form Auth Result. Required when type is not all.","items":{"type":"string","description":"IDs of Selected Form Auth Result. Required when type is not all."}}},"description":"Selector of survey authentication result ID"},"PortalCandidatesOpenApiVO":{"required":["allPortal"],"type":"object","properties":{"allPortal":{"type":"boolean","description":"Whether portal privilege is true"},"portalIds":{"type":"array","description":"Portal IDs of the requested SSIDs and networks.","items":{"type":"string","description":"Portal IDs of the requested SSIDs and networks."}}}},"OperationResponsePortalCandidatesResOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PortalCandidatesResOpenApiVO"}}},"PortalCandidatesResOpenApiVO":{"type":"object","properties":{"wlanList":{"type":"array","description":"WLAN list of the portals.","items":{"$ref":"#/components/schemas/PortalWlanOpenApiVO"}},"networkList":{"type":"array","description":"Network list of the portals.","items":{"$ref":"#/components/schemas/PortalNetworkOpenApiVO"}}}},"PortalNetworkOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Network ID"},"name":{"type":"string","description":"Network name"}},"description":"Network list of the portals."},"PortalSsidOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"SSID ID"},"name":{"type":"string","description":"SSID name"}},"description":"SSID list of WLAN"},"PortalWlanOpenApiVO":{"type":"object","properties":{"wlanId":{"type":"string","description":"WLAN ID"},"wlanName":{"type":"string","description":"WLAN name"},"ssidList":{"type":"array","description":"SSID list of WLAN","items":{"$ref":"#/components/schemas/PortalSsidOpenApiVO"}}},"description":"WLAN list of the portals."},"Hotspot Operator":{"required":["name","password","selectedSites"],"type":"object","properties":{"name":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"Operator name should contain 1 to 128 ASCII characters."},"password":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"Operator password should contain 1 to 128 ASCII characters."},"note":{"pattern":"^[^ ]$|^[^ ].{0,254}[^ ]$","type":"string","description":"Operator note should contain 1 to 256 ASCII characters."},"operatorRoleType":{"type":"integer","description":"Operator role type should be a value as follows: 0: Administrator; 1: Viewer.","format":"int32"},"lastSite":{"type":"string","description":"Last Site ID"},"selectedSites":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Selected site ID list should contain at least one site for each operator.","items":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Selected site ID list should contain at least one site for each operator."}}}},"CreateLocalUserOpenApiVO":{"required":["bindingType","enable","expirationTime","password","portals","rateLimit","trafficLimitEnable","userName"],"type":"object","properties":{"userName":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"User name should contain 1 to 128 ASCII visible characters, with no spaces at the beginning and end, and spaces in the middle, cannot be changed after creation."},"password":{"type":"string","description":"Password should contain 1 to 128 characters."},"enable":{"type":"boolean","description":"Whether to enable."},"expirationTime":{"type":"integer","description":"Expiration timestamp. Unit:ms.","format":"int64"},"bindingType":{"type":"integer","description":"MAC binding type should be a value as follows: 0: no binding; 1: static binding; 2: dynamic binding.","format":"int32"},"macAddress":{"type":"string","description":"Mac address,the value is only available when the macType is static binding or dynamic binding."},"maxUsers":{"type":"integer","description":"The maximum number of users online at the same time when the MAC binding type is No Binding. It cannot be modified after initialization. MaxUsers should be within the range of 1–2048.","format":"int32"},"name":{"pattern":"^$|^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"Name should contain 1 to 128 characters, with no spaces at the beginning and end, and spaces in the middle"},"phone":{"type":"string","description":"Phone number should contain 1 to 20 characters."},"rateLimit":{"$ref":"#/components/schemas/RateLimitOpenApiVO"},"trafficLimitEnable":{"type":"boolean","description":"Whether to enable traffic limit."},"trafficLimit":{"type":"integer","description":"Traffic limit in MB. It should be within the range of 1–10485760.","format":"int64"},"trafficLimitFrequency":{"type":"integer","description":"Frequency of traffic limit should be a value as follows: 0: total; 1: daily; 2: weekly; 3: monthly.","format":"int32"},"portals":{"type":"array","description":"Bound portal ID list. Portal can be created using 'Add portal' interface, and portal ID can be obtained from 'Get portal list in a site' interface","items":{"type":"string","description":"Bound portal ID list. Portal can be created using 'Add portal' interface, and portal ID can be obtained from 'Get portal list in a site' interface"}},"logout":{"type":"boolean","description":"local user logout. enable local user logout"},"applyToAllPortals":{"type":"boolean","description":"Is the localuser effective for all portals, including all newly created portals"},"dailyLimitEnable":{"type":"boolean","description":"Whether to enable localuser daily time limit"},"dailyLimit":{"$ref":"#/components/schemas/DailyAuthTimeOpenApiVO"}}},"DailyAuthTimeOpenApiVO":{"required":["authTimeout"],"type":"object","properties":{"authTimeout":{"type":"integer","description":"Validity period should be a value as follows: 0: Custom; 1: 30 Minutes; 2: 1 Hour; 3: 2 Hours; 4: 4 Hours; 5: 8 Hours;","format":"int32"},"customTimeout":{"type":"integer","description":"Custom timeout should be within the range of 1 ~ 1,440 minutes(when parameter[customTimeoutUnit] value is 1), or 1 ~ 24 hours(when parameter[customTimeoutUnit] value is 2).","format":"int32"},"customTimeoutUnit":{"type":"integer","description":"Custom timeout unit should be a value as follows: 1: min; 2: hour.","format":"int32"}},"description":"Daily time limit setting, required when parameter [dailyLimitEnable] is true"},"ModifyLocalUserOpenApiVO":{"required":["bindingType","enable","expirationTime","password","portals","rateLimit","trafficLimitEnable"],"type":"object","properties":{"password":{"type":"string","description":"Password should contain 1 to 128 characters."},"enable":{"type":"boolean","description":"Whether to enable."},"expirationTime":{"type":"integer","description":"Expiration timestamp. Unit:ms.","format":"int64"},"bindingType":{"type":"integer","description":"MAC binding type should be a value as follows: 0: no binding; 1: static binding; 2: dynamic binding.","format":"int32"},"macAddress":{"type":"string","description":"Mac address,the value is only available when the macType is static binding or dynamic binding."},"maxUsers":{"type":"integer","description":"The maximum number of users online at the same time when the MAC binding type is No Binding. It cannot be modified after initialization. MaxUsers should be within the range of 1–2048.","format":"int32"},"name":{"pattern":"^$|^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"Name should contain 1 to 128 characters, with no spaces at the beginning and end, and spaces in the middle"},"phone":{"type":"string","description":"Phone number should contain 1 to 20 characters."},"rateLimit":{"$ref":"#/components/schemas/RateLimitOpenApiVO"},"trafficLimitEnable":{"type":"boolean","description":"Whether to enable traffic limit."},"trafficLimit":{"type":"integer","description":"Traffic limit in MB. It should be within the range of 1–10485760.","format":"int64"},"trafficLimitFrequency":{"type":"integer","description":"Frequency of traffic limit should be a value as follows: 0: total; 1: daily; 2: weekly; 3: monthly.","format":"int32"},"portals":{"type":"array","description":"Bound portal ID list. Portal can be created using 'Add portal' interface, and portal ID can be obtained from 'Get portal list in a site' interface","items":{"type":"string","description":"Bound portal ID list. Portal can be created using 'Add portal' interface, and portal ID can be obtained from 'Get portal list in a site' interface"}},"logout":{"type":"boolean","description":"local user logout. enable local user logout"},"applyToAllPortals":{"type":"boolean","description":"Is the localuser effective for all portals, including all newly created portals"}}},"SelectLocalUsersOpenApiVO":{"required":["type"],"type":"object","properties":{"type":{"type":"integer","description":"Select type. It should be a value as follows: 0: Represents selecting all localUsers, this selection does not pass parameter [ids]. 1: Parameter [ids] includes the IDs of the localUsers to be selected. 2: Parameter [ids] includes the IDs of the localUsers not to be selected","format":"int32"},"ids":{"type":"array","description":"IDs of localUsers to be deleted in batch operation","items":{"type":"string","description":"IDs of localUsers to be deleted in batch operation"}}}},"UploadVoucherGroupLogoOpenApiVO":{"type":"object","properties":{"fileName":{"type":"string","description":"File name"},"md5":{"type":"string","description":"File md5, at least one of the file or md5 parameters needs to be passed"}},"description":"File name,,need to specify Content-Type of this form part as application/json."},"ExtendOpenApiVO":{"required":["period"],"type":"object","properties":{"period":{"type":"integer","description":"Extended timestamp. Unit:ms. Period should be within the range of 60000 to 86400000000000(60s to 1000000days).","format":"int64"}}},"Delete Filter Info":{"required":["end","start"],"type":"object","properties":{"start":{"type":"integer","description":"Start timestamp, in seconds, such as 1682000000.","format":"int64"},"end":{"type":"integer","description":"End timestamp, in seconds, such as 1682000000.","format":"int64"},"searchKey":{"type":"string","description":"Searching key for clients to delete, Searching by: client mac, client name, ssid name, network name."}}},"ExportAuthedClientOpenApiVO":{"type":"object","properties":{"siteIds":{"type":"array","description":"Site IDs of the authed clients to export.","items":{"type":"string","description":"Site IDs of the authed clients to export."}},"format":{"type":"integer","description":"Export authed client format.","format":"int32"}}},"TimeQueryOpenApiVO":{"required":["end","start"],"type":"object","properties":{"start":{"type":"integer","description":"Start time, number of seconds from UTC0 1970/01/01","format":"int64"},"end":{"type":"integer","description":"End time, number of seconds from UTC0 1970/01/01","format":"int64"}}},"ActiveOswHealthOpenApiVO":{"type":"object","properties":{"name":{"type":"string","description":"Device name"},"mac":{"type":"string","description":"Device mac"},"model":{"type":"string","description":"Device model"},"modelVersion":{"type":"string","description":"Device model version"},"healthScore":{"type":"integer","description":"Health score","format":"int32"},"type":{"type":"string","description":"Device type"},"deviceSeriesType":{"type":"integer","description":"Device series type should be a value as follows: 0:advanced, 1:pro","format":"int32"},"traffic":{"type":"integer","description":"Device traffic (Bytes)","format":"int64"}},"description":"Active switches information list"},"OperationResponseOswRankingCardsOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswRankingCardsOpenApiVO"}}},"OswRankingCardsOpenApiVO":{"type":"object","properties":{"topActiveSwitches":{"type":"array","description":"Active switches information list","items":{"$ref":"#/components/schemas/ActiveOswHealthOpenApiVO"}},"topCpu":{"type":"array","description":"Cpu information list","items":{"$ref":"#/components/schemas/TopCpuUsageHealthOpenApiVO"}},"topMem":{"type":"array","description":"Memory information list","items":{"$ref":"#/components/schemas/TopMemUsageHealthOpenApiVO"}},"topPacketsLoss":{"type":"array","description":"Packet loss information list","items":{"$ref":"#/components/schemas/TopOswPacketLossOpenApiVO"}},"topPacketsError":{"type":"array","description":"Packet error information list","items":{"$ref":"#/components/schemas/TopOswErrorPacketOpenApiVO"}}}},"TopCpuUsageHealthOpenApiVO":{"type":"object","properties":{"name":{"type":"string","description":"Device name"},"mac":{"type":"string","description":"Device mac"},"model":{"type":"string","description":"Device model"},"modelVersion":{"type":"string","description":"Device model version"},"healthScore":{"type":"integer","description":"Health score","format":"int32"},"type":{"type":"string","description":"Device type"},"deviceSeriesType":{"type":"integer","description":"Device series type should be a value as follows: 0:advanced, 1:pro","format":"int32"},"cpuUtil":{"type":"integer","description":"CPU utilization","format":"int32"}},"description":"Cpu information list"},"TopMemUsageHealthOpenApiVO":{"type":"object","properties":{"name":{"type":"string","description":"Device name"},"mac":{"type":"string","description":"Device mac"},"model":{"type":"string","description":"Device model"},"modelVersion":{"type":"string","description":"Device model version"},"healthScore":{"type":"integer","description":"Health score","format":"int32"},"type":{"type":"string","description":"Device type"},"deviceSeriesType":{"type":"integer","description":"Device series type should be a value as follows: 0:advanced, 1:pro","format":"int32"},"memUtil":{"type":"integer","description":"Memory utilization","format":"int32"}},"description":"Memory information list"},"TopOswErrorPacketOpenApiVO":{"type":"object","properties":{"name":{"type":"string","description":"Device name"},"mac":{"type":"string","description":"Device mac"},"model":{"type":"string","description":"Device model"},"modelVersion":{"type":"string","description":"Device model version"},"healthScore":{"type":"integer","description":"Health score","format":"int32"},"type":{"type":"string","description":"Device type"},"deviceSeriesType":{"type":"integer","description":"Device series type should be a value as follows: 0:advanced, 1:pro","format":"int32"},"portCnt":{"type":"integer","description":"Total number of ports","format":"int32"},"errPortCnt":{"type":"integer","description":"Number of Ports with error packets","format":"int32"},"errPkts":{"type":"integer","description":"Total number of error packets","format":"int64"}},"description":"Packet error information list"},"TopOswPacketLossOpenApiVO":{"type":"object","properties":{"name":{"type":"string","description":"Device name"},"mac":{"type":"string","description":"Device mac"},"model":{"type":"string","description":"Device model"},"modelVersion":{"type":"string","description":"Device model version"},"healthScore":{"type":"integer","description":"Health score","format":"int32"},"type":{"type":"string","description":"Device type"},"deviceSeriesType":{"type":"integer","description":"Device series type should be a value as follows: 0:advanced, 1:pro","format":"int32"},"portCnt":{"type":"integer","description":"Total number of ports","format":"int32"},"pktsLossPortCnt":{"type":"integer","description":"Number of Ports with Packet Loss","format":"int32"},"lossPkts":{"type":"integer","description":"Total number of lost packets","format":"int64"}},"description":"Packet loss information list"},"OpenApiSpeedTestSelectPortsVO":{"type":"object","properties":{"portUuidList":{"type":"array","description":"The uuid of selected wan ports for speed test.","items":{"type":"string","description":"The uuid of selected wan ports for speed test."}},"virtualWanIdList":{"type":"array","description":"The id of selected virtual wan ports for speed test.","items":{"type":"string","description":"The id of selected virtual wan ports for speed test."}}}},"OperationResponseStartSpeedTestV2ResultVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/StartSpeedTestV2ResultVO"}}},"StartSpeedTestV2ResultVO":{"type":"object","properties":{"deviceMac":{"type":"string","description":"The mac of the speed test device."}}},"OpenApiQuerySpeedTestDateListVO":{"required":["currentPage","currentPageSize"],"type":"object","properties":{"portUuid":{"type":"string","description":"Port Uuid. Only one of the parameters portUuid and virtualWanId can exist"},"virtualWanId":{"type":"string","description":"Virtual Wan Id. Only one of the parameters portUuid and virtualWanId can exist"},"currentPage":{"type":"integer","description":"Start from 1.","format":"int32"},"currentPageSize":{"type":"integer","description":"It should be within the range of 1–100.","format":"int32"}}},"GridVOSpeedTestV2ResultItemOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SpeedTestV2ResultItemOpenApiVO"}}}},"OperationResponseGridVOSpeedTestV2ResultItemOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOSpeedTestV2ResultItemOpenApiVO"}}},"SpeedTestV2ResultItemOpenApiVO":{"type":"object","properties":{"portId":{"type":"integer","description":"The id of physical wan port.","format":"int32"},"virtualWanEntryId":{"type":"integer","description":"The entry id of virtual wan.","format":"int32"},"time":{"type":"integer","description":"Time of speed test.","format":"int64"},"isp":{"type":"string","description":"Name of isp."},"status":{"type":"integer","description":"The status of this wan port speed test result.","format":"int32"},"serverName":{"type":"string","description":"Name of speed test server."},"serverLocation":{"type":"string","description":"Location of speed test server."},"latency":{"type":"integer","description":"The latency of this wan port speed test result.","format":"int32"},"down":{"type":"integer","description":"The download speed of this wan port speed test result.","format":"int64"},"up":{"type":"integer","description":"The upload speed of this wan port speed test result.","format":"int64"}}},"OperationResponseOperationResponseWithoutResult":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OperationResponseWithoutResult"}}},"ChangeInternetStateOpenApiVO":{"type":"object","properties":{"portId":{"type":"integer","description":"port ID","format":"int32"},"operation":{"type":"integer","description":"operation, 1 for open, and 0 for close","format":"int32"},"virtualWanId":{"type":"string","description":"If operating virtualWan, should give virtualWanId"}}},"ChangeOduModeVO":{"type":"object","properties":{"ippt":{"type":"boolean","description":"Current device mode: Ip Pass-through or not."}}},"QueryBatchFullChannelDetectStatusVO":{"type":"object","properties":{"idList":{"type":"array","items":{"type":"string"}}}},"BatchFullChannelDetectStatusOpenApiVO":{"type":"object","properties":{"historyId":{"type":"string","description":"Id of batch full channel detect history."},"status":{"type":"integer","description":"Status of full channel detect, status should be a value as follows: 0: finish; 1: scanning.","format":"int32"}}},"OperationResponseListBatchFullChannelDetectStatusOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/BatchFullChannelDetectStatusOpenApiVO"}}}},"StartBatchFullChannelDetectCmdOpenApiVO":{"required":["selectType"],"type":"object","properties":{"macList":{"type":"array","description":"Select the Aps to full channel detect;.","items":{"type":"string","description":"Select the Aps to full channel detect;."}},"enableInterference":{"type":"boolean","description":"Whether to enable non-interference detect."},"enableWifiInterference":{"type":"boolean","description":"Whether to enable wifi interference detect."},"enableChannelUtil":{"type":"boolean","description":"Whether to enable channel load detect."},"selectType":{"type":"string","description":"Select type of macs. include: include selected aps, exclude: all but exclude selected aps, all: include all aps(Parameter [macList] need input '[]')."}}},"HotspotPortalsOpenApiVO":{"required":["portals"],"type":"object","properties":{"applyToAllPortals":{"type":"boolean","description":"Is the localuser effective for all portals, including all newly created portals"},"portals":{"type":"array","description":"Bound portal ID list.","items":{"type":"string","description":"Bound portal ID list."}}},"description":"Bound portal ID list,need to specify Content-Type of this form part as application/json."},"DeviceVO":{"type":"object","properties":{"mac":{"type":"string","description":"The mac of the general device."},"stackId":{"type":"string","description":"The stack of the stack device."},"ports":{"type":"array","description":"The ports selected.","items":{"$ref":"#/components/schemas/PortVO"}},"impbs":{"type":"array","description":"The impbs selected.","items":{"$ref":"#/components/schemas/ImpbVO"}}},"description":"The devices selected to create entries."},"DhcpSnoopVO":{"type":"object","properties":{"id":{"type":"string","description":"The primary id of the dhcp snoop."},"omadacId":{"type":"string","description":"The id of the omada the dhcp snoop belongs to."},"siteId":{"type":"string","description":"The id of the site the dhcp snoop belongs to."},"name":{"type":"string","description":"The name of the dhcp snoop."},"mac":{"type":"string","description":"The mac of the general device."},"deviceName":{"type":"string","description":"The name of the device."},"deviceType":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"deviceModel":{"type":"string","description":"Model of device,for example:EAP225"},"deviceModelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"showModel":{"type":"string","description":"The client showModel"},"stackId":{"type":"string","description":"The stack of the stack device."},"stackName":{"type":"string","description":"The name of the stacking devices."},"oswStack":{"$ref":"#/components/schemas/OswStackInfoVO"},"ports":{"type":"array","description":"The ports selected.","items":{"$ref":"#/components/schemas/PortVO"}},"status":{"type":"integer","description":"The connected status of the device.","format":"int32"},"unSelectedablePorts":{"type":"array","description":"The unSelectedable ports of the device.","items":{"$ref":"#/components/schemas/PortVO"}},"allPorts":{"type":"array","description":"All Port list in one device.","items":{"$ref":"#/components/schemas/OswPortVO"}},"allLags":{"type":"array","description":"All lag list in one device.","items":{"$ref":"#/components/schemas/OswLagVO"}},"devices":{"type":"array","description":"The devices selected to create entries.","items":{"$ref":"#/components/schemas/DeviceVO"}}}},"ImpbVO":{"type":"object","properties":{"id":{"type":"string","description":"id"},"port":{"$ref":"#/components/schemas/PortVO"},"ip":{"type":"string","description":"ip"},"mac":{"type":"string","description":"mac"},"clientName":{"type":"string","description":"clientName"},"vlan":{"type":"integer","description":"vlan","format":"int32"}},"description":"The impbs selected."},"DhcpSnoopImbpVO":{"type":"object","properties":{"mac":{"type":"string","description":"The mac of the general device."},"stackId":{"type":"string","description":"The stack of the stack device."},"ports":{"type":"array","description":"The ports selected.","items":{"$ref":"#/components/schemas/PortVO"}}}},"QueryDhcpLeaseTimeParamVO":{"required":["ipAddress","mac"],"type":"object","properties":{"mac":{"type":"string","description":"the mac you want to get dhcp-lease-time."},"ipAddress":{"type":"string","description":"the ipAddress you want to get dhcp-lease-time."}}},"QueryDhcpLeaseTimeVO":{"required":["queryDhcpLeaseTimeParamVOS"],"type":"object","properties":{"queryDhcpLeaseTimeParamVOS":{"type":"array","items":{"$ref":"#/components/schemas/QueryDhcpLeaseTimeParamVO"}}}},"ClientDhcpLeaseTimeOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"device mac"},"leaseTime":{"type":"integer","description":"lease time of the client","format":"int32"}}},"OperationResponseListClientDhcpLeaseTimeOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ClientDhcpLeaseTimeOpenApiVO"}}}},"AdoptDeviceRequest":{"type":"object","properties":{"username":{"type":"string","description":"Adopt device username. It should contain 1 to 64 characters."},"password":{"type":"string","description":"Adopt device password. It should contain 1 to 64 characters."}}},"DeviceMoveSiteOpenApiVO":{"required":["targetSite"],"type":"object","properties":{"targetSite":{"type":"string","description":"Target site ID"}}},"CheckReplaceVO":{"required":["deviceKey"],"type":"object","properties":{"deviceKey":{"type":"string","description":"Device Key."}}},"OperationResponseReplaceConfigRespVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ReplaceConfigRespVO"}}},"ReplaceConfigRespVO":{"type":"object","properties":{"oldModel":{"type":"string","description":"Old model."},"newModel":{"type":"string","description":"New model."},"needPrompt":{"type":"boolean","description":"Whether to show a prompt."},"featureList":{"type":"array","description":"List of incompatible features.","items":{"type":"string","description":"List of incompatible features."}}}},"LocateDeviceRequest":{"type":"object","properties":{"locateEnable":{"type":"boolean"},"portList":{"type":"array","description":"Ports to be located","items":{"type":"integer","description":"Ports to be located","format":"int32"}}}},"RetryAddDeviceOpenApiVO":{"type":"object","properties":{"username":{"type":"string","description":"retry add device username"},"password":{"type":"string","description":"retry add device password"}}},"OperationResponseRetryAddDeviceRespOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/RetryAddDeviceRespOpenApiVO"}}},"RetryAddDeviceRespOpenApiVO":{"type":"object","properties":{"preConfigRetryType":{"type":"integer","description":"1: need username and pwd; 2: don't need need username and pwd","format":"int32"}}},"QueryDeviceUplinkOpenApiVO":{"type":"object","properties":{"deviceMacs":{"type":"array","description":"The list of deviceMac that require querying uplink device information.","items":{"type":"string","description":"The list of deviceMac that require querying uplink device information."}}}},"DeviceUplinkOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"Current Device MAC"},"uplinkDeviceMac":{"type":"string","description":"Uplink device mac"},"uplinkDeviceName":{"type":"string","description":"Uplink device name"},"uplinkDevicePort":{"type":"string","description":"Uplink device port"},"linkSpeed":{"type":"integer","description":"Device uplink port linkSpeed, linkSpeed should be a value as follows: 0: Auto; 1: 10M; 2: 100M; 3: 1000M; 4: 2500M; 5: 10G; 6: 5G; 7: 25G, 8: 100G.","format":"int32"},"duplex":{"type":"integer","description":"Device uplink port duplex mode, duplex should be a value as follows: 0: Auto; 1: Half; 2: Full.","format":"int32"}}},"OperationResponseListDeviceUplinkOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/DeviceUplinkOpenApiVO"}}}},"File":{"type":"object","properties":{"fileId":{"type":"string","description":"File ID"}}},"OperationResponseFile":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/File"}}},"TagOpenApiVO":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"Tag name should contain 1 to 128 ASCII characters."}}},"TagRespOpenApiVO":{"type":"object","properties":{"name":{"type":"string","description":"Tag name"},"tagId":{"type":"string","description":"Tag ID"}}},"UnbindActiveDeviceSnOpenApiVO":{"required":["newSn","oldSn"],"type":"object","properties":{"oldSn":{"pattern":"^[A-Z0-9]{13}$","type":"string","description":"Old serial number. It should contains 13 characters"},"newSn":{"pattern":"^[A-Z0-9]{13}$","type":"string","description":"New serial number. It should contains 13 characters"}}},"AddDeviceVO":{"type":"object","properties":{"sn":{"type":"string","description":"Device serial number. It should contains 13 characters."},"name":{"type":"string","description":"Device name should contain 1 to 128 characters."},"username":{"type":"string","description":"Device username. It should contain 1 to 64 characters."},"password":{"type":"string","description":"Device password. It should contain 1 to 64 characters."},"deviceKey":{"type":"string"}},"description":"Add devices list"},"DeviceListAddOpenApiVO":{"required":["devices"],"type":"object","properties":{"devices":{"type":"array","description":"Add devices list","items":{"$ref":"#/components/schemas/AddDeviceVO"}}}},"LocateOswPortsOpenApiVO":{"required":["locateEnable"],"type":"object","properties":{"portListVOs":{"type":"array","description":"List of Switch MAC and ports.","items":{"$ref":"#/components/schemas/OswNormalPortListVO"}},"stackPortListVOs":{"type":"array","description":"List of Stack ID and Standard Ports.","items":{"$ref":"#/components/schemas/OswStackPortListVO"}},"locateEnable":{"type":"boolean","description":"Whether locate function is enabled"}}},"OswNormalPortListVO":{"type":"object","properties":{"mac":{"type":"string","description":"Switch MAC Address"},"portList":{"type":"array","description":"Switch port list.","items":{"type":"integer","description":"Switch port list.","format":"int32"}}},"description":"List of Switch MAC and ports."},"OswStackPortListVO":{"type":"object","properties":{"stackId":{"type":"string","description":"Stack Id"},"standardPorts":{"type":"array","description":"Standard port should be in the format of unit/slot/portId. e.g. 1/0/1","items":{"type":"string","description":"Standard port should be in the format of unit/slot/portId. e.g. 1/0/1"}}},"description":"List of Stack ID and Standard Ports."},"LocateOswPortsResultOpenApiVO":{"type":"object","properties":{"locateOswPortsResultList":{"type":"array","description":"Locate switch ports error information","items":{"$ref":"#/components/schemas/LocateOswResultOpenApiVO"}},"locateStackPortsResultList":{"type":"array","description":"Locate stack ports error information","items":{"$ref":"#/components/schemas/LocateStackResultOpenApiVO"}}}},"LocateOswResultOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"Switch MAC Address"},"errorCode":{"type":"integer","description":"Error code","format":"int32"},"errorMsg":{"type":"string","description":"Error message"}},"description":"Locate switch ports error information"},"LocateStackResultOpenApiVO":{"type":"object","properties":{"stackId":{"type":"string","description":"Stack Id"},"errorCode":{"type":"integer","description":"Error code","format":"int32"},"errorMsg":{"type":"string","description":"Error message"}},"description":"Locate stack ports error information"},"OperationResponseLocateOswPortsResultOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/LocateOswPortsResultOpenApiVO"}}},"DeviceIncidentCountRequestOpenApiVO":{"type":"object","properties":{"deviceList":{"type":"array","description":"Device MAC addresses for which incident counts are requested.","items":{"type":"string","description":"Device MAC addresses for which incident counts are requested."}}}},"DeviceIncidentCountResultOpenApiVO":{"type":"object","properties":{"incidents":{"type":"array","description":"Incident counts for the requested devices.","items":{"$ref":"#/components/schemas/Incident"}}}},"Incident":{"type":"object","properties":{"mac":{"type":"string","description":"Device MAC address."},"incidentCounts":{"type":"integer","description":"Incident counts.","format":"int32"}},"description":"Incident counts for the requested devices."},"OperationResponseDeviceIncidentCountResultOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceIncidentCountResultOpenApiVO"}}},"ExportGlobalDeviceListOpenApiVO":{"required":["format","mode"],"type":"object","properties":{"mode":{"type":"integer","description":"Value of mode should be 0 or 1 or 2. 0 : All columns, 1 : Customize the export columns, 2 : Default columns.","format":"int32"},"displayColumns":{"type":"array","description":"In mode 1, the displayColumns cannot be empty. Allowed column name for input : ['deviceName', 'serialNumber', 'macAddress', 'ipAddress', 'publicIpAddress',  'ipv6Address', 'status', 'model', 'version', 'uplink', 'downlink', 'uptime', 'memoryUsage', 'cpuUsage',  'clients', 'downloadTraffic', 'uploadTraffic', 'loopback', 'hop', 'wlanGroup', 'override',  'radio2G', 'radio5G', 'radio6G', '2gClients', '5gClients', '6gClients', 'bSsid', 'txRate', 'rxRate', 'channel', 'channelUtilization2G', 'channelUtilization5G', 'channelUtilization6G', 'tags', 'lastSeen',  'configurationResult', 'licenseStatus'(pro controller exclusive), 'dueTime'(pro controller exclusive), 'series'(pro controller exclusive), 'health'(pro controller exclusive), 'stackGroup'(site view exclusive),  'uplinkDeviceName'(site view exclusive), 'uplinkDevicePort'(site view exclusive),  'linkSpeed'(site view exclusive), 'duplex'(site view exclusive)]","items":{"type":"string","description":"In mode 1, the displayColumns cannot be empty. Allowed column name for input : ['deviceName', 'serialNumber', 'macAddress', 'ipAddress', 'publicIpAddress',  'ipv6Address', 'status', 'model', 'version', 'uplink', 'downlink', 'uptime', 'memoryUsage', 'cpuUsage',  'clients', 'downloadTraffic', 'uploadTraffic', 'loopback', 'hop', 'wlanGroup', 'override',  'radio2G', 'radio5G', 'radio6G', '2gClients', '5gClients', '6gClients', 'bSsid', 'txRate', 'rxRate', 'channel', 'channelUtilization2G', 'channelUtilization5G', 'channelUtilization6G', 'tags', 'lastSeen',  'configurationResult', 'licenseStatus'(pro controller exclusive), 'dueTime'(pro controller exclusive), 'series'(pro controller exclusive), 'health'(pro controller exclusive), 'stackGroup'(site view exclusive),  'uplinkDeviceName'(site view exclusive), 'uplinkDevicePort'(site view exclusive),  'linkSpeed'(site view exclusive), 'duplex'(site view exclusive)]"}},"format":{"type":"integer","description":"Format should be a value as follows. 0 means CSV , 1 means XLSX.","format":"int32"},"queryData":{"$ref":"#/components/schemas/OpenApiQueryDataVO"}}},"OpenApiQueryDataVO":{"required":["page","pageSize"],"type":"object","properties":{"page":{"type":"integer","description":"Start from 1.","format":"int32"},"pageSize":{"type":"integer","description":"It should be within the range of 1–1000.","format":"int32"},"sorts":{"type":"object","additionalProperties":{"type":"string"}},"searchKey":{"type":"string","description":"Look for a specific piece of data."},"filters":{"type":"object","additionalProperties":{"type":"object"}},"searchField":{"type":"string"}}},"DeviceCopyConfigurationOpenApiVO":{"required":["sourceMac","targetMac"],"type":"object","properties":{"sourceMac":{"type":"string","description":"Source device MAC, like AA-BB-CC-DD-EE-FF"},"targetMac":{"type":"string","description":"Target device MAC, like AA-BB-CC-DD-EE-FF"}}},"CreateTabOpenApiVO":{"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,30}[^ ]$","type":"string","description":"Names on this Dashboard page must be unique. It should contain 1 to 64 characters."}}},"ClientTrafficOpenApiQueryDataVO":{"required":["page","pageSize"],"type":"object","properties":{"page":{"type":"integer","description":"Start from 1.","format":"int32"},"pageSize":{"type":"integer","description":"It should be within the range of 1–100.","format":"int32"},"sorts":{"type":"object","additionalProperties":{"type":"string"}},"searchKey":{"type":"string","description":"Look for a specific piece of data."},"filters":{"type":"object","additionalProperties":{"type":"object"}},"searchField":{"type":"string"},"start":{"type":"integer","description":"Start timestamp, in seconds, such as 1682000000","format":"int64"},"end":{"type":"integer","description":"End timestamp, in seconds, such as 1682000000","format":"int64"},"clientTrafficFilters":{"type":"array","description":"Client traffic filtering condition","items":{"$ref":"#/components/schemas/ClientTrafficFilterOpenApiVO"}}}},"ApplicationTrafficWithClientCount":{"type":"object","properties":{"applicationName":{"type":"string","description":"The name of the application."},"applicationId":{"type":"integer","description":"The id of the application.","format":"int32"},"applicationDescription":{"type":"string","description":"The description of the application."},"familyId":{"type":"integer","description":"The id of the category.","format":"int32"},"familyName":{"type":"string","description":"The name of the category."},"traffic":{"type":"integer","description":"The total amount of traffic used by the app.","format":"int64"},"trafficPercent":{"type":"number","description":"The percentage of traffic used by the app.","format":"double"},"clientsCount":{"type":"integer","description":"The number of clients using the app.","format":"int32"}},"description":"The applications info using by the client."},"ClientTrafficGridVOClientTrafficWithApplicationDetail":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClientTrafficWithApplicationDetail"}},"clientTrafficFilters":{"type":"array","items":{"$ref":"#/components/schemas/ClientTrafficFilterOpenApiVO"}}}},"ClientTrafficWithApplicationDetail":{"type":"object","properties":{"type":{"type":"string","description":"The type of the client."},"manager":{"type":"boolean","description":"Whether the client is managed by the controller.."},"clientName":{"type":"string","description":"The name of the client."},"mac":{"type":"string","description":"The mac of the client."},"traffic":{"type":"integer","description":"The total amount of traffic used by the client.","format":"int64"},"trafficPercent":{"type":"number","description":"The percentage of traffic used by the client.","format":"double"},"upload":{"type":"integer","description":"The upload traffic used by the client.","format":"int64"},"uploadTrafficPercent":{"type":"number","description":"The percentage of upload traffic used by the client.","format":"double"},"download":{"type":"integer","description":"The download traffic used by the client.","format":"int64"},"downloadTrafficPercent":{"type":"number","description":"The percentage of download traffic used by the client.","format":"double"},"totalApplications":{"type":"integer","description":"The number of applications using by the client.","format":"int32"},"applicationList":{"type":"array","description":"The applications info using by the client.","items":{"$ref":"#/components/schemas/ApplicationTrafficWithClientCount"}},"network":{"type":"string","description":"Lan network name."},"vlanId":{"type":"string","description":"VLAN ID. The VLAN ID range is 1–4096 or Untag."}}},"OperationResponseClientTrafficGridVOClientTrafficWithApplicationDetail":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ClientTrafficGridVOClientTrafficWithApplicationDetail"}}},"OsgVpnTunnelOpenApiVO":{"type":"object","properties":{"vpnId":{"type":"integer","description":"VPN Item Id.","format":"int32"},"vpnName":{"type":"string","description":"VPN Item Name."},"userId":{"type":"integer","description":"User Id.","format":"int32"},"userName":{"type":"string","description":"Peer Username."},"interfaceName":{"type":"string","description":"Interface Name."},"serverType":{"type":"integer","description":"Client-To-Site VPN Type First-level cascade selection 0:VPN Server 1:VPN Client.","format":"int32"},"vpnType":{"type":"integer","description":"Client-To-Site VPN Type Second-level cascade selection 0：L2TP 1: PPTP 2: IPSec 3: OpenVPN.","format":"int32"},"clientMode":{"type":"string","description":"Client Mode: Client or NEM(Network Extension Mode)."},"localIp":{"type":"string","description":"The local Server IP of the tunnel."},"remoteIp":{"type":"string","description":"The IP address of the peer VPN User."},"downPkts":{"type":"integer","description":"Number of packets in the downlink.","format":"int64"},"downBytes":{"type":"integer","description":"Downlink traffic in bytes.","format":"int64"},"upPkts":{"type":"integer","description":"The amount of uplink packets.","format":"int64"},"upBytes":{"type":"integer","description":"Uplink traffic in bytes.","format":"int64"},"uptime":{"type":"string","description":"VPN tunnel effective time, it starts from the connection calculation, accurate to the minute."},"dns":{"type":"string","description":"DNS for the peer VPN."}}},"OswStackRebootOpenApiVO":{"type":"object","properties":{"selectAll":{"type":"boolean","description":"Indicates whether to select the entire stack"},"macs":{"type":"array","description":"Selected Devices","items":{"type":"string","description":"Selected Devices"}}}},"OperationResponseListRebootResultVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/RebootResultVO"}}}},"RebootResultVO":{"type":"object","properties":{"mac":{"type":"string","description":"Mac"},"status":{"type":"integer","description":"Status","format":"int32"},"statusCategory":{"type":"integer","description":"Status Category","format":"int32"}}},"OswStackLocateOpenApiVO":{"required":["locateEnable"],"type":"object","properties":{"selectAll":{"type":"boolean","description":"Indicates whether to select the entire stack"},"macs":{"maxItems":1,"minItems":0,"type":"array","description":"Selected Device","items":{"maxLength":1,"minLength":0,"type":"string","description":"Selected Device"}},"locateEnable":{"type":"boolean","description":"Indicates whether locate is enabled"},"standardPorts":{"type":"array","description":"Standard port should be in the format of unit/slot/portId. e.g. 1/0/1 . When parameter[standardPorts] is not empty, paramter[selectAll] and [macs] are not needed","items":{"type":"string","description":"Standard port should be in the format of unit/slot/portId. e.g. 1/0/1 . When parameter[standardPorts] is not empty, paramter[selectAll] and [macs] are not needed"}}}},"LocateResultVO":{"type":"object","properties":{"mac":{"type":"string","description":"Mac"},"locateEnable":{"type":"boolean","description":"Indicates whether the locate function is enabled"},"restTime":{"type":"integer","description":"The remaining time that the device locate switch is valid","format":"int64"}}},"OperationResponseLocateResultVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/LocateResultVO"}}},"InternetOpenApiVO":{"required":["siteId"],"type":"object","properties":{"omadacId":{"type":"string","description":"Omadac ID."},"siteId":{"type":"string","description":"Site ID."},"enable":{"type":"boolean","description":"Is Internet enable."},"osgPortInfo":{"$ref":"#/components/schemas/OsgPortInfoOpenApiVO"},"portUuids":{"type":"array","description":"The list of wan port UUID.","items":{"type":"string","description":"The list of wan port UUID."}},"interval":{"type":"integer","description":"Time taken to check the connection of wan port.","format":"int32"},"unit":{"type":"integer","description":"Unit.","format":"int32"},"supportCustomInterval":{"type":"boolean","description":"Whether the device supports Custom Interval."},"supportDiscreteWan":{"type":"boolean","description":"Whether the device supports Discrete Wan."},"supportReduceUsbRfi":{"type":"boolean","description":"Whether the device supports Reduce USB 3.0 Interference Reduction."},"supportAllWan":{"type":"boolean","description":"Whether the device supports all wan."},"supportMaxWanNum":{"type":"integer","description":"The maximum number of wans supported.","format":"int32"},"supportIpv6NonAddress":{"type":"boolean","description":"Whether the IPv6 configuration supports Non-Address."},"supportMssClamping":{"type":"boolean","description":"Whether MSS clamping is supported for PPPoE, L2TP, and PPTP."},"supportPppoeMru":{"type":"boolean","description":"Whether to configure PPPoE MRUs."},"supportWanMultipleIp":{"type":"boolean","description":"Whether to configure multiple IP addresses for wan ports."},"supportLte":{"type":"boolean","description":"Whether to configure LTE Wan."},"supportDualSim":{"type":"integer","description":"Whether it supports dual SIM single standby: 0: not support, 1: support.","format":"int32"},"supportDsl":{"type":"boolean","description":"Whether it supports DSL."},"supportVirtualWan":{"type":"boolean","description":"Whether it supports virtual wan."},"supportNetworkIsolation":{"type":"boolean","description":"Whether it supports isolate network."},"supportDhcpOptions":{"type":"boolean","description":"Whether WAN port dhcpOptions can be customized."},"supportUsbDhcpOptions":{"type":"boolean","description":"Whether USB port dhcpOptions can be customized."},"supportDsLite":{"type":"boolean","description":"Whether the WAN port supports configuring DS-Lite."},"supportMapE":{"type":"boolean","description":"Whether the WAN port supports configuring MAP-E."},"supportTimingMode":{"type":"boolean","description":"Whether the Load Balance Failover supports Timing mode."},"wanPortSettings":{"type":"array","description":"A list of wan port setting.","items":{"$ref":"#/components/schemas/WanPortSettingOpenApiVO"}},"usbLteSettings":{"type":"array","description":"A list of USB LTE setting.","items":{"$ref":"#/components/schemas/UsbLteSettingOpenApiVO"}},"lteWanSettings":{"type":"array","description":"A list of LTE wan setting.","items":{"$ref":"#/components/schemas/LteWanPortSettingOpenApiVO"}},"wanLoadBalance":{"$ref":"#/components/schemas/WanLoadBalanceOpenApiVO"},"networkNames":{"type":"array","description":"A list of the name of the LanNetwork entry that was invalidated on the frontend.","items":{"type":"string","description":"A list of the name of the LanNetwork entry that was invalidated on the frontend."}},"unmatchedWans":{"type":"array","description":"A list of the name of the WAN port that was invalidated on the frontend.","items":{"type":"string","description":"A list of the name of the WAN port that was invalidated on the frontend."}},"gatewayMac":{"type":"string","description":"Gateway MAC."},"enableModified":{"type":"boolean","description":"Whether it enable modified."},"lteIntervalTips":{"type":"boolean","description":"Whether to display the interval prompt for LTE ports."},"portOnlineStatus":{"$ref":"#/components/schemas/PortOnlineStatusOpenApiVO"},"resource":{"type":"integer","description":"Resource of data.","format":"int32"}}},"LteWanPortSettingOpenApiVO":{"required":["dataRoaming","dialupSetting","mobileData","networkMode","portUuId"],"type":"object","properties":{"portUuId":{"type":"string","description":"Port UUID"},"portDescription":{"type":"string","description":"Port description"},"portName":{"type":"string","description":"Port name"},"simCardUsed":{"type":"integer","description":"The SIM card being used","format":"int32"},"status":{"type":"integer","description":"0: unknown, 1: disconnected, 2:disconnecting, 3:connected, 4:connecting","format":"int32"},"cardStatus":{"type":"integer","description":"cardStatus: 0:no_sim, 1:unknown, 2:pin_lock, 3:pin_verified, 4:ready, 5:puk_lock, 6:blocked","format":"int32"},"simPriority":{"type":"integer","description":"Which SIM card is used first.","format":"int32"},"mobileData":{"type":"boolean","description":"mobile data"},"dataRoaming":{"type":"boolean","description":"First SIM card's data roaming"},"networkMode":{"type":"integer","description":"First SIM card's networkMode: 1:3G Only, 2:4G Only, 3:4G Preferred, 4: 5G-NSA/4G, 5: 5G-SA, 6: 5G/4G/3G","format":"int32"},"bandMode":{"type":"integer","description":"First SIM card's bandMode: 0:auto, 1:manual, only for networkMode 4g Only and 4G Preferred","format":"int32"},"bands":{"type":"array","description":"First SIM card's. Only for band mode manual","items":{"type":"string","description":"First SIM card's. Only for band mode manual"}},"bands5g":{"type":"array","description":"First SIM card's. Only for band mode manual","items":{"type":"string","description":"First SIM card's. Only for band mode manual"}},"dialupSetting":{"$ref":"#/components/schemas/DialupSettingOpenApiVO"},"failoverTimeout":{"type":"integer","description":"First SIM card's failoverTimeout. Set the dial-up timeout (100 to 3552 seconds). If the connection is not successfully established within the specified time, the gateway will use the other SIM card to connect to the internet.","format":"int32"},"dataRoaming2":{"type":"boolean","description":"Second SIM card's data roaming"},"networkMode2":{"type":"integer","description":"Second SIM card's networkMode: 1:3G Only, 2:4G Only, 3:4G Preferred4: 5G-NSA/4G, 5: 5G-SA, 6: 5G/4G/3G","format":"int32"},"bandMode2":{"type":"integer","description":"Second SIM card's bandMode: 0:auto, 1:manual, only for networkMode 4g Only and 4G Preferred","format":"int32"},"bands2":{"type":"array","description":"Second SIM card's bands. Only for band mode manual","items":{"type":"string","description":"Second SIM card's bands. Only for band mode manual"}},"bands5g2":{"type":"array","description":"Second SIM card's. Only for band mode manual","items":{"type":"string","description":"Second SIM card's. Only for band mode manual"}},"dialupSetting2":{"$ref":"#/components/schemas/DialupSettingOpenApiVO"},"failoverTimeout2":{"type":"integer","description":"Second SIM card's failoverTimeout. Set the dial-up timeout (100 to 3552 seconds). If the connection is not successfully established within the specified time, the gateway will use the other SIM card to connect to the internet.","format":"int32"},"supportNetworkMode":{"type":"array","description":"The network mode that the device can select.","items":{"type":"integer","description":"The network mode that the device can select.","format":"int32"}}},"description":"A list of LTE wan setting."},"OsgPortInfoOpenApiVO":{"type":"object","properties":{"realOsgModel":{"type":"string","description":"real gateway model"},"preOsgModel":{"type":"integer","description":"preconfigured gateway model","format":"int32"},"preOsgModelName":{"type":"string","description":"preconfigured gateway model name"},"targetModels":{"type":"array","description":"target gateway models when gateway change","items":{"type":"integer","description":"target gateway models when gateway change","format":"int32"}},"wanPortNum":{"type":"integer","description":"custom wan port num","format":"int32"},"wanLanPortSettings":{"type":"array","items":{"$ref":"#/components/schemas/WanLanPortSettingOpenApiVO"}}},"description":"Gateway port info."},"PortOnlineStatusOpenApiVO":{"type":"object","properties":{"virtualWanOnlineStatus":{"type":"array","description":"Virtual WAN online status list","items":{"$ref":"#/components/schemas/VirtualWanOnlineStatusOpenApiVO"}},"wanOnlineStatus":{"type":"array","description":"WAN online status list","items":{"$ref":"#/components/schemas/WanOnlineStatusOpenApiVO"}}},"description":"Port online status."},"UsbLteSettingOpenApiVO":{"required":["authType","configType","connectionMode","dnsEnable","mtuSize","portId"],"type":"object","properties":{"portId":{"type":"string","description":"Port ID"},"portDescription":{"type":"string","description":"Port description"},"portName":{"type":"string","description":"Port Name"},"usbModem":{"type":"string","description":"USB modem name"},"reduceUsbRif":{"type":"boolean","description":"whether to use usb2.0, false means close, default is open"},"configType":{"type":"integer","description":"0: Auto; 1：Manually.","format":"int32"},"autoConfig":{"$ref":"#/components/schemas/AutoConfigOpenApiVO"},"manuallyConfig":{"$ref":"#/components/schemas/ManuallyConfigOpenApiVO"},"connectionMode":{"type":"integer","description":"1: Connect Automatically, 2: Connect Manually","format":"int32"},"usbModemMsgId":{"type":"integer","format":"int32"},"pin":{"type":"string","description":"It is required when [usbModemMsgId] is 1 or 3"},"authType":{"type":"integer","description":"0:Auto, 1:PAP, 2:CHAP","format":"int32"},"mtuSize":{"type":"integer","description":"MTU range from 576 ~ 1500","format":"int32"},"dnsEnable":{"type":"boolean"},"dhcpOptions":{"type":"array","items":{"$ref":"#/components/schemas/WanDhcpOptionOpenApiVO"}},"dnsConfig":{"$ref":"#/components/schemas/DnsConfigOpenApiVO"}},"description":"A list of USB LTE setting."},"VirtualWanOnlineStatusOpenApiVO":{"type":"object","properties":{"virtualWanId":{"type":"string","description":"This field represents VirtualWan ID. VirtualWan ID can be obtained from 'Query available virtual WAN list' interface"},"onlineDetection":{"type":"integer","description":"Port Online Detection","format":"int32"}},"description":"Virtual WAN online status list"},"WanLanPortSettingOpenApiVO":{"type":"object","properties":{"portUuid":{"type":"string","description":"port uuid"},"portName":{"type":"string","description":"port name"},"type":{"type":"integer","description":"0: WAN, 1: WAN/LAN, 2: LAN","format":"int32"},"mode":{"type":"integer","description":"0: WAN, 1: LAN","format":"int32"},"lanNetworkNames":{"type":"array","description":"names of lan networks","items":{"type":"string","description":"names of lan networks"}},"supportVpn":{"type":"boolean","description":"support vpn or not, true: support"},"supportIptv":{"type":"boolean","description":"support iptv or not, true: support"},"closable":{"type":"boolean","description":"can this port be closed or not, true: support"},"supportInternetVlan":{"type":"boolean","description":"does this port support vlan or not, true: support"},"wanIpv6Component":{"type":"integer","description":"component version of gateway wan ipv6","format":"int32"},"supportQosTagEnable":{"type":"boolean","description":"does this port support qos tage enable"},"status":{"type":"integer","description":"whether to open this port","format":"int32"}}},"WanOnlineStatusOpenApiVO":{"type":"object","properties":{"portUuid":{"type":"string","description":"The port UUID of WAN"},"onlineDetection":{"type":"integer","description":"Port Online Detection","format":"int32"}},"description":"WAN online status list"},"Optimization Strategy":{"required":["optimizationStrategy"],"type":"object","properties":{"optimizationStrategy":{"type":"integer","description":"Strategy of WLAN Optimization. 0: Global Optimization. 1: Optimization Adjustment, when WLAN Optimization is performed for the first time, that is, when API [get RF Planning Deploy History] returns ‘true’, this option is equivalent to Global Optimization.","format":"int32"}}},"MoveToSiteVO":{"required":["site"],"type":"object","properties":{"deviceMacs":{"type":"array","description":"Device macs.If only stacking is migrated, then it is empty.","items":{"type":"string","description":"Device macs.If only stacking is migrated, then it is empty."}},"stackIds":{"type":"array","description":"The stack to be migrated; all stack members are migrated together during the migration.","items":{"type":"string","description":"The stack to be migrated; all stack members are migrated together during the migration."}},"site":{"type":"string","description":"Target site key"}}},"MoveSiteInfoVO":{"type":"object","properties":{"mac":{"type":"string","description":"Mac address"},"name":{"type":"string","description":"Name"},"moveSiteStatus":{"type":"integer","description":"Move site status.MoveSiteStatus should be a value as follows:0: Device is in MoveSite;1: MoveSite Success;2: MoveSite Failed","format":"int32"},"errorCode":{"type":"integer","description":"Error code","format":"int32"}},"description":"MoveSite results for each device."},"MoveSiteProcessVO":{"type":"object","properties":{"moveSiteId":{"type":"string","description":"ID of moved site"},"finished":{"type":"boolean","description":"Process status of site moving"},"moveSiteResult":{"type":"array","description":"MoveSite results for each device.","items":{"$ref":"#/components/schemas/MoveSiteInfoVO"}}}},"OperationResponseMoveSiteProcessVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/MoveSiteProcessVO"}}},"MlagRebootOpenApiVO":{"required":["selectAll"],"type":"object","properties":{"selectAll":{"type":"boolean","description":"Indicates whether to select the entire M-LAG group"},"macs":{"type":"array","description":"Selected Devices Mac List. When selectAll is false, it cannot be empty.","items":{"type":"string","description":"Selected Devices Mac List. When selectAll is false, it cannot be empty."}}}},"MlagLocateOpenApiVO":{"required":["locateEnable","selectAll"],"type":"object","properties":{"selectAll":{"type":"boolean","description":"Indicates whether to select the entire M-LAG group"},"macs":{"type":"array","description":"Selected Devices Mac List. When selectAll is false, it cannot be empty.","items":{"type":"string","description":"Selected Devices Mac List. When selectAll is false, it cannot be empty."}},"locateEnable":{"type":"boolean","description":"Indicates whether locate is enabled"}}},"GatewayIspUpgrade":{"type":"object","properties":{"fileId":{"type":"string","description":"File Id"}}},"ModifyIpv6State":{"required":["operation","portId"],"type":"object","properties":{"portId":{"type":"integer","description":"Port ID","format":"int32"},"operation":{"type":"integer","description":"Operation","format":"int32"}}},"MoveToSite":{"required":["site"],"type":"object","properties":{"deviceMacs":{"type":"array","description":"Device mac list","items":{"type":"string","description":"Device mac list"}},"stackIds":{"type":"array","description":"Stack id list","items":{"type":"string","description":"Stack id list"}},"site":{"type":"string","description":"Target site key"}}},"BatchAdoptDeviceRequest":{"type":"object","properties":{"username":{"type":"string","description":"Adopt device username. It should contain 1 to 64 characters."},"password":{"type":"string","description":"Adopt device password. It should contain 1 to 64 characters."},"macs":{"type":"array","description":"MAC list of devices. E.g. AA-BB-CC-DD-11-22","items":{"type":"string","description":"MAC list of devices. E.g. AA-BB-CC-DD-11-22"}}}},"AutoAdoptDeviceOpenApiVO":{"type":"object","properties":{"devices":{"type":"array","description":"Auto adopt device details.","items":{"$ref":"#/components/schemas/DeviceOpenApiVO"}},"siteUrl":{"type":"string","description":"Site url for device management."}}},"DeviceOpenApiVO":{"type":"object","properties":{"username":{"type":"string","description":"The username of device."},"password":{"type":"string","description":"The password of device."},"discovery":{"type":"object","additionalProperties":{"type":"object","description":"Discovery udp packet from device."},"description":"Discovery udp packet from device."}},"description":"Auto adopt device details."},"AutoAdoptDeviceResponseOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"Mac of the device."},"errorCode":{"type":"integer","description":"Error code of the device.","format":"int32"},"msg":{"type":"string","description":"Error message of the device."}},"description":"Adopt check result of devices."},"AutoAdoptResponseOpenApiVO":{"type":"object","properties":{"device":{"type":"array","description":"Adopt check result of devices.","items":{"$ref":"#/components/schemas/AutoAdoptDeviceResponseOpenApiVO"}}}},"OperationResponseAutoAdoptResponseOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AutoAdoptResponseOpenApiVO"}}},"Client Reboot":{"type":"object","properties":{"deviceId":{"type":"string","description":"DeviceId of device adopted in VMS.Used when rebooting adopted VIGI devices in device list"}}},"Client Lock To AP Setting":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Lock to AP enable"},"aps":{"type":"array","description":"AP MAC list. Use capital letters and separator, for example: AA-AA-AA-AA-AA-AA.","items":{"type":"string","description":"AP MAC list. Use capital letters and separator, for example: AA-AA-AA-AA-AA-AA."}}}},"ClientIncidentCountRequestOpenApiVO":{"required":["clientList"],"type":"object","properties":{"clientList":{"type":"array","description":"Client MAC addresses for which incident counts are requested.","items":{"type":"string","description":"Client MAC addresses for which incident counts are requested."}}}},"ClientIncidentCountResultOpenApiVO":{"type":"object","properties":{"incidents":{"type":"array","description":"Incident counts for the requested clients.","items":{"$ref":"#/components/schemas/Incident"}}}},"OperationResponseClientIncidentCountResultOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ClientIncidentCountResultOpenApiVO"}}},"Client Delete Filter":{"type":"object","properties":{"start":{"type":"integer","description":"Start timestamp, in seconds, such as 1682000000.","format":"int64"},"end":{"type":"integer","description":"End timestamp, in seconds, such as 1682000000.","format":"int64"},"wireless":{"type":"boolean","description":"Wireless, filter by wireless field if provided."},"guest":{"type":"boolean","description":"Guest, filter by guest field if provided."},"rateLimit":{"type":"boolean","description":"RateLimit, filter by rateLimit field if provided."},"block":{"type":"boolean","description":"Block, filter by block field if provided."},"connectSuccess":{"type":"boolean","description":"Connect success, filter by connectSuccess field if provided."},"searchKey":{"type":"string","description":"Searching for clients to delete, Searching by client mac, client name."}}},"Client Detail":{"type":"object","properties":{"id":{"type":"string","description":"Client ID."},"mac":{"type":"string","description":"Client MAC Address."},"name":{"type":"string","description":"Client Name, alias."},"hostName":{"type":"string","description":"Host name, device name."},"vendor":{"type":"string","description":"Vendor."},"deviceType":{"type":"string","description":"Device Type: iphone, ipod, android, pc, printer, tv..."},"deviceCategory":{"type":"string","description":"Device Category: loT, TV, computer, phone..."},"osName":{"type":"string","description":"Device system version."},"model":{"type":"string","description":"Model of client device."},"ip":{"type":"string","description":"IP Address."},"ipv6List":{"type":"array","description":"IPv6 Address.","items":{"type":"string","description":"IPv6 Address."}},"connectType":{"type":"integer","description":"Connect type should be a value as follows: 0: wireless guest; 1: wireless user; 2: wired user.","format":"int32"},"connectDevType":{"type":"string","description":"connect device type should be a value as follows: ap, switch, gateway."},"connectedToWirelessRouter":{"type":"boolean","description":"true: Client is connecting to a wireless router."},"wireless":{"type":"boolean","description":"true: Wireless device (connectDevType=ap);  false: Not wireless device(connectDevType=switch or gateway)"},"ssid":{"type":"string","description":"(Wireless)  SSID name."},"signalLevel":{"type":"integer","description":"(Wireless) Signal strength percentage should be within the range of 0-100.","format":"int32"},"signalRank":{"type":"integer","description":"(Wireless) Signal strength level should be within the range of 0-5.","format":"int32"},"wifiMode":{"type":"integer","description":"(Wireless) Wifi mode should be a value as follows: 0: 11a; 1: 11b; 2: 11g; 3: 11na; 4: 11ng; 5: 11ac; 6: 11axa; 7: 11axg; 8: 11beg; 9: 11bea.","format":"int32"},"apName":{"type":"string","description":"(Wireless)  AP Name."},"apMac":{"type":"string","description":"(Wireless)  AP MAC Address."},"radioId":{"type":"integer","description":"(Wireless) Radio ID should be a value as follows: 0: 2.4GHz; 1: 5GHz-1; 2:5GHz-2; 3: 6GHz.","format":"int32"},"channel":{"type":"integer","description":"(Wireless)  Actual channel.","format":"int32"},"rxRate":{"type":"integer","description":"(Wireless) Uplink negotiation rate (Kbit/s).","format":"int64"},"txRate":{"type":"integer","description":"(Wireless) Downlink negotiation rate (Kbit/s).","format":"int64"},"powerSave":{"type":"boolean","description":"(Wireless)  true: Power save mode enabled."},"rssi":{"type":"integer","description":"(Wireless) Signal strength, unit: dBm.","format":"int32"},"snr":{"type":"integer","description":"(Wireless) Signal Noise Ratio.","format":"int32"},"switchMac":{"type":"string","description":"(Wired, connectDevType=switch)  Switch MAC address."},"switchName":{"type":"string","description":"(Wired, connectDevType=switch)  Switch name."},"gatewayMac":{"type":"string","description":"(Wired, connectDevType=gateway)  Gateway MAC Address."},"gatewayName":{"type":"string","description":"(Wired, connectDevType=gateway)  Gateway name."},"vid":{"type":"integer","description":"(Wired) vlan.","format":"int32"},"networkName":{"type":"string","description":"(Wired) Network name."},"dot1xIdentity":{"type":"string","description":"(Wired) 802.1x authentication identity."},"dot1xVlan":{"type":"integer","description":"(Wired) Network name corresponding to the VLAN obtained by 802.1x D-VLAN.","format":"int32"},"port":{"type":"integer","description":"(Wired) Port ID.","format":"int32"},"lagId":{"type":"integer","description":"(Wired) LAG ID. Exists only when the client is connected to the LAG.","format":"int32"},"activity":{"type":"integer","description":"Real-time downlink rate (Byte/s).","format":"int64"},"uploadActivity":{"type":"integer","description":"Real-time downlink rate (Byte/s).","format":"int64"},"trafficDown":{"type":"integer","description":"Downstream traffic (Byte).","format":"int64"},"trafficUp":{"type":"integer","description":"Upstream traffic (Byte).","format":"int64"},"uptime":{"type":"integer","description":"Up time (unit: s).","format":"int64"},"lastSeen":{"type":"integer","description":"Last found time, timestamp (ms).","format":"int64"},"authStatus":{"type":"integer","description":"Authentication status should be a value as follows: 0: CONNECTED // Access without any authentication method; 1: PENDING // Access to Portal, but authentication failed; 2: AUTHORIZED // Pass through portal, pass other authentication without portal; 3: AUTH-FREE // No portal authentication required.","format":"int32"},"blocked":{"type":"boolean","description":"Whether the client is blocked."},"guest":{"type":"boolean","description":"(Wireless) Whether it is Guest (used to display the wireless Guest client icon)."},"active":{"type":"boolean","description":"Whether the client is online."},"manager":{"type":"boolean","description":"Whether it is the client currently being managed."},"ipSetting":{"$ref":"#/components/schemas/Client Ip Setting"},"downPacket":{"type":"integer","description":"Number of downstream packets.","format":"int64"},"upPacket":{"type":"integer","description":"Number of upstream packets.","format":"int64"},"rateLimit":{"$ref":"#/components/schemas/Rate Limit Setting of Client"},"clientLockToApSetting":{"$ref":"#/components/schemas/Client Lock To Ap Setting"},"multiLink":{"type":"array","description":"(Wireless) Client multifrequency info list.","items":{"$ref":"#/components/schemas/Client Multifrequency Info"}},"unit":{"type":"integer","description":"Unit ID.","format":"int32"},"standardPort":{"type":"string","description":"Standard port."},"blockDisable":{"type":"boolean","description":"Block client disabled, default value: false"},"dhcpLeaseTime":{"type":"integer","description":"DHCP lease time, unit seconds","format":"int64"},"systemName":{"type":"string","description":"Device system name."},"description":{"type":"string","description":"Device description."},"capabilities":{"type":"array","description":"One or more of the following values: Station、DOCSIS cable device、Telephone、Router、WLAN access point、Bridge、Repeater、other.","items":{"type":"string","description":"One or more of the following values: Station、DOCSIS cable device、Telephone、Router、WLAN access point、Bridge、Repeater、other."}},"authInfo":{"type":"array","description":"Client portal authentication information","items":{"$ref":"#/components/schemas/AuthInfoOpenApiVO"}},"supportLocate":{"type":"boolean","description":"Whether the client supports locate.True when the client is wired connected to a switch or stack that supports locate port."},"locateEnable":{"type":"boolean","description":"Whether locate function is enabled"},"stackId":{"type":"string","description":"Stack Id"},"switchPortsInLag":{"uniqueItems":true,"type":"array","description":"Switch ports in Lag. Exists only when lagId exists and stackId is null","items":{"type":"integer","description":"Switch ports in Lag. Exists only when lagId exists and stackId is null","format":"int32"}},"stPortsInLag":{"uniqueItems":true,"type":"array","description":"Standard switch ports in Lag. Exists only when lagId exists and stackId exists","items":{"type":"string","description":"Standard switch ports in Lag. Exists only when lagId exists and stackId exists"}},"clientSupportNatTraversal":{"type":"boolean","description":"Whether client support NAT traversal"}}},"OperationResponseClient Detail":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Client Detail"}}},"Client Batch IP Setting":{"required":["useFixedAddr"],"type":"object","properties":{"useFixedAddr":{"type":"boolean","description":"Use fixed ip address."},"netId":{"type":"string","description":"Network ID."},"serverType":{"type":"string","description":"DHCP Server Type."},"serverMac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"DHCP Server Mac."},"serverStackId":{"type":"string","description":"DHCP Server Stack ID."},"ipList":{"type":"array","description":"List of ip and client mac.","items":{"$ref":"#/components/schemas/Client MAC-IP Setting"}}},"description":"Setting of ip."},"Client Batch Setting":{"type":"object","properties":{"macList":{"type":"array","description":"List of clients' mac.","items":{"type":"string","description":"List of clients' mac."}},"ipSetting":{"$ref":"#/components/schemas/Client Batch IP Setting"},"rateLimit":{"$ref":"#/components/schemas/Client Rate Limit Setting"},"lockToAp":{"$ref":"#/components/schemas/Client Lock To AP Setting"}}},"Client MAC-IP Setting":{"type":"object","properties":{"mac":{"type":"string","description":"Client MAC address, Use capital letters and separator, for example: AA-AA-AA-AA-AA-AA."},"ip":{"type":"string","description":"Fixed IP address."}},"description":"List of ip and client mac."},"Client Rate Limit Setting":{"required":["mode"],"type":"object","properties":{"mode":{"type":"integer","description":"Rate limit mode should be a value as follows: <br/>0: Custom mode. Apply the given rate limit value to the client; <br/>1: Rate limit profile mode. Find the corresponding rate limit file with rate limit ID and apply it to the client.","format":"int32"},"rateLimitProfileId":{"type":"string","description":"Rate limit profile ID. Required when ratelimit mode is 1"},"customRateLimit":{"$ref":"#/components/schemas/Custom rate limit entity"}},"description":"Setting of rate limit."},"Custom rate limit entity":{"type":"object","properties":{"upEnable":{"type":"boolean","description":"Up limit enable"},"upUnit":{"type":"integer","description":"Up limit unit should be a value as follows: 1: Kbps; 2: Mbps","format":"int32"},"upLimit":{"type":"integer","description":"Up limit should be within the range of 1–1024.","format":"int32"},"downEnable":{"type":"boolean","description":"Down limit enable"},"downUnit":{"type":"integer","description":"Down limit unit should be a value as follows: 1: Kbps; 2: Mbps","format":"int32"},"downLimit":{"type":"integer","description":"Down limit should be within the range of 1–1024.","format":"int32"}},"description":"Custom configuration rate limit."},"BucketBoundaryVO":{"type":"object","properties":{"value":{"type":"integer","description":"Boundary value","format":"int32"},"lowerInclusive":{"type":"boolean","description":"Whether the boundary value is included in the upper bucket (>= value). Default: true"}},"description":"Custom bucket boundaries (ascending by value). If not provided, default boundaries for the card type will be used."},"ClientCardsParamOpenApiVO":{"type":"object","properties":{"type":{"type":"string","description":"Type of the card, e.g. 'rssi', 'snr'"},"topK":{"type":"string","description":"TopK parameter of the card."},"buckets":{"maxItems":100,"minItems":1,"type":"array","description":"Custom bucket boundaries (ascending by value). If not provided, default boundaries for the card type will be used.","items":{"$ref":"#/components/schemas/BucketBoundaryVO"}}},"description":"client cards to query"},"ClientCardsQueryOpenApiVO":{"type":"object","properties":{"cards":{"type":"array","description":"client cards to query","items":{"$ref":"#/components/schemas/ClientCardsParamOpenApiVO"}}}},"ClientCardBucketVO":{"type":"object","properties":{"label":{"type":"string","description":"Bucket label, e.g. '>= -50 dBm' or '[10, 20) dB'"},"lowerBound":{"type":"integer","description":"Lower bound of the bucket, null means negative infinity","format":"int32"},"lowerInclusive":{"type":"boolean","description":"Whether the lower bound is inclusive"},"upperBound":{"type":"integer","description":"Upper bound of the bucket, null means positive infinity","format":"int32"},"upperInclusive":{"type":"boolean","description":"Whether the upper bound is inclusive"},"count":{"type":"integer","description":"Total number of clients in this bucket","format":"int32"},"percent":{"type":"integer","description":"Percentage of clients in this bucket (0-100)","format":"int32"},"clients2g":{"type":"integer","description":"Number of 2.4GHz clients in this bucket","format":"int32"},"clients5g":{"type":"integer","description":"Number of 5GHz clients in this bucket","format":"int32"},"clients6g":{"type":"integer","description":"Number of 6GHz clients in this bucket","format":"int32"}},"description":"Distribution buckets for this card"},"ClientCardDataVO":{"type":"object","properties":{"totalCount":{"type":"integer","description":"Total number of clients counted for this card","format":"int32"},"buckets":{"type":"array","description":"Distribution buckets for this card","items":{"$ref":"#/components/schemas/ClientCardBucketVO"}}},"description":"SNR distribution card data. Only present when 'snr' is requested."},"ClientCardsResultOpenApiVO":{"type":"object","properties":{"rssi":{"$ref":"#/components/schemas/ClientCardDataVO"},"snr":{"$ref":"#/components/schemas/ClientCardDataVO"}}},"OperationResponseClientCardsResultOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ClientCardsResultOpenApiVO"}}},"DeviceExportCliVO":{"required":["deviceMac"],"type":"object","properties":{"variableMap":{"type":"object","additionalProperties":{"type":"string","description":"The values of different user-defined variables."},"description":"The values of different user-defined variables."},"deviceMac":{"type":"string","description":"Device mac"}},"description":"Devices"},"ImportCliVarOpenApiVO":{"type":"object","properties":{"devices":{"type":"array","description":"Devices","items":{"$ref":"#/components/schemas/DeviceExportCliVO"}}}},"OperationResponseImportCliVarOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ImportCliVarOpenApiVO"}}},"ExportCliVarOpenApiVO":{"required":["devices","type"],"type":"object","properties":{"type":{"type":"integer","description":"Export type should be a value as follows: 0:CSV; 1:JSON","format":"int32"},"devices":{"type":"array","description":"Devices","items":{"$ref":"#/components/schemas/DeviceExportCliVO"}}}},"DeviceCliVO":{"type":"object","properties":{"variableMap":{"type":"object","additionalProperties":{"type":"string","description":"The values of different user-defined variables."},"description":"The values of different user-defined variables."},"deviceMac":{"type":"string","description":"Device mac"},"deviceName":{"type":"string","description":"Device name"},"deviceModel":{"type":"string","description":"Model of device"},"modelVersion":{"type":"string","description":"Model version of device"}},"description":"List of devices bound to the CLI configuration."},"ModifyCliOpenApiVO":{"required":["cliConfig","deviceType","name"],"type":"object","properties":{"name":{"type":"string","description":"CLI configuration name, it should be within the range of 1 - 64 characters"},"deviceType":{"type":"string","description":"Device type for CLI configuration application, it should be a value as follows: switch."},"description":{"type":"string","description":"CLI configuration description, it should be within the range of 0 - 256 characters."},"cliConfig":{"type":"string","description":"CLI configuration content"},"devices":{"type":"array","description":"List of devices bound to the CLI configuration.","items":{"$ref":"#/components/schemas/DeviceCliVO"}},"stacks":{"type":"array","description":"List of stacks bound to the CLI configuration, only device CLI has this field.","items":{"$ref":"#/components/schemas/StackCliVO"}},"model":{"type":"string","description":"Device model of model cli"},"modelVersion":{"type":"string","description":"Device model version of model cli"}},"description":"Modify the CLI configuration entry"},"StackCliVO":{"type":"object","properties":{"stackId":{"type":"string","description":"Stack ID"},"stackName":{"type":"string","description":"Stack name"},"masterMac":{"type":"string","description":"Master mac"},"variableMap":{"type":"object","additionalProperties":{"type":"string","description":"The values of different user-defined variables."},"description":"The values of different user-defined variables."}},"description":"List of stacks bound to the CLI configuration, only device CLI has this field."},"PackageCaptureConfig":{"type":"object","properties":{"duration":{"type":"integer","description":"Packet capture duration, in seconds.","format":"int32"},"interfaceType":{"type":"integer","description":"Interface type. 0: Wired; 1: Wireless; 2: LAN Network.","format":"int32"},"singlePackageSize":{"type":"integer","description":"Single package size, in bytes.","format":"int64"},"channel":{"type":"integer","description":"(Wireless)  0: 2.4GHz  1: 5GHz-1  2:5GHz-2 3: 6GHz","format":"int32"},"interfaceName":{"type":"string","description":"Interface name."},"interfaceId":{"type":"string","description":"Interface ID, for example: if interfaceType is network, interfaceId should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."},"filterRules":{"type":"string","description":"Filter rules."},"captureMode":{"type":"integer","description":"Capture mode. 0: Local packet capture; 1: Flow-mode packet capture.","format":"int32"},"arChannel":{"type":"integer","description":"Channel.","format":"int32"},"otaFilterRules":{"type":"string","description":"Filter rules of air interface packet capture."},"srcMac":{"type":"integer","description":"Source L4 port of the packet.","format":"int32"},"destMac":{"type":"string","description":"Destination MAC address of the packet."},"destPort":{"type":"integer","description":"Destination L4 port of the packet.","format":"int32"},"srcIp":{"type":"string","description":"IP address of the message sender."},"destIp":{"type":"string","description":"Destination IP address of the packet."},"protocol":{"type":"integer","description":"Packet type/protocol. It's required when a Switch captures packets.","format":"int32"},"stack":{"type":"boolean","description":"Whether the device supports stacking."},"unit":{"type":"integer","description":"Equipment unit ID.","format":"int32"}}},"CaptureInfo":{"type":"object","properties":{"requestId":{"type":"string","description":"A GUID based on the timestamp. This ID is required when querying the packet capture status and downloading the packet capture file."}}},"OperationResponseCaptureInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CaptureInfo"}}},"OswBriefPortInfoOpenApiVO":{"type":"object","properties":{"port":{"type":"integer","description":"Port","format":"int32"},"standardPort":{"$ref":"#/components/schemas/OswStandPortVO"}},"description":"Port list"},"OswCableTestTestingPortOpenApiVO":{"type":"object","properties":{"portList":{"type":"array","description":"Port list","items":{"$ref":"#/components/schemas/OswBriefPortInfoOpenApiVO"}}}},"ArpDetectVO":{"type":"object","properties":{"id":{"type":"string","description":"The primary id of the arp detection."},"omadacId":{"type":"string","description":"The id of the omada the arp detect belongs to."},"siteId":{"type":"string","description":"The id of the site the arp detect belongs to."},"name":{"type":"string","description":"The name of the arp detect."},"mac":{"type":"string","description":"The mac of the general device."},"deviceName":{"type":"string","description":"The name of the device."},"deviceType":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"deviceModel":{"type":"string","description":"Model of device,for example:EAP225"},"deviceModelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"showModel":{"type":"string","description":"The client showModel"},"stackId":{"type":"string","description":"The stack of the stack device."},"stackName":{"type":"string","description":"The name of the stacking devices."},"oswStack":{"$ref":"#/components/schemas/OswStackInfoVO"},"ports":{"type":"array","description":"The ports selected.","items":{"$ref":"#/components/schemas/PortVO"}},"impbs":{"type":"array","description":"The impbs selected.","items":{"$ref":"#/components/schemas/ImpbVO"}},"status":{"type":"integer","description":"The connected status of the device.","format":"int32"},"unSelectedablePorts":{"type":"array","description":"The unSelectedable ports of the device.","items":{"$ref":"#/components/schemas/PortVO"}},"allPorts":{"type":"array","description":"All Port list in one device.","items":{"$ref":"#/components/schemas/OswPortVO"}},"allLags":{"type":"array","description":"All lag list in one device.","items":{"$ref":"#/components/schemas/OswLagVO"}},"devices":{"type":"array","description":"The devices selected to create entries.","items":{"$ref":"#/components/schemas/DeviceVO"}},"dhcpSnoopPorts":{"type":"array","description":"The ports dhcp snooping selected.","items":{"$ref":"#/components/schemas/PortVO"}}}},"ArpDetectOswVO":{"type":"object","properties":{"mac":{"type":"string","description":"The mac of the general device."},"stackId":{"type":"string","description":"The stack of the stack device."}}},"SpeedTestCommand":{"required":["childMac"],"type":"object","properties":{"childMac":{"type":"string","description":"The parameter [childMac] can be the MAC address of the Main AP or Client AP. Ensure that the two devices to be tested are in a Main-Client relationship."}}},"ApLocationConfigOpenApiVO":{"type":"object","properties":{"longitude":{"type":"number","description":"the longitude of ap location info","format":"double"},"latitude":{"type":"number","description":"the latitude of ap location info","format":"double"}}},"OperationResponseApLocationConfigOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApLocationConfigOpenApiVO"}}},"FullChanScanCommandOpenApiVO":{"type":"object","properties":{"enableInterference":{"type":"boolean","description":"Whether to detect interference when full channel scan."},"enableWifiInterference":{"type":"boolean","description":"Whether to enable wifi interference detect."},"enableChannelUtil":{"type":"boolean","description":"Whether to enable channel load detect."}}},"ApMoveSiteOpenApiVO":{"required":["targetSite"],"type":"object","properties":{"targetSite":{"type":"string","description":"Target site ID"},"apMacs":{"type":"array","description":"aps mac list","items":{"type":"string","description":"aps mac list"}}}},"MoveSiteIdOpenApiVO":{"type":"object","properties":{"moveSiteId":{"type":"string","description":"For batch move site operations, use the \"Get batch move site\" interface to query the result of this operation."}}},"OperationResponseMoveSiteIdOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/MoveSiteIdOpenApiVO"}}},"BatchUpdateMultiApPortsOpenApiVO":{"required":["apMacList","lanPortList"],"type":"object","properties":{"apMacList":{"type":"array","description":"AP mac list","items":{"type":"string","description":"AP mac list"}},"lanPortList":{"maxItems":2147483647,"minItems":1,"type":"array","description":"The list of ap ports which are configured in batches.","items":{"maxLength":2147483647,"minLength":1,"type":"string","description":"The list of ap ports which are configured in batches."}},"name":{"type":"string","description":"Port name"},"status":{"type":"boolean","description":"Port status"},"localVlanEnable":{"type":"boolean","description":"Specifies whether to enable the port."},"localVlanId":{"type":"integer","description":"Local vlan ID should be within the range of 1-4094, which has a value only if Status is true.","format":"int32"},"localVlanNetworkId":{"type":"string","description":"The ID of the LAN network profile selected for the port."},"poeOutEnable":{"type":"boolean","description":"Whether to enable poe out."},"custom":{"type":"boolean","description":"Whether to enter a tagged vlan customically. Enter the VLAN ID manually if it is true. and select LAN network profile if it is false."},"tagged":{"type":"string","description":"Tagged vlan list, it must be present when custom is true."},"untagged":{"type":"string","description":"Untagged vlan list, it must be present when custom is true. Two data cannot be duplicated."},"taggedNetworkId":{"type":"array","description":"The Id list of the tagged vlan network profile, it must be present when custom is true.","items":{"type":"string","description":"The Id list of the tagged vlan network profile, it must be present when custom is true."}},"untaggedNetworkId":{"type":"array","description":"The Id list of the untagged vlan network profile, it must be present when custom is true.","items":{"type":"string","description":"The Id list of the untagged vlan network profile, it must be present when custom is true."}},"bandwidthControlEnable":{"type":"boolean","description":"Whether to enable bandwidthControl."},"ingressRateLimit":{"$ref":"#/components/schemas/ONUPortRateLimitVO"},"egressRateLimit":{"$ref":"#/components/schemas/ONUPortRateLimitVO"}}},"ONUPortRateLimitVO":{"type":"object","properties":{"status":{"type":"boolean","description":"Enable the switch."},"rate":{"type":"integer","description":"Rate should be within the range 1 - 10240","format":"int32"}},"description":"Optical ap egress Rate Limit."},"MultiApPortCapOpenApiVO":{"required":["apMacList"],"type":"object","properties":{"apMacList":{"maxItems":2147483647,"minItems":1,"type":"array","description":"AP mac list","items":{"maxLength":2147483647,"minLength":1,"type":"string","description":"AP mac list"}}}},"AP LAN Port List":{"type":"object","properties":{"id":{"type":"string","description":"Port Id"},"onuId":{"type":"string","description":"Onu Id"},"port":{"type":"integer","description":"Port Number","format":"int32"},"portType":{"type":"integer","description":"Port Type","format":"int32"},"lanPort":{"type":"string","description":"Lan Port"},"name":{"type":"string","description":"Port Name. It should contain 1 ~ 64 ASCII characters. If it is NULL, LanPort is displayed."},"linkStatus":{"type":"integer","description":"Link status; It should be a value as follows:  1:link up;  0: link down.","format":"int32"},"linkSpeed":{"type":"integer","description":"Real-time link speed;It should be a value as follows: 1: 10Mbps; 2: 100Mbps; 3: 1000Mbps; 4: 10Gbps.","format":"int32"},"duplex":{"type":"integer","description":"Real-time duplex mode;It should be a value as follows: 1: Half; 2: Full.","format":"int32"},"supportVlan":{"type":"boolean","description":"Whether the port supports VLANs."},"localVlanEnable":{"type":"boolean","description":"Whether the port enable VLANs."},"localVlanId":{"type":"integer","description":"Local vlan id.","format":"int32"},"localVlanNetworkId":{"type":"string","description":"Local Vlan Network Id, used to enter the LAN field."},"status":{"type":"boolean","description":"Whether to disable the port, defaults to true."},"supportPoe":{"type":"boolean","description":"Whether poe is supported."},"poeOutEnable":{"type":"boolean","description":"Whether to enable poe out."},"poeState":{"type":"integer","description":"This value is only available when supportPoe is true.It should be a value as follows: 0：In the power supply; 1：Not in the power supply.","format":"int32"},"voipState":{"type":"integer","description":"This field has a value for the voice port.It should be a value as follows: 0：Off-hook; 1：On-hook.","format":"int32"},"supportVlanOption":{"type":"boolean","description":"Whether configure a VLAN in profile is supported"},"supportVlanTagged":{"type":"boolean","description":"Whether vlan tagged is supported"},"supportStatusEnable":{"type":"boolean","description":"Whether the port disabling is supported."},"supportStatusInform":{"type":"boolean","description":"Whether report the status of port links through inform is supported."},"custom":{"type":"boolean","description":"Whether to enter a tagged vlan customically. Enter the VLAN ID manually if it is true"},"tagged":{"type":"string","description":"Tagged vlan list, it must be present when custom is true."},"untagged":{"type":"string","description":"Untagged vlan list, it must be present when custom is true. Two data cannot be duplicated."},"taggedNetworkId":{"type":"array","description":"The Id list of the tagged vlan network profile, it must be present when custom is true.","items":{"type":"string","description":"The Id list of the tagged vlan network profile, it must be present when custom is true."}},"untaggedNetworkId":{"type":"array","description":"The Id list of the untagged vlan network profile, it must be present when custom is true.","items":{"type":"string","description":"The Id list of the untagged vlan network profile, it must be present when custom is true."}},"uplinkPort":{"type":"boolean","description":"Whether it is an actual uplink port in topology."},"logicUplinkPort":{"type":"boolean","description":"Whether it is a logical uplink port of device."},"supportBandwidthControl":{"type":"boolean","description":"Whether band width control is supported"},"bandwidthControlEnable":{"type":"boolean","description":"Whether to enable band width control."},"ingressRateLimit":{"$ref":"#/components/schemas/ONUPortRateLimitVO"},"egressRateLimit":{"$ref":"#/components/schemas/ONUPortRateLimitVO"},"portStatus":{"$ref":"#/components/schemas/ApPortStatusVO"},"poeInputMode":{"type":"integer","description":"Poe Input Mode. It should be a value as follows: 0: OFF, 1: BT, 2: AT, 3: AF.","format":"int32"}}},"ApPortStatusVO":{"type":"object","properties":{"tx":{"type":"integer","description":"Tx Bytes","format":"int64"},"rx":{"type":"integer","description":"Rx Bytes","format":"int64"}},"description":"Port Status"},"OperationResponseListAP LAN Port List":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/AP LAN Port List"}}}},"AP MAC list":{"type":"object","properties":{"macList":{"type":"array","description":"Ap mac list","items":{"type":"string","description":"Ap mac list"}}}},"Afc6gPowerDetailVO":{"type":"object","properties":{"value":{"type":"integer","format":"int32"},"channelWidth":{"type":"integer","format":"int32"},"maxPow":{"type":"integer","format":"int32"},"minPow":{"type":"integer","format":"int32"},"powerMode":{"type":"boolean"},"channelValue":{"type":"integer","format":"int32"}}},"ApChannelInfoOpenApiVO":{"type":"object","properties":{"data":{"type":"array","description":"Ap channel item list.","items":{"$ref":"#/components/schemas/ChannelItemVO"}}}},"ChannelDetailVO":{"type":"object","properties":{"freq":{"type":"integer","format":"int32"},"channelName":{"type":"string"},"value":{"type":"integer","format":"int32"},"maxPow":{"type":"integer","format":"int32"},"widthFlag":{"type":"integer","format":"int32"},"dfs":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"channelValue":{"type":"integer","format":"int32"},"maxPowId":{"type":"integer","format":"int32"},"widthFlagId":{"type":"integer","format":"int32"},"maxPowOd":{"type":"integer","format":"int32"},"widthFlagOd":{"type":"integer","format":"int32"},"minPowAnt":{"type":"integer","format":"int32"},"maxPowAnt":{"type":"integer","format":"int32"}}},"ChannelItemVO":{"type":"object","properties":{"radioId":{"type":"integer","format":"int32"},"band":{"type":"string"},"channelList":{"type":"array","items":{"$ref":"#/components/schemas/ChannelDetailVO"}},"afc6gPowerList":{"type":"array","items":{"$ref":"#/components/schemas/Afc6gPowerDetailVO"}},"disable6gReason":{"type":"integer","format":"int32"},"minPowAnt":{"type":"integer","format":"int32"},"maxPowAnt":{"type":"integer","format":"int32"}},"description":"Ap channel item list."},"ChangeP2pRole":{"required":["clientMac","mainMac"],"type":"object","properties":{"mainMac":{"type":"string","description":"Main ap's mac address"},"clientMac":{"type":"string","description":"Client ap's mac address"}}},"IncidentRankingQueryVO":{"required":["anomalyCode","endTime","startTime"],"type":"object","properties":{"startTime":{"type":"integer","description":"Start time in milliseconds","format":"int64"},"endTime":{"type":"integer","description":"End time in milliseconds","format":"int64"},"topK":{"maximum":20,"type":"integer","description":"Number of top items to return. Defaults to 5 if not provided, maximum to 20.","format":"int32"},"anomalyCode":{"type":"integer","description":"For the values of Anomaly event code, refer to section 5.7.2.1 of the Open API Access","format":"int32","example":1001001}}},"IncidentRankingBandItemVO":{"type":"object","properties":{"band":{"type":"integer","description":"Frequency band identifier (e.g. 0=2.4GHz, 1=5GHz, 2=5GHz-2, 3=6GHz)","format":"int32"},"incidents":{"type":"integer","description":"Number of incidents associated with this frequency band","format":"int32"}},"description":"Top frequency bands ranked by incident count (e.g. 0=2.4GHz, 1=5GHz, 2=5GHz-2, 3=6GHz)"},"IncidentRankingClientItemVO":{"type":"object","properties":{"name":{"type":"string","description":"Display name of the client"},"mac":{"type":"string","description":"MAC address of the client"},"type":{"type":"string","description":"Device type of the client (e.g. iphone, android, pc)"},"manager":{"type":"boolean","description":"Whether this client is a managed client"},"incidents":{"type":"integer","description":"Number of incidents involving this client","format":"int32"}},"description":"Top clients ranked by incident count"},"IncidentRankingDeviceItemVO":{"type":"object","properties":{"name":{"type":"string","description":"Display name of the device"},"mac":{"type":"string","description":"MAC address of the device"},"model":{"type":"string","description":"Device model (e.g. EAP225)"},"modelVersion":{"type":"string","description":"Device model version (e.g. 3.0)"},"type":{"type":"string","description":"Device type (e.g. ap, gateway, switch)"},"incidents":{"type":"integer","description":"Number of incidents involving this device","format":"int32"}},"description":"Top devices ranked by incident count"},"IncidentRankingResultVO":{"type":"object","properties":{"clientList":{"type":"array","description":"Top clients ranked by incident count","items":{"$ref":"#/components/schemas/IncidentRankingClientItemVO"}},"deviceList":{"type":"array","description":"Top devices ranked by incident count","items":{"$ref":"#/components/schemas/IncidentRankingDeviceItemVO"}},"ssidList":{"type":"array","description":"Top SSIDs ranked by incident count","items":{"$ref":"#/components/schemas/IncidentRankingSsidItemVO"}},"bandList":{"type":"array","description":"Top frequency bands ranked by incident count (e.g. 0=2.4GHz, 1=5GHz, 2=5GHz-2, 3=6GHz)","items":{"$ref":"#/components/schemas/IncidentRankingBandItemVO"}}}},"IncidentRankingSsidItemVO":{"type":"object","properties":{"ssidName":{"type":"string","description":"SSID name"},"incidents":{"type":"integer","description":"Number of incidents associated with this SSID","format":"int32"}},"description":"Top SSIDs ranked by incident count"},"OperationResponseIncidentRankingResultVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/IncidentRankingResultVO"}}},"AnomalyBriefQueryVO":{"required":["anomalyCode","object"],"type":"object","properties":{"object":{"type":"array","items":{"type":"string"}},"anomalyCode":{"type":"string","description":"For the values of Anomaly event code, refer to section 5.7.2.1 of the Open API Access","example":"01001001"}},"description":"List of anomaly event objects to operate on, identified by anomaly code and MAC."},"AnomalyTimerSettingVO":{"required":["endTime","startTime","status"],"type":"object","properties":{"incidents":{"type":"array","description":"List of anomaly event objects to operate on, identified by anomaly code and MAC.","items":{"$ref":"#/components/schemas/AnomalyBriefQueryVO"}},"selectAll":{"type":"boolean","description":"Whether to select all incidents. If true, 'incidents' list items are excluded; otherwise only listed items are processed."},"searchKey":{"type":"string","description":"Search keyword for event content, device name/MAC/IP. Required when selectAll is true."},"level":{"type":"integer","description":"Event severity level filter. 0: Critical, 1: Error, 2: Warning, 3: Info.","format":"int32"},"category":{"type":"string","description":"Event category filter, comma-separated. Required when selectAll is true."},"objectType":{"type":"string","description":"Object type filter, comma-separated (e.g. 'ap,wirelessClient'). Required when selectAll is true."},"status":{"type":"integer","description":"Current event status. 0: Unresolved, 1: Resolved, 2: Ignored. 3: Ongoing","format":"int32"},"targetStatus":{"type":"integer","description":"Target event status for modification. 0: Unresolved 1: Resolved, 2: Ignored. Not required for deletion.","format":"int32"},"start":{"type":"integer","description":"Start time in seconds (Unix timestamp).","format":"int64"},"end":{"type":"integer","description":"End time in seconds (Unix timestamp).","format":"int64"},"startTime":{"type":"integer","description":"Start time in milliseconds (Unix timestamp).","format":"int64"},"endTime":{"type":"integer","description":"End time in milliseconds (Unix timestamp).","format":"int64"}}},"OperationResponseObject":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"object"}}},"AnomalyListSettingVO":{"type":"object","properties":{"incidents":{"type":"array","description":"List of anomaly event IDs to operate on. IDs are from 'Get grid incident List' API.","items":{"type":"string","description":"List of anomaly event IDs to operate on. IDs are from 'Get grid incident List' API."}},"selectAll":{"type":"boolean","description":"Whether to select all incidents. If true, 'incidents' list items are excluded; otherwise only listed items are processed."},"object":{"type":"string","description":"Device or client MAC, multiple MACs separated by comma. Required when selectAll is true."},"anomalyCode":{"type":"string","description":"Anomaly event code. Required when selectAll is true."},"start":{"type":"integer","description":"Start time in seconds. If both start and end are omitted, the server defaults to the last 30 days.","format":"int64"},"end":{"type":"integer","description":"End time in seconds. If both start and end are omitted, the server defaults to the last 30 days.","format":"int64"},"status":{"type":"integer","description":"Current event status. 0: Unresolved, 1: Resolved, 2: Ignored. 3：Ongoing","format":"int32"},"targetStatus":{"type":"integer","description":"Target event status for modification. 0: Unresolved 1: Resolved, 2: Ignored. Not required for deletion.","format":"int32"}}},"BatchEditCustomAclOpenApiVO":{"required":["ids","log","status"],"type":"object","properties":{"ids":{"uniqueItems":true,"type":"array","description":"When selectType is set to all, the ids do not need to be passed and all entries are processed, when selectType is set to include, the id entries contained in the ids are processed, when selectType is set to exclude, the id entries that are not contained in the ids are processed","items":{"type":"string","description":"When selectType is set to all, the ids do not need to be passed and all entries are processed, when selectType is set to include, the id entries contained in the ids are processed, when selectType is set to exclude, the id entries that are not contained in the ids are processed"}},"selectType":{"pattern":"all|include|exclude","type":"string","description":"SelectType all, include or exclude"},"searchKey":{"type":"string","description":"Fuzzy query parameters, support field: voucher code"},"log":{"type":"integer","description":"log status of acl.","format":"int32"},"status":{"type":"integer","description":"enable status of acl.","format":"int32"}}},"CreateSiteByTemplate":{"required":["deviceAccountSetting","name","region","scenario","siteTemplateId"],"type":"object","properties":{"siteTemplateId":{"type":"string","description":"Site template ID."},"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,62}[^ ]$","type":"string","description":"Name of the site should contain 1 to 64 characters."},"region":{"type":"string","description":"Country/Region of the site; For the values of region, refer to the abbreviation of the ISO country code; For example, you need to input \"United States\" for the United States of America."},"scenario":{"type":"string","description":"For the values of the scenario of the site, refer to result of the interface for Get scenario list."},"tagIds":{"uniqueItems":true,"type":"array","description":"Site tag ID, Site tag ID can be created using \"Create new site tag\" interface, and site tag ID can be obtained from \"Get site tag list\" interface","items":{"type":"string","description":"Site tag ID, Site tag ID can be created using \"Create new site tag\" interface, and site tag ID can be obtained from \"Get site tag list\" interface"}},"longitude":{"type":"number","description":"Longitude of the site should be within the range of -180 - 180.","format":"double"},"latitude":{"type":"number","description":"Latitude of the site should be within the range of -90 - 90.","format":"double"},"address":{"type":"string","description":"Address of the site"},"deviceAccountSetting":{"$ref":"#/components/schemas/DeviceAccountSettingOpenApiVO"},"supportES":{"type":"boolean","description":"Whether the site supports adopting Agile Series switches"},"supportL2":{"type":"boolean","description":"Whether the site supports adopting Non-Agile Series switches"}}},"CreateSiteTagOpenApiVO":{"type":"object","properties":{"name":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"Tag name should contain 1 to 128 ASCII characters"}}},"Site Tag":{"type":"object","properties":{"name":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"Tag name should contain 1 to 128 ASCII characters."},"tagId":{"type":"string","description":"Tag ID"}}},"SiteStatistic":{"required":["omadacId","siteId"],"type":"object","properties":{"omadacId":{"type":"string","description":"Omadac ID"},"siteId":{"type":"string","description":"Site ID"}},"description":"Site statistic"},"SiteStatisticList":{"type":"object","properties":{"omadaAndSiteIds":{"type":"array","description":"Omadac ID and site ID list","items":{"$ref":"#/components/schemas/SiteStatistic"}}},"description":"Site statistic list"},"DeviceAccountSettingVO":{"required":["password","username"],"type":"object","properties":{"username":{"pattern":"^[\\041-\\0176]{1,64}$","type":"string"},"password":{"pattern":"^[\\041-\\0176]{1,64}$","type":"string"}}},"HealthStatVO":{"type":"object","properties":{"good":{"type":"integer","format":"int32"},"fair":{"type":"integer","format":"int32"},"poor":{"type":"integer","format":"int32"},"noData":{"type":"integer","format":"int32"}}},"OperationResponseSiteSummaryStatistic":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteSummaryStatistic"}}},"SiteSettingAnomalyStatVO":{"type":"object","properties":{"critical":{"type":"integer","description":"Number of critical level incidents.","format":"int32"},"error":{"type":"integer","description":"Number of error level incidents.","format":"int32"},"warning":{"type":"integer","description":"Number of warning level incidents.","format":"int32"},"info":{"type":"integer","description":"Number of info level incidents.","format":"int32"}},"description":"Statistics of incidents for site."},"SiteSummaryStatistic":{"type":"object","properties":{"siteStatisticMap":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/site statistic info"}}},"description":"Site summary statistic info"},"WanHealthStatVO":{"type":"object","properties":{"good":{"type":"integer","format":"int32"},"fair":{"type":"integer","format":"int32"},"poor":{"type":"integer","format":"int32"},"noData":{"type":"integer","format":"int32"},"offline":{"type":"integer","format":"int32"}}},"site statistic info":{"type":"object","properties":{"id":{"type":"string"},"gatewayStatus":{"type":"integer","format":"int32"},"preConfigOsgNum":{"type":"integer","format":"int64"},"preConfigOswNum":{"type":"integer","format":"int64"},"preConfigApNum":{"type":"integer","format":"int64"},"preConfigOltNum":{"type":"integer","format":"int64"},"lan":{"type":"boolean"},"wlan":{"type":"boolean"},"lanDeviceConnectedNum":{"type":"integer","format":"int64"},"lanDeviceDisconnectedNum":{"type":"integer","format":"int64"},"wlanDeviceConnectedNum":{"type":"integer","format":"int64"},"wlanDeviceDisconnectedNum":{"type":"integer","format":"int64"},"wlanDeviceIsolatedNum":{"type":"integer","format":"int64"},"oltDeviceConnectedNum":{"type":"integer","format":"int64"},"oltDeviceDisconnectedNum":{"type":"integer","format":"int64"},"lanUserNum":{"type":"integer","format":"int64"},"wlanUserNum":{"type":"integer","format":"int64"},"lanGuestNum":{"type":"integer","format":"int64"},"wlanGuestNum":{"type":"integer","format":"int64"},"deviceAccount":{"$ref":"#/components/schemas/DeviceAccountSettingVO"},"wirelessUpgrade":{"type":"boolean"},"wiredUpgrade":{"type":"boolean"},"issueEvent":{"$ref":"#/components/schemas/SiteSettingAnomalyStatVO"},"wanHealth":{"$ref":"#/components/schemas/WanHealthStatVO"},"wlanHealth":{"type":"integer","format":"int32"},"gatewayHealth":{"type":"integer","format":"int32"},"switchHealth":{"$ref":"#/components/schemas/HealthStatVO"},"eapHealth":{"$ref":"#/components/schemas/HealthStatVO"},"wirelessClientHealth":{"$ref":"#/components/schemas/HealthStatVO"},"wiredClientHealth":{"$ref":"#/components/schemas/HealthStatVO"}}},"BatchSiteImportVO":{"required":["fileServerConfig","siteImportConfigList"],"type":"object","properties":{"fileServerConfig":{"$ref":"#/components/schemas/FileServerOpenApiVO"},"siteImportConfigList":{"type":"array","description":"Site import config list. max size 300.","items":{"$ref":"#/components/schemas/SiteImportOpenApiVO"}}}},"FileServerOpenApiVO":{"required":["hostname","port","protocol"],"type":"object","properties":{"protocol":{"type":"string","description":"File server protocol, protocol should be a value as follows: FTP: FTP protocal; SFTP: SFTP protocal; TFTP: TFTP protocal; SCP: SCP protocal."},"hostname":{"type":"string","description":"File server host name or IP. Parameter [filePath] should be 1 - 128 ASCII characters."},"port":{"type":"integer","description":"File server port. The value must be between 1 and 65535.","format":"int32"},"username":{"type":"string","description":"File server access username, if needed in FTP/SFTP/SCP protocol. Parameter [username] should be 1 - 128 ASCII characters."},"password":{"type":"string","description":"File server access password, if needed in FTP/SFTP protocol. Parameter [password] should be 1 - 128 ASCII characters."}},"description":"File server configuration."},"SiteImportOpenApiVO":{"required":["filePath","siteName"],"type":"object","properties":{"filePath":{"type":"string","description":"File path of site backup config file."},"siteName":{"type":"string","description":"Target site name. It should contain 1 to 64 characters."},"skipDevice":{"type":"boolean","description":"Whether skip device info(if true: skip import device; if false: import device in config file; default for false"}},"description":"Site import config list. max size 300."},"OperationResponseSiteResultVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteResultVO"}}},"SiteResultVO":{"type":"object","properties":{"successSiteList":{"uniqueItems":true,"type":"array","description":"Site ID list which executing site maintenance successfully.","items":{"type":"string","description":"Site ID list which executing site maintenance successfully."}}}},"BatchSiteSelfRestoreVO":{"required":["siteRestoreInfos"],"type":"object","properties":{"siteRestoreInfos":{"uniqueItems":true,"type":"array","description":"Site restore info list to restore. Up to 300 entries are allowed for the site restore info list.","items":{"$ref":"#/components/schemas/SelfSiteRestoreVO"}}}},"SelfSiteRestoreVO":{"required":["fileName","siteId"],"type":"object","properties":{"fileName":{"type":"string","description":"Site backup file name. Parameter [fileName] should be 1 - 128 ASCII characters."},"siteId":{"type":"string","description":"Site ID to restore"}},"description":"Site restore info list to restore. Up to 300 entries are allowed for the site restore info list."},"BatchSiteFileServerRestoreVO":{"required":["serverConfig","siteInfos"],"type":"object","properties":{"serverConfig":{"$ref":"#/components/schemas/FileServerOpenApiVO"},"siteInfos":{"type":"array","description":"Sites to restore.","items":{"$ref":"#/components/schemas/FileServerSiteRestoreVO"}}}},"FileServerSiteRestoreVO":{"required":["filePath","siteId"],"type":"object","properties":{"filePath":{"type":"string","description":"Full path of Backup file, example: /backup/omada_backup.cfg. Parameter [filePath] should be 1 - 128 ASCII characters."},"siteId":{"type":"string","description":"Site ID to restore."}},"description":"Sites to restore."},"BatchSiteBackupVO":{"required":["siteIds"],"type":"object","properties":{"siteIds":{"uniqueItems":true,"type":"array","description":"Site ID list to backup, at least one site, max 300 sites.","items":{"type":"string","description":"Site ID list to backup, at least one site, max 300 sites."}}}},"FileServerSiteBackupVO":{"required":["filePath","serverConfig","siteIds"],"type":"object","properties":{"serverConfig":{"$ref":"#/components/schemas/FileServerOpenApiVO"},"filePath":{"type":"string","description":"Saving path of directory for all backup config files, example: /backup. Parameter [filePath] should be 1 - 128 ASCII characters."},"siteIds":{"uniqueItems":true,"type":"array","description":"Site ID list to backup, up to 300 entries are allowed for the site ID list.","items":{"type":"string","description":"Site ID list to backup, up to 300 entries are allowed for the site ID list."}}}},"BatchSiteCopyVO":{"required":["siteNamePrefix","sourceSiteId","targetSiteNum"],"type":"object","properties":{"sourceSiteId":{"type":"string","description":"Source site ID to be copied."},"targetSiteNum":{"type":"integer","description":"Site num to be created should between 1 and 300.","format":"int32"},"siteNamePrefix":{"type":"string","description":"Site name prefix, new sites name will use this prefix. Parameter [siteNamePrefix] should be 1 - 128 ASCII characters."}}},"SendMailServerOpenApiVO":{"required":["authEnable","port","smtpServer","sslEnable"],"type":"object","properties":{"smtpEnable":{"type":"boolean","description":"Enable SMTP mail server"},"smtpServer":{"pattern":"^[\\041-\\0176]{1,128}$","type":"string","description":"The domain name of the SMTP mailbox server."},"port":{"type":"integer","description":"The port of the SMTP mailbox server,xxxx  should be within the range of 1-65535","format":"int32"},"sslEnable":{"type":"boolean","description":"Whether the SMTP mailbox server uses SSL encryption."},"authEnable":{"type":"boolean","description":"Whether the SMTP email server uses basic authentication."},"username":{"pattern":"^[\\041-\\0176]{1,128}$","type":"string","description":"The user's email address used for authentication."},"password":{"pattern":"^[\\041-\\0176]{1,128}$","type":"string","description":"The user's email password used for authentication."},"senderAddress":{"pattern":"[-0-9a-zA-Z.+_]+@[-0-9a-zA-Z.+_]+\\.[a-zA-Z0-9]{2,}","type":"string","description":"The email address from which the message was sent."},"receiver":{"pattern":"[-0-9a-zA-Z.+_]+@[-0-9a-zA-Z.+_]+\\.[a-zA-Z0-9]{2,}","type":"string","description":"The email address where the message will be received."}}},"QueryThreatMapOpenApiVO":{"type":"object","properties":{"start":{"type":"integer","description":"The timestamp for the start time is in milliseconds.","format":"int64"},"end":{"type":"integer","description":"The timestamp for the end time is in milliseconds.","format":"int64"},"severity":{"type":"string","description":"Severity."},"country":{"type":"string","description":"The country that was attacked."},"sites":{"type":"string","description":"Comma separated sites should be explained. If it is not passed, select all."}}},"GetThreatMapOpenApiVO":{"type":"object","properties":{"data":{"type":"array","description":"Threat Map List.","items":{"$ref":"#/components/schemas/ThreatMapOpenApiVO"}}}},"OperationResponseGetThreatMapOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GetThreatMapOpenApiVO"}}},"ThreatMapOpenApiVO":{"type":"object","properties":{"country":{"type":"string","description":"Country."},"coords":{"type":"array","description":"Longitude, latitude.","items":{"type":"number","description":"Longitude, latitude.","format":"double"}},"attempts":{"type":"integer","description":"Number of threats.","format":"int64"}},"description":"Threat Map List."},"QueryCountryThreatListOpenApiVO":{"type":"object","properties":{"country":{"type":"string","description":"Country."},"severity":{"type":"string","description":"Displays the number of threats at different levels,0 - very high，1- high, 2- medium，3 - low."},"sites":{"type":"string","description":"List of siteIds, separated by commas (,). All sites are returned if they are not passed."},"currentPage":{"type":"integer","description":"Current Page.","format":"int32"},"currentPageSize":{"type":"integer","description":"Current Page Size.","format":"int32"},"searchKey":{"type":"string","description":"Search Key."},"searchField":{"type":"string","description":"Specify the search domain, separated by commas, such as \"clientMac,clientName\".Can be null, in which case the default search domain should be used."},"sorts":{"type":"string","description":"sorts."},"startTime":{"type":"integer","description":"The timestamp for the start time is in milliseconds.","format":"int64"},"endTime":{"type":"integer","description":"End Time.","format":"int64"}}},"GridVOIpsThreatOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/IpsThreatOpenApiVO"}}}},"IpsThreatOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"ID."},"omadacId":{"type":"string","description":"Omada ID"},"siteId":{"type":"string","description":"Site ID"},"siteName":{"type":"string","description":"Site Name."},"time":{"type":"integer","description":"Time.","format":"int64"},"severity":{"type":"integer","description":"0：critical, 1：major, 2：concerning 3：minor.","format":"int32"},"service":{"type":"string","description":"Service."},"signature":{"type":"string","description":"Signature."},"category":{"type":"integer","description":"Category.","format":"int32"},"activity":{"type":"string","description":"Activity."},"dataUsage":{"type":"integer","description":"Data Usage.","format":"int64"},"srcIp":{"type":"string","description":"Source Ip."},"dstIp":{"type":"string","description":"Destination Ip."},"srcCountry":{"type":"string","description":"Source Country."},"dstCountry":{"type":"string","description":"Destination Country."},"protocol":{"type":"string","description":"Protocol."},"sid":{"type":"integer","description":"Sid.","format":"int64"},"srcLatitude":{"type":"number","description":"Source Latitude(The precision is four decimal places).","format":"double"},"srcLongitude":{"type":"number","description":"Source Longitude(The precision is four decimal places).","format":"double"},"dstLatitude":{"type":"number","description":"Destination Latitude(The precision is four decimal places).","format":"double"},"dstLongitude":{"type":"number","description":"Destination Longitude(The precision is four decimal places).","format":"double"},"archived":{"type":"boolean","description":"Whether archived."},"classification":{"type":"string","description":"Classification."},"creatTime":{"type":"integer","description":"Creat Time.","format":"int64"}}},"OperationResponseGridVOIpsThreatOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOIpsThreatOpenApiVO"}}},"OperationResponseThreatMapCategoryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ThreatMapCategoryOpenApiVO"}}},"ThreatCategoryOpenApiVO":{"type":"object","properties":{"country":{"type":"string","description":"Country."},"coords":{"type":"array","description":"Longitude, latitude.","items":{"type":"number","description":"Longitude, latitude.","format":"double"}},"attempts":{"type":"array","description":"Number of threats,List structure : [Low, Minor, Moderate, major, critical].","items":{"type":"integer","description":"Number of threats,List structure : [Low, Minor, Moderate, major, critical].","format":"int64"}}},"description":"Threat Category List."},"ThreatMapCategoryOpenApiVO":{"type":"object","properties":{"data":{"type":"array","description":"Threat Category List.","items":{"$ref":"#/components/schemas/ThreatCategoryOpenApiVO"}}}},"SiteListOpenApiVO":{"type":"object","properties":{"sites":{"type":"string","description":"Site ID list."}}},"BlockedCountryOpenApiVO":{"type":"object","properties":{"countries":{"type":"array","description":"Country List.","items":{"type":"string","description":"Country List."}}}},"OperationResponseBlockedCountryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/BlockedCountryOpenApiVO"}}},"OpsBlockedCountryOpenApiVO":{"type":"object","properties":{"country":{"type":"string","description":"Country."},"sites":{"type":"array","description":"Site list.","items":{"type":"string","description":"Site list."}}}},"AutoSelectWanPortReq":{"required":["deviceMac","role","siteId"],"type":"object","properties":{"deviceMac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"The MAC of a SD-WAN candidate device."},"siteId":{"type":"string","description":"Site ID."},"role":{"type":"integer","description":"The role of SD-WAN member, hub: 0 or spoke: 1.","format":"int32"},"linkedSpokes":{"type":"array","description":"A list MAC of linked-spokes of the sdWan group.","items":{"type":"string","description":"A list MAC of linked-spokes of the sdWan group."}}},"description":"A list of the SD-WAN devices which use auto select."},"BatchAutoSelectWanPortReq":{"type":"object","properties":{"memberList":{"type":"array","description":"A list of the SD-WAN devices which use auto select.","items":{"$ref":"#/components/schemas/AutoSelectWanPortReq"}}}},"AutoSelectWanPortResult":{"type":"object","properties":{"deviceMac":{"type":"string","description":"The device MAC of the sdWan member."},"recommendWanId":{"type":"string","description":"Recommend Wan ID."}},"description":"A list of the auto select Wan port result."},"BatchAutoSelectWanPortResult":{"type":"object","properties":{"data":{"type":"array","description":"A list of the auto select Wan port result.","items":{"$ref":"#/components/schemas/AutoSelectWanPortResult"}}}},"OperationResponseBatchAutoSelectWanPortResult":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/BatchAutoSelectWanPortResult"}}},"SdWanLanNetworkNatReq":{"required":["gatewaySubnet","siteId"],"type":"object","properties":{"id":{"type":"string","description":"The ID of the lan network"},"siteId":{"type":"string","description":"The site ID of the lan network"},"gatewaySubnet":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\/(?:[0-9]|[1-2][0-9]|3[0-2])$","type":"string","description":"The Gateway Subnet of the lan network"},"needMap":{"type":"boolean","description":"This value exists in customNetwork. If true, it indicates a conflicting route that requires mapping; routes with false should be avoided by NAT mapping."}},"description":"A list of original custom route"},"SdWanMemberSelected":{"required":["deviceMac","siteId"],"type":"object","properties":{"deviceMac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"The device MAC of the sdWan member."},"siteId":{"type":"string","description":"The ID of the site where the sdWan member is located."}},"description":"A list of members of the SD-WAN group"},"SdWanSelectedMapNetwork":{"type":"object","properties":{"lanNetworks":{"type":"array","description":"A list of original lan network","items":{"$ref":"#/components/schemas/SdWanLanNetworkNatReq"}},"customNetwork":{"type":"array","description":"A list of original custom route","items":{"$ref":"#/components/schemas/SdWanLanNetworkNatReq"}},"mapNetworkList":{"type":"array","description":"A list of map network range","items":{"type":"string","description":"A list of map network range"}},"memberList":{"type":"array","description":"A list of members of the SD-WAN group","items":{"$ref":"#/components/schemas/SdWanMemberSelected"}},"groupId":{"type":"string","description":"The SD-WAN group ID."}}},"OperationResponseSdWanMappedNetworkResult":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SdWanMappedNetworkResult"}}},"SdWanMappedNetworkResult":{"type":"object","properties":{"mappedNetworks":{"type":"array","description":"A list of the mapped network","items":{"$ref":"#/components/schemas/SdWanNetworkMap"}},"defaultMapNetworkList":{"type":"array","description":"A list of the default mapping network","items":{"type":"string","description":"A list of the default mapping network"}},"customMapNetworkList":{"type":"array","description":"A list of the customized mapping network","items":{"type":"string","description":"A list of the customized mapping network"}}}},"SdWanNetworkMap":{"type":"object","properties":{"siteId":{"type":"string","description":"The ID of the site"},"siteName":{"type":"string","description":"The name of the site"},"deviceName":{"type":"string","description":"The name of the device"},"lanNetworkId":{"type":"string","description":"The ID of the original network before mapping"},"gatewaySubnet":{"type":"string","description":"The IP range of the original network before mapping"},"mappedNetwork":{"type":"string","description":"mapped network"},"networkType":{"type":"integer","description":"Network type, 0/null: LAN network, 1: custom route","format":"int32"}},"description":"A list of the mapped network"},"CheckMappedNetwork":{"required":["memberList","modifiedNetwork"],"type":"object","properties":{"modifiedNetwork":{"pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\\/(?:[0-9]|[1-2][0-9]|3[0-2])$","type":"string","description":"The IP Subnet of the modified network"},"memberList":{"type":"array","description":"A list of members of the SD-WAN group","items":{"$ref":"#/components/schemas/SdWanMemberSelected"}},"mappedNetworks":{"type":"array","description":"A list of current mapped network of the SD-WAN group","items":{"type":"string","description":"A list of current mapped network of the SD-WAN group"}}}},"SdWanIpPoolRange":{"required":["ipPoolEnd","ipPoolStart","tunnelLimit"],"type":"object","properties":{"ipPoolStart":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The start of the IP pool of the sdWan group."},"ipPoolEnd":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The end of the IP pool of the sdWan group."},"groupId":{"type":"string","description":"The SD-WAN group ID."},"tunnelLimit":{"type":"integer","description":"Enter the number of tunnels required by this group to determine if the number of IPs in the IP pool is sufficient.","format":"int32"}}},"QuerySdWanCandidateDevice":{"required":["page","pageSize","role","tunnelLimit"],"type":"object","properties":{"page":{"type":"integer","description":"Start from 1.","format":"int32"},"pageSize":{"type":"integer","description":"It should be within the range of 1–1000.","format":"int32"},"sorts":{"type":"object","additionalProperties":{"type":"string"}},"searchKey":{"type":"string","description":"Look for a specific piece of data."},"filters":{"type":"object","additionalProperties":{"type":"object"}},"searchField":{"type":"string"},"tunnelLimit":{"type":"integer","description":"The maximum number of VPN tunnels that can be created. Used to filter devices that meet the minimum supported tunnel count. Only those that support a tunnel count greater than the minimum will be listed.","format":"int32"},"groupId":{"type":"string","description":"The ID of the SD-WAN group."},"role":{"type":"integer","description":"The role in SD-WAN Group. 0:Hub,1:Spoke","format":"int32"},"excludeDeviceMacs":{"type":"array","description":"A list of exclude Device MAC for the candidate.","items":{"type":"string","description":"A list of exclude Device MAC for the candidate."}}}},"GridVOSdWanCandidateDevice":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SdWanCandidateDevice"}}}},"OperationResponseGridVOSdWanCandidateDevice":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOSdWanCandidateDevice"}}},"SdWanCandidateDevice":{"type":"object","properties":{"deviceName":{"type":"string","description":"The name of a SD-WAN candidate device."},"deviceMac":{"type":"string","description":"The MAC of a SD-WAN candidate device."},"showModel":{"type":"string","description":"The showModel of a SD-WAN candidate device."},"type":{"type":"string","description":"The device type of a SD-WAN candidate device."},"model":{"type":"string","description":"The model of a SD-WAN candidate device."},"modelVersion":{"type":"string","description":"The model version of a SD-WAN candidate device."},"siteId":{"type":"string","description":"The ID of the site where the a SD-WAN candidate device located."},"siteName":{"type":"string","description":"The name of the site where the a SD-WAN candidate device located."},"wanIp":{"type":"string","description":"The wan IP of the a SD-WAN candidate device."},"tunnelLimit":{"type":"integer","description":"The maximum number of VPN tunnels that can be created.","format":"int32"},"capacityLevel":{"type":"integer","description":"The capacity level of a SD-WAN candidate device.","format":"int32"},"hasPublicIp":{"type":"boolean","description":"Whether the a SD-WAN candidate has public IP."},"status":{"type":"integer","description":"The online status of the candidate.","format":"int32"},"lanNetworks":{"type":"array","description":"A list of the lan network info for the candidate.","items":{"$ref":"#/components/schemas/LanNetworkBrief"}},"portInfos":{"type":"array","description":"A list of the port info for the candidate.","items":{"$ref":"#/components/schemas/OsgPortStatBrief"}},"supportSdWanNat":{"type":"boolean","description":"Whether the device support SD-WAN NAT."}}},"Scenario":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Scenario name should contain 1 to 128 visible ASCII characters."}}},"CreateRoleResultVO":{"type":"object","properties":{"roleId":{"type":"string","description":"Role ID"}}},"OperationResponseCreateRoleResultVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CreateRoleResultVO"}}},"TransferRootOpenApiVO":{"required":["userId"],"type":"object","properties":{"userId":{"type":"string","description":"Target user ID for new owner"},"token":{"type":"string","description":"Token for transfer operation"}}},"AddDeviceWithSiteBySnOpenApiVO":{"type":"object","properties":{"siteId":{"type":"string","description":"Site ID"},"sn":{"pattern":"^[A-Z0-9]{13}$","type":"string","description":"Device serial number. It should contains 13 characters."},"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"Device name should contain 1 to 128 characters."},"username":{"type":"string","description":"Device username. It should contain 1 to 128 characters."},"password":{"type":"string","description":"Device password. It should contain 1 to 128 characters."}},"description":"Add devices list"},"DeviceListAddMultiSiteBySnOpenApiVO":{"required":["devices"],"type":"object","properties":{"devices":{"type":"array","description":"Add devices list","items":{"$ref":"#/components/schemas/AddDeviceWithSiteBySnOpenApiVO"}}}},"ActiveDeviceMultiSiteOpenApiVO":{"required":["activePairList","category"],"type":"object","properties":{"activePairList":{"type":"array","items":{"$ref":"#/components/schemas/ActivePairMultiSiteOpenApiDTO"}},"category":{"type":"string","description":"It should be a value as follows: basic; ap; l2Switch; l3Switch; gateway"}}},"ActivePairMultiSiteOpenApiDTO":{"required":["deviceMac","licenseType"],"type":"object","properties":{"siteId":{"type":"string","description":"Site ID"},"deviceMac":{"type":"string","description":"Device MAC address, like AA-BB-CC-DD-EE-FF"},"licenseType":{"type":"string","description":"License type should be a value as follows: Cloud Based Controller(1year, 2years, 3years, 4years, 5years, others, trial); Local Controller(trial, permanent);"},"licenseId":{"type":"string","description":"License ID"}}},"MFAConfigOpenApiVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to turn on two-factor authentication for your account"}}},"SelfGlobalRestoreVO":{"required":["fileName"],"type":"object","properties":{"fileName":{"type":"string","description":"Site backup file name. Parameter [fileName] should be 1 - 128 ASCII characters."}}},"FileServerGlobalRestoreVO":{"required":["filePath","serverConfig","skipDevice"],"type":"object","properties":{"serverConfig":{"$ref":"#/components/schemas/FileServerOpenApiVO"},"filePath":{"type":"string","description":"Saving directory path for backup file. Parameter [filePath] should be 1 - 128 ASCII characters."},"skipDevice":{"type":"boolean","description":"Whether skip import devices."}}},"SelfGlobalBackupVO":{"required":["retainUser"],"type":"object","properties":{"retainUser":{"type":"boolean","description":"Whether saving user info."}}},"FileServerGlobalBackupVO":{"required":["filePath","serverConfig"],"type":"object","properties":{"serverConfig":{"$ref":"#/components/schemas/FileServerOpenApiVO"},"filePath":{"type":"string","description":"Saving directory path for backup file. Parameter [filePath] should be 1 - 128 ASCII characters."},"retainUser":{"type":"boolean","description":"Whether need retain user info."},"retainAuthRecord":{"type":"boolean","description":"Whether need retain auth record."},"retainFirmwareLog":{"type":"boolean","description":"Whether need retain firmware log."},"retention":{"type":"integer","description":"Backup data retention, values are as follows: 0 :no limit others:7，30，60，90，180，365.","format":"int32"}}},"RollbackCreateInfo":{"required":["scheduleType","targetVersion"],"type":"object","properties":{"year":{"type":"integer","description":"User selected year","format":"int32"},"monthOfYear":{"type":"integer","description":"The month of the year selected by the user, It should be within the range of 1-12","format":"int32"},"dayOfMonth":{"type":"integer","description":"The day of the month selected by the user, It should be within the range of 1-31","format":"int32"},"hour":{"type":"integer","description":"The hour selected by the user, It should be within the range of 0-23","format":"int32"},"minute":{"type":"integer","description":"The minute selected by the user, It should be within the range of 0-59","format":"int32"},"scheduleType":{"type":"integer","description":"The type of execution time for the upgrade, where 0 represents now and 1 represents the specified time","format":"int32"},"targetVersion":{"type":"string","description":"User selected rollback version, It should not be null"}}},"FailedCreateModelPlanUpgradeInfo":{"required":["scheduleType"],"type":"object","properties":{"year":{"type":"integer","description":"The year selected by the user","format":"int32"},"monthOfYear":{"type":"integer","description":"The month of the year selected by the user, It should be within the range of 1-12","format":"int32"},"dayOfMonth":{"type":"integer","description":"The day of the month selected by the user, It should be within the range of 1-31","format":"int32"},"hour":{"type":"integer","description":"The hour of the day selected by the user, It should be within the range of 0-23","format":"int32"},"minute":{"type":"integer","description":"The minute in the hour selected by the user, It should be within the range of 0-59","format":"int32"},"scheduleType":{"type":"integer","description":"The type of upgrade execution time, where 0 represents now and 1 represents the specified time","format":"int32"}}},"CreateFailedDeviceUpgradePlan":{"type":"object","properties":{"upgradeIdList":{"type":"array","description":"Upgrade ID list","items":{"type":"string","description":"Upgrade ID list"}}}},"OperationResponseCreateFailedDeviceUpgradePlan":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CreateFailedDeviceUpgradePlan"}}},"ExportLogOpenApiVO":{"required":["format","siteIds"],"type":"object","properties":{"siteIds":{"type":"array","description":"Parameter [siteIds] indicates site IDs that need to export log results.","items":{"type":"string","description":"Parameter [siteIds] indicates site IDs that need to export log results."}},"format":{"type":"integer","description":"Parameter [format] indicates the type of the exported file. 0: CSV, 1: xlsx.","format":"int32"}}},"LicenseAutoActiveOpenApiVO":{"required":["autoActive"],"type":"object","properties":{"autoActive":{"type":"boolean"}}},"DeleteGlobalThreatOpenApiVO":{"type":"object","properties":{"threatId":{"type":"array","description":"The global view needs to pass in a site ID.","items":{"$ref":"#/components/schemas/SiteTimeIdOpenApiVO"}}}},"SiteTimeIdOpenApiVO":{"type":"object","properties":{"time":{"type":"integer","description":"Time.","format":"int64"},"id":{"type":"string","description":"ID."},"siteId":{"type":"string","description":"Site ID."}},"description":"The global view needs to pass in a site ID."},"OperateGlobalThreatOpenApiVO":{"required":["type"],"type":"object","properties":{"threatId":{"type":"array","description":"The global view needs to pass in a siteId.","items":{"$ref":"#/components/schemas/SiteTimeIdOpenApiVO"}},"type":{"type":"integer","description":"type,0 - block, 1 - isolate device, 2 - allow from all ips, 3 - allow this ip.","format":"int32"},"signatureSuppression":{"$ref":"#/components/schemas/SignatureSuppression"},"blockName":{"type":"string","description":"Block Name."}}},"PlanFirmwareUpgradeCreateInfo":{"required":["scheduleType","sites"],"type":"object","properties":{"sites":{"type":"array","description":"List of site ID selected by the user","items":{"type":"string","description":"List of site ID selected by the user"}},"year":{"type":"integer","description":"The year selected by the user","format":"int32"},"monthOfYear":{"type":"integer","description":"The month of the year selected by the user, It should be within the range of 1-12","format":"int32"},"dayOfMonth":{"type":"integer","description":"The day of the month selected by the user, It should be within the range of 1-31","format":"int32"},"hour":{"type":"integer","description":"The hour of the day selected by the user, It should be within the range of 0-23","format":"int32"},"minute":{"type":"integer","description":"The minute in the hour selected by the user, It should be within the range of 0-59","format":"int32"},"scheduleType":{"type":"integer","description":"The type of upgrade execution time, where 0 represents now and 1 represents the specified time","format":"int32"}}},"OperationResponseUploadFirmwareResInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/UploadFirmwareResInfo"}}},"UploadFirmwareResInfo":{"type":"object","properties":{"id":{"type":"string","description":"The ID returned from uploading the upgrade file."}}},"OperationResponseUploadCertResponseOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/UploadCertResponseOpenApiVO"}}},"UploadCertResponseOpenApiVO":{"type":"object","properties":{"caCertFileId":{"type":"string","description":"CA certificate profile file id."},"clientCertFileId":{"type":"string","description":"Client certificate profile file id."},"privateKeyFileId":{"type":"string","description":"Client Private key file id."}},"description":"UploadCertResponseOpenApiVO"},"Export RF planning history openapi VO":{"required":["export_format"],"type":"object","properties":{"type":{"type":"string","description":"Export policy, type should be a value as follows:, all: export all history, include: export history in ids, exclude: exclude history in ids."},"export_format":{"type":"integer","description":"Export file format, should be a value as follows: 0: csv, 1: xlsx","format":"int32"},"history_ids":{"type":"array","description":"RfPlanningHistoryId list","items":{"type":"string","description":"RfPlanningHistoryId list"}},"start":{"type":"integer","description":"Start time of history to export (millisecond timestamp)","format":"int64"},"end":{"type":"integer","description":"End time of history to export (millisecond timestamp)","format":"int64"},"filter_mode":{"type":"integer","description":"filtermode should be a value as follows: 1: rfPlanningHistory mode is manual; 2:rfPlanningHistory mode is adaptive","format":"int32"}}},"ClientExportOpenApiVO":{"required":["format","tables"],"type":"object","properties":{"format":{"type":"integer","description":"Format should be a value as follows: 0: csv; 1: xlsx.","format":"int32"},"tables":{"maxItems":5,"minItems":1,"type":"array","description":"Tables should be a list of follows: 0: online; 1: offline; 2: blocked; 3: past-connection, 4: past-portal-auth.","items":{"maximum":5,"minimum":1,"type":"integer","description":"Tables should be a list of follows: 0: online; 1: offline; 2: blocked; 3: past-connection, 4: past-portal-auth.","format":"int32"}}}},"DownloadCaptureFileConfig":{"required":["requestId"],"type":"object","properties":{"requestId":{"type":"string","description":"A GUID based on the timestamp."},"stack":{"type":"boolean","description":"Parameter [stack] indicates whether the device supports stacking."}}},"Required Parameters for Exporting Rogue AP Scan Results":{"type":"object","properties":{"siteIds":{"type":"array","description":"Parameter [siteIds] indicates site IDs that need to export rogue AP scan results.","items":{"type":"string","description":"Parameter [siteIds] indicates site IDs that need to export rogue AP scan results."}},"format":{"type":"integer","description":"Parameter [format] indicates the type of the exported file. 0: CSV, 1: xlsx.","format":"int32"}}},"ExportVoucherOpenApiVO":{"required":["format","type"],"type":"object","properties":{"format":{"type":"integer","description":"Export file format, should be a value as follows: 0: csv, 1: xlsx","format":"int32"},"queryData":{"$ref":"#/components/schemas/OpenApiQueryDataVO"},"type":{"type":"integer","description":"Select type. It should be a value as follows: 0: Represents selecting all voucher groups, this selection does not pass parameter [groupIds]. 1: Parameter [groupIds] includes the IDs of the voucher groups to be selected. 2: Parameter [groupIds] includes the IDs of the voucher groups not to be selected","format":"int32"},"groupIds":{"type":"array","description":"ID list of voucher groups. Voucher group can be created using 'Create Voucher Group' interface, and Voucher Group ID can be obtained from 'Get Voucher Group list' interface","items":{"type":"string","description":"ID list of voucher groups. Voucher group can be created using 'Create Voucher Group' interface, and Voucher Group ID can be obtained from 'Get Voucher Group list' interface"}}}},"ExportClientListOpenApiVO":{"required":["format","mode","siteIds"],"type":"object","properties":{"siteIds":{"type":"array","description":"IDs of the site of the data to be exported.","items":{"type":"string","description":"IDs of the site of the data to be exported."}},"mode":{"type":"integer","description":"Export columns mode. 0：All Columns  1: CurrentDisplayColumns.","format":"int32"},"clientsDisplay":{"type":"array","description":"The information of client list for export.","items":{"type":"string","description":"The information of client list for export."}},"format":{"type":"integer","description":"Format of file exported.0: CSV 1: XLSX","format":"int32"},"queryDataVO":{"$ref":"#/components/schemas/OpenApiQueryDataVO"}}},"MultiSiteClientExportOpenApiVO":{"required":["format","mode","selectType","siteIds"],"type":"object","properties":{"format":{"type":"integer","description":"Format should be a value as follows: 0: csv; 1: xlsx.","format":"int32"},"clientsDisplay":{"type":"array","description":"The information of client list for export.","items":{"type":"string","description":"The information of client list for export."}},"clientsDisplayOverride":{"type":"object","additionalProperties":{"type":"array","description":"Override the export columns for given siteIds.","items":{"type":"string","description":"Override the export columns for given siteIds."}},"description":"Override the export columns for given siteIds."},"mode":{"type":"integer","description":"Export columns mode. 0：All Columns  1: CurrentDisplayColumns.","format":"int32"},"selectType":{"type":"string","description":"Select type of the sites of clients to export. include: include selected sites, exclude: all but exclude selected sites, all: include all sites."},"siteIds":{"type":"array","description":"List of site id to export. SiteIds should contains at least 1 element when [selectType] is \"include\".","items":{"type":"string","description":"List of site id to export. SiteIds should contains at least 1 element when [selectType] is \"include\"."}}}},"BindOwnerOpenApiVO":{"required":["accountName","password"],"type":"object","properties":{"accountName":{"type":"string","description":"account name"},"password":{"type":"string","description":"account password"}}},"Global Device Item":{"required":["mac","siteId"],"type":"object","properties":{"mac":{"type":"string","description":"Mac of device."},"siteId":{"type":"string","description":"SiteId of device."}},"description":"Devices to query"},"GlobalDevicesQueryOpenApiVO":{"required":["devices"],"type":"object","properties":{"devices":{"maxItems":1000,"minItems":1,"type":"array","description":"Devices to query","items":{"$ref":"#/components/schemas/Global Device Item"}}}},"DeviceClientNumOpenApiVO":{"type":"object","properties":{"siteId":{"type":"string","description":"Site id of the device"},"mac":{"type":"string","description":"MAC address of the device"},"clientNum":{"type":"integer","description":"Client number of the device","format":"int32"},"clientNum2g":{"type":"integer","description":"Client number under 2g of the device","format":"int32"},"clientNum5g":{"type":"integer","description":"Client number under 5g of the device","format":"int32"},"clientNum5g2":{"type":"integer","description":"Client number under 5g2 of the device","format":"int32"},"clientNum6g":{"type":"integer","description":"Client number under 6g of the device","format":"int32"}},"description":"Client number under the device"},"OperationResponseListDeviceClientNumOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/DeviceClientNumOpenApiVO"}}}},"Batch request entity":{"type":"object","properties":{"interrupt":{"type":"boolean","description":"Indicates whether to interrupt execution when encountering an error while executing openAPI, defaults to true"},"actions":{"type":"array","description":"List of OpenAPIs that require batch execution. Up to 20 entries are allowed for the action list","items":{"$ref":"#/components/schemas/Request action entity"}}}},"Request action entity":{"required":["method","path"],"type":"object","properties":{"path":{"type":"string","description":"OpenAPI request path. Same as regular OpenAPI, file upload and download are not supported."},"method":{"type":"string","description":"OpenAPI request method. Same as regular OpenAPI, it should be a value as follows: POST, PATCH, PUT, DELETE."},"body":{"type":"string","description":"OpenAPI request body, same as regular OpenAPI. Should be a JSON object but not a string."},"query":{"type":"string","description":"OpenAPI request query of the path, same as regular OpenAPI."}},"description":"List of OpenAPIs that require batch execution. Up to 20 entries are allowed for the action list"},"Batch response entity":{"type":"object","properties":{"response":{"type":"array","description":"A response list","items":{"$ref":"#/components/schemas/OperationResponseObject"}}}},"OperationResponseBatch Response Entity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Batch response entity"}}},"AutoBackupOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether enable backup schedule task"},"occurrence":{"$ref":"#/components/schemas/BaseScheduleTimeVO"},"maxNumberOfFile":{"type":"integer","description":"Max number of schedule backup files","format":"int32"},"retention":{"type":"integer","description":"Retention setting for data, values are as follows: -1 retention settings only, 0 backup all data, only for software controller, 7 retention backup data for 7 days, 30 retention backup data for 30 days, 60 retention backup data for 60 days, 90 retention backup data for 90 days, 180 retention backup data for 180 days, 365 retention backup data for 365 days","format":"int32"},"savingPath":{"type":"string","description":"Saving path for backup schedule"},"availablePaths":{"type":"array","description":"Available paths for backup schedule","items":{"type":"string","description":"Available paths for backup schedule"}},"fileServerConfig":{"$ref":"#/components/schemas/FileServerOpenApiVO"},"storageType":{"type":"integer","description":"Storage type, values are as follows: 0 for file server, 1 for cloud server(only for Cloud based controller), 2 for local disk, null for default path","format":"int32"},"dataSheets":{"type":"array","description":"Data to backup, values are as follows: knowClient, omadaLog, auditLog.","items":{"type":"string","description":"Data to backup, values are as follows: knowClient, omadaLog, auditLog."}},"retainSetting":{"type":"boolean","description":"Whether retain setting when backup."},"retainUser":{"type":"boolean","description":"Whether retain user when backup."},"retainAuthRecord":{"type":"boolean","description":"Whether retain auth record when backup."},"retainFirmwareLog":{"type":"boolean","description":"Whether retain firmware log when backup."}}},"BaseScheduleTimeVO":{"required":["hour","minute","timingType"],"type":"object","properties":{"timingType":{"type":"integer","description":"Time type for schedule task, values are as follows:  Daily(1), Weekly(2), Monthly(3), Yearly(4)","format":"int32"},"hour":{"type":"integer","description":"Hour when schedule execute, value is between 0 to 23","format":"int32"},"minute":{"type":"integer","description":"Minute when schedule execute, value is between 0 to 59","format":"int32"},"dayOfWeek":{"type":"integer","description":"Day of week when schedule execute, only for timingType: Weekly(2), value is between 0 to 6","format":"int32"},"dayOfMonth":{"type":"integer","description":"Day of month when schedule execute, only for timingType: Monthly(3), value is between 1 to 31","format":"int32"},"monthOfYear":{"type":"integer","description":"Month of year when schedule execute, only for timingType: Yearly(4), value is between 1 to 12","format":"int32"}},"description":"Backup schedule time occurrence"},"CreateMspUserVO":{"required":["allCustomer","customerRoleId","name","roleId","type"],"type":"object","properties":{"type":{"type":"integer","description":"Type of user should be a value as follows: 0:local user; 1: cloud user","format":"int32"},"name":{"pattern":"^(?![+=@-])[\\041-\\0176]$|^(?![+=@-])[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"User name. When creating cloud user, you should set TP-LINK ID. It should contain 1 to 128 ASCII visible characters and start with letters, numbers, and underscores."},"password":{"pattern":"^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?=.*[\\!\\#\\$\\%\\&\\'\\(\\)\\*\\+\\,\\-\\.\\/\\:\\;\\<\\=\\>\\@\\[\\\\\\]\\^\\_\\`\\{\\|\\}\\~])(?!.*[\\00-\\040\\042\\077\\0177]).{8,128}$","type":"string","description":"Password of local user should contain 8 to 128 ASCII visible characters.And password must be a combination of uppercase letters, lowercase letters, numbers, and special symbols. Symbols such as ! # $ % & * @ ^ are supported."},"email":{"type":"string","description":"Email of user"},"roleId":{"type":"string","description":"Msp role ID of user"},"customerRoleId":{"type":"string","description":"Msp user's customer role ID when visit customer"},"allCustomer":{"type":"boolean","description":"Whether msp user has all customer permission, including new created customer."},"customers":{"uniqueItems":true,"type":"array","description":"User customer privilege list","items":{"type":"string","description":"User customer privilege list"}},"alert":{"type":"boolean","description":"Whether this user wants to receive alert, event, and incident emails. Make sure your email is not null."},"temporaryEnable":{"type":"boolean","description":"Whether the user wants to enable the temporary worker permission"},"startTime":{"type":"integer","description":"The start time of the user's validity period. time range: start timestamp (Millisecond).","format":"int64"},"endTime":{"type":"integer","description":"The end time of the user's validity period. time range: end timestamp (Millisecond).","format":"int64"}}},"ModifyMspRoleVO":{"required":["name","privilege"],"type":"object","properties":{"name":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"Role name should contain 1 to 128 ASCII characters."},"privilege":{"$ref":"#/components/schemas/MspRoleVO"}}},"MspRoleVO":{"type":"object","properties":{"mspDashboard":{"type":"integer","description":"Msp dashboard permission. It should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspDevice":{"type":"integer","description":"Msp device. It should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspLog":{"type":"integer","description":"Msp log. It should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspLicense":{"type":"integer","description":"Msp license. It should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspLicenseBind":{"type":"integer","description":"msp license bind","format":"int32"},"mspAdopt":{"type":"integer","description":"Msp adopt. It should be a value as follows: 0:block; 2:access","format":"int32","deprecated":true},"mspAddDevices":{"type":"integer","description":"Msp add devices. It should be a value as follows: 0:block; 2:access","format":"int32","deprecated":true},"mspAddAdoptDevice":{"type":"integer","description":"Msp add and adopt devices. It should be a value as follows: 0:block; 2:access","format":"int32"},"mspUsers":{"type":"integer","description":"Msp users. It should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspRoles":{"type":"integer","description":"Msp roles. It should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspSamlUsers":{"type":"integer","description":"Saml users in msp view. It should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspSamlRoles":{"type":"integer","description":"Saml roles in msp view. It should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspSamlSsos":{"type":"integer","description":"Saml ssos in msp view. It should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspSetting":{"type":"integer","description":"Msp setting. It should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspExportData":{"type":"integer","description":"Export data in msp view. It should be a value as follows: 0:block; 2:access","format":"int32"},"mspWebhook":{"type":"integer","description":"Msp webhook. It should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"},"mspSites":{"type":"integer","description":"Msp sites. It should be a value as follows: 0:block; 2:access","format":"int32"},"mspCluster":{"type":"integer","description":"msp cluster, 0:block; 1:view only; 2:modify","format":"int32"},"aiAssi":{"type":"integer","description":"AI Assistant, it should be a value as follows: 0:block; 1:view only; 2:modify","format":"int32"}},"description":"Role privilege."},"ExportMspLogOpenApiVO":{"required":["format"],"type":"object","properties":{"format":{"type":"integer","description":"Parameter [format] indicates the type of the exported file. 0: CSV, 1: xlsx.","format":"int32"}}},"ResolveMspLogListOpenApiVO":{"required":["endTime","selectType","startTime"],"type":"object","properties":{"logs":{"type":"array","description":"Select the logs to resolve; Log ID list can be obtained from 'Get MSP alert log list' interface.","items":{"type":"string","description":"Select the logs to resolve; Log ID list can be obtained from 'Get MSP alert log list' interface."}},"selectType":{"type":"string","description":"Select type of logs. include: include selected logs, exclude: all but exclude selected logs, all: include all logs(Parameter [logs] need input '[]')."},"startTime":{"type":"integer","description":"The start timeStamp of the resolve msp alert log, unit: MS.","format":"int64"},"endTime":{"type":"integer","description":"The end timeStamp of the resolve msp alert log, unit: MS.","format":"int64"},"filterModule":{"type":"string","description":"The module of the resolve msp alert log; It is required when [selectType] is 'all', filterModule should be a value as follows: 'System' or 'Device'."}}},"LicenseCategoryOtherIdsOpenApiVO":{"type":"object","properties":{"licenseKeyList":{"type":"array","description":"License key list","items":{"type":"string","description":"License key list"}},"selectAll":{"type":"boolean","description":"Select all used license"},"total":{"minimum":0,"type":"integer","description":"Total select used license","format":"int32"}},"description":"Gateway used license"},"LicenseNumOpenApiVO":{"required":["type"],"type":"object","properties":{"basic":{"minimum":0,"type":"integer","description":"Basic","format":"int32"},"ap":{"minimum":0,"type":"integer","description":"Pro ap","format":"int32"},"l2Switch":{"minimum":0,"type":"integer","description":"Pro l2Switch","format":"int32"},"l3Switch":{"minimum":0,"type":"integer","description":"Pro l3Switch","format":"int32"},"gateway":{"minimum":0,"type":"integer","description":"Pro gateway","format":"int32"},"type":{"type":"string","description":"Type should be a value as follows: 1year; 2years; 3years; 4years; 5years; trial"}},"description":"License num"},"LicenseOthersIdsOpenApiVO":{"type":"object","properties":{"basic":{"$ref":"#/components/schemas/LicenseCategoryOtherIdsOpenApiVO"},"ap":{"$ref":"#/components/schemas/LicenseCategoryOtherIdsOpenApiVO"},"l2Switch":{"$ref":"#/components/schemas/LicenseCategoryOtherIdsOpenApiVO"},"l3Switch":{"$ref":"#/components/schemas/LicenseCategoryOtherIdsOpenApiVO"},"gateway":{"$ref":"#/components/schemas/LicenseCategoryOtherIdsOpenApiVO"}},"description":"Used license"},"LicenseRecycleOpenApiVO":{"required":["customerId","licenseNum","others"],"type":"object","properties":{"customerId":{"type":"string","description":"Customer ID"},"licenseNum":{"type":"array","description":"License num","items":{"$ref":"#/components/schemas/LicenseNumOpenApiVO"}},"others":{"$ref":"#/components/schemas/LicenseOthersIdsOpenApiVO"}}},"LicenseAssignmentOpenApiVO":{"required":["customerId","licenseNum","others"],"type":"object","properties":{"customerId":{"type":"string","description":"Customer ID"},"licenseNum":{"type":"array","description":"License num","items":{"$ref":"#/components/schemas/LicenseNumOpenApiVO"}},"others":{"$ref":"#/components/schemas/LicenseOthersIdsOpenApiVO"}}},"MspDeviceIncidentCountItemOpenApiVO":{"required":["customerId","mac"],"type":"object","properties":{"customerId":{"type":"string","description":"Customer ID"},"mac":{"type":"string","description":"Device MAC address for which the incident count is requested."}},"description":"Devices grouped by their owning customer."},"MspDeviceIncidentCountRequestOpenApiVO":{"required":["deviceList"],"type":"object","properties":{"deviceList":{"type":"array","description":"Devices grouped by their owning customer.","items":{"$ref":"#/components/schemas/MspDeviceIncidentCountItemOpenApiVO"}}}},"CustomerOpenApiVO":{"type":"object","properties":{"customerName":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,30}[^ ]$","type":"string","description":"Customer name should contain 1 to 32 characters."},"description":{"pattern":"^$|^[^ ]$|^[^ ].*\\r?\\n?.*{0,126}[^ ]$","type":"string","description":"Customer description should contain 1 to 128 characters."}}},"CreateCustomerOmadacVO":{"type":"object","properties":{"customerId":{"type":"string"}}},"OperationResponseCreateCustomerOmadacVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CreateCustomerOmadacVO"}}},"MspAddDeviceListOpenApiVO":{"required":["devices"],"type":"object","properties":{"devices":{"type":"array","description":"Add devices list","items":{"$ref":"#/components/schemas/AddDeviceVO"}},"keepResult":{"type":"boolean","description":"Save the last result"},"allowOffline":{"type":"boolean","description":"Whether to allow offline addition. The default value is False"},"verifyCode":{"type":"string","deprecated":true},"addType":{"type":"integer","description":"0/null indicates SN, and 1 indicates deviceKey","format":"int32"},"mspId":{"type":"string","description":"MSP ID"}}},"MoveToCustomerOpenApiVO":{"required":["customer","site"],"type":"object","properties":{"deviceMacs":{"maxItems":1,"minItems":1,"type":"array","description":"Mac adress of the device.","deprecated":true,"items":{"maxLength":1,"minLength":1,"type":"string","description":"Mac adress of the device.","deprecated":true}},"deviceMac":{"type":"string","description":"Mac adress of the device. If [deviceMac] is not empty, it takes effect with a higher priority than [deviceMacs]."},"customer":{"type":"string","description":"Target customer id."},"site":{"type":"string","description":"Target site id."}}},"MoveToCustomerVO":{"required":["customer","deviceMacs","site"],"type":"object","properties":{"deviceMacs":{"maxItems":1,"minItems":1,"type":"array","description":"DeviceMacs should contain 1 entry","items":{"maxLength":1,"minLength":1,"type":"string","description":"DeviceMacs should contain 1 entry"}},"customer":{"type":"string","description":"Target customer ID"},"site":{"type":"string","description":"Target site ID"}}},"CustomerCopyOpenapiVO":{"required":["newCustomerName","sourceCustomerId"],"type":"object","properties":{"newCustomerName":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,30}[^ ]$","type":"string","description":"New Customer name should contain 1 to 31 characters."},"description":{"pattern":"^$|^[^ ]$|^[^ ].*\\r?\\n?.*{0,126}[^ ]$","type":"string","description":"Customer description should contain 1 to 128 characters."},"sourceCustomerId":{"type":"string","description":"Source customer ID to be copied."}}},"CustomerCopyOpenapiResVO":{"type":"object","properties":{"customerId":{"type":"string","description":"The ID of the newly copied customer."}}},"OperationResponseCustomerCopyOpenapiResVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CustomerCopyOpenapiResVO"}}},"CustomerQueryOpenApiVO":{"required":["customerIds"],"type":"object","properties":{"customerIds":{"type":"array","description":"Customer Ids to get client number.","items":{"type":"string","description":"Customer Ids to get client number."}}}},"CustomerListClientNumVO":{"type":"object","properties":{"customerId":{"type":"string"},"wiredUser":{"type":"integer","format":"int32"},"wirelessUser":{"type":"integer","format":"int32"},"wirelessGuest":{"type":"integer","format":"int32"}}},"OperationResponseListCustomerListClientNumVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/CustomerListClientNumVO"}}}},"Msp Device Item":{"required":["customerId","mac","siteId"],"type":"object","properties":{"mac":{"type":"string","description":"Mac of device."},"siteId":{"type":"string","description":"SiteId of device."},"customerId":{"type":"string","description":"CustomerId of device."}},"description":"Devices to query"},"MspDevicesQueryOpenApiVO":{"required":["devices"],"type":"object","properties":{"devices":{"maxItems":1000,"minItems":1,"type":"array","description":"Devices to query","items":{"$ref":"#/components/schemas/Msp Device Item"}}}},"MspDeviceClientNumOpenApiVO":{"type":"object","properties":{"customerId":{"type":"string","description":"Customer id of the device"},"siteId":{"type":"string","description":"Site id of the device"},"mac":{"type":"string","description":"MAC address of the device"},"clientNum":{"type":"integer","description":"Client number of the device","format":"int32"},"clientNum2g":{"type":"integer","description":"Client number under 2g of the device","format":"int32"},"clientNum5g":{"type":"integer","description":"Client number under 5g of the device","format":"int32"},"clientNum5g2":{"type":"integer","description":"Client number under 5g2 of the device","format":"int32"},"clientNum6g":{"type":"integer","description":"Client number under 6g of the device","format":"int32"}},"description":"Client number under the device for MSP"},"OperationResponseListMspDeviceClientNumOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/MspDeviceClientNumOpenApiVO"}}}},"CreateOmadacRequestDTO":{"type":"object","properties":{"accountId":{"type":"string"},"orgId":{"type":"string"},"email":{"type":"string"},"areaInfo":{"type":"string"},"category":{"type":"string"},"type":{"type":"integer","format":"int32"}}},"CreateOmadacResponseDTO":{"type":"object","properties":{"customizeOmadacId":{"type":"string"},"url":{"type":"string"},"controllerId":{"type":"string"},"embedWeb":{"type":"boolean"}}},"OperationResponseCreateOmadacResponseDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CreateOmadacResponseDTO"}}},"AcceptInviteRequestDTO":{"type":"object","properties":{"customizeOmadacId":{"type":"string"},"email":{"type":"string"},"accountId":{"type":"string"},"areaInfo":{"type":"string"}}},"LogoutControllerRequestDTO":{"type":"object","properties":{"customizeOmadacId":{"type":"string"},"tokens":{"type":"array","items":{"type":"string"}}}},"CreateOmadacWithWizardRequestDTO":{"type":"object","properties":{"accountId":{"type":"string"},"orgId":{"type":"string"},"email":{"type":"string"},"areaInfo":{"type":"string"},"name":{"type":"string"},"region":{"type":"string"},"timeZone":{"type":"string"},"expImprove":{"type":"boolean"},"category":{"type":"string"},"type":{"type":"integer","format":"int32"}}},"UpdateSessionRequestDTO":{"required":["accountId","idleTimeout"],"type":"object","properties":{"accountId":{"type":"string"},"idleTimeout":{"type":"integer","format":"int64"}}},"AddProWhitelistDTO":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string"}}}},"QueryByControllerIdsDTO":{"type":"object","properties":{"accountId":{"type":"string"},"customizeOmadacIds":{"type":"array","items":{"type":"string"}},"query":{"type":"string"},"category":{"type":"string"},"needOmadacCategory":{"type":"boolean"},"showCentral":{"type":"boolean"}}},"OmadacBasicInfoDTO":{"type":"object","properties":{"customizeOmadacId":{"type":"string"},"controllerName":{"type":"string"},"controllerId":{"type":"string"},"controllerVersion":{"type":"string"},"role":{"type":"integer","format":"int32"},"siteNum":{"type":"integer","format":"int64"},"deviceNum":{"type":"integer","format":"int64"},"clientNum":{"type":"integer","format":"int64"},"alertNum":{"type":"integer","format":"int64"},"alertObscured":{"type":"boolean"},"configured":{"type":"boolean"},"url":{"type":"string"},"areaInfo":{"type":"string"},"isAutoActive":{"type":"boolean"},"category":{"type":"string"},"customerNum":{"type":"integer","format":"int64"},"mspMode":{"type":"boolean"},"timeZone":{"type":"string"},"informUrl":{"type":"string"},"disconnectedDeviceNum":{"type":"integer","format":"int64"},"connectedDeviceNum":{"type":"integer","format":"int64"},"guestNum":{"type":"integer","format":"int64"},"deviceUpgrade":{"type":"boolean"},"hasMspPermission":{"type":"boolean"},"apiProtocol":{"type":"string"},"type":{"type":"integer","format":"int32"},"embedWeb":{"type":"boolean"}}},"OmadacBasicInfoResponseDTO":{"type":"object","properties":{"totalNum":{"type":"integer","format":"int32"},"omadacs":{"type":"array","items":{"$ref":"#/components/schemas/OmadacBasicInfoDTO"}}}},"OperationResponseOmadacBasicInfoResponseDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OmadacBasicInfoResponseDTO"}}},"LicenseDetailDTO":{"type":"object","properties":{"licenseId":{"type":"string"},"duration":{"type":"integer","format":"int32"},"durationUnit":{"type":"integer","format":"int32"},"expirationTime":{"type":"integer","format":"int64"},"category":{"type":"string"},"active":{"type":"boolean"}}},"LicenseNumDTO":{"type":"object","properties":{"ap":{"minimum":0,"type":"integer","format":"int32"},"l2Switch":{"minimum":0,"type":"integer","format":"int32"},"l3Switch":{"minimum":0,"type":"integer","format":"int32"},"gateway":{"minimum":0,"type":"integer","format":"int32"},"basic":{"minimum":0,"type":"integer","format":"int32"},"pro":{"minimum":0,"type":"integer","format":"int32"},"ipc":{"minimum":0,"type":"integer","format":"int32"}}},"SaveLicenseImportedRecordDTO":{"type":"object","properties":{"omadacId":{"type":"string"},"time":{"type":"integer","format":"int64"},"licenseNumVO":{"$ref":"#/components/schemas/LicenseNumDTO"},"operator":{"type":"string"},"operation":{"type":"integer","format":"int32"},"activationCode":{"type":"string"},"licenseDetails":{"type":"array","items":{"$ref":"#/components/schemas/LicenseDetailDTO"}}}},"GetDevicesRequestDTO":{"type":"object","properties":{"accountId":{"type":"string"},"ownerId":{"type":"string"},"macs":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"GetDevicesResponseDTO":{"type":"object","properties":{"deviceList":{"type":"array","items":{"$ref":"#/components/schemas/OmadacDeviceInfoDTO"}},"totalNum":{"type":"integer","format":"int32"}}},"OmadacDeviceInfoDTO":{"type":"object","properties":{"deviceMac":{"type":"string"},"deviceName":{"type":"string"},"deviceType":{"type":"string"},"deviceModel":{"type":"string"},"deviceHwVer":{"type":"string"},"siteId":{"type":"string"},"siteName":{"type":"string"},"omadacId":{"type":"string"},"controllerId":{"type":"string"},"controllerName":{"type":"string"},"lastSeen":{"type":"integer","format":"int64"}}},"OperationResponseGetDevicesResponseDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GetDevicesResponseDTO"}}},"DeleteDeviceRecordRequest":{"type":"object","properties":{"mac":{"type":"string"},"orgCategory":{"type":"string"}}},"DeviceInternalResponse":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"object"}}},"CheckDeviceBindRequest":{"type":"object","properties":{"deviceMacList":{"type":"array","items":{"type":"string"}},"orgCategory":{"type":"string"}}},"DeviceBindStatusDTO":{"type":"object","properties":{"mac":{"type":"string"},"bound":{"type":"boolean"},"omadacId":{"type":"string"},"omadacName":{"type":"string"},"accountId":{"type":"string"}}},"DeviceInternalResponseListDeviceBindStatusDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/DeviceBindStatusDTO"}}}},"OswLagBasicVO":{"required":["lagId"],"type":"object","properties":{"lagId":{"type":"integer","description":"Lag ID","format":"int32"},"ports":{"uniqueItems":true,"type":"array","description":"Lag ports","items":{"type":"integer","description":"Lag ports","format":"int32"}},"lagType":{"type":"integer","description":"LagType should be a value as follows: 1: Static LAG; 2: LACP; 3: LACP-Active; 4: LACP-Passive","format":"int32"},"mlagName":{"type":"string","description":"M-LAG group Name"},"mlagEnable":{"type":"boolean","description":"Indicates whether M-LAG port is enabled"},"mlagPeerSetting":{"$ref":"#/components/schemas/OswMlagPeerSettingVO"}},"description":"Lag Setting"},"StackPortSettingVO":{"type":"object","properties":{"name":{"pattern":"^[^ ?\"]$|^[^ ?\"][^?\"]{0,126}[^ ?\"]$","type":"string","description":"Port or Lag Name"},"tagIds":{"type":"array","description":"Tag ID List","items":{"type":"string","description":"Tag ID List"}},"nativeNetworkId":{"type":"string","description":"Native Network ID, Native Network cannot be selected from Tagged Networks or Untagged Networks."},"nativeBridgeVlan":{"type":"integer","description":"Native Network Bridge Vlan.","format":"int32"},"networkTagsSetting":{"type":"integer","description":"Network Tags Setting should be a value as follows: 0: Allow All; 1: Block All; 2: Custom","format":"int32"},"tagNetworkIds":{"type":"array","description":"Tag Network IDs","items":{"type":"string","description":"Tag Network IDs"}},"tagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Tag Network Bridge Vlan Map","items":{"type":"integer","description":"Tag Network Bridge Vlan Map","format":"int32"}},"description":"Tag Network Bridge Vlan Map"},"untagNetworkIds":{"type":"array","description":"Untag Network IDs","items":{"type":"string","description":"Untag Network IDs"}},"untagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Untag Network Bridge Vlan Map","items":{"type":"integer","description":"Untag Network Bridge Vlan Map","format":"int32"}},"description":"Untag Network Bridge Vlan Map"},"voiceNetworkEnable":{"type":"boolean","description":"Indicates whether voice network is enabled"},"voiceNetworkId":{"type":"string","description":"Voice Network ID"},"voiceBridgeVlan":{"type":"integer","description":"Voice Network Bridge Vlan","format":"int32"},"voiceDscpEnable":{"type":"boolean","description":"Indicates whether voice DSCP is enabled"},"voiceDscp":{"type":"integer","description":"Voice DSCP","format":"int32"},"portAlertEnable":{"type":"boolean","description":"Indicates whether port alert is enabled"},"fecMode":{"type":"integer","description":"FEC mode should be a value as follows: 1: Off; 2: RS528; 3: RS544; 4: Auto; 5: Base-R","format":"int32"},"fecLinkPeerApplyEnable":{"type":"boolean","description":"Indicates whether the FEC Mode is synchronously applied to the link peer port."},"disable":{"type":"boolean","description":"Indicates whether to disable"},"profileId":{"type":"string","description":"Profile ID is required (not null) when modifying a single port."},"profileOverrideEnable":{"type":"boolean","description":"Indicates whether to enable Profile Override before v6.2.10; Indicates the fill mode of port configuration after v6.2.10: true: custom; false: follow profile"},"profileVlanOverrideEnable":{"type":"boolean","description":"Indicates the fill mode of vlan configuration: true: custom; false: follow profile"},"linkSpeed":{"type":"integer","description":"Link Speed should be a value as follows: 0: auto; 1: 10M; 2: 100M; 3: 1000M; 4: 2.5G; 5: 10G","format":"int32"},"duplex":{"type":"integer","description":"Duplex should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"},"igmpSnoopingEnable":{"type":"boolean","description":"Indicates whether IGMP Snooping is enabled"},"bandWidthCtrlType":{"type":"integer","description":"BandWidthCtrlType should be a value as follows: 0: Off; 1: Rate Limit; 2: Storming Control","format":"int32"},"bandCtrl":{"$ref":"#/components/schemas/OswBandCtrlVO"},"stormCtrl":{"$ref":"#/components/schemas/OswStormCtrlVO"},"spanningTreeEnable":{"type":"boolean","description":"Indicates whether SpanningTree is enabled"},"spanningTreeSetting":{"$ref":"#/components/schemas/SpanningTreeSettingVO"},"loopbackDetectEnable":{"type":"boolean","description":"Indicates whether loopbackDetect port based is enabled"},"loopbackDetectVlanBasedEnable":{"type":"boolean","description":"Indicates whether loopbackDetect vlan based is enabled"},"igmpFastLeaveEnable":{"type":"boolean","description":"Indicates whether igmp fast leave is enabled"},"mldFastLeaveEnable":{"type":"boolean","description":"Indicates whether mld fast leave is enabled"},"portIsolationEnable":{"type":"boolean","description":"Indicates whether port isolation is enabled"},"eeeEnable":{"type":"boolean","description":"Indicates whether EEE is enabled"},"flowControlEnable":{"type":"boolean","description":"Indicates whether flow control is enabled"},"fastLeaveEnable":{"type":"boolean","description":"Indicates whether igmpSnooping fastLeave is enabled"},"dhcpL2RelaySettings":{"$ref":"#/components/schemas/OswPortDhcpL2RelayVO"},"dot1pPriority":{"type":"integer","description":"Dot1p Priority","format":"int32"},"trustMode":{"type":"integer","description":"TrustMode should be a value as follows: 0: Untrusted; 1: Trust 802.1p; 2: Trust DSCP","format":"int32"},"qosQueueEnable":{"type":"boolean","description":"Indicates whether the ES device port has enabled the Qos scheduling queue configuration"},"queueId":{"type":"integer","description":"ES Qos scheduling queue ID","format":"int32"},"removedOuiBasedRuleIds":{"type":"array","description":"The id of oui based vlan rule removded.","items":{"type":"string","description":"The id of oui based vlan rule removded."}},"operation":{"pattern":"switching|mirroring|aggregating","type":"string","description":"Operation should be a value as follows: \"switching\" or \"mirroring\" or \"aggregating\""},"mirroredPorts":{"uniqueItems":true,"type":"array","description":"Mirrored Ports","items":{"type":"integer","description":"Mirrored Ports","format":"int32"}},"mirroredLags":{"uniqueItems":true,"type":"array","description":"Mirrored Lags","items":{"type":"integer","description":"Mirrored Lags","format":"int32"}},"lagSetting":{"$ref":"#/components/schemas/OswLagBasicVO"},"lagDelete":{"type":"boolean","description":"When the operation changes from aggregating to switching, this parameter should be set to true, and the \"lagSetting\" parameter needs to include the lagId."},"dot1x":{"type":"integer","description":"Dot1x should be a value as follows: 0: Force unauthorized; 1: Force authorized; 2: Auto","format":"int32"},"poe":{"type":"integer","description":"Poe should be a value as follows: 0: Off; 1: 802.3at/af","format":"int32"},"lldpMedEnable":{"type":"boolean","description":"Indicates whether LLDP-MED is enabled"},"topoNotifyEnable":{"type":"boolean","description":"Indicates whether Topology Notify is enabled"},"mac":{"type":"string","description":"Mac address of the port. This parameter can be null when batch modify stack ports, but not null when modify a single stack port"},"stackSetting":{"$ref":"#/components/schemas/OswPortStackSettingVO"}}},"BatchStackPortSettingVO":{"required":["unitList"],"type":"object","properties":{"name":{"pattern":"^[^ ?\"]$|^[^ ?\"][^?\"]{0,126}[^ ?\"]$","type":"string","description":"Port or Lag Name"},"tagIds":{"type":"array","description":"Tag ID List","items":{"type":"string","description":"Tag ID List"}},"nativeNetworkId":{"type":"string","description":"Native Network ID, Native Network cannot be selected from Tagged Networks or Untagged Networks."},"nativeBridgeVlan":{"type":"integer","description":"Native Network Bridge Vlan.","format":"int32"},"networkTagsSetting":{"type":"integer","description":"Network Tags Setting should be a value as follows: 0: Allow All; 1: Block All; 2: Custom","format":"int32"},"tagNetworkIds":{"type":"array","description":"Tag Network IDs","items":{"type":"string","description":"Tag Network IDs"}},"tagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Tag Network Bridge Vlan Map","items":{"type":"integer","description":"Tag Network Bridge Vlan Map","format":"int32"}},"description":"Tag Network Bridge Vlan Map"},"untagNetworkIds":{"type":"array","description":"Untag Network IDs","items":{"type":"string","description":"Untag Network IDs"}},"untagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Untag Network Bridge Vlan Map","items":{"type":"integer","description":"Untag Network Bridge Vlan Map","format":"int32"}},"description":"Untag Network Bridge Vlan Map"},"voiceNetworkEnable":{"type":"boolean","description":"Indicates whether voice network is enabled"},"voiceNetworkId":{"type":"string","description":"Voice Network ID"},"voiceBridgeVlan":{"type":"integer","description":"Voice Network Bridge Vlan","format":"int32"},"voiceDscpEnable":{"type":"boolean","description":"Indicates whether voice DSCP is enabled"},"voiceDscp":{"type":"integer","description":"Voice DSCP","format":"int32"},"portAlertEnable":{"type":"boolean","description":"Indicates whether port alert is enabled"},"fecMode":{"type":"integer","description":"FEC mode should be a value as follows: 1: Off; 2: RS528; 3: RS544; 4: Auto; 5: Base-R","format":"int32"},"fecLinkPeerApplyEnable":{"type":"boolean","description":"Indicates whether the FEC Mode is synchronously applied to the link peer port."},"disable":{"type":"boolean","description":"Indicates whether to disable"},"profileId":{"type":"string","description":"Profile ID is required (not null) when modifying a single port."},"profileOverrideEnable":{"type":"boolean","description":"Indicates whether to enable Profile Override before v6.2.10; Indicates the fill mode of port configuration after v6.2.10: true: custom; false: follow profile"},"profileVlanOverrideEnable":{"type":"boolean","description":"Indicates the fill mode of vlan configuration: true: custom; false: follow profile"},"linkSpeed":{"type":"integer","description":"Link Speed should be a value as follows: 0: auto; 1: 10M; 2: 100M; 3: 1000M; 4: 2.5G; 5: 10G","format":"int32"},"duplex":{"type":"integer","description":"Duplex should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"},"igmpSnoopingEnable":{"type":"boolean","description":"Indicates whether IGMP Snooping is enabled"},"bandWidthCtrlType":{"type":"integer","description":"BandWidthCtrlType should be a value as follows: 0: Off; 1: Rate Limit; 2: Storming Control","format":"int32"},"bandCtrl":{"$ref":"#/components/schemas/OswBandCtrlVO"},"stormCtrl":{"$ref":"#/components/schemas/OswStormCtrlVO"},"spanningTreeEnable":{"type":"boolean","description":"Indicates whether SpanningTree is enabled"},"spanningTreeSetting":{"$ref":"#/components/schemas/SpanningTreeSettingVO"},"loopbackDetectEnable":{"type":"boolean","description":"Indicates whether loopbackDetect port based is enabled"},"loopbackDetectVlanBasedEnable":{"type":"boolean","description":"Indicates whether loopbackDetect vlan based is enabled"},"igmpFastLeaveEnable":{"type":"boolean","description":"Indicates whether igmp fast leave is enabled"},"mldFastLeaveEnable":{"type":"boolean","description":"Indicates whether mld fast leave is enabled"},"portIsolationEnable":{"type":"boolean","description":"Indicates whether port isolation is enabled"},"eeeEnable":{"type":"boolean","description":"Indicates whether EEE is enabled"},"flowControlEnable":{"type":"boolean","description":"Indicates whether flow control is enabled"},"fastLeaveEnable":{"type":"boolean","description":"Indicates whether igmpSnooping fastLeave is enabled"},"dhcpL2RelaySettings":{"$ref":"#/components/schemas/OswPortDhcpL2RelayVO"},"dot1pPriority":{"type":"integer","description":"Dot1p Priority","format":"int32"},"trustMode":{"type":"integer","description":"TrustMode should be a value as follows: 0: Untrusted; 1: Trust 802.1p; 2: Trust DSCP","format":"int32"},"qosQueueEnable":{"type":"boolean","description":"Indicates whether the ES device port has enabled the Qos scheduling queue configuration"},"queueId":{"type":"integer","description":"ES Qos scheduling queue ID","format":"int32"},"removedOuiBasedRuleIds":{"type":"array","description":"The id of oui based vlan rule removded.","items":{"type":"string","description":"The id of oui based vlan rule removded."}},"operation":{"pattern":"switching|mirroring|aggregating","type":"string","description":"Operation should be a value as follows: \"switching\" or \"mirroring\" or \"aggregating\""},"mirroredPorts":{"uniqueItems":true,"type":"array","description":"Mirrored Ports","items":{"type":"integer","description":"Mirrored Ports","format":"int32"}},"mirroredLags":{"uniqueItems":true,"type":"array","description":"Mirrored Lags","items":{"type":"integer","description":"Mirrored Lags","format":"int32"}},"lagSetting":{"$ref":"#/components/schemas/OswLagBasicVO"},"lagDelete":{"type":"boolean","description":"When the operation changes from aggregating to switching, this parameter should be set to true, and the \"lagSetting\" parameter needs to include the lagId."},"dot1x":{"type":"integer","description":"Dot1x should be a value as follows: 0: Force unauthorized; 1: Force authorized; 2: Auto","format":"int32"},"poe":{"type":"integer","description":"Poe should be a value as follows: 0: Off; 1: 802.3at/af","format":"int32"},"lldpMedEnable":{"type":"boolean","description":"Indicates whether LLDP-MED is enabled"},"topoNotifyEnable":{"type":"boolean","description":"Indicates whether Topology Notify is enabled"},"mac":{"type":"string","description":"Mac address of the port. This parameter can be null when batch modify stack ports, but not null when modify a single stack port"},"stackSetting":{"$ref":"#/components/schemas/OswPortStackSettingVO"},"unitList":{"maxItems":2147483647,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/OswStackUnitVO"}}}},"StackLagSettingVO":{"type":"object","properties":{"name":{"pattern":"^[^ ?\"]$|^[^ ?\"][^?\"]{0,126}[^ ?\"]$","type":"string","description":"Port or Lag Name"},"tagIds":{"type":"array","description":"Tag ID List","items":{"type":"string","description":"Tag ID List"}},"nativeNetworkId":{"type":"string","description":"Native Network ID, Native Network cannot be selected from Tagged Networks or Untagged Networks."},"nativeBridgeVlan":{"type":"integer","description":"Native Network Bridge Vlan.","format":"int32"},"networkTagsSetting":{"type":"integer","description":"Network Tags Setting should be a value as follows: 0: Allow All; 1: Block All; 2: Custom","format":"int32"},"tagNetworkIds":{"type":"array","description":"Tag Network IDs","items":{"type":"string","description":"Tag Network IDs"}},"tagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Tag Network Bridge Vlan Map","items":{"type":"integer","description":"Tag Network Bridge Vlan Map","format":"int32"}},"description":"Tag Network Bridge Vlan Map"},"untagNetworkIds":{"type":"array","description":"Untag Network IDs","items":{"type":"string","description":"Untag Network IDs"}},"untagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Untag Network Bridge Vlan Map","items":{"type":"integer","description":"Untag Network Bridge Vlan Map","format":"int32"}},"description":"Untag Network Bridge Vlan Map"},"voiceNetworkEnable":{"type":"boolean","description":"Indicates whether voice network is enabled"},"voiceNetworkId":{"type":"string","description":"Voice Network ID"},"voiceBridgeVlan":{"type":"integer","description":"Voice Network Bridge Vlan","format":"int32"},"voiceDscpEnable":{"type":"boolean","description":"Indicates whether voice DSCP is enabled"},"voiceDscp":{"type":"integer","description":"Voice DSCP","format":"int32"},"portAlertEnable":{"type":"boolean","description":"Indicates whether port alert is enabled"},"fecMode":{"type":"integer","description":"FEC mode should be a value as follows: 1: Off; 2: RS528; 3: RS544; 4: Auto; 5: Base-R","format":"int32"},"fecLinkPeerApplyEnable":{"type":"boolean","description":"Indicates whether the FEC Mode is synchronously applied to the link peer port."},"disable":{"type":"boolean","description":"Indicates whether to disable"},"profileId":{"type":"string","description":"Profile ID is required (not null) when modifying a single port."},"profileOverrideEnable":{"type":"boolean","description":"Indicates whether to enable Profile Override before v6.2.10; Indicates the fill mode of port configuration after v6.2.10: true: custom; false: follow profile"},"profileVlanOverrideEnable":{"type":"boolean","description":"Indicates the fill mode of vlan configuration: true: custom; false: follow profile"},"linkSpeed":{"type":"integer","description":"Link Speed should be a value as follows: 0: auto; 1: 10M; 2: 100M; 3: 1000M; 4: 2.5G; 5: 10G","format":"int32"},"duplex":{"type":"integer","description":"Duplex should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"},"igmpSnoopingEnable":{"type":"boolean","description":"Indicates whether IGMP Snooping is enabled"},"bandWidthCtrlType":{"type":"integer","description":"BandWidthCtrlType should be a value as follows: 0: Off; 1: Rate Limit; 2: Storming Control","format":"int32"},"bandCtrl":{"$ref":"#/components/schemas/OswBandCtrlVO"},"stormCtrl":{"$ref":"#/components/schemas/OswStormCtrlVO"},"spanningTreeEnable":{"type":"boolean","description":"Indicates whether SpanningTree is enabled"},"spanningTreeSetting":{"$ref":"#/components/schemas/SpanningTreeSettingVO"},"loopbackDetectEnable":{"type":"boolean","description":"Indicates whether loopbackDetect port based is enabled"},"loopbackDetectVlanBasedEnable":{"type":"boolean","description":"Indicates whether loopbackDetect vlan based is enabled"},"igmpFastLeaveEnable":{"type":"boolean","description":"Indicates whether igmp fast leave is enabled"},"mldFastLeaveEnable":{"type":"boolean","description":"Indicates whether mld fast leave is enabled"},"portIsolationEnable":{"type":"boolean","description":"Indicates whether port isolation is enabled"},"eeeEnable":{"type":"boolean","description":"Indicates whether EEE is enabled"},"flowControlEnable":{"type":"boolean","description":"Indicates whether flow control is enabled"},"fastLeaveEnable":{"type":"boolean","description":"Indicates whether igmpSnooping fastLeave is enabled"},"dhcpL2RelaySettings":{"$ref":"#/components/schemas/OswPortDhcpL2RelayVO"},"dot1pPriority":{"type":"integer","description":"Dot1p Priority","format":"int32"},"trustMode":{"type":"integer","description":"TrustMode should be a value as follows: 0: Untrusted; 1: Trust 802.1p; 2: Trust DSCP","format":"int32"},"qosQueueEnable":{"type":"boolean","description":"Indicates whether the ES device port has enabled the Qos scheduling queue configuration"},"queueId":{"type":"integer","description":"ES Qos scheduling queue ID","format":"int32"},"removedOuiBasedRuleIds":{"type":"array","description":"The id of oui based vlan rule removded.","items":{"type":"string","description":"The id of oui based vlan rule removded."}},"operation":{"pattern":"switching|mirroring|aggregating","type":"string","description":"Operation should be a value as follows: \"switching\" or \"mirroring\" or \"aggregating\""},"lagId":{"type":"integer","description":"Lag ID","format":"int32"},"lagType":{"type":"integer","description":"Lag Type should be a value as follows: 1: STATIC; 2: LACP; 3: LACP ACTIVE; 4: LACP PASSIVE","format":"int32"},"ports":{"type":"array","description":"Lag Ports","items":{"type":"integer","description":"Lag Ports","format":"int32"}},"mlagName":{"type":"string","description":"M-LAG group Name"},"mlagEnable":{"type":"boolean","description":"Indicates whether M-LAG port is enabled"},"mlagPeerSetting":{"$ref":"#/components/schemas/OswMlagPeerSettingVO"},"standardPorts":{"type":"array","description":"LAG Standard ports","items":{"$ref":"#/components/schemas/OswStandPortVO"}}}},"LogAlertEmailOpenApiVO":{"type":"object","properties":{"alertEmailEnable":{"type":"boolean","description":"Log Enable or Disable email","example":false},"delayEnable":{"type":"boolean","description":"Log Enable or Disable delay email","example":false},"delay":{"type":"integer","description":"Time of Log delay email (unit:s). The value should be within the range of 0–99999.","format":"int32","example":30}},"description":"Log Event Email (This config applies to the log site view)"},"LogNotificationEditOpenApiV2VO":{"required":["email","enable","key"],"type":"object","properties":{"key":{"type":"string","description":"For the values of Log Notification Key, refer to section 5.6.1 of the Open API Access","example":"LOGIN_OK"},"enable":{"type":"boolean","description":"Log Notification Enable or Disable","example":true},"email":{"type":"boolean","description":"Log Notification Enable or Disable Email","example":true},"webhook":{"type":"boolean","description":"Log Notification Category Enable or Disable Webhook (This config applies to the Omada Pro Controller only and should not bu null)","example":false}},"description":"Event Notification List"},"LogNotificationSettingEditOpenApiV2VO":{"type":"object","properties":{"webhookConfig":{"$ref":"#/components/schemas/WebhookConfigEditOpenApiVO"},"alertNotifications":{"type":"array","description":"Alert Notification List","items":{"$ref":"#/components/schemas/LogNotificationEditOpenApiV2VO"}},"eventNotifications":{"type":"array","description":"Event Notification List","items":{"$ref":"#/components/schemas/LogNotificationEditOpenApiV2VO"}},"alertEmailSetting":{"$ref":"#/components/schemas/LogAlertEmailOpenApiVO"},"eventEmailSetting":{"$ref":"#/components/schemas/LogAlertEmailOpenApiVO"}}},"WebhookConfigEditOpenApiVO":{"required":["webhookEnable"],"type":"object","properties":{"webhookEnable":{"type":"boolean","description":"Audit or Omada Log Notification Enable for Disable Webhook","example":false},"webhookId":{"type":"string","description":"Webhook ID (Webhook ID should be configured in webhook setting, when Webhook Enable is true)"}},"description":"Log Notification Webhook Config (This config applies to the Omada Pro Controller only)"},"ApSsidOverrideOpenApiV2VO":{"required":["ssidOverrides"],"type":"object","properties":{"ssidOverrides":{"type":"array","description":"SsidOverride Config List","items":{"$ref":"#/components/schemas/SsidOverrideOpenApiV2VO"}}}},"SsidOverrideOpenApiV2VO":{"required":["overrideSsidEnable","overrideVlanEnable","ssidEntryId"],"type":"object","properties":{"ssidEntryId":{"type":"integer","description":"This field represents SSID Entry ID.SSID Entry ID can be obtained from 'Get ap WLANs override config' interface.","format":"int32"},"overrideSsidName":{"type":"string","description":"Override SSID name. It should contain 1 to 32 UTF-8 characters."},"overrideSsidPassword":{"type":"string","description":"Override SSID password(when security is WPA-Personal need fill).It should contain 8-63 printable ASCII characters or 8-63 hexadecimal digits."},"overrideSsidEnable":{"type":"boolean","description":"Enable/disable SSID override"},"overrideVlanEnable":{"type":"boolean","description":"Enable/disable VLAN override"},"vlanId":{"type":"integer","description":"VLAN ID","format":"int32"},"vlanPoolIds":{"type":"string","description":"VLAN POOL IDS"},"ssidEnable":{"type":"boolean","description":"Enable/disable SSID"}},"description":"SsidOverride Config List"},"OpenApiWebhookSettingEditVO":{"required":["retryPolicy","template","urlList"],"type":"object","properties":{"urlList":{"type":"array","description":"Webhook URL List. Up to 3 entries are allowed for the URL list ","example":"[http(s)://webhook.site/4a566f9e-0b77-42e2-9a34-a78]","items":{"type":"string","description":"Webhook URL List. Up to 3 entries are allowed for the URL list ","example":"[http(s)://webhook.site/4a566f9e-0b77-42e2-9a34-a78]"}},"retryPolicy":{"type":"integer","description":"Webhook retry policy. It should be a value as follows: 0:None, 1:Important (Up to 5 retries over 60 minutes), 2:Critical (Up to 5 retries over 24 hours)","format":"int32"},"shardedSecret":{"type":"string","description":"Webhook Sharded Secret. It should contain 0 to 128 characters."},"template":{"type":"integer","description":"Webhook template, it should be a value as follow: 0:Omada template, 1:Google chat template. Example: 0. ","format":"int32"}}},"BatchModifyUserOpenApiVO":{"type":"object","properties":{"userIds":{"type":"array","description":"The list of user IDs that need to be configured in bulk","items":{"type":"string","description":"The list of user IDs that need to be configured in bulk"}},"temporaryEnable":{"type":"boolean","description":"Whether the user wants to enable the temporary worker permission"},"startTime":{"type":"integer","description":"The start time of the user's validity period. time range: start timestamp (Millisecond).","format":"int64"},"endTime":{"type":"integer","description":"The end time of the user's validity period. time range: end timestamp (Millisecond).","format":"int64"}}},"BatchModifyCountVO":{"type":"object","properties":{"successes":{"type":"integer","format":"int32"},"failures":{"type":"integer","format":"int32"}}},"OperationResponseBatchModifyCountVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/BatchModifyCountVO"}}},"UpgradeSettingTryBeta":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Try beta switch status"}}},"UpgradeSettingTryBetaChannel":{"required":["channel"],"type":"object","properties":{"channel":{"type":"integer","description":"Channel should be a value as follows: 0:Stable; 1:Release Candidate; 2:Beta","format":"int32"}}},"UpgradeSettingEmailReminder":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Email Reminder switch status"}}},"UpdateWlanGroupOpenApiVO":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"WLAN group name should contain 1 to 128 characters."}}},"UpdateSsidWlanScheduleOpenApiVO":{"required":["wlanScheduleEnable"],"type":"object","properties":{"wlanScheduleEnable":{"type":"boolean","description":"SSID WLAN schedule global config status. True: enable, false: disable."},"action":{"type":"integer","description":"0 means radio off, indicating the Wi-Fi function is off during the selected period; 1 means radio on, indicating the Wi-Fi function is on during the selected period.","format":"int32"},"scheduleId":{"type":"string","description":"This field represents Time Range Profile ID. Time Range Profile can be created using Create time range profile interface, and Time Range Profile ID can be obtained from Get time range profile list interface."}}},"UpdateWifiCallingOpenApiVO":{"required":["wifiCallingEnable"],"type":"object","properties":{"wifiCallingEnable":{"type":"boolean","description":"SSID Wi-Fi Calling global config status. True: enable, false: disable."},"wifiCallingId":{"type":"string","description":"This field represents Wi-Fi Calling Profile ID. Wi-Fi Calling Profile can be created using Create a new wifi calling profile."}}},"UpdateSsidRateLimitOpenApiVO":{"type":"object","properties":{"clientRateLimit":{"$ref":"#/components/schemas/RateLimitSettingOpenApiVO"},"ssidRateLimit":{"$ref":"#/components/schemas/RateLimitSettingOpenApiVO"}}},"UpdateSsidRateControlOpenApiVO":{"required":["rate2gCtrlEnable","rate5gCtrlEnable"],"type":"object","properties":{"rate2gCtrlEnable":{"type":"boolean","description":"Whether to enable 2.4GHz Data Rate Control"},"lowerDensity2g":{"type":"number","description":"2.4GHz Data Rate Control lower density value(Unit: Mbps); It should be a value as follows: [1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54]."},"higherDensity2g":{"type":"integer","description":"2.4GHz Data Rate Control higher density value(Unit: Mbps); It should be a value as follows: [54].","format":"int32"},"cckRatesDisable":{"type":"boolean","description":"Whether to disable 2G CCK Rates. If this field is true, Parameter [lowerDensity2g] can not enter the following values: [1, 2, 5.5, 11]."},"clientRatesRequire2g":{"type":"boolean","description":"Whether to require clients to use rates at or above the specified value of 2.4GHz Data Rate Control."},"sendBeacons2g":{"type":"boolean","description":"Whether to enable send beacons at 1Mbps of 2.4GHz Data Rate Control."},"rate5gCtrlEnable":{"type":"boolean","description":"Whether to enable 5GHz Data Rate Control."},"lowerDensity5g":{"type":"integer","description":"5GHz Data Rate Control lower density value(Unit: Mbps); It should be a value as follows: [6, 9, 12, 18, 24, 36, 48, 54].","format":"int32"},"higherDensity5g":{"type":"integer","description":"5GHz Data Rate Control higher density value(Unit: Mbps); It should be a value as follows: [54].","format":"int32"},"clientRatesRequire5g":{"type":"boolean","description":"Whether to require clients to use rates at or above the specified value of 5GHz Data Rate Control."},"sendBeacons5g":{"type":"boolean","description":"Whether to enable send beacons at 6Mbps of 5GHz Data Rate Control."},"rate6gCtrlEnable":{"type":"boolean","description":"Whether to enable 6GHz Data Rate Control. Note: This field will no longer be supported since Omada Controller V5.14.30.","deprecated":true},"lowerDensity6g":{"type":"integer","description":"6GHz Data Rate Control lower density value(Unit: Mbps); It should be a value as follows: [6, 9, 12, 18, 24, 36, 48, 54].Note: This field will no longer be supported since Omada Controller V5.14.30.","format":"int32","deprecated":true},"higherDensity6g":{"type":"integer","description":"6GHz Data Rate Control higher density value(Unit: Mbps); It should be a value as follows: [54].Note: This field will no longer be supported since Omada Controller V5.14.30.","format":"int32","deprecated":true},"clientRatesRequire6g":{"type":"boolean","description":"Whether to require clients to use rates at or above the specified value of 6GHz Data Rate Control. Note: This field will no longer be supported since Omada Controller V5.14.30.","deprecated":true},"sendBeacons6g":{"type":"boolean","description":"Whether to enable send beacons at 6Mbps of 6GHz Data Rate Control. Note: This field will no longer be supported since Omada Controller V5.14.30.","deprecated":true},"manageRateControl2gEnable":{"type":"boolean","description":"Whether to enable 2GHz Manage Rate Control."},"manageRateControl2g":{"type":"number","description":"2.4GHz Manage Rate Control lower density value(Unit: Mbps); It should be a value as follows: [1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, 54]. The higher density value is fixed at 54."},"manageRateControl5gEnable":{"type":"boolean","description":"Whether to enable 5GHz Manage Rate Control."},"manageRateControl5g":{"type":"integer","description":"5GHz Manage Rate Control lower density value(Unit: Mbps); It should be a value as follows: [6, 9, 12, 18, 24, 36, 48, 54]. The higher density value is fixed at 54.","format":"int32"}}},"UpdateSsidMultiCastOpenApiVO":{"required":["arpCastEnable","channelUtil","filterEnable","ipv6CastEnable","multiCastEnable"],"type":"object","properties":{"multiCastEnable":{"type":"boolean","description":"Whether to enable multicast to unicast, which is disabled by default; true: enable, false: disable"},"channelUtil":{"type":"integer","description":"This item indicates that when the channel utilization reaches the threshold, multicast will no longer be converted to unicast, the default threshold is 100, and the value should be within the range of 0-100.","format":"int32"},"arpCastEnable":{"type":"boolean","description":"Whether to enable ARP cast to unicast, which is disabled by default; true: enable, false: disable"},"ipv6CastEnable":{"type":"boolean","description":"Whether to enable IPv6 multicast to unicast, which is enabled by default; true: enable, false: disable"},"filterEnable":{"type":"boolean","description":"Whether to enable the multicast filter switch, which is disabled by default; true: enable, false: disable"},"filterMode":{"type":"integer","description":"This item indicates the status of the filtering protocol, the lowest low bit indicates whether IGMP is enabled, the second low bit indicates whether MDNS is enabled, and the third low bit indicates whether Others is enabled; 1 means enable while 0 means disable. For example, 7(111) means that all are enabled, 1(001) means that only IGMP is enabled. ","format":"int32"},"macGroupId":{"type":"string","description":"This field represents MAC Group Profile ID. MAC Group Profile can be created using Create a new group profile interface, and MAC Group Profile ID can be obtained from Get group profile list by type interface."}}},"UpdateSsidMacFilterOpenApiVO":{"required":["macFilterEnable"],"type":"object","properties":{"macFilterEnable":{"type":"boolean","description":"SSID MAC Filter global config status. True: enable, false: disable."},"policy":{"type":"integer","description":"SSID MAC Filter policy config mode; It should be a value as follows: 0: Deny List, 1: Allow List.","format":"int32"},"macFilterId":{"type":"string","description":"This field represents MAC Group Profile ID. MAC Group Profile can be created using Create a new group profile interface, and MAC Group Profile ID can be obtained from Get group profile list by type interface."},"ouiProfileIdList":{"type":"array","description":"This field represents OUI Profile ID list. OUI Profile can be created using Create OUI profile interface, and OUI Profile ID can be obtained from Get OUI profile summary list interface(This configuration applies to the Pro Site of the Omada Pro Controller only).","items":{"type":"string","description":"This field represents OUI Profile ID list. OUI Profile can be created using Create OUI profile interface, and OUI Profile ID can be obtained from Get OUI profile summary list interface(This configuration applies to the Pro Site of the Omada Pro Controller only)."}}}},"UpdateSsidLoadBalanceOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"SSID Load Balance global config status. True: enable, false: disable."}}},"UpdateSsidHotspotV2SettingOpenApiVO":{"required":["hotspotV2Enable"],"type":"object","properties":{"hotspotV2Enable":{"type":"boolean","description":"Whether Hotspot2.0 is enabled.<br />If hotspot2.0 is disabled, other parameters in Hotspot2.0 will be invalid."},"networkType":{"type":"integer","description":"Specify the 802.11u network type.<br /> Parameter networkType should be a value as follows: [0: Private network; 1: Private network with guest access; 2: Chargeable public network; 3: Free public network; 4: Personal device network; 5: Emergency services only network; 14: Test or experimental; 15: Wildcard].","format":"int32"},"plmnId":{"maxItems":6,"minItems":0,"type":"array","description":"PLMN ID list, enter PLMN ID of 802.11u 3GPP cellular network.<br />Note: Up to 6 entries are allowed for the PLMN ID list.","items":{"$ref":"#/components/schemas/PlmnIdOpenApiVO"}},"roamingConsortiumOi":{"maxItems":3,"minItems":0,"type":"array","description":"Roaming Consortium Oi list, enter the 802.11u roaming organization identifiers.<br />Note: Up to 3 entries are allowed for the Roaming Consortium Oi list.","items":{"$ref":"#/components/schemas/RoamingConsortiumOiOpenApiVO"}},"operatorDomain":{"pattern":"^$|^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?$","type":"string","description":"Enter the domain name of the hotspot operator.<br />For example, www.omadanetworks.com."},"dgafDisable":{"type":"boolean","description":"Whether to enable DGAF(downstream group-addressed forwarding) disable mode.<br />In DGAF disable mode, the AP will not forward downstream multicast and broadcast packets."},"heSsid":{"pattern":"^$|^[A-F0-9]{1}[02468ACE]{1}([-][A-F0-9]{2}){5}$","type":"string","description":"Homogenous Extended Service Set Identifier, it is used to identify the same type of ESS network set.<br />Note: HESSID should be consistent with one of the BSSIDs of the APs in the zone."},"internet":{"type":"boolean","description":"Internet access support status (network reachability), which indicates that the network is allowed to access the Internet."},"availabilityIpv4":{"type":"integer","description":"Available type information of IPv4 addresses.<br />Parameter availabilityIpv4 should be a value as follows: [0: Address type not available; 1: Public IPv4 address available; 2: Port-restricted IPv4 address available; 3: Single NATed private IPv4 address available; 4: Double NATed private IPv4 address available; 5: Port-restricted IPv4 address and single NATed IPv4 address available; 6: Port-restricted IPv4 address and double NATed IPv4 address available; 7: Availability of the address type is not known].","format":"int32"},"availabilityIpv6":{"type":"integer","description":"Available type information of IPv6 addresses.<br /> Parameter availabilityIpv6 should be a value as follows: [0: Address type not available; 1: Address type available; 2: Availability of the address type not known].","format":"int32"},"operatorFriendly":{"pattern":"^$|^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,62}[\\041-\\0176]$","type":"string","description":"Hotspot network operator friendly name.<br />Note:Parameter operatorFriendly should contain between 1 and 64 visible ASCII characters, with no Spaces at the beginning and end, and Spaces in between."},"venueInfo":{"$ref":"#/components/schemas/VenueInfoOpenApiVO"},"realmList":{"maxItems":10,"minItems":0,"type":"array","description":"Add a profile to identify and describe a NAI (Network Access Identifier) realm accessible using the AP, and the method that this NAI realm uses for authentication.<br />Note: Up to 10 entries are allowed for the NAI Realm list.","items":{"$ref":"#/components/schemas/RealmOpenApiVO"}}}},"UpdateSsidDhcpOptionOpenApiVO":{"required":["dhcpEnable"],"type":"object","properties":{"dhcpEnable":{"type":"boolean","description":"SSID DHCP Option 82 global config status. True: enable, false: disable."},"format":{"type":"integer","description":"SSID DHCP Option 82 format config; It should be a value as follows: 0: ASCII; 1: Binary.","format":"int32"},"delimiter":{"pattern":"^[\\040-\\0176]$","type":"string","description":"SSID DHCP Option 82 delimiter config (A single arbitrary ASCII character is acceptable)."},"circuitId":{"type":"array","description":"SSID DHCP Option 82 Circuit-ID config. Circuit-ID is an array formed in the selected order, with each array element corresponding to the following enumeration values: 1: VLAN-ID; 2: AP Radio Mac-Address; 3: SSID-Type; 4: SSID-Name; 5: AP Ethernet MAC address; 6: Site-Name. As in the example [3,1,2,4], the following enumeration values are selected sequentially on the page: SSID-Type, VLAN-ID, AP Radio Mac-Address and SSID-Name.","items":{"type":"integer","description":"SSID DHCP Option 82 Circuit-ID config. Circuit-ID is an array formed in the selected order, with each array element corresponding to the following enumeration values: 1: VLAN-ID; 2: AP Radio Mac-Address; 3: SSID-Type; 4: SSID-Name; 5: AP Ethernet MAC address; 6: Site-Name. As in the example [3,1,2,4], the following enumeration values are selected sequentially on the page: SSID-Type, VLAN-ID, AP Radio Mac-Address and SSID-Name.","format":"int32"}},"remoteId":{"type":"array","description":"SSID DHCP Option 82 Remote-ID config. Remote-ID is an array formed in the selected order, with each array element corresponding to the following enumeration values: 1: VLAN-ID; 2: AP Radio Mac-Address; 3: SSID-Type; 4: SSID-Name; 5: AP Ethernet MAC address; 6: Site-Name. As in the example [3,1,2,4], the following enumeration values are selected sequentially on the page: SSID-Type, VLAN-ID, AP Radio Mac-Address and SSID-Name.","items":{"type":"integer","description":"SSID DHCP Option 82 Remote-ID config. Remote-ID is an array formed in the selected order, with each array element corresponding to the following enumeration values: 1: VLAN-ID; 2: AP Radio Mac-Address; 3: SSID-Type; 4: SSID-Name; 5: AP Ethernet MAC address; 6: Site-Name. As in the example [3,1,2,4], the following enumeration values are selected sequentially on the page: SSID-Type, VLAN-ID, AP Radio Mac-Address and SSID-Name.","format":"int32"}}}},"UpdateSsidBasicConfigOpenApiVO":{"required":["band","broadcast","enable11r","guestNetEnable","mloEnable","name","pmfMode","security","vlanEnable"],"type":"object","properties":{"name":{"type":"string","description":"SSID name. It should contain 1 to 32 UTF-8 characters."},"band":{"type":"integer","description":"SSID band. The lowest bit indicates whether 2.4G is included; the second lowest bit indicates whether 5G is included; the third lowest bit indicates whether 6G is included; 1 means included while 0 means not included. For example, 7(111) means that 2G/5G/6G are enabled; 1(001) means that 2G is enabled. (When 5G is included，it means 5G/5G1/5G2 are enabled.)","format":"int32"},"autoWanAccess":{"type":"boolean","description":"Whether to enable auto wan access. True: enable, false: disable."},"guestNetEnable":{"type":"boolean","description":"SSID guest network config status. True: enable, false: disable."},"security":{"type":"integer","description":"SSID security mode; Security should be a value as follows: 0: None; 2: WPA-Enterprise; 3: WPA-Personal; 4: PPSK without RADIUS; 5: PPSK with RADIUS.","format":"int32"},"oweEnable":{"type":"boolean","description":"Opportunistic Wireless Encryption, also known as Enhanced Open, is a certification provided by the Wi-Fi Alliance as part of the WPA3 wireless security standard. OWE will enable two wireless VAPs per radio, one for access of OWE-supported stations, and one for access of other stations. An SSID with OWE enabled will be counted as two SSID entries for 2G and 5G. Only for security is None and band contains 2.4G or 5G."},"broadcast":{"type":"boolean","description":"SSID broadcast config status. True: enable, false: disable."},"vlanEnable":{"type":"boolean","description":"SSID VLAN config status. True: enable, false: disable."},"vlanId":{"type":"integer","description":"SSID VLAN ID. This field is required when Parameter [vlanEnable] is true; It should be within the range of 1–4094. ","format":"int32"},"pskSetting":{"$ref":"#/components/schemas/SsidPskSettingOpenApiVO"},"entSetting":{"$ref":"#/components/schemas/SsidEnterpriseSettingOpenApiVO"},"ppskSetting":{"$ref":"#/components/schemas/SsidPpskSettingOpenApiVO"},"mloEnable":{"type":"boolean","description":"SSID MLO config status. True: enable, false: disable."},"pmfMode":{"type":"integer","description":"SSID PMF mode. It should be a value as follows: 1: Mandatory; 2: Capable; 3: Disable.","format":"int32"},"enable11r":{"type":"boolean","description":"SSID 802.11r config status. True: enable, false: disable."},"hidePwd":{"type":"boolean","description":"If this field is true, the SSID password will be hidden."},"greEnable":{"type":"boolean","description":"SSID EoGre Tunnel config status. True: enable, false: disable; This configuration can be enabled only when the [VPN - EoGre Tunnel] global config is enabled."},"vlanSetting":{"$ref":"#/components/schemas/SsidVlanSettingOpenApiVO"},"prohibitWifiShare":{"type":"boolean","description":"SSID prohibitWifiShare config status. True: enable, false: disable."},"enhancedIotConnectivity":{"type":"boolean","description":"SSID Enhanced IoT Connectivity config status. True: enable, false: disable. This configuration can be enabled only when the 5GHz and 6GHz bands are disabled, the parameters [versionEnt] and [versionPsk] are not set to 4, and the following configurations are disabled: [hotspotV2Enable], [bandSteer], [arpCastEnable], [loadBalance], [enable11r], [gikRekeyPskEnable], [pmfMode], [mloEnable]."},"CondBroadcastCtrl":{"$ref":"#/components/schemas/CondBroadcastCtrlVO"}}},"UpdateSsidBandSteerOpenApiVO":{"required":["mode"],"type":"object","properties":{"mode":{"type":"integer","description":"should be a value as follows: 0:Disable; 1:Prefer 5GHz/6GHz; 2:Balance; 3:Use site setting.","format":"int32"}}},"UpdateSsidEnableStatusOpenApiVO":{"required":["ssidEnable"],"type":"object","properties":{"ssidEnable":{"type":"boolean","description":"Enable or disable the SSID"}}},"MergeSsidOpenApiVO":{"type":"object","properties":{"mergeSsidId":{"type":"string","description":"the merged SSID ID"},"mergeSsidName":{"type":"string","description":"the merged SSID name"},"apGroupIds":{"type":"array","description":"the AP Group IDs bound to the merged SSID","items":{"type":"string","description":"the AP Group IDs bound to the merged SSID"}},"deleteSsidIds":{"type":"array","description":"the SSIDs to be deleted","items":{"type":"string","description":"the SSIDs to be deleted"}},"forceMerge":{"type":"boolean","description":"Whether to force merge the SSIDs and skip the device type compatibility check."}}},"InternetPortOpenApiVO":{"required":["type"],"type":"object","properties":{"type":{"type":"integer","description":"The Type of the Internet port as follows: 0: WAN; 1: USB; 2: LTE; 3: DSL.","format":"int32"},"wanPortSetting":{"$ref":"#/components/schemas/WanPortSettingOpenApiVO"},"usbLteSetting":{"$ref":"#/components/schemas/UsbLteSettingOpenApiVO"},"lteWanSetting":{"$ref":"#/components/schemas/LteWanSettingOpenApiVO"}}},"LteWanSettingOpenApiVO":{"required":["portUuid"],"type":"object","properties":{"portName":{"type":"string","description":"LTE WAN port name"},"portUuid":{"type":"string","description":"LTE WAN port uuid"},"portDesc":{"type":"string","description":"LTE WAN port description"},"lteWanPortsConfig":{"type":"array","description":"LTE WAN ports config","items":{"$ref":"#/components/schemas/LteWanPortSettingOpenApiVO"}}},"description":"The setting of the WAN lte."},"OperationResponseVoid":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"object"}}},"UrlDragSortIndexOpenapiVO":{"required":["indexes","type"],"type":"object","properties":{"type":{"pattern":"gateway|ap","type":"string","description":"Type must be gateway or ap"},"indexes":{"type":"object","additionalProperties":{"type":"integer","description":"The order in which items take effect, this object is a Map, the key is item ID and the value is the index you want to set.","format":"int32"},"description":"The order in which items take effect, this object is a Map, the key is item ID and the value is the index you want to set."}}},"OswPortSettingVO":{"type":"object","properties":{"name":{"pattern":"^[^ ?\"]$|^[^ ?\"][^?\"]{0,126}[^ ?\"]$","type":"string","description":"Port or Lag Name"},"tagIds":{"type":"array","description":"Tag ID List","items":{"type":"string","description":"Tag ID List"}},"nativeNetworkId":{"type":"string","description":"Native Network ID, Native Network cannot be selected from Tagged Networks or Untagged Networks."},"nativeBridgeVlan":{"type":"integer","description":"Native Network Bridge Vlan.","format":"int32"},"networkTagsSetting":{"type":"integer","description":"Network Tags Setting should be a value as follows: 0: Allow All; 1: Block All; 2: Custom","format":"int32"},"tagNetworkIds":{"type":"array","description":"Tag Network IDs","items":{"type":"string","description":"Tag Network IDs"}},"tagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Tag Network Bridge Vlan Map","items":{"type":"integer","description":"Tag Network Bridge Vlan Map","format":"int32"}},"description":"Tag Network Bridge Vlan Map"},"untagNetworkIds":{"type":"array","description":"Untag Network IDs","items":{"type":"string","description":"Untag Network IDs"}},"untagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Untag Network Bridge Vlan Map","items":{"type":"integer","description":"Untag Network Bridge Vlan Map","format":"int32"}},"description":"Untag Network Bridge Vlan Map"},"voiceNetworkEnable":{"type":"boolean","description":"Indicates whether voice network is enabled"},"voiceNetworkId":{"type":"string","description":"Voice Network ID"},"voiceBridgeVlan":{"type":"integer","description":"Voice Network Bridge Vlan","format":"int32"},"voiceDscpEnable":{"type":"boolean","description":"Indicates whether voice DSCP is enabled"},"voiceDscp":{"type":"integer","description":"Voice DSCP","format":"int32"},"portAlertEnable":{"type":"boolean","description":"Indicates whether port alert is enabled"},"fecMode":{"type":"integer","description":"FEC mode should be a value as follows: 1: Off; 2: RS528; 3: RS544; 4: Auto; 5: Base-R","format":"int32"},"fecLinkPeerApplyEnable":{"type":"boolean","description":"Indicates whether the FEC Mode is synchronously applied to the link peer port."},"disable":{"type":"boolean","description":"Indicates whether to disable"},"profileId":{"type":"string","description":"Profile ID is required (not null) when modifying a single port."},"profileOverrideEnable":{"type":"boolean","description":"Indicates whether to enable Profile Override before v6.2.10; Indicates the fill mode of port configuration after v6.2.10: true: custom; false: follow profile"},"profileVlanOverrideEnable":{"type":"boolean","description":"Indicates the fill mode of vlan configuration: true: custom; false: follow profile"},"linkSpeed":{"type":"integer","description":"Link Speed should be a value as follows: 0: auto; 1: 10M; 2: 100M; 3: 1000M; 4: 2.5G; 5: 10G","format":"int32"},"duplex":{"type":"integer","description":"Duplex should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"},"igmpSnoopingEnable":{"type":"boolean","description":"Indicates whether IGMP Snooping is enabled"},"bandWidthCtrlType":{"type":"integer","description":"BandWidthCtrlType should be a value as follows: 0: Off; 1: Rate Limit; 2: Storming Control","format":"int32"},"bandCtrl":{"$ref":"#/components/schemas/OswBandCtrlVO"},"stormCtrl":{"$ref":"#/components/schemas/OswStormCtrlVO"},"spanningTreeEnable":{"type":"boolean","description":"Indicates whether SpanningTree is enabled"},"spanningTreeSetting":{"$ref":"#/components/schemas/SpanningTreeSettingVO"},"loopbackDetectEnable":{"type":"boolean","description":"Indicates whether loopbackDetect port based is enabled"},"loopbackDetectVlanBasedEnable":{"type":"boolean","description":"Indicates whether loopbackDetect vlan based is enabled"},"igmpFastLeaveEnable":{"type":"boolean","description":"Indicates whether igmp fast leave is enabled"},"mldFastLeaveEnable":{"type":"boolean","description":"Indicates whether mld fast leave is enabled"},"portIsolationEnable":{"type":"boolean","description":"Indicates whether port isolation is enabled"},"eeeEnable":{"type":"boolean","description":"Indicates whether EEE is enabled"},"flowControlEnable":{"type":"boolean","description":"Indicates whether flow control is enabled"},"fastLeaveEnable":{"type":"boolean","description":"Indicates whether igmpSnooping fastLeave is enabled"},"dhcpL2RelaySettings":{"$ref":"#/components/schemas/OswPortDhcpL2RelayVO"},"dot1pPriority":{"type":"integer","description":"Dot1p Priority","format":"int32"},"trustMode":{"type":"integer","description":"TrustMode should be a value as follows: 0: Untrusted; 1: Trust 802.1p; 2: Trust DSCP","format":"int32"},"qosQueueEnable":{"type":"boolean","description":"Indicates whether the ES device port has enabled the Qos scheduling queue configuration"},"queueId":{"type":"integer","description":"ES Qos scheduling queue ID","format":"int32"},"removedOuiBasedRuleIds":{"type":"array","description":"The id of oui based vlan rule removded.","items":{"type":"string","description":"The id of oui based vlan rule removded."}},"operation":{"pattern":"switching|mirroring|aggregating","type":"string","description":"Operation should be a value as follows: \"switching\" or \"mirroring\" or \"aggregating\""},"mirroredPorts":{"uniqueItems":true,"type":"array","description":"Mirrored Ports","items":{"type":"integer","description":"Mirrored Ports","format":"int32"}},"mirroredLags":{"uniqueItems":true,"type":"array","description":"Mirrored Lags","items":{"type":"integer","description":"Mirrored Lags","format":"int32"}},"lagSetting":{"$ref":"#/components/schemas/OswLagBasicVO"},"lagDelete":{"type":"boolean","description":"When the operation changes from aggregating to switching, this parameter should be set to true, and the \"lagSetting\" parameter needs to include the lagId."},"dot1x":{"type":"integer","description":"Dot1x should be a value as follows: 0: Force unauthorized; 1: Force authorized; 2: Auto","format":"int32"},"poe":{"type":"integer","description":"Poe should be a value as follows: 0: Off; 1: 802.3at/af","format":"int32"},"lldpMedEnable":{"type":"boolean","description":"Indicates whether LLDP-MED is enabled"},"topoNotifyEnable":{"type":"boolean","description":"Indicates whether Topology Notify is enabled"}}},"BatchOswPortSettingVO":{"required":["portList"],"type":"object","properties":{"name":{"pattern":"^[^ ?\"]$|^[^ ?\"][^?\"]{0,126}[^ ?\"]$","type":"string","description":"Port or Lag Name"},"tagIds":{"type":"array","description":"Tag ID List","items":{"type":"string","description":"Tag ID List"}},"nativeNetworkId":{"type":"string","description":"Native Network ID, Native Network cannot be selected from Tagged Networks or Untagged Networks."},"nativeBridgeVlan":{"type":"integer","description":"Native Network Bridge Vlan.","format":"int32"},"networkTagsSetting":{"type":"integer","description":"Network Tags Setting should be a value as follows: 0: Allow All; 1: Block All; 2: Custom","format":"int32"},"tagNetworkIds":{"type":"array","description":"Tag Network IDs","items":{"type":"string","description":"Tag Network IDs"}},"tagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Tag Network Bridge Vlan Map","items":{"type":"integer","description":"Tag Network Bridge Vlan Map","format":"int32"}},"description":"Tag Network Bridge Vlan Map"},"untagNetworkIds":{"type":"array","description":"Untag Network IDs","items":{"type":"string","description":"Untag Network IDs"}},"untagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Untag Network Bridge Vlan Map","items":{"type":"integer","description":"Untag Network Bridge Vlan Map","format":"int32"}},"description":"Untag Network Bridge Vlan Map"},"voiceNetworkEnable":{"type":"boolean","description":"Indicates whether voice network is enabled"},"voiceNetworkId":{"type":"string","description":"Voice Network ID"},"voiceBridgeVlan":{"type":"integer","description":"Voice Network Bridge Vlan","format":"int32"},"voiceDscpEnable":{"type":"boolean","description":"Indicates whether voice DSCP is enabled"},"voiceDscp":{"type":"integer","description":"Voice DSCP","format":"int32"},"portAlertEnable":{"type":"boolean","description":"Indicates whether port alert is enabled"},"fecMode":{"type":"integer","description":"FEC mode should be a value as follows: 1: Off; 2: RS528; 3: RS544; 4: Auto; 5: Base-R","format":"int32"},"fecLinkPeerApplyEnable":{"type":"boolean","description":"Indicates whether the FEC Mode is synchronously applied to the link peer port."},"disable":{"type":"boolean","description":"Indicates whether to disable"},"profileId":{"type":"string","description":"Profile ID is required (not null) when modifying a single port."},"profileOverrideEnable":{"type":"boolean","description":"Indicates whether to enable Profile Override before v6.2.10; Indicates the fill mode of port configuration after v6.2.10: true: custom; false: follow profile"},"profileVlanOverrideEnable":{"type":"boolean","description":"Indicates the fill mode of vlan configuration: true: custom; false: follow profile"},"linkSpeed":{"type":"integer","description":"Link Speed should be a value as follows: 0: auto; 1: 10M; 2: 100M; 3: 1000M; 4: 2.5G; 5: 10G","format":"int32"},"duplex":{"type":"integer","description":"Duplex should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"},"igmpSnoopingEnable":{"type":"boolean","description":"Indicates whether IGMP Snooping is enabled"},"bandWidthCtrlType":{"type":"integer","description":"BandWidthCtrlType should be a value as follows: 0: Off; 1: Rate Limit; 2: Storming Control","format":"int32"},"bandCtrl":{"$ref":"#/components/schemas/OswBandCtrlVO"},"stormCtrl":{"$ref":"#/components/schemas/OswStormCtrlVO"},"spanningTreeEnable":{"type":"boolean","description":"Indicates whether SpanningTree is enabled"},"spanningTreeSetting":{"$ref":"#/components/schemas/SpanningTreeSettingVO"},"loopbackDetectEnable":{"type":"boolean","description":"Indicates whether loopbackDetect port based is enabled"},"loopbackDetectVlanBasedEnable":{"type":"boolean","description":"Indicates whether loopbackDetect vlan based is enabled"},"igmpFastLeaveEnable":{"type":"boolean","description":"Indicates whether igmp fast leave is enabled"},"mldFastLeaveEnable":{"type":"boolean","description":"Indicates whether mld fast leave is enabled"},"portIsolationEnable":{"type":"boolean","description":"Indicates whether port isolation is enabled"},"eeeEnable":{"type":"boolean","description":"Indicates whether EEE is enabled"},"flowControlEnable":{"type":"boolean","description":"Indicates whether flow control is enabled"},"fastLeaveEnable":{"type":"boolean","description":"Indicates whether igmpSnooping fastLeave is enabled"},"dhcpL2RelaySettings":{"$ref":"#/components/schemas/OswPortDhcpL2RelayVO"},"dot1pPriority":{"type":"integer","description":"Dot1p Priority","format":"int32"},"trustMode":{"type":"integer","description":"TrustMode should be a value as follows: 0: Untrusted; 1: Trust 802.1p; 2: Trust DSCP","format":"int32"},"qosQueueEnable":{"type":"boolean","description":"Indicates whether the ES device port has enabled the Qos scheduling queue configuration"},"queueId":{"type":"integer","description":"ES Qos scheduling queue ID","format":"int32"},"removedOuiBasedRuleIds":{"type":"array","description":"The id of oui based vlan rule removded.","items":{"type":"string","description":"The id of oui based vlan rule removded."}},"operation":{"pattern":"switching|mirroring|aggregating","type":"string","description":"Operation should be a value as follows: \"switching\" or \"mirroring\" or \"aggregating\""},"mirroredPorts":{"uniqueItems":true,"type":"array","description":"Mirrored Ports","items":{"type":"integer","description":"Mirrored Ports","format":"int32"}},"mirroredLags":{"uniqueItems":true,"type":"array","description":"Mirrored Lags","items":{"type":"integer","description":"Mirrored Lags","format":"int32"}},"lagSetting":{"$ref":"#/components/schemas/OswLagBasicVO"},"lagDelete":{"type":"boolean","description":"When the operation changes from aggregating to switching, this parameter should be set to true, and the \"lagSetting\" parameter needs to include the lagId."},"dot1x":{"type":"integer","description":"Dot1x should be a value as follows: 0: Force unauthorized; 1: Force authorized; 2: Auto","format":"int32"},"poe":{"type":"integer","description":"Poe should be a value as follows: 0: Off; 1: 802.3at/af","format":"int32"},"lldpMedEnable":{"type":"boolean","description":"Indicates whether LLDP-MED is enabled"},"topoNotifyEnable":{"type":"boolean","description":"Indicates whether Topology Notify is enabled"},"portList":{"maxItems":2147483647,"minItems":1,"type":"array","items":{"maximum":2147483647,"minimum":1,"type":"integer","format":"int32"}}}},"OswLagSettingVO":{"type":"object","properties":{"name":{"pattern":"^[^ ?\"]$|^[^ ?\"][^?\"]{0,126}[^ ?\"]$","type":"string","description":"Port or Lag Name"},"tagIds":{"type":"array","description":"Tag ID List","items":{"type":"string","description":"Tag ID List"}},"nativeNetworkId":{"type":"string","description":"Native Network ID, Native Network cannot be selected from Tagged Networks or Untagged Networks."},"nativeBridgeVlan":{"type":"integer","description":"Native Network Bridge Vlan.","format":"int32"},"networkTagsSetting":{"type":"integer","description":"Network Tags Setting should be a value as follows: 0: Allow All; 1: Block All; 2: Custom","format":"int32"},"tagNetworkIds":{"type":"array","description":"Tag Network IDs","items":{"type":"string","description":"Tag Network IDs"}},"tagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Tag Network Bridge Vlan Map","items":{"type":"integer","description":"Tag Network Bridge Vlan Map","format":"int32"}},"description":"Tag Network Bridge Vlan Map"},"untagNetworkIds":{"type":"array","description":"Untag Network IDs","items":{"type":"string","description":"Untag Network IDs"}},"untagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Untag Network Bridge Vlan Map","items":{"type":"integer","description":"Untag Network Bridge Vlan Map","format":"int32"}},"description":"Untag Network Bridge Vlan Map"},"voiceNetworkEnable":{"type":"boolean","description":"Indicates whether voice network is enabled"},"voiceNetworkId":{"type":"string","description":"Voice Network ID"},"voiceBridgeVlan":{"type":"integer","description":"Voice Network Bridge Vlan","format":"int32"},"voiceDscpEnable":{"type":"boolean","description":"Indicates whether voice DSCP is enabled"},"voiceDscp":{"type":"integer","description":"Voice DSCP","format":"int32"},"portAlertEnable":{"type":"boolean","description":"Indicates whether port alert is enabled"},"fecMode":{"type":"integer","description":"FEC mode should be a value as follows: 1: Off; 2: RS528; 3: RS544; 4: Auto; 5: Base-R","format":"int32"},"fecLinkPeerApplyEnable":{"type":"boolean","description":"Indicates whether the FEC Mode is synchronously applied to the link peer port."},"disable":{"type":"boolean","description":"Indicates whether to disable"},"profileId":{"type":"string","description":"Profile ID is required (not null) when modifying a single port."},"profileOverrideEnable":{"type":"boolean","description":"Indicates whether to enable Profile Override before v6.2.10; Indicates the fill mode of port configuration after v6.2.10: true: custom; false: follow profile"},"profileVlanOverrideEnable":{"type":"boolean","description":"Indicates the fill mode of vlan configuration: true: custom; false: follow profile"},"linkSpeed":{"type":"integer","description":"Link Speed should be a value as follows: 0: auto; 1: 10M; 2: 100M; 3: 1000M; 4: 2.5G; 5: 10G","format":"int32"},"duplex":{"type":"integer","description":"Duplex should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"},"igmpSnoopingEnable":{"type":"boolean","description":"Indicates whether IGMP Snooping is enabled"},"bandWidthCtrlType":{"type":"integer","description":"BandWidthCtrlType should be a value as follows: 0: Off; 1: Rate Limit; 2: Storming Control","format":"int32"},"bandCtrl":{"$ref":"#/components/schemas/OswBandCtrlVO"},"stormCtrl":{"$ref":"#/components/schemas/OswStormCtrlVO"},"spanningTreeEnable":{"type":"boolean","description":"Indicates whether SpanningTree is enabled"},"spanningTreeSetting":{"$ref":"#/components/schemas/SpanningTreeSettingVO"},"loopbackDetectEnable":{"type":"boolean","description":"Indicates whether loopbackDetect port based is enabled"},"loopbackDetectVlanBasedEnable":{"type":"boolean","description":"Indicates whether loopbackDetect vlan based is enabled"},"igmpFastLeaveEnable":{"type":"boolean","description":"Indicates whether igmp fast leave is enabled"},"mldFastLeaveEnable":{"type":"boolean","description":"Indicates whether mld fast leave is enabled"},"portIsolationEnable":{"type":"boolean","description":"Indicates whether port isolation is enabled"},"eeeEnable":{"type":"boolean","description":"Indicates whether EEE is enabled"},"flowControlEnable":{"type":"boolean","description":"Indicates whether flow control is enabled"},"fastLeaveEnable":{"type":"boolean","description":"Indicates whether igmpSnooping fastLeave is enabled"},"dhcpL2RelaySettings":{"$ref":"#/components/schemas/OswPortDhcpL2RelayVO"},"dot1pPriority":{"type":"integer","description":"Dot1p Priority","format":"int32"},"trustMode":{"type":"integer","description":"TrustMode should be a value as follows: 0: Untrusted; 1: Trust 802.1p; 2: Trust DSCP","format":"int32"},"qosQueueEnable":{"type":"boolean","description":"Indicates whether the ES device port has enabled the Qos scheduling queue configuration"},"queueId":{"type":"integer","description":"ES Qos scheduling queue ID","format":"int32"},"removedOuiBasedRuleIds":{"type":"array","description":"The id of oui based vlan rule removded.","items":{"type":"string","description":"The id of oui based vlan rule removded."}},"operation":{"pattern":"switching|mirroring|aggregating","type":"string","description":"Operation should be a value as follows: \"switching\" or \"mirroring\" or \"aggregating\""},"lagId":{"type":"integer","description":"Lag ID","format":"int32"},"lagType":{"type":"integer","description":"Lag Type should be a value as follows: 1: STATIC; 2: LACP; 3: LACP ACTIVE; 4: LACP PASSIVE","format":"int32"},"ports":{"type":"array","description":"Lag Ports","items":{"type":"integer","description":"Lag Ports","format":"int32"}},"mlagName":{"type":"string","description":"M-LAG group Name"},"mlagEnable":{"type":"boolean","description":"Indicates whether M-LAG port is enabled"},"mlagPeerSetting":{"$ref":"#/components/schemas/OswMlagPeerSettingVO"}}},"LogNotificationEditOpenApiVO":{"required":["alert","email","event","key"],"type":"object","properties":{"key":{"type":"string","description":"For the values of Log Notification Key, refer to section 5.6.1 of the Open API Access","example":"LOGIN_OK"},"alert":{"type":"boolean","description":"Log Notification Enable or Disable Alert","example":false},"event":{"type":"boolean","description":"Log Notification Enable or Disable Event","example":true},"email":{"type":"boolean","description":"Log Notification Enable or Disable Email","example":true},"webhook":{"type":"boolean","description":"Log Notification Category Enable or Disable Webhook (This config applies to the Omada Pro Controller only and should not bu null)","example":false}},"description":"Log Notification List"},"LogNotificationSettingEditOpenApiVO":{"required":["logNotifications"],"type":"object","properties":{"webhookConfig":{"$ref":"#/components/schemas/WebhookConfigEditOpenApiVO"},"logNotifications":{"type":"array","description":"Log Notification List","items":{"$ref":"#/components/schemas/LogNotificationEditOpenApiVO"}},"alertEmailSetting":{"$ref":"#/components/schemas/LogAlertEmailOpenApiVO"}}},"AuditLogNotificationEditOpenApiVO":{"required":["key","webhook"],"type":"object","properties":{"key":{"type":"string","description":"For the values of Audit Log Notification Category Key, refer to section 5.2.1 of the Open API Access","example":"DASHBOARD"},"webhook":{"type":"boolean","description":"Audit Log Notification Category Enable or Disable Webhook","example":false}},"description":"Audit Log Notification List"},"AuditLogNotificationSettingEditOpenApiVO":{"required":["auditLogNotifications","webhookConfig"],"type":"object","properties":{"webhookConfig":{"$ref":"#/components/schemas/WebhookConfigEditOpenApiVO"},"auditLogNotifications":{"type":"array","description":"Audit Log Notification List","items":{"$ref":"#/components/schemas/AuditLogNotificationEditOpenApiVO"}}}},"Access":{"type":"object","properties":{"accesses":{"maxItems":3,"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/AccessItem"}}}},"AccessItem":{"required":["phone"],"type":"object","properties":{"countryCode":{"maxLength":2,"minLength":2,"type":"string","description":"Country code should contain 2 characters. Country code must be entered when entering the calling code. For the values of Country code, refer to section 5.4.1 of the Open API Access Guide."},"callingCode":{"pattern":"\\+\\d{1,4}","type":"string","description":"Calling code should contain 2 to 5 characters. Calling code must be entered when entering the country code. For the values of Calling code, refer to section 5.4.1 of the Open API Access Guide."},"phone":{"pattern":"\\d{1,20}","type":"string","description":"Allowed phone numbers."}}},"ContentPortInfo":{"required":["id","ip","usage"],"type":"object","properties":{"id":{"type":"string","description":"Port Uuid."},"name":{"type":"string","description":"Port name."},"ip":{"type":"boolean","description":"Whether to query the port IP."},"usage":{"type":"boolean","description":"Whether to query the port data usage."}}},"Reboot":{"type":"object","properties":{"command":{"pattern":"^[\\x21\\x23-\\x26\\x28-\\x7E]{1,64}$","type":"string","description":"To reboot the router via SMS, send a message starting with \"LTE Router Reboot\", followed by Password/PIN(e.g. LTE Router Reboot 1234). Password is required for the control of device restart via SMS."}}},"SmsRouterCommand":{"required":["accessEnable","rebootEnable","statusEnable"],"type":"object","properties":{"rebootEnable":{"type":"boolean","description":"Whether to enable the control of device restart via SMS."},"reboot":{"$ref":"#/components/schemas/Reboot"},"statusEnable":{"type":"boolean","description":"Whether to enable Viewing device-related information and WAN port-related information via SMS."},"status":{"$ref":"#/components/schemas/Status"},"accessEnable":{"type":"boolean","description":"Whether to enable the allow list of the above functions, and only allow users in the list to interact with the device."},"access":{"$ref":"#/components/schemas/Access"},"resource":{"type":"integer","description":"The SMS router command setting creation resource, such as: 0: new created, 1: from template, 2: override.","format":"int32"}}},"Status":{"type":"object","properties":{"command":{"pattern":"^[\\x21\\x23-\\x26\\x28-\\x7E]{1,64}$","type":"string","description":"To get status information from the router, send a message starting with \"LTE Router Status\", followed by Password/PIN(e.g. LTE Router Status 1234). The password is required for viewing device-related Information via SMS."},"content":{"$ref":"#/components/schemas/StatusContent"}}},"StatusContent":{"type":"object","properties":{"name":{"type":"boolean","description":"Whether to query device model name."},"uptime":{"type":"boolean","description":"Whether to query device boot time."},"version":{"type":"boolean","description":"Whether to query device firmware version."},"mac":{"type":"boolean","description":"Whether to query device MAC address."},"ports":{"type":"array","items":{"$ref":"#/components/schemas/ContentPortInfo"}}}},"SmaPolicySetting":{"required":["inboxPolicy"],"type":"object","properties":{"inboxPolicy":{"type":"integer","description":"Policy parameter [inboxPolicy] should be from 0 to 2. 0: If SMS inbox/outbox is full, delete the oldest read SMS; 1: If SMS inbox/outbox is full, send e-mail alert to Administrator;2: If SMS inbox/outbox is full, Forward new SMS with e-mail to Administrator.","format":"int32"},"mailServer":{"type":"string","description":"Mail server ID."},"resource":{"type":"integer","description":"SMS policy setting creation resource, such as: 0: new created, 1: from template, 2: override.","format":"int32"}}},"AdvancedFeatureOpenApiVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the feature"}}},"AirtimeFairnessSettingOpenApiVO":{"required":["enable2g","enable5g","enable6g"],"type":"object","properties":{"enable2g":{"type":"boolean","description":"Whether to enable 2G airtime fairness"},"enable5g":{"type":"boolean","description":"Whether to enable 5G airtime fairness"},"enable6g":{"type":"boolean","description":"Whether to enable 6G airtime fairness"}},"description":"Site airtime fairness setting."},"BandSteeringMultiBandOpenApiVO":{"required":["mode"],"type":"object","properties":{"mode":{"type":"integer","description":"Mode should be a value as follows: 0: Disable; 1: Prefer 5GHz/6GHz; 2: Balance","format":"int32"}},"description":"Site band steering multi band setting."},"BandSteeringOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Band steer enable."},"connectionThreshold":{"type":"integer","description":"The range of connect threshold is from 2 to 256, with a default of 30.","format":"int32"},"differenceThreshold":{"type":"integer","description":"The range of difference threshold is from 1 to 20, with a default of 4.","format":"int32"},"maxFailures":{"type":"integer","description":"The range of maxFailures threshold is from 1 to 20, with a default of 5.","format":"int32"}},"description":"Site band steering setting."},"BeaconControlOpenApiVO":{"required":["dtimPeriod2g","dtimPeriod5g","dtimPeriod6g","rtsThreshold2g","rtsThreshold5g","rtsThreshold6g"],"type":"object","properties":{"beaconInterval2g":{"type":"integer","description":"2.4GHz beacon interval, parameter beaconInterval2g should be within the range of 40-500)","format":"int32"},"beaconIntvMode2g":{"type":"integer","description":"Configuration for Beacon Interval Mode in the 2G Band:0: Auto 1: Custom","format":"int32"},"dtimPeriod2g":{"type":"integer","description":"2.4GHz DTIM period, parameter dtimPeriod2g should be within the range of 1-255","format":"int32"},"rtsThreshold2g":{"type":"integer","description":"2.4GHz RTS threshold, parameter rtsThreshold2g should be within the range of 1-2347","format":"int32"},"beaconInterval5g":{"type":"integer","description":"5GHz beacon interval, parameter beaconInterval5g should be within the range of 40-500)","format":"int32"},"beaconIntvMode5g":{"type":"integer","description":"Configuration for Beacon Interval Mode in the 5G Band:0: Auto 1: Custom","format":"int32"},"dtimPeriod5g":{"type":"integer","description":"5GHz DTIM period, parameter dtimPeriod5g should be within the range of 1-255","format":"int32"},"rtsThreshold5g":{"type":"integer","description":"5GHz RTS threshold, parameter rtsThreshold5g should be within the range of 1-2347","format":"int32"},"beaconInterval6g":{"type":"integer","description":"6GHz beacon interval, parameter beaconInterval6g should be within the range of 40-500)","format":"int32"},"beaconIntvMode6g":{"type":"integer","description":"6g band Beacon Interval mode: 0-auto, 1-custom","format":"int32"},"dtimPeriod6g":{"type":"integer","description":"6GHz DTIM period, parameter dtimPeriod6g should be within the range of 1-255","format":"int32"},"rtsThreshold6g":{"type":"integer","description":"6GHz RTS threshold, parameter rtsThreshold6g should be within the range of 1-2347","format":"int32"}},"description":"Site beacon control setting."},"DstTimeDTO":{"required":["day","hour","minute","month","serial"],"type":"object","properties":{"month":{"type":"integer","description":"Month of the DST config should be a value as follows: 1: January; 2: February; 3: March; 4: April; 5: May; 6: June; 7: July; 8: August; 9: September; 10: October; 11: November; 12: December.","format":"int32"},"serial":{"type":"integer","description":"Week of the DST config should be a value as follows: 1: 1st; 2: 2nd; 3: 3rd; 4: 4th; 5: Last.","format":"int32"},"day":{"type":"integer","description":"Day of the DST config should be a value as follows: 1: Monday; 2: Tuesday; 3: Wednesday; 4: Thursday; 5: Friday; 6: Saturday; 7: Sunday.","format":"int32"},"hour":{"type":"integer","description":"Hour of the DST config should be within the range of 0–23.","format":"int32"},"minute":{"type":"integer","description":"Minute of the DST config should be within the range of 0–59.","format":"int32"}},"description":"DST end time config"},"NewChannelLimitSettingOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable channel limit."}}},"NewMcastRateLimitSettingOpenApiVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"Parameter [enable] indicates whether to enable the multicast rate limiting function. True: on, false: off"},"arpEnable":{"type":"boolean","description":"Whether to enable ARP."},"arpPps":{"type":"integer","description":"Parameter [arpPps] indicates the number of ARP packets allowed to pass per second.","format":"int32"},"ndEnable":{"type":"boolean","description":"Whether to enable ND."},"ndPps":{"type":"integer","description":"Parameter [ndPps] indicates the number of ND packets allowed to pass per second.","format":"int32"},"igmpEnable":{"type":"boolean","description":"Whether to enable IGMP."},"igmpPps":{"type":"integer","description":"Parameter [igmpPps] indicates the number of IGMP packets allowed to pass per second.","format":"int32"},"dhcpEnable":{"type":"boolean","description":"Whether to enable DHCP."},"dhcpPps":{"type":"integer","description":"Parameter [dhcpPps] indicates the number of DHCP packets allowed to pass per second.","format":"int32"},"dhcpv6Enable":{"type":"boolean","description":"Whether to enable DHCP v6."},"dhcpv6Pps":{"type":"integer","description":"Parameter [dhcpv6Pps] indicates the number of DHCP v6 packets allowed to pass per second.","format":"int32"},"mdnsEnable":{"type":"boolean","description":"Whether to enable MDNS."},"mdnsPps":{"type":"integer","description":"Parameter [mdnsPps] indicates the number of MDNS packets allowed to pass per second.","format":"int32"},"otherBcastEnable":{"type":"boolean","description":"Whether to enable OTHER BROADCAST."},"otherBcastPps":{"type":"integer","description":"Parameter [otherBcastPps] indicates the number of OTHER BROADCAST packets allowed to pass per second.","format":"int32"},"otherMcastEnable":{"type":"boolean","description":"Whether to enable OTHER MULTICAST."},"otherMcastPps":{"type":"integer","description":"Parameter [otherMcastPps] indicates the number of OTHER MULTICAST packets allowed to pass per second.","format":"int32"}},"description":"Site multicast rate limit setting"},"NewMeshSettingOpenApiVO":{"required":["meshEnable"],"type":"object","properties":{"meshEnable":{"type":"boolean","description":"Whether to enable mesh"},"autoFailoverEnable":{"type":"boolean","description":"Whether to enable auto failover"},"defGatewayEnable":{"type":"boolean","description":"Connectivity detection, parameter defGatewayEnable should be a value as follows: true: Auto(Recommended) ; false: Customer IP"},"gateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Customer IP"},"fullSector":{"type":"boolean","description":"Whether to enable full-sector DFS"}},"description":"Site mesh setting."},"NewRoamingSettingOpenApiVO":{"required":["aiRoamingEnable","fastRoamingEnable"],"type":"object","properties":{"fastRoamingEnable":{"type":"boolean","description":"Whether to enable fast roaming"},"aiRoamingEnable":{"type":"boolean","description":"Whether to enable AI roaming, this configuration will take effect only when fast roaming is enabled"},"nonStickRoamingEnable":{"type":"boolean","description":"Whether to enable non-stick roaming"},"nonPingPongRoamingEnable":{"type":"boolean","description":"Whether to enable non-ping-pong roaming"},"pingPongAssocThreshold":{"type":"integer","description":"Association frequency threshold of ping-pong roaming","format":"int32"}},"description":"Site roaming setting"},"RemoteLogSettingOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the feature"},"host":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"The IP address of the remote log server"},"port":{"type":"integer","description":"Port of the remote log server, port should be within the range of 1-65535","format":"int32"},"moreClientLog":{"type":"boolean","description":"Whether it contains client log"}},"description":"Site remote logging setting."},"Site setting:dst":{"type":"object","properties":{"enable":{"type":"boolean","description":"DST config status; If false, other parameters are not required."},"mode":{"type":"integer","description":"DST config mode; If disable, other parameters are not required. 0: disable, 1: auto, 2: manually","format":"int32"},"offset":{"type":"integer","description":"DST offset config(Unit: ms); It should be a value as follows: [1800000, 3600000, 5400000, 7200000].","format":"int64"},"start":{"$ref":"#/components/schemas/DstTimeDTO"},"end":{"$ref":"#/components/schemas/DstTimeDTO"}},"description":"Daylight Saving Time."},"SiteApLldpSettingOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable LLDP."}},"description":"Site lldp setting."},"SiteTemplateOpenApiVO":{"type":"object","properties":{"timeZone":{"type":"string","description":"For the values of the timezone of the site, refer to section 5.1 of the Open API Access Guide."},"dst":{"$ref":"#/components/schemas/Site setting:dst"},"ntpEnable":{"type":"boolean","description":"NTP server status of the site."},"ntpServers":{"maxItems":5,"minItems":0,"type":"array","description":"NTP server address; Up to 5 entries are allowed for the NTP server address list.","items":{"$ref":"#/components/schemas/ntp server"}}},"description":"Site template setting."},"SiteTemplateSettingOpenApiVO":{"type":"object","properties":{"siteTemplate":{"$ref":"#/components/schemas/SiteTemplateOpenApiVO"},"mesh":{"$ref":"#/components/schemas/NewMeshSettingOpenApiVO"},"remoteLog":{"$ref":"#/components/schemas/RemoteLogSettingOpenApiVO"},"advancedFeature":{"$ref":"#/components/schemas/AdvancedFeatureOpenApiVO"},"channelLimit":{"$ref":"#/components/schemas/NewChannelLimitSettingOpenApiVO"},"lldp":{"$ref":"#/components/schemas/SiteApLldpSettingOpenApiVO"},"beaconControl":{"$ref":"#/components/schemas/BeaconControlOpenApiVO"},"bandSteering":{"$ref":"#/components/schemas/BandSteeringOpenApiVO"},"bandSteeringForMultiBand":{"$ref":"#/components/schemas/BandSteeringMultiBandOpenApiVO"},"airtimeFairness":{"$ref":"#/components/schemas/AirtimeFairnessSettingOpenApiVO"},"led":{"$ref":"#/components/schemas/SiteLedSetting"},"roaming":{"$ref":"#/components/schemas/NewRoamingSettingOpenApiVO"},"SiteMulticastRateLimitSetting":{"$ref":"#/components/schemas/NewMcastRateLimitSettingOpenApiVO"}}},"WanPortsOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"whether to enable wan Settings Override"},"preOsgModel":{"type":"integer","description":"select gateway model, you can query option from 'Get supported gateway model list for pre-configuration'. If already choose or adopted gateway,use current gateway model id.","format":"int32"},"wanPortNum":{"type":"integer","description":"custom number of wan ports, only for preOsgModel at 2","format":"int32"},"portUuids":{"type":"array","description":"select wan ports to open, and other wan ports will be closed, you can get port uuid list from 'Get internet basic info'.","items":{"type":"string","description":"select wan ports to open, and other wan ports will be closed, you can get port uuid list from 'Get internet basic info'."}},"forceChange":{"type":"boolean","description":"Force change wan ports. If set true, wan ports will be modified without check, and the gateway will reboot. If set false, consequence will be checked and return check result."}}},"ModifyProviderProfileEntity":{"type":"object","properties":{"profileName":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Provider profile name"},"providerSettings":{"$ref":"#/components/schemas/ModifyProviderSettingOpenApiVO"}}},"ModifyProviderSettingOpenApiVO":{"type":"object","properties":{"provider":{"type":"integer","description":"The telephony providers supported. The range is between 0 and 13. 0: Other Provider; 1: 1 & 1 Internet; 2: Congstar; 3: Vodafone/Arcor; 4: DUS.net; 5: Easybell; 6: Kabel Deutschland; 7: QSC/Q-DSL home; 8: Sipgate; 9: Sipgate Team; 10: Sipload; 11: Ventengo; 12: Telekom; 13: Bellsip. The default value is 0.","format":"int32"},"registrarAddress":{"type":"string","description":"When parameter [provider] is a value in[0, 6], parameter [registrarAddress] should not be null."},"username":{"type":"string","description":"When parameter [provider] is a value in [0, 2, 4, 5, 8, 9, 10, 11, 12, 13], parameter [username] should not be null."},"password":{"type":"string"},"portSettings":{"$ref":"#/components/schemas/PortSettingVO"}},"description":"Telephony provider settings"},"VoipEmergencyNumberSetting":{"required":["emergencyNumberEnable"],"type":"object","properties":{"emergencyNumberEnable":{"type":"boolean","description":"Whether to enable the emergency number."},"noOperationTime":{"type":"integer","description":"No operation time should be within the range of 2-8s.","format":"int32"},"emergencyNumbers":{"type":"array","description":"Emergency number list.","items":{"type":"string","description":"Emergency number list."}}}},"DndSettingEntity":{"required":["enable"],"type":"object","properties":{"omadacId":{"type":"string","description":"Omadac ID"},"siteId":{"type":"string","description":"Site ID"},"enable":{"type":"boolean","description":"Enable DND or not"},"dayMode":{"type":"integer","description":"The days you want to block the incoming calls. 1-daily，2-weekend，3-weekday","format":"int32"},"timeBegin":{"type":"integer","description":"The start time of the DND period you want to block incoming calls. It should be an integer value between 0 and 1438.","format":"int32"},"timeEnd":{"type":"integer","description":"The end time of the DND period you want to block incoming calls. It should be an integer value between 1 and 1439.","format":"int32"}}},"ModifyDigitMapProfileEntity":{"type":"object","properties":{"profileName":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Digit map profile name"},"digitMap":{"type":"string","description":"Digit map"}}},"ModifyCallBlockingProfileEntity":{"type":"object","properties":{"profileName":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Call blocking profile name"},"incomingCallsBlockingEnable":{"type":"boolean","description":"Enable incoming calls blocking or not. The default value is false."},"incomingCallsBlocking":{"$ref":"#/components/schemas/IncomingCallsBlockingVO"},"outgoingCallsBlockingEnable":{"type":"boolean","description":"Enable outgoing calls blocking or not. The default value is false."},"outgoingCallsBlocking":{"$ref":"#/components/schemas/OutgoingCallsBlockingVO"}}},"VirtualWanStatusOpenApiVO":{"required":["status"],"type":"object","properties":{"status":{"type":"boolean","description":"The status of virtual WAN, valid values are true or false."}},"description":"VirtualWanStatusOpenApiVO"},"SnmpSettingOpenApiVO":{"required":["snmpV1V2CEnable","snmpV3Enable"],"type":"object","properties":{"snmpV1V2CEnable":{"type":"boolean","description":"SNMPv1 & SNMPv2c enable status"},"communityString":{"pattern":"^[\\041\\043-\\076\\0100-\\0176]{1,64}$","type":"string","description":"Community string, valid when parameter [snmpV1V2CEnable] is true. The communityString should contain at least 10 characters, using a combination of numbers, letters or special characters. \nThe communityString should not contain consecutive identical characters."},"snmpV3Enable":{"type":"boolean","description":"SNMPv3 enable status"},"username":{"pattern":"^[0-9a-zA-Z\\-\\_]{1,30}$","type":"string","description":"Username, valid when parameter [snmpV3Enable] is true. Username should contain 1 to 30 characters"},"password":{"pattern":"^[\\041\\043-\\076\\0100-\\0133\\0135-\\0176]{8,32}$","type":"string","description":"The password should contain at least 10 characters, using a combination of numbers, letters or special characters. \nThe password should not contain consecutive identical characters. \nUsername and Password should not be the same."},"securityLevel":{"type":"integer","description":"Security Level should be a value as follows: 0: NoAuthNoPriv; 1: AuthNoPriv; 2: AuthPriv","format":"int32"},"authMode":{"type":"integer","description":"Authentication Mode should be a value as follows: 1: MD5; 2: SHA. When Security Level is AuthNoPriv or AuthPriv, this field is required","format":"int32"},"privacyMode":{"type":"integer","description":"Privacy Mode should be a value as follows: 1: DES; 2: AES. When Security Level is AuthPriv, this field is required","format":"int32"},"privacyPassword":{"pattern":"^[\\041\\043-\\076\\0100-\\0133\\0135-\\0176]{8,32}$","type":"string","description":"The privacy password should contain at least 10 characters, using a combination of numbers, letters or special characters. \nThe privacy password should not contain consecutive identical characters. \nUsername and privacy password should not be the same."},"location":{"pattern":"^[!-~][\\040-\\0176]{0,126}[!-~]$|^[!-~]$|$","type":"string","description":"Location"},"contact":{"pattern":"^[\\041-\\0176]{0,128}$","type":"string","description":"Contact"}}},"DnsOverrideSettingOpenApiVO":{"required":["primaryDnsServer"],"type":"object","properties":{"primaryDnsServer":{"type":"string","description":"Specify the primary upstream DNS server."},"secondaryDnsServer":{"type":"string","description":"Specify the secondary upstream DNS server."},"applyNetwork":{"type":"array","description":"Specify the effective LAN network to apply DNS Override. Available LAN networks can be obtained from 'Get all \"single\"-\"multi\" interface lan network'","items":{"type":"string","description":"Specify the effective LAN network to apply DNS Override. Available LAN networks can be obtained from 'Get all \"single\"-\"multi\" interface lan network'"}}},"description":"DNS Override setting, valid when parameter [type] is 3"},"DnsProxySettingOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"DNS proxy setting enable status"},"type":{"type":"integer","description":"DNS proxy setting type. Type should be a value as follows: 0: DNSSEC, 1: DoH, 2: DoT, 3: DNS Override","format":"int32"},"dnsSecSetting":{"$ref":"#/components/schemas/DnsSecSettingOpenApiVO"},"dohSetting":{"$ref":"#/components/schemas/DohSettingOpenApiVO"},"dotSetting":{"$ref":"#/components/schemas/DotSettingOpenApiVO"},"dnsOverrideSetting":{"$ref":"#/components/schemas/DnsOverrideSettingOpenApiVO"}}},"DnsSecSettingOpenApiVO":{"required":["replyPolicy","servers"],"type":"object","properties":{"servers":{"type":"array","description":"DNS Server IP list, Up to 2 entries are allowed for the server list","items":{"type":"string","description":"DNS Server IP list, Up to 2 entries are allowed for the server list"}},"replyPolicy":{"type":"integer","description":"Bogus DNS reply policy type. ReplyPolicy should be a value as follows: 0: Pass, 1: Drop","format":"int32"}},"description":"DNS proxy DNSSEC setting, valid when parameter [type] is 0"},"DohCustomizedServerOpenApiVO":{"required":["enable","name","server"],"type":"object","properties":{"enable":{"type":"boolean","description":"Custom service enable status"},"name":{"type":"string","description":"Custom service name, should contain 1 to 64 characters"},"server":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"Custom service IP or domain"}},"description":"Custom Service list. Up to 2 DoH default and custom Servers can be selected, setting the parameter [enable] to true indicates the selection of the custom server."},"DohSettingOpenApiVO":{"type":"object","properties":{"defaultServers":{"uniqueItems":true,"type":"array","description":"Preconfigured Server List. DefaultServers should be a value as follows: 0:Google, 1：Cloudflare, 4：CleanBrowsing, 5：Quad9_1, 6: Quad9_2. Up to 2 DoH default and custom servers can be selected. For example, defaultServers : [0, 1] represents that you have selected default services Google and Cloudflare","items":{"type":"integer","description":"Preconfigured Server List. DefaultServers should be a value as follows: 0:Google, 1：Cloudflare, 4：CleanBrowsing, 5：Quad9_1, 6: Quad9_2. Up to 2 DoH default and custom servers can be selected. For example, defaultServers : [0, 1] represents that you have selected default services Google and Cloudflare","format":"int32"}},"customizedServers":{"type":"array","description":"Custom Service list. Up to 2 DoH default and custom Servers can be selected, setting the parameter [enable] to true indicates the selection of the custom server.","items":{"$ref":"#/components/schemas/DohCustomizedServerOpenApiVO"}}},"description":"DNS proxy DoH setting, valid when parameter [type] is 1"},"DotCustomizedServerOpenApiVO":{"required":["enable","name","servers"],"type":"object","properties":{"enable":{"type":"boolean","description":"Custom service enable status"},"name":{"type":"string","description":"Custom service name, should contain 1 to 64 characters"},"servers":{"type":"array","description":"Custom service IPs, up to 2 IPs can be configured","items":{"type":"string","description":"Custom service IPs, up to 2 IPs can be configured"}}},"description":"Custom Service list. Up to 2 DoT default and custom Servers can be selected, setting the parameter [enable] to true indicates the selection of the custom server."},"DotSettingOpenApiVO":{"type":"object","properties":{"defaultServers":{"uniqueItems":true,"type":"array","description":"Preconfigured Server List. DefaultServers should be a value as follows: 0:Google, 1：Cloudflare, 2：OpenDNS, 3：Quad9, 4: CleanBrowsing. Up to 2 DoT default and custom servers can be selected. For example, defaultServers : [0, 1] represents that you have selected default services Google and Cloudflare","items":{"type":"integer","description":"Preconfigured Server List. DefaultServers should be a value as follows: 0:Google, 1：Cloudflare, 2：OpenDNS, 3：Quad9, 4: CleanBrowsing. Up to 2 DoT default and custom servers can be selected. For example, defaultServers : [0, 1] represents that you have selected default services Google and Cloudflare","format":"int32"}},"customizedServers":{"type":"array","description":"Custom Service list. Up to 2 DoT default and custom Servers can be selected, setting the parameter [enable] to true indicates the selection of the custom server.","items":{"$ref":"#/components/schemas/DotCustomizedServerOpenApiVO"}}},"description":"DNS proxy DoT setting, valid when parameter [type] is 2"},"MailServerOpenApiModifyVO":{"required":["auth","receiver","sender","ssl"],"type":"object","properties":{"sender":{"pattern":"[-0-9a-zA-Z.+_]+@[-0-9a-zA-Z.+_]+\\.[a-zA-Z0-9]{2,}","type":"string","description":"The email address of the sender."},"receiver":{"pattern":"[-0-9a-zA-Z.+_]+@[-0-9a-zA-Z.+_]+\\.[a-zA-Z0-9]{2,}","type":"string","description":"The email address of the receiver, which can be the same as or different from the sender's email address."},"ssl":{"type":"boolean","description":"Enable this feature, and the data will be transmitted based on the SSL protocol."},"smtpServer":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"Enter the domain name or IP address of the SMTP server."},"smtpPort":{"type":"integer","description":"Enter the port used by the SMTP server according to the instructions of your email service provider.","format":"int32"},"auth":{"type":"boolean","description":"Enable this feature if the login of the mailbox requires a username and authorization code."},"username":{"type":"string","description":"When Authentication is enabled, enter your email address as the username."},"authCode":{"type":"string","description":"When Authentication is enabled, enter the authorization code that enables a third party to log in to the mailbox. Note that the authorization code is not the mailbox's password."}}},"IotRadioSettingOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Bluetooth enable."},"consoleMode":{"type":"integer","description":"Bluetooth consle mode should be a value as follow:[0:auto, 1:on, 2:off].","format":"int32"},"passcode":{"pattern":"^[0-9]{6}$","type":"string","description":"Bluetooth consle passcode."},"transmitPower":{"type":"integer","description":"Broadcast transmission power.<br />The parameter [transmitPower] should be a value as follows:[-20, -18, -15, -12, -10, -9, -6, -5, -3, 0, 1, 2, 3, 4, 5, 14, 15, 16, 17, 18, 19, 20].(0 by default)","format":"int32"},"agingTime":{"type":"integer","description":"The system automatically removes a device's registry entry if no data reports are received within a predefined aging period.<br/>When format = 0, The parameter aging time should be within the range of 30-86400.<br/>When format = 1, The parameter aging time should be within the range of 1-1440.<br/>When format = 2, The parameter aging time should be within the range of 1-24.<br/>","format":"int32"},"format":{"type":"integer","description":"The parameter [format] should be a value as follows: [0:second 1:minute; 2:hour]","format":"int32"},"resource":{"type":"integer","format":"int32"}}},"FreeAuthClientPolicyOpenApiVO":{"required":["type"],"type":"object","properties":{"idInt":{"type":"integer","description":"Entry ID of the policy. Except for newly added policies, this parameter should be retained","format":"int32"},"type":{"type":"integer","description":"Type of the policy. It should be a value as follows: 3: Free auth client IP, and parameter [clientIp] is needed. 4: Free auth client MAC, and parameter [clientMac] is needed","format":"int32"},"clientIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Free auth client IP Address"},"clientMac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"Free auth client MAC Address, for example: AA-AA-AA-AA-AA-AA"},"description":{"type":"string","description":"Description of Pre-Authentication Access Policy"}},"description":"List of Free-Authentication Client Policy"},"PortalAccessControlOpenApiVO":{"required":["freeAuthClientEnable","preAuthAccessEnable"],"type":"object","properties":{"preAuthAccessEnable":{"type":"boolean","description":"Whether to enable Pre-Authentication Access. If parameter [preAuthAccessEnable] is true, parameter [preAuthAccessPolicies] is needed"},"preAuthAccessPolicies":{"type":"array","description":"List of Pre-Authentication Access Policy","items":{"$ref":"#/components/schemas/PreAuthAccessPolicyOpenApiVO"}},"freeAuthClientEnable":{"type":"boolean","description":"Whether to enable Free-Authentication Client. If parameter [freeAuthClientEnable] is true, parameter [freeAuthClientPolicies] is needed"},"freeAuthClientPolicies":{"type":"array","description":"List of Free-Authentication Client Policy","items":{"$ref":"#/components/schemas/FreeAuthClientPolicyOpenApiVO"}}}},"PreAuthAccessPolicyOpenApiVO":{"required":["type"],"type":"object","properties":{"idInt":{"type":"integer","description":"Entry ID of the policy. Except for newly added policies, this parameter should be retained","format":"int32"},"type":{"type":"integer","description":"Type of the policy. It should be a value as follows: 1: Destination IP Range, and parameter [ip] and [subnetMask] is needed. 2: URL, and parameter [url] is needed","format":"int32"},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP Address of Pre-Authentication Access"},"subnetMask":{"type":"integer","description":"Subnet mask of Pre-Authentication Access. It should be within the range of 1-32","format":"int32"},"url":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}(:([0-9]|[1-9]\\d{1,3}|[1-5]\\d{4}|6[0-4]\\d{4}|65[0-4]\\d{2}|655[0-2]\\d|6553[0-5]))?|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,18}(:([0-9]|[1-9]\\d{1,3}|[1-5]\\d{4}|6[0-4]\\d{4}|65[0-4]\\d{2}|655[0-2]\\d|6553[0-5]))?)","type":"string","description":"URL of Pre-Authentication Access"},"description":{"type":"string","description":"Description of Pre-Authentication Access Policy"}},"description":"List of Pre-Authentication Access Policy"},"OperationResponsePortalAccessControlOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PortalAccessControlOpenApiVO"}}},"Session limit entity":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Enable the session limit."}}},"TransmissionDragSortIndexOpenapiVO":{"required":["indexes"],"type":"object","properties":{"indexes":{"type":"object","additionalProperties":{"type":"integer","description":"The order in which items take effect, this object is a Map, the key is item ID and the value is the index you want to set.","format":"int32"},"description":"The order in which items take effect, this object is a Map, the key is item ID and the value is the index you want to set."}}},"ModifySiteServiceOpenApiVO":{"type":"object","properties":{"mesh":{"$ref":"#/components/schemas/NewMeshSettingOpenApiVO"},"remoteLog":{"$ref":"#/components/schemas/RemoteLogSettingOpenApiVO"},"lldp":{"$ref":"#/components/schemas/SiteApLldpSettingOpenApiVO"},"beaconControl":{"$ref":"#/components/schemas/BeaconControlOpenApiVO"},"bandSteering":{"$ref":"#/components/schemas/BandSteeringOpenApiVO"},"bandSteeringForMultiBand":{"$ref":"#/components/schemas/BandSteeringMultiBandOpenApiVO"},"airtimeFairness":{"$ref":"#/components/schemas/AirtimeFairnessSettingOpenApiVO"},"led":{"$ref":"#/components/schemas/SiteLedSetting"},"roaming":{"$ref":"#/components/schemas/NewRoamingSettingOpenApiVO"}}},"RoamingOpenApiVO":{"required":["aiRoamingEnable","fastRoamingEnable"],"type":"object","properties":{"fastRoamingEnable":{"type":"boolean","description":"Whether to enable fast roaming"},"aiRoamingEnable":{"type":"boolean","description":"Whether to enable AI roaming, this configuration will take effect only when fast roaming is enabled"},"dualBand11kReportEnable":{"type":"boolean","description":"Whether to enable 802.11k report. It has been deprecated.","deprecated":true},"forceDisassociationEnable":{"type":"boolean","description":"Whether to enable forced disassociation. Note: This field will no longer be supported since Omada Controller 5.14.24.40.","deprecated":true},"nonStickRoamingEnable":{"type":"boolean","description":"Whether to enable non-stick roaming"}},"description":"Site roaming."},"SiteRoamingSetting":{"required":["roaming"],"type":"object","properties":{"roaming":{"$ref":"#/components/schemas/RoamingOpenApiVO"}},"description":"Site roaming setting"},"RemoteLogSettingVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the feature"},"host":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"The IP address of the remote log server"},"port":{"type":"integer","description":"Port of the remote log server, port should be within the range of 1-65535","format":"int32"},"moreClientLog":{"type":"boolean","description":"Whether it contains client log"},"resource":{"type":"integer","description":"Data Source. Resource should be a value as follows: 0: new created; 1: from template; 2: override","format":"int32"}},"description":"Site remote logging."},"SiteRemoteLoggingSetting":{"type":"object","properties":{"remoteLog":{"$ref":"#/components/schemas/RemoteLogSettingVO"}},"description":"Site remote logging setting."},"IpsInfo":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable IDS/IPS config. If parameter[enable] is true, parameter[ipsMode] and parameter[dplevel] are needed"},"ipsMode":{"type":"integer","description":"IpsMode should be a value as follows: 0: detect only; 1: detect and block","format":"int32","example":1},"geoEnable":{"type":"boolean","description":"Whether to enable identifying the source country and destination country of attack ip addresses.","example":false},"dpLevel":{"type":"integer","description":"DpLevel should be a value as follows: 0: Low; 1: Medium; 2: High; 3: Custom","format":"int32","example":0},"customCategories":{"type":"array","description":"Custom IDS/IPS categories list, if parameter[Dplevel] is 3, customCategories is needed.CustomCategories should be a list as follow: 1: Botcc, 2: Worm, 3: Malware, 4: Mobile_Malware, 6: P2P, 7: Tor, 8: Exploit, 9: Shellcode, 14: Activex, 15: DNS, 18: User Agents, 24: DShield","items":{"type":"integer","description":"Custom IDS/IPS categories list, if parameter[Dplevel] is 3, customCategories is needed.CustomCategories should be a list as follow: 1: Botcc, 2: Worm, 3: Malware, 4: Mobile_Malware, 6: P2P, 7: Tor, 8: Exploit, 9: Shellcode, 14: Activex, 15: DNS, 18: User Agents, 24: DShield","format":"int32"}},"timeRangeId":{"type":"string","description":"This field represents Time Range ID. Time Range can be created using 'Create time range profile' interface, and Time Range ID can be obtained from 'Get time range profile list' interface. If parameter[timeRangeId] is null, IDS/IPS will be effective in all time ranges."}},"description":"IPS config entity"},"Modify IPS allow list entry":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"Allow list entry ID."},"direction":{"type":"integer","description":"The location of the target that can trigger the threat, direction should be a value as follows:0: both 1: source, 2: destination.","format":"int32"},"trafficType":{"type":"integer","description":"Exempt the category of objects (targets) that can trigger the threat, trafficType should be a value as follows: 0: IP Address, 1: Network, 2: Subnet.","format":"int32"},"ipAddress":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The value of the trafficType is 0, indicating IP address."},"network":{"type":"string","description":"The value of the trafficType is 1, indicating LAN network ID."},"subnet":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])/(\\d|((1|2)\\d)|(30|31|32))\\b","type":"string","description":"The value of the trafficType is 2, indicating subnet."}}},"McastRateLimitSettingVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"Parameter [enable] indicates whether to enable the multicast rate limiting function. True: on, false: off"},"arpEnable":{"type":"boolean","description":"Whether to enable ARP."},"arpPps":{"type":"integer","description":"Parameter [arpPps] indicates the number of ARP packets allowed to pass per second.","format":"int32"},"ndEnable":{"type":"boolean","description":"Whether to enable ND."},"ndPps":{"type":"integer","description":"Parameter [ndPps] indicates the number of ND packets allowed to pass per second.","format":"int32"},"igmpEnable":{"type":"boolean","description":"Whether to enable IGMP."},"igmpPps":{"type":"integer","description":"Parameter [igmpPps] indicates the number of IGMP packets allowed to pass per second.","format":"int32"},"dhcpEnable":{"type":"boolean","description":"Whether to enable DHCP."},"dhcpPps":{"type":"integer","description":"Parameter [dhcpPps] indicates the number of DHCP packets allowed to pass per second.","format":"int32"},"dhcpv6Enable":{"type":"boolean","description":"Whether to enable DHCP v6."},"dhcpv6Pps":{"type":"integer","description":"Parameter [dhcpv6Pps] indicates the number of DHCP v6 packets allowed to pass per second.","format":"int32"},"mdnsEnable":{"type":"boolean","description":"Whether to enable MDNS."},"mdnsPps":{"type":"integer","description":"Parameter [mdnsPps] indicates the number of MDNS packets allowed to pass per second.","format":"int32"},"otherBcastEnable":{"type":"boolean","description":"Whether to enable OTHER BROADCAST."},"otherBcastPps":{"type":"integer","description":"Parameter [otherBcastPps] indicates the number of OTHER BROADCAST packets allowed to pass per second.","format":"int32"},"otherMcastEnable":{"type":"boolean","description":"Whether to enable OTHER MULTICAST."},"otherMcastPps":{"type":"integer","description":"Parameter [otherMcastPps] indicates the number of OTHER MULTICAST packets allowed to pass per second.","format":"int32"}}},"SiteMulticastRateLimitSetting":{"type":"object","properties":{"mcastRateLimit":{"$ref":"#/components/schemas/McastRateLimitSettingVO"}},"description":"Site multicast rate limit setting"},"MeshSettingVO":{"required":["meshEnable"],"type":"object","properties":{"meshEnable":{"type":"boolean","description":"Whether to enable mesh"},"autoFailoverEnable":{"type":"boolean","description":"Whether to enable auto failover"},"defGatewayEnable":{"type":"boolean","description":"Connectivity detection, parameter defGatewayEnable should be a value as follows: true: Auto(Recommended) ; false: Customer IP"},"gateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Customer IP"},"fullSector":{"type":"boolean","description":"Whether to enable full-sector DFS"}},"description":"Site mesh."},"SiteMeshSetting":{"type":"object","properties":{"mesh":{"$ref":"#/components/schemas/MeshSettingVO"}},"description":"Site mesh setting."},"MacFilteringGeneralSetting":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Enable of the MAC filtering general setting."},"filterMode":{"type":"integer","description":"Filter mode should be a value as follows: 0: allow; 1: deny.","format":"int32"},"direction":{"$ref":"#/components/schemas/Gateway direction entity"}}},"UpdateMacAuthOpenApiVO":{"required":["enable","ssids"],"type":"object","properties":{"enable":{"type":"boolean","description":"MAC-Based Authentication enable status"},"ssids":{"type":"array","description":"SSID ID list with MAC-Based authentication configured. SSID can be created using 'Create new SSID' ('Create new SSID template') interface, and SSID ID can be obtained from 'Get SSID list' ('Get SSID template list') interface","items":{"type":"string","description":"SSID ID list with MAC-Based authentication configured. SSID can be created using 'Create new SSID' ('Create new SSID template') interface, and SSID ID can be obtained from 'Get SSID list' ('Get SSID template list') interface"}},"radiusProfileId":{"type":"string","description":"This field represents radius profile ID. Radius profile can be created using 'Create a new RADIUS profile' ('Create a new RADIUS profile template') interface, and radius profile ID can be obtained from 'Get RADIUS profile list' ('Get RADIUS profile template list') interface"},"mabEnable":{"type":"boolean","description":"MAB enable status"},"macFormat":{"type":"integer","description":"Format of the MAC address. MacFormat should be a value as follows: 0: aabbccddeeff, 1: aa-bb-cc-dd-ee-ff, 2: aa:bb:cc:dd:ee:ff, 3: AABBCCDDEEFF, 4: AA-BB-CC-DD-EE-FF, 5: AA:BB:CC:DD:EE:FF","format":"int32"},"emptyPwdEnable":{"type":"boolean","description":"Whether to enable empty password"},"nasId":{"pattern":"^$|^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"NAS ID issued to AP. NasId should contain 1 to 64 characters"}}},"SiteApLldpSettingVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable LLDP."}},"description":"Site LLDP."},"SiteLldpSetting":{"type":"object","properties":{"lldp":{"$ref":"#/components/schemas/SiteApLldpSettingVO"}},"description":"Site LLDP setting."},"IPMacBindingGeneralSetting":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Enable of the IP MAC binding general setting, If applied, fill in at least one of LAN and WAN."},"lanIds":{"type":"array","description":"LANs of the IP MAC binding general setting. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"LANs of the IP MAC binding general setting. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."}},"wanIds":{"type":"array","description":"WANs of the IP MAC binding general setting. WAN port ID can be obtained from 'Get internet basic info' interface.","items":{"type":"string","description":"WANs of the IP MAC binding general setting. WAN port ID can be obtained from 'Get internet basic info' interface."}},"imbPass":{"type":"boolean","description":"ImbPass of the IP MAC binding general setting."},"garp":{"type":"boolean","description":"GARP of the IP MAC binding general setting."},"interval":{"type":"integer","description":"Interval should be within the range of 1–10000.","format":"int32"}}},"DhcpServerChangedConfigOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable DHCP server change."}},"description":"Site DHCP server changed setting"},"RememberDeviceSetting":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable remember device"}},"description":"Site remember device setting"},"SiteServiceGeneralConfigOpenApiVO":{"type":"object","properties":{"led":{"$ref":"#/components/schemas/SiteLedSetting"},"remoteLog":{"$ref":"#/components/schemas/RemoteLogSettingOpenApiVO"},"rememberDevice":{"$ref":"#/components/schemas/RememberDeviceSetting"},"dhcpSrvChanged":{"$ref":"#/components/schemas/DhcpServerChangedConfigOpenApiVO"},"portalLogoutConfig":{"$ref":"#/components/schemas/PortalLogoutConfigOpenApiVO"}}},"DslSettings":{"type":"object","properties":{"modulationType":{"type":"integer","description":"Enter a value as follows: 0-Auto Sync-up, 2-ADSL2, 3-ADSL2+, 4-G.dmt, 5-T1.423, 6-VDSL2, 7-G.Lte.","format":"int32"},"annexType":{"type":"integer","description":"Enter a value as follows: 0-Annex Auto, 1-Annex A, 2-Annex B, 3-Annex I, 4-Annex J, 5-Annex M, 6-Annex A/L, 7-Annex B/J, 8-Annex A/I/J/L/M","format":"int32"},"bitSwap":{"type":"integer","description":"Enter a value as follows: 0-off, 1-on.","format":"int32"},"sra":{"type":"integer","description":"Enter a value as follows: 0-off, 1-on.","format":"int32"}},"description":"DSL port configurations."},"GatewayTemplatePortSettingConfig":{"type":"object","properties":{"linkSpeed":{"type":"integer","description":"Port link speed should be a value as follows: 0: Auto; 1: 10M; 2: 100M; 3: 1000M; 4: 2500M; 5: 10G; 6: 5G","format":"int32"},"duplex":{"type":"integer","description":"Port duplex mode should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"},"mirrorEnable":{"type":"boolean","description":"Port enabled mirror or not"},"mirroredPorts":{"uniqueItems":true,"type":"array","description":"Mirrored Ports Set","items":{"type":"integer","description":"Mirrored Ports Set","format":"int32"}},"mirrorMode":{"type":"integer","description":"Port mirror mode should be a value as follow: 0: ingress; 1: egress; 2: ingress and egress.","format":"int32"},"pvid":{"type":"integer","description":"Pvid(only for lan port.)","format":"int32"},"flowControl":{"type":"boolean","description":"Enable flow control or not.(When the port supports flow control.)"},"status":{"type":"integer","description":"Enable port or not, status should be a value as follows: 0: disable; 1: enable.(When the port supports status.)","format":"int32"},"poeMode":{"type":"integer","description":"Enter a value as follows: 0: off; 1: 802.3at/af.","format":"int32"},"dslSettings":{"$ref":"#/components/schemas/DslSettings"},"tagSet":{"uniqueItems":true,"type":"array","description":"Tag ID Set","items":{"type":"string","description":"Tag ID Set"}}}},"OperationResponseGatewayTemplatePortSettingConfig":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GatewayTemplatePortSettingConfig"}}},"SsidPskSettingForIpptOpenApiVO":{"required":["encryptionPsk","versionPsk"],"type":"object","properties":{"securityKey":{"type":"string","description":"WPA-Personal SSID password. This is necessary when the value of security is 3(WPA-Personal);It should contain 8-63 printable ASCII characters or 8-63 hexadecimal digits."},"versionPsk":{"type":"integer","description":"WPA-Personal version. This is necessary when the value of security is 3(WPA-Personal); It should be a value as follows: 1: WPA-PSK; 2: WPA2-PSK; 3: WPA/WPA2-PSK; 4: WPA3-SAE.","format":"int32"},"encryptionPsk":{"type":"integer","description":"WPA-Personal encryption. This is necessary when the value of security is 3(WPA-Personal); It should be a value as follows: 1: Auto; 3: AES; When versionPsk is WPA3-SAE, Parameter [encryptionPsk] must be AES.","format":"int32"}},"description":"WPA-Personal SSID config. This is necessary when the value of security is 3(WPA-Personal)."},"UpdateSsidBasicConfigForIpptOpenApiVO":{"required":["band","broadcast","name","security"],"type":"object","properties":{"name":{"type":"string","description":"SSID name. It should contain 1 to 32 UTF-8 characters."},"band":{"type":"integer","description":"SSID band. The lowest bit indicates whether 2.4G is included; the second lowest bit indicates whether 5G is included; the third lowest bit indicates whether 6G is included; 1 means included while 0 means not included. For example, 7(111) means that 2G/5G/6G are enabled; 1(001) means that 2G is enabled. (When 5G is included，it means 5G/5G1/5G2 are enabled.)","format":"int32"},"autoWanAccess":{"type":"boolean","description":"Whether to enable auto wan access. True: enable, false: disable."},"security":{"type":"integer","description":"SSID security mode; Security should be a value as follows: 0: None; 2: WPA-Enterprise; 3: WPA-Personal; 4: PPSK without RADIUS; 5: PPSK with RADIUS.","format":"int32"},"oweEnable":{"type":"boolean","description":"Opportunistic Wireless Encryption, also known as Enhanced Open, is a certification provided by the Wi-Fi Alliance as part of the WPA3 wireless security standard. OWE will enable two wireless VAPs per radio, one for access of OWE-supported stations, and one for access of other stations. An SSID with OWE enabled will be counted as two SSID entries for 2G and 5G. Only for security is None and band contains 2.4G or 5G."},"broadcast":{"type":"boolean","description":"SSID broadcast config status. True: enable, false: disable."},"pskSetting":{"$ref":"#/components/schemas/SsidPskSettingForIpptOpenApiVO"}}},"FirewallSetting":{"required":["broadcastPing","icmp","other","receiveRedirects","sendRedirects","synCookies","tcpClose","tcpCloseWait","tcpEstablished","tcpFinWait","tcpLastAck","tcpSynReceive","tcpSynSent","tcpTimeWait","udpOther","udpStream"],"type":"object","properties":{"icmp":{"type":"integer","description":"ICMP should be within the range of 1–2097151.","format":"int32"},"other":{"type":"integer","description":"Other should be within the range of 1–2097151.","format":"int32"},"tcpClose":{"type":"integer","description":"TCP close should be within the range of 1–2097151.","format":"int32"},"tcpCloseWait":{"type":"integer","description":"TCP close wait should be within the range of 1–2097151.","format":"int32"},"tcpEstablished":{"type":"integer","description":"TCP established should be within the range of 1–2097151.","format":"int32"},"tcpFinWait":{"type":"integer","description":"TCP FIN wait should be within the range of 1–2097151.","format":"int32"},"tcpLastAck":{"type":"integer","description":"TCP last ACK should be within the range of 1–2097151.","format":"int32"},"tcpSynReceive":{"type":"integer","description":"TCP SYN receive should be within the range of 1–2097151.","format":"int32"},"tcpSynSent":{"type":"integer","description":"TCP SYN sent should be within the range of 1–2097151.","format":"int32"},"tcpTimeWait":{"type":"integer","description":"TCP time wait should be within the range of 1–2097151.","format":"int32"},"udpOther":{"type":"integer","description":"UDP other should be within the range of 1–2097151.","format":"int32"},"udpStream":{"type":"integer","description":"UDP stream should be within the range of 1–2097151.","format":"int32"},"broadcastPing":{"type":"boolean","description":"Broadcast ping of the firewall setting."},"receiveRedirects":{"type":"boolean","description":"Receive redirects of the firewall setting."},"sendRedirects":{"type":"boolean","description":"Send redirects of the firewall setting."},"synCookies":{"type":"boolean","description":"SYN Cookies of the firewall setting."}}},"deviceTemplateEdit":{"type":"object","properties":{"templateName":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"The name of device template."},"autoBind":{"type":"boolean","description":"Devices will automatically bind the template and use template configurations."},"status":{"type":"integer","description":"The status of device template. 0:completed ; 1:draft","format":"int32"}}},"ChannelLimitSettingVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable channel limit."}},"description":"Site channel limit."},"SiteChannelLimitSetting":{"type":"object","properties":{"channelLimit":{"$ref":"#/components/schemas/ChannelLimitSettingVO"}},"description":"Site channel limit setting."},"AirtimeFairnessSettingVO":{"required":["enable2g","enable5g","enable6g"],"type":"object","properties":{"enable2g":{"type":"boolean","description":"Whether to enable 2G airtime fairness"},"enable5g":{"type":"boolean","description":"Whether to enable 5G airtime fairness"},"enable6g":{"type":"boolean","description":"Whether to enable 6G airtime fairness"}},"description":"Site airtimeFairness."},"BeaconControlVO":{"required":["dtimPeriod2g","dtimPeriod5g","dtimPeriod6g","rtsThreshold2g","rtsThreshold5g","rtsThreshold6g"],"type":"object","properties":{"beaconInterval2g":{"type":"integer","description":"2.4GHz beacon interval, parameter beaconInterval2g should be within the range of 40-500)","format":"int32"},"beaconIntvMode2g":{"type":"integer","format":"int32"},"dtimPeriod2g":{"type":"integer","description":"2.4GHz DTIM period, parameter dtimPeriod2g should be within the range of 1-255","format":"int32"},"rtsThreshold2g":{"type":"integer","description":"2.4GHz RTS threshold, parameter rtsThreshold2g should be within the range of 1-2347","format":"int32"},"fragmentationThreshold2g":{"type":"integer","description":"2.4GHz fragmentation threshold, parameter fragmentationThreshold2g should be within the range of 256-2346","format":"int32","deprecated":true},"beaconInterval5g":{"type":"integer","description":"5GHz beacon interval, parameter beaconInterval5g should be within the range of 40-500)","format":"int32"},"beaconIntvMode5g":{"type":"integer","format":"int32"},"dtimPeriod5g":{"type":"integer","description":"5GHz DTIM period, parameter dtimPeriod5g should be within the range of 1-255","format":"int32"},"rtsThreshold5g":{"type":"integer","description":"5GHz RTS threshold, parameter rtsThreshold5g should be within the range of 1-2347","format":"int32"},"fragmentationThreshold5g":{"type":"integer","description":"5GHz fragmentation threshold, parameter fragmentationThreshold5g should be within the range of 256-2346","format":"int32","deprecated":true},"beaconInterval6g":{"type":"integer","description":"6GHz beacon interval, parameter beaconInterval6g should be within the range of 40-500)","format":"int32"},"beaconIntvMode6g":{"type":"integer","format":"int32"},"dtimPeriod6g":{"type":"integer","description":"6GHz DTIM period, parameter dtimPeriod6g should be within the range of 1-255","format":"int32"},"rtsThreshold6g":{"type":"integer","description":"6GHz RTS threshold, parameter rtsThreshold6g should be within the range of 1-2347","format":"int32"},"fragmentationThreshold6g":{"type":"integer","description":"6GHz fragmentation threshold, parameter fragmentationThreshold6g should be within the range of 256-2346","format":"int32","deprecated":true},"probeResponseMaxRetransNum2g":{"type":"integer","description":"2.4GHz probe response maximum retransmission number, parameter probeResponseMaxRetransNum2g should be within the range of 0-3","format":"int32"},"probeResponseMaxRetransNum5g":{"type":"integer","description":"5GHz probe response maximum retransmission number, parameter probeResponseMaxRetransNum2g should be within the range of 0-3","format":"int32"},"probeResponseReplyThresholdEnable2g":{"type":"boolean","description":"Whether to enable 2G probe response reply threshold"},"probeResponseReplyThresholdEnable5g":{"type":"boolean","description":"Whether to enable 5G probe response reply threshold"},"probeResponseReplyThresholdMode2g":{"type":"integer","format":"int32"},"probeResponseReplyThresholdMode5g":{"type":"integer","format":"int32"},"probeResponseReplyThreshold2g":{"type":"integer","description":"2.4GHz probe response reply threshold, parameter probeResponseReplyThreshold2g should be within the range of -95-0","format":"int32"},"probeResponseReplyThreshold5g":{"type":"integer","description":"5GHz probe response reply threshold, parameter probeResponseReplyThreshold5g should be within the range of -95-0","format":"int32"}},"description":"Site beacon control."},"SiteBeaconControlSetting":{"type":"object","properties":{"beaconControl":{"$ref":"#/components/schemas/BeaconControlVO"},"airtimeFairness":{"$ref":"#/components/schemas/AirtimeFairnessSettingVO"}},"description":"Site beacon control setting."},"BandwidthControl":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Enable the bandwidth control."},"thresholdControlEnable":{"type":"boolean","description":"Enable the threshold control of the bandwidth control."},"thresholdValue":{"type":"integer","description":"Threshold value should be within the range of 1–100. Threshold value must be entered when threshold control is enable.","format":"int32"},"bandwidthPortSettings":{"type":"array","description":"Bandwidth port settings of the bandwidth control.","items":{"$ref":"#/components/schemas/BandwidthPortSetting"}}}},"BandwidthPortSetting":{"required":["portUuid"],"type":"object","properties":{"portUuid":{"type":"string","description":"Port uuid."},"upstreamBandwidth":{"type":"integer","description":"Upstream bandwidth should be within the range of 1–9999999.","format":"int32"},"upstreamBandwidthUnit":{"type":"integer","description":"Upstream bandwidth unit should be a value as follows: 1: Kbps, 2: Mbps.","format":"int32"},"downstreamBandwidth":{"type":"integer","description":"Downstream bandwidth should be within the range of 1–9999999.","format":"int32"},"downstreamBandwidthUnit":{"type":"integer","description":"Downstream bandwidth unit should be a value as follows: 1: Kbps, 2: Mbps.","format":"int32"}},"description":"Bandwidth port settings of the bandwidth control."},"BandSteeringMultiBandVO":{"required":["mode"],"type":"object","properties":{"mode":{"type":"integer","description":"Mode should be a value as follows: 0: Disable; 1: Prefer 5GHz/6GHz; 2: Balance","format":"int32"}},"description":"Site band steering."},"SiteBandSteeringSetting":{"type":"object","properties":{"bandSteeringForMultiBand":{"$ref":"#/components/schemas/BandSteeringMultiBandVO"}},"description":"Site band steering setting."},"AttackDefenseSetting":{"required":["icmpConnEnable","icmpSrcEnable","largePingEnable","pingDeathEnable","pingWanEnable","specifiedOptionEnable","tcpConnEnable","tcpFinNoAckEnable","tcpScanEnable","tcpSrcEnable","tcpSynFinEnable","udpConnEnable","udpSrcEnable","winNukeAttackEnable"],"type":"object","properties":{"tcpConnEnable":{"type":"boolean","description":"Multi-connections TCP SYN flood enable of the attack defense setting."},"tcpConnLimit":{"type":"integer","description":"Multi-connections TCP SYN flood limit should be within the range of 100–99999.","format":"int32"},"udpConnEnable":{"type":"boolean","description":"Multi-connections UDP flood enable of the attack defense setting."},"udpConnLimit":{"type":"integer","description":"Multi-connections UDP flood limit should be within the range of 100–99999.","format":"int32"},"icmpConnEnable":{"type":"boolean","description":"Multi-connections ICMP flood enable of the attack defense setting."},"icmpConnLimit":{"type":"integer","description":"Multi-connections ICMP flood limit should be within the range of 100–99999.","format":"int32"},"tcpSrcEnable":{"type":"boolean","description":"Stationary source TCP SYN flood enable of the attack defense setting."},"tcpSrcLimit":{"type":"integer","description":"Stationary source TCP SYN flood limit should be within the range of 100–99999.","format":"int32"},"udpSrcEnable":{"type":"boolean","description":"Stationary source UDP flood enable of the attack defense setting."},"udpSrcLimit":{"type":"integer","description":"Stationary source UDP flood limit should be within the range of 100–99999.","format":"int32"},"icmpSrcEnable":{"type":"boolean","description":"Stationary source ICMP flood enable of the attack defense setting."},"icmpSrcLimit":{"type":"integer","description":"Stationary source ICMP flood limit should be within the range of 100–99999.","format":"int32"},"tcpScanEnable":{"type":"boolean","description":"Block TCP scan enable of the attack defense setting."},"tcpScanReject":{"type":"boolean","description":"Block TCP scan with reject of the attack defense setting."},"pingDeathEnable":{"type":"boolean","description":"Block ping of death of the attack defense setting."},"largePingEnable":{"type":"boolean","description":"Block large ping of the attack defense setting."},"largePingThreshold":{"type":"integer","description":"Block large ping threshold of the attack defense setting, Value is between 28 and 65535.","format":"int32"},"pingWanEnable":{"type":"boolean","description":"Block ping from WAN of the attack defense setting."},"winNukeAttackEnable":{"type":"boolean","description":"Block WinNuke attack of the attack defense setting."},"tcpSynFinEnable":{"type":"boolean","description":"Block TCP packets with SYN and FIN Bits set of the attack defense setting."},"tcpFinNoAckEnable":{"type":"boolean","description":"Block TCP packets with FIN Bit set but no ACK Bit set of the attack defense setting."},"specifiedOptionEnable":{"type":"boolean","description":"Block packets with specified options of the attack defense setting."},"specifiedOption":{"$ref":"#/components/schemas/SpecifiedOptionOpenApiVO"},"icmpTimestampRequestReject":{"type":"boolean","description":"ICMP Timestamp Request setting of the attack defense setting."}}},"SpecifiedOptionOpenApiVO":{"type":"object","properties":{"securityOptionEnable":{"type":"boolean","description":"Security Option of the attack defense setting."},"recordRouteEnable":{"type":"boolean","description":"Record Route Option of the attack defense setting."},"streamEnable":{"type":"boolean","description":"Stream Option of the attack defense setting."},"timestampEnable":{"type":"boolean","description":"Timestamp Option of the attack defense setting."},"noOperationEnable":{"type":"boolean","description":"No Operation Option of the attack defense setting."}},"description":"Specified option of the attack defense setting."},"UpdateApGroupOpenApiVO":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"AP group name should contain 1 to 128 characters."},"addApMacs":{"type":"array","description":"List of AP device MAC addresses to be added to this AP group. Can be empty.","items":{"type":"string","description":"List of AP device MAC addresses to be added to this AP group. Can be empty."}},"removeApMacs":{"type":"array","description":"List of AP device MAC addresses to be removed from this AP group. Can be empty.","items":{"type":"string","description":"List of AP device MAC addresses to be removed from this AP group. Can be empty."}}}},"AnomalyEventSettingEditOpenApiVO":{"required":["anomalyCode"],"type":"object","properties":{"anomalyCode":{"type":"string","description":"For the values of Anomaly event code, refer to section 5.7.2.1 of the Open API Access","example":"01001001"},"enable":{"type":"boolean","description":"Whether to detect anomaly events","example":false},"level":{"type":"integer","description":"Anomaly event level, it should be a value as follows: 0:Critical, 1:Error, 2:Warning, 3: Info","format":"int32","example":1},"params":{"type":"object","additionalProperties":{"type":"integer","description":"For the values of Anomaly event params, refer to section 5.7.2.1 of the Open API Access","format":"int32"},"description":"For the values of Anomaly event params, refer to section 5.7.2.1 of the Open API Access","example":{"offlineCount":2}}}},"AlertEmailSettingVO":{"required":["delayEnable"],"type":"object","properties":{"delayEnable":{"type":"boolean","description":"Enable alert emails delay"},"delay":{"minimum":1,"type":"integer","description":"Send similar alerts within x seconds in one email, Note that when the number of incidents reaches 100, the log will be sent immediately","format":"int32"}},"description":"Abnormal Alert Email(This config applies to the Abnormal > Notification view)."},"NotificationConfigurationOpenApiVO":{"required":["eventCategory","eventLevel","eventObjectType"],"type":"object","properties":{"eventLevel":{"type":"object","additionalProperties":{"type":"boolean","description":"The incident level of event map. Key is event level, such as: critical, error, warning, info. Value is true or false, indicating whether the event level is selected."},"description":"The incident level of event map. Key is event level, such as: critical, error, warning, info. Value is true or false, indicating whether the event level is selected."},"eventObjectType":{"type":"object","additionalProperties":{"type":"boolean","description":"The incident object of event. Key is event object type, such as: gateway, switch, ap, wiredClient, wirelessClient. Value is true or false, indicating whether the event object type is selected."},"description":"The incident object of event. Key is event object type, such as: gateway, switch, ap, wiredClient, wirelessClient. Value is true or false, indicating whether the event object type is selected."},"eventCategory":{"type":"object","additionalProperties":{"type":"boolean","description":"For the values of event category Key, refer to section 5.7.1.1 of the Open API Access.","example":false},"description":"For the values of event category Key, refer to section 5.7.1.1 of the Open API Access.","example":"networking"}},"description":"Email Alerts List(This config applies to the Abnormal > Notification view)."},"SetNotificationOpenApiVO":{"required":["alertEmailSetting","email"],"type":"object","properties":{"alertEmailSetting":{"$ref":"#/components/schemas/AlertEmailSettingVO"},"email":{"$ref":"#/components/schemas/NotificationConfigurationOpenApiVO"}}},"OperationResponseSetNotificationOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SetNotificationOpenApiVO"}}},"Gateway Custom ACL modify entity":{"required":["description","destinationList","direction","id","index","logStatus","policy","protocol","sourceList","status"],"type":"object","properties":{"id":{"type":"string","description":"Custom ACL ID"},"index":{"type":"integer","description":"Custom ACL index","format":"int32"},"status":{"type":"boolean","description":"Custom ACL status"},"description":{"pattern":"^[^ ]$|^[^ ].{0,510}[^ ]$","type":"string","description":"Custom ACL description should contain 1 to 512 characters."},"direction":{"type":"integer","description":"Custom ACL direction should be a value as follows: 0: LAN-LAN; 1: LAN-WAN; 2: WAN-LAN; 3: LOCAL IN","format":"int32"},"policy":{"type":"integer","description":"Custom ACL policy should be a value as follows: 0: Drop; 1:Allow","format":"int32"},"protocol":{"type":"integer","description":"Custom ACL protocol. For the values of protocol, refer to section 5.5 of the Open API Access Guide.","format":"int32"},"sourceList":{"type":"array","description":"Custom ACL source list.","items":{"type":"string","description":"Custom ACL source list."}},"sourcePort":{"type":"string","description":"Custom ACL source port. when \"protocol\" is \"TCP\" or \"UDP\", port is valid."},"destinationList":{"type":"array","description":"Custom ACL destination list.","items":{"type":"string","description":"Custom ACL destination list."}},"destinationPort":{"type":"string","description":"Custom ACL destination port. when \"protocol\" is \"TCP\" or \"UDP\", port is valid."},"logStatus":{"type":"boolean","description":"Custom ACL log status"}},"description":"Modified Custom ACLs."},"Gateway Custom ACL update entity":{"type":"object","properties":{"adds":{"type":"array","description":"Added Custom ACLs.","items":{"$ref":"#/components/schemas/GatewayCustomACLAddEntity"}},"deletes":{"type":"array","description":"Deleted Custom ACLs.","items":{"type":"string","description":"Deleted Custom ACLs."}},"modifies":{"type":"array","description":"Modified Custom ACLs.","items":{"$ref":"#/components/schemas/Gateway Custom ACL modify entity"}}}},"GatewayCustomACLAddEntity":{"required":["description","destinationList","direction","index","logStatus","policy","protocol","sourceList","status"],"type":"object","properties":{"index":{"type":"integer","description":"Custom ACL index","format":"int32"},"status":{"type":"boolean","description":"Custom ACL status"},"description":{"pattern":"^[^ ]$|^[^ ].{0,510}[^ ]$","type":"string","description":"Custom ACL description should contain 1 to 512 characters."},"direction":{"type":"integer","description":"Custom ACL direction should be a value as follows: 0: LAN-LAN; 1: LAN-WAN; 2: WAN-LAN; 3: LOCAL IN","format":"int32"},"policy":{"type":"integer","description":"Custom ACL policy should be a value as follows: 0: Drop; 1:Allow","format":"int32"},"protocol":{"type":"integer","description":"Custom ACL protocol. For the values of protocol, refer to section 5.5 of the Open API Access Guide.","format":"int32"},"sourceList":{"type":"array","description":"Custom ACL source list.","items":{"type":"string","description":"Custom ACL source list."}},"sourcePort":{"type":"string","description":"Custom ACL source port. when \"protocol\" is \"TCP\" or \"UDP\", port is valid."},"destinationList":{"type":"array","description":"Custom ACL destination list.","items":{"type":"string","description":"Custom ACL destination list."}},"destinationPort":{"type":"string","description":"Custom ACL destination port. when \"protocol\" is \"TCP\" or \"UDP\", port is valid."},"logStatus":{"type":"boolean","description":"Custom ACL log status"}},"description":"Added Custom ACLs."},"UpdateSsidBindApGroupOpenApiVO":{"required":["apGroupIds"],"type":"object","properties":{"apGroupIds":{"type":"array","description":"AP GroupId List to bind with SSID. ","items":{"type":"string","description":"AP GroupId List to bind with SSID. "}}}},"VpnStatusVO":{"required":["status"],"type":"object","properties":{"status":{"type":"boolean"}}},"UrlFilterGlobalOpenApiVO":{"required":["blockPage","safeSearch"],"type":"object","properties":{"blockPage":{"type":"boolean","description":"blockPage should be a value as follows: false: close; true: open."},"blockPageMessage":{"type":"string","description":"blockPageMessage of blockPage,when blockPage switch is open."},"safeSearch":{"type":"boolean","description":"safeSearch should be a value as follows: false: close; true: open."}}},"OswSdmApplicationVO":{"type":"object","properties":{"category":{"type":"integer","description":"It should be a value as follows: 0: ACL&Qos(IPv4); 1:ACL&Qos(IPv6); 3:IP Source Guard; 4:IPv6 Source Guard.","format":"int32"},"num":{"type":"integer","description":"Maximum number of entries allowed by the feature.","format":"int32"}},"description":"Application "},"OswSdmBriefVO":{"type":"object","properties":{"name":{"type":"string","description":"Sdm template name."},"apps":{"type":"array","description":"Application ","items":{"$ref":"#/components/schemas/OswSdmApplicationVO"}}},"description":"All sdm templates supported by the device."},"OswSdmTemplateVO":{"type":"object","properties":{"inUse":{"type":"string","description":"Sdm template currently in use."},"templates":{"type":"array","description":"All sdm templates supported by the device.","items":{"$ref":"#/components/schemas/OswSdmBriefVO"}}},"description":"Sdm template"},"OswSnmpOpenApiVO":{"type":"object","properties":{"location":{"pattern":"^[!-~][\\040-\\0176]{0,126}[!-~]$|^[!-~]$|$","type":"string","description":"Location, location should contain 0 to 128 ASCII characters, spaces are allowed, and leading and trailing spaces are not allowed."},"contact":{"pattern":"^[\\041-\\0176]{0,128}$","type":"string","description":"Contact, contact should contain 0 to 128 ASCII characters, spaces are not allowed."},"type":{"type":"integer","description":"SNMP config type, 0: Use Site Settings; 1: Custom.","format":"int32"}},"description":"SNMP setting"},"SwitchGeneralConfig":{"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"Device name should contain 1 to 128 characters."},"ledSetting":{"type":"integer","description":"Led setting should be a value as follows: 0:off; 1:on; 2:Use Site Settings","format":"int32"},"tagIds":{"type":"array","description":"Tag IDs","items":{"type":"string","description":"Tag IDs"}},"location":{"$ref":"#/components/schemas/DeviceLocationDetailVO"},"jumboFollowSite":{"type":"boolean","description":"Whether jumbo setting follows site setting."},"jumbo":{"type":"integer","description":"Required only when jumboFollowSite = false. Range: 1518–9216.","format":"int32"},"lagHashAlgFollowSite":{"type":"boolean","description":"Whether lag hash algorithm setting follows site setting."},"lagHashAlg":{"type":"integer","description":"Required only when lagHashAlgFollowSite = false. It should be a value as follows: 0: SRC MAC; 1: DST MAC; 2: SRC MAC + DST MAC; 3: SRC IP; 4: DST IP; 5: SRC IP + DST IP","format":"int32"},"snmp":{"$ref":"#/components/schemas/OswSnmpOpenApiVO"},"sdm":{"$ref":"#/components/schemas/OswSdmTemplateVO"}},"description":"After the device is added to the stack group, the interface can only modify the device name."},"IpSettingVO":{"required":["mode"],"type":"object","properties":{"mode":{"pattern":"static|dhcp","type":"string","description":"IpSetting parameter [mode] should be \"static\" or \"dhcp\""},"configIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Config IP"},"configMask":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Config Mask"},"configGate":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Config Gate"},"fallback":{"type":"boolean","description":"Fallback, only for \"dhcp\" mode"},"fallbackIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Fallback IP, only for \"dhcp\" mode"},"fallbackMask":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Fallback Mask, only for \"dhcp\" mode"},"fallbackGate":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Fallback Gate, only for \"dhcp\" mode"},"useFoxedAddr":{"type":"boolean","description":"Use Fixed Address, only for \"dhcp\" mode"},"netId":{"type":"string","description":"Net ID, only for \"dhcp\" mode"},"dhcpIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"DHCP IP, only for \"dhcp\" mode"},"serverType":{"type":"string","description":"DHCP Server Type, only for \"dhcp\" mode"},"serverMac":{"type":"string","description":"DHCP Server Mac, only for \"dhcp\" mode"},"serverStackId":{"type":"string","description":"DHCP Server Stack ID, only for \"dhcp\" mode"},"preferredDNS":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Preferred DNS, only for \"static\" mode"},"alternateDNS":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Alternate DNS, only for \"static\" mode"},"confirmConflict":{"type":"boolean","description":"Confirm Conflict"}},"description":"Ip Setting"},"OperationResponseOswDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswDetailVO"}}},"OswDetailVO":{"type":"object","properties":{"type":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"mac":{"type":"string","description":"Device mac"},"name":{"type":"string","description":"Device name,default value is the mac address of device"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"compoundModel":{"type":"string","description":"Model complex used in the backend.Ap：model+(country)+modelVersion,  EAP225(EU) v3.0 Ap: specialModel+modelVersion, EAP225-Outdoor-1a20a950b8d950e8 v1.0  Gateway/Switch：model+modelVersion, Osg v3.0"},"showModel":{"type":"string","description":"Model complex shown in the front end.Ap：model+(country)+modelVersion,EAP225(EU) v3.0  Gateway/Switch：model+modelVersion,Osg v3.0"},"specialModel":{"type":"string","description":"Special device model,for example:EAP225-Outdoor-1a20a950b8d950e8"},"firmwareVersion":{"type":"string","description":"Version of firmware,for example:2.5.0 Build 20190118 Rel. 64821"},"version":{"type":"string","description":"Simplified version of firmware,for example:2.5.0"},"hwVersion":{"type":"string","description":"Version of hardware,for example 1.0"},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected;1:Disconnected(Migrating);10:Provisioning;11:Configuring;12:Upgrading;13:Rebooting;14:Connected;15:Connected(Wireless);16:Connected(Migrating);17:Connected(Wireless,Migrating);20:Pending;21:Pending(Wireless);22:Adopting;23:Adopting(Wireless);24:Adopt Failed;25:Adopt Failed(Wireless);26:Managed By Others;27:Managed By Others(Wireless);30:Heartbeat Missed;31:Heartbeat Missed(Wireless);32:Heartbeat Missed(Migrating);33:Heartbeat Missed(Wireless,Migrating);40:Isolated;41:Isolated(Migrating);50:Slice Configuring","format":"int32"},"statusCategory":{"type":"integer","description":"Category of device status,statusCategory should be a value as follows: 0:Disconnected;1:Connected;2:Pending;3:Heartbeat Missed;4:Isolated","format":"int32"},"es":{"type":"boolean","description":"Whether the switch is Agile Series Switch"},"site":{"type":"string","description":"Site of the device"},"siteName":{"type":"string","description":"Site name of the device"},"omadacId":{"type":"string","description":"OmadacId of the device"},"compatible":{"type":"integer","description":"Device firmware and controller compatibility type.Compatible should be a value as follows: 0:COMPATIBLE;1:HIGH_MAJOR_VER;2:LOW_MAJOR_VER;3:HIGH_MINOR_VER;4:LOW_MINOR_VER;7:HIGH_COMPONENT_VER;10:DEVICE_NOT_COMPATIBLE;11:HIGH_ADOPT_COMMPONENT;12:DEVICE_CATEGORY_NOT_COMPATIBLE;14:DEVICE_NOT_COMPATIBLE_IN_CLUSTER","format":"int32"},"supportAnomaly":{"type":"boolean","description":"Whether the device firmware support intelligent anomaly detection"},"supportLocatePort":{"type":"boolean","description":"Whether the device supports locating port"},"active":{"type":"boolean","description":"whether to active the device(cloud base exclusive)"},"licenseStatus":{"type":"integer","description":"License status(cloud base exclusive).LicenseStatus should be a value as follows: 0:unActive 1:Unbind 2:Expired 3:active","format":"int32"},"dueTime":{"type":"integer","description":"Expire timestamp of license(cloud base exclusive)","format":"int64"},"dueTimeLeft":{"type":"integer","description":"Milliseconds from the current moment to the expiration time(cloud base exclusive)","format":"int64"},"licenseId":{"type":"string","description":"License key on detail page of device(cloud base exclusive)"},"licenseUnbindingLimit":{"type":"integer","description":"Remaining unbind count for license on detail Page of device(cloud base exclusive)","format":"int32"},"initialUnbindingLimit":{"type":"integer","description":"Initial unbind count for license(cloud base exclusive)","format":"int32"},"category":{"type":"string","description":"Category of license"},"forgetId":{"type":"string","description":"Forget ID of device"},"sn":{"type":"string","description":"Device serial number"},"eost":{"type":"integer","description":"End of service time of device(CBC exclusive)","format":"int64"},"eos":{"type":"integer","description":"End of support time of device(CBC exclusive)","format":"int64"},"inWhitelist":{"type":"boolean","description":"Whether the device is in white list"},"location":{"$ref":"#/components/schemas/DeviceLocationDetailVO"},"addedInAdvanced":{"type":"boolean","description":"Whether the device is added in advanced."},"customId":{"type":"string","description":"Customer ID"},"customName":{"type":"string","description":"Customer name"},"moveSiteId":{"type":"string","description":"Record that the device is in a moveSite operation; if it is null, then it is not in the moveSite operation."},"remember":{"type":"boolean","description":"Whether to remember the device(deprecated)","deprecated":true},"rememberDevice":{"type":"integer","description":"Whether to remember the device.RememberDevice should be a value as follows: 0:off, 1:on, 2: follow site","format":"int32"},"description":{"type":"string","description":"Description of the device"},"disableHwReset":{"type":"boolean","description":"Whether to disable hardware reset"},"templateId":{"type":"string","description":"ID of the template bound to the device"},"templateName":{"type":"string","description":"Name of the template bound to the device"},"boundSiteTemplate":{"type":"boolean","description":"Whether the site where the device is located is bound to a site template"},"deviceTemplateAvailable":{"type":"boolean","description":"Whether there is an available device template for the device; it is false if the model is not supported or the site template has not created the corresponding device template."},"boundDeviceTemplate":{"type":"boolean","description":"Whether the device is bound to device template"},"siteTemplateName":{"type":"string","description":"Template name bound to the site"},"siteTemplateId":{"type":"string","description":"Template ID bound to the site"},"deviceSeriesType":{"type":"integer","description":"Device series type.DeviceSeriesType should be a value as follows: 0:advanced;1:pro","format":"int32"},"resource":{"type":"integer","description":"Data source.Resource should be a value as follows: 0:new created;1:from template;2:override","format":"int32"},"ecspFirstVersion":{"type":"integer","description":"Ecsp first version","format":"int32"},"latestVersion":{"type":"string","description":"Latest firmware version"},"replaceDeviceInfo":{"$ref":"#/components/schemas/DeviceReplaceSettingVO"},"deviceMisc":{"$ref":"#/components/schemas/OswDeviceMiscVO"},"devCap":{"$ref":"#/components/schemas/OswDevCapVO"},"ledSetting":{"type":"integer","description":"LedSetting should be a value as follows: 0: Off; 1: On; 2:follow site","format":"int32"},"mvlanNetworkId":{"type":"string","description":"Management VLAN network ID"},"mvlanBridgeVlan":{"type":"integer","description":"Only valid when mvlanNetworkId is bridge vlan","format":"int32"},"ipSetting":{"$ref":"#/components/schemas/IpSettingVO"},"loopbackDetectEnable":{"type":"boolean","description":"Loopback Detect Enable"},"stp":{"type":"integer","description":"Spanning Tree Protocol should be a value as follows: 1: STP; 2: RSTP; 3: MSTP; 0: OFF","format":"int32"},"priority":{"type":"integer","description":"STP priority","format":"int32"},"helloTime":{"type":"integer","description":"STP helloTime","format":"int32"},"maxAge":{"type":"integer","description":"STP maxAge","format":"int32"},"forwardDelay":{"type":"integer","description":"STP forwardDelay","format":"int32"},"txHoldCount":{"type":"integer","description":"STP txHoldCount","format":"int32"},"maxHops":{"type":"integer","description":"STP maxHops","format":"int32"},"mstp":{"$ref":"#/components/schemas/OswStpMstpVO"},"qosConfig":{"$ref":"#/components/schemas/OswQosConfigVO"},"snmp":{"$ref":"#/components/schemas/OswSnmpVO"},"multicast":{"$ref":"#/components/schemas/OswLanMulticastVO"},"ports":{"type":"array","description":"Port List","items":{"$ref":"#/components/schemas/OswPortVO"}},"lags":{"type":"array","description":"Lag List","items":{"$ref":"#/components/schemas/OswLagVO"}},"tagIds":{"type":"array","description":"The bound TAG ID List","items":{"type":"string","description":"The bound TAG ID List"}},"ip":{"type":"string","description":"Switch IP"},"publicIp":{"type":"string","description":"Public IP"},"ipv6List":{"type":"array","description":"IPV6 List","items":{"type":"string","description":"IPV6 List"}},"lastSeen":{"type":"integer","description":"Last Seen","format":"int64"},"needUpgrade":{"type":"boolean","description":"Need Upgrade"},"uptime":{"type":"string","description":"Uptime"},"uptimeLong":{"type":"integer","description":"UptimeLong, Running duration, Units: seconds","format":"int64"},"cpuUtil":{"type":"integer","description":"Real-time CPU usage","format":"int32"},"memUitl":{"type":"integer","description":"Real-time memory usage","format":"int32"},"poeTotalPower":{"type":"number","description":"PoE Total Power (W)","format":"double"},"poeRemain":{"type":"number","description":"PoE Residual Power (W)","format":"double"},"poeRemainPercent":{"type":"number","description":"PoE Residual Power Percentage","format":"double"},"fanStatus":{"type":"integer","description":"Fan Status should be a value as follows: 0:normal; 1:fault; 2:no fan","format":"int32"},"uplink":{"$ref":"#/components/schemas/OswUplinkVO"},"uplinkPort":{"type":"integer","description":"Uplink port","format":"int32"},"uplinkStPort":{"type":"string","description":"Uplink standard port,unit/slot/port"},"downlinkList":{"type":"array","description":"Downlink Omada device list","items":{"$ref":"#/components/schemas/OswDownlinkVO"}},"stpLinkList":{"type":"array","description":"STP Blocked Link Omada device list","items":{"$ref":"#/components/schemas/OswDownlinkVO"}},"download":{"type":"integer","description":"Total Download (Byte)","format":"int64"},"upload":{"type":"integer","description":"Total Upload (Byte)","format":"int64"},"supportVlanIf":{"type":"boolean","description":"Support Vlan Interface"},"jumbo":{"type":"integer","description":"Jumbo should be within the range of 1518-9216.","format":"int32"},"jumboFollowSite":{"type":"boolean","description":"When enabled, the jumbo frame setting follows the site-level configuration; otherwise, a custom setting is used."},"lagHashAlg":{"type":"integer","description":"It should be a value as follows: 0: SRC MAC; 1: DST MAC; 2: SRC MAC + DST MAC; 3: SRC IP; 4: DST IP; 5: SRC IP + DST IP","format":"int32"},"lagHashAlgFollowSite":{"type":"boolean","description":"When enabled, the lag hash alg setting follows the site-level configuration; otherwise, a custom setting is used."},"speeds":{"type":"array","description":"Supported rate list for all ports. Speeds should be a value as follows: 0:auto; 1:10M; 2:100M; 3:1000M; 4:2.5G; 5:10G; 6:5G; 7:25G; 8:100G; 9:40G; -1:error; no value:all rate supported","items":{"type":"integer","description":"Supported rate list for all ports. Speeds should be a value as follows: 0:auto; 1:10M; 2:100M; 3:1000M; 4:2.5G; 5:10G; 6:5G; 7:25G; 8:100G; 9:40G; -1:error; no value:all rate supported","format":"int32"}},"supportIpv6Acl":{"type":"boolean","description":"Support Ipv6 Acl"},"stackDevice":{"type":"boolean","description":"Stack Device"},"supportVrf":{"type":"boolean","description":"Support Vrf"},"unit":{"type":"integer","description":"Unit ID","format":"int32"},"stackPorts":{"type":"array","description":"Stack Port List","items":{"$ref":"#/components/schemas/OswStackPortGroupVO"}},"stackMsg":{"$ref":"#/components/schemas/StackMsgVO"},"templateSettings":{"type":"array","description":"Template Setting List","items":{"type":"integer","description":"Template Setting List","format":"int32"}},"loop":{"type":"string","description":"Loop information"},"loopbackNum":{"type":"integer","description":"Loopback Num","format":"int32"},"block":{"type":"string","description":"Block information"},"blockNum":{"type":"integer","description":"Block Num","format":"int32"},"txRate":{"type":"integer","description":"Tx Rate","format":"int64"},"rxRate":{"type":"integer","description":"Rx Rate","format":"int64"},"mlagMsg":{"$ref":"#/components/schemas/MlagMsgVO"},"mlagPeerInfo":{"$ref":"#/components/schemas/OswMlagPeerInfoVO"},"sdm":{"$ref":"#/components/schemas/OswSdmTemplateVO"},"terminalPrefix":{"type":"string","description":"TerminalPrefix represents the device name within the terminal function, designed to prevent terminal command recognition errors when device name contains illegal characters such as '#'."},"supportHealth":{"type":"boolean","description":"Support health"},"pmtudEnable":{"type":"boolean","description":"Path MTU Discovery enable."},"supportAutoAddOuiBasedVlan":{"type":"boolean","description":"Whether support auto add oui based vlan."},"mtuList":{"type":"array","description":"MTU List","items":{"$ref":"#/components/schemas/OswMtuCountVO"}}}},"OswLanMulticastVO":{"type":"object","properties":{"reportSuppressionEnable":{"type":"boolean","description":"Whether report suppression is enabled"},"fastLeaveEnable":{"type":"boolean","description":"Whether fast leave is enabled"}}},"OswMlagPeerInfoVO":{"type":"object","properties":{"mac":{"type":"string","description":"M-LAG Peer device mac"},"name":{"type":"string","description":"M-LAG Peer device name"},"portNum":{"type":"integer","description":"Number of ports in the M-LAG group","format":"int32"},"maxLagNum":{"type":"integer","description":"Maximum number of LAG groups","format":"int32"},"maxLagMember":{"type":"integer","description":"Maximum number of ports in a LAG group","format":"int32"},"usedLagIds":{"uniqueItems":true,"type":"array","description":"List of used lag IDs","items":{"type":"integer","description":"List of used lag IDs","format":"int32"}}},"description":"M-LAG Peer device info"},"OswMtuCountVO":{"type":"object","properties":{"mtu":{"type":"integer","description":"MTU value","format":"int32"},"count":{"type":"integer","description":"The count of MTU value","format":"int32"}},"description":"MTU List"},"OswQosConfigVO":{"required":["dot1pQueueMappingId","dscpDot1pMappingId","queueSchedulerId"],"type":"object","properties":{"dscpDot1pMappingId":{"type":"string","description":"Dscp Dot1p Mapping ID"},"dscpDot1pMappingName":{"type":"string","description":"Dscp Dot1p Mapping Name"},"dot1pQueueMappingId":{"type":"string","description":"Dot1p Queue Mapping ID"},"dot1pQueueMappingName":{"type":"string","description":"Dot1p Queue Mapping Name"},"queueSchedulerId":{"type":"string","description":"Queue Scheduler ID"},"queueSchedulerName":{"type":"string","description":"Queue Scheduler Name"}},"description":"Switch qos config"},"OswSnmpVO":{"type":"object","properties":{"location":{"pattern":"^[!-~][\\040-\\0176]{0,126}[!-~]$|^[!-~]$|$","type":"string","description":"Location"},"contact":{"pattern":"^[\\041-\\0176]{0,128}$","type":"string","description":"Contact"},"type":{"type":"integer","description":"SNMP config type, 0: use site setting, 1:custom","format":"int32"}},"description":"Snmp setting"},"OswStpInstance":{"type":"object","properties":{"id":{"type":"integer","description":"ID","format":"int32"},"priority":{"type":"integer","description":"Priority","format":"int32"},"vlan":{"type":"string","description":"Vlan"}},"description":"Instances"},"OswStpMstpVO":{"type":"object","properties":{"region":{"$ref":"#/components/schemas/OswStpRegion"},"instances":{"type":"array","description":"Instances","items":{"$ref":"#/components/schemas/OswStpInstance"}}},"description":"STP MSTP mode settging"},"OswStpRegion":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"revision":{"type":"integer","description":"Revision","format":"int32"}},"description":"Region"},"MultiOswPortSettingOpenApiVO":{"required":["selectAll","switchList"],"type":"object","properties":{"switchList":{"type":"array","description":"Switch List with port and LAG info","items":{"$ref":"#/components/schemas/OswPortLagListVO"}},"selectAll":{"type":"boolean","description":"Indicates whether select all switch ports.false: include selected switch ports and lags in Parameter [switchList], true: all switch ports and lags but exclude selected switch ports and lags in Parameter [switchList]."},"searchKey":{"type":"string","description":"The keywords of the searchIt is effected when [selectAll] is 'true'."},"filters":{"type":"object","additionalProperties":{"type":"object","description":"Filter conditions in the form of Map.It is effected when [selectAll] is 'true', filter key is the filter field and the value is the filter content.Filter fields include: [connectedStatus], [networkMode], [poeDisplayType], [linkSpeed], [duplex],[switchMac], [switchStatusCategory], [switchSupportPoe], [nativeNetworkId], [networkTagsSetting], [profileId], [operation], [tagIds]."},"description":"Filter conditions in the form of Map.It is effected when [selectAll] is 'true', filter key is the filter field and the value is the filter content.Filter fields include: [connectedStatus], [networkMode], [poeDisplayType], [linkSpeed], [duplex],[switchMac], [switchStatusCategory], [switchSupportPoe], [nativeNetworkId], [networkTagsSetting], [profileId], [operation], [tagIds]."},"tagIds":{"type":"array","description":"Tag ID List","items":{"type":"string","description":"Tag ID List"}},"nativeNetworkId":{"type":"string","description":"Native Network ID, Native Network cannot be selected from Tagged Networks or Untagged Networks."},"nativeBridgeVlan":{"type":"integer","description":"Native Network Bridge Vlan.","format":"int32"},"networkTagsSetting":{"type":"integer","description":"Network Tags Setting should be a value as follows: 0: Allow All; 1: Block All; 2: Custom","format":"int32"},"tagNetworkIds":{"type":"array","description":"Tag Network IDs","items":{"type":"string","description":"Tag Network IDs"}},"tagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Tag Network Bridge Vlan Map","items":{"type":"integer","description":"Tag Network Bridge Vlan Map","format":"int32"}},"description":"Tag Network Bridge Vlan Map"},"untagNetworkIds":{"type":"array","description":"Untag Network IDs","items":{"type":"string","description":"Untag Network IDs"}},"untagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Untag Network Bridge Vlan Map","items":{"type":"integer","description":"Untag Network Bridge Vlan Map","format":"int32"}},"description":"Untag Network Bridge Vlan Map"},"voiceNetworkEnable":{"type":"boolean","description":"Indicates whether voice network is enabled"},"voiceNetworkId":{"type":"string","description":"Voice Network ID"},"voiceBridgeVlan":{"type":"integer","description":"Voice Network Bridge Vlan","format":"int32"},"profileId":{"type":"string","description":"Profile ID"},"profileOverrideEnable":{"type":"boolean","description":"Indicates whether to enable Profile Override before v6.2.10; Indicates the fill mode of port configuration after v6.2.10: true: custom; false: follow profile"},"profileVlanOverrideEnable":{"type":"boolean","description":"Indicates the fill mode of vlan configuration: true: custom; false: follow profile"}}},"EasyManagedSwitchGeneralConfig":{"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,30}[^ ]$","type":"string","description":"Device name should contain 1 to 32 characters."},"ledSetting":{"type":"integer","description":"LED setting should be a value as follows: 0:off; 1:on; 2:Use Site Settings","format":"int32"},"tagIds":{"type":"array","description":"Tag IDs","items":{"type":"string","description":"Tag IDs"}},"jumboEnable":{"type":"boolean","description":"Parameter [jumboEnable] should be true or false."},"location":{"$ref":"#/components/schemas/DeviceLocationDetailVO"},"remember":{"type":"boolean","description":"Parameter [remember] should be true or false."},"powerAlertEnable":{"type":"boolean","description":"Power alert status."}}},"ESDetailVO":{"type":"object","properties":{"type":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"mac":{"type":"string","description":"Device mac"},"name":{"type":"string","description":"Device name,default value is the mac address of device"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"compoundModel":{"type":"string","description":"Model complex used in the backend.Ap：model+(country)+modelVersion,  EAP225(EU) v3.0 Ap: specialModel+modelVersion, EAP225-Outdoor-1a20a950b8d950e8 v1.0  Gateway/Switch：model+modelVersion, Osg v3.0"},"showModel":{"type":"string","description":"Model complex shown in the front end.Ap：model+(country)+modelVersion,EAP225(EU) v3.0  Gateway/Switch：model+modelVersion,Osg v3.0"},"specialModel":{"type":"string","description":"Special device model,for example:EAP225-Outdoor-1a20a950b8d950e8"},"firmwareVersion":{"type":"string","description":"Version of firmware,for example:2.5.0 Build 20190118 Rel. 64821"},"version":{"type":"string","description":"Simplified version of firmware,for example:2.5.0"},"hwVersion":{"type":"string","description":"Version of hardware,for example 1.0"},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected;1:Disconnected(Migrating);10:Provisioning;11:Configuring;12:Upgrading;13:Rebooting;14:Connected;15:Connected(Wireless);16:Connected(Migrating);17:Connected(Wireless,Migrating);20:Pending;21:Pending(Wireless);22:Adopting;23:Adopting(Wireless);24:Adopt Failed;25:Adopt Failed(Wireless);26:Managed By Others;27:Managed By Others(Wireless);30:Heartbeat Missed;31:Heartbeat Missed(Wireless);32:Heartbeat Missed(Migrating);33:Heartbeat Missed(Wireless,Migrating);40:Isolated;41:Isolated(Migrating);50:Slice Configuring","format":"int32"},"statusCategory":{"type":"integer","description":"Category of device status,statusCategory should be a value as follows: 0:Disconnected;1:Connected;2:Pending;3:Heartbeat Missed;4:Isolated","format":"int32"},"es":{"type":"boolean","description":"Whether the device is Agile Series Switch"},"site":{"type":"string","description":"Site of the device"},"siteName":{"type":"string","description":"Site name of the device"},"omadacId":{"type":"string","description":"OmadacId of the device"},"compatible":{"type":"integer","description":"Device firmware and controller compatibility type.Compatible should be a value as follows: 0:COMPATIBLE;1:HIGH_MAJOR_VER;2:LOW_MAJOR_VER;3:HIGH_MINOR_VER;4:LOW_MINOR_VER;7:HIGH_COMPONENT_VER;10:DEVICE_NOT_COMPATIBLE;11:HIGH_ADOPT_COMMPONENT;12:DEVICE_CATEGORY_NOT_COMPATIBLE;14:DEVICE_NOT_COMPATIBLE_IN_CLUSTER","format":"int32"},"supportAnomaly":{"type":"boolean","description":"Whether the device firmware support intelligent anomaly detection"},"supportLocatePort":{"type":"boolean","description":"Whether the device supports locating port"},"active":{"type":"boolean","description":"whether to active the device(cloud base exclusive)"},"licenseStatus":{"type":"integer","description":"License status(cloud base exclusive).LicenseStatus should be a value as follows: 0:unActive 1:Unbind 2:Expired 3:active","format":"int32"},"dueTime":{"type":"integer","description":"Expire timestamp of license(cloud base exclusive)","format":"int64"},"dueTimeLeft":{"type":"integer","description":"Milliseconds from the current moment to the expiration time(cloud base exclusive)","format":"int64"},"licenseId":{"type":"string","description":"License key on detail page of device(cloud base exclusive)"},"licenseUnbindingLimit":{"type":"integer","description":"Remaining unbind count for license on detail Page of device(cloud base exclusive)","format":"int32"},"initialUnbindingLimit":{"type":"integer","description":"Initial unbind count for license(cloud base exclusive)","format":"int32"},"category":{"type":"string","description":"Category of license"},"forgetId":{"type":"string","description":"Forget ID of device"},"sn":{"type":"string"},"eost":{"type":"integer","description":"End of service time of device(CBC exclusive)","format":"int64"},"eos":{"type":"integer","description":"End of support time of device(CBC exclusive)","format":"int64"},"inWhitelist":{"type":"boolean","description":"Whether the device is in white list"},"location":{"$ref":"#/components/schemas/DeviceLocationDetailVO"},"addedInAdvanced":{"type":"boolean","description":"Whether the device is added in advanced."},"customId":{"type":"string","description":"Customer ID"},"customName":{"type":"string","description":"Customer name"},"moveSiteId":{"type":"string","description":"Record that the device is in a moveSite operation; if it is null, then it is not in the moveSite operation."},"remember":{"type":"boolean","description":"Whether to remember the device(deprecated)","deprecated":true},"rememberDevice":{"type":"integer","description":"Whether to remember the device.RememberDevice should be a value as follows: 0:off, 1:on, 2: follow site","format":"int32"},"description":{"type":"string","description":"Description of the device"},"disableHwReset":{"type":"boolean","description":"Whether to disable hardware reset"},"templateId":{"type":"string","description":"ID of the template bound to the device"},"templateName":{"type":"string","description":"Name of the template bound to the device"},"boundSiteTemplate":{"type":"boolean","description":"Whether the site where the device is located is bound to a site template"},"deviceTemplateAvailable":{"type":"boolean","description":"Whether there is an available device template for the device; it is false if the model is not supported or the site template has not created the corresponding device template."},"boundDeviceTemplate":{"type":"boolean","description":"Whether the device is bound to device template"},"siteTemplateName":{"type":"string","description":"Template name bound to the site"},"siteTemplateId":{"type":"string","description":"Template ID bound to the site"},"deviceSeriesType":{"type":"integer","description":"Device series type.DeviceSeriesType should be a value as follows: 0:advanced;1:pro","format":"int32"},"resource":{"type":"integer","description":"Data source.Resource should be a value as follows: 0:new created;1:from template;2:override","format":"int32"},"ecspFirstVersion":{"type":"integer","description":"Ecsp first version","format":"int32"},"latestVersion":{"type":"string","description":"Latest firmware version"},"replaceDeviceInfo":{"$ref":"#/components/schemas/DeviceReplaceSettingVO"},"id":{"type":"string"},"deviceMisc":{"$ref":"#/components/schemas/OswDeviceMiscVO"},"managerMark":{"type":"integer","format":"int32"},"devCap":{"$ref":"#/components/schemas/OswDevCapVO"},"ledSetting":{"type":"integer","format":"int32"},"mvlanNetworkId":{"type":"string"},"mvlanBridgeVlan":{"type":"integer","format":"int32"},"ipSetting":{"$ref":"#/components/schemas/IpSettingVO"},"loopbackDetectEnable":{"type":"boolean"},"stp":{"type":"integer","format":"int32"},"priority":{"type":"integer","format":"int32"},"maxAge":{"type":"integer","format":"int32"},"forwardDelay":{"type":"integer","format":"int32"},"txHoldCount":{"type":"integer","format":"int32"},"ports":{"type":"array","items":{"$ref":"#/components/schemas/OswPortVO"}},"lags":{"type":"array","items":{"$ref":"#/components/schemas/OswLagVO"}},"tagIds":{"type":"array","items":{"type":"string"}},"ip":{"type":"string"},"publicIp":{"type":"string"},"lastSeen":{"type":"integer","format":"int64"},"needUpgrade":{"type":"boolean"},"uptime":{"type":"string"},"uptimeLong":{"type":"integer","format":"int64"},"cpuUtil":{"type":"integer","format":"int32"},"memUtil":{"type":"integer","format":"int32"},"poeTotalPower":{"type":"number","format":"double"},"poeRemain":{"type":"number","format":"double"},"poeRemainPercent":{"type":"number","format":"double"},"fanStatus":{"type":"integer","format":"int32"},"uplink":{"$ref":"#/components/schemas/OswUplinkVO"},"downlinkList":{"type":"array","items":{"$ref":"#/components/schemas/OswDownlinkVO"}},"download":{"type":"integer","format":"int64"},"upload":{"type":"integer","format":"int64"},"jumboEnable":{"type":"boolean"},"speeds":{"type":"array","items":{"type":"integer","format":"int32"}},"unknownMulticastRule":{"type":"integer","format":"int32"},"loop":{"type":"string"},"loopbackNum":{"type":"integer","format":"int32"},"block":{"type":"string","description":"Block information"},"blockNum":{"type":"integer","description":"Block Num","format":"int32"},"txRate":{"type":"integer","description":"Tx Rate","format":"int64"},"rxRate":{"type":"integer","description":"Rx Rate","format":"int64"},"networkNotify":{"type":"boolean"},"supportPortAlert":{"type":"boolean"},"supportPowerAlert":{"type":"boolean"},"powerAlertEnable":{"type":"boolean"},"supportStp":{"type":"boolean"},"powerStatusList":{"type":"array","items":{"$ref":"#/components/schemas/OswPortAlertStatusVO"}},"templateSettings":{"type":"array","items":{"type":"integer","format":"int32"}},"supportCableTest":{"type":"boolean"},"supportGetOspfNeighborTable":{"type":"boolean"},"multicast":{"$ref":"#/components/schemas/OswLanMulticastVO"},"terminalPrefix":{"type":"string","description":"TerminalPrefix represents the device name within the terminal function, designed to prevent terminal command recognition errors when device name contains illegal characters such as '#'."},"supportHealth":{"type":"boolean","description":"Support health"},"supportAutoAddOuiBasedVlan":{"type":"boolean","description":"Whether support auto add oui based vlan."}}},"OperationResponseESDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ESDetailVO"}}},"OswPortAlertStatusVO":{"type":"object","properties":{"power":{"type":"string"},"status":{"type":"integer","format":"int32"},"voltage":{"type":"number","format":"double"}}},"OswPortSettingOpenApiVO":{"required":["profileOverrideEnable"],"type":"object","properties":{"mac":{"type":"string","description":"The device mac to which the port belongs"},"name":{"pattern":"^[^ ?\"]$|^[^ ?\"][^?\"]{0,126}[^ ?\"]$","type":"string","description":"Port name"},"profileId":{"type":"string","description":"Lan Profile ID"},"profileOverrideEnable":{"type":"boolean","description":"Indicates whether to enable Profile Override"},"operation":{"pattern":"switching|mirroring|aggregating","type":"string","description":"Operation should be a value as follows: SWITCHING; MIRRORING; AGGREGATING"},"mirroredPorts":{"uniqueItems":true,"type":"array","description":"Monitored Port","items":{"type":"integer","description":"Monitored Port","format":"int32"}},"mirroredLags":{"uniqueItems":true,"type":"array","description":"Monitored LAG","items":{"type":"integer","description":"Monitored LAG","format":"int32"}},"lagSetting":{"$ref":"#/components/schemas/OswLagBasicVO"},"linkSpeed":{"type":"integer","description":"LinkSpeed should be a value as follows: 0: Auto; 1: 10M; 2: 100M; 3: 1000M; 4: 2500M; 5: 10G; 6: 5G; 7: 25G; 8: 100G; 9: 40G.","format":"int32"},"duplex":{"type":"integer","description":"Duplex should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"},"dot1x":{"type":"integer","description":"Dot1x should be a value as follows: 0: Force unauthorized; 1: Force authorized; 2: Auto","format":"int32"},"poe":{"type":"integer","description":"PoE switch should be a value as follows: 0: Off; 1: 802.3at/af","format":"int32"},"bandWidthCtrlType":{"type":"integer","description":"BandWidthCtrlType should be a value as follows: 0: Off; 1: Rate Limit; 2: Storming Control","format":"int32"},"bandCtrl":{"$ref":"#/components/schemas/OswBandCtrlVO"},"stormCtrl":{"$ref":"#/components/schemas/OswStormCtrlOpenApiVO"},"lldpMedEnable":{"type":"boolean","description":"LLDP-MED enable status"},"topoNotifyEnable":{"type":"boolean","description":"TopoNotify enable status"},"spanningTreeEnable":{"type":"boolean","description":"SpanningTree enable status"},"spanningTreeSetting":{"$ref":"#/components/schemas/SpanningTreeSettingVO"},"loopbackDetectEnable":{"type":"boolean","description":"LoopbackDetect enable status"},"loopbackDetectVlanBasedEnable":{"type":"boolean","description":"LoopbackDetectVLANBased enable status"},"igmpFastLeaveEnable":{"type":"boolean","description":"Indicates whether igmp fast leave is enabled"},"mldFastLeaveEnable":{"type":"boolean","description":"Indicates whether mld fast leave is enabled"},"portIsolationEnable":{"type":"boolean","description":"Port-isolation enable status"},"eeeEnable":{"type":"boolean","description":"EEE enable status"},"flowControlEnable":{"type":"boolean","description":"FlowControl enable status"},"fastLeaveEnable":{"type":"boolean","description":"Indicates whether igmpSnooping fastLeave is enabled"},"dhcpL2RelaySettings":{"$ref":"#/components/schemas/OswPortDhcpL2RelayVO"},"stackSetting":{"$ref":"#/components/schemas/OswPortStackSettingVO"},"dot1pPriority":{"type":"integer","description":"Dot1p Priority","format":"int32"},"trustMode":{"type":"integer","description":"TrustMode should be a value as follows: 0: Untrusted; 1: Trust 802.1p; 2: Trust DSCP","format":"int32"}}},"OswStormCtrlOpenApiVO":{"required":["action","broadcastEnable","multicastEnable","unknownUnicastEnable"],"type":"object","properties":{"unknownUnicastEnable":{"type":"boolean","description":"Unknown-Unicast enable status"},"unknownUnicast":{"type":"integer","description":"Unknown-Unicast","format":"int32"},"multicastEnable":{"type":"boolean","description":"Multicast enable status"},"multicast":{"type":"integer","description":"Multicast","format":"int32"},"broadcastEnable":{"type":"boolean","description":"Broadcast enable status"},"broadcast":{"type":"integer","description":"Broadcast","format":"int32"},"action":{"type":"integer","description":"Action should be a value as follows: 0: drop(default), 1: shutdown","format":"int32"},"recoverTime":{"type":"integer","description":"Recover Time should be within the range of 1-3600, default 3600","format":"int32"}},"description":"Storm Control"},"OperationResponseOswStackNetworkModifyRespOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswStackNetworkModifyRespOpenApiVO"}}},"OswStackNetworkModifyRespOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Network ID"}}},"OswStackMemberLagOpenApiVO":{"required":["profileOverrideEnable"],"type":"object","properties":{"name":{"pattern":"^[^ ?\"]$|^[^ ?\"][^?\"]{0,126}[^ ?\"]$","type":"string","description":"Lag Name"},"profileId":{"type":"string","description":"Profile ID"},"profileOverrideEnable":{"type":"boolean","description":"Indicates whether to enable Profile Override"},"linkSpeed":{"type":"integer","description":"Link Speed should be a value as follows: 0: auto; 1: 10M; 2: 100M; 3: 1000M; 4: 2.5G; 5: 10G","format":"int32"},"duplex":{"type":"integer","description":"Duplex should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"},"bandCtrl":{"$ref":"#/components/schemas/OswBandCtrlVO"},"stormCtrl":{"$ref":"#/components/schemas/OswStormCtrlVO"},"bandWidthCtrlType":{"type":"integer","description":"BandWidthCtrlType should be a value as follows: 0: Off; 1: Rate Limit; 2: Storming Control","format":"int32"},"spanningTreeEnable":{"type":"boolean","description":"Indicates whether SpanningTree is enabled"},"spanningTreeSetting":{"$ref":"#/components/schemas/SpanningTreeSettingVO"},"loopbackDetectEnable":{"type":"boolean","description":"Indicates whether loopbackDetect port based is enabled"},"loopbackDetectVlanBasedEnable":{"type":"boolean","description":"Indicates whether loopbackDetect vlan based is enabled"},"igmpFastLeaveEnable":{"type":"boolean","description":"Indicates whether igmp fast leave is enabled"},"mldFastLeaveEnable":{"type":"boolean","description":"Indicates whether mld fast leave is enabled"},"portIsolationEnable":{"type":"boolean","description":"Indicates whether port isolation is enabled"},"eeeEnable":{"type":"boolean","description":"Indicates whether EEE is enabled"},"flowControlEnable":{"type":"boolean","description":"Indicates whether flow control is enabled"},"fastLeaveEnable":{"type":"boolean","description":"Indicates whether igmpSnooping fastLeave is enabled"},"dhcpL2RelaySettings":{"$ref":"#/components/schemas/OswPortDhcpL2RelayVO"},"dot1pPriority":{"type":"integer","description":"Dot1p Priority","format":"int32"},"trustMode":{"type":"integer","description":"TrustMode should be a value as follows: 0: Untrusted; 1: Trust 802.1p; 2: Trust DSCP","format":"int32"},"standardPorts":{"type":"array","description":"LAG Standard ports","items":{"$ref":"#/components/schemas/OswStandPortVO"}}}},"OswStackDetailConfigOpenApiVO":{"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"Stack Name"},"ledSetting":{"type":"integer","description":"LED setting should be a value as follows: 0:off; 1:on; 2:Use Site Settings","format":"int32"},"mvlanNetworkId":{"type":"string","description":"Management VLAN network ID"},"mvlanBridgeVlan":{"type":"integer","description":"Only valid when mvlanNetworkId is bridge vlan","format":"int32"},"loopbackDetectEnable":{"type":"boolean","description":"LoopbackDetect enable status"},"stp":{"type":"integer","description":"Spanning Tree Protocol should be a value as follows: 1: STP; 2: RSTP; 3: MSTP; 4: RPVST 0: OFF","format":"int32"},"snmp":{"$ref":"#/components/schemas/OswSnmpVO"},"priority":{"type":"integer","description":"STP priority should be an integer from 0 to 61440 and divisible by 4096","format":"int32"},"helloTime":{"type":"integer","description":"STP helloTime should be should be within the range of 1-10","format":"int32"},"maxAge":{"type":"integer","description":"STP maxAge should be should be within the range of 6-40","format":"int32"},"forwardDelay":{"type":"integer","description":"STP should be should be within the range of 4-30","format":"int32"},"txHoldCount":{"type":"integer","description":"STP txHoldCount should be should be within the range of 1-20","format":"int32"},"maxHops":{"type":"integer","description":"STP maxHops should be should be within the range of 1-40","format":"int32"},"mstp":{"$ref":"#/components/schemas/OswStpRpvstVO"},"tagIds":{"type":"array","description":"Tag ID List","items":{"type":"string","description":"Tag ID List"}},"jumbo":{"type":"integer","description":"Jumbo should be should be within the range of 1518-9216","format":"int32"},"lagHashAlg":{"type":"integer","description":"It should be a value as follows: 0: SRC MAC; 1: DST MAC; 2: SRC MAC + DST MAC; 3: SRC IP; 4: DST IP; 5: SRC IP + DST IP","format":"int32"},"location":{"$ref":"#/components/schemas/DeviceLocationDetailVO"},"qosConfig":{"$ref":"#/components/schemas/OswQosConfigVO"},"rememberDevice":{"type":"integer","description":"Whether to remember the device.RememberDevice should be a value as follows: 0:off, 1:on, 2: follow site","format":"int32"}}},"ModifyVoipDeviceApSettingEntity":{"required":["skipConfirm"],"type":"object","properties":{"voipDeviceApConfiguration":{"$ref":"#/components/schemas/VoipDeviceApConfigurationOpenApiVO"},"telephoneNumberAdvancedSetting":{"$ref":"#/components/schemas/TelephoneNumberAdvancedSettingApOpenApiVO"},"skipConfirm":{"type":"boolean","description":"skipConfirm indicates whether to skip the query of \"#'s conflict\" of voip device settings. false: Not to skip the query. true: Skip the query and the device will give priority to the \"end with #\" configuration. "}}},"TelephoneNumberAdvancedSettingApOpenApiVO":{"type":"object","properties":{"locale":{"type":"integer","description":"The country code of telephone number.","format":"int32"},"dscpForSip":{"type":"integer","description":"The dscp For Sip of telephone number.","format":"int32"},"dscpForRtp":{"type":"integer","description":"The dscp For Rtp of telephone number.","format":"int32"},"dtmfRelaySetting":{"type":"integer","description":"The dtmf relay setting of telephone number.","format":"int32"},"expirationTime":{"type":"integer","description":"The expiration time of telephone number.","format":"int32"},"retryInterval":{"type":"integer","description":"The retry interval of telephone number.","format":"int32"},"t38Support":{"type":"boolean","description":"Whether to enable t38 Support."},"endWithNumberSign":{"type":"boolean","description":"Whether the telephone number setting end with number sign."}},"description":"Advanced settings."},"VoipDeviceApConfigurationOpenApiVO":{"type":"object","properties":{"numberIdForOutgoingCalls":{"type":"string","description":"The outgoing calls number ID of voip device."},"numberIdListForIncomingCalls":{"type":"array","description":"The list of incoming calls number ID.","items":{"type":"string","description":"The list of incoming calls number ID."}},"vadSupportEnable":{"type":"boolean","description":"Whether to enable vad support."},"speakerGain":{"type":"integer","description":"The speaker gain of voip device.","format":"int32"},"micGain":{"type":"integer","description":"The mic gain of voip device.","format":"int32"},"callBlockingEnable":{"type":"boolean","description":"Whether to enable callBlocking."},"callBlockingProfileId":{"type":"string","description":"The call blocking profile ID of voip device.When callBlockingEnable is true, it can not be null."},"callBlockingProfileName":{"type":"string","description":"The call blocking profile name of voip device."},"digitMapProfileId":{"type":"string","description":"The digit map profile ID of voip device."},"digitMapProfileName":{"type":"string","description":"The digit map profile name of voip device."}},"description":"Telephony settings."},"ModifyConfirmResultOpenApiVO":{"type":"object","properties":{"needConfirm":{"type":"boolean","description":"needConfirm indicates whether the digit map configuration conflicts with the \"end with #\" configuration of the current device."}}},"OperationResponseModifyConfirmResultOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ModifyConfirmResultOpenApiVO"}}},"TelephoneNumberListUpdateOpenApiVO":{"type":"object","properties":{"addTelephoneNumbers":{"type":"array","description":"Telephone numbers to be added.","items":{"$ref":"#/components/schemas/TelephoneNumberWithoutStatusOpenApiVO"}},"deleteTelephoneNumberIds":{"type":"array","description":"Telephone number IDs to be deleted.","items":{"type":"string","description":"Telephone number IDs to be deleted."}},"modifyTelephoneNumbers":{"type":"array","description":"Telephone numbers to be modified.","items":{"$ref":"#/components/schemas/TelephoneNumberWithoutStatusOpenApiVO"}}}},"ModifyVoipDeviceOsgSettingEntity":{"required":["skipConfirm"],"type":"object","properties":{"voipDeviceOsgConfiguration":{"$ref":"#/components/schemas/VoipDeviceOsgConfigurationOpenApiVO"},"telephoneNumberAdvancedSetting":{"$ref":"#/components/schemas/TelephoneNumberAdvancedSettingOsgOpenApiVO"},"skipConfirm":{"type":"boolean","description":"skipConfirm indicates whether to skip the query of \"#'s conflict\" of voip device settings. false: Not to skip the query. true: Skip the query and the device will give priority to the \"end with #\" configuration. "}}},"TelephoneNumberAdvancedSettingOsgOpenApiVO":{"required":["interfaceType"],"type":"object","properties":{"locale":{"type":"string","description":"The country code of telephone number."},"noAnswerTime":{"type":"integer","description":"The no answer time of telephone number.","format":"int32"},"t38Support":{"type":"boolean","description":"Whether to enable t38 Support."},"interfaceType":{"type":"integer","description":"InterfaceType should be a value as follows: 0: WAN; 1: LAN; 2: Virtual WAN.","format":"int32"},"interfaceId":{"type":"string","description":"Interface ID, for example: if interfaceType is LAN network, interfaceId should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface. When parameter [interfaceType] is 0 or 1, parameter [interfaceId] should not be empty."},"virtualWanId":{"type":"string","description":"Virtual WAN ID, can be obtained from 'Query virtual WAN list' interface. When parameter [interfaceType] is 2, parameter [virtualWanId] should not be empty."}},"description":"Advanced settings."},"VoipDeviceOsgConfigurationOpenApiVO":{"type":"object","properties":{"portSettings":{"type":"array","description":"VOIP device port setting.","items":{"$ref":"#/components/schemas/VoipDevicePortSettingOpenApiVO"}},"callBlockingEnable":{"type":"boolean","description":"Whether to enable callBlocking."},"callBlockingProfileId":{"type":"string","description":"The call blocking profile ID of voip device.When callBlockingEnable is true, it can not be null."},"callBlockingProfileName":{"type":"string","description":"The call blocking profile name of voip device."},"viaIpv6":{"type":"boolean","description":"Whether via IPv6."}},"description":"Telephony settings."},"VoipDevicePortSettingOpenApiVO":{"type":"object","properties":{"port":{"type":"integer","description":"Port ID.","format":"int32"},"numberIdForOutgoingCalls":{"type":"string","description":"The outgoing calls number ID of voip device."},"auto":{"type":"boolean","description":"Whether to enable auto."},"numberIdListForIncomingCalls":{"type":"array","description":"The list of incoming calls number ID.","items":{"type":"string","description":"The list of incoming calls number ID."}},"vadSupportEnable":{"type":"boolean","description":"Whether to enable vad support."},"speakerGain":{"type":"integer","description":"The speaker gain of voip device.","format":"int32"},"micGain":{"type":"integer","description":"The mic gain of voip device.","format":"int32"}},"description":"VOIP device port setting."},"BatchModifyVoipDeviceConfigurationEntity":{"type":"object","properties":{"vadSupportEnable":{"type":"boolean","description":"Whether to enable vad support."},"speakerGain":{"type":"integer","description":"The speaker gain of voip device.","format":"int32"},"micGain":{"type":"integer","description":"The mic gain of voip device.","format":"int32"},"callBlockingEnable":{"type":"boolean","description":"Whether to enable callBlocking."},"callBlockingProfileId":{"type":"string","description":"The call blocking profile ID of voip device.When callBlockingEnable is true, it can not be null."},"callBlockingProfileName":{"type":"string","description":"The call blocking profile name of voip device."},"digitMapProfileId":{"type":"string","description":"The digit map profile ID of voip device."},"digitMapProfileName":{"type":"string","description":"The digit map profile name of voip device."}},"description":"Telephony settings."},"BatchModifyVoipDeviceSettingEntity":{"required":["deviceMacList","skipConfirm"],"type":"object","properties":{"deviceMacList":{"type":"array","description":"Device MAC list.","items":{"type":"string","description":"Device MAC list."}},"voipDeviceConfiguration":{"$ref":"#/components/schemas/BatchModifyVoipDeviceConfigurationEntity"},"telephoneNumberAdvancedSetting":{"$ref":"#/components/schemas/TelephoneNumberAdvancedSettingApOpenApiVO"},"skipConfirm":{"type":"boolean","description":"skipConfirm indicates whether to skip the query of \"#'s conflict\" of voip device settings. false: Not to skip the query. true: Skip the query and the device(s) will give priority to the \"end with #\" configuration. "}}},"VoiceMailSettingRequest":{"required":["enable"],"type":"object","properties":{"omadacId":{"type":"string","description":"Omadac ID."},"siteId":{"type":"string","description":"Site ID."},"noAnswerTime":{"type":"integer","description":"The no answer time of telephone number. Parameter [noAnswerTime] should be from 5 to 60","format":"int32"},"remoteAccessPin":{"pattern":"^\\d{4,8}$","type":"string","description":"Remote access pin."},"voiceMailInUsb":{"type":"boolean","description":"Whether voice mail is in USB."},"greetingForVoiceMailMode":{"type":"integer","description":"Parameter [greetingForVoiceMailMode] should be 0 or 1. 0: Default, 1: Custom.","format":"int32"},"greetingName":{"type":"string","description":"Greeting name."},"usbUuid":{"type":"string","description":"USB UUID."},"voiceMailCapacity":{"type":"integer","description":"The capacity of voice mail.","format":"int32"},"enable":{"type":"boolean","description":"Whether to enable voice mail settings."},"remoteAccessEnable":{"type":"boolean","description":"Whether voice mail allows remote access."},"duration":{"type":"integer","description":"Parameter [duration] should be from 20 to 120.","format":"int32"}}},"NatTraversalTunnelModifyOpenApiVO":{"required":["appType"],"type":"object","properties":{"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name of the remote access tunnel."},"localAddress":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP address of the local target device."},"localPort":{"type":"integer","description":"Port of the local target device's service.","format":"int32"},"duration":{"type":"integer","description":"Valid duration time of the remote access tunnel, 1-24 hours.","format":"int32"},"appType":{"type":"string","description":"App type of the remote access tunnel for the local target device. HTTP, HTTPS, SSH, TELNET."},"openStatus":{"type":"boolean","description":"If open the remote access tunnel after create."},"localMac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"Mac of the local target device."},"clientManager":{"type":"boolean","description":"Client's manager of the remote access tunnel for the client."},"clientName":{"type":"string","description":"Client's name of the remote access tunnel for the client."},"clientDeviceType":{"type":"string","description":"Client's type of the remote access tunnel for the client."},"clientModel":{"type":"string","description":"Client's model of the remote access tunnel for the client."},"tunnelEntryType":{"type":"integer","description":"Entry of the remote access tunnel.1: custom tunnel 2: device tunnel 3:device detail 4:client detail","format":"int32"},"autoLogin":{"type":"boolean","description":"If the remote access tunnel enabled auto login. true: Auto login is enabled; false: Auto login is disabled."}}},"NatTraversalTunnelOpenVO":{"type":"object","properties":{"openStatus":{"type":"boolean","description":"Enable/Disable existing remote access tunnel. True: Enable, False: Disable"}}},"OltConfigModifyDTO":{"type":"object","properties":{"name":{"type":"string","description":"Device name,default value is the mac address of device"},"tagIds":{"type":"array","description":"Tag ID list","items":{"type":"string","description":"Tag ID list"}},"location":{"$ref":"#/components/schemas/DeviceLocationDetailVO"}}},"OltDetailDownlinkVO":{"type":"object","properties":{"port":{"type":"string","description":"Port"},"name":{"type":"string","description":"Name of the device connected to the port"},"mac":{"type":"string","description":"Mac of the device"},"ip":{"type":"string","description":"Ip address"},"ipv6":{"type":"string","description":"Ipv6"},"linkStatus":{"type":"integer","description":"Link status should be a value as follows: 0:LINK_DOWN;1:LINK_UP","format":"int32"},"speed":{"type":"integer","description":"Speed","format":"int64"},"type":{"type":"string","description":"Device type"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"}},"description":"Down-link list"},"OltDetailVO":{"type":"object","properties":{"type":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"mac":{"type":"string","description":"Device mac"},"name":{"type":"string","description":"Device name,default value is the mac address of device"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"compoundModel":{"type":"string","description":"Model complex used in the backend.Ap：model+(country)+modelVersion,  EAP225(EU) v3.0 Ap: specialModel+modelVersion, EAP225-Outdoor-1a20a950b8d950e8 v1.0  Gateway/Switch：model+modelVersion, Osg v3.0"},"showModel":{"type":"string","description":"Model complex shown in the front end.Ap：model+(country)+modelVersion,EAP225(EU) v3.0  Gateway/Switch：model+modelVersion,Osg v3.0"},"specialModel":{"type":"string","description":"Special device model,for example:EAP225-Outdoor-1a20a950b8d950e8"},"firmwareVersion":{"type":"string","description":"Version of firmware,for example:2.5.0 Build 20190118 Rel. 64821"},"version":{"type":"string","description":"Simplified version of firmware,for example:2.5.0"},"hwVersion":{"type":"string","description":"Version of hardware,for example 1.0"},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected;1:Disconnected(Migrating);10:Provisioning;11:Configuring;12:Upgrading;13:Rebooting;14:Connected;15:Connected(Wireless);16:Connected(Migrating);17:Connected(Wireless,Migrating);20:Pending;21:Pending(Wireless);22:Adopting;23:Adopting(Wireless);24:Adopt Failed;25:Adopt Failed(Wireless);26:Managed By Others;27:Managed By Others(Wireless);30:Heartbeat Missed;31:Heartbeat Missed(Wireless);32:Heartbeat Missed(Migrating);33:Heartbeat Missed(Wireless,Migrating);40:Isolated;41:Isolated(Migrating);50:Slice Configuring","format":"int32"},"statusCategory":{"type":"integer","description":"Category of device status,statusCategory should be a value as follows: 0:Disconnected;1:Connected;2:Pending;3:Heartbeat Missed;4:Isolated","format":"int32"},"es":{"type":"boolean","description":"Whether the device is Agile Series Switch"},"site":{"type":"string","description":"Site of the device"},"siteName":{"type":"string","description":"Site name of the device"},"omadacId":{"type":"string","description":"OmadacId of the device"},"compatible":{"type":"integer","description":"Device firmware and controller compatibility type.Compatible should be a value as follows: 0:COMPATIBLE;1:HIGH_MAJOR_VER;2:LOW_MAJOR_VER;3:HIGH_MINOR_VER;4:LOW_MINOR_VER;7:HIGH_COMPONENT_VER;10:DEVICE_NOT_COMPATIBLE;11:HIGH_ADOPT_COMMPONENT;12:DEVICE_CATEGORY_NOT_COMPATIBLE;14:DEVICE_NOT_COMPATIBLE_IN_CLUSTER","format":"int32"},"supportAnomaly":{"type":"boolean","description":"Whether the device firmware support intelligent anomaly detection"},"supportLocatePort":{"type":"boolean","description":"Whether the device supports locating port"},"active":{"type":"boolean","description":"whether to active the device(cloud base exclusive)"},"licenseStatus":{"type":"integer","description":"License status(cloud base exclusive).LicenseStatus should be a value as follows: 0:unActive 1:Unbind 2:Expired 3:active","format":"int32"},"dueTime":{"type":"integer","description":"Expire timestamp of license(cloud base exclusive)","format":"int64"},"dueTimeLeft":{"type":"integer","description":"Milliseconds from the current moment to the expiration time(cloud base exclusive)","format":"int64"},"licenseId":{"type":"string","description":"License key on detail page of device(cloud base exclusive)"},"licenseUnbindingLimit":{"type":"integer","description":"Remaining unbind count for license on detail Page of device(cloud base exclusive)","format":"int32"},"initialUnbindingLimit":{"type":"integer","description":"Initial unbind count for license(cloud base exclusive)","format":"int32"},"category":{"type":"string","description":"Category of license"},"forgetId":{"type":"string","description":"Forget ID of device"},"sn":{"type":"string","description":"SN code of device"},"eost":{"type":"integer","description":"End of service time of device(CBC exclusive)","format":"int64"},"eos":{"type":"integer","description":"End of support time of device(CBC exclusive)","format":"int64"},"inWhitelist":{"type":"boolean","description":"Whether the device is in white list"},"location":{"$ref":"#/components/schemas/DeviceLocationDetailVO"},"addedInAdvanced":{"type":"boolean","description":"Whether the device is added in advanced."},"customId":{"type":"string","description":"Customer ID"},"customName":{"type":"string","description":"Customer name"},"moveSiteId":{"type":"string","description":"Record that the device is in a moveSite operation; if it is null, then it is not in the moveSite operation."},"remember":{"type":"boolean","description":"Whether to remember the device(deprecated)","deprecated":true},"rememberDevice":{"type":"integer","description":"Whether to remember the device.RememberDevice should be a value as follows: 0:off, 1:on, 2: follow site","format":"int32"},"description":{"type":"string","description":"Description of the device"},"disableHwReset":{"type":"boolean","description":"Whether to disable hardware reset"},"templateId":{"type":"string","description":"ID of the template bound to the device"},"templateName":{"type":"string","description":"Name of the template bound to the device"},"boundSiteTemplate":{"type":"boolean","description":"Whether the site where the device is located is bound to a site template"},"deviceTemplateAvailable":{"type":"boolean","description":"Whether there is an available device template for the device; it is false if the model is not supported or the site template has not created the corresponding device template."},"boundDeviceTemplate":{"type":"boolean","description":"Whether the device is bound to device template"},"siteTemplateName":{"type":"string","description":"Template name bound to the site"},"siteTemplateId":{"type":"string","description":"Template ID bound to the site"},"deviceSeriesType":{"type":"integer","description":"Device series type.DeviceSeriesType should be a value as follows: 0:advanced;1:pro","format":"int32"},"resource":{"type":"integer","description":"Data source.Resource should be a value as follows: 0:new created;1:from template;2:override","format":"int32"},"ecspFirstVersion":{"type":"integer","description":"Ecsp first version","format":"int32"},"latestVersion":{"type":"string","description":"Latest firmware version"},"replaceDeviceInfo":{"$ref":"#/components/schemas/DeviceReplaceSettingVO"},"ip":{"type":"string","description":"Ip address"},"publicIp":{"type":"string","description":"Public ip address"},"ipv6List":{"type":"array","description":"Ipv6 address List","items":{"type":"string","description":"Ipv6 address List"}},"uptime":{"type":"string","description":"Runtime duration, for example:0 days 00:44:09"},"uptimeLong":{"type":"integer","description":"Runtime duration, in seconds (s).","format":"int64"},"cpuUtil":{"type":"integer","description":"Cpu utilization","format":"int32"},"memUtil":{"type":"integer","description":"Memory utilization","format":"int32"},"lastSeen":{"type":"integer","description":"Last online timestamp (ms)","format":"int64"},"down":{"type":"integer","description":"Total real-time down-link traffic(byte)","format":"int64"},"up":{"type":"integer","description":"Total real-time up-link traffic(byte)","format":"int64"},"onuCount":{"type":"integer","description":"Number of ONUs managed by the device","format":"int32"},"devCap":{"$ref":"#/components/schemas/OltDevCapVO"},"tagIds":{"type":"array","description":"Bound tag ID","items":{"type":"string","description":"Bound tag ID"}},"components":{"type":"object","additionalProperties":{"type":"string","description":"Component information of the Omada Controller sent to the OLT"},"description":"Component information of the Omada Controller sent to the OLT"},"downlinkList":{"type":"array","description":"Down-link list","items":{"$ref":"#/components/schemas/OltDetailDownlinkVO"}},"uplink":{"$ref":"#/components/schemas/OltUplinkVO"},"speeds":{"type":"array","description":"Supported rate list for all ports. Speeds should be a value as follows: 0:auto; 1:10M; 2:100M; 3:1000M; 4:2.5G; 5:10G; 6:5G; 7:25G; 8:100G; 9:40G; -1:error; no value:all rate supported","items":{"type":"integer","description":"Supported rate list for all ports. Speeds should be a value as follows: 0:auto; 1:10M; 2:100M; 3:1000M; 4:2.5G; 5:10G; 6:5G; 7:25G; 8:100G; 9:40G; -1:error; no value:all rate supported","format":"int32"}}}},"OltDevCapVO":{"type":"object","properties":{"ponPortCount":{"type":"integer","description":"Number of pon ports","format":"int32"},"lagCount":{"type":"integer","description":"Number of LAGs(Link Aggregation Group)","format":"int32"},"networkCheckSupport":{"type":"boolean","description":"Whether this OLT supports network check function"},"pingSupport":{"type":"boolean","description":"Whether this OLT supports ping function"},"traceRouteSupport":{"type":"boolean","description":"Whether this OLT supports traceRoute function"}},"description":"Capability of device"},"OltUplinkVO":{"type":"object","properties":{"mac":{"type":"string","description":"The mac of uplink device"},"name":{"type":"string","description":"The name of uplink device"},"model":{"type":"string","description":"The model of uplink device"},"hwVersion":{"type":"string","description":"HwVersion"},"modelVersion":{"type":"string","description":"Model Version"},"linkSpeed":{"type":"integer","description":"Link Speed","format":"int32"},"port":{"type":"string","description":"Olt port linking with uplink device"},"type":{"type":"string","description":"The type of uplink device"}},"description":"Up-link device"},"OperationResponseOltDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OltDetailVO"}}},"IpsSignatureConfig":{"required":["type"],"type":"object","properties":{"type":{"type":"integer","description":"Type should be a value as follow: 0: all traffic; 1: packet tracking","format":"int32","example":1},"direction":{"type":"integer","description":"Direction should be a value as follow: 0: both direction; 1: source direction; 2: destination direction","format":"int32","example":1},"trafficType":{"type":"integer","description":"TrafficType should be a value as follow: 0: ip address; 1: subnet","format":"int32","example":0},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IPS signature traffic Source. If parameter [trafficType] is 0, parameter [ip] is needed","example":"192.168.0.1"},"subnet":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])/([1-9]|((1|2)\\d)|(30|31|32))\\b","type":"string","description":"IPS signature traffic Source. If parameter [trafficType] is 1, parameter [subnet] is needed","example":"192.168.0.0/24"}},"description":"IPS signature configuration"},"LanMappingVO":{"type":"object","properties":{"lanRelation":{"type":"array","items":{"$ref":"#/components/schemas/LanPortMappingVO"}}}},"LanPortMappingVO":{"type":"object","properties":{"dstPort":{"type":"string"},"srcPorts":{"type":"array","items":{"type":"string"}}}},"NetworkMappingVO":{"type":"object","properties":{"wanMapping":{"$ref":"#/components/schemas/WanMappingVO"},"lanMapping":{"$ref":"#/components/schemas/LanMappingVO"},"destModel":{"type":"integer","format":"int32"},"wanNum":{"type":"integer","format":"int32"}}},"WanMappingVO":{"type":"object","properties":{"wanRelation":{"type":"array","items":{"$ref":"#/components/schemas/WanPortMappingVO"}},"enableWanPorts":{"maxItems":2147483647,"minItems":1,"type":"array","items":{"maxLength":2147483647,"minLength":1,"type":"string"}}}},"WanPortMappingVO":{"type":"object","properties":{"dstPort":{"type":"string"},"srcPort":{"type":"string"}}},"OperationResponseInternetOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/InternetOpenApiVO"}}},"EditVoucherGroupPatternOpenApiVO":{"type":"object","properties":{"patternType":{"type":"integer","description":"0: Logo, 1: Title, 2: Disable","format":"int32"},"position":{"type":"integer","description":"0: Left, 1: Right, 2: Middle","format":"int32"},"logoPictureId":{"type":"string","description":"Logo picture ID"},"logoSize":{"type":"integer","description":"Logo size. It should be within the range of 50-175","format":"int32"},"title":{"type":"string","description":"Voucher title"},"titleSize":{"type":"integer","description":"Voucher title size. It should be within the range of 12-18","format":"int32"},"ssidNetworkenable":{"type":"boolean","description":"Whether to print SSIDs and networks on the pattern of the voucher"},"ssidList":{"type":"array","description":"SSID list on the pattern of the voucher","items":{"type":"string","description":"SSID list on the pattern of the voucher"}},"networkList":{"type":"array","description":"Network list on the pattern of the voucher","items":{"type":"string","description":"Network list on the pattern of the voucher"}},"durationEnable":{"type":"boolean","description":"Whether to print duration of the voucher"},"limitEnable":{"type":"boolean","description":"Whether to print limit information of the voucher"},"printComments":{"type":"string","description":"Comments to print on the voucher"}}},"HotspotSiteSettingOpenApiVO":{"type":"object","properties":{"currency":{"type":"string","description":"Currency Short Code of voucher. For the values of Currency Short Code, refer to section 5.4.2 of the Open API Access Guide."}}},"GatewayPortSettingConfig":{"type":"object","properties":{"linkSpeed":{"type":"integer","description":"Port link speed should be a value as follows: 0: Auto; 1: 10M; 2: 100M; 3: 1000M; 4: 2500M; 5: 10G; 6: 5G","format":"int32"},"duplex":{"type":"integer","description":"Port duplex mode should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"},"mirrorEnable":{"type":"boolean","description":"Port enabled mirror or not"},"mirroredPorts":{"uniqueItems":true,"type":"array","description":"Mirrored Ports Set","items":{"type":"integer","description":"Mirrored Ports Set","format":"int32"}},"mirrorMode":{"type":"integer","description":"Port mirror mode should be a value as follow: 0: ingress; 1: egress; 2: ingress and egress.","format":"int32"},"pvid":{"type":"integer","description":"Pvid(only for lan port.)","format":"int32"},"flowControl":{"type":"boolean","description":"Enable flow control or not.(When the port supports flow control.)"},"status":{"type":"integer","description":"Enable port or not, status should be a value as follows: 0: disable; 1: enable.(When the port supports status.)","format":"int32"},"poeMode":{"type":"integer","description":"Enter a value as follows: 0: off; 1: 802.3at/af.","format":"int32"},"dslSettings":{"$ref":"#/components/schemas/DslSettings"},"tagSet":{"uniqueItems":true,"type":"array","description":"Tag ID Set","items":{"type":"string","description":"Tag ID Set"}}}},"OperationResponseGatewayPortSettingConfig":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GatewayPortSettingConfig"}}},"Ipv6ForIpptOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Is Lan ipv6 for Ip Pass-through enable."}}},"GatewayPortConfig":{"required":["port"],"type":"object","properties":{"port":{"type":"integer","description":"Port serial number","format":"int32"},"linkSpeed":{"type":"integer","description":"Port link speed should be a value as follows: 0: Auto; 1: 10M; 2: 100M; 3: 1000M; 4: 2500M; 5: 10G; 6: 5G","format":"int32"},"duplex":{"type":"integer","description":"Port duplex mode should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"},"mirrorEnable":{"type":"boolean","description":"Port enabled mirror or not"},"mirroredPorts":{"uniqueItems":true,"type":"array","description":"Mirrored Ports Set","items":{"type":"integer","description":"Mirrored Ports Set","format":"int32"}},"mirrorMode":{"type":"integer","description":"Port mirror mode should be a value as follows: 0: ingress; 1: egress; 2: ingress and egress","format":"int32"},"pvid":{"type":"integer","description":"Pvid(only for lan port.)","format":"int32"},"flowControl":{"type":"boolean","description":"Enable flow control or not.(When the port supports flow control.)"},"status":{"type":"integer","description":"Enable port or not, status should be a value as follows: 0: disable; 1: enable.(When the port supports status.)","format":"int32"},"dslSettings":{"$ref":"#/components/schemas/DslSettings"}},"description":"gateway port config entity"},"gateway ports config entity":{"type":"object","properties":{"portsConfig":{"type":"array","description":"gateway port config entity","items":{"$ref":"#/components/schemas/GatewayPortConfig"}}}},"OperationResponseGateway Ports Config Entity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/gateway ports config entity"}}},"IpptWanModeOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"whether to enable wan Settings Override"},"interval":{"type":"integer","description":"Time taken to check the connection of wan port.","format":"int32"},"unit":{"type":"integer","description":"Unit. 0: minute, 1: second.","format":"int32"}}},"Dot1xSwitchOpenApiVO":{"required":["authMode","authType","enable","mab","macFormat","radiusProfileId","vlanAssign"],"type":"object","properties":{"enable":{"type":"boolean","description":"Switch 802.1x function enable status"},"radiusProfileId":{"type":"string","description":"This field represents radius profile ID. Radius profile can be created using 'Create a new RADIUS profile' ('Create a new RADIUS profile template') interface, and radius profile ID can be obtained from 'Get RADIUS profile list' ('Get RADIUS profile template list') interface"},"authMode":{"type":"integer","description":"Mode of authentication protocol. AuthMode should be a value as follows: 0: PAP, 1: EAP","format":"int32"},"authType":{"type":"integer","description":"Type of the authentication. AuthType should be a value as follows: 0: Port based, 1: Mac based","format":"int32"},"vlanAssign":{"type":"boolean","description":"VLAN Assignment enable status"},"mab":{"type":"boolean","description":"MAB enable status"},"macFormat":{"type":"integer","description":"Format of the MAC address. MacFormat should be a value as follows: 0: aabbccddeeff, 1: aa-bb-cc-dd-ee-ff, 2: aa:bb:cc:dd:ee:ff, 3: AABBCCDDEEFF, 4: AA-BB-CC-DD-EE-FF, 5: AA:BB:CC:DD:EE:FF","format":"int32"},"nasId":{"pattern":"^(?![\\x20-\\x7E]*[?\"][\\x20-\\x7E]*$)[\\x20-\\x7E]{1,31}$","type":"string","description":"Nas ID,NasId should contain 1~31 characters, except the question mark (?) and double quote (\")."},"guestVlan":{"type":"integer","description":"Guest VLAN, clients that have not been authorized will be added to the guest VLAN.The value of guest VLAN should be selected from the created LAN Network.","format":"int32"},"switches":{"type":"array","description":"Enabled switch ports, optional when update switch 802.1x setting","items":{"$ref":"#/components/schemas/Dot1xSwitchSettingOpenApiVO"}}}},"Dot1xSwitchSettingOpenApiVO":{"required":["mac"],"type":"object","properties":{"mac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"MAC address of the switch"},"dot1xPorts":{"type":"array","description":"Switch 802.1x enabled ports","items":{"type":"integer","description":"Switch 802.1x enabled ports","format":"int32"}},"mabPorts":{"type":"array","description":"Switch MAB enabled ports","items":{"type":"integer","description":"Switch MAB enabled ports","format":"int32"}},"accountVrfId":{"type":"string","description":"Account VRF ID"},"authVrfId":{"type":"string","description":"Auth VRF ID"}},"description":"Enabled switch ports, optional when update switch 802.1x setting"},"Dot1xEapOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"EAP 802.1x function enable status"},"radiusProfileId":{"type":"string","description":"This field represents radius profile ID. Radius profile can be created using 'Create a new RADIUS profile' ('Create a new RADIUS profile template') interface, and radius profile ID can be obtained from 'Get RADIUS profile list' ('Get RADIUS profile template list') interface"},"macFormat":{"type":"integer","description":"Format of the MAC address. MacFormat should be a value as follows: 0: aabbccddeeff, 1: aa-bb-cc-dd-ee-ff, 2: aa:bb:cc:dd:ee:ff, 3: AABBCCDDEEFF, 4: AA-BB-CC-DD-EE-FF, 5: AA:BB:CC:DD:EE:FF","format":"int32"},"guestVlanSetting":{"$ref":"#/components/schemas/Dot1xGuestVlanSettingOpenApiVO"},"eaps":{"type":"array","description":"Enabled eap ports","items":{"$ref":"#/components/schemas/Dot1xEapSettingOpenApiVO"}}}},"Dot1xEapSettingOpenApiVO":{"required":["mac"],"type":"object","properties":{"mac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"MAC address of the EAP. Parameter [mac] should not be null when [eaps] is not null."},"dot1xPorts":{"type":"array","description":"EAP 802.1x enabled ports. Parameter [dot1xPorts] should be a list of port names","example":["ETH1","ETH2"],"items":{"type":"string","description":"EAP 802.1x enabled ports. Parameter [dot1xPorts] should be a list of port names","example":"[\"ETH1\",\"ETH2\"]"}}},"description":"Enabled eap ports"},"Dot1xGuestVlanSettingOpenApiVO":{"required":["mode"],"type":"object","properties":{"mode":{"type":"integer","description":"Guest VLAN application mode. Valid values: 0 = None (Disable Guest Vlan), 1 = By Network (select a LAN network), 2 = By VLAN ID (specify a VLAN ID directly).","format":"int32"},"lanNetworkId":{"type":"string","description":"LAN network ID used when [mode] = 1 (By Network). Specifies the target LAN network to which the Guest VLAN is mapped. The LAN network ID can be obtained from the 'Get LAN network list V3' interface."},"bridgeVlan":{"type":"integer","description":"Actual VLAN ID to apply when the selected LAN network is a Multi-VLAN network. Valid range: 1-4094.","format":"int32"},"vlanId":{"type":"integer","description":"Guest VLAN ID used when [mode] = 2 (By VLAN ID). Valid range: 1-4094.","format":"int32"}},"description":"Guest VLAN configuration used for EAP 802.1x authentication. Supports three modes: 0 = None, 1 = By Network, 2 = By VLAN ID. Parameter [guestVlanSetting] should not be null when [enable] is TRUE."},"DhcpSnoopStatusVO":{"type":"object","properties":{"dhcpSnoopEnable":{"type":"boolean","description":"Whether open the dhcp snoop switch."}}},"ModifyTagOpenApiVO":{"required":["name","tagId"],"type":"object","properties":{"tagId":{"type":"string","description":"Tag ID"},"name":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"Tag name should contain 1 to 128 ASCII characters."}}},"UpdateTabOpenApiVO":{"type":"object","properties":{"name":{"type":"string","description":"Name on this Dashboard page must be unique, it should contain 1 to 64 characters."},"reset":{"type":"boolean","description":"True: reset Default TAB (custom TAB cannot be reset)."}}},"BatchEditTabs":{"type":"object","properties":{"tabs":{"type":"array","description":"Edit Tab Parameters","items":{"$ref":"#/components/schemas/BatchUpdateTab"}}}},"BatchUpdateTab":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier"},"cards":{"type":"array","description":"Card list displayed in Tab. Each number indicates a type of card. card should be a value as follows:  0: Controller Snapshot, 101: Alerts, 102: ISP Load, 103: L2TP/PPTP VPN, 104: Channel Distribution and Usage, 105: Most Active EAPs, 106: Most Active Switches, 108: WiFi/Switching Summary, 109: Traffic Distribution, 110: Traffic Activities, 111: Clients Distribution, 112: Retry Rate/Dropped Rate, 117: Top Device CPU/Memory Usage, 118: IPSEC VPN, 119: OPEN VPN, 120: SSL VPN, 200: Most Active Clients, 201: Longest client uptime, 202: Clients Freq Distribution, 203: Clients Activities, 204: Clients Association Activities, 205: Association Failures, 206: Clients Association Time Distribution, 207: Clients SSID Distribution, 208: Clients RSSI Distribution","items":{"type":"integer","description":"Card list displayed in Tab. Each number indicates a type of card. card should be a value as follows:  0: Controller Snapshot, 101: Alerts, 102: ISP Load, 103: L2TP/PPTP VPN, 104: Channel Distribution and Usage, 105: Most Active EAPs, 106: Most Active Switches, 108: WiFi/Switching Summary, 109: Traffic Distribution, 110: Traffic Activities, 111: Clients Distribution, 112: Retry Rate/Dropped Rate, 117: Top Device CPU/Memory Usage, 118: IPSEC VPN, 119: OPEN VPN, 120: SSL VPN, 200: Most Active Clients, 201: Longest client uptime, 202: Clients Freq Distribution, 203: Clients Activities, 204: Clients Association Activities, 205: Association Failures, 206: Clients Association Time Distribution, 207: Clients SSID Distribution, 208: Clients RSSI Distribution","format":"int32"}}},"description":"Edit Tab Parameters"},"Client Name Setting":{"required":["name"],"type":"object","properties":{"name":{"pattern":"^$|^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"Client Name should contain 1 to 128 characters"}}},"ArpDetectStatusVO":{"type":"object","properties":{"arpDetectEnable":{"type":"boolean","description":"Whether open the arp detect switch."},"snoopForEntryEnable":{"type":"boolean","description":"Whether open the snoop for entry."}}},"ApUpdateWlanGroupOpenApiVO":{"required":["wlanGroupId"],"type":"object","properties":{"wlanGroupId":{"type":"string","description":"The wlan group Id that the AP should switch to, must be in the same site as the AP and cannot be the current wlan group."}}},"ApL3AccessVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the EAP L3 Accessibility setting."}},"description":"EAP L3 Accessibility setting."},"ApServicesConfigOpenApiVO":{"type":"object","properties":{"mvlanSetting":{"$ref":"#/components/schemas/ApMvlanSettingOpenApiVO"},"snmp":{"$ref":"#/components/schemas/ApSnmpVO"},"l3AccessSetting":{"$ref":"#/components/schemas/ApL3AccessVO"},"lldpEnable":{"type":"integer","description":"Parameter [lldpEnable] should be a value as follows: 0:off; 1:on; 2:Use Site Settings.","format":"int32"},"loopbackDetectEnable":{"type":"boolean","description":"Whether to enable loopback detection."},"voipVlanSetting":{"$ref":"#/components/schemas/ApVoipVlanSettingOpenApiVO"}}},"ApSnmpVO":{"type":"object","properties":{"location":{"pattern":"^[!-~][\\040-\\0176]{0,126}[!-~]$|^[!-~]$|$","type":"string","description":"Location, location should contain 0 to 128 ASCII characters, spaces are allowed, and leading and trailing spaces are not allowed."},"contact":{"pattern":"^[\\041-\\0176]{0,128}$","type":"string","description":"Contact, contact should contain 0 to 128 ASCII characters, spaces are not allowed."},"type":{"type":"integer","description":"SNMP parameter [type] should not be null and should be a value as follows: 0: Use Site Settings; 1: Custom.","format":"int32"}},"description":"Snmp Setting."},"ApRadioSetting":{"type":"object","properties":{"radioEnable":{"type":"boolean","description":"Enable/Disable radio setting(if false, other params is not required)"},"channelRange":{"type":"array","description":"Custom optional channel freq collection.","items":{"type":"integer","description":"Custom optional channel freq collection.","format":"int32"}},"channelWidth":{"type":"string","description":"RADIO_20 = 2; RADIO_40 = 3; RADIO_40_20 = 4(corresponding 2G Auto); RADIO_80 = 5; RADIO_80_40_20 = 6(corresponding 5G Auto); RADIO_160= 7; RADIO_160_80_40_20 = 8; RADIO_240 = 9; RADIO_320 = 10"},"channel":{"type":"string","description":"Channel Index; The channel index list supported by device can be obtained from interface : Get available channel list of ap; If select auto configuration need to enter 0."},"txPower":{"type":"integer","description":"TX Power","format":"int32"},"txPowerLevel":{"type":"integer","description":"It should be a value as follows: 0: Low; 1: Medium; 2: High; 3: Custom; 4: Auto","format":"int32"},"channelLimitEnable":{"type":"boolean","description":"Enable channel limit(site level)"},"freq":{"type":"integer","description":"Frequency;The frequency list supported by device can be obtained from interface : Get available channel list of ap.The freq and channel fields should be corresponding, otherwise the channel will be corrected based on the freq field.","format":"int32"},"wirelessMode":{"type":"integer","description":"Wireless mode config status of the device; -2 : Auto; 3 : 802.11b/g mixed(Only for 2.4G); 4 : 802.11b/g/n mixed(Only for 2.4G); 13 : 802.11b/g/n/ax mixed(Only for 2.4G); 17 : 802.11b/g/n/ax/be mixed(Only for 2.4G); 7 : 802.11a/n mixed(Only for 5G); 10 : 802.11a/n/ac mixed(Only for 5G); 16 : 802.11a/n/ac/ax mixed(Only for 5G); 18 : 802.11a/n/ac/ax/be mixed(Only for 5G); 11 : 802.11ax only(Only for 6G); 19 : 802.11ax/be mixed(Only for 6G).","format":"int32"},"autoSwitchOffWifi":{"type":"boolean","description":"Enable auto Switch Off Wifi"},"autoSwitchOffWifiInterval":{"type":"integer","description":"Auto Switch Off Wifi Interval","format":"int32"},"rrmType":{"type":"integer","format":"int32"},"interTimeStamp":{"type":"integer","format":"int64"}},"description":"Radio Setting"},"ApRadiosConfig":{"type":"object","properties":{"radioSetting2g":{"$ref":"#/components/schemas/ApRadioSetting"},"radioSetting5g":{"$ref":"#/components/schemas/ApRadioSetting"},"radioSetting5g1":{"$ref":"#/components/schemas/ApRadioSetting"},"radioSetting5g2":{"$ref":"#/components/schemas/ApRadioSetting"},"radioSetting6g":{"$ref":"#/components/schemas/ApRadioSetting"}}},"ModifyApAdvancedQosOpenApiVO":{"type":"object","properties":{"deliveryEnable2g":{"type":"boolean","description":"Whether Unscheduled Automatic Power Save Delivery enabled in 2.4GHz."},"deliveryEnable5g":{"type":"boolean","description":"Whether Unscheduled Automatic Power Save Delivery enabled in the entire band of 5GHz. If the device supports 5GHz but does not support frequency division, you need to enter this field."},"deliveryEnable5g1":{"type":"boolean","description":"Whether Unscheduled Automatic Power Save Delivery enabled in 5GHz-1. 5GHZ-1 is the first part of the 5GHz band. This field is required if the device supports 5GHz and frequency splitting."},"deliveryEnable5g2":{"type":"boolean","description":"Whether Unscheduled Automatic Power Save Delivery enabled in 5GHz-2. 5GHZ-2 is the second part of the 5GHz band. This field is required if the device supports 5GHz and frequency splitting."},"deliveryEnable6g":{"type":"boolean","description":"Whether Unscheduled Automatic Power Save Delivery enabled in 6GHz."}}},"Modify AP LAN Port":{"type":"object","properties":{"lanPort":{"type":"string","description":"lanPort"},"name":{"type":"string","description":"port name"},"status":{"type":"boolean","description":"port status, true: enable; false: disable"},"localVlanEnable":{"type":"boolean","description":"vlan status, true: enable; false: disable"},"localVlanId":{"type":"integer","description":"port vlan id","format":"int32"},"localVlanNetworkId":{"type":"string","description":"local vlan network Id"},"poeOutEnable":{"type":"boolean","description":"poe out status, true: enable; false: disable"},"custom":{"type":"boolean","description":"custom"},"tagged":{"type":"string","description":"tagged"},"untagged":{"type":"string","description":"untagged"},"taggedNetworkId":{"type":"array","description":"vlan tagged NetworkId","items":{"type":"string","description":"vlan tagged NetworkId"}},"untaggedNetworkId":{"type":"array","description":"vlan untagged NetworkId","items":{"type":"string","description":"vlan untagged NetworkId"}},"bandwidthControlEnable":{"type":"boolean","description":"bandwidth Control status"},"ingressRateLimit":{"$ref":"#/components/schemas/ONUPortRateLimitVO"},"egressRateLimit":{"$ref":"#/components/schemas/ONUPortRateLimitVO"}}},"UpdateApOfdmaConfigOpenApiVO":{"type":"object","properties":{"ofdmaEnable2g":{"type":"boolean","description":"Advanced feature OFDMA 2G config status. True: enable, false: disable."},"ofdmaEnable5g":{"type":"boolean","description":"Advanced feature OFDMA 5G1 config status. True: enable, false: disable."},"ofdmaEnable5g2":{"type":"boolean","description":"Advanced feature OFDMA 5G2 config status. True: enable, false: disable."},"ofdmaEnable6g":{"type":"boolean","description":"Advanced feature OFDMA 6G config status. True: enable, false: disable."}}},"UpdateApAdvancedLoadBalanceOpenApiVO":{"type":"object","properties":{"maxClientsEnable2g":{"type":"boolean","description":"Whether the device enable maximum associated clients 2g."},"maxClients2g":{"type":"integer","description":"The maximum number of clients connected to the 2G band. MaxClients2g should be within the range of 1–512.","format":"int32"},"rssiEnable2g":{"type":"boolean","description":"Whether the device enable rssi 2g."},"threshold2g":{"type":"integer","description":"The RSSI threshold for the 2G band. threshold2g should be within the range of -95–0.","format":"int32"},"maxClientsEnable5g":{"type":"boolean","description":"Whether the device enable maximum associated clients 5g."},"maxClients5g":{"type":"integer","description":"The maximum number of clients connected to the 5G band. MaxClients5g should be within the range of 1–512.","format":"int32"},"rssiEnable5g":{"type":"boolean","description":"Whether the device enable rssi 5g."},"threshold5g":{"type":"integer","description":"The RSSI threshold for the 5G band. threshold5g should be within the range of -95–0.","format":"int32"},"maxClientsEnable5g1":{"type":"boolean","description":"Whether the device enable load balance 5g1."},"maxClients5g1":{"type":"integer","description":"The maximum number of clients connected to the 5G1 band. MaxClients5g1 should be within the range of 1–512.","format":"int32"},"rssiEnable5g1":{"type":"boolean","description":"Whether the device enable rssi 5g1."},"threshold5g1":{"type":"integer","description":"The RSSI threshold for the 5G1 band. threshold5g1 should be within the range of -95–0.","format":"int32"},"maxClientsEnable5g2":{"type":"boolean","description":"Whether the device enable maximum associated clients 5g2."},"maxClients5g2":{"type":"integer","description":"The maximum number of clients connected to the 5G2 band. MaxClients5g2 should be within the range of 1–512.","format":"int32"},"rssiEnable5g2":{"type":"boolean","description":"Whether the device enable rssi 5g2."},"threshold5g2":{"type":"integer","description":"The RSSI threshold for the 5G2 band. threshold5g2 should be within the range of -95–0.","format":"int32"},"maxClientsEnable6g":{"type":"boolean","description":"Whether the device enable maximum associated clients 6g."},"maxClients6g":{"type":"integer","description":"The maximum number of clients connected to the 6G band. MaxClients6g should be within the range of 1–512.","format":"int32"},"rssiEnable6g":{"type":"boolean","description":"Whether the device enable rssi 6g."},"threshold6g":{"type":"integer","description":"The RSSI threshold for the 6G band. threshold6g should be within the range of -95–0.","format":"int32"}}},"ApIPv6Setting":{"required":["ipv6Enable"],"type":"object","properties":{"ipv6Enable":{"type":"boolean","description":"ipv6 enable"},"mode":{"pattern":"dynamic|static","type":"string","description":"Mode should be a value as follows: static; dynamic"},"dynamicIpv6Setting":{"$ref":"#/components/schemas/dynamic ipv6 setting entity"},"staticIpv6Setting":{"$ref":"#/components/schemas/static ipv6 setting entity"}}},"dynamic ipv6 setting entity":{"required":["dnsMode"],"type":"object","properties":{"dnsMode":{"type":"integer","description":"only for \"dynamic\" mode (0: Get Dynamic DNS; 1: Use the Following DNS Addresses)","format":"int32"},"priDns":{"pattern":"(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\S*$)","type":"string","description":"primary DNS address, pattern: ipv6 address. This value is required when dnsMode is 1."},"sndDns":{"pattern":"(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\S*$)","type":"string","description":"secondary DNS address, pattern: ipv6 address. This value is optional when dnsMode is 1."}},"description":"Dynamic Ipv6 Setting(SLAAC/DHCPv6)"},"static ipv6 setting entity":{"required":["ipv6Addr","prefixLen"],"type":"object","properties":{"ipv6Addr":{"pattern":"(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\S*$)","type":"string","description":"ipv6 address, only required for static mode"},"prefixLen":{"type":"integer","description":"prefixLen of the ipv6 address, only required for static mode","format":"int32"},"defaultGate":{"pattern":"(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\S*$)","type":"string","description":"default gateway, only for static mode"},"priDns":{"pattern":"(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\S*$)","type":"string","description":"primary DNS address, pattern: ipv6 address."},"sndDns":{"pattern":"(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\S*$)","type":"string","description":"secondary DNS address, pattern: ipv6 address."}},"description":"Static Ipv6 Setting"},"ApIPSetting":{"required":["mode"],"type":"object","properties":{"mode":{"pattern":"static|dhcp","type":"string","description":"Mode should be a value as follows: Static; DHCP"},"dhcpIpSetting":{"$ref":"#/components/schemas/dhcp ip setting entity"},"staticIpSetting":{"$ref":"#/components/schemas/static ip setting entity"}}},"dhcp ip setting entity":{"type":"object","properties":{"fallback":{"type":"boolean","description":"Enable/Disable fallback(if false, other params is not required)"},"fallbackIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Fallback IP address"},"fallbackMask":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Fallback IP mask"},"fallbackGate":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Fallback gateway IP address"},"useFixedAddr":{"type":"boolean","description":"Enable reserved address(Gateway required)"},"netId":{"type":"string","description":"Network ID"},"dhcpIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Reserved IP address"},"serverType":{"type":"string","description":"DHCP Server Type"},"serverMac":{"type":"string","description":"DHCP Server Mac"},"serverStackId":{"type":"string","description":"DHCP Server Stack ID"}},"description":"DHCP IP setting"},"static ip setting entity":{"type":"object","properties":{"configIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Static IP address"},"configMask":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Subnet mask"},"configGate":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Gateway IP address"},"preferredDNS":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Primary DNS server"},"alternateDNS":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Secondary DNS server"}},"description":"Static IP setting"},"ApGeneralConfig":{"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"Device name should contain 1 to 128 characters."},"ledSetting":{"type":"integer","description":"Led setting should be a value as follows: 0:off; 1:on; 2:Use Site Settings.","format":"int32"},"remoteReset":{"type":"boolean","description":"Whether the remote reset function is enabled."},"wifiControlEnable":{"type":"boolean","description":"Whether the wifi Control function is enabled."},"rssiLedSettings":{"type":"array","description":"Rssi Led Setting.","items":{"$ref":"#/components/schemas/ApRssiLedSettingVO"}},"tagIds":{"type":"array","description":"Tag IDs.","items":{"type":"string","description":"Tag IDs."}},"gpsEnable":{"type":"boolean","description":"gps Enable only for ap which support gps function."},"location":{"$ref":"#/components/schemas/DeviceLocationDetailVO"},"rememberDevice":{"type":"integer","description":"Parameter [rememberDevice] should be a value as follows: 0:off; 1:on; 2:Use Site Settings.","format":"int32"},"disableHwReset":{"type":"boolean","description":"When this value is [true], the device's hardware reset is invalid.(Only some specific devices support this feature)"}}},"ApRssiLedSettingVO":{"type":"object","properties":{"ledId":{"type":"string","description":"Led Name."},"threshold":{"type":"integer","description":"Rssi threshold.","format":"int32"}},"description":"Rssi Led Setting."},"ApBridgeConfig":{"type":"object","properties":{"bridgeSsidName":{"type":"string","description":"Bridge SSID name. It should contain 1 to 32 UTF-8 characters."},"bridgeSsidPassword":{"type":"string","description":"Bridge SSID password. It should contain 8-63 printable ASCII characters."},"hwSwitch":{"type":"integer","description":"Bridge DIP Switch config status. 0: disable, 1: enable.","format":"int32"},"tdmaConfig":{"$ref":"#/components/schemas/ApBridgeTdmaConfigVO"}}},"ApBridgeTdmaConfigVO":{"required":["status"],"type":"object","properties":{"status":{"type":"integer","description":"Bridge TDMA config status. 0: disable, 1: enable.","format":"int32"},"clients":{"type":"array","description":"Bridge TDMA Client config.","items":{"$ref":"#/components/schemas/BridgeClientApConfigVO"}}},"description":"Bridge TDMA config."},"BridgeClientApConfigVO":{"required":["mac"],"type":"object","properties":{"mac":{"type":"string","description":"Bridge TDMA Client AP mac."},"priority":{"type":"integer","description":"Bridge TDMA Client AP priority config. 0: high, 1:base, 2:low.","format":"int32"}},"description":"Bridge TDMA Client config."},"UpdateApAnteGainConfig":{"type":"object","properties":{"anteGainList":{"type":"array","description":"Antenna gain list.","items":{"$ref":"#/components/schemas/UpdateApRadioAnteGainConfigOpenApiVO"}}}},"UpdateApRadioAnteGainConfigOpenApiVO":{"required":["anteGain","radioId"],"type":"object","properties":{"radioId":{"type":"integer","description":"The value of parameter [radioId] should be between 0 and 3. 0: 2.4 GHz, 1: 5 GHz, 2: 5 GHz-2, 3: 6 GHz.","format":"int32"},"anteGain":{"type":"integer","description":"Antenna Gain. The value of [anteGain] should be between 0 and 30. ","format":"int32"}},"description":"Antenna gain list."},"ModifyHistoryRetentionOpenApiVO":{"required":["clientsDataEnable"],"type":"object","properties":{"override":{"type":"boolean","description":"Whether the customer overrides the retention configuration of MSP. This configuration applies to the customer in MSP mode only. If true, customer retention configuration will be used (excluding daily, clientHistory, log and widsData)."},"clientsDataEnable":{"type":"boolean","description":"Whether the clients' history data is recorded."},"clientDataTrendEnable":{"type":"boolean","description":"Whether the client data trend records is recorded."},"clientRecognitionEnable":{"type":"boolean","description":"Whether client recognition is enabled. With the feature enabled, network devices will report client information in real time to ensure the accuracy of client recognition. Cloud Access is required for client recognition."},"clientHealthEnable":{"type":"boolean","description":"Whether client health is enabled. When enabled, client health data will be recorded, which may consume a significant amount of storage space."},"knownClient":{"type":"integer","description":"Retention configuration of known client Data, knownClient should be a value as follows: -1: Disabled; 0: All Time(Windows, Linux Only); 1: 1day; 7: 7days; 31: 31days; 90: 90days; 180: 180days; 365: 365days.","format":"int32"},"clientHistory":{"type":"integer","description":"Retention configuration of client History(only effective in local controller), clientHistory should be a value as follows: -1: Disabled; 0: All Time(Windows, Linux Only); 7: 7days; 31: 31days; 90: 90days; 180: 180days; 365: 365days.","format":"int32"},"daily":{"type":"integer","description":"Retention configuration of time series with daily granularity, daily should be a value as follows: 90: 90days; 180: 180days; 365: 365days(Fixed value in Cloud Based Controller as 365 days).","format":"int32"},"weekly":{"type":"integer","description":"Retention configuration of time series with weekly granularity, weekly should be a value as follows: 31: 31days; 90: 90days; 180: 180days; 365: 365days.","format":"int32"},"portalAuth":{"type":"integer","description":"Retention configuration of portal authentication records, portalAuth should be a value as follows: 0: All Time(Windows, Linux Only); 7: 7days; 31: 31days; 90: 90days; 180: 180days; 365: 365days.","format":"int32"},"log":{"type":"integer","description":"Retention Configuration of log data(only effective in local controller), log should be a value as follows: 0: All Time(Windows, Linux Only); 31: 31days; 90: 90days; 180: 180days; 365: 365days.","format":"int32"},"rogueAp":{"type":"integer","description":"Retention Configuration of rogue ap data, rogueAp should be a value as follows: 0: All Time(Windows, Linux Only); 31: 31days; 90: 90days; 180: 180days; 365: 365days.","format":"int32"},"widsData":{"type":"integer","description":"Retention Configuration of wids data(only effective in local pro controller), widsData should be a value as follows: 0: All Time(Windows, Linux Only); 90: 90days; 180: 180days; 365: 365days.","format":"int32"},"clientDataTrendDaily":{"type":"integer","description":"Retention Configuration of client data trend records(only effective in local controller), clientDataTrendDaily should be a value as follows: 1: 1day; 7: 7days; 31: 31days; 60: 60days, 90: 90days.","format":"int32"}}},"PlanUpgradeEditInfo":{"required":["scheduleType","sites"],"type":"object","properties":{"sites":{"type":"array","description":"List of site IDs selected by the user","items":{"type":"string","description":"List of site IDs selected by the user"}},"year":{"type":"integer","description":"User selected year","format":"int32"},"monthOfYear":{"type":"integer","description":"The month of the year selected by the user, It should be within the range of 1-12","format":"int32"},"dayOfMonth":{"type":"integer","description":"The day of the month selected by the user, It should be within the range of 1-31","format":"int32"},"hour":{"type":"integer","description":"The hour selected by the user, It should be within the range of 0-23","format":"int32"},"minute":{"type":"integer","description":"The minute selected by the user, It should be within the range of 0-59","format":"int32"},"scheduleType":{"type":"integer","description":"The type of execution time for the upgrade, where 0 represents now and 1 represents the specified time","format":"int32"}}},"OpenApi Client Ip Setting":{"required":["useFixedAddr"],"type":"object","properties":{"useFixedAddr":{"type":"boolean","description":"Whether to use the specified IP"},"netId":{"type":"string","description":"Lan network ID"},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Client IP"},"serverType":{"type":"string","description":"DHCP Server Type"},"serverMac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"DHCP Server Mac"},"serverStackId":{"type":"string","description":"DHCP Server Stack ID"}}},"Remote Log":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the feature"},"host":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"The IP address of the remote log server"},"port":{"type":"integer","description":"Port of the remote log server, port should be within the range of 1-65535","format":"int32"}}},"Built In RADIUS Server Config RequestBody":{"required":["authServerPort","enable","secret","serverAddressType","tunnelReplyEnable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the Built-In RADIUS server is enabled."},"authServerPort":{"type":"integer","description":"Server port.","format":"int32"},"secret":{"pattern":"^[\\041-\\0176]{1,64}$","type":"string","description":"Server secrect."},"tunnelReplyEnable":{"type":"boolean","description":"Whether the Tunneled Reply is enabled."},"serverAddressType":{"type":"integer","description":"Built In RADIUS server address type, 0: Auto generated, 1: Custom","format":"int32"},"customAddress":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Customize server address, required when parameter [serverAddressType] is 1."},"radiusServerCertificate":{"$ref":"#/components/schemas/RADIUS Server Certificate Setting"},"requireMessageAuthenticator":{"type":"boolean","description":"Message-Authenticator parameter verification enable status"},"limitProxyState":{"type":"boolean","description":"Proxy-State parameter limit status"}}},"RADIUS Server Certificate Setting":{"type":"object","properties":{"cerId":{"type":"string","description":"Certificate ID"},"cerName":{"type":"string","description":"Certificate name"},"keyId":{"type":"string","description":"Secrect key ID"},"keyName":{"type":"string","description":"Secrect key name"},"keyPassword":{"type":"string","description":"Keystore password"},"cerType":{"type":"string","description":"Certificate type: JKS/PFX/PEM"}},"description":"RADIUS server certificate"},"Radius Proxy Server Setting RequestBody":{"required":["enable","port"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the RADIUS proxy server is enabled."},"port":{"type":"integer","description":"Server port.","format":"int32"},"requireMessageAuthenticator":{"type":"boolean","description":"Message-Authenticator parameter verification enable status"},"limitProxyState":{"type":"boolean","description":"Proxy-State parameter limit status"}}},"DST Time":{"required":["day","hour","minute","month","serial"],"type":"object","properties":{"month":{"type":"integer","description":"Month of the DST config should be a value as follows: 1: January; 2: February; 3: March; 4: April; 5: May; 6: June; 7: July; 8: August; 9: September; 10: October; 11: November; 12: December.","format":"int32"},"serial":{"type":"integer","description":"Week of the DST config should be a value as follows: 1: 1st; 2: 2nd; 3: 3rd; 4: 4th; 5: Last.","format":"int32"},"day":{"type":"integer","description":"Day of the DST config should be a value as follows: 1: Monday; 2: Tuesday; 3: Wednesday; 4: Thursday; 5: Friday; 6: Saturday; 7: Sunday.","format":"int32"},"hour":{"type":"integer","description":"Hour of the DST config should be within the range of 0–23.","format":"int32"},"minute":{"type":"integer","description":"Minute of the DST config should be within the range of 0–59.","format":"int32"}},"description":"DST end time config"},"DstOpenApiVO":{"type":"object","properties":{"mode":{"type":"integer","description":"DST mode should be a value as follows: 0: disable; 1: auto; 2: manual.","format":"int32"},"start":{"$ref":"#/components/schemas/DST Time"},"end":{"$ref":"#/components/schemas/DST Time"},"enable":{"type":"boolean","description":"DST config status; If false, other parameters are not required."},"status":{"type":"boolean","description":"DST available status"},"startTime":{"type":"integer","description":"The timeStamp of the DST available start time","format":"int64"},"endTime":{"type":"integer","description":"The timeStamp of the DST available end time","format":"int64"},"offset":{"type":"integer","description":"DST offset config(Unit: ms); It should be a value as follows: [1800000, 3600000, 5400000, 7200000].","format":"int64"},"nextStart":{"type":"integer","description":"The timeStamp of the DST start time of the next year(Unit: ms)","format":"int64"},"nextEnd":{"type":"integer","description":"The timeStamp of the DST end time of the next year(Unit: ms)","format":"int64"},"timeZone":{"type":"string","description":"Timezone of the site"},"lastStart":{"type":"integer","description":"The timeStamp of the DST start time of the last year(Unit: ms)","format":"int64"},"lastEnd":{"type":"integer","description":"The timeStamp of the DST end time of the last year(Unit: ms)","format":"int64"}},"description":"Daylight Saving Time"},"General Setting":{"required":["name","region","timeZone"],"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,30}[^ ]$","type":"string","description":"General setting name should be visible ASCII, between 1 and 32 characters."},"timeZone":{"type":"string","description":"For the values of timeZone, refer to section 5.1 of the Open API Access Guide."},"region":{"type":"string","description":"Country/Region of the controller"},"dst":{"$ref":"#/components/schemas/DstOpenApiVO"}}},"Experience Improvement Program":{"required":["expImprove"],"type":"object","properties":{"expImprove":{"type":"boolean","description":"Join User Experience Improvement Program"}}},"DeviceAccessManagementSetting":{"required":["appDiscovery","webControlHttp","webControlHttps"],"type":"object","properties":{"webControlHttp":{"type":"boolean","description":"Control device web http accessing."},"webControlHttps":{"type":"boolean","description":"Control device web https accessing."},"appDiscovery":{"type":"boolean","description":"Control device app discovery, bind with device web https access, if appDiscvoery is enabled, webControlHttps must be enabled."}},"description":"Device Access Management Setting."},"UI Interface":{"required":["refreshRate"],"type":"object","properties":{"timeZone":{"type":"integer","description":"Time zone should be a value as follows: 0: Site's; 1: Browser's; 2: Controller's; 3: UTC","format":"int32"},"refreshRate":{"type":"integer","description":"Refresh rate should be a value as follows: 0: 15 seconds;1: 1 minute; 2: 2 minutes; 3: 5 minutes; 4: never refresh.","format":"int32"},"privateLabelingEnable":{"type":"boolean","description":"Enable customer labeling of controller, this configuration applies to Omada Pro Controller only"},"privateLabelingUrl":{"type":"string","description":"The redirection url of labeling image, this configuration applies to Omada Pro Controller only"},"privateLabelingFileId":{"type":"string","description":"The file id of labeling image, this configuration applies to Omada Pro Controller only"},"privateLabelingFileName":{"type":"string","description":"The file name of labeling image, this configuration applies to Omada Pro Controller only"},"macFormat":{"type":"integer","format":"int32"}}},"History Retention":{"required":["clientsDataEnable"],"type":"object","properties":{"override":{"type":"boolean","description":"Whether the customer overrides the retention configuration of MSP."},"clientsDataEnable":{"type":"boolean","description":"Whether the clients' history data is recorded."},"clientDataTrendEnable":{"type":"boolean","description":"Whether the client data trend records is recorded."},"clientRecognitionEnable":{"type":"boolean","description":"Whether client recognition is enabled. With the feature enabled, network devices will report client information in real time to ensure the accuracy of client recognition. Cloud Access is required for client recognition. This feature is not supported in the MSP view."},"clientHealthEnable":{"type":"boolean","description":"Whether client health is enabled. When enabled, client health data will be recorded, which may consume a significant amount of storage space."},"knownClientAvailableRetentionDays":{"type":"array","description":"Provide optional knownClient data Retention Configuration list.","items":{"type":"integer","description":"Provide optional knownClient data Retention Configuration list.","format":"int32"}},"knownClient":{"type":"integer","description":"Retention configuration of known client Data, knownClient should be a value as follows: -1: Disabled; 0: All Time(Windows, Linux Only); 1: 1day; 7: 7days; 31: 31days; 90: 90days; 180: 180days; 365: 365days.","format":"int32"},"clientHistory":{"type":"integer","description":"Retention configuration of client History(only effective in local controller), clientHistory should be a value as follows: -1: Disabled; 0: All Time(Windows, Linux Only); 7: 7days; 31: 31days; 90: 90days; 180: 180days; 365: 365days.","format":"int32"},"clientHistoryAvailableRetentionDays":{"type":"array","description":"Provide optional clientHistory data Retention Configuration list.","items":{"type":"integer","description":"Provide optional clientHistory data Retention Configuration list.","format":"int32"}},"fiveMin":{"type":"integer","description":"Retention configuration of Time Series with 5 Minutes Granularity. It is fixed to 2days and cannot be changed.","format":"int32"},"tenMin":{"type":"integer","description":"Retention configuration of Time Series with 10 Minutes Granularity, only for Lite Cloud-Based Controller. It is fixed to 2days and cannot be changed.","format":"int32"},"hourly":{"type":"integer","description":"Retention configuration of time series with hourly granularity, hourly should be a value as follows: 7: 7days.","format":"int32"},"dailyAvailableRetentionDays":{"type":"array","description":"Provide optional daily data Retention Configuration list.","items":{"type":"integer","description":"Provide optional daily data Retention Configuration list.","format":"int32"}},"daily":{"type":"integer","description":"Retention configuration of time series with daily granularity, daily should be a value as follows: 90: 90days; 180: 180days; 365: 365days(Fixed value in Cloud Based Controller as 365 days).","format":"int32"},"weeklyAvailableRetentionDays":{"type":"array","description":"Provide optional weekly data Retention Configuration list.","items":{"type":"integer","description":"Provide optional weekly data Retention Configuration list.","format":"int32"}},"weekly":{"type":"integer","description":"Retention configuration of time series with weekly granularity, weekly should be a value as follows: 31: 31days; 90: 90days; 180: 180days; 365: 365days.","format":"int32"},"portalAuthAvailableRetentionDays":{"type":"array","description":"Provide optional portalAuth data Retention Configuration list.","items":{"type":"integer","description":"Provide optional portalAuth data Retention Configuration list.","format":"int32"}},"portalAuth":{"type":"integer","description":"Retention configuration of portal authentication records, portalAuth should be a value as follows: 0: All Time(Windows, Linux Only); 7: 7days; 31: 31days; 90: 90days; 180: 180days; 365: 365days.","format":"int32"},"logAvailableRetentionDays":{"type":"array","description":"Provide optional log data Retention Configuration list.","items":{"type":"integer","description":"Provide optional log data Retention Configuration list.","format":"int32"}},"log":{"type":"integer","description":"Retention Configuration of log data(only effective in local controller), log should be a value as follows: 0: All Time(Windows, Linux Only); 31: 31days; 90: 90days; 180: 180days; 365: 365days.","format":"int32"},"rogueAp":{"type":"integer","description":"Retention Configuration of rogue ap data, rogueAp should be a value as follows: 0: All Time(Windows, Linux Only); 31: 31days; 90: 90days; 180: 180days; 365: 365days.","format":"int32"},"widsData":{"type":"integer","description":"Retention Configuration of wids data(only effective in local pro controller), widsData should be a value as follows: 0: All Time(Windows, Linux Only); 90: 90days; 180: 180days; 365: 365days.","format":"int32"},"clientDataTrendDaily":{"type":"integer","description":"Retention Configuration of client data trend records(only effective in local controller), clientStatDaily should be a value as follows: 1: 1day; 7: 7days; 31: 31days; 60: 60days, 90: 90days.","format":"int32"},"clientTrendAvailableRetentionDays":{"type":"array","description":"Provide optional clientDataTrendDaily data Retention Configuration list.","items":{"type":"integer","description":"Provide optional clientDataTrendDaily data Retention Configuration list.","format":"int32"}}}},"Controller General Setting":{"type":"object","properties":{"general":{"$ref":"#/components/schemas/ControllerGeneralSettingOpenApiVO"},"deviceManage":{"$ref":"#/components/schemas/DeviceManageOpenApiVO"}}},"ControllerGeneralSettingOpenApiVO":{"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,30}[^ ]$","type":"string"},"timeZone":{"type":"string"},"region":{"type":"string"},"dst":{"$ref":"#/components/schemas/DstDTO"},"scenario":{"type":"string"},"ntpServerI":{"pattern":"(?=^.{3,64}$)[a-zA-Z0-9][-a-zA-Z0-9]{0,62}(\\.[a-zA-Z0-9][-a-zA-Z0-9]{0,62})+","type":"string","deprecated":true},"ntpServerII":{"pattern":"(?=^.{3,64}$)[a-zA-Z0-9][-a-zA-Z0-9]{0,62}(\\.[a-zA-Z0-9][-a-zA-Z0-9]{0,62})+","type":"string","deprecated":true},"ntpEnable":{"type":"boolean","deprecated":true},"ntpServers":{"maxItems":5,"minItems":0,"type":"array","items":{"$ref":"#/components/schemas/NtpServerVO"}},"timeSettingType":{"type":"integer","format":"int32"},"manualTime":{"pattern":"^((([0-9]{3}[1-9]|[0-9]{2}[1-9][0-9]{1}|[0-9]{1}[1-9][0-9]{2}|[1-9][0-9]{3})-(((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01]))|((0[469]|11)-(0[1-9]|[12][0-9]|30))|(02-(0[1-9]|[1][0-9]|2[0-8]))))|((([0-9]{2})(0[48]|[2468][048]|[13579][26])|((0[48]|[2468][048]|[3579][26])00))-02-29))\\s+([0-1]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$","type":"string"},"modifyTime":{"type":"boolean"},"resetEnable":{"type":"boolean"},"network":{"type":"boolean"},"fallbackIP":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string"},"fallbackNetmask":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string"},"ipaddr":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string"},"netmask":{"pattern":"(254|252|248|240|224|192|128|0).0.0.0|255.(254|252|248|240|224|192|128|0).0.0|255.255.(254|252|248|240|224|192|128|0).0|255.255.255.(254|252|248|240|224|192|128|0)","type":"string"},"gateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string"},"primary":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string"},"secondary":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string"},"supportSfp":{"type":"boolean"},"sfpSpeed1":{"type":"integer","format":"int32"},"sfpSpeed2":{"type":"integer","format":"int32"},"timeZoneId":{"type":"string"}}},"DeviceManageOpenApiVO":{"required":["deviceHostEnable"],"type":"object","properties":{"deviceHostEnable":{"type":"boolean"},"deviceHost":{"type":"string"}}},"DstDTO":{"type":"object","properties":{"enable":{"type":"boolean","description":"DST config status; If false, other parameters are not required."},"mode":{"type":"integer","description":"DST config mode; If disable, other parameters are not required. 0: disable, 1: auto, 2: manually","format":"int32"},"start":{"$ref":"#/components/schemas/DstTimeDTO"},"end":{"$ref":"#/components/schemas/DstTimeDTO"},"status":{"type":"boolean","description":"DST available status"},"startTime":{"type":"integer","description":"The timeStamp of the DST available start time","format":"int64"},"endTime":{"type":"integer","description":"The timeStamp of the DST available end time","format":"int64"},"offset":{"type":"integer","description":"DST offset config(Unit: ms); It should be a value as follows: [1800000, 3600000, 5400000, 7200000].","format":"int64"},"nextStart":{"type":"integer","description":"The timeStamp of the DST start time of the next year(Unit: ms)","format":"int64"},"nextEnd":{"type":"integer","description":"The timeStamp of the DST end time of the next year(Unit: ms)","format":"int64"},"timeZone":{"type":"string","description":"Timezone of the site"},"lastStart":{"type":"integer","description":"The timeStamp of the DST start time of the last year(Unit: ms)","format":"int64"},"lastEnd":{"type":"integer","description":"The timeStamp of the DST end time of the last year(Unit: ms)","format":"int64"}}},"NtpServerVO":{"type":"object","properties":{"address":{"pattern":"(?=^.{3,64}$)[a-zA-Z0-9][-a-zA-Z0-9]{0,62}(\\.[a-zA-Z0-9][-a-zA-Z0-9]{0,62})+","type":"string"}}},"ClientRecognitionEnableOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether enable client recognition"}}},"Client Active Timeout":{"required":["clientActiveTimeoutMin"],"type":"object","properties":{"clientActiveTimeoutMin":{"type":"integer","description":"Client Active Timeout should be within the range of 3-10 minutes","format":"int32"}}},"ClientDetailInformationSettingVO":{"type":"object","properties":{"clientRecognitionEnable":{"type":"boolean","description":"Whether client recognition is enabled. With the feature enabled, network devices will report client information in real time to ensure the accuracy of client recognition. Cloud Access is required for client recognition."},"clientHealthEnable":{"type":"boolean","description":"Whether client health is enabled. When enabled, client health data will be recorded, which may consume a significant amount of storage space."},"clientHistoryEnable":{"type":"boolean","description":"Whether client history is enabled. When enabled, client history, client logs will be recorded. This will occupy much storage space."},"clientDataTrendEnable":{"type":"boolean","description":"Whether client data trend record is enabled.When enabled, client trend statistics and charts will be retained, which will take up lots of storage space."},"followMsp":{"type":"boolean","description":"Whether customer follow MSP setting, only effective in MSP mode and only effective for [clientHistoryEnable] and [clientDataTrendEnable]."}}},"MspUiInterfaceOpenApiVO":{"required":["fixedMenu","refreshBtnEnable","refreshRate","use24hour","websocketEnable"],"type":"object","properties":{"language":{"type":"integer","description":"It should be a value as follows: 1: English; 4: German; 7: French; 8: Spanish; 10: Italian; 12: Portuguese; 13: Russian; 15: Turkish; 17: Japanese; 18: Traditional Chinese; 21: Korean","format":"int32"},"use24hour":{"type":"boolean"},"fixedMenu":{"type":"boolean"},"theme":{"type":"integer","description":"It should be a value as follows: 0: default; 1: dark","format":"int32"},"showPDevices":{"type":"boolean","description":"Show pending devices"},"refreshBtnEnable":{"type":"boolean","description":"Enable refresh button"},"refreshRate":{"type":"integer","description":"It should be a value as follows: 0: 15 seconds; 1: 1 minute; 2: 2 minutes; 3: 5 minutes; 4: never refresh","format":"int32"},"websocketEnable":{"type":"boolean","description":"Enable websocket connection"},"controllerNotification":{"type":"boolean","description":"Enable controller upgrade notification"},"privateLabelingEnable":{"type":"boolean","description":"Enable private label"},"privateLabelingUrl":{"type":"string","description":"The url of private label"},"privateLabelingFileId":{"type":"string","description":"The file id of private label picture"},"privateLabelingFileName":{"type":"string","description":"The file name of private label picture"}}},"MspUserInterfaceOpenApiVO":{"required":["refreshRate"],"type":"object","properties":{"refreshRate":{"type":"integer","description":"It should be a value as follows: 0: 15 seconds; 1: 1 minute; 2: 2 minutes; 3: 5 minutes; 4: never refresh","format":"int32"},"privateLabelingEnable":{"type":"boolean","description":"Enable private label. This field applies to the Omada Pro Controller only."},"privateLabelingUrl":{"type":"string","description":"The url of private label. This field applies to the Omada Pro Controller only."},"privateLabelingFileId":{"type":"string","description":"The file id of private label picture. This field applies to the Omada Pro Controller only."},"privateLabelingFileName":{"type":"string","description":"The file name of private label picture. This field applies to the Omada Pro Controller only."}}},"ModifyMailServerOpenApiVO":{"required":["authEnable","port","smtpServer","sslEnable"],"type":"object","properties":{"smtpEnable":{"type":"boolean","description":"Enable SMTP mail server"},"smtpServer":{"pattern":"^[\\041-\\0176]{1,128}$","type":"string","description":"The domain name of the SMTP mailbox server."},"port":{"type":"integer","description":"The port of the SMTP mailbox server,xxxx  should be within the range of 1-65535","format":"int32"},"sslEnable":{"type":"boolean","description":"Whether the SMTP mailbox server uses SSL encryption."},"authEnable":{"type":"boolean","description":"Whether the SMTP email server uses basic authentication."},"username":{"pattern":"^[\\041-\\0176]{1,128}$","type":"string","description":"The user's email address used for authentication."},"password":{"pattern":"^[\\041-\\0176]{1,128}$","type":"string","description":"The user's email password used for authentication."},"senderAddress":{"pattern":"[-0-9a-zA-Z.+_]+@[-0-9a-zA-Z.+_]+\\.[a-zA-Z0-9]{2,}","type":"string","description":"The email address from which the message was sent."},"receiver":{"pattern":"[-0-9a-zA-Z.+_]+@[-0-9a-zA-Z.+_]+\\.[a-zA-Z0-9]{2,}","type":"string","description":"The email address where the message will be received."}}},"ModifyMspRemoteLoggingSettingOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the feature."},"host":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"The IP address of the remote log server."},"port":{"type":"integer","description":"Port of the remote log server, port should be within the range of 1-65535.","format":"int32"}}},"ModifyMspGeneralSettingOpenApiVO":{"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,34}[^ ]$","type":"string","description":"Parameter [name] should be within the range of 1–36 visible ASCII characters."},"timeZone":{"type":"string","description":"For the values of timeZone, refer to section 5.1 of the Open API Access Guide."},"dst":{"$ref":"#/components/schemas/ModifyDstDTO"}}},"GatewayOsgMspConfig":{"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"Device name should contain 1 to 128 characters."}}},"MspClientDetailInfoSettingVO":{"type":"object","properties":{"clientHealthEnable":{"type":"boolean","description":"Whether client health is enabled. When enabled, client health data will be recorded, which may consume a significant amount of storage space."},"clientHistoryEnable":{"type":"boolean","description":"Whether client history is enabled. When enabled, client history, client logs will be recorded. This will occupy much storage space."},"clientDataTrendEnable":{"type":"boolean","description":"Whether client data trend record is enabled. When enabled, client trend statistics and charts will be retained, which will take up lots of storage space."}}},"ModifyOmadacByOmadaCloudRequestDTO":{"type":"object","properties":{"accountId":{"type":"string"},"customizeOmadacId":{"type":"string"},"controllerName":{"type":"string"},"timeZone":{"type":"string"},"region":{"type":"string"}}},"DhcpSettingsTemplateOpenApiVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"When value is true, DHCP server is enabled"},"ipRangePool":{"type":"array","description":"The list of DHCP Range, which size can't be more than \"dhcpRangePoolSize\", \"dhcpRangePoolSize\" can be obtained from 'Get LAN network template list' interface.","items":{"$ref":"#/components/schemas/DhcpRangeOpenApiVO"}},"ipRangeStart":{"type":"integer","description":"The specific format value of Gateway Subnet start IP","format":"int64"},"ipRangeEnd":{"type":"integer","description":"The specific format value of Gateway Subnet End IP","format":"int64"},"dhcpns":{"type":"string","description":"Setup DHCP server: \"auto\" or \"manual\""},"priDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"When DHCPs are \"manual\", primary DNS Server."},"sndDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"When DHCPs are \"manual\", second DNS Server."},"leasetime":{"type":"integer","description":"Leasetime should be within the range of 2-10080","format":"int32"},"gateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Manual Setup of DHCP Gateway IP"},"dhcpNextServer":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The dhcpNextServer should be valid IP address, which is used in optional set next DHCP server."},"dhcpPoolMask":{"type":"integer","format":"int32"},"options":{"type":"array","description":"User custom DHCP options","items":{"$ref":"#/components/schemas/custom DHCP Options"}}},"description":"Configure DHCP settings"},"LanNetworkOpenApiV3GridVOLanNetworkTemplateQueryOpenApiV3VO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/LanNetworkTemplateQueryOpenApiV3VO"}},"supportMultiVlan":{"type":"boolean","description":"Whether multi vlan configuration is supported of the lan netowrk."},"supportRA":{"type":"boolean","description":"Whether Router Advertisement configuration is supported of the lan netowrk."},"supportCustomDhcpOption":{"type":"boolean","description":"Whether custom DHCP option configuration is supported of the lan netowrk."},"combinedGateway":{"type":"boolean","description":"Whether the current site is combined gateway"},"dhcpRangePoolSize":{"type":"integer","description":"The size of DHCP range pool supported by the lan network DHCP.","format":"int32"},"interfaceNum":{"type":"integer","description":"The number of interface supported by current gateway.","format":"int32"},"supportDefault":{"type":"boolean","description":"Whether to allow the selection of Default VLAN."},"osgSupportIgmpSnooping":{"type":"array","description":"The name of the model that supports IgmpSnooping under site.","items":{"type":"string","description":"The name of the model that supports IgmpSnooping under site."}},"supportDhcpNextServer":{"type":"boolean","description":"Whether DHCP Next Server is supported of the lan network."},"vlanNums":{"type":"integer","description":"The vlan num of the site.","format":"int32"},"supportArpDetection":{"type":"boolean","description":"Whether ARP Detection is supported of the lan network."},"supportNetworkIsolation":{"type":"boolean","description":"Whether it supports isolate network."},"supportLanIpv6":{"type":"boolean","description":"Whether it supports lan Ipv6."},"supportLanIpv6PassThrough":{"type":"boolean","description":"Whether it supports Pass Through."},"supportMaxVlanNum":{"type":"integer","description":"The number of vlan supported by current gateway.","format":"int32"},"supportPdOnDhcp":{"type":"boolean","description":"Whether it supports \"Get from Prefix Delegation\" when disable Prefix Delegation on the corresponding WAN interface page."}}},"LanNetworkTemplateQueryOpenApiV3VO":{"required":["deviceType","igmpSnoopEnable","name","purpose"],"type":"object","properties":{"id":{"type":"string","description":"LAN network ID"},"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"LAN network name should contain 1 to 128 characters."},"purpose":{"type":"integer","description":"LAN network purpose should be a value as follows: 0: VLAN; 1: interface","format":"int32"},"interfaceIds":{"type":"array","description":"Gateway LAN port IDs (acquired from \"Check WAN/LAN status\")","items":{"type":"string","description":"Gateway LAN port IDs (acquired from \"Check WAN/LAN status\")"}},"vlanType":{"type":"integer","description":"When purpose is interface, VLANType should be a value as follows: 0: Single; 1: Multiple","format":"int32"},"vlans":{"pattern":"^[\\d|\\d-\\d]+(,[\\d|\\d-\\d]+)*$","type":"string","description":"When purpose is interface and VLANType is 1, batch create VLANs. VLAN format: 200, 1-100."},"application":{"type":"integer","description":"Effective device type should be a value as follows: 0: Gateway and Switch; 1: Switch","format":"int32"},"isolation":{"type":"boolean","description":"Whether network isolated."},"vlan":{"type":"integer","description":"Only Valid when vlanType is 0. Vlan should be within the range of 1-4094.","format":"int32"},"gatewaySubnet":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])/(\\d|((1|2)\\d)|(30))\\b","type":"string","description":"When purpose is interface, gateway subnet is needed. Format: IP/Mask"},"dhcpSettings":{"$ref":"#/components/schemas/DhcpSettingsTemplateOpenApiVO"},"domain":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"The domain of this network"},"igmpSnoopEnable":{"type":"boolean","description":"Enable IGMP snooping"},"fastLeaveEnable":{"type":"boolean","description":"IGMP Snooping fast leave enable status"},"mldSnoopEnable":{"type":"boolean","description":"Enable MLD snooping"},"dhcpv6Guard":{"$ref":"#/components/schemas/Dhcpv6 Servers setting"},"dhcpL2RelayEnable":{"type":"boolean","description":"The switch of DHCP L2 relay"},"dhcpGuard":{"$ref":"#/components/schemas/Dhcp Servers setting"},"portal":{"type":"boolean","description":"Show portal is enabled or not"},"portalId":{"type":"string","description":"Show portal ID"},"portalName":{"type":"string","description":"Show related portal name"},"accessControlRule":{"type":"boolean","description":"Show AccessControlRule is enabled or not"},"rateLimit":{"type":"boolean","description":"Show RateLimit is enabled or not"},"lanNeworkIpv6Config":{"$ref":"#/components/schemas/LanNetworkIpv6ConfigTemplateOpenApiVO"},"allLan":{"type":"boolean","description":"When Internet pre-config is closed or Internet pre-config is Universal, allLAN is \"true\"; after adopting gateway, allLAN is \"false\"."},"origName":{"type":"string","description":"Original name"},"arpDetectionEnable":{"type":"boolean","description":"Enable arp detection. Only valid when deviceType is 1 and gateway supports this feature."},"qosQueueEnable":{"type":"boolean","description":"The switch of QoS queue."},"queueId":{"type":"integer","description":"QoS queue Id.","format":"int32"},"existMultiVlan":{"type":"boolean","description":"Whether VLAN Type is Multiple."},"existRA":{"type":"boolean","description":"Whether RA has been configured."},"existCustomDhcpOption":{"type":"boolean","description":"Whether custom DHCP Options has been configured."},"existDhcpNextServer":{"type":"boolean","description":"Whether DHCP Next Server has been configured."},"existArpDetection":{"type":"boolean","description":"Whether Arp Detection is configured."},"existNetworkIsolation":{"type":"boolean","description":"Whether Network Isolation is configured."},"deviceType":{"type":"integer","description":"DHCP Server Device type. It should be a value as follows: 0:External Device 1:gateway 2:switch 3:none","format":"int32"},"deviceMac":{"type":"string","description":"DHCP Server Device mac. Only valid when deviceType is 1 or 2. When deviceType is 1, deviceMac can be empty when there is no gateway in the site."},"stackId":{"type":"string","description":"DHCP Server Device stackId. Only valid when deviceType is 2 and the selected device is stack"},"ip":{"$ref":"#/components/schemas/OswIpSettingBriefOpenapiVO"},"mode":{"type":"integer","description":"DHCP mode. 0: None 1: DHCP Server 2: DHCP Relay. Only valid when deviceType is 2.","format":"int32"},"dhcpServer":{"$ref":"#/components/schemas/OswDhcpServerOpenApiVO"},"dhcpRelay":{"$ref":"#/components/schemas/OswDhcpRelayOpenApiVO"},"totalIpNum":{"type":"integer","description":"Total ip num","format":"int64"},"dhcpServerNum":{"type":"integer","description":"The number of dhcp server devices in effect, Only valid when vlanType is 0.","format":"int32"},"subnetOverrideEnable":{"type":"boolean","description":"Subnet override enable status"},"subnetOverride":{"type":"boolean","description":"Subnet override"},"primary":{"type":"boolean","description":"Primary"}}},"OperationResponseLanNetworkOpenApiV3GridVOLanNetworkTemplateQueryOpenApiV3VO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/LanNetworkOpenApiV3GridVOLanNetworkTemplateQueryOpenApiV3VO"}}},"OperationResponseVpnUserServerGridVOVpnUserInfoVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VpnUserServerGridVOVpnUserInfoVO"}}},"VpnUserInfoVO":{"type":"object","properties":{"id":{"type":"string","description":"ID of the VPN user."},"username":{"type":"string","description":"Username of the VPN user."},"password":{"type":"string","description":"Password of the VPN user."},"protocol":{"type":"integer","description":"Protocol should be a value as follows: 0: L2TP or PPTP; 1: openVPN; 2: SSL VPN.","format":"int32"},"servers":{"type":"array","description":"Servers of the VPN user. Server can be created using 'Create client-to-site VPN server' interface, and server ID can be obtained from 'Get client-to-site VPN server list' interface.","items":{"type":"string","description":"Servers of the VPN user. Server can be created using 'Create client-to-site VPN server' interface, and server ID can be obtained from 'Get client-to-site VPN server list' interface."}},"clientMode":{"type":"integer","description":"Client mode should be a value as follows: 0: Client-To-Site, 1: Site-To-Site.","format":"int32"},"maxConnections":{"type":"integer","description":"Max connections should be within the range of 1–100.","format":"int32"},"userRemoteSubnets":{"type":"array","description":"User remote subnets of the VPN user.","items":{"$ref":"#/components/schemas/IPSubnetsVO"}},"serverNames":{"type":"string","description":"Server names of the VPN user."},"localIp":{"type":"string","description":"Local IP of the VPN user."},"groupId":{"type":"string","description":"Group ID of the SSL VPN user. User group can be created using 'Create SSL VPN user group' interface, and User Group ID can be obtained from 'Get user group list for SSL VPN server' interface."},"groupName":{"type":"string"},"status":{"type":"boolean","description":"Status of the SSL VPN user."},"validity":{"type":"string","description":"Validity of the SSL VPN user. The format is Month/Day/Year, for example 08/20/2022."},"available":{"type":"boolean"},"featureDescription":{"type":"array","description":"Gateway Feature Description.","items":{"$ref":"#/components/schemas/FeatureInfoVO"}}}},"VpnUserServerGridVOVpnUserInfoVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VpnUserInfoVO"}},"supportLocalIp":{"type":"boolean","description":"Whether the local IP address configuration is supported by the VPN user."},"supportL2TP":{"type":"boolean","description":"Whether the L2TP configuration is supported by the VPN user."},"supportPptp":{"type":"boolean","description":"Whether the PPTP configuration is supported by the VPN user."},"supportProtocol":{"type":"boolean","description":"Whether protocol configuration is supported of the VPN user"},"supportOpenVpn":{"type":"boolean","description":"Whether the OpenVPN configuration is supported by the VPN user."},"supportSslVpn":{"type":"boolean","description":"Whether the SSLVPN configuration is supported by the VPN user."},"maxConcurrentUser":{"type":"integer","description":"The maximum number of concurrent users supported by VPN.","format":"int32"},"sslVpnMaxConUserNum":{"type":"integer","description":"The maximum number of concurrent users supported by SSL VPN.","format":"int32"},"subnetsLimitSize":{"type":"integer","description":"The maximum number of subnets allowed for a VPN user.","format":"int32"},"supportServerOptional":{"type":"boolean","description":"Whether VPN server is optional."},"vpnInfo":{"$ref":"#/components/schemas/VpnUserServerInfoVO"},"total":{"type":"integer","format":"int32"},"available":{"type":"integer","format":"int32"},"expired":{"type":"integer","format":"int32"}}},"VpnUserServerInfoVO":{"type":"object","properties":{"id":{"type":"string","description":"ID of the VPN."},"name":{"type":"string","description":"VPN name."},"vpnType":{"type":"integer","description":"Server Vpn type. 0: L2TP; 1: PPTP; 3: OpenVPN; 5: SSL VPN.","format":"int32"}}},"MultiLinkEntryDTO":{"type":"object","properties":{"channel":{"type":"integer","description":"MLO Channel","format":"int32"},"radio":{"type":"integer","description":"MLO Radio","format":"int32"}},"description":"Vigi MultiLink In MLO Mode"},"OperationResponseTopologyV3OpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/TopologyV3OpenApiVO"}}},"PartnerLinkDTO":{"type":"object","properties":{"radioId":{"type":"integer","format":"int32"},"channel":{"type":"integer","format":"int32"},"txRate":{"type":"string"},"rxRate":{"type":"string"},"tx":{"type":"integer","format":"int32"},"rx":{"type":"integer","format":"int32"},"rssi":{"type":"integer","format":"int32"},"rssiPercent":{"type":"number","format":"float"},"rxDropPkts":{"type":"integer","format":"int64"},"txDropPkts":{"type":"integer","format":"int64"},"rxErrPkts":{"type":"integer","format":"int64"},"txErrPkts":{"type":"integer","format":"int64"},"snr":{"type":"integer","format":"int32"},"upRate":{"type":"integer","format":"int64"},"downRate":{"type":"integer","format":"int64"}},"description":"partner link info in mlo mesh link"},"PortLabelDTO":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"description":"Other Device Port Labels"},"TopologyFilterClientCountDTO":{"type":"object","properties":{"client2g":{"type":"integer","description":"2g Client Count","format":"int32"},"client5g":{"type":"integer","description":"5g Client Count","format":"int32"},"client6g":{"type":"integer","description":"6g Client Count","format":"int32"},"client2g5g":{"type":"integer","description":"2g And 5g Client Count","format":"int32"},"client2g6g":{"type":"integer","description":"2g And 6g Client Count","format":"int32"},"client5g6g":{"type":"integer","description":"5g And 6g Client Count","format":"int32"},"client2g5g6g":{"type":"integer","description":"2g, 5g And 6g Client Count","format":"int32"},"wiredClient":{"type":"integer","description":"Wired Client Count","format":"int32"}},"description":"Each Connection Type Client Count"},"TopologyOpenApiHealthStatusVO":{"type":"object","properties":{"good":{"type":"integer","description":"Devices Count In Good Health Status","format":"int32"},"fair":{"type":"integer","description":"Devices Count In Fair/Average Health Status","format":"int32"},"poor":{"type":"integer","description":"Devices Count In Poor Health Status","format":"int32"},"noData":{"type":"integer","description":"Devices Count With No Health Status","format":"int32"},"disconnected":{"type":"integer","description":"Disconnected Devices Count","format":"int32"},"total":{"type":"integer","description":"Total Devices Count","format":"int32"}},"description":"Topology Health Status"},"TopologyOpenApiStatusVO":{"type":"object","properties":{"existUMVmsDev":{"type":"boolean","description":"Whether Unmanaged Vms Devices Exist"},"connected":{"type":"integer","description":"Connected Devices Count","format":"int32"},"disconnected":{"type":"integer","description":"Disconnected Devices Count","format":"int32"},"client2g":{"type":"integer","description":"2g Client Count","format":"int32"},"client5g":{"type":"integer","description":"5g Client Count","format":"int32"},"client6g":{"type":"integer","description":"6g Client Count","format":"int32"},"wiredClient":{"type":"integer","description":"Wired Client Count","format":"int32"},"directlyShowClientsDeviceMacs":{"type":"array","description":"Devices Macs That Show Clients Directly","items":{"$ref":"#/components/schemas/ClientsQueryMacAndFilterType"}},"stpLoops":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Stp Loops","items":{"$ref":"#/components/schemas/TopologyOpenApiEdgeVO"}},"description":"Stp Loops"}},"description":"Topology Related Status"},"TopologyV3OpenApiNodeVO":{"type":"object","properties":{"type":{"type":"string","description":"Device Type"},"name":{"type":"string","description":"Device Name"},"mac":{"type":"string","description":"Device Mac"},"macList":{"type":"array","description":"Device Macs","items":{"type":"string","description":"Device Macs"}},"clientCount":{"type":"integer","description":"Directly Connected Client Count","format":"int32"},"ipcCount":{"type":"integer","description":"Directly Connected IPC Client Count","format":"int32"},"isAllClients":{"type":"boolean","description":"Whether The Client Group Is All Clients Or Just Other Clients"},"uplinkMacList":{"type":"array","description":"Mlag Or Vrrp Group All Members Mac List","items":{"type":"string","description":"Mlag Or Vrrp Group All Members Mac List"}},"multiSwitchDownlinkClient":{"type":"array","description":"Mlag Or Vrrp Group All Members Client Query Parameter","items":{"$ref":"#/components/schemas/ClientsQueryMacAndFilterType"}},"filterClientCount":{"$ref":"#/components/schemas/TopologyFilterClientCountDTO"},"healthScore":{"type":"integer","description":"Health Score","format":"int32"},"model":{"type":"string","description":"Device Model"},"modelVersion":{"type":"string","description":"Device ModelVersion"},"showModel":{"type":"string","description":"Device Show Model"},"specialModel":{"type":"string","description":"Special device model,for example:EAP225-Outdoor-1a20a950b8d950e8"},"deviceSeriesType":{"type":"integer","description":"Device Series Type","format":"int32"},"compatible":{"type":"integer","description":"The Compatibility Type Of Device Firmware And Controller","format":"int32"},"ecspFirstVersion":{"type":"integer","description":"Device Protocol First Version","format":"int32"},"disconnected":{"type":"boolean","description":"Whether The Device Is Disconnected Or Not"},"active":{"type":"boolean","description":"Whether The Device Is License Active Or Not"},"ip":{"type":"string","description":"Device Ip"},"devTxRate":{"type":"integer","description":"Device TxRate","format":"int64"},"devRxRate":{"type":"integer","description":"Device RxRate","format":"int64"},"clientHealth":{"$ref":"#/components/schemas/ClientAggHealthDTO"},"wanPorts":{"type":"array","description":"Gateway Wan Port List","items":{"$ref":"#/components/schemas/WanPort"}},"lanPorts":{"type":"array","description":"Gateway Lan Port List","items":{"$ref":"#/components/schemas/LanPort"}},"stackStatus":{"type":"integer","description":"Status of the Stack Group. 0: normal; 1: abnormal; 2: stack not ready.","format":"int32"},"abnormalReason":{"type":"integer","description":"Stack Abnormal Reason. 0: Not All Connected. 2: Not All Activated.","format":"int32"},"stackGroup":{"type":"boolean","description":"Whether The Switch Device Is Stack Group Or Not"},"stackId":{"type":"string","description":"StackGroup Switch Device Id"},"rdMode2g":{"type":"string","description":"rdMode2g"},"channel2g":{"type":"integer","description":"channel2g","format":"int32"},"rdMode5g":{"type":"string","description":"rdMode5g"},"channel5g":{"type":"integer","description":"channel5g","format":"int32"},"rdMode5g2":{"type":"string","description":"rdMode5g2"},"channel5g2":{"type":"integer","description":"channel5g2","format":"int32"},"rdMode6g":{"type":"string","description":"rdMode6g"},"channel6g":{"type":"integer","description":"channel6g","format":"int32"},"support5g2":{"type":"boolean","description":"Whether The Device Supports 5g2 Or Not"},"role":{"type":"integer","description":"Identify Device Role In P2P Scenarios","format":"int32"},"firmwareVersion":{"type":"string","description":"FirmwareVersion Of IPC/NVR"},"channelNum":{"type":"integer","description":"ChannelNum Of IPC/NVR","format":"int32"},"connectedChannel":{"type":"integer","description":"Connected Channel Of IPC/NVR","format":"int32"},"wirelessUplink":{"type":"boolean","description":"Whether The IPC/NVR Is Wireless Connected Or Not"},"successors":{"type":"array","description":"Device Successors","items":{"$ref":"#/components/schemas/TopologyV3OpenApiNodeVO"}},"wiredUpInfo":{"$ref":"#/components/schemas/WiredUpInfoDTO"},"wiredUpInfos":{"type":"array","description":"Multi wiredUpInfo for mlag and vrrp member or downlink device","items":{"$ref":"#/components/schemas/WiredUpInfoDTO"}},"wirelessUpInfo":{"$ref":"#/components/schemas/WirelessUpInfoDTO"},"vigiWirelessUpInfo":{"$ref":"#/components/schemas/VigiWirelessUpInfoDTO"},"portLabels":{"$ref":"#/components/schemas/PortLabelDTO"},"description":{"type":"string","description":"Other Device Description"},"capability":{"type":"string","description":"Other Device Capability"},"status":{"type":"integer","description":"Device Status","format":"int32"},"statusCategory":{"type":"integer","description":"Device Status Category","format":"int32"},"warnNvrFirmware":{"type":"boolean","description":"Whether IPC/NVR Needs To Upgrade Firmware To Support Lldp Feature"},"clientType":{"type":"string","description":"Type of Third Party Device, if type is other"},"clientVlanId":{"type":"integer","description":"Vlan Id Of Client That Exists In Topology As Other Device","format":"int32"},"omadaDeviceType":{"type":"string","description":"Type of Omada Device, if type is other"},"specificOtherType":{"type":"string","description":"SpecificOtherType for other device"},"existStpLoop":{"type":"boolean","description":"Exist Stp Loop Or Not"},"vigiManaged":{"type":"boolean","description":"If Vigi Is Managed By Vms"},"ippt":{"type":"boolean","description":"If Gateway Is Ippt Mode"},"specificType":{"type":"integer","description":"SpecificType for multiSwitchNode, 0 means mlag node and 1 means vrrp node","format":"int32"},"mlagId":{"type":"string","description":"Mlag group id"},"multiSwitchList":{"type":"array","description":"All members for multiSwitchNode including mlag and vrrp node","items":{"$ref":"#/components/schemas/TopologyV3OpenApiNodeVO"}},"multiSwitchNum":{"type":"integer","description":"Serial number for mlag and vrrp node members, which is unique","format":"int32"},"multiSwitchRole":{"type":"integer","description":"Role for mlag and vrrp node members","format":"int32"},"dadLink":{"type":"array","description":"DadLink for mlag node","items":{"$ref":"#/components/schemas/WiredPortV3DTO"}},"peerLink":{"type":"array","description":"PeerLink for mlag node","items":{"$ref":"#/components/schemas/WiredPortV3DTO"}},"vrrpLink":{"type":"array","description":"Vrrp members internal link","items":{"$ref":"#/components/schemas/VrrpLinkDTO"}},"vlansAsMaster":{"type":"string","description":"All vlans that vrrp member act as master"},"vrrpGroupList":{"type":"array","description":"Vrrp node member's vrrp group information","items":{"$ref":"#/components/schemas/VrrpGroupDTO"}}},"description":"Topology Nodes"},"TopologyV3OpenApiVO":{"type":"object","properties":{"topologyArray":{"type":"array","description":"Topology Nodes","items":{"$ref":"#/components/schemas/TopologyV3OpenApiNodeVO"}},"status":{"$ref":"#/components/schemas/TopologyOpenApiStatusVO"},"healthStat":{"$ref":"#/components/schemas/TopologyOpenApiHealthStatusVO"},"lastUpdateTime":{"type":"integer","description":"Last Update Time","format":"int64"}}},"VigiWirelessUpInfoDTO":{"type":"object","properties":{"channel":{"type":"integer","description":"Wireless Vigi Channel","format":"int32"},"ssid":{"type":"string","description":"Wireless Vigi Ssid"},"radio":{"type":"integer","description":"Wireless Vigi Radio","format":"int32"},"support5g2":{"type":"boolean","description":"Whether The Vigi Supports 5g2 Or Not"},"multiLink":{"type":"array","description":"Vigi MultiLink In MLO Mode","items":{"$ref":"#/components/schemas/MultiLinkEntryDTO"}}},"description":"Wireless Vigi UpLink Info"},"VrrpGroupDTO":{"type":"object","properties":{"vrrpId":{"type":"integer","format":"int32"},"vrrpName":{"type":"string"},"isMaster":{"type":"boolean"}},"description":"Vrrp node member's vrrp group information"},"VrrpLinkDTO":{"type":"object","properties":{"upLink":{"$ref":"#/components/schemas/WiredPortV3DTO"},"downLink":{"$ref":"#/components/schemas/WiredPortV3DTO"},"linkSpeed":{"type":"integer","description":"LinkSpeed","format":"int32"},"duplex":{"type":"integer","description":"Duplex","format":"int32"},"blocked":{"type":"boolean","description":"Whether The Link Is Blocked By STP Or Not"}},"description":"Vrrp members internal link"},"WiredUpInfoDTO":{"type":"object","properties":{"port":{"$ref":"#/components/schemas/WiredPortV3DTO"},"upLinkPort":{"$ref":"#/components/schemas/WiredPortV3DTO"},"linkSpeed":{"type":"integer","description":"LinkSpeed","format":"int32"},"duplex":{"type":"integer","description":"Duplex","format":"int32"},"fiberOptic":{"type":"boolean","description":"Whether The Device Is FiberOptic Or Not"},"rxDropPkts":{"type":"integer","description":"Rx Dropped Packets","format":"int64"},"txDropPkts":{"type":"integer","description":"Tx Dropped Packets","format":"int64"},"rxErrPkts":{"type":"integer","description":"Rx Error Packets","format":"int64"},"txErrPkts":{"type":"integer","description":"Tx Error Packets","format":"int64"},"blocked":{"type":"boolean","description":"Blocked Connection Or Not"},"blocked_vlans":{"type":"string","description":"Blocked Vlans"}},"description":"Multi wiredUpInfo for mlag and vrrp member or downlink device"},"WirelessUpInfoDTO":{"type":"object","properties":{"txRate":{"type":"string","description":"Tx Rate"},"rxRate":{"type":"string","description":"Rx Rate"},"tx":{"type":"integer","description":"Tx","format":"int32"},"rx":{"type":"integer","description":"Rx","format":"int32"},"rssi":{"type":"integer","description":"Rssi","format":"int32"},"rssiPercent":{"type":"number","description":"Rssi Percent","format":"float"},"rxDropPkts":{"type":"integer","description":"Rx Dropped Packets","format":"int64"},"txDropPkts":{"type":"integer","description":"Tx Dropped Packets","format":"int64"},"rxErrPkts":{"type":"integer","description":"Rx Error Packets","format":"int64"},"txErrPkts":{"type":"integer","description":"Tx Error Packets","format":"int64"},"snr":{"type":"integer","description":"Wireless P2P Ap Snr","format":"int32"},"meshRadioId":{"type":"integer","description":"radio Id used in mesh link","format":"int32"},"channel":{"type":"integer","description":"channel in link","format":"int32"},"upRate":{"type":"integer","description":"upRate of this radio Id","format":"int64"},"downRate":{"type":"integer","description":"downRate of this radio Id","format":"int64"},"partnerLinks":{"type":"array","description":"partner link info in mlo mesh link","items":{"$ref":"#/components/schemas/PartnerLinkDTO"}}},"description":"Wireless UpLink Info"},"OperationResponseTopologyFilterDevicesVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/TopologyFilterDevicesVO"}}},"TopologyFilterDevicesVO":{"type":"object","properties":{"deviceMacs":{"type":"array","description":"Devices Macs.","items":{"type":"string","description":"Devices Macs."}}}},"LanNetworkOpenApiV3GridVOLanNetworkQueryOpenApiV3VO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/LanNetworkQueryOpenApiV3VO"}},"supportMultiVlan":{"type":"boolean","description":"Whether multi vlan configuration is supported of the lan netowrk."},"supportRA":{"type":"boolean","description":"Whether Router Advertisement configuration is supported of the lan netowrk."},"supportCustomDhcpOption":{"type":"boolean","description":"Whether custom DHCP option configuration is supported of the lan netowrk."},"combinedGateway":{"type":"boolean","description":"Whether the current site is combined gateway"},"dhcpRangePoolSize":{"type":"integer","description":"The size of DHCP range pool supported by the lan network DHCP.","format":"int32"},"interfaceNum":{"type":"integer","description":"The number of interface supported by current gateway.","format":"int32"},"supportDefault":{"type":"boolean","description":"Whether to allow the selection of Default VLAN."},"osgSupportIgmpSnooping":{"type":"array","description":"The name of the model that supports IgmpSnooping under site.","items":{"type":"string","description":"The name of the model that supports IgmpSnooping under site."}},"supportDhcpNextServer":{"type":"boolean","description":"Whether DHCP Next Server is supported of the lan network."},"vlanNums":{"type":"integer","description":"The vlan num of the site.","format":"int32"},"supportArpDetection":{"type":"boolean","description":"Whether ARP Detection is supported of the lan network."},"supportNetworkIsolation":{"type":"boolean","description":"Whether it supports isolate network."},"supportLanIpv6":{"type":"boolean","description":"Whether it supports lan Ipv6."},"supportLanIpv6PassThrough":{"type":"boolean","description":"Whether it supports Pass Through."},"supportMaxVlanNum":{"type":"integer","description":"The number of vlan supported by current gateway.","format":"int32"},"supportPdOnDhcp":{"type":"boolean","description":"Whether it supports \"Get from Prefix Delegation\" when disable Prefix Delegation on the corresponding WAN interface page."}}},"OperationResponseLanNetworkOpenApiV3GridVOLanNetworkQueryOpenApiV3VO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/LanNetworkOpenApiV3GridVOLanNetworkQueryOpenApiV3VO"}}},"GridVOWlanGroupOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WlanGroupOpenApiVO"}}}},"OperationResponseWlanGroupGridOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/WlanGroupGridOpenApiVO"}}},"WlanGroupGridOpenApiVO":{"type":"object","properties":{"gridWlanGroup":{"$ref":"#/components/schemas/GridVOWlanGroupOpenApiVO"},"maxSsids2G":{"type":"integer","description":"2G radio max Ssid number in group","format":"int32"},"maxSsids5G":{"type":"integer","description":"5G radio max Ssid number in group","format":"int32"},"maxSsids6G":{"type":"integer","description":"6G radio max Ssid number in group","format":"int32"},"maxSsidsMlo":{"type":"integer","description":"max Mlo Ssid number in group","format":"int32"}}},"WlanGroupOpenApiVO":{"type":"object","properties":{"wlanId":{"type":"string","description":"WLAN group ID, kept for backward compatibility and equivalent to id. This field will be removed in a future release; use id instead.","deprecated":true},"id":{"type":"string","description":"WLAN group ID"},"name":{"type":"string","description":"WLAN group name should contain 1 to 128 characters."},"primary":{"type":"boolean","description":"Whether it is the default WLAN group"},"clone":{"type":"boolean","description":"Whether it is cloned"},"cloneWlanId":{"type":"string","description":"cloneWlanId"},"site":{"type":"string","description":"site Id"},"resource":{"type":"integer","description":"resource. 0 is new created, 1 is from template, 2 is override template.","format":"int32"}}},"GridVOLanProfileOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/LanProfileOpenApiVO"}}}},"LanProfileOpenApiVO":{"required":["bandWidthCtrlType","dot1x","lldpMedEnable","loopbackDetectEnable","name","poe","portIsolationEnable","spanningTreeEnable"],"type":"object","properties":{"id":{"type":"string","description":"LAN profile ID"},"flag":{"type":"integer","description":"Flag should be a value as follows: 0: default(all,disable,LAN), 1: native(generated by creating LAN network), 2: customize(created by users)","format":"int32"},"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Name should contain 1 to 128 characters."},"poe":{"type":"integer","description":"PoE should be a value as follows: 0: off, 1: on, 2: \"do not modify\"","format":"int32"},"nativeNetworkId":{"type":"string","description":"Native network ID, Native Network cannot be selected from Tagged Networks or Untagged Networks."},"tagNetworkIds":{"type":"array","description":"Tag network IDs","items":{"type":"string","description":"Tag network IDs"}},"untagNetworkIds":{"type":"array","description":"Untag network IDs","items":{"type":"string","description":"Untag network IDs"}},"voiceNetworkId":{"type":"string","description":"Voice Network ID"},"dot1x":{"type":"integer","description":"Dot1x should be a value as follows: 0: force unauthorized, 1: force authorized, 2:auto","format":"int32"},"portIsolationEnable":{"type":"boolean","description":"Port-isolation enable status"},"lldpMedEnable":{"type":"boolean","description":"LLDP-MED enable status"},"topoNotifyEnable":{"type":"boolean","description":"TopoNotify enable status"},"bandWidthCtrlType":{"type":"integer","description":"BandWidthCtrlType should be a value as follows: 0: off, 1: rate limit, 2: storming control","format":"int32"},"stormCtrl":{"$ref":"#/components/schemas/StormCtrlVO"},"bandCtrl":{"$ref":"#/components/schemas/BandCtrlVO"},"spanningTreeEnable":{"type":"boolean","description":"SpanningTree enable status"},"spanningTreeSetting":{"$ref":"#/components/schemas/SpanningTreeSettingVO"},"loopbackDetectEnable":{"type":"boolean","description":"LoopbackDetect enable status"},"eeeEnable":{"type":"boolean","description":"EEE enable status"},"flowControlEnable":{"type":"boolean","description":"FlowControl enable status"},"loopbackDetectVlanBasedEnable":{"type":"boolean","description":"LoopbackDetectVLANBased enable status"},"igmpFastLeaveEnable":{"type":"boolean","description":"Indicates whether igmp fast leave is enabled"},"mldFastLeaveEnable":{"type":"boolean","description":"Indicates whether mld fast leave is enabled"},"dhcpL2RelaySettings":{"$ref":"#/components/schemas/DhcpL2RelayVO"},"fastLeaveEnable":{"type":"boolean","description":"IGMP Snooping fast leave enable status"},"dot1pPriority":{"type":"integer","description":"802.1p Priority","format":"int32"},"trustMode":{"type":"integer","description":"Trust mode","format":"int32"},"type":{"type":"integer","description":"Type should be a value as follows: 0: LAN profile-ALL, 1: LAN profile-Disable, 2: LAN Profile except ALL and Disable","format":"int32"},"supportESEnable":{"type":"boolean","description":"Agile Series Switch enable status. The default value is false"},"networkConflict":{"type":"boolean","description":"Indicates whether the VLAN configuration in the Profile is inconsistent with the VLAN configuration that is effective for the bound port."}}},"OperationResponseGridVOLanProfileOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOLanProfileOpenApiVO"}}},"InterfaceForBatchIsolateOpenApiVO":{"type":"object","properties":{"name":{"type":"string","description":"Lan network name."},"id":{"type":"string","description":"Lan network Id."},"vlan":{"type":"integer","description":"vlan Id.","format":"int32"},"vlans":{"type":"string","description":"multiple vlan Ids"},"isolation":{"type":"boolean","description":"Whether isolate network."}}},"OperationResponseListInterfaceForBatchIsolateOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/InterfaceForBatchIsolateOpenApiVO"}}}},"OperationResponseListWlanBriefAppVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/WlanBriefAppVO"}}}},"SsidBriefAppVO":{"type":"object","properties":{"idInt":{"type":"integer","format":"int32"},"name":{"type":"string"},"bandInfo":{"type":"integer","format":"int32"},"securityMode":{"type":"integer","format":"int32"},"guestNetEnable":{"type":"boolean"},"versionPsk":{"type":"integer","format":"int32"},"psk":{"type":"string"},"hidePwd":{"type":"boolean"},"ssidConfigurable":{"type":"boolean"},"oweEnable":{"type":"boolean"},"mloEnable":{"type":"boolean"}}},"WlanBriefAppVO":{"type":"object","properties":{"wlanId":{"type":"string"},"wlanName":{"type":"string"},"ssids":{"type":"array","items":{"$ref":"#/components/schemas/SsidBriefAppVO"}}}},"OperationResponseWlanGroupOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/WlanGroupOpenApiVO"}}},"GridVOSsidOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SsidOpenApiVO"}}}},"OperationResponseGridVOSsidOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOSsidOpenApiVO"}}},"SsidOpenApiVO":{"type":"object","properties":{"ssidId":{"type":"string","description":"SSID ID, kept for backward compatibility and equivalent to id. This field will be removed in a future release; use id instead.","deprecated":true},"id":{"type":"string","description":"SSID ID"},"name":{"type":"string","description":"SSID name. It should contain 1 to 32 UTF-8 characters."},"description":{"type":"boolean","description":"SSID Enable status."},"chooseDevices":{"type":"integer","format":"int32"},"band":{"type":"integer","description":"SSID band. The lowest bit indicates whether 2.4G is included; the second lowest bit indicates whether 5G is included; the third lowest bit indicates whether 6G is included; 1 means included while 0 means not included. For example, 7(111) means that 2G/5G/6G are enabled; 1(001) means that 2G is enabled. (When 5G is included，it means 5G/5G1/5G2 are enabled.)","format":"int32"},"guestNetEnable":{"type":"boolean","description":"SSID guest network config status. True: enable, false: disable."},"security":{"type":"integer","description":"SSID security mode; Security should be a value as follows: 0: None; 2: WPA-Enterprise; 3: WPA-Personal; 4: PPSK without RADIUS; 5: PPSK with RADIUS.","format":"int32"},"broadcast":{"type":"boolean","description":"SSID broadcast config status. True: enable, false: disable."},"vlanEnable":{"type":"boolean","description":"SSID VLAN config status. True: enable, false: disable."},"vlanId":{"type":"integer","description":"SSID VLAN ID. This field is required when Parameter [vlanEnable] is true; It should be within the range of 1–4094.","format":"int32"},"vlanPoolIds":{"type":"string","description":"SSID VLAN POOL IDs. This field is required when Parameter [vlanEnable] is true; The numbers contain in it should be within the range of 1–4094."}}},"OperationResponseVpnUserOpenApiGridVOVpnUserInfoVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VpnUserOpenApiGridVOVpnUserInfoVO"}}},"VpnUserOpenApiGridVOVpnUserInfoVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VpnUserInfoVO"}},"supportLocalIp":{"type":"boolean","description":"Whether the local IP address configuration is supported by the VPN user."},"supportL2TP":{"type":"boolean","description":"Whether the L2TP configuration is supported by the VPN user."},"supportPptp":{"type":"boolean","description":"Whether the PPTP configuration is supported by the VPN user."},"supportProtocol":{"type":"boolean","description":"Whether protocol configuration is supported of the VPN user"},"supportOpenVpn":{"type":"boolean","description":"Whether the OpenVPN configuration is supported by the VPN user."},"supportSslVpn":{"type":"boolean","description":"Whether the SSLVPN configuration is supported by the VPN user."},"maxConcurrentUser":{"type":"integer","description":"The maximum number of concurrent users supported by VPN.","format":"int32"},"sslVpnMaxConUserNum":{"type":"integer","description":"The maximum number of concurrent users supported by SSL VPN.","format":"int32"},"subnetsLimitSize":{"type":"integer","description":"The maximum number of subnets allowed for a VPN user.","format":"int32"},"supportServerOptional":{"type":"boolean","description":"Whether VPN server is optional."}}},"OperationResponseSslVpnUserGridVOVpnUserInfoVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SslVpnUserGridVOVpnUserInfoVO"}}},"SslVpnUserGridVOVpnUserInfoVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VpnUserInfoVO"}},"total":{"type":"integer","format":"int32"},"available":{"type":"integer","format":"int32"},"expired":{"type":"integer","format":"int32"},"sslVpnMaxConUserNum":{"type":"integer","format":"int32"},"subnetsLimitSize":{"type":"integer","format":"int32"}}},"IPsecFailoverStatusOpenApiVO":{"type":"object","properties":{"backupWan":{"type":"string","description":"Backup WAN of the IPSec failover."},"status":{"type":"boolean","description":"Backup VPN status."}},"description":"Setting of the IPSec failover."},"OperationResponseVpnSummaryOpenApiGridVOVpnSummaryVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VpnSummaryOpenApiGridVOVpnSummaryVO"}}},"VpnSummaryOpenApiGridVOVpnSummaryVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VpnSummaryVO"}},"supportVpnUserTab":{"type":"boolean","description":"Whether user tab configuration is supported of the VPN"},"supportCustomDns":{"type":"boolean","description":"Whether custom dns configuration is supported of the VPN"},"supportCustomNetwork":{"type":"boolean","description":"Whether custom network configuration is supported of the VPN"},"supportAccountAuth":{"type":"boolean","description":"Whether account auth configuration is supported of the VPN"},"supportIpRange":{"type":"boolean","description":"Whether ip range configuration is supported of the VPN"},"supportTunnelMode":{"type":"boolean","description":"Whether tunnel mode configuration is supported of the VPN"},"supportLdap":{"type":"boolean","description":"Whether LDAP authentication mode is supported of the VPN server"},"supportSslVpnLdap":{"type":"boolean","description":"Whether LDAP authentication mode is supported of the SSl VPN server"},"supportSslVpnRadius":{"type":"boolean","description":"Whether radius authentication mode is supported of the SSl VPN server"},"supportL2TP":{"type":"boolean","description":"Whether L2TP VPN is supported."},"supportIPsec":{"type":"boolean","description":"Whether IPsec VPN is supported."},"supportIPsecIpRange":{"type":"boolean","description":"Whether IP range is supported of IPSec VPN Server."},"supportOpenVpnDomain":{"type":"boolean","description":"Whether OpenVPN supports inputting domain."},"supportWgDomain":{"type":"boolean","description":"Whether peer supports inputting domain."},"pfsCap":{"type":"array","description":"All PFS configuration types supported by the device, 1:dh1; 2:dh2; 3:dh3; 14:dh14; 15:dh15. Default: dh1、dh2、dh5","items":{"type":"integer","description":"All PFS configuration types supported by the device, 1:dh1; 2:dh2; 3:dh3; 14:dh14; 15:dh15. Default: dh1、dh2、dh5","format":"int32"}},"supportServerClientWireGuard":{"type":"boolean","description":"Whether Server/Client Wire Guard is supported."},"supportCustomServer":{"type":"boolean","description":"Whether custom server is supported."},"phase1Proposal1Cap":{"type":"array","description":"Proposal options for IKE negotiation phase-1. 0: MD5, 1: SHA1, 2:SHA256, 3:SHA384, 4:SHA512. Default: MD5, SHA1 and SHA256","items":{"type":"integer","description":"Proposal options for IKE negotiation phase-1. 0: MD5, 1: SHA1, 2:SHA256, 3:SHA384, 4:SHA512. Default: MD5, SHA1 and SHA256","format":"int32"}},"phase2Proposal2Cap":{"type":"array","description":"Proposal options for IKE negotiation phase-2. 0: MD5, 1: SHA1, 2:SHA256, 3:SHA384, 4:SHA512. Default: MD5, SHA1 and SHA256","items":{"type":"integer","description":"Proposal options for IKE negotiation phase-2. 0: MD5, 1: SHA1, 2:SHA256, 3:SHA384, 4:SHA512. Default: MD5, SHA1 and SHA256","format":"int32"}},"supportByDsLiteAndMapE":{"type":"boolean","description":"Whether this feature is supported for the DS-Lite or Map-E WAN connection types."},"supportServerOpenVpnGoogleLdap":{"type":"boolean","description":"Whether Open VPN Server supports Google LDAP."},"supportDnsStatus":{"type":"boolean","description":"Whether supports dns auto."},"subnetsLimitSize":{"type":"integer","description":"The limit on the number of entries for remote subnets and local network.","format":"int32"},"wgPeerLimitSize":{"type":"integer","description":"The limit on the number of entries for peer in WireGuard.","format":"int32"},"supportManualWgLocalNetwork":{"type":"boolean","description":"Whether manual Wire Guard in site to site supports local network."},"supportAutoWireGuard":{"type":"boolean","description":"Whether auto Wire Guard in site to site is supported."},"supportIPsecFailover":{"type":"boolean","description":"Whether supports IPSec failover in manual IPSec."},"sslVpnNum":{"type":"integer","description":"The number of SSLVPN servers.","format":"int64"}}},"VpnSummaryVO":{"type":"object","properties":{"id":{"type":"string","description":"ID of the VPN."},"name":{"type":"string","description":"VPN name."},"status":{"type":"boolean","description":"Status of the VPN."},"vpnType":{"type":"integer","description":"Server Vpn type. 0: L2TP; 1: PPTP; 2: IPSec; 3: OpenVPN; 4: WireGuard; 5: SSL VPN.","format":"int32"},"siteVpnType":{"type":"integer","description":"Site VPN type of the VPN. 0: Auto; 1: Manual.","format":"int32"},"wans":{"type":"array","description":"WAN port ID.","items":{"type":"string","description":"WAN port ID."}},"failoverSetting":{"$ref":"#/components/schemas/IPsecFailoverStatusOpenApiVO"},"networkType":{"type":"integer","description":"Network type. 0: network list; 1: custom networks.","format":"int32"},"networkList":{"type":"array","description":"Network list of the VPN.","items":{"type":"string","description":"Network list of the VPN."}},"customNetwork":{"type":"array","description":"Custom networks of the VPN.","items":{"$ref":"#/components/schemas/IPSubnetsVO"}},"groupId":{"type":"string","description":"Default group ID of SSL VPN server."},"userCount":{"type":"integer","description":"User number of the VPN.","format":"int64"},"activeClients":{"type":"integer","description":"Active clients number of the VPN.","format":"int64"},"featureDescription":{"type":"array","description":"Gateway Feature Description.","items":{"$ref":"#/components/schemas/FeatureInfoVO"}}}},"OperationResponseVpnSiteToSiteDetailOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VpnSiteToSiteDetailOpenApiVO"}}},"VpnSiteToSiteDetailOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"ID of the VPN."},"name":{"type":"string","description":"VPN name."},"status":{"type":"boolean","description":"Status of the VPN."},"vpnType":{"type":"integer","description":"Server Vpn type. 0: L2TP; 1: PPTP; 2: IPSec; 3: OpenVPN; 4: WireGuard; 5: SSL VPN.","format":"int32"},"siteVpnType":{"type":"integer","description":"Site VPN type of the VPN. 0: Auto; 1: Manual.","format":"int32"},"remoteSite":{"type":"string","description":"Remote site of the VPN."},"remoteSiteName":{"type":"string","description":"Remote site name of the VPN."},"mtu":{"type":"integer","description":"The MTU of WireGuard VPN should be within the range of 576-1440.","format":"int32"},"tunnelIp":{"type":"string","description":"IP address."},"privateKey":{"type":"string","description":"The private key of WireGuard VPN must have 44 character of base64 and end with '='."},"publicKey":{"type":"string","description":"The public key of WireGuard VPN must have 44 character of base64 and end with '='."},"servicePort":{"type":"integer","description":"Service port for VPN.","format":"int32"},"wans":{"type":"array","description":"WAN list of the VPN, only for Manual IPSec type. WAN port ID can be obtained from 'Get internet basic info' interface.","items":{"type":"string","description":"WAN list of the VPN, only for Manual IPSec type. WAN port ID can be obtained from 'Get internet basic info' interface."}},"failoverSetting":{"$ref":"#/components/schemas/IPsecFailoverSettingOpenApiVO"},"remoteIp":{"type":"string","description":"Remote IP of the VPN."},"remoteSubnet":{"type":"array","description":"Remote subnet of the VPN.","items":{"type":"string","description":"Remote subnet of the VPN."}},"preSharedKey":{"type":"string","description":"Pre-shared key of the VPN."},"networkType":{"type":"integer","description":"Network type should be a value as follows: 0: network list; 1: custom networks.","format":"int32"},"networkList":{"type":"array","description":"Network list of the VPN. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Network list of the VPN. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface."}},"customNetwork":{"type":"array","description":"Custom networks of the VPN.","items":{"$ref":"#/components/schemas/IPSubnetsVO"}},"advancedSetting":{"$ref":"#/components/schemas/VpnAdvancedSettingOpenApiVO"},"peers":{"type":"array","description":"List of Site-To-Site manual WireGuard peer Configuration.","items":{"$ref":"#/components/schemas/SiteToSiteManualWgPeerConfigVO"}},"featureDescription":{"type":"array","description":"Gateway Feature Description.","items":{"$ref":"#/components/schemas/FeatureInfoVO"}}}},"OperationResponseVpnServerDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VpnServerDetailVO"}}},"ServerWireGuardClientsVO":{"type":"object","properties":{"id":{"type":"string","description":"ID of the client."},"name":{"type":"string","description":"Client name."},"interfaceIp":{"type":"string","description":"IP address."},"publicKey":{"type":"string","description":"The public key of WireGuard VPN must have 44 character of base64 and end with '='."},"privateKey":{"type":"string","description":"The privateKey key of WireGuard VPN must have 44 character of base64 and end with '='."},"preSharedKey":{"type":"string","description":"The preSharedKey of WireGuard peer must have 44 character of base64 and end with '='."},"allowedAddressStatus":{"type":"boolean","description":"When parameter [allowedAddressStatus] is false, server WireGuard peer allowed address is client interface IP."},"allowedAddress":{"type":"array","description":"IP/MASK address list of server WireGuard peer allowed.","items":{"type":"string","description":"IP/MASK address list of server WireGuard peer allowed."}}},"description":"WireGuard clients."},"VpnServerDetailVO":{"type":"object","properties":{"id":{"type":"string","description":"ID of the VPN."},"name":{"type":"string","description":"VPN name."},"status":{"type":"boolean","description":"Status of the VPN."},"vpnType":{"type":"integer","description":"Server Vpn type. 0: L2TP; 1: PPTP; 2: IPSec; 3: OpenVPN; 4: WireGuard; 5: SSL VPN.","format":"int32"},"wans":{"type":"array","description":"WAN port ID.","items":{"type":"string","description":"WAN port ID."}},"servicePort":{"type":"integer","description":"Service port for VPN server.","format":"int32"},"customServer":{"type":"boolean","description":"Whether enable custom server."},"customServerAddress":{"type":"string","description":"IPv4 Address or FQDN."},"ipPoolType":{"type":"integer","description":"IP pool type should be a value as follows: 0: Ip Address/Mask; 1: Ip Address Range.","format":"int32"},"ipPoolStart":{"type":"string","description":"The start IP of the IP pool."},"ipPoolEnd":{"type":"string","description":"The end IP of the IP pool."},"ipPool":{"$ref":"#/components/schemas/IPSubnetsVO"},"mtu":{"type":"integer","description":"The MTU of WireGuard VPN should be within the range of 576-1440.","format":"int32"},"keepAlive":{"type":"integer","description":"The keepalive second of WireGuard peer should be within the range of 0-65535.","format":"int32"},"privateKey":{"type":"string","description":"The private key of WireGuard VPN must have 44 character of base64 and end with '='."},"publicKey":{"type":"string","description":"The public key of WireGuard VPN must have 44 character of base64 and end with '='."},"dnsStatus":{"type":"boolean","description":"Dns auto status."},"dns1":{"type":"string","description":"Primary DNS of the VPN."},"dns2":{"type":"string","description":"Secondary DNS of the VPN."},"clients":{"type":"array","description":"WireGuard clients.","items":{"$ref":"#/components/schemas/ServerWireGuardClientsVO"}},"tunnelMode":{"type":"integer","description":"OpenVPN tunnel mode should be a value as follows: 0: split; 1: full.","format":"int32"},"networkType":{"type":"integer","description":"Network type. 0: network list; 1: custom networks.","format":"int32"},"networkList":{"type":"array","description":"Network list of the VPN. ","items":{"type":"string","description":"Network list of the VPN. "}},"customNetwork":{"type":"array","description":"Custom networks of the VPN.","items":{"$ref":"#/components/schemas/VpnIPSubnetsOpenApiVO"}},"accountAuth":{"type":"boolean","description":"Account auth of the VPN, only for server OpenVPN."},"authMode":{"type":"integer","description":"Authentication mode. 0: Local; 1: LDAP.","format":"int32"},"serviceType":{"type":"integer","description":"Service type of the VPN.","format":"int32"},"remoteIp":{"type":"string","description":"Remote IP of the VPN."},"encryption":{"type":"integer","description":"Encryption type. Only L2TP can configure auto type. 0: Encrypted; 1: Unencrypted; 2: Auto.","format":"int32"},"preSharedKey":{"type":"string","description":"Pre-shared key of the VPN."},"advancedSetting":{"$ref":"#/components/schemas/VpnAdvancedSettingOpenApiVO"},"ldapProfile":{"type":"string"},"LDAPSetting":{"$ref":"#/components/schemas/LdapSettingOpenApiVO"},"radiusSetting":{"$ref":"#/components/schemas/RadiusAuthSettingOpenApiVO"},"nameLockSetting":{"$ref":"#/components/schemas/LockSettingOpenApiVO"},"ipLockSetting":{"$ref":"#/components/schemas/LockSettingOpenApiVO"},"exitAtIdle":{"type":"boolean","description":"Whether to exit when idle."},"exitTime":{"type":"integer","description":"Exit time should be within the range of 5–3600(s). It is required when parameter [exitAtIdle] is true.","format":"int32"},"totalTraffic":{"type":"boolean","description":"Whether to proxy all traffic."},"vpnUserList":{"type":"array","description":"VPN user id list.","items":{"type":"string","description":"VPN user id list."}},"featureDescription":{"type":"array","description":"Gateway Feature Description.","items":{"$ref":"#/components/schemas/FeatureInfoVO"}}}},"OperationResponseVpnClientDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VpnClientDetailVO"}}},"VpnClientDetailVO":{"type":"object","properties":{"id":{"type":"string","description":"ID of the VPN."},"name":{"type":"string","description":"VPN name."},"status":{"type":"boolean","description":"Status of the VPN."},"vpnType":{"type":"integer","description":"Client Vpn type. 0: L2TP; 1: PPTP; 3: OpenVPN; 4: WireGuard.","format":"int32"},"wans":{"type":"array","description":"WAN port ID.","items":{"type":"string","description":"WAN port ID."}},"setup":{"type":"integer","description":"Wire Guard setup should be a value as follows: 0: file; 1: manual.","format":"int32"},"mtu":{"type":"integer","description":"The MTU of WireGuard VPN should be within the range of 576-1440.","format":"int32"},"keepAlive":{"type":"integer","description":"The keepalive second of WireGuard peer should be within the range of 0-65535.","format":"int32"},"privateKey":{"type":"string","description":"The private key of WireGuard VPN must have 44 character of base64 and end with '='."},"publicKey":{"type":"string","description":"The public key of WireGuard VPN must have 44 character of base64 and end with '='."},"serverPublicKey":{"type":"string","description":"The public key of WireGuard VPN must have 44 character of base64 and end with '='."},"tunnelIp":{"type":"string","description":"The local IP address of WireGuard VPN."},"remoteIp":{"type":"string","description":"Remote IP of the VPN."},"remoteSubnet":{"type":"array","description":"Remote subnet of the VPN.","items":{"type":"string","description":"Remote subnet of the VPN."}},"servicePort":{"type":"integer","description":"Service port for VPN server.","format":"int32"},"clientPort":{"type":"integer","description":"Client port for VPN client.","format":"int32"},"dns1":{"type":"string","description":"Primary DNS of the VPN."},"dns2":{"type":"string","description":"Secondary DNS of the VPN."},"networkType":{"type":"integer","description":"Network type. 0: network list; 1: custom networks.","format":"int32"},"networkList":{"type":"array","description":"Network list of the VPN. ","items":{"type":"string","description":"Network list of the VPN. "}},"customNetwork":{"type":"array","description":"Custom networks of the VPN.","items":{"$ref":"#/components/schemas/VpnIPSubnetsOpenApiVO"}},"openVpnMode":{"type":"integer","description":"OpenVPN mode should be a value as follows: 0: certification; 1: certification+account.","format":"int32"},"preSharedKey":{"type":"string","description":"Pre-shared key of the VPN."},"encryption":{"type":"integer","description":"Encryption should be a value as follows: 0: Encrypted; 1: Unencrypted.","format":"int32"},"workingMode":{"type":"integer","description":"Working mode should be a value as follows: 0: NAT; 1: Routing.","format":"int32"},"clientUsername":{"type":"string","description":"Client username should contain 1 to 64 characters."},"clientPassword":{"type":"string","description":"Client password should contain 1 to 64 characters."},"vpnConfiguration":{"$ref":"#/components/schemas/VpnCertificateOpenApiVO"},"allowedServerAddress":{"type":"array","description":"Wire Guard allowed server address.","items":{"type":"string","description":"Wire Guard allowed server address."}},"featureDescription":{"type":"array","description":"Gateway Feature Description","items":{"$ref":"#/components/schemas/FeatureInfoVO"}}}},"GridVOTopologyDeviceClient":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TopologyDeviceClient"}}}},"OperationResponseGridVOTopologyDeviceClient":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOTopologyDeviceClient"}}},"TopologyDeviceClient":{"type":"object","properties":{"mac":{"type":"string","description":"Device or Client MAC address, like AA-BB-CC-DD-EE-FF."},"name":{"type":"string","description":"Device or Client Name."},"ip":{"type":"string","description":"Device or Client Ip."},"model":{"type":"string","description":"Device model."},"showModel":{"type":"string","description":"Device model."},"modelVersion":{"type":"string","description":"Device model version."},"specialModel":{"type":"string","description":"Special device model,for example:EAP225-Outdoor-1a20a950b8d950e8"},"type":{"type":"string","description":"Type of Device"},"stackGroup":{"type":"boolean","description":"Whether this node is stack or not"},"omadaDeviceType":{"type":"string","description":"Type of omada device when it's type is other in topology"},"uplinkMac":{"type":"string","description":"Uplink Device MAC address of client."},"groupType":{"type":"integer","description":"Topology group type of client, 0：clientGroup  1：cameraGroup","format":"int32"},"isClient":{"type":"boolean","description":"Whether this entry is a client"},"deviceType":{"type":"string","description":"Type of Client"}},"description":"Device or Client In Topology."},"OperationResponseListTopologyRoot":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/TopologyRoot"}}}},"TopologyRoot":{"type":"object","properties":{"type":{"type":"string","description":"Root Node Type, which can only be one of the following three types: switch, olt and other."},"specificType":{"type":"integer","description":"MultiSwitch Node SpecificType, which can only be one of the following two types: 0:Mlag and 1:Vrrp.","format":"int32"},"name":{"type":"string","description":"Root Node name."},"nameList":{"type":"array","description":"MultiSwitch Node name list.","items":{"type":"string","description":"MultiSwitch Node name list."}},"mac":{"type":"string","description":"Root Node MAC address, like AA-BB-CC-DD-EE-FF."},"macList":{"type":"array","description":"MultiSwitch Node MAC list.","items":{"type":"string","description":"MultiSwitch Node MAC list."}},"model":{"type":"string","description":"Root Node Model."},"modelVersion":{"type":"string","description":"Root Node ModelVersion."},"showModel":{"type":"string","description":"Root Node ShowModel."},"isRoot":{"type":"boolean","description":"Whether the Node is root."},"stackGroup":{"type":"boolean","description":"Whether the Node is stackGroup."},"clientType":{"type":"string","description":"Specific type of other node when it is a client."},"omadaDeviceType":{"type":"string","description":"Specific type of other node when it is a omada device."}},"description":"Root Node In Topology."},"OperationResponseTopologyIsolatedAndPreConfigDevice":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/TopologyIsolatedAndPreConfigDevice"}}},"TopologyBriefDevice":{"type":"object","properties":{"type":{"type":"string","description":"Device type."},"mac":{"type":"string","description":"Device mac."},"name":{"type":"string","description":"Device name."},"model":{"type":"string","description":"Device model."},"modelVersion":{"type":"string","description":"Device modelVersion."},"healthScore":{"type":"integer","description":"Device healthScore.","format":"int32"},"ippt":{"type":"boolean","description":"Odu device in ippt mode or not."}},"description":"Brief device information."},"TopologyIsolatedAndPreConfigDevice":{"type":"object","properties":{"isolated":{"type":"array","description":"Isolated devices.","items":{"$ref":"#/components/schemas/TopologyBriefDevice"}},"preconfig":{"type":"array","description":"PreConfig devices.","items":{"$ref":"#/components/schemas/TopologyBriefDevice"}},"total":{"type":"integer","description":"Total number of devices.","format":"int32"}},"description":"Isolated and preConfig devices."},"OperationResponseListTopologyClient":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/TopologyClient"}}}},"TopologyClient":{"type":"object","properties":{"mac":{"type":"string","description":"Client MAC address, like AA-BB-CC-DD-EE-FF."},"name":{"type":"string","description":"Client name."},"wireless":{"type":"boolean","description":"Whether the client is wireless."},"uplinkSwitchInfo":{"$ref":"#/components/schemas/TopologyClientUplinkSwitchInfo"},"uplinkApInfo":{"$ref":"#/components/schemas/TopologyClientUplinkApInfo"},"uplinkGatewayInfo":{"$ref":"#/components/schemas/TopologyClientUplinkGatewayInfo"},"guest":{"type":"boolean","description":"Whether the client is a guest."},"type":{"type":"string","description":"Client Type."}},"description":"Client In Topology."},"TopologyClientUplinkApInfo":{"type":"object","properties":{"channel":{"type":"integer","description":"Channel, only for wireless connection.","format":"int32"},"ssid":{"type":"string","description":"Ssid, only for wireless connection."},"radio":{"type":"integer","description":"Radio, it should be a value as follows: 0:2G, 1:5G, 2:5G2, 3:6G, only for wireless connection.","format":"int32"},"linkSpeed":{"type":"integer","description":"Link Speed, it should be a value as follows: 1:10Mbps, 2:100Mbps, 3:1000Mbps, 4:2.5Gbps, 5:10Gbps, only for wired connection.","format":"int32"},"support5g2":{"type":"boolean","description":"Whether the device supports the 5G2 frequency band."},"duplex":{"type":"integer","description":"Duplex, it should be a value as follows: 1:Half Duplex, 2:Full Duplex, only for wired connection.","format":"int32"}},"description":"Uplink Information while Uplink Device is Ap."},"TopologyClientUplinkGatewayInfo":{"type":"object","properties":{"port":{"$ref":"#/components/schemas/TopologyClientUplinkGatewayPortInfo"},"linkSpeed":{"type":"integer","description":"Link Speed, it should be a value as follows: 1:10Mbps, 2:100Mbps, 3:1000Mbps, 4:2.5Gbps, 5:10Gbps, 6:5Gbps, 7:25Gbps.","format":"int32"},"duplex":{"type":"integer","description":"Duplex, it should be a value as follows: 1:Half Duplex.","format":"int32"},"channel":{"type":"integer","description":"Channel, only for wireless router.","format":"int32"},"ssid":{"type":"string","description":"Ssid, only for wireless router"},"radio":{"type":"integer","description":"Radio, it should be a value as follows: 0:2G, 1:5G, 2:5G2, 3:6G, only for wireless router","format":"int32"},"support5g2":{"type":"boolean","description":"Whether the device supports the 5G2 frequency band, only for wireless router."}},"description":"Uplink Information while Uplink Device is Gateway."},"TopologyClientUplinkGatewayPortInfo":{"type":"object","properties":{"port":{"type":"integer","description":"Port Number.","format":"int32"}},"description":"Uplink Port Information while Uplink Device is Gateway."},"TopologyClientUplinkSwitchInfo":{"type":"object","properties":{"port":{"$ref":"#/components/schemas/TopologyClientUplinkSwitchPortInfo"},"linkSpeed":{"type":"integer","description":"Link Speed, it should be a value as follows: 1:10Mbps, 2:100Mbps, 3:1000Mbps, 4:2.5Gbps, 5:10Gbps, 6:5Gbps, 7:25Gbps.","format":"int32"},"duplex":{"type":"integer","description":"Duplex, it should be a value as follows: 1:Half Duplex.","format":"int32"}},"description":"Uplink Information while Uplink Device is Switch."},"TopologyClientUplinkSwitchPortInfo":{"type":"object","properties":{"port":{"type":"integer","description":"Real Port Number or Port Number of Lag.","format":"int32"},"standardPort":{"type":"string","description":"Standard Port of Stack, for Uplink Device is Stack."},"lagId":{"type":"integer","description":"Lag Id.","format":"int32"},"lagPort":{"type":"array","description":"Lag Ports.","items":{"type":"integer","description":"Lag Ports.","format":"int32"}}},"description":"Uplink Port Information while Uplink Device is Switch."},"OperationResponseListTopologyClientNode":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/TopologyClientNode"}}}},"OperationResponseTopology Available Network And SSID":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Topology Available Network and SSID"}}},"Topology Available Network and SSID":{"type":"object","properties":{"splitNetworks":{"type":"array","description":"Networks split by vlan.","items":{"$ref":"#/components/schemas/TopologySplitWiredNetwork"}},"ssids":{"type":"array","description":"SSID List.","items":{"$ref":"#/components/schemas/TopologySSID"}}},"description":"Available Network split by vlan and ssids."},"TopologySSID":{"type":"object","properties":{"id":{"type":"string","description":"SSID ID."},"name":{"type":"string","description":"SSID Name."},"wlanName":{"type":"string","description":"WLAN group name"},"vlanEnable":{"type":"boolean","description":"Whether enable vlan."},"vlanIds":{"type":"array","description":"Vlan IDs.","items":{"type":"integer","description":"Vlan IDs.","format":"int32"}},"configuring":{"type":"boolean","description":"Whether SSID is configuring."},"clientNum":{"type":"integer","description":"Client Num.","format":"int32"}},"description":"SSID."},"TopologySplitWiredNetwork":{"type":"object","properties":{"id":{"type":"string","description":"Network ID."},"name":{"type":"string","description":"Network Name."},"vlanId":{"type":"integer","description":"Vlan ID.","format":"int32"},"defaultNetwork":{"type":"boolean","description":"Whether network is default."},"configuring":{"type":"boolean","description":"Whether network is configuring."}},"description":"Network split by vlan."},"LogNotificationOpenApiVO":{"type":"object","properties":{"key":{"type":"string","description":"Log Notification Key","example":"LOGIN_OK"},"shortMsg":{"type":"string","description":"Log Notification Short Message","example":"User Logged In"},"alert":{"type":"boolean","description":"Log Notification Enable or Disable Alert","example":false},"event":{"type":"boolean","description":"Log Notification Enable or Disable Event","example":true},"email":{"type":"boolean","description":"Log Notification Enable or Disable Email","example":true},"webhook":{"type":"boolean","description":"Log Notification Enable or Disable Webhook (This config applies to the Omada Pro Controller only)","example":false}},"description":"Log Notification List"},"LogNotificationSettingOpenApiVO":{"type":"object","properties":{"webhookConfig":{"$ref":"#/components/schemas/WebhookConfigOpenApiVO"},"logNotifications":{"type":"array","description":"Log Notification List","items":{"$ref":"#/components/schemas/LogNotificationOpenApiVO"}},"alertEmailSetting":{"$ref":"#/components/schemas/LogAlertEmailOpenApiVO"}}},"OperationResponseLogNotificationSettingOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/LogNotificationSettingOpenApiVO"}}},"WebhookConfigOpenApiVO":{"type":"object","properties":{"webhookEnable":{"type":"boolean","description":"Audit or Omada Log Notification Enable for Disable Webhook","example":false},"webhookId":{"type":"string","description":"Webhook ID"}},"description":"Log Notification Webhook Config (This config applies to the Omada Pro Controller only)"},"ApBtDetailOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device mac."},"name":{"type":"string","description":"Device name."},"type":{"type":"integer","description":"Device type.","format":"int32","deprecated":true},"showModel":{"type":"string","description":"Device show model."},"firmwareVersion":{"type":"string","description":"Device firmware version."},"statusCategory":{"type":"integer","description":"Device status.","format":"int32"},"deviceType":{"type":"string","description":"Device type."}},"description":"Detailed information about the devices bound to this configuration."},"GridVOIotBtIbeaconOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/IotBtIbeaconOpenApiVO"}}}},"IotBtIbeaconOpenApiVO":{"required":["name"],"type":"object","properties":{"id":{"type":"string","description":"The Bluetooth Advertising entry ID."},"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"The Bluetooth Advertising seting name."},"boundDeviceNum":{"type":"integer","description":"The quantity of devices bound to this configuration.","format":"int32"},"macList":{"type":"array","description":"List of device MAC addresses bound to this configuration.","items":{"type":"string","description":"List of device MAC addresses bound to this configuration."}},"enable":{"type":"boolean","description":"Whether to enable the Bluetooth Advertising setting."},"transmitPower":{"type":"integer","description":"Broadcast transmission power.<br />The parameter [transmitPower] should be a value as follows:[-20, -18, -15, -12, -10, -9, -6, -5, -3, 0, 1, 2, 3, 4, 5, 14, 15, 16, 17, 18, 19, 20]","format":"int32","deprecated":true},"measurePower":{"type":"integer","description":"RSSI Calibration Value. The parameter [measurePower] is used to input the RSSI measured at a 1-meter distance from the device, enabling positioning functionality.","format":"int32"},"advInterval":{"type":"integer","description":"Advertising interval.","format":"int32"},"uuid":{"type":"string","description":"The UUID (Universally Unique Identifier) of the advertising ibeacon packet."},"major":{"type":"string","description":"The major value of adverting ibeacon packet, indicating a larger group."},"minor":{"type":"string","description":"The minor value of adverting ibeacon packet, indicating a smaller group."},"selectMacInfo":{"type":"array","description":"Detailed information about the devices bound to this configuration.","items":{"$ref":"#/components/schemas/ApBtDetailOpenApiVO"}},"buildIn":{"type":"integer","description":"Whether it is a built-in configuration: [0:true; 1:false].","format":"int32"}}},"Ap Brief Info":{"type":"object","properties":{"mac":{"type":"string","description":"Device MAC, e.g. 00-00-FF-FF-0C-E9"},"name":{"type":"string","description":"Device name"},"ip":{"type":"string","description":"Device IP"},"statusCategory":{"type":"integer","description":"Device status should be a value as follows: 0: Disconnected; 1: Connected; 2: Pending; 3: Heartbeat Missed; 4: Isolated","format":"int32"},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected;1:Disconnected(Migrating);10:Provisioning;11:Configuring;12:Upgrading;13:Rebooting;14:Connected;15:Connected(Wireless);16:Connected(Migrating);17:Connected(Wireless,Migrating);20:Pending;21:Pending(Wireless);22:Adopting;23:Adopting(Wireless);24:Adopt Failed;25:Adopt Failed(Wireless);26:Managed By Others;27:Managed By Others(Wireless);30:Heartbeat Missed;31:Heartbeat Missed(Wireless);32:Heartbeat Missed(Migrating);33:Heartbeat Missed(Wireless,Migrating);40:Isolated;41:Isolated(Migrating);50:Slice Configuring","format":"int32"},"model":{"type":"string","description":"Device model name, such as EAP225."},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"type":{"type":"string","description":"Device type"},"showModel":{"type":"string","description":"Device model name with version, such as EAP225(EU) v3.0."},"specialModel":{"type":"string","description":"Special device model,for example:EAP225-Outdoor-1a20a950b8d950e8"},"active":{"type":"boolean","description":"Mark whether the device is activated: When license (specific to cloud base) is false, the status column shows the pre-bound status. When it is true or null, the status column displays as it originally did."},"supportLockToAp":{"type":"boolean","description":"Whether the device support function [Lock to ap]."}}},"OperationResponseListAp Brief Info":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/Ap Brief Info"}}}},"GridVOLanProfileInfoOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/LanProfileInfoOpenApiVO"}}}},"LanProfileInfoOpenApiVO":{"required":["bandWidthCtrlType","dot1x","lldpMedEnable","loopbackDetectEnable","name","networkTagsSetting","poe","portIsolationEnable","spanningTreeEnable","vlanConfigEnable"],"type":"object","properties":{"id":{"type":"string","description":"LAN profile ID"},"flag":{"type":"integer","description":"Flag should be a value as follows: 0: default(all,disable,LAN), 1: native(generated by creating LAN network), 2: customize(created by users)","format":"int32"},"prohibitModify":{"type":"boolean","description":"Marks profiles that cannot be modified"},"vlanConfigEnable":{"type":"boolean","description":"Vlan configuration enable status"},"networkTagsSetting":{"type":"integer","description":"network Tags configuration mode should be a value as follows: 0:allow all, 1:block all, 2:custom","format":"int32"},"nativeNetworkId":{"type":"string","description":"Native Network ID, Native Network cannot be selected from Tagged Networks or Untagged Networks."},"nativeBridgeVlan":{"type":"integer","description":"Native Network Bridge Vlan.","format":"int32"},"tagNetworkIds":{"type":"array","description":"Tag Network IDs","items":{"type":"string","description":"Tag Network IDs"}},"tagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Tag Network Bridge Vlan Map","items":{"type":"integer","description":"Tag Network Bridge Vlan Map","format":"int32"}},"description":"Tag Network Bridge Vlan Map"},"untagNetworkIds":{"type":"array","description":"Untag Network IDs","items":{"type":"string","description":"Untag Network IDs"}},"untagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Untag Network Bridge Vlan Map","items":{"type":"integer","description":"Untag Network Bridge Vlan Map","format":"int32"}},"description":"Untag Network Bridge Vlan Map"},"voiceNetworkEnable":{"type":"boolean","description":"Indicates whether voice network is enabled"},"voiceNetworkId":{"type":"string","description":"Voice Network ID"},"voiceBridgeVlan":{"type":"integer","description":"Voice Network Bridge Vlan","format":"int32"},"voiceDscpEnable":{"type":"boolean","description":"Indicates whether voice DSCP is enabled"},"voiceDscp":{"type":"integer","description":"Voice DSCP","format":"int32"},"esEnable":{"type":"boolean","description":"ES enable status"},"esTaggedModified":{"type":"boolean","description":"Indicates whether ES Tagged is modified"},"esEnableTaggedNetworkIds":{"type":"array","description":"ES enable tagged network ids","items":{"type":"string","description":"ES enable tagged network ids"}},"esEnableTagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Es enable tagged bridge vlan map","items":{"type":"integer","description":"Es enable tagged bridge vlan map","format":"int32"}},"description":"Es enable tagged bridge vlan map"},"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Name should contain 1 to 128 characters."},"poe":{"type":"integer","description":"PoE should be a value as follows: 0: off, 1: on, 2: \"do not modify\"","format":"int32"},"dot1x":{"type":"integer","description":"Dot1x should be a value as follows: 0: force unauthorized, 1: force authorized, 2:auto","format":"int32"},"portIsolationEnable":{"type":"boolean","description":"Port-isolation enable status"},"lldpMedEnable":{"type":"boolean","description":"LLDP-MED enable status"},"topoNotifyEnable":{"type":"boolean","description":"TopoNotify enable status"},"bandWidthCtrlType":{"type":"integer","description":"BandWidthCtrlType should be a value as follows: 0: off, 1: rate limit, 2: storming control","format":"int32"},"stormCtrl":{"$ref":"#/components/schemas/StormCtrlVO"},"bandCtrl":{"$ref":"#/components/schemas/BandCtrlVO"},"spanningTreeEnable":{"type":"boolean","description":"SpanningTree enable status"},"spanningTreeSetting":{"$ref":"#/components/schemas/SpanningTreeSettingVO"},"loopbackDetectEnable":{"type":"boolean","description":"LoopbackDetect enable status"},"eeeEnable":{"type":"boolean","description":"EEE enable status"},"flowControlEnable":{"type":"boolean","description":"FlowControl enable status"},"loopbackDetectVlanBasedEnable":{"type":"boolean","description":"LoopbackDetectVLANBased enable status"},"igmpFastLeaveEnable":{"type":"boolean","description":"Indicates whether igmp fast leave is enabled"},"mldFastLeaveEnable":{"type":"boolean","description":"Indicates whether mld fast leave is enabled"},"dhcpL2RelaySettings":{"$ref":"#/components/schemas/DhcpL2RelayVO"},"fastLeaveEnable":{"type":"boolean","description":"IGMP Snooping fast leave enable status"},"dot1pPriority":{"type":"integer","description":"802.1p Priority","format":"int32"},"trustMode":{"type":"integer","description":"Trust mode","format":"int32"},"type":{"type":"integer","description":"Type should be a value as follows: 0: LAN profile-ALL, 1: LAN profile-Disable, 2: LAN Profile except ALL and Disable","format":"int32"},"createByNewUI":{"type":"boolean","description":"Mark whether the profile is created by the new UI"},"resource":{"type":"integer","description":"resource","format":"int32"}}},"OperationResponseGridVOLanProfileInfoOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOLanProfileInfoOpenApiVO"}}},"LanNetworkOpenApiV2GridVOLanNetworkQueryOpenApiV2VO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/LanNetworkQueryOpenApiV2VO"}},"supportMultiVlan":{"type":"boolean","description":"Whether multi vlan configuration is supported of the lan netowrk."},"supportRA":{"type":"boolean","description":"Whether Router Advertisement configuration is supported of the lan netowrk."},"supportCustomDhcpOption":{"type":"boolean","description":"Whether custom DHCP option configuration is supported of the lan netowrk."},"supportDhcpNextServer":{"type":"boolean","description":"Whether DHCP Next Server is supported of the lan network."},"supportArpDetection":{"type":"boolean","description":"Whether ARP Detection is supported of the lan network."},"dhcpRangePoolSize":{"type":"integer","description":"The size of DHCP range pool supported by the lan network DHCP.","format":"int32"}}},"LanNetworkQueryOpenApiV2VO":{"required":["igmpSnoopEnable","name","purpose"],"type":"object","properties":{"id":{"type":"string","description":"LAN network ID"},"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"LAN network name should contain 1 to 128 characters."},"purpose":{"type":"integer","description":"LAN network purpose should be a value as follows: 0: VLAN; 1: interface","format":"int32"},"interfaceIds":{"type":"array","description":"Gateway LAN port IDs (acquired from \"Check WAN/LAN status\")","items":{"type":"string","description":"Gateway LAN port IDs (acquired from \"Check WAN/LAN status\")"}},"vlanType":{"type":"integer","description":"When purpose is interface, VLANType should be a value as follows: 0: Single; 1: Multiple","format":"int32"},"vlans":{"pattern":"^[\\d|\\d-\\d]+(,[\\d|\\d-\\d]+)*$","type":"string","description":"When purpose is interface and VLANType is 1, batch create VLANs. VLAN format: 200, 1-100."},"vlan":{"type":"integer","description":"Only Valid when vlanType is 0. Vlan should be within the range of 1-4094.","format":"int32"},"application":{"type":"integer","description":"Effective device type should be a value as follows: 0: Gateway and Switch; 1: Switch","format":"int32"},"gatewaySubnet":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])/(\\d|((1|2)\\d)|(30))\\b","type":"string","description":"When purpose is interface, gateway subnet is needed. Format: IP/Mask"},"dhcpSettingsVO":{"$ref":"#/components/schemas/DhcpSettingInfo"},"domain":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"The domain of this network"},"igmpSnoopEnable":{"type":"boolean","description":"Enable IGMP snooping"},"mldSnoopEnable":{"type":"boolean","description":"Enable MLD snooping"},"dhcpL2RelayEnable":{"type":"boolean","description":"The switch of DHCP L2 relay"},"dhcpGuard":{"$ref":"#/components/schemas/Dhcp Servers setting"},"dhcpv6Guard":{"$ref":"#/components/schemas/Dhcpv6 Servers setting"},"portal":{"type":"boolean","description":"Show portal is enabled or not"},"portalId":{"type":"string","description":"Show portal ID"},"portalName":{"type":"string","description":"Show related portal name"},"accessControlRule":{"type":"boolean","description":"Show AccessControlRule is enabled or not"},"rateLimit":{"type":"boolean","description":"Show RateLimit is enabled or not"},"lanNeworkIpv6Config":{"$ref":"#/components/schemas/Lan network IPV6 config"},"allLan":{"type":"boolean","description":"When Internet pre-config is closed or Internet pre-config is Universal, allLAN is \"true\"; after adopting gateway, allLAN is \"false\"."},"existMultiVlan":{"type":"boolean","description":"Whether VLAN Type is Multiple."},"existRA":{"type":"boolean","description":"Whether RA has been configured."},"existCustomDhcpOption":{"type":"boolean","description":"Whether custom DHCP Options has been configured."},"existDhcpNextServer":{"type":"boolean","description":"Whether DHCP Next Server has been configured."},"existArpDetection":{"type":"boolean","description":"Whether Arp Detection is configured."},"primary":{"type":"boolean","description":"Primary"}},"description":"LANNetworkQueryOpenApiVO"},"OperationResponseLanNetworkOpenApiV2GridVOLanNetworkQueryOpenApiV2VO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/LanNetworkOpenApiV2GridVOLanNetworkQueryOpenApiV2VO"}}},"OperationResponseResponseDataVOLanNetworkQueryOpenApiV2VO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ResponseDataVOLanNetworkQueryOpenApiV2VO"}}},"ResponseDataVOLanNetworkQueryOpenApiV2VO":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LanNetworkQueryOpenApiV2VO"}}}},"OperationResponseSsidDeviceOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SsidDeviceOpenApiVO"}}},"SsidDeviceOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Device ID"},"mac":{"type":"string","description":"Device MAC address"},"name":{"type":"string","description":"Device name"},"model":{"type":"string","description":"Device model"},"modelVersion":{"type":"string","description":"Device model version"},"apGroupName":{"type":"string","description":"AP Group Name"},"apGroupId":{"type":"string","description":"apGroupId"},"clientNum":{"type":"integer","description":"number of clients connected to Device","format":"int64"},"traffic":{"type":"integer","description":"total traffic of Device","format":"int64"},"deviceType":{"type":"string","description":"Device type, such as EAP, Gateway"},"ip":{"type":"string","description":"Ip address,such as 192.168.0.105"},"showModel":{"type":"string","description":"Model complex shown in the front end.Ap：model+(country)+modelVersion,EAP225(EU) v3.0  Gateway/Switch：model+modelVersion,Osg v3.0"},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected;1:Disconnected(Migrating);10:Provisioning;11:Configuring;12:Upgrading;13:Rebooting;14:Connected;15:Connected(Wireless);16:Connected(Migrating);17:Connected(Wireless,Migrating);20:Pending;21:Pending(Wireless);22:Adopting;23:Adopting(Wireless);24:Adopt Failed;25:Adopt Failed(Wireless);26:Managed By Others;27:Managed By Others(Wireless);30:Heartbeat Missed;31:Heartbeat Missed(Wireless);32:Heartbeat Missed(Migrating);33:Heartbeat Missed(Wireless,Migrating);40:Isolated;41:Isolated(Migrating);50:Slice Configuring","format":"int32"},"statusCategory":{"type":"integer","description":"Category of device status,statusCategory should be a value as follows: 0:Disconnected;1:Connected;2:Pending;3:Heartbeat Missed;4:Isolated","format":"int32"},"overrideNum":{"type":"integer","description":"Override ssid number for AP","format":"int32"}}},"OperationResponseListTopologyV3OpenApiNodeVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/TopologyV3OpenApiNodeVO"}}}},"ActiveDevice":{"type":"object","properties":{"status":{"type":"integer","description":"Status should be a value as follows: 0: Connected; 1: Disconnected.","format":"int32"},"name":{"type":"string","description":"Device name"},"traffic":{"type":"number","description":"Traffic measured in GB","format":"double"},"mac":{"type":"string","description":"Device MAC address, linked to the device details page"},"model":{"type":"string","description":"Device model, such as EAP620 HD"},"modelVersion":{"type":"string","description":"Model version, such as 3.0"}},"description":"Most Active APs devices by traffic"},"GetActiveDeviceV2OpenApiVO":{"type":"object","properties":{"activeAps":{"type":"array","description":"Most Active APs devices by traffic","items":{"$ref":"#/components/schemas/ActiveDevice"}},"totalTraffic":{"type":"number","description":"The sum of the traffic of all AP devices under the site","format":"double"}}},"OperationResponseGetActiveDeviceV2OpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GetActiveDeviceV2OpenApiVO"}}},"AnomalyAdviceVO":{"type":"object","properties":{"contentParams":{"type":"object","additionalProperties":{"type":"string","description":"Content parameter map for rendering the advice content template."},"description":"Content parameter map for rendering the advice content template."},"devices":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DeviceObjectDTO"},"description":"Device objects map used by this advice. Key is MAC address, value is device info."},"helpful":{"type":"integer","description":"Whether the advice is helpful. 0: Not set, 1: Helpful, 2: Not helpful.","format":"int32"}}},"AnomalyBriefCountVO":{"type":"object","properties":{"anomalyCode":{"type":"string","description":"For the values of Anomaly event code, refer to section 5.7.2.1 of the Open API Access","example":"01001001"},"category":{"type":"integer","description":"Anomaly category. 11: Network, 12: Device, 13: Client, etc.","format":"int32"},"incidentId":{"type":"string","description":"Incident ID"},"level":{"type":"integer","description":"Anomaly severity level","format":"int32"},"lastTime":{"type":"integer","description":"Last occurrence timestamp (ms)","format":"int64"},"count":{"type":"integer","description":"Total occurrence count","format":"int32"},"object":{"type":"array","description":"List of affected device MAC addresses","items":{"type":"string","description":"List of affected device MAC addresses"}},"macs":{"type":"array","description":"List of affected device MAC addresses","items":{"type":"string","description":"List of affected device MAC addresses"}},"titleParams":{"type":"object","additionalProperties":{"type":"string","description":"Title parameters for anomaly message"},"description":"Title parameters for anomaly message"},"contentParams":{"type":"object","additionalProperties":{"type":"string","description":"Content parameters for anomaly message"},"description":"Content parameters for anomaly message"},"devices":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DeviceObjectDTO"},"description":"Device objects map, key is MAC address"},"clients":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ClientObjectDTO"},"description":"Client objects map, key is MAC address"},"causes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnomalyCauseVO"},"description":"Root cause information map"},"influencingDevices":{"type":"array","description":"List of influenced device MAC addresses","items":{"type":"string","description":"List of influenced device MAC addresses"}},"influencingClients":{"type":"array","description":"List of influenced client MAC addresses","items":{"type":"string","description":"List of influenced client MAC addresses"}},"status":{"type":"integer","description":"Anomaly incident status (0=unresolved, 1=resolved, 2=ignored, 3=ongoing)","format":"int32"}},"description":"Anomaly brief information with count for device/client health view"},"AnomalyCauseVO":{"type":"object","properties":{"titleParams":{"type":"object","additionalProperties":{"type":"string"}},"contentParams":{"type":"object","additionalProperties":{"type":"string"}},"detail":{"type":"object","additionalProperties":{"type":"object"}},"devices":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DeviceObjectDTO"}},"clients":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ClientObjectDTO"}},"advices":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnomalyAdviceVO"}}},"description":"Root cause information map"},"ChannelSubHealthInfoDetailVO":{"type":"object","properties":{"summaryScore":{"type":"integer","description":"Sub dimension health score","format":"int32"},"support":{"type":"boolean","description":"Sub dimension support"},"incidents":{"type":"array","description":"Incident information for this health dimension, null if no incidents","items":{"$ref":"#/components/schemas/AnomalyBriefCountVO"}},"averageNum2g":{"type":"integer","description":"Average value of 2g channel","format":"int32"},"averageNum5g":{"type":"integer","description":"Average value of 5g channel","format":"int32"},"averageNum6g":{"type":"integer","description":"Average value of 6g channel","format":"int32"},"pastNums2g":{"type":"array","description":"List of 2g channel value","items":{"$ref":"#/components/schemas/TimeValueItemVO"}},"pastNums5g":{"type":"array","description":"List of 5g channel value","items":{"$ref":"#/components/schemas/TimeValueItemVO"}},"pastNums6g":{"type":"array","description":"List of 6g channel value","items":{"$ref":"#/components/schemas/TimeValueItemVO"}}},"description":"Rssi health info and score"},"ClientDataRateSubHealthDetailVO":{"type":"object","properties":{"summaryScore":{"type":"integer","description":"Sub dimension health score","format":"int32"},"support":{"type":"boolean","description":"Sub dimension support"},"incidents":{"type":"array","description":"Incident information for this health dimension, null if no incidents","items":{"$ref":"#/components/schemas/AnomalyBriefCountVO"}},"averageTxRate":{"type":"integer","format":"int64"},"averageRxRate":{"type":"integer","format":"int64"},"pastTxRate":{"type":"array","items":{"$ref":"#/components/schemas/LongTimeValueItemVO"}},"pastRxRate":{"type":"array","items":{"$ref":"#/components/schemas/LongTimeValueItemVO"}}},"description":"Negotiation rate health info and score"},"ClientHealthDetailV2VO":{"type":"object","properties":{"score":{"type":"integer","format":"int32"},"onboardingTime":{"$ref":"#/components/schemas/OnBoardingTimeSubHealthDetailVO"},"bandRssi":{"$ref":"#/components/schemas/ChannelSubHealthInfoDetailVO"},"dataRate":{"$ref":"#/components/schemas/ClientDataRateSubHealthDetailVO"},"snr":{"$ref":"#/components/schemas/CommonSubHealthInfoDetailVO"},"connectScore":{"$ref":"#/components/schemas/ConnectScoreSubHealthInfoDetailVO"},"linkErrorScore":{"$ref":"#/components/schemas/CommonSubHealthInfoDetailVO"},"incident":{"$ref":"#/components/schemas/IncidentSubHealthInfoDetailVO"}}},"ClientObjectDTO":{"type":"object","properties":{"name":{"type":"string","description":"Client Name, alias."},"deviceType":{"type":"string","description":"Client type: iPhone, iPod, Android, PC, printer, TV..."},"manager":{"type":"boolean","description":"Whether it is the client currently being managed."},"ip":{"type":"string","description":"Client IP address."},"radioId":{"type":"integer","description":"(Wireless) Radio ID should be a value as follows: 0: 2.4GHz; 1: 5GHz-1; 2:5GHz-2; 3: 6GHz.","format":"int32"},"port":{"type":"integer","description":"(Wired) Port ID.","format":"int32"},"model":{"type":"string","description":"Client model."},"ssid":{"type":"string","description":"(Wireless)  SSID name."}}},"CommonSubHealthInfoDetailVO":{"type":"object","properties":{"summaryScore":{"type":"integer","description":"Sub dimension health score","format":"int32"},"support":{"type":"boolean","description":"Sub dimension support"},"incidents":{"type":"array","description":"Incident information for this health dimension, null if no incidents","items":{"$ref":"#/components/schemas/AnomalyBriefCountVO"}},"averageNum":{"type":"integer","description":"Average value of common dimension, such as cpu、memory","format":"int32"},"pastNums":{"type":"array","description":"List of common dimension value , such as cpu、memory","items":{"$ref":"#/components/schemas/TimeValueItemVO"}}},"description":"Link error score health info and score (wired clients only)"},"ConnectScoreSubHealthInfoDetailVO":{"type":"object","properties":{"summaryScore":{"type":"integer","description":"Sub dimension health score","format":"int32"},"support":{"type":"boolean","description":"Sub dimension support"},"incidents":{"type":"array","description":"Incident information for this health dimension, null if no incidents","items":{"$ref":"#/components/schemas/AnomalyBriefCountVO"}},"connectStatus":{"type":"integer","description":"Connect status of the wired client","format":"int32"}},"description":"Connect score and status (wired clients only)"},"DeviceObjectDTO":{"type":"object","properties":{"name":{"type":"string","description":"Default uses the MAC address as the name."},"type":{"type":"string","description":"Device type:ap、gateway、switch、olt."},"model":{"type":"string","description":"Device model, such as EAP225."},"modelVersion":{"type":"string","description":"Model version of device, for example:3.0."},"ip":{"type":"string","description":"Ip address,such as 192.168.0.105."},"portNum":{"type":"integer","description":"Number of ports. ","format":"int32"},"lagPortsMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Switch LAG ports map. Key is LAG ID, value is member port set.","items":{"type":"integer","description":"Switch LAG ports map. Key is LAG ID, value is member port set.","format":"int32"}},"description":"Switch LAG ports map. Key is LAG ID, value is member port set."},"supportAnomaly":{"type":"boolean","description":"Whether the device firmware support intelligent anomaly detection."},"support5g":{"type":"boolean","description":"Whether the device supports 5 GHz radio."},"support5g2":{"type":"boolean","description":"Whether the device supports 5 GHZ-2 radio."},"support6g":{"type":"boolean","description":"Whether the device supports 6 GHz radio."},"apTempThresholds":{"type":"array","description":"AP temperature thresholds.","items":{"type":"integer","description":"AP temperature thresholds.","format":"int32"}},"oswCpuTempThreshold":{"type":"integer","description":"Switch CPU temperature threshold.","format":"int32"},"oswMacTempThreshold":{"type":"integer","description":"Switch MAC chip temperature threshold.","format":"int32"},"oswPseTempThreshold":{"type":"integer","description":"Switch PSE temperature threshold.","format":"int32"},"oswPhyTempThreshold":{"type":"integer","description":"Switch PHY temperature threshold.","format":"int32"},"osgTempThreshold":{"type":"integer","description":"Gateway temperature threshold.","format":"int32"},"radio2gEnable":{"type":"boolean","description":"Whether 2.4 GHz radio is enabled."},"radio5gEnable":{"type":"boolean","description":"Whether 5 GHz radio is enabled."},"radio5g2Enable":{"type":"boolean","description":"Whether 5 GHz-2 radio is enabled."},"radio6gEnable":{"type":"boolean","description":"Whether 6 GHz radio is enabled."},"filledTempThreshold":{"type":"boolean","description":"Whether temperature threshold fields have been filled."},"deviceSeriesType":{"type":"integer","description":"Device series type. 0: Advanced, 1: Pro.","format":"int32"}},"description":"Device objects map used by this advice. Key is MAC address, value is device info."},"IncidentSubHealthInfoDetailVO":{"type":"object","properties":{"summaryScore":{"type":"integer","description":"Sub dimension health score","format":"int32"},"support":{"type":"boolean","description":"Sub dimension support"},"incidents":{"type":"array","description":"Incident information for this health dimension, null if no incidents","items":{"$ref":"#/components/schemas/AnomalyBriefCountVO"}},"incidentNum":{"type":"integer","description":"Number of incident","format":"int32"}},"description":"Incident health info and score (wireless clients only)"},"LongTimeValueItemVO":{"type":"object","properties":{"time":{"type":"integer","description":"Time(unit:ms)","format":"int64"},"pastNum":{"type":"integer","description":"Value corresponding to time (Long type)","format":"int64"}}},"OnBoardingTimeSubHealthDetailVO":{"type":"object","properties":{"summaryScore":{"type":"integer","description":"Sub dimension health score","format":"int32"},"support":{"type":"boolean","description":"Sub dimension support"},"incidents":{"type":"array","description":"Incident information for this health dimension, null if no incidents","items":{"$ref":"#/components/schemas/AnomalyBriefCountVO"}},"assocTime":{"type":"array","description":"Client association cost time list.","items":{"$ref":"#/components/schemas/TimeValueItemVO"}},"authTime":{"type":"array","description":"Client authorization cost time list.","items":{"$ref":"#/components/schemas/TimeValueItemVO"}},"dhcpTime":{"type":"array","description":"Client DHCP cost time list.","items":{"$ref":"#/components/schemas/TimeValueItemVO"}},"dnsTime":{"type":"array","description":"Client dns cost time list.","items":{"$ref":"#/components/schemas/TimeValueItemVO"}},"averageAssocTime":{"type":"integer","description":"Average association time.","format":"int32"},"averageAuthTime":{"type":"integer","description":"Average authorization time.","format":"int32"},"averageDhcpTime":{"type":"integer","description":"Average DHCP time.","format":"int32"},"averageDnsTime":{"type":"integer","description":"Average DNS time.","format":"int32"}},"description":"Onboarding time health info and score"},"OperationResponseClientHealthDetailV2VO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ClientHealthDetailV2VO"}}},"TimeValueItemVO":{"type":"object","properties":{"time":{"type":"integer","description":"Time(unit:ms)","format":"int64"},"pastNum":{"type":"integer","description":"Value corresponding to time","format":"int32"}},"description":"List of common dimension value , such as cpu、memory"},"ApRFScanResult":{"type":"object","properties":{"channel2g":{"type":"array","description":"Channel 2g","items":{"$ref":"#/components/schemas/RFScanRadio2g"}},"channel5g":{"type":"array","description":"Channel 5g","items":{"$ref":"#/components/schemas/RFScanRadio5g"}},"channel5g2":{"type":"array","description":"Channel 5g2","items":{"$ref":"#/components/schemas/RFScanRadio5g2"}},"channel6g":{"type":"array","description":"Channel 6g","items":{"$ref":"#/components/schemas/RFScanRadio6g"}},"currentChan2g":{"type":"string","description":"The 2G channel of AP, such as 1,6,11,13. It should be within the range of 1–13."},"currentChan5g":{"type":"string","description":"The 5G channel of AP, such as 36,161. It should be within the range of 36–161."},"currentChan5g2":{"type":"string","description":"The 5G2 channel of AP,such as 36,161. It should be within the range of 36–161."},"currentChan6g":{"type":"string","description":"The 6G channel of AP,such as 36,161. It should be within the range of 36–161."},"currentChanW2g":{"type":"integer","description":"The 2g channel bandwidth of the AP. It should be a value as follows: 2:20MHz, 3: 40MHz","format":"int32"},"currentChanW5g":{"type":"integer","description":"The 5g channel bandwidth of the AP. It should be a value as follows: 2:20MHz, 3: 40MHz, 5: 80MHz2 menas 20MHz, 3 means 40MHz, 5 means 80MHz","format":"int32"},"currentChanW5g2":{"type":"integer","description":"The 5g2 channel bandwidth of the AP. It should be a value as follows: 2:20MHz, 3: 40MHz, 5: 80MHz","format":"int32"},"currentChanW6g":{"type":"integer","description":"The 6g channel bandwidth of the AP. It should be a value as follows: 2:20MHz, 3: 40MHz, 5: 80MHz","format":"int32"},"time":{"type":"integer","description":"The scan time(13 bits), Unit: ms","format":"int64"},"time2g":{"type":"integer","description":"The scan time(13 bits) of 5GHz-2 band, Unit: ms","format":"int64"},"time5g":{"type":"integer","description":"The scan time(13 bits) of 5GHz band, Unit: ms","format":"int64"},"time6g":{"type":"integer","description":"The scan time(13 bits) of 6GHz band, Unit: ms","format":"int64"},"status":{"type":"integer","description":"Status should be a value as follows: 0: the scan result is displayed; 1: no scan result; 2: Scanning","format":"int32"},"status2g":{"type":"integer","description":"Status of 2.4GHz band should be a value as follows: 0: the scan result is displayed; 1: no scan result; 2: Scanning","format":"int32"},"status5g":{"type":"integer","description":"Status of 5GHz band should be a value as follows: 0: the scan result is displayed; 1: no scan result; 2: Scanning","format":"int32"},"status5g2":{"type":"integer","description":"Status of 5GHz-2 band should be a value as follows: 0: the scan result is displayed; 1: no scan result; 2: Scanning","format":"int32"},"status6g":{"type":"integer","description":"Status of 6GHz band should be a value as follows: 0: the scan result is displayed; 1: no scan result; 2: Scanning","format":"int32"}}},"Interference":{"type":"object","properties":{"inf":{"type":"integer","description":"Interference should be within the range of -96 ~ -48","format":"int32"},"infType":{"type":"integer","description":"Interference Type should be a value as follows: 0: invalid parameter; 1: MWO; 2: CW; 3: WLAN; 4: FHSS.","format":"int32"},"infData":{"$ref":"#/components/schemas/Interference data entity"}},"description":"At most two types of interference data are reported in Inter, sorted in descending order of interference intensity"},"Interference data entity":{"type":"object","properties":{"str":{"type":"array","description":"Interference strength, range [-91, -89, -87, …., -33, -31, -29] (up to 32 strength levels), for example: -91 means the range is -92-90.","items":{"type":"integer","description":"Interference strength, range [-91, -89, -87, …., -33, -31, -29] (up to 32 strength levels), for example: -91 means the range is -92-90.","format":"int32"}},"cnt":{"type":"array","description":"interference counts, range [0, 200]","items":{"type":"integer","description":"interference counts, range [0, 200]","format":"int32"}}},"description":"Interference data, the data refer to the interference intensity and the times of interferences, and they are used to create histograms."},"OperationResponseApRFScanResult":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApRFScanResult"}}},"RFScanRadio2g":{"type":"object","properties":{"chan":{"type":"integer","description":"Channel number","format":"int32"},"chanWidth":{"type":"integer","description":"ChanWidth should be a value as follows: 2: 20MHz, 3: 40MHz, 5: 80MHz","format":"int32"},"util":{"type":"integer","description":"Channel utilization should be within the range of 0–100.","format":"int32"},"inter":{"type":"array","description":"At most two types of interference data are reported in Inter, sorted in descending order of interference intensity","items":{"$ref":"#/components/schemas/Interference"}}},"description":"Channel 2g"},"RFScanRadio5g":{"type":"object","properties":{"chan":{"type":"integer","description":"Channel number","format":"int32"},"chanWidth":{"type":"integer","description":"ChanWidth should be a value as follows: 2: 20MHz, 3: 40MHz, 5: 80MHz","format":"int32"},"util":{"type":"integer","description":"Channel utilization should be within the range of 0–100.","format":"int32"},"inter":{"type":"array","description":"At most two types of interference data are reported in Inter, sorted in descending order of interference intensity","items":{"$ref":"#/components/schemas/Interference"}}},"description":"Channel 5g"},"RFScanRadio5g2":{"type":"object","properties":{"chan":{"type":"integer","description":"Channel number","format":"int32"},"chanWidth":{"type":"integer","description":"ChanWidth should be a value as follows: 2: 20MHz, 3: 40MHz, 5: 80MHz","format":"int32"},"util":{"type":"integer","description":"Channel utilization should be within the range of 0–100.","format":"int32"},"inter":{"type":"array","description":"At most two types of interference data are reported in Inter, sorted in descending order of interference intensity","items":{"$ref":"#/components/schemas/Interference"}}},"description":"Channel 5g2"},"RFScanRadio6g":{"type":"object","properties":{"chan":{"type":"integer","description":"Channel number","format":"int32"},"chanWidth":{"type":"integer","description":"ChanWidth should be a value as follows: 2: 20MHz, 3: 40MHz, 5: 80MHz","format":"int32"},"util":{"type":"integer","description":"Channel utilization should be within the range of 0–100.","format":"int32"},"inter":{"type":"array","description":"At most two types of interference data are reported in Inter, sorted in descending order of interference intensity","items":{"$ref":"#/components/schemas/Interference"}}},"description":"Channel 6g"},"ApSsidWlansOpenApiV2VO":{"required":["ssidOverrides"],"type":"object","properties":{"ssidOverrides":{"type":"array","description":"SsidOverride Config List","items":{"$ref":"#/components/schemas/SsidOverrideConfigOpenApiV2VO"}},"apGroupId":{"type":"string","description":"AP Group Id"},"apGroupName":{"type":"string","description":"AP Group Name"}}},"OperationResponseApSsidWlansOpenApiV2VO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApSsidWlansOpenApiV2VO"}}},"SsidOverrideConfigOpenApiV2VO":{"required":["ssidId","ssidName"],"type":"object","properties":{"ssidId":{"type":"string","description":"SSID ID"},"ssidEntryId":{"type":"integer","description":"SSID Entry ID","format":"int32"},"ssidName":{"type":"string","description":"SSID name. It should contain 1 to 32 UTF-8 characters."},"ssidPassword":{"type":"string","description":"SSID password. It should contain 8-63 printable ASCII characters or 8-63 hexadecimal digits."},"band":{"type":"array","description":"SSID band should be a value as follows: 0: 2.4GHz; 1: 5GHz; 2: 6GHz","items":{"type":"integer","description":"SSID band should be a value as follows: 0: 2.4GHz; 1: 5GHz; 2: 6GHz","format":"int32"}},"security":{"type":"integer","description":"SSID security mode should be a value as follows: 0: None; 2: WPA-Enterprise; 3: WPA-Personal;4: PPSK without RADIUS; 5: PPSK with RADIUS.","format":"int32"},"vlanEnable":{"type":"boolean","description":"Enable/disable VLAN"},"vlanId":{"type":"integer","description":"VLAN ID","format":"int32"},"vlanPoolIds":{"type":"string","description":"VLAN POOL IDS"},"ssidEnable":{"type":"boolean","description":"Enable/disable SSID"}},"description":"SsidOverride Config List"},"OperationResponseListWebhookSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/WebhookSetting"}}}},"WebhookSetting":{"type":"object","properties":{"name":{"type":"string","description":"Webhook Name"},"urlNum":{"type":"integer","description":"Webhook URL Number","format":"int32"},"urlList":{"type":"array","description":"Webhook URL List","items":{"type":"string","description":"Webhook URL List"}},"webhookId":{"type":"string","description":"Webhook ID"},"shardedSecret":{"type":"string","description":"Webhook Sharded Secret (old token)"},"lastTime":{"type":"integer","description":"Webhook setting last update time (ms)","format":"int64"},"retryPolicy":{"type":"integer","description":"Webhook retry policy. It should be a value as follows: 0:None, 1:Important (Up to 5 retries over 60 minutes), 2:Critical (Up to 5 retries over 24 hours)","format":"int32"},"template":{"type":"integer","description":"Webhook template, it should be a value as follow: 0:Omada template, 1:Google chat template. Example: 0. ","format":"int32"}}},"GridVOOpenApiWebhookDispatchLogVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OpenApiWebhookDispatchLogVO"}}}},"OpenApiDispatchLogDetailVO":{"type":"object","properties":{"headers":{"type":"string","description":"Http Headers of Webhook Push"},"content":{"type":"string","description":"Webhook Push Content"},"attemptNumber":{"type":"integer","description":"Webhook Attempt Number","format":"int32"}},"description":"Dispatch Log Detail"},"OpenApiWebhookAttemptMessageVO":{"type":"object","properties":{"status":{"type":"integer","description":"Webhook Attempt Push Status: 0/1 (Success/Failed)","format":"int32"},"messageCode":{"type":"integer","description":"Http Message Code of Webhook Attempt Push","format":"int32"},"attemptTime":{"type":"integer","description":"Webhook Attempt Push Time, Unit (ms)","format":"int64"}},"description":"Attempt Message of Dispatch Log Detail"},"OpenApiWebhookDispatchLogVO":{"type":"object","properties":{"dispatchMessage":{"$ref":"#/components/schemas/OpenApiWebhookLogMessageVO"},"dispatchDetail":{"$ref":"#/components/schemas/OpenApiDispatchLogDetailVO"},"attemptMessages":{"type":"array","description":"Attempt Message of Dispatch Log Detail","items":{"$ref":"#/components/schemas/OpenApiWebhookAttemptMessageVO"}}}},"OpenApiWebhookLogMessageVO":{"type":"object","properties":{"url":{"type":"string","description":"Webhook URL"},"webhookMessage":{"$ref":"#/components/schemas/OpenApiWebhookMessageVO"},"dispatchTime":{"type":"integer","description":"Webhook Dispatch Log Time, Unit (ms)","format":"int64"}},"description":"Dispatch Log Message"},"OpenApiWebhookMessageVO":{"type":"object","properties":{"status":{"type":"integer","description":"Webhook Push Status. It should be a value as follows: 0: Success; 1: Failed","format":"int32"},"messageCode":{"type":"integer","description":"Http Message Code of Webhook Push","format":"int32"}},"description":"Webhook Message"},"OperationResponseGridVOOpenApiWebhookDispatchLogVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOpenApiWebhookDispatchLogVO"}}},"GridVOUserDetailVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UserDetailVO"}}}},"OperationResponseGridVOUserDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOUserDetailVO"}}},"UserDetailVO":{"type":"object","properties":{"id":{"type":"string","description":"User ID"},"type":{"type":"integer","description":"Type of user, type should be a value as follows: 0:local user; 1: cloud user","format":"int32"},"roleId":{"type":"string","description":"User role ID"},"roleName":{"type":"string","description":"User bind role name"},"name":{"type":"string","description":"User name"},"email":{"type":"string","description":"User email"},"omadacId":{"type":"string","description":"Omada ID"},"verified":{"type":"boolean","description":"Whether this cloud user has verified"},"showTree":{"type":"boolean","description":"Whether this user has Sub-users."},"alert":{"type":"boolean","description":"Whether this user wants to receive alert, event, and incident emails. Make sure your email is not null."},"allSite":{"type":"boolean","description":"Whether user has all site permission, including new created site"},"siteIds":{"uniqueItems":true,"type":"array","description":"User site privilege list","items":{"type":"string","description":"User site privilege list"}},"parentUserId":{"type":"string","description":"User's parent user id"},"favorites":{"type":"array","description":"User favorite site list","items":{"type":"string","description":"User favorite site list"}},"incidentNotification":{"type":"boolean","description":"Incident notification, this field is deprecated, please use alert field instead.","deprecated":true},"userLevel":{"type":"integer","description":"User level, user level should be a value as follows: 0:standard user; 1:customer user; 2:msp user","format":"int32"},"temporaryEnable":{"type":"boolean","description":"Whether the user wants to enable the temporary worker permission"},"startTime":{"type":"integer","description":"The start time of the user's validity period. time range: start timestamp (Millisecond).","format":"int64"},"endTime":{"type":"integer","description":"The end time of the user's validity period. time range: end timestamp (Millisecond).","format":"int64"},"temporaryValidity":{"type":"integer","description":"Whether the temporary user is still valid","format":"int32"}}},"OperationResponseUserDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/UserDetailVO"}}},"GetUserListResponseVO":{"type":"object","properties":{"users":{"type":"array","description":"User list","items":{"$ref":"#/components/schemas/UserBriefVO"}}}},"OperationResponseGetUserListResponseVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GetUserListResponseVO"}}},"UserBriefVO":{"type":"object","properties":{"userId":{"type":"string","description":"User ID."},"name":{"type":"string","description":"User name."},"temporaryEnable":{"type":"boolean","description":"Temporary enable."}},"description":"User list"},"GridVOPlanUpgradeModelList":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PlanUpgradeModelList"}}}},"OperationResponseGridVOPlanUpgradeModelList":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOPlanUpgradeModelList"}}},"PlanUpgradeModelList":{"type":"object","properties":{"modelTypeInfo":{"$ref":"#/components/schemas/ModelTypeInfoOpenApiVO"},"currentVersion":{"type":"array","description":"Model version list, software version, such as \"2.5.0 Build 20190118 Rel. 64821\"","items":{"type":"string","description":"Model version list, software version, such as \"2.5.0 Build 20190118 Rel. 64821\""}},"status":{"type":"integer","description":"Model critical status should be a value as follows: 0: good; 1: critical","format":"int32"},"upgradeStatus":{"type":"integer","description":"Model upgrade status should be a value as follows: 0: up-to-date; 1: new Version Available","format":"int32"}}},"OperationResponseUpgradeSettingTryBeta":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/UpgradeSettingTryBeta"}}},"OperationResponseUpgradeSettingTryBetaChannel":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/UpgradeSettingTryBetaChannel"}}},"GridVOPlanUpgradeInfo":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PlanUpgradeInfo"}}}},"OperationResponseGridVOPlanUpgradeInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOPlanUpgradeInfo"}}},"PlanUpgradeInfo":{"type":"object","properties":{"id":{"type":"string","description":"ID."},"modelTypeInfo":{"$ref":"#/components/schemas/ModelTypeInfoOpenApiVO"},"siteNames":{"type":"array","description":"Site names where the model is located.","items":{"type":"string","description":"Site names where the model is located."}},"siteNum":{"type":"integer","description":"Number of sites where the model is located.","format":"int32"},"currentVersion":{"type":"array","description":"Current version number.","items":{"type":"string","description":"Current version number."}},"targetVersion":{"type":"string","description":"Target upgrade version."},"scheduledUpgradeTime":{"type":"string","description":"Plan upgrade time."},"operator":{"type":"string","description":"operator."},"fromRollback":{"type":"boolean","description":"Is it from rollback?"}}},"OperationResponseUpgradeSettingEmailReminder":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/UpgradeSettingEmailReminder"}}},"GridVOUpgradeLogOpenApiInfo":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UpgradeLogOpenApiInfo"}}}},"OperationResponseGridVOUpgradeLogOpenApiInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOUpgradeLogOpenApiInfo"}}},"UpgradeLogOpenApiInfo":{"type":"object","properties":{"id":{"type":"string","description":"Upgrade log ID."},"modelTypeInfo":{"$ref":"#/components/schemas/ModelTypeInfoOpenApiVO"},"siteNames":{"type":"array","description":"The siteName lists where the model belongs.","items":{"type":"string","description":"The siteName lists where the model belongs."}},"siteNum":{"type":"integer","description":"Number of sites where the model belongs.","format":"int32"},"currentVersion":{"type":"array","description":"Model firmware version list before upgrade ,such as \"[2.5.0 Build 20190118 Rel. 64821, 2.4.8 Build 20190118 Rel. 64821]\". This field is the same as \"PREVIOUS VERSION\" in Controller Upgrade Logs","items":{"type":"string","description":"Model firmware version list before upgrade ,such as \"[2.5.0 Build 20190118 Rel. 64821, 2.4.8 Build 20190118 Rel. 64821]\". This field is the same as \"PREVIOUS VERSION\" in Controller Upgrade Logs"}},"targetVersion":{"type":"string","description":"Model firmware version after device upgrade, such as \"2.5.1 Build 20190118 Rel. 64821\". This field is the same as \"CURRENT VERSION\" in Controller Upgrade Logs"},"upgradeTime":{"type":"string","description":"The time when the upgrade is complete."},"operator":{"type":"string","description":"Operator."},"rollbacked":{"type":"boolean","description":"Whether the log is rolled back or not. The logs that are rolled back cannot be rolled back repeatedly."},"failedDeviceNum":{"type":"integer","description":"The number of devices that failed to upgrade in this upgrade plan.","format":"int32"}}},"ModelFirmwarePoolGridInfoModelLatestFwInfo":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ModelLatestFwInfo"}},"fwNum":{"type":"object","additionalProperties":{"type":"integer","description":"The firmware quantity map for each channel: The key is channel: (0: stable; 1: Release Candidate(RC); 2: Beta), The Value is the quantity","format":"int32"},"description":"The firmware quantity map for each channel: The key is channel: (0: stable; 1: Release Candidate(RC); 2: Beta), The Value is the quantity"}}},"ModelLatestFwInfo":{"type":"object","properties":{"id":{"type":"string","description":"ID"},"modelTypeInfo":{"$ref":"#/components/schemas/ModelTypeInfoOpenApiVO"},"latestVersion":{"type":"string","description":"Latest version"},"releaseTime":{"type":"integer","description":"Latest version release time, timestamp ms","format":"int64"}}},"OperationResponseModelFirmwarePoolGridInfoModelLatestFwInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ModelFirmwarePoolGridInfoModelLatestFwInfo"}}},"CriticalModelNum":{"type":"object","properties":{"criticalNumber":{"type":"integer","description":"Number of critical models","format":"int32"}}},"OperationResponseCriticalModelNum":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CriticalModelNum"}}},"FirmwareInfo":{"type":"object","properties":{"id":{"type":"string","description":"ID"},"name":{"type":"string","description":"File name"},"modelTypeInfo":{"$ref":"#/components/schemas/ModelTypeInfoOpenApiVO"},"uploadTime":{"type":"integer","description":"Uploaded timestamp (ms)","format":"int64"},"description":{"type":"string","description":"Description of firmware"}}},"GridVOFirmwareInfo":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/FirmwareInfo"}}}},"OperationResponseGridVOFirmwareInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOFirmwareInfo"}}},"AllTargetSites":{"type":"object","properties":{"targetSites":{"type":"array","items":{"$ref":"#/components/schemas/SiteBasicInfo"}}}},"OperationResponseAllTargetSites":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AllTargetSites"}}},"AutoCheckUpgradeInfo":{"type":"object","properties":{"id":{"type":"string","description":"ID"},"modelTypeInfos":{"type":"array","description":"List of model type selected by the user","items":{"$ref":"#/components/schemas/ModelTypeInfoOpenApiVO"}},"siteNames":{"type":"array","description":"The siteNames lists selected by the user","items":{"type":"string","description":"The siteNames lists selected by the user"}},"siteNum":{"type":"integer","description":"Number of sites selected by the user","format":"int32"},"autoCheckTime":{"type":"string","description":"Next execution time"},"channel":{"type":"integer","description":"Channel should be a value as follows: 0: stable; 1: Release Candidate(RC); 2: Beta","format":"int32"},"occurrence":{"$ref":"#/components/schemas/UpgradeBaseScheduleTimeOpenApiVO"}}},"GridVOAutoCheckUpgradeInfo":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AutoCheckUpgradeInfo"}}}},"OperationResponseGridVOAutoCheckUpgradeInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOAutoCheckUpgradeInfo"}}},"OperationResponseUnplaced SitesUnplaced Site":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/unplaced sitesUnplaced Site"}}},"unplaced site":{"type":"object","properties":{"region":{"type":"string","description":"site region"},"id":{"type":"string","description":"site id"},"name":{"type":"string","description":"site name"},"type":{"type":"integer","description":"site type. 0:advanced ; 1:pro","format":"int32"}}},"unplaced sitesUnplaced Site":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/unplaced site"}},"unplacedNum":{"type":"integer","description":"unplaced site number","format":"int64"}}},"Controller Status":{"type":"object","properties":{"name":{"type":"string","description":"Controller Name"},"macAddress":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"MAC address, should be a valid MAC address format, e.g. AA-BB-CC-DD-11-22"},"timeZone":{"type":"string","description":"For the values of timeZone, refer to section 5.1 of the Open API Access Guide."},"systemTime":{"type":"integer","description":"System time","format":"int64"},"upTime":{"type":"integer","description":"Up time (unit: s)","format":"int64"},"controllerVersion":{"type":"string","description":"Controller version"},"category":{"type":"string","description":"Category should be a value as follows: localPro; local; advanced; pro."},"model":{"type":"string","description":"Controller Model"},"firmwareVersion":{"type":"string","description":"Firmware Version"},"hwcStorage":{"type":"array","description":"Hardware Storage","items":{"$ref":"#/components/schemas/Disk Condition"}},"deviceCapacity":{"$ref":"#/components/schemas/Device Capacity"},"sn":{"type":"string","description":"Device serial number"},"areaInfo":{"type":"string","description":"Storage area information"},"informUrl":{"type":"string","description":"Inform URL"},"controllerType":{"type":"integer","description":"Controller type should be a value as follows: 0: Windows; 1: Linux; 10: OC200; 11: OC300; 12: ER7212PC; 13: OC400; 20: CBC.","format":"int32"}}},"Device Capacity":{"type":"object","properties":{"adoptedApNum":{"type":"integer","description":"Adopted AP num of controller","format":"int32"},"apCapacity":{"type":"integer","description":"Ap capacity of controller ","format":"int32"},"adoptedOswNum":{"type":"integer","description":"Adopted switch num of controller","format":"int32"},"oswCapacity":{"type":"integer","description":"Switch capacity of controller","format":"int32"},"adoptedOsgNum":{"type":"integer","description":"Adopted gateway num of controller","format":"int32"},"osgCapacity":{"type":"integer","description":"Gateway capacity of controller","format":"int32"}},"description":"Device capacity"},"Disk Condition":{"type":"object","properties":{"name":{"type":"string","description":"Disk condition name"},"totalStorage":{"type":"number","description":"Total storage of disk","format":"double"},"usedStorage":{"type":"number","description":"Used storage of disk","format":"double"},"ocStorage":{"type":"boolean","description":"OC storage of disk"}},"description":"Hardware Storage"},"OperationResponseController Status":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Controller Status"}}},"GridVOIdpMetadataDetailOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/IdpMetadataDetailOpenApiVO"}}}},"IdpMetadataDetailOpenApiVO":{"type":"object","properties":{"idpId":{"type":"string","description":"IdP ID(resource ID)."},"name":{"type":"string","description":"IdP name."},"description":{"type":"string","description":"Description."},"entityId":{"type":"string","description":"The IdP entity ID which must be unique in same Omadac."},"loginUrl":{"type":"string","description":"Login url."},"x509Certificate":{"type":"string","description":"BASE64 encoded string of x509 certificate."},"entityUrl":{"type":"string","description":"Entity url."},"signOnUrl":{"type":"string","description":"Sign On url."}}},"OperationResponseGridVOIdpMetadataDetailOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOIdpMetadataDetailOpenApiVO"}}},"ExternalUserDetailOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"External user ID."},"name":{"type":"string","description":"External user name."},"idpId":{"type":"string","description":"The ID of IdP which is used by this user."},"idpName":{"type":"string","description":"The name of IdP which is used by this user."},"roleId":{"type":"string","description":"The ID of role which is used by this user."},"roleName":{"type":"string","description":"The name of role which is used by this user."},"privilege":{"$ref":"#/components/schemas/PrivilegeOpenApiVO"},"temporaryEnable":{"type":"boolean","description":"Whether the user wants to enable the temporary worker permission"},"startTime":{"type":"integer","description":"The start time of the user's validity period. time range: start timestamp (Millisecond).","format":"int64"},"endTime":{"type":"integer","description":"The end time of the user's validity period. time range: end timestamp (Millisecond).","format":"int64"},"temporaryValidity":{"type":"integer","description":"Whether the temporary user is still valid","format":"int32"}}},"GridVOExternalUserDetailOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExternalUserDetailOpenApiVO"}}}},"OperationResponseGridVOExternalUserDetailOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOExternalUserDetailOpenApiVO"}}},"PrivilegeOpenApiVO":{"type":"object","properties":{"all":{"type":"boolean","description":"Whether having all site privilege."},"sites":{"uniqueItems":true,"type":"array","description":"The IDs of site that can be accessed by this user.","items":{"type":"string","description":"The IDs of site that can be accessed by this user."}}},"description":"The site's privilege of this user."},"ExternalUserGroupDetailOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"External user group ID."},"name":{"type":"string","description":"External user group name."},"roleId":{"type":"string","description":"Role ID."},"roleName":{"type":"string","description":"Role name."},"roleType":{"type":"integer","description":"Role type. It should be a value as follows: 0: standard, 1: customer, 2: msp.","format":"int32"},"allSite":{"type":"boolean","description":"Whether having all site permissions."},"sites":{"type":"array","description":"The sites which can be accessed.","items":{"$ref":"#/components/schemas/SiteInfoOpenApiVO"}},"temporaryEnable":{"type":"boolean","description":"Whether the user wants to enable the temporary worker permissione"},"startTime":{"type":"integer","description":"The start time of the user's validity period. time range: start timestamp (Millisecond).","format":"int64"},"endTime":{"type":"integer","description":"The end time of the user's validity period. time range: end timestamp (Millisecond).","format":"int64"},"temporaryValidity":{"type":"integer","description":"Whether the temporary user is still valid","format":"int32"}}},"GridVOExternalUserGroupDetailOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExternalUserGroupDetailOpenApiVO"}}}},"OperationResponseGridVOExternalUserGroupDetailOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOExternalUserGroupDetailOpenApiVO"}}},"SiteInfoOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Site ID"},"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,62}[^ ]$","type":"string","description":"Site name should contain 0 to 64 characters."}},"description":"The sites which can be accessed."},"GridVOSiteTemplateSummaryVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SiteTemplateSummaryVO"}}}},"OperationResponseGridVOSiteTemplateSummaryVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOSiteTemplateSummaryVO"}}},"SiteTemplateSummaryVO":{"type":"object","properties":{"id":{"type":"string","description":"Site Template ID"},"omadacId":{"type":"string","description":"Omada ID"},"name":{"type":"string","description":"Name of the site should contain 1 to 64 characters."},"status":{"type":"integer","description":"Site template sync sites status.","format":"int32"},"bindSiteNum":{"type":"integer","description":"The number of sites to which the template is bound.","format":"int64"},"category":{"type":"string","description":"The category of the site template.","deprecated":true},"type":{"type":"integer","description":"The type should be a value as follows: 0:basic; 1:pro.","format":"int32"},"settings":{"type":"array","description":"The settings of site template seleted.","items":{"type":"string","description":"The settings of site template seleted."}}}},"OperationResponseSiteTemplateBriefOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteTemplateBriefOpenApiVO"}}},"SiteTemplateBriefOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Site Template ID"},"omadacId":{"type":"string","description":"Omada ID"},"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,62}[^ ]$","type":"string","description":"Name of the site template should contain 1 to 64 characters."},"category":{"type":"string","description":"The category of the site template","deprecated":true},"type":{"type":"integer","description":"The type should be a value as follows: 0:basic; 1:pro.","format":"int32"},"settings":{"type":"array","description":"The settings of the site template.","items":{"type":"string","description":"The settings of the site template."}}}},"OperationResponseListWlanGroupOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/WlanGroupOpenApiVO"}}}},"OperationResponseSsidDetailOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SsidDetailOpenApiVO"}}},"SsidDetailOpenApiVO":{"type":"object","properties":{"ssidId":{"type":"string","description":"SSID ID, kept for backward compatibility and equivalent to id. This field will be removed in a future release; use id instead.","deprecated":true},"id":{"type":"string","description":"SSID ID"},"name":{"type":"string","description":"SSID name. It should contain 1 to 32 UTF-8 characters."},"band":{"type":"integer","description":"SSID band. The lowest bit indicates whether 2.4G is included; the second lowest bit indicates whether 5G is included; the third lowest bit indicates whether 6G is included; 1 means included while 0 means not included. For example, 7(111) means that 2G/5G/6G are enabled; 1(001) means that 2G is enabled. (When 5G is included，it means 5G/5G1/5G2 are enabled.)","format":"int32"},"autoWanAccess":{"type":"boolean","description":"Whether to enable auto wan access. True: enable, false: disable."},"guestNetEnable":{"type":"boolean","description":"SSID guest network config status. True: enable, false: disable."},"security":{"type":"integer","description":"SSID security mode; Security should be a value as follows: 0: None; 2: WPA-Enterprise; 3: WPA-Personal; 4: PPSK without RADIUS; 5: PPSK with RADIUS.","format":"int32"},"oweEnable":{"type":"boolean","description":"Opportunistic Wireless Encryption, also known as Enhanced Open, is a certification provided by the Wi-Fi Alliance as part of the WPA3 wireless security standard. OWE will enable two wireless VAPs per radio, one for access of OWE-supported stations, and one for access of other stations. An SSID with OWE enabled will be counted as two SSID entries for 2G and 5G."},"broadcast":{"type":"boolean","description":"SSID broadcast config status. True: enable, false: disable."},"vlanEnable":{"type":"boolean","description":"SSID VLAN config status. True: enable, false: disable."},"vlanId":{"type":"integer","description":"SSID VLAN ID. This field is required when Parameter [vlanEnable] is true; It should be within the range of 1–4094.","format":"int32"},"hidePwd":{"type":"boolean","description":"If this field is true, the SSID password will be hidden."},"vlanSetting":{"$ref":"#/components/schemas/SsidVlanSettingOpenApiVO"},"pskSetting":{"$ref":"#/components/schemas/SsidPskSettingOpenApiVO"},"entSetting":{"$ref":"#/components/schemas/SsidEnterpriseSettingOpenApiVO"},"ppskSetting":{"$ref":"#/components/schemas/SsidPpskSettingOpenApiVO"},"mloEnable":{"type":"boolean","description":"SSID MLO config status. True: enable, false: disable."},"pmfMode":{"type":"integer","description":"SSID PMF mode. It should be a value as follows: 1: Mandatory; 2: Capable; 3: Disable.","format":"int32"},"enable11r":{"type":"boolean","description":"SSID 802.11r config status. True: enable, false: disable."},"clientRateLimit":{"$ref":"#/components/schemas/RateLimitSettingOpenApiVO"},"ssidRateLimit":{"$ref":"#/components/schemas/RateLimitSettingOpenApiVO"},"wlanSchedule":{"$ref":"#/components/schemas/SsidWlanScheduleOpenApiVO"},"rateControl":{"$ref":"#/components/schemas/SsidRateControlOpenApiVO"},"macFilter":{"$ref":"#/components/schemas/SsidMacFilterOpenApiVO"},"multiCast":{"$ref":"#/components/schemas/SsidMultiCastOpenApiVO"},"dhcpOption82":{"$ref":"#/components/schemas/SsidDhcpOptionOpenApiVO"},"deviceType":{"type":"integer","description":"SSID device type, identify which devices this SSID will take effect. The lowest bit indicates whether [EAP] is included, the second low bit indicates whether [Gateway] is included, 1 means included while 0 means not included; For example, 3(11) means that EAP/Gateway is enabled, 1(01) means that EAP is enabled.","format":"int32"},"ssidEnable":{"type":"boolean","description":"SSID enable status. True: enable, false: disable."},"chooseDevices":{"type":"integer","description":"description = select all devices or not. 0 means select all devices, 1 means not select all devices.","format":"int32"},"prohibitWifiShare":{"type":"boolean","description":"SSID prohibitWifiShare config status. True: enable, false: disable."},"hotspotV2Setting":{"$ref":"#/components/schemas/HotspotV2SettingOpenApiVO"},"wifiCallingEnable":{"type":"boolean","description":"SSID Wifi Calling config status. True: enable, false: disable."},"wifiCallingId":{"type":"string","description":"The ID of the Wi-Fi calling profile bound to the SSID. When parameter [wifiCallingEnable] is true, it should not be null."},"ssidDhcpOption":{"$ref":"#/components/schemas/BandSteerOpenApiVO"},"apGroupIds":{"type":"array","description":"List of AP Group IDs associated with this SSID","items":{"type":"string","description":"List of AP Group IDs associated with this SSID"}},"enhancedIotConnectivity":{"type":"boolean","description":"SSID Enhanced IoT Connectivity config status. True: enable, false: disable. This configuration can be enabled only when the 5GHz and 6GHz bands are disabled, the parameters [versionEnt] and [versionPsk] are not set to 4, and the following configurations are disabled: [hotspotV2Enable], [bandSteer], [arpCastEnable], [loadBalance], [enable11r], [gikRekeyPskEnable], [pmfMode], [mloEnable]."}}},"DuplicateSsidOpenApiVO":{"type":"object","properties":{"ssidNameMap":{"type":"object","additionalProperties":{"type":"integer","description":"The SSIDs that are duplicated by site","format":"int64"},"description":"The SSIDs that are duplicated by site"},"duplicateSsidNames":{"type":"array","description":"The SSID Names that are duplicated by site","items":{"type":"string","description":"The SSID Names that are duplicated by site"}},"siteId":{"type":"string","description":"The site ID"}}},"OperationResponseDuplicateSsidOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DuplicateSsidOpenApiVO"}}},"OperationResponseSsidDeviceTypeConflictOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SsidDeviceTypeConflictOpenApiVO"}}},"SsidDeviceTypeConflictOpenApiVO":{"type":"object","properties":{"deviceTypeIncompatible":{"type":"integer","description":"Compatibility result: 0 means no warning, 1 means the target SSID does not include Gateway, and 2 means the target SSID does not include AP. The target SSID with deviceType 0 is invalid.","format":"int32"}}},"DeviceTypeChangedSsidOpenApiVO":{"type":"object","properties":{"supportApSsidNames":{"type":"array","description":"The SSIDs that can still send AP after changing deviceType.","items":{"type":"string","description":"The SSIDs that can still send AP after changing deviceType."}},"noEffectDeviceNames":{"type":"array","description":"The SSIDs that do not have any effect after changing deviceType.","items":{"type":"string","description":"The SSIDs that do not have any effect after changing deviceType."}}}},"OperationResponseDeviceTypeChangedSsidOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceTypeChangedSsidOpenApiVO"}}},"OperationResponseSsidDetailResponseVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SsidDetailResponseVO"}}},"SsidDetailResponseVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SsidVO"}},"wirelessRouterSupport2g":{"type":"boolean"},"wirelessRouterSupport5g":{"type":"boolean"},"wirelessRouterSupport6g":{"type":"boolean"},"wirelessRouter":{"type":"boolean"},"gatewaySsidNum":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"gatewayMaxSsidNum":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}}},"OperationResponseWlanGroupStatusOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/WlanGroupStatusOpenApiVO"}}},"WlanGroupStatusOpenApiVO":{"type":"object","properties":{"exceeded":{"type":"boolean","description":"whether the number of WLAN groups exceeds the limit"},"wlanGroupNum":{"type":"integer","description":"the number of wlan groups","format":"int64"}}},"DisableNatDetailOpenApiVO":{"required":["interface","lanList","name","status"],"type":"object","properties":{"id":{"type":"string","description":"ID of the Disable Nat."},"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name of the Disable Nat."},"status":{"type":"boolean","description":"The Status of the Disable Nat."},"lanList":{"type":"array","description":"A list of Lan of the Disable Nat.","items":{"type":"string","description":"A list of Lan of the Disable Nat."}},"description":{"type":"string","description":"The description of the Disable Nat."},"interface":{"type":"string","description":"The wan of the Disable Nat."}}},"GridVODisableNatDetailOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DisableNatDetailOpenApiVO"}}}},"OperationResponseGridVODisableNatDetailOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVODisableNatDetailOpenApiVO"}}},"OperationResponseWanMaxSpeedOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/WanMaxSpeedOpenApiVO"}}},"WanMaxSpeedOpenApiVO":{"type":"object","properties":{"upstream":{"type":"integer","description":"upstream speed","format":"int32"},"downstream":{"type":"integer","description":"downstream speed","format":"int32"}}},"CheckWanLanStatusOpenApiVO":{"type":"object","properties":{"portName":{"type":"object","additionalProperties":{"type":"string","description":"The map of port name, key: \"port ID\", value: \"port name\""},"description":"The map of port name, key: \"port ID\", value: \"port name\""},"networkComptent":{"type":"integer","description":"NetworkComptent","format":"int32"},"adoptedGateway":{"type":"boolean","description":"Indicates whether the gateway is connected"},"supportIpv6":{"type":"integer","description":"IIndicates whether the gateway support IPv6","format":"int32"},"wanList":{"type":"array","description":"The WAN list of gateway","items":{"$ref":"#/components/schemas/wanList"}},"iptvPorts":{"type":"array","description":"IPTVPorts","items":{"type":"string","description":"IPTVPorts"}},"preOsgModel":{"type":"integer","description":"PreOSGModel","format":"int32"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"hasGateway":{"type":"boolean","description":"Whether adopt a gateway or enable WAN Settings Overrides."}}},"OperationResponseCheckWanLanStatusOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CheckWanLanStatusOpenApiVO"}}},"wanList":{"type":"object","properties":{"portId":{"type":"string","description":"Wan port ID."},"portName":{"type":"string","description":"Wan port name."},"enable":{"type":"integer","description":"IPv6 enable. 0:\"Disable\", 1:\"Enable\"","format":"int32"},"networkId":{"type":"string","description":"If networkId is not null, indicates this wan is used by specific \"Lan Network\"."},"proto":{"type":"integer","description":"IPv6 connection type of wan port. Includes: 0:\"static\", 1:\"dynamic\", 2:\"pppoe\", 3:\"6to4Tunnel\", 4:\"bridge\", 7:\"pppoa\", 8:\"ipoa\". Only type is \"bridge\", can be selected by passthrough(Lan Network mode)","format":"int32"},"pdEnable":{"type":"integer","description":"Prefix Delegation. 0:\"Disable\", 1:\"Enable\"(Default)","format":"int32"},"prefix":{"type":"string","description":"True prefix of wan port."},"pdSize":{"type":"integer","description":"Prefix size","format":"int32"}},"description":"The WAN list of gateway"},"GridVOVoipTelephoneBookSetting":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VoipTelephoneBookSetting"}}}},"OperationResponseGridVOVoipTelephoneBookSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOVoipTelephoneBookSetting"}}},"VoipTelephoneBookSetting":{"type":"object","properties":{"contactId":{"type":"string","description":"The contact ID of contact person."},"firstName":{"pattern":"^[A-Za-z0-9]{0,64}$","type":"string","description":"The firstName of contact person. It should contain 0 to 64 characters."},"lastName":{"pattern":"^[A-Za-z0-9]{0,64}$","type":"string","description":"The lastName of contact person. It should contain 0 to 64 characters."},"privatePhoneNumber":{"type":"string","description":"The privatePhoneNumber of contact person."},"workPhoneNumber":{"type":"string","description":"The workPhoneNumber of contact person."},"mobilePhoneNumber":{"type":"string","description":"The mobilePhoneNumber of contact person."},"speedDialEnable":{"type":"boolean","description":"Whether to enable the speedDial."},"speedDialNumberType":{"type":"integer","description":"speedDialNumberType should be a value as follows: 0: Private Phone Number; 1: Work Phone Number; 2: Mobile Phone Number.","format":"int32"},"speedDialNumber":{"type":"string","description":"The speedDialNumber of contact person."}}},"OperationResponseVoipCallLogEnableSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VoipCallLogEnableSetting"}}},"BookOpenApiVO":{"type":"object","properties":{"contact id":{"type":"string","description":"contact id"},"contact name":{"type":"string","description":"contact name"}},"description":"Contacts."},"CallForwardingRulesGrid":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CallForwardingRule"}},"numberList":{"type":"array","description":"Telephone numbers.","items":{"$ref":"#/components/schemas/NumberOpenApiVO"}},"deviceList":{"type":"array","description":"Telephony devices.","items":{"$ref":"#/components/schemas/DeviceOpenApiVO"}},"bookList":{"type":"array","description":"Contacts.","items":{"$ref":"#/components/schemas/BookOpenApiVO"}}}},"NumberOpenApiVO":{"type":"object","properties":{"telephone number id":{"type":"string","description":"telephone number id"},"telephone number":{"type":"string","description":"telephone number"}},"description":"Telephone numbers."},"OperationResponseCallForwardingRulesGrid":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CallForwardingRulesGrid"}}},"OperationResponseUrlFilteringOpenApiGridVOQueryUrlFilteringOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/UrlFilteringOpenApiGridVOQueryUrlFilteringOpenApiVO"}}},"QueryUrlFilteringOpenApiVO":{"required":["filterMode","name","policy","sourceIds","sourceType","status","type"],"type":"object","properties":{"id":{"type":"string","description":"ID of the URL filtering."},"index":{"type":"integer","description":"Index of the URL filtering.","format":"int32"},"type":{"pattern":"gateway|ap","type":"string","description":"Type should be a value as follows: \"gateway\"; \"ap\"."},"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name should contain 1 to 64 characters."},"status":{"type":"boolean","description":"Status of the URL filtering."},"policy":{"type":"integer","description":"Policy should be a value as follows: 0: drop; 1: allow.","format":"int32"},"sourceType":{"type":"integer","description":"Source type should be a value as follows: 0: network; 1: IP group; 2: SSID.","format":"int32"},"sourceIds":{"type":"array","description":"Source IDs of the URL filtering. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface. IP group can be created using 'Create a new group profile' interface, and IP group ID can be obtained from 'Get group profile list' interface. SSID can be created using 'Create new SSID' interface, and SSID ID can be obtained from 'Get SSID list' interface.","items":{"type":"string","description":"Source IDs of the URL filtering. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface. IP group can be created using 'Create a new group profile' interface, and IP group ID can be obtained from 'Get group profile list' interface. SSID can be created using 'Create new SSID' interface, and SSID ID can be obtained from 'Get SSID list' interface."}},"mode":{"type":"integer","description":"Mode should be a value as follows: 0: URL; 1: keyword.","format":"int32"},"urls":{"type":"array","description":"URLs of the URL filtering, eg: www.google.com.","items":{"type":"string","description":"URLs of the URL filtering, eg: www.google.com."}},"keywords":{"type":"array","description":"Keywords of the URL filtering.","items":{"type":"string","description":"Keywords of the URL filtering."}},"filterMode":{"type":"integer","description":"filterMode should be a value as follows: 0: URL; 1: category.","format":"int32"},"scenarioMode":{"type":"integer","description":"scenarioMode should be a value as follows:0: Custom  1: Family 2：Work 3：Education 4：Guest.","format":"int32"},"categories":{"type":"object","additionalProperties":{"type":"array","description":"categories of the URL filtering, TreeMap<String, List<String>> categories","items":{"type":"string","description":"categories of the URL filtering, TreeMap<String, List<String>> categories"}},"description":"categories of the URL filtering, TreeMap<String, List<String>> categories"},"timeRange":{"type":"string","description":"timeRange of the URL filtering, TimeSchedule"},"existKeyword":{"type":"boolean","description":"Whether this URL filtering is keyword mode."},"existCategory":{"type":"boolean","description":"Whether this URL filtering is category mode."},"existTimeSchedule":{"type":"boolean","description":"Whether this URL filtering contains time schedule setting."}}},"UrlFilteringOpenApiGridVOQueryUrlFilteringOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/QueryUrlFilteringOpenApiVO"}},"supportKeyword":{"type":"boolean","description":"Whether keyword is supported of the URL filtering."},"supportCategory":{"type":"boolean","description":"Whether category is supported of the URL filtering."},"supportTimeSchedule":{"type":"boolean","description":"Whether time schedule is supported of the URL filtering."}}},"OperationResponseUpnpSettingOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/UpnpSettingOpenApiVO"}}},"OperationResponseListTimeRangeProfileOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/TimeRangeProfileOpenApiVO"}}}},"TimeRangeProfileOpenApiVO":{"type":"object","properties":{"profileId":{"type":"string","description":"Time range profile ID"},"name":{"type":"string","description":"Time range profile name should contain 1 to 64 characters."},"dayMode":{"type":"integer","description":"Time range profile day mode; It should be a value as follows: 0: Every Day, 1: Weekday, 2: Weekend, 3: Customized","format":"int32"},"customDayMode":{"$ref":"#/components/schemas/CustomDayModeOpenApiVO"},"timeList":{"type":"array","description":"Time range profile schedule time config","items":{"$ref":"#/components/schemas/ScheduleTimeOpenApiVO"}}}},"OperationResponseSwitchTemplateOverviewInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SwitchTemplateOverviewInfo"}}},"PortInfo":{"required":["lagPort","name","poeMode","port","profileId","profileName","profileOverrideEnable","status"],"type":"object","properties":{"port":{"type":"integer","description":"Port ID","format":"int32"},"name":{"pattern":"^[^ ?\"]$|^[^ ?\"][^?\"]{0,126}[^ ?\"]$","type":"string","description":"Port name"},"profileId":{"type":"string","description":"Profile ID"},"profileName":{"type":"string","description":"Profile Name"},"profileOverrideEnable":{"type":"boolean","description":"Profile Override Enable"},"poeMode":{"type":"integer","description":"PoE mode should be a value as follows: 1: on(802.3at/af); 0: off.","format":"int32"},"lagPort":{"type":"boolean","description":"Whether this port exists in a LAG"},"status":{"type":"integer","description":"Status should be a value as follows: 0: off; 1: on, only when lagPort is false","format":"int32"}},"description":"Port List"},"SwitchTemplateOverviewInfo":{"type":"object","properties":{"id":{"type":"string","description":"Device templateId"},"model":{"type":"string","description":"Model"},"hwVersion":{"type":"string","description":"Hardware Version"},"portList":{"type":"array","description":"Port List","items":{"$ref":"#/components/schemas/PortInfo"}}}},"GridVOOswVrfOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OswVrfOpenApiVO"}}}},"OperationResponseGridVOOswVrfOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOswVrfOpenApiVO"}}},"OswVrfOpenApiVO":{"required":["ipv4Enable","ipv6Enable","vrf"],"type":"object","properties":{"id":{"type":"string","description":"VRF ID"},"vrf":{"pattern":"^(?!(\\.|\\.\\.)$)[a-zA-Z0-9.\\-_@+]{1,15}$","type":"string","description":"VRF name, it should be 1 to 15 characters consisting of numbers (0 to 9), uppercase and lowercase letters (A to Z, a to z), and symbols -_@.+ but cannot be . or .. only."},"ipv4Enable":{"type":"boolean","description":"Whether to enable ipv4. Ipv4Enable should be true"},"ipv6Enable":{"type":"boolean","description":"Whether to enable ipv6"},"isDefault":{"type":"boolean","description":"Indicates whether vrf is default vrf"},"resource":{"type":"integer","description":"resource is a value as follows: 0: new created; 1: from template; 2: override","format":"int32"}}},"GridVOOswNetworkBriefInfoOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OswNetworkBriefInfoOpenApiVO"}}}},"OswNetworkBriefInfoOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Network's ID"},"name":{"type":"string","description":"Network's name"},"vlan":{"type":"integer","description":"VLAN ID","format":"int32"}},"description":"OswNetworkBriefInfoOpenApiVO"},"OswPortAndLagNetworkVO":{"type":"object","properties":{"nativePorts":{"type":"array","description":"Native Vlan Port List, for example [1, 2]","items":{"type":"integer","description":"Native Vlan Port List, for example [1, 2]","format":"int32"}},"nativeStPorts":{"type":"array","description":"Native Vlan Standard Port List, for example [\"1/0/1\", \"1/0/2\"]","items":{"type":"string","description":"Native Vlan Standard Port List, for example [\"1/0/1\", \"1/0/2\"]"}},"nativeLags":{"type":"array","description":"Native Vlan Lag List, for example [1, 2]","items":{"type":"integer","description":"Native Vlan Lag List, for example [1, 2]","format":"int32"}},"tagPorts":{"type":"array","description":"Tag Vlan Port List, for example [1, 2]","items":{"type":"integer","description":"Tag Vlan Port List, for example [1, 2]","format":"int32"}},"tagStPorts":{"type":"array","description":"Tag Vlan Standard Port List, for example [\"1/0/1\", \"1/0/2\"]","items":{"type":"string","description":"Tag Vlan Standard Port List, for example [\"1/0/1\", \"1/0/2\"]"}},"tagLags":{"type":"array","description":"Tag Vlan Lag List, for example [1, 2]","items":{"type":"integer","description":"Tag Vlan Lag List, for example [1, 2]","format":"int32"}},"untagPorts":{"type":"array","description":"Untag Vlan Port List, for example [1, 2]","items":{"type":"integer","description":"Untag Vlan Port List, for example [1, 2]","format":"int32"}},"untagStPorts":{"type":"array","description":"Untag Vlan Standard Port List, for example [\"1/0/1\", \"1/0/2\"]","items":{"type":"string","description":"Untag Vlan Standard Port List, for example [\"1/0/1\", \"1/0/2\"]"}},"untagLags":{"type":"array","description":"Untag Vlan Lag List, for example [1, 2]","items":{"type":"integer","description":"Untag Vlan Lag List, for example [1, 2]","format":"int32"}},"vlan":{"type":"integer","description":"Vlan ID","format":"int32"},"ipaddr":{"type":"string","description":"IP address."},"mode":{"type":"integer","description":"Ip address mode, it should be a value as follows: 0:static 1:dynamic","format":"int32"}},"description":"OswPortAndLagNetworkVO"},"OperationResponseOswInterfaceGridOswInterfaceOpenApi":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswInterfaceGridOswInterfaceOpenApi"}}},"OswDhcpRelayVO":{"type":"object","properties":{"addr":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Address IP, like 192.168.0.1"},"serverAddrs":{"type":"array","description":"Server Address IP List, like 192.168.0.1","items":{"type":"string","description":"Server Address IP List, like 192.168.0.1"}},"vrfId":{"type":"string","description":"VRF ID"}},"description":"Network DHCP relay settings."},"OswDhcpServerRangeVO":{"required":["endIp","startIp"],"type":"object","properties":{"startIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"DHCP Range Start IP"},"endIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"DHCP Range End IP"}},"description":"The list of DHCP Range"},"OswDhcpServerVO":{"required":["leasetime","priDns"],"type":"object","properties":{"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"DHCP Server IP, like 192.168.0.1."},"netmask":{"type":"string","description":"Parameter [netmask] should be within the range of 1-31"},"range":{"type":"array","description":"The list of DHCP Range","items":{"$ref":"#/components/schemas/OswDhcpServerRangeVO"}},"priDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Primary DNS, like 192.0.0.1"},"sndDns":{"pattern":"^$|\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Second DNS, like 8.8.8.8"},"leasetime":{"type":"integer","description":"Lease time should be within the range of 2–2880","format":"int32"},"gateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Gateway IP, like 192.168.0.1"},"option138":{"pattern":"^$|\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"option138 ip, like 192.168.0.1"},"dhcpPoolMask":{"type":"integer","description":"Value of dhcp pool mask is from 1 to 31.","format":"int32"},"options":{"type":"array","description":"Custom DHCP options.","items":{"$ref":"#/components/schemas/custom DHCP Options"}},"vrfId":{"type":"string","description":"VRF ID"}},"description":"Network DHCP server settings."},"OswInterfaceGridOswInterfaceOpenApi":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OswInterfaceOpenApi"}},"supportIpv6":{"type":"boolean","description":"Switch supports ipv6 or not."}}},"OswInterfaceOpenApi":{"required":["interfaceType"],"type":"object","properties":{"interfaceType":{"type":"integer","description":"Interface type. 0: Loopback; 1: VLAN.","format":"int32"},"name":{"type":"string","description":"Interface name."},"interfaceId":{"type":"integer","description":"Interface ID.","format":"int32"},"status":{"type":"integer","description":"Interface status. 0: disable, 1: enable.","format":"int32"},"vlanInterface":{"$ref":"#/components/schemas/OswNetworkVO"},"loopbackInterface":{"$ref":"#/components/schemas/OswLoopbackInterfaceVO"}}},"OswIpSettingVO":{"required":["mode"],"type":"object","properties":{"mode":{"type":"integer","description":"IP Setting mode. Static:0, DHCP:1","format":"int32"},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Static IP for mode 0, like 192.168.0.1"},"gateway":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Gateway, like 192.168.0.1"},"netmask":{"pattern":"(254|252|248|240|224|192|128).0.0.0|255.(254|252|248|240|224|192|128|0).0.0|255.255.(254|252|248|240|224|192|128|0).0|255.255.255.(254|252|248|240|224|192|128|0)","type":"string","description":"IP Mask, like 255.255.255.0"},"preDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"primary DNS Server"},"secDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"second DNS Server"},"fallback":{"type":"boolean","description":"The switch of fallback ip for mode 1."},"fallbackIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Fallback ip for dhcp mode when fallback is enabled."},"fallbackMask":{"pattern":"(254|252|248|240|224|192|128|0).0.0.0|255.(254|252|248|240|224|192|128|0).0.0|255.255.(254|252|248|240|224|192|128|0).0|255.255.255.(254|252|248|240|224|192|128|0)","type":"string","description":"Fallback mask for dhcp mode when fallback is enabled."},"fallbackGate":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Fallback gateway for dhcp mode when fallback is enabled."},"option12":{"type":"string","description":"option12"},"useFixedAddr":{"type":"boolean","description":"The switch of Fixed Address"},"netId":{"type":"string","description":"The LAN Network for Address reservation when useFixedAddr is enabled. Obtain the id from \"Get LAN network list\""},"dhcpIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The IP for Address reservation when useFixedAddr is enabled."},"serverType":{"type":"string","description":"The Type of DHCP Server for Address reservation when useFixedAddr is enabled."},"serverMac":{"type":"string","description":"The Mac of DHCP Server for Address reservation when useFixedAddr is enabled."},"serverStackId":{"type":"string","description":"The Stack ID of DHCP Server for Address reservation when useFixedAddr is enabled."},"confirmConflict":{"type":"boolean","description":"Enable IP-MAC Conflict Detection or not."}},"description":"Network IP setting."},"OswIpv6SettingVO":{"required":["mode"],"type":"object","properties":{"mode":{"pattern":"dynamic|static","type":"string","description":"Ipv6Setting parameter [mode] should be dynamic or static"},"dnsMode":{"type":"integer","description":"DNS mode for dynamic mode, 0: Get Dynamic DNS, 1: Use the Following DNS Addresses.","format":"int32"},"priDns":{"pattern":"(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\S*$)","type":"string","description":"Primary DNS, like 2001:4860:4860::8888"},"sndDns":{"pattern":"(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\S*$)","type":"string","description":"Second DNS, like 2001:4860:4860::8844"},"ipv6Addr":{"pattern":"(^\\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)(\\.(25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)){3}))|:)))(%.+)?\\S*$)","type":"string","description":"IPv6 Address for static mode, like 2001:4860:4860::8888"},"prefixLen":{"type":"integer","description":"Prefix Length for static mode, which should be within the range of 1–128","format":"int32"}},"description":"Network IPV6 setting."},"OswNetworkVO":{"required":["mode"],"type":"object","properties":{"id":{"type":"string","description":"Network ID"},"mvlan":{"type":"boolean","description":"Indicate the vlan is management vlan or not."},"name":{"type":"string","description":"Switch network name."},"vlan":{"type":"integer","description":"VLAN ID.","format":"int32"},"status":{"type":"integer","description":"Enable status of the network vlan. 0: disable; 1: enable.","format":"int32"},"ip":{"$ref":"#/components/schemas/OswIpSettingVO"},"ipv6Enable":{"type":"boolean","description":"Enable IPV6 or not."},"ipv6":{"$ref":"#/components/schemas/OswIpv6SettingVO"},"mode":{"type":"integer","description":"DHCP mode. 0: None, mode 1: DHCP Server, mode 2: DHCP Relay.","format":"int32"},"dhcpServer":{"$ref":"#/components/schemas/OswDhcpServerVO"},"dhcpRelay":{"$ref":"#/components/schemas/OswDhcpRelayVO"},"vrfId":{"type":"string","description":"VRF ID"},"mtu":{"type":"integer","description":"MTU, MTU value should be less than or equal to the jumbo value.","format":"int32"}},"description":"VLAN Interface."},"OperationResponseDscpMappingVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DscpMappingVO"}}},"GridVOOuiBasedVlanTemplateSwitchQueryOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OuiBasedVlanTemplateSwitchQueryOpenApiVO"}}}},"OperationResponseGridVOOuiBasedVlanTemplateSwitchQueryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOuiBasedVlanTemplateSwitchQueryOpenApiVO"}}},"OuiBasedVlanTemplateSwitchQueryOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Rule ID"},"enable":{"type":"boolean","description":"Switch Rule state."},"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Switch Rule name should contain 1 to 128 characters."},"mode":{"type":"integer","description":"Switch Rule type should be a value as follows: 0: All device port; 1: Custom device port","format":"int32"},"ruleCombine":{"type":"array","description":"Basic vlan-oui-priority configuration of oui based vlan rule.","items":{"$ref":"#/components/schemas/VlanOuiModeQueryOpenApiVO"}}}},"VlanOuiModeQueryOpenApiVO":{"required":["ouiProfileId","priority","vlanId"],"type":"object","properties":{"vlanId":{"type":"integer","description":"Selected vlan should be within the range of 2 or 4090","format":"int32"},"priority":{"type":"integer","description":"Selected priority should be within the range of 0 or 7.","format":"int32"},"ouiProfileId":{"type":"string","description":"Oui profile ID."},"ouiProfileName":{"type":"string","description":"Oui profile name. (Used in Get Api.)"}},"description":"Basic vlan-oui-priority configuration of oui based vlan rule."},"OperationResponseOuiBasedVlanSiteAutoAddVlanVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OuiBasedVlanSiteAutoAddVlanVO"}}},"OuiBasedVlanSiteAutoAddVlanVO":{"type":"object","properties":{"autoAddVlanEnable":{"type":"boolean","description":"Whether site support auto add vlan."}}},"GridVOLanNetworkVlansOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/LanNetworkVlansOpenApiVO"}}}},"LanNetworkVlansOpenApiVO":{"type":"object","properties":{"vlan":{"type":"integer","description":"Created vlan in site. Valid range is from 2 to 4090 in \"Oui based vlan\".","format":"int32"},"lanNetworkId":{"type":"string","description":"Lan network ID."}}},"OperationResponseOuiBasedVlanGridVOSwitchDataVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OuiBasedVlanGridVOSwitchDataVO"}}},"OswStackDataVOSwitchDataVO":{"type":"object","properties":{"stackId":{"type":"string"},"stackName":{"type":"string"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"showModel":{"type":"string","description":"Model complex shown in the front end.Ap：model+(country)+modelVersion,EAP225(EU) v3.0  Gateway/Switch：model+modelVersion,Osg v3.0"},"masterMac":{"type":"string"},"unSelectedablePorts":{"type":"array","description":"The unSelectedable ports of the device.","items":{"$ref":"#/components/schemas/PortVO"}},"stackStatus":{"type":"integer","format":"int32"},"abnormalReason":{"type":"integer","format":"int32"},"member":{"type":"array","items":{"$ref":"#/components/schemas/SwitchDataVO"}},"lags":{"type":"array","items":{"$ref":"#/components/schemas/OswLagStatusVO"}},"supportCustomDhcpOption":{"type":"boolean"},"supportDhcpRange":{"type":"boolean"},"supportVrf":{"type":"boolean"},"supportAutoAddVlan":{"type":"boolean"},"devCap":{"$ref":"#/components/schemas/OswDevCapVO"},"customStandardPorts":{"type":"array","description":"The standard ports that has some vlan not included in port vlan.","items":{"type":"string","description":"The standard ports that has some vlan not included in port vlan."}},"customLagIds":{"type":"array","description":"The lag ids that has some vlan not included in port vlan.","items":{"type":"integer","description":"The lag ids that has some vlan not included in port vlan.","format":"int32"}},"supportLayout":{"type":"boolean","description":"Whether the device supports reporting port layout information."}},"description":"stackOswData"},"OuiBasedVlanGridVOSwitchDataVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SwitchDataVO"}},"supportAutoAddVlanRows":{"type":"integer","description":"Total rows of all items support auto add vlan.","format":"int64"},"unSupportAutoAddVlanRows":{"type":"integer","description":"Total rows of all items does not support auto add vlan.","format":"int64"}}},"SwitchDataVO":{"type":"object","properties":{"stackId":{"type":"string","description":"Stack Id"},"stackName":{"type":"string","description":"Stack name"},"unit":{"type":"integer","description":"Unit","format":"int32"},"stackOswData":{"$ref":"#/components/schemas/OswStackDataVOSwitchDataVO"},"mac":{"type":"string","description":"Device mac"},"name":{"type":"string","description":"Device name,default value is the mac address of device"},"type":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"showModel":{"type":"string","description":"Model complex shown in the front end.Ap：model+(country)+modelVersion,EAP225(EU) v3.0  Gateway/Switch：model+modelVersion,Osg v3.0"},"unSelectedablePorts":{"type":"array","description":"The unSelectedable ports of the device.","items":{"$ref":"#/components/schemas/PortVO"}},"portNum":{"type":"integer","description":"The number of ports of one device.","format":"int32"},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected;1:Disconnected(Migrating);10:Provisioning;11:Configuring;12:Upgrading;13:Rebooting;14:Connected;15:Connected(Wireless);16:Connected(Migrating);17:Connected(Wireless,Migrating);20:Pending;21:Pending(Wireless);22:Adopting;23:Adopting(Wireless);24:Adopt Failed;25:Adopt Failed(Wireless);26:Managed By Others;27:Managed By Others(Wireless);30:Heartbeat Missed;31:Heartbeat Missed(Wireless);32:Heartbeat Missed(Migrating);33:Heartbeat Missed(Wireless,Migrating);40:Isolated;41:Isolated(Migrating);50:Slice Configuring","format":"int32"},"uplink":{"$ref":"#/components/schemas/OswUplinkVO"},"ports":{"type":"array","description":"Port List","items":{"$ref":"#/components/schemas/OswPortVO"}},"lags":{"type":"array","description":"Lag List","items":{"$ref":"#/components/schemas/OswLagVO"}},"networkNotAssociatedStandardPorts":{"type":"array","description":"The ports not associated with network.","items":{"$ref":"#/components/schemas/OswStandPortVO"}},"networkNotAssociatedLags":{"type":"array","description":"The lags not associated with network.","items":{"type":"integer","description":"The lags not associated with network.","format":"int32"}},"firmwareVersion":{"type":"string","description":"The firmware version of the device."},"supportAutoAddVlan":{"type":"boolean","description":"Whether the switch support auto add vlan."}}},"GridVOOuiBasedVlanDeviceInfoVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OuiBasedVlanDeviceInfoVO"}}}},"OperationResponseGridVOOuiBasedVlanDeviceInfoVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOuiBasedVlanDeviceInfoVO"}}},"OperationResponseOuiBasedVlanDeviceAutoAddVlanVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OuiBasedVlanDeviceAutoAddVlanVO"}}},"OuiBasedVlanDeviceAutoAddVlanVO":{"type":"object","properties":{"autoAddVlanAllSupport":{"type":"boolean","description":"Whether all devices support auto add vlan."}}},"OperationResponseSSHSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SSHSetting"}}},"OperationResponseSpecificationOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SpecificationOpenApiVO"}}},"SpecificationOpenApiVO":{"type":"object","properties":{"interfaceNum":{"type":"integer","description":"The number of interfaces supported by the site.","format":"int32"},"urlFilteringNum":{"type":"integer","description":"The number of urlFilteringNum supported by the sitey.","format":"int32"},"macGroupAddressNum":{"type":"integer","description":"The number of macGroupAddressNum supported by the site.","format":"int32"}}},"AuditLogNotificationOpenApiVO":{"type":"object","properties":{"key":{"type":"string","description":"Audit Log Notification Category Key","example":"DASHBOARD"},"shortMsg":{"type":"string","description":"Audit Log Notification Category Short Message","example":"Dashboard"},"webhook":{"type":"boolean","description":"Audit Log Notification Category Enable or Disable Webhook","example":false}},"description":"Audit Log Notification List"},"AuditLogNotificationSettingOpenApiVO":{"type":"object","properties":{"webhookConfig":{"$ref":"#/components/schemas/WebhookConfigOpenApiVO"},"auditLogNotifications":{"type":"array","description":"Audit Log Notification List","items":{"$ref":"#/components/schemas/AuditLogNotificationOpenApiVO"}}}},"OperationResponseAuditLogNotificationSettingOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AuditLogNotificationSettingOpenApiVO"}}},"OperationResponseSmsRouterCommand":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SmsRouterCommand"}}},"OperationResponseSmaPolicySetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SmaPolicySetting"}}},"OperationResponseSimQuotaSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SimQuotaSetting"}}},"AdvancedFeatureVO":{"type":"object","properties":{"enable":{"type":"boolean"}},"description":"advanced feature"},"BandSteeringVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean"},"connectionThreshold":{"type":"integer","format":"int32"},"differenceThreshold":{"type":"integer","format":"int32"},"maxFailures":{"type":"integer","format":"int32"}},"description":"band Steering"},"OperationResponseSite Template WirelessFeature":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/site template WirelessFeature"}}},"RoamingSettingVO":{"required":["aiRoamingEnable","fastRoamingEnable"],"type":"object","properties":{"fastRoamingEnable":{"type":"boolean","description":"Whether to enable fast roaming"},"aiRoamingEnable":{"type":"boolean","description":"Whether to enable AI roaming, this configuration will take effect only when fast roaming is enabled"},"dualBand11kReportEnable":{"type":"boolean","description":"Whether to enable 802.11k report","deprecated":true},"forceDisassociationEnable":{"type":"boolean","description":"Whether to enable forced disassociation","deprecated":true},"nonStickRoamingEnable":{"type":"boolean","description":"Whether to enable non-stick roaming"},"nonPingPongRoamingEnable":{"type":"boolean","description":"Whether to enable non-ping-pong roaming"},"pingPongAssocThreshold":{"type":"integer","description":"Association frequency threshold of ping-pong roaming","format":"int32"}},"description":"roaming setting"},"site template WirelessFeature":{"type":"object","properties":{"mesh":{"$ref":"#/components/schemas/MeshSettingVO"},"advancedFeature":{"$ref":"#/components/schemas/AdvancedFeatureVO"},"lldp":{"$ref":"#/components/schemas/SiteApLldpSettingVO"},"beaconControl":{"$ref":"#/components/schemas/BeaconControlVO"},"bandSteering":{"$ref":"#/components/schemas/BandSteeringVO"},"bandSteeringForMultiBand":{"$ref":"#/components/schemas/BandSteeringMultiBandVO"},"airtimeFairness":{"$ref":"#/components/schemas/AirtimeFairnessSettingVO"},"roaming":{"$ref":"#/components/schemas/RoamingSettingVO"},"mcastRateLimit":{"$ref":"#/components/schemas/McastRateLimitSettingVO"}}},"AvailableWanPortOpenApiVO":{"type":"object","properties":{"portName":{"type":"string","description":"port name"},"portUuid":{"type":"string","description":"port id"},"type":{"type":"integer","description":"wan type","format":"int32"},"configured":{"type":"boolean","description":"qos configured"},"supportIptv":{"type":"boolean","description":"support iptv?"},"virtualWanNum":{"type":"integer","description":"How many virtual wan does this wan port support","format":"int32"},"proto":{"type":"string","description":"WAN IPv4 connection type, it supports Static IP, DHCP, PPPoE, L2TP, PPTP, DS-Lite, and MAP-E."},"ipv6":{"type":"boolean","description":"IPv6 enable."},"ipv6Proto":{"type":"string","description":"IPv6 connection type: 0: static; 1: dynamic; 2: PPPoE; 3: 6to4Tunnel; 4: bridge."},"recommendedWan":{"type":"boolean","description":"Recommended WAN port."},"ip":{"type":"string","description":"IPv4 address."}},"description":"available wan ports"},"AvailableWanResultOpenApiVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"enable"},"wanPorts":{"type":"array","description":"available wan ports","items":{"$ref":"#/components/schemas/AvailableWanPortOpenApiVO"}}}},"OperationResponseAvailableWanResultOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AvailableWanResultOpenApiVO"}}},"GridVOProviderProfileEntity":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ProviderProfileEntity"}}}},"OperationResponseGridVOProviderProfileEntity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOProviderProfileEntity"}}},"ProviderProfileEntity":{"type":"object","properties":{"profileId":{"type":"string","description":"Provider profile ID"},"omadacId":{"type":"string","description":"Omadac ID"},"siteId":{"type":"string","description":"Site ID"},"profileName":{"type":"string","description":"Provider profile name"},"providerSettings":{"$ref":"#/components/schemas/ProviderSettingVO"}}},"OperationResponseVoipEmergencyNumberSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VoipEmergencyNumberSetting"}}},"OperationResponseDndSettingEntity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DndSettingEntity"}}},"DigitMapProfileInfo":{"type":"object","properties":{"profileId":{"type":"string","description":"Digit map profile ID"},"omadacId":{"type":"string","description":"Omadac ID"},"siteId":{"type":"string","description":"Site ID"},"profileName":{"type":"string","description":"Digit map profile name"},"digitMap":{"type":"string","description":"Digit map"},"defaultProfile":{"type":"boolean","description":"Whether the digit map profile is the default one."}}},"OperationResponseListDigitMapProfileInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/DigitMapProfileInfo"}}}},"CallBlockingProfileEntity":{"type":"object","properties":{"profileId":{"type":"string","description":"Call blocking profile ID"},"omadacId":{"type":"string","description":"Omadac ID"},"siteId":{"type":"string","description":"Site ID"},"profileName":{"type":"string","description":"Call blocking profile name"},"incomingCallsBlockingEnable":{"type":"boolean","description":"Enable incoming calls blocking or not."},"incomingCallsBlocking":{"$ref":"#/components/schemas/IncomingCallsBlockingVO"},"outgoingCallsBlockingEnable":{"type":"boolean","description":"Enable outgoing calls blocking or not."},"outgoingCallsBlocking":{"$ref":"#/components/schemas/OutgoingCallsBlockingVO"}}},"OperationResponseListCallBlockingProfileEntity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/CallBlockingProfileEntity"}}}},"OperationResponseVirtualWanGridOpenApiVOVirtualWanInfoOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VirtualWanGridOpenApiVOVirtualWanInfoOpenApiVO"}}},"VirtualWanGridOpenApiVOVirtualWanInfoOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VirtualWanInfoOpenApiVO"}},"supportMssClamping":{"type":"boolean","description":"Whether the pppoe supports mss clamping."},"supportPppoeMru":{"type":"boolean","description":"Whether the virtual WAN supports configuring pppoe mru."},"numReachLimit":{"type":"boolean","description":"Whether the virtual WAN reaches number limit."},"supportByDsLiteAndMapE":{"type":"boolean","description":"Whether this feature is supported for the DS-Lite or Map-E WAN connection types."}}},"VirtualWanInfoOpenApiVO":{"type":"object","properties":{"status":{"type":"boolean","description":"Virtual WAN status."},"name":{"type":"string","description":"Virtual WAN name. "},"physicalWanName":{"type":"string","description":"Physical WAN name."},"physicalWanId":{"type":"string","description":"Physical WAN ID."},"physicalWanPortId":{"type":"integer","description":"Physical WAN port ID.","format":"int32"},"id":{"type":"string","description":"Virtual WAN ID."},"wanPortIpv4Setting":{"$ref":"#/components/schemas/VirtualWanIpv4SettingInfoOpenApiVO"},"dslSetting":{"$ref":"#/components/schemas/VirtualWanDslOpenApiVO"}},"description":"VirtualWanInfo"},"VirtualWanIpv4SettingInfoOpenApiVO":{"type":"object","properties":{"proto":{"type":"string","description":"Virtual WAN IPv4 connection type."},"protoType":{"type":"integer","description":"Virtual WAN IPv4 proto type, 0:static; 1:DHCP; 2:PPPoE.","format":"int32"},"vlanId":{"type":"integer","description":"Vlan ID.","format":"int32"},"vlanPriority":{"type":"integer","description":"Vlan Priority.","format":"int32"},"supportInternetVlan":{"type":"boolean","description":"Whether support internet vlan."},"supportQosTagEnable":{"type":"boolean","description":"Whether support Qos Tag enable."},"qosTagEnable":{"type":"boolean","description":"Whether Qos Tag is enable."},"qosTag":{"type":"integer","description":"Qos Tag.","format":"int32"},"ipv4Static":{"$ref":"#/components/schemas/VirtualWanIpv4StaticOpenApiVO"},"ipv4Dhcp":{"$ref":"#/components/schemas/VirtualWanIpv4DhcpOpenApiVO"},"ipv4Pppoe":{"$ref":"#/components/schemas/VirtualWanIpv4PppoeOpenApiVO"}},"description":"VirtualWanIpv4SettingInfo"},"OperationResponseVirtualWanIdUsedOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VirtualWanIdUsedOpenApiVO"}}},"VirtualWanIdUsedOpenApiVO":{"type":"object","properties":{"virtualWanId":{"type":"string","description":"The ID of the Virtual WAN."},"functions":{"type":"array","description":"The functions that have adopted the current Virtual WAN","items":{"type":"string","description":"The functions that have adopted the current Virtual WAN"}},"notAllowDeleteFunctions":{"type":"array","description":"The Virtual WAN related settings that are not allowed to be deleted.","items":{"type":"string","description":"The Virtual WAN related settings that are not allowed to be deleted."}},"allowDeleteFunctions":{"type":"array","description":"The Virtual WAN related settings that are allowed to be deleted.","items":{"type":"string","description":"The Virtual WAN related settings that are allowed to be deleted."}},"allowDelete":{"type":"boolean","description":"Whether all Virtual WAN related functions are allowed to be deleted."}}},"OperationResponseSpeedTestV2SettingVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SpeedTestV2SettingVO"}}},"SpeedTestV2SettingVO":{"required":["autoSpeedTest"],"type":"object","properties":{"autoSpeedTest":{"type":"boolean","description":"Whether enable scheduled speed testing."},"timingType":{"type":"integer","description":"The timing type of speed test setting: 1:Daily, 2:Weekly, 3:Monthly.","format":"int32"},"hour":{"type":"integer","description":"Start time of speed test(unit: hour); It should be within the range of 0~23.","format":"int32"},"minute":{"type":"integer","description":"Start time of speed test(unit: minute); It should be within the range of 0~59.","format":"int32"},"dayOfWeek":{"type":"array","description":"It is required when [timingType] is 2. The value should be within the range of 0(Sunday)~6(Saturday).","items":{"type":"integer","description":"It is required when [timingType] is 2. The value should be within the range of 0(Sunday)~6(Saturday).","format":"int32"}},"dayOfMonth":{"type":"array","description":"It is required when [timingType] is 3. The value should be within the range of 1~31.","items":{"type":"integer","description":"It is required when [timingType] is 3. The value should be within the range of 1~31.","format":"int32"}},"resource":{"type":"integer","description":"Data Source. Resource should be a value as follows: 0: new created; 1: from template; 2: override","format":"int32"},"featureDescription":{"type":"array","description":"Gateway Feature Description.","items":{"$ref":"#/components/schemas/FeatureInfoVO"}}}},"AlertSettingOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Alert enable."},"delayEnable":{"type":"boolean","description":"Alert delay enable."},"delay":{"type":"integer","description":"Time of Log delay email (unit:s). The value should be within the range of 0–99999.","format":"int32"}},"description":"Site alert setting."},"OperationResponseSiteServiceOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteServiceOpenApiVO"}}},"SiteServiceOpenApiVO":{"type":"object","properties":{"mesh":{"$ref":"#/components/schemas/NewMeshSettingOpenApiVO"},"alert":{"$ref":"#/components/schemas/AlertSettingOpenApiVO"},"remoteLog":{"$ref":"#/components/schemas/RemoteLogSettingOpenApiVO"},"lldp":{"$ref":"#/components/schemas/SiteApLldpSettingOpenApiVO"},"beaconControl":{"$ref":"#/components/schemas/BeaconControlOpenApiVO"},"bandSteering":{"$ref":"#/components/schemas/BandSteeringOpenApiVO"},"bandSteeringForMultiBand":{"$ref":"#/components/schemas/BandSteeringMultiBandOpenApiVO"},"airtimeFairness":{"$ref":"#/components/schemas/AirtimeFairnessSettingOpenApiVO"},"led":{"$ref":"#/components/schemas/SiteLedSetting"},"roaming":{"$ref":"#/components/schemas/NewRoamingSettingOpenApiVO"}}},"OperationResponseSnmpSettingOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SnmpSettingOpenApiVO"}}},"OperationResponseListPortOrPoeScheduleOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/PortOrPoeScheduleOpenApiVO"}}}},"GridVOMdnsRuleTemplateOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/MdnsRuleTemplateOpenApiVO"}}}},"MdnsRuleTemplateOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"MDNS rule ID"},"name":{"type":"string","description":"MDNS rule name"},"status":{"type":"boolean","description":"MDNS rule enable status"},"profileIds":{"type":"array","description":"ID list of selected Bonjour Service Profile","items":{"type":"string","description":"ID list of selected Bonjour Service Profile"}},"type":{"type":"integer","description":"MDNS rule band VLAN type. Type should be a value as follows: 0: By VLAN ID, 1: By Network","format":"int32"},"ap":{"$ref":"#/components/schemas/ApMdnsRuleOpenApiVO"},"osg":{"$ref":"#/components/schemas/OsgMdnsRuleTemplateOpenApiVO"}}},"OperationResponseGridVOMdnsRuleTemplateOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOMdnsRuleTemplateOpenApiVO"}}},"OperationResponseIptvSettingOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/IptvSettingOpenApiVO"}}},"OperationResponseIptvOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/IptvOpenApiVO"}}},"OperationResponseIgmpTemplateOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/IgmpTemplateOpenApiVO"}}},"DnsProxySettingQueryOpenApiVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"DNS proxy setting enable status."},"type":{"type":"integer","description":"DNS proxy setting type. Type should be a value as follows: 0: DNSSEC, 1: DoH, 2: DoT, 3: DNS Override","format":"int32"},"dnsSecSetting":{"$ref":"#/components/schemas/DnsSecSettingOpenApiVO"},"dohSetting":{"$ref":"#/components/schemas/DohSettingOpenApiVO"},"dotSetting":{"$ref":"#/components/schemas/DotSettingOpenApiVO"},"dnsOverrideSetting":{"$ref":"#/components/schemas/DnsOverrideSettingOpenApiVO"},"supportDnsOverride":{"type":"boolean","description":"Whether DNS Override setting is supported in DNS Proxy."},"existDnsOverride":{"type":"boolean","description":"Whether DNS Override has been configured in DNS Proxy."}}},"OperationResponseDnsProxySettingQueryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DnsProxySettingQueryOpenApiVO"}}},"DnsCacheQueryOpenApiVO":{"type":"object","properties":{"page":{"type":"integer","description":"Queried page","format":"int32"},"pageSize":{"type":"integer","description":"Queried page size","format":"int32"},"type":{"type":"integer","description":"Type should be a value as follows: 0: ipv4; 1: ipv6. Default type is ipv4.","format":"int32"}}},"DnsCacheInfoVO":{"type":"object","properties":{"type":{"type":"integer","format":"int32"},"domain":{"type":"string"},"ipList":{"type":"array","items":{"type":"string"}},"ttl":{"type":"integer","format":"int32"}}},"GridVODnsCacheInfoVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DnsCacheInfoVO"}}}},"OperationResponseGridVODnsCacheInfoVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVODnsCacheInfoVO"}}},"DdnsOpenApiGridVODdnsOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DdnsOpenApiVO"}},"supportCustomDdns":{"type":"boolean","description":"Whether Custom Service Provider is supported in Dynamic DNS."},"supportCustomInterval":{"type":"boolean","description":"Whether Custom Update Interval is supported in Dynamic DNS."},"supportTpLinkddns":{"type":"integer","description":"Whether Dynamic DNS supports TP-Link as a service provider. 0: Not supported, 1: Supported and not configured, 2: Supported and configured.","format":"int32"},"supportByDsLiteAndMapE":{"type":"boolean","description":"Whether this feature is supported for the DS-Lite or Map-E WAN connection types."}}},"DdnsOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Dynamic DNS ID"},"service":{"type":"integer","description":"Dynamic DNS service type, 0: DynDNS, 1: NO-IP, 2: Peanuthull, 3: Comexe, 4: Custom, 5: TP-Link DDNS","format":"int32"},"status":{"type":"boolean","description":"Dynamic DNS enable status"},"interfacePortId":{"type":"string","description":"Port ID of interface"},"username":{"type":"string","description":"Dynamic DNS username"},"password":{"type":"string","description":"Dynamic DNS password"},"domainName":{"type":"string","description":"Dynamic DNS domainName"},"updateInterval":{"type":"integer","description":"Dynamic DNS update interval, unit: hour","format":"int32"},"customInterval":{"type":"integer","description":"Dynamic DNS custom interval, valid when parameter [server] is 0, 1 or 4, unit: minute","format":"int32"},"updateUrl":{"type":"string","description":"Dynamic DNS updateUrl, valid when parameter [server] is 4"},"existCustomDdns":{"type":"boolean","description":"Whether Custom Service Provider has been configured in the current Dynamic DNS."},"existCustomInterval":{"type":"boolean","description":"Whether Custom Update Interval has been configured in the current Dynamic DNS."},"existTpLinkddns":{"type":"boolean","description":"Whether TP-Link has been configured as Service Provider in the current Dynamic DNS."}}},"OperationResponseDdnsOpenApiGridVODdnsOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DdnsOpenApiGridVODdnsOpenApiVO"}}},"CertProfileOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Certificate authority profile entry id."},"name":{"type":"string","description":"Certificate authority profile name"},"fileName":{"type":"string","description":"Certificate authority profile file name"},"type":{"type":"integer","description":"Certificate authority profile type, such as:  0: CA Cert; 1: Client Cert.","format":"int32"},"format":{"type":"integer","description":"Cert profile format, format should be a value as follows: 0: X509; 1: DER.","format":"int32"},"status":{"type":"integer","description":"Cert profile status, status should be a value as follows: 0: Normal 1: Expired Soon 2: Expired.","format":"int32"},"expiredOn":{"type":"integer","description":"Cert profile expired time, expired timestamp, in seconds, such as 1682000000.","format":"int64"},"caCertFileId":{"type":"string","description":"CA Certificate file id, it's obtained from the interface 'uploadCaCertFile'; When type = 0, Parameter [caCertFileId] should not be null."},"clientCertFileId":{"type":"string","description":"Client certificate file id, it's obtained from the interface 'uploadClientCertFile'; When type = 1, Parameter [clientCertFileId] should not be null."},"certFileMd5":{"type":"string","description":"Client certificate file MD5."},"privateKeyFileId":{"type":"string","description":"Client private key file id, it's obtained from the interface 'UploadClientPrivateKeyFile'; When type = 1, Parameter [privateKeyFileId] should not be null."},"privateKeyFileName":{"type":"string","description":"Client private key file name."},"privateKeyFileMd5":{"type":"string","description":"Client private key file MD5."},"privateKeyPassword":{"pattern":"^[\\041-\\0176]{1,64}$","type":"string","description":"Certificate authority profile privateKey Password should contain 1 to 64 characters, spaces, comma, single quotation marks and double quotation marks are not allowed."},"resource":{"type":"integer","format":"int32"}},"description":"CertProfileOpenApiVO"},"OperationResponseCertProfileOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CertProfileOpenApiVO"}}},"CertProfileDetailOpenApiVO":{"type":"object","properties":{"fileName":{"type":"string","description":"Certificate authority profile file name"},"type":{"type":"integer","description":"Certificate authority profile type, such as:  0: CA Cert; 1: Client Cert.","format":"int32"},"certType":{"type":"string","description":"Cert profile file type, such as: X.509."},"version":{"type":"integer","description":"Cert profile file version, such as: 3.","format":"int32"},"serialNumber":{"type":"string","description":"Cert profile serial number, such as 1."},"certName":{"type":"string","description":"Certificate authority profile file name, such as : server_certificate"},"issuer":{"type":"string","description":"Certificate authority profile file issuer, such as : L=$$$$, CN=TLSGenSelfSignedRootCA 2024-11-01T16:54:19.242005"},"subject":{"type":"string","description":"Certificate authority profile file subject, such as : O=server, CN=192.168.0.20"},"issuedOn":{"type":"string","description":"Certificate authority profile file issued on, such as : Fri Nov 01 16:54:19 CST 2024"},"expiresOn":{"type":"string","description":"Certificate authority profile file expired on, such as : Mon Oct 30 16:54:19 CST 2034"},"rsaKeySize":{"type":"string","description":"Certificate authority profile file rsa Key Size, such as : 3"},"signedUsing":{"type":"string","description":"Certificate authority profile file signed using such as : SHA256withRSA"}},"description":"CertProfileDetailOpenApiVO"},"OperationResponseCertProfileDetailOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CertProfileDetailOpenApiVO"}}},"OperationResponseMailServerOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/MailServerOpenApiVO"}}},"GridVOIotServerOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/IotServerOpenApiVO"}}}},"IotServerOpenApiVO":{"required":["authentication_iotServer","blePeriodicTelemetry_iotServer","deviceClasses_iotServer","enable_iotServer","name_iotServer","rawData_iotServer","rssiFormat_iotServer","serverType_iotServer","serverUrl_iotServer"],"type":"object","properties":{"id":{"type":"string","description":"The IoT Transport Stream entry ID."},"name_iotServer":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"IoT Transport Stream setting name."},"enable_iotServer":{"type":"boolean","description":"Whether to enable the IoT Transport Stream setting."},"serverUrl_iotServer":{"type":"string","description":"If the service type is http, the server URL must start with http://."},"serverType_iotServer":{"type":"integer","description":"The server type should be a value as follows: [0: http].","format":"int32"},"deviceClasses_iotServer":{"type":"array","description":"Supports protocol-based filtering during IoT data reporting processes.<br />The device class list should contain the value as follows: [0:minew; 1:iBeacon; 2:Eddystone].","items":{"type":"integer","description":"Supports protocol-based filtering during IoT data reporting processes.<br />The device class list should contain the value as follows: [0:minew; 1:iBeacon; 2:Eddystone].","format":"int32"}},"reportInterval_iotServer":{"type":"integer","description":"Data reporting interval configuration for AP devices in IoT systems.","format":"int32"},"authentication_iotServer":{"type":"integer","description":"The parameter [authentication] should be a value as follows:[0:Use Token].","format":"int32"},"accessToken_iotServer":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"This parameter becomes mandatory when the authentication method is set to \"Use Token\".<br/>Note:The parameter [clientId] should be 1 ~ 128 characters."},"clientId_iotServer":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"This parameter becomes mandatory when the authentication method is set to \"Use Token\".<br />Note:The parameter [clientId] should be 1 ~ 128 characters."},"rssiFormat_iotServer":{"type":"integer","description":"The signal strength reporting format currently supports five types: [0:Average; 1:Max; 2:Last; 3:Smooth; 4:Bulk].","format":"int32"},"filtersType_iotServer":{"type":"array","description":"User-defined settings to manage AP device filtering rules for IoT devices.<br />The parameter [filtersType] should contain the value as follows:[0:Company Identifier; 1:Vendor; 2:Local Name; 3:Service UUID; 4:Mac Oui; 5:iBeacon UUID; 6:UID; 7:URL].","items":{"type":"integer","description":"User-defined settings to manage AP device filtering rules for IoT devices.<br />The parameter [filtersType] should contain the value as follows:[0:Company Identifier; 1:Vendor; 2:Local Name; 3:Service UUID; 4:Mac Oui; 5:iBeacon UUID; 6:UID; 7:URL].","format":"int32"}},"filters_iotServer":{"type":"object","additionalProperties":{"type":"array","description":"The keys in the [filters] map represent the filter types, while the values correspond to the specific filtering criteria or values associated with each filter type.<br />Note:<br />Filter type = 0, The Company Identifier must conform to a 4-digit or 6-digit hexadecimal encoding. It is only applicable to ibeacon devices<br />Filter type = 1, The Vendor should not exceed 255 bytes in length.<br />Filter type = 2, The Local Name should not exceed 120 bytes in length. It is only applicable to minew devices.<br />Filter type = 3, The Service UUID must conform to a 4-digit hexadecimal encoding. It is only applicable to minew and eddystone devices.<br />Filter type = 4, The Mac Oui must conform to a 6-digit hexadecimal encoding.<br />Filter type = 5, The iBeacon UUID must conform to a 32-digit hexadecimal encoding. It is only applicable to iBeacon devices.<br />Filter type = 6, The UID must conform to a 20-digit or 32-digit hexadecimal encoding. It is only applicable to eddystone devices.<br />Filter type = 7, The URL should not include a scheme. It is only applicable to eddystone devices.<br />","items":{"type":"string","description":"The keys in the [filters] map represent the filter types, while the values correspond to the specific filtering criteria or values associated with each filter type.<br />Note:<br />Filter type = 0, The Company Identifier must conform to a 4-digit or 6-digit hexadecimal encoding. It is only applicable to ibeacon devices<br />Filter type = 1, The Vendor should not exceed 255 bytes in length.<br />Filter type = 2, The Local Name should not exceed 120 bytes in length. It is only applicable to minew devices.<br />Filter type = 3, The Service UUID must conform to a 4-digit hexadecimal encoding. It is only applicable to minew and eddystone devices.<br />Filter type = 4, The Mac Oui must conform to a 6-digit hexadecimal encoding.<br />Filter type = 5, The iBeacon UUID must conform to a 32-digit hexadecimal encoding. It is only applicable to iBeacon devices.<br />Filter type = 6, The UID must conform to a 20-digit or 32-digit hexadecimal encoding. It is only applicable to eddystone devices.<br />Filter type = 7, The URL should not include a scheme. It is only applicable to eddystone devices.<br />"}},"description":"The keys in the [filters] map represent the filter types, while the values correspond to the specific filtering criteria or values associated with each filter type.<br />Note:<br />Filter type = 0, The Company Identifier must conform to a 4-digit or 6-digit hexadecimal encoding. It is only applicable to ibeacon devices<br />Filter type = 1, The Vendor should not exceed 255 bytes in length.<br />Filter type = 2, The Local Name should not exceed 120 bytes in length. It is only applicable to minew devices.<br />Filter type = 3, The Service UUID must conform to a 4-digit hexadecimal encoding. It is only applicable to minew and eddystone devices.<br />Filter type = 4, The Mac Oui must conform to a 6-digit hexadecimal encoding.<br />Filter type = 5, The iBeacon UUID must conform to a 32-digit hexadecimal encoding. It is only applicable to iBeacon devices.<br />Filter type = 6, The UID must conform to a 20-digit or 32-digit hexadecimal encoding. It is only applicable to eddystone devices.<br />Filter type = 7, The URL should not include a scheme. It is only applicable to eddystone devices.<br />"},"countOnly_iotServer":{"type":"boolean","description":"A switch that controls whether the AP device exclusively reports the count of IoT devices."},"blePeriodicTelemetry_iotServer":{"type":"boolean","description":"Whether to enable the BLE Periodic Telemetry. When disabled no periodic packets will be uploaded."},"rawData_iotServer":{"type":"boolean","description":"Whether to enable the BLE Data Forwarding. When enabled, the AP directly reports the Bluetooth packet rawData to the server."}}},"OperationResponseSiteServiceGeneralConfigOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteServiceGeneralConfigOpenApiVO"}}},"ExistSiteSettingOpenApiVO":{"type":"object","properties":{"virtualWan":{"type":"boolean","description":"Whether the current site has Virtual WAN configured."},"dnsProxy":{"type":"boolean","description":"Whether the current site has DNS proxy configured."},"lanDns":{"type":"boolean","description":"Whether the current site has LAN DNS configured."},"ipsecFailover":{"type":"boolean","description":"Whether the current site has IPsec failover configured."},"wireguard":{"type":"boolean","description":"Whether the current site has WireGuard VPN configured."},"sslVpn":{"type":"boolean","description":"Whether the current site has SSL VPN configured."},"googleLdap":{"type":"boolean","description":"Whether the current site has Google LDAP configured."},"ipsIds":{"type":"boolean","description":"Whether the current site has IDS/IPS configured."},"vpnUser":{"type":"boolean","description":"Whether the current site has VPN User configured."},"oneToOneNat":{"type":"boolean","description":"Whether the current site has One-to-One NAT configured."},"disableNat":{"type":"boolean","description":"Whether the current site has Disable NAT configured."},"qos":{"type":"boolean","description":"Whether the current site has QoS configured."},"serviceType":{"type":"boolean","description":"Whether the current site has Gateway QoS service configured."},"policyRouting":{"type":"boolean","description":"Whether the current site has Policy Routing configured."},"ipMacBinding":{"type":"boolean","description":"Whether the current site has IP-MAC Binding configured."},"urlCategory":{"type":"boolean","description":"Whether the General Config of URL Filtering has been configured."},"dnsCache":{"type":"boolean","description":"Whether the current site has DNS Cache configured."},"macFilter":{"type":"boolean","description":"Whether the current site has MAC Filtering configured."}}},"OperationResponseExistSiteSettingOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ExistSiteSettingOpenApiVO"}}},"OperationResponseSite Template Settings":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/site template settings"}}},"site template settings":{"type":"object","properties":{"id":{"type":"string","description":"site template id"},"omadacId":{"type":"string","description":"omadacId"},"name":{"type":"string","description":"site template name"},"timeZone":{"type":"string","description":"time zone"},"dst":{"$ref":"#/components/schemas/Site setting:dst"},"ntpEnable":{"type":"boolean","description":"Network Time Protocol enable"},"ntpServers":{"type":"array","description":"ntp servers","items":{"$ref":"#/components/schemas/ntp server"}},"type":{"type":"integer","description":"site type. 0：Basic；1：Pro","format":"int32"},"settings":{"type":"array","description":"list of supported configurations","items":{"type":"string","description":"list of supported configurations"}}}},"OperationResponseVirtualWanAvailablesOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VirtualWanAvailablesOpenApiVO"}}},"VirtualWanAvailableOpenApiVO":{"type":"object","properties":{"virtualEntryId":{"type":"integer","description":"Virtual WAN Entry ID.","format":"int32"},"virtualWanId":{"type":"string","description":"Virtual WAN ID."},"physicalWanId":{"type":"string","description":"Physical WAN ID."},"name":{"type":"string","description":"Virtual WAN name."},"ipv4Proto":{"type":"string","description":"Virtual WAN IPv4 proto."},"type":{"type":"integer","description":"Physical WAN port type, 0: WAN; 1:WAN/LAN; 2:LAN; 3:SFP WAN; 4:USB LTE WAN; 5: LTE WAN; 6:DSL WAN;","format":"int32"},"maxBandwidth":{"type":"integer","description":"Port max bandwidth.","format":"int64"},"weight":{"type":"integer","description":"Virtual WAN weight.","format":"int32"},"onlineDetection":{"type":"integer","description":"Port Online Detection.","format":"int32"}},"description":"VirtualWanAvailableInfo"},"VirtualWanAvailablesOpenApiVO":{"type":"object","properties":{"wanPorts":{"type":"array","description":"Virtual WAN available list.","items":{"$ref":"#/components/schemas/VirtualWanAvailableOpenApiVO"}}},"description":"VirtualWanAvailablesInfo"},"AutoFreeAuthPolicyOpenApi":{"type":"object","properties":{"url":{"type":"string","description":"The URL of the automatically generated free auth policy"},"sourceType":{"type":"integer","description":"The source type of the auto free auth policy, 0: System created; 1: From Portal Created","format":"int32"},"sourcePortal":{"type":"string","description":"The name of the source portal, required when parameter [sourceType] is 1"}}},"OperationResponseListAutoFreeAuthPolicyOpenApi":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/AutoFreeAuthPolicyOpenApi"}}}},"OperationResponseSession Limit Entity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Session limit entity"}}},"OperationResponseSessionLimitRuleGridOpenApiVOQuerySessionLimitRuleOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SessionLimitRuleGridOpenApiVOQuerySessionLimitRuleOpenApiVO"}}},"QuerySessionLimitRuleOpenApiVO":{"required":["maxSession","name","sourceType","status"],"type":"object","properties":{"id":{"type":"string","description":"ID of the session limit rule."},"index":{"type":"integer","description":"Index of the session limit rule. When the [sourceType] is 0 or 1, the index is counted in order, when the sourceType is 2, the index is always -1","format":"int32"},"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name should contain 1 to 64 characters."},"status":{"type":"boolean","description":"Status of the session limit rule."},"sourceType":{"type":"integer","description":"Source type should be a value as follows: 0: network; 1: IP group; 2: IP.","format":"int32"},"sourceIds":{"type":"array","description":"Source IDs of the session limit rule, only for network and IP group type.Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface. IP group can be created using 'Create a new group profile' interface, and IP group ID can be obtained from 'Get group profile list' interface.","items":{"type":"string","description":"Source IDs of the session limit rule, only for network and IP group type.Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface. IP group can be created using 'Create a new group profile' interface, and IP group ID can be obtained from 'Get group profile list' interface."}},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP of the session limit rule."},"maxSession":{"type":"integer","description":"Max sessions should be within the range of 1–999999.","format":"int32"},"existIpAddress":{"type":"boolean","description":"Whether Source Type of Current Session Limit rule is IP Address."},"featureDescription":{"type":"array","description":"Gateway Feature Description.","items":{"$ref":"#/components/schemas/FeatureInfoVO"}}}},"SessionLimitRuleGridOpenApiVOQuerySessionLimitRuleOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/QuerySessionLimitRuleOpenApiVO"}},"supportIpAddress":{"type":"boolean","description":"Whether Choosing Ip Address as Source Type is supported in Session Limit."}}},"OperationResponseRrmSettingOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/RrmSettingOpenApiVO"}}},"OperationResponseStaticRoutingOpenApiGridVOStaticRoutingInfoTemplate":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/StaticRoutingOpenApiGridVOStaticRoutingInfoTemplate"}}},"StaticRoutingInfoTemplate":{"required":["destinations","metric","name","routeType","status"],"type":"object","properties":{"id":{"type":"string","description":"ID"},"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name, name should contain 1 to 64 characters."},"status":{"type":"boolean","description":"Status"},"destinations":{"type":"array","description":"IP address/SubNet, up to 16 entries are allowed for the destinations list.","items":{"type":"string","description":"IP address/SubNet, up to 16 entries are allowed for the destinations list."}},"routeType":{"type":"integer","description":"RouteType should be a value as follows: 0: NextHop; 1: Interface","format":"int32"},"nextHopIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Only for routeType:0 or routeType:1 and selected WAN is Static IP/Dynamic IP mode"},"interfaceType":{"type":"integer","description":"Only for routeType:1, interfaceType should be a value as follows: 0: Internet(WAN); 1: Network(LAN).","format":"int32"},"interfaceId":{"type":"string","description":"Interface ID, for example: if interfaceType is network, interfaceId should be LAN network ID. LAN Network can be created using 'Create LAN network template' interface, and LAN Network ID can be obtained from 'Get LAN network list template' interface."},"metric":{"type":"integer","description":"Metric should be within the range of 0–15.","format":"int32"}}},"StaticRoutingOpenApiGridVOStaticRoutingInfoTemplate":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/StaticRoutingInfoTemplate"}},"supportVirtualWan":{"type":"boolean","description":"Whether Virtual Wan is supported in Static Route."},"supportVpnClient":{"type":"boolean","description":"Whether VPN Client is supported in Static Route."},"supportByDsLiteAndMapE":{"type":"boolean","description":"Whether this feature is supported for the DS-Lite or Map-E WAN connection types."}}},"OperationResponsePolicyRoutingOpenApiGridVOPolicyRoutingInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PolicyRoutingOpenApiGridVOPolicyRoutingInfo"}}},"PolicyRoutingInfo":{"required":["backupInterface","destinationIds","destinationType","name","protocols","sourceIds","sourceType","status"],"type":"object","properties":{"id":{"type":"string","description":"ID"},"index":{"type":"integer","description":"Index","format":"int32"},"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name, name should contain 1 to 64 characters."},"status":{"type":"boolean","description":"Status"},"protocols":{"type":"array","description":"For the values of protocols, refer to section 5.5.2 of the Open API Access Guide.","items":{"type":"integer","description":"For the values of protocols, refer to section 5.5.2 of the Open API Access Guide.","format":"int32"}},"interfaceType":{"type":"integer","description":"InterfaceType should be a value as follows: 0: WAN; 2: L2TP; 3: PPTP; 4: multi-select WAN or VPN or virtual WAN.","format":"int32"},"interfaceId":{"type":"string","description":"Interface ID"},"wanPortIds":{"type":"array","description":"WAN port list. When interfaceType is 4, at least one of the wanPortIds or vpnIds or virtualWanIds is not empty.","items":{"type":"string","description":"WAN port list. When interfaceType is 4, at least one of the wanPortIds or vpnIds or virtualWanIds is not empty."}},"vpnIds":{"type":"array","description":"VPN list. When interfaceType is 4, at least one of the wanPortIds or vpnIds or virtualWanIds is not empty.","items":{"type":"string","description":"VPN list. When interfaceType is 4, at least one of the wanPortIds or vpnIds or virtualWanIds is not empty."}},"virtualWanIds":{"type":"array","description":"Virtual WAN list. When interfaceType is 4, at least one of the wanPortIds or vpnIds or virtualWanIds is not empty.","items":{"type":"string","description":"Virtual WAN list. When interfaceType is 4, at least one of the wanPortIds or vpnIds or virtualWanIds is not empty."}},"backupInterface":{"type":"boolean","description":"Use another WAN port if the current one is down"},"sourceType":{"type":"integer","description":"SourceType should be a value as follows: 0: Network; 1: IP Group; 2: IP port Group","format":"int32"},"sourceIds":{"type":"array","description":"Source IDs, which depends on sourceType, for example: if sourceType is network, sourceIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Source IDs, which depends on sourceType, for example: if sourceType is network, sourceIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."}},"destinationType":{"type":"integer","description":"DestinationType should be a value as follows: 0: Network; 1: IP Group; 2: IP port Group","format":"int32"},"destinationIds":{"type":"array","description":"Destination IDs, which depends on destinationType, for example: if destinationType is network, destinationIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Destination IDs, which depends on destinationType, for example: if destinationType is network, destinationIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."}},"existVpnClient":{"type":"boolean","description":"Whether the interface option exists VPN client"},"existVirtualWan":{"type":"boolean","description":"Whether the interface option exists virtual WAN"},"existMulti":{"type":"boolean","description":"Whether the interface option exists multi"},"existLocationGroupDest":{"type":"boolean","description":"Whether the destination type exists location group"},"existDomainGroupDest":{"type":"boolean","description":"Whether the destination type exists domain group"},"existIpPortGroup":{"type":"boolean","description":"Whether the destination type exists ip port group"},"featureDescription":{"type":"array","description":"Gateway Feature Description.","items":{"$ref":"#/components/schemas/FeatureInfoVO"}}}},"PolicyRoutingOpenApiGridVOPolicyRoutingInfo":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PolicyRoutingInfo"}},"supportMulti":{"type":"boolean","description":"Whether multiple WAN interface is supported in Policy Routing."},"supportLocationGroupDest":{"type":"boolean","description":"Whether Location Group is supported as Destination in Policy Routing."},"supportDomainGroupDest":{"type":"boolean","description":"Whether Domain Group is supported as Interface in Policy Routing."},"supportVpnClient":{"type":"boolean","description":"Whether Vpn Client is supported as Interface in Policy Routing."},"supportByDsLiteAndMapE":{"type":"boolean","description":"Whether this feature is supported for the DS-Lite or Map-E WAN connection types."}}},"OperationResponseSiteRoamingSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteRoamingSetting"}}},"ApPlanningHistoryDetailVO":{"type":"object","properties":{"name":{"type":"string","description":"Device name."},"model":{"type":"string","description":"Device model."},"modelVersion":{"type":"string","description":"Device model version."},"type":{"type":"string","description":"Device type."},"ip":{"type":"string","description":"IP Address."},"optimizeSuccess":{"type":"boolean","description":"Parameter [optimizeSuccess] indicates whether the optimization has been executed successfully."},"support5g2":{"type":"boolean","description":"Parameter [support5g2] indicates whether the device supports 5 GHz-2."},"radio2g":{"$ref":"#/components/schemas/ApPlanningRadioVO"},"radio5g":{"$ref":"#/components/schemas/ApPlanningRadioVO"},"radio5g2":{"$ref":"#/components/schemas/ApPlanningRadioVO"},"radio6g":{"$ref":"#/components/schemas/ApPlanningRadioVO"},"failMsg":{"type":"string","description":"Fail message."},"failMsgType":{"type":"integer","description":"Fail message type. -1: Success. 0: Failed to optimize device because of no scan result. 1: Failed to apply deploy config because the device is not connected or the configuration is invalid.","format":"int32"},"triggerReason":{"type":"integer","description":"Trigger reason. 0: none. 1: Strong Interference. 2: new ap","format":"int32"}},"description":"Optimization history details."},"ApPlanningRadioVO":{"type":"object","properties":{"origChan":{"type":"string","description":"The original channel."},"rcmdChan":{"type":"string","description":"Channel recommended by the algorithm."},"origChanWidth":{"type":"string","description":"The original channel width."},"rcmdChanWidth":{"type":"string","description":"Channel width recommended by the algorithm."},"origPower":{"type":"integer","description":"The original power value.","format":"int32"},"rcmdPower":{"type":"integer","description":"Power value recommended by the algorithm.","format":"int32"},"origBand":{"type":"integer","description":"The original switch status of band. 0: off, 1: on.","format":"int32"},"rcmdBand":{"type":"integer","description":"Band switch status recommended by the algorithm. 0: off, 1: on.","format":"int32"},"errCode":{"type":"integer","description":"Error code returned by the algorithm. 0: OK. -34820: The configured bandwidth has no optional channel. -34821: The lowest power supported by this device is out of the configured Power Range. -34822: The highest power supported by this device is out of the configured Power Range. -34815: Failed to optimize device because of no scan result. -34816: Failed to apply deploy config because of this device is not connected. -34823: Cannot optimize the channels because you have excluded them.","format":"int32"}},"description":"Optimization results in band 6 GHz."},"OperationResponsePlanning History Detail":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Planning history detail"}}},"Planning history detail":{"type":"object","properties":{"channelDeployEnable":{"type":"boolean","description":"Whether to enable channel deployment."},"channelWidthDeployEnable":{"type":"boolean","description":"Whether to enable channel width deployment."},"bandDeployEnable":{"type":"boolean","description":"Whether to enable band deployment."},"powerAdjustEnable":{"type":"boolean","description":"Whether to enable power adjustment."},"time":{"type":"integer","description":"Timestamp corresponding to the start of optimization.","format":"int64"},"currentConfig":{"type":"integer","description":"0: This entry does not correspond to the current configuration. 1: The recommended values are the current configuration. 2: The previous/origin values are the current configuration.","format":"int32"},"successDevices":{"type":"integer","description":"The number of devices which have been successfully optimized.","format":"int32"},"failDevices":{"type":"integer","description":"The number of devices which have been optimized unsuccessfully.","format":"int32"},"data":{"type":"array","description":"Optimization history details.","items":{"$ref":"#/components/schemas/ApPlanningHistoryDetailVO"}}}},"OperationResponseSiteRemoteLoggingSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteRemoteLoggingSetting"}}},"OperationResponseSiteRememberDeviceSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteRememberDeviceSetting"}}},"OperationResponseListRebootScheduleTemplateQueryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/RebootScheduleTemplateQueryOpenApiVO"}}}},"RebootScheduleTemplateQueryOpenApiVO":{"required":["name","status","time"],"type":"object","properties":{"id":{"type":"string","description":"Reboot Schedule ID."},"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Reboot Schedule name should contain 1 to 128 characters."},"status":{"type":"boolean","description":"Reboot Schedule status."},"time":{"$ref":"#/components/schemas/RebootScheduleTimeOpenApiVO"},"nextExecute":{"type":"integer","description":"Reboot Schedule next execution timestamp(ms).","format":"int64"}}},"OperationResponseListRateLimitProfileOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/RateLimitProfileOpenApiVO"}}}},"RateLimitProfileOpenApiVO":{"type":"object","properties":{"profileId":{"type":"string","description":"Rate limit profile ID"},"name":{"type":"string","description":"Rate limit profile name"},"downLimitEnable":{"type":"boolean","description":"Whether to enable download limit"},"downLimit":{"type":"integer","description":"Download limit(Unit: Kbps), this field is required when parameter [downLimitEnable] is true.","format":"int64"},"upLimitEnable":{"type":"boolean","description":"Whether to enable upload limit"},"upLimit":{"type":"integer","description":"Upload limit(Unit: Kbps), this field is required when parameter [upLimitEnable] is true.","format":"int64"},"defaultProfile":{"type":"boolean","description":"Whether it is default profile."},"resource":{"type":"integer","description":"Data source. Resource should be a value as follows: 0: new created; 1: from template; 2: override","format":"int32"}}},"OperationResponseResponseDataVOQosBwcWanInfoOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ResponseDataVOQosBwcWanInfoOpenApiVO"}}},"QosBwcWanInfoOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"WAN port ID."},"name":{"type":"string","description":"WAN port name."},"configured":{"type":"boolean","description":"Whether the port has been configured with QoS Bandwidth Control."}}},"ResponseDataVOQosBwcWanInfoOpenApiVO":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/QosBwcWanInfoOpenApiVO"}}}},"OperationResponseVoipOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VoipOpenApiVO"}}},"OperationResponseTagOutConfigOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/TagOutConfigOpenApiVO"}}},"ClassRuleTemplateDetailOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"The ID of class rule."},"enable":{"type":"boolean","description":"The status of class rule. valid values are true or false."},"ipVersion":{"type":"integer","description":"The IP Version of class rule should be a value as follows: 0: IPv4; 1: IPv6.","format":"int32"},"localIp":{"type":"string","description":"The ID of IP Group or IPv6 Group selected in the Local Address configuration. The ID can be obtained from 'Get group profile template list' interface."},"remoteIp":{"type":"string","description":"The ID of IP Group or IPv6 Group selected in the Remote Address configuration. The ID can be obtained from 'Get group profile template list' interface."},"dscp":{"type":"string","description":"The DSCP value selected in the DSCP configuration should be a value as follows: any: any; 8: IP precedence 1; 16: IP precedence 2; 24: IP precedence 3; 32: IP precedence 4; 40: IP precedence 5; 48: IP precedence 6; 56: IP precedence 7; 10: AF Class 1 (Low Drop); 12: AF Class 1 (Medium Drop); 14: AF Class 1 (High Drop); 18: AF Class 2 (Low Drop); 20: AF Class 2 (Medium Drop); 22: AF Class 2 (High Drop); 26: AF Class 3 (Low Drop); 28: AF Class 3 (Medium Drop); 30: AF Class 3 (High Drop); 34: AF Class 4 (Low Drop); 36: AF Class 4 (Medium Drop); 38: AF Class 4 (High Drop); 46: EF Class."},"serviceType":{"type":"string","description":"The ID of Gateway Qos Service selected in the Service Name configuration. The ID can be obtained from 'Get all Gateway QoS Service's ID and name info in siteTemplate' interface."},"classType":{"type":"integer","description":"The Class value selected in the Qos Class configuration should be a value as follows: 1: Class 1, 2: Class 2, 3: Class 3.","format":"int32"}}},"GridVOClassRuleTemplateDetailOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClassRuleTemplateDetailOpenApiVO"}}}},"OperationResponseGridVOClassRuleTemplateDetailOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOClassRuleTemplateDetailOpenApiVO"}}},"GridVOQosBwcDetailOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/QosBwcDetailOpenApiVO"}}}},"OperationResponseGridVOQosBwcDetailOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOQosBwcDetailOpenApiVO"}}},"QosBwcDetailOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"The ID of Bandwidth Control rule."},"wan":{"type":"string","description":"The ID of WAN port to which this Bandwidth Control applies."},"status":{"type":"boolean","description":"The status of Bandwidth Control rule, valid values are true or false."},"udpBandwidthCtrl":{"type":"boolean","description":"The UDP Bandwidth Control of Bandwidth Control rule, valid values are true or false."},"udpRatio":{"type":"integer","description":"The Limited Bandwidth Ratio of Bandwidth Control rule. It should be within the range of 0-100 when parameter [udpBandwidthCtrl] is true.","format":"int32"},"outPrioritization":{"type":"boolean","description":"The Outbound TCP ACK Prioritize of Bandwidth Control rule, valid values are true or false."},"direction":{"type":"integer","description":"The direction value selected in the Direction configuration should be a value as follows: 0: Inbound; 1: Outbound; 2: Both.","format":"int32"},"inBandwidth":{"type":"integer","description":"The Inbound Bandwidth of Bandwidth Control rule should be within the range of 100-1000000.","format":"int32"},"outBandwidth":{"type":"integer","description":"The Outbound Bandwidth of Bandwidth Control rule should be within the range of 100-1000000.","format":"int32"},"classRatio":{"type":"array","description":"The ratio of class type, value's format is [class1 ratio, class2 ratio, class3 ratio, others ratio].","items":{"type":"integer","description":"The ratio of class type, value's format is [class1 ratio, class2 ratio, class3 ratio, others ratio].","format":"int32"}}}},"OperationResponseListWifiCallingProfileOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/WifiCallingProfileOpenApiVO"}}}},"WifiCallingProfileOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Wi-Fi Calling Profile ID"},"name":{"type":"string","description":"Wi-Fi Calling Profile Name. It should contain 1 to 32 UTF-8 characters."},"description":{"type":"string","description":"The Description of Wi-Fi Calling Profile. It should contain 1 to 32 UTF-8 characters."},"carrierList":{"type":"array","description":"carrierList","items":{"$ref":"#/components/schemas/CarrierOpenApiVO"}},"resource":{"type":"integer","description":"The incident notifiction setting creation resource, such as: 0: new created, 1: from template, 2: override.","format":"int32"}}},"GatewayQosServiceDetailOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"The ID of Gateway QoS Service."},"defaultProfile":{"type":"boolean","description":"Indicating that the profile is the default which cannot be modified."},"name":{"type":"string","description":"The name of Gateway QoS Service should contain 1 to 64 characters."},"protocol":{"type":"integer","description":"The protocol of Gateway QoS Service should be a value as follows: 0: TCP, 1: UDP, 2: TCP/UDP, 3: ICMP, 4: Other.","format":"int32"},"sourceStartPort":{"type":"integer","description":"The start port of Source Port Range. It must be less than the end port. It should be within the range of 0-65535 when protocol is 0(TCP), 1(UDP) or 2(TCP/UDP).","format":"int32"},"sourceEndPort":{"type":"integer","description":"The end port of Source Port Range. It must be more than the start port. It should be within the range of 0-65535 when protocol is 0(TCP), 1(UDP) or 2(TCP/UDP).","format":"int32"},"destStartPort":{"type":"integer","description":"The start port of Destination Port Range. It must be less than the end port. It should be within the range of 0-65535 when protocol is 0(TCP), 1(UDP) or 2(TCP/UDP).","format":"int32"},"destEndPort":{"type":"integer","description":"The end port of Destination Port Range. It must be more than the start port. It should be within the range of 0-65535 when protocol is 0(TCP), 1(UDP) or 2(TCP/UDP).","format":"int32"},"type":{"type":"integer","description":"The type cannot be null and should be within the range of 0-255 when protocol is 3(ICMP).","format":"int32"},"code":{"type":"integer","description":"The code cannot be null and should be within the range of 0-255 when protocol is 3(ICMP).","format":"int32"},"protoNum":{"type":"integer","description":"The protoNum cannot be null and should be within the range of 1-255 when protocol is 4(Other).","format":"int32"},"description":{"type":"string","description":"The description of Gateway QoS Service should contain 0 to 128 characters."}}},"GridVOGatewayQosServiceDetailOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GatewayQosServiceDetailOpenApiVO"}}}},"OperationResponseGridVOGatewayQosServiceDetailOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOGatewayQosServiceDetailOpenApiVO"}}},"GatewayQosServiceSummaryOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"The ID of Gateway QoS Service."},"name":{"type":"string","description":"The name of Gateway QoS Service."}}},"OperationResponseResponseDataVOGatewayQosServiceSummaryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ResponseDataVOGatewayQosServiceSummaryOpenApiVO"}}},"ResponseDataVOGatewayQosServiceSummaryOpenApiVO":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GatewayQosServiceSummaryOpenApiVO"}}}},"OperationResponseListRadiusProfileOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/RadiusProfileOpenApiVO"}}}},"RadiusProfileOpenApiVO":{"type":"object","properties":{"radiusProfileId":{"type":"string","description":"Radius profile ID"},"name":{"type":"string","description":"Radius profile name"},"authServer":{"type":"array","description":"Radius authentication server list","items":{"$ref":"#/components/schemas/RadiusAuthServerOpenApiVO"}},"radiusAccountingEnable":{"type":"boolean","description":"Radius accounting enable status"},"interimUpdateEnable":{"type":"boolean","description":"When radius accounting enables, interval update enable status"},"interimUpdateInterval":{"type":"integer","description":"When interval update enables, interval update duration","format":"int32"},"acctServer":{"type":"array","description":"Radius accounting server list, valid when parameter [radiusAccountingEnable] is true","items":{"$ref":"#/components/schemas/RadiusAcctServerOpenApiVO"}},"wirelessVlanAssignment":{"type":"boolean","description":"VLAN assignment for wireless network enable status"},"domainEnable":{"type":"boolean","description":"Domain enable status"},"coaEnable":{"type":"boolean","description":"Radius CoA enable status"},"coaPassword":{"type":"string","description":"Radius CoA password, valid when parameter [coaEnable] is true"},"builtInServer":{"type":"boolean","description":"Is this RADIUS server a built-in server"},"serverEnable":{"type":"boolean","description":"Built-in RADIUS server enable status, valid when parameter [builtInServer] is true"},"tunnelReplyEnable":{"type":"boolean","description":"Built-in RADIUS server tunneled reply enable status, valid when parameter [builtInServer] is true"},"builtInServerSecret":{"type":"string","description":"Built-in RADIUS server secret, valid when parameter [builtInServer] is true"},"ipType":{"type":"integer","description":"Built-in RADIUS server IP type, 0: auto，1: custom, valid when parameter [builtInServer] is true","format":"int32"},"customIp":{"type":"string","description":"Built-in RADIUS server custom IP, valid when parameter [builtInServer] is true and [ipType] is 1"},"requireMessageAuthenticator":{"type":"boolean","description":"Message-Authenticator enable status"}}},"GridVORadiusUserOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RadiusUserOpenApiVO"}}}},"OperationResponseGridVORadiusUserOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVORadiusUserOpenApiVO"}}},"RadiusUserOpenApiVO":{"type":"object","properties":{"userId":{"type":"string","description":"Build-in RADIUS profile user ID"},"type":{"type":"integer","description":"Type of Build-in RADIUS profile user, 0: user auth; 1: MAC auth","format":"int32"},"username":{"type":"string","description":"Build-in RADIUS profile user name, when parameter [type] is 1, [username] is the MAC address"},"password":{"type":"string","description":"Build-in RADIUS profile user password, when parameter [type] is 1, [password] is the MAC address"},"upRateLimit":{"type":"integer","description":"Build-in RADIUS profile user uplink rate limit, unit: Kbps","format":"int64"},"downRateLimit":{"type":"integer","description":"Build-in RADIUS profile user downlink rate limit, unit: Kbps","format":"int64"},"upLimit":{"type":"integer","description":"Build-in RADIUS profile user uplink traffic limit, unit: MB","format":"int64"},"downLimit":{"type":"integer","description":"Build-in RADIUS profile user downlink traffic limit, unit: MB","format":"int64"},"vlanId":{"type":"integer","description":"VLAN ID, from 1 to 4096","format":"int32"},"timeout":{"type":"integer","description":"Session timeout","format":"int32"},"description":{"type":"string","description":"Description of radius user, should contain 1 to 256 characters"}}},"LdapProfileOpenApiVO":{"type":"object","properties":{"ldapProfileId":{"type":"string","description":"LDAP profile ID"},"name":{"type":"string","description":"LDAP profile name"},"status":{"type":"boolean","description":"LDAP profile enable status"},"bindType":{"type":"integer","description":"Type of LDAP bind, 0: Simple Mode；1: Anonymous Mode; 2: Regular Mode","format":"int32"},"server":{"type":"string","description":"LDAP server address"},"dstPort":{"type":"integer","description":"LDAP server listening port. When SSL is not enabled, it is generally 389, and when SSL is enabled, it is generally 636","format":"int32"},"useSsl":{"type":"boolean","description":"LDAP server enable ssl status"},"cn":{"type":"string","description":"LDAP server common name"},"baseDn":{"type":"string","description":"LDAP server base distinguish name"},"groupDn":{"type":"string","description":"LDAP server group distinguish name, optional when parameter [type] is 1 or 2"},"filter":{"type":"string","description":"Additional filter, optional when parameter [type] is 1 or 2"},"regularDn":{"type":"string","description":"Regular Dn, valid when parameter [type] is 2"},"regularPassword":{"type":"string","description":"Regular Password, valid when parameter [type] is 2"}}},"OperationResponseListLdapProfileOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/LdapProfileOpenApiVO"}}}},"GroupOpenApiVO":{"type":"object","properties":{"groupId":{"type":"string","description":"Group profile ID"},"name":{"type":"string","description":"Group profile name"},"type":{"type":"integer","description":"Type of group profile. 0: IP Group; 1: IP Port Group; 2: MAC Group; 3: IPv6 Group; 4: IPv6 Port Group; 5: Country Group; 7: Domain Group;","format":"int32"},"count":{"type":"integer","description":"Count of list entries","format":"int32"},"buildIn":{"type":"boolean","description":"Is this profile a built-in profile"},"ipList":{"type":"array","description":"IP subnet info list. [type] value of 0 or 1 is required","items":{"$ref":"#/components/schemas/IPSubnetsOpenApiVO"}},"ipv6List":{"type":"array","description":"IPv6 subnet info list. [type] value of 3 or 4 is required","items":{"$ref":"#/components/schemas/IPv6SubnetsOpenApiVO"}},"portType":{"type":"integer","description":"Port type. 0: port range 1: port mask. Valid when [type] is 1 or 4","format":"int32"},"portList":{"type":"array","description":"Port list. Valid when [portType] is 0","items":{"type":"string","description":"Port list. Valid when [portType] is 0"}},"portMaskList":{"type":"array","description":"Port mask list. [portType] value of 1 are is required","items":{"$ref":"#/components/schemas/PortMaskOpenApiVO"}},"macAddressList":{"type":"array","description":"MAC address list. Valid when [type] is 2","items":{"$ref":"#/components/schemas/MacAddressOpenApiVO"}},"countryList":{"type":"array","description":"Country list. Valid when [type] is 5","items":{"type":"string","description":"Country list. Valid when [type] is 5"}},"description":{"type":"string","description":"Description. Valid when [type] is 5"},"domainName":{"type":"array","description":"Domain name. Valid when [type] is 7","deprecated":true,"items":{"type":"string","description":"Domain name. Valid when [type] is 7","deprecated":true}},"domainNamePort":{"type":"array","description":"Domain info. Handle situations where there are ports,  [type] values of 7 is required","items":{"$ref":"#/components/schemas/DomainOpenApiVO"}}}},"MacAddressOpenApiVO":{"type":"object","properties":{"ruleId":{"type":"integer","description":"ID of MAC address info","format":"int32"},"name":{"type":"string","description":"MAC address name"},"macAddress":{"type":"string","description":"MAC address"}},"description":"MAC address list. Valid when [type] is 2"},"OperationResponseListGroupOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/GroupOpenApiVO"}}}},"BonjourServiceDetailOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"The id of Bonjour Service."},"name":{"type":"string","description":"The name of Bonjour Service should contain 1 to 64 characters."},"serviceIds":{"type":"array","description":"The Service ID list of Bonjour Service. Service ID is a string in \"_A._B.local\" format, where \"A\" can be lowercase letters/numbers/hyphens (-)/underscore (_), and \"B\" should be lowercase letters. For example: _a1._b.local.Up to 3 entries are allowed for the serviceIds list.","items":{"type":"string","description":"The Service ID list of Bonjour Service. Service ID is a string in \"_A._B.local\" format, where \"A\" can be lowercase letters/numbers/hyphens (-)/underscore (_), and \"B\" should be lowercase letters. For example: _a1._b.local.Up to 3 entries are allowed for the serviceIds list."}},"defaultProfile":{"type":"boolean","description":"Indicating that this profile is default which can not be modified."}}},"OperationResponseResponseDataVOBonjourServiceDetailOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ResponseDataVOBonjourServiceDetailOpenApiVO"}}},"ResponseDataVOBonjourServiceDetailOpenApiVO":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BonjourServiceDetailOpenApiVO"}}}},"ApnProfile":{"required":["apnType","authentication","name","pdpType"],"type":"object","properties":{"id":{"type":"string","description":"APN profile ID"},"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"APN profile name, name should contain 1 to 64 characters."},"pdpType":{"type":"integer","description":"PdpType should be a value as follows: 0: IPv4; 1: IPv6; 2: IPv4 & IPv6.","format":"int32"},"apnType":{"type":"integer","description":"ApnType should be a value as follows: 0: static; 1: dynamic.","format":"int32"},"apn":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Access point name, only for apnType static, should contain 1 to 64 characters and should meet the following requirements:\n    1. Should not start with \"rac\", \"lac\", \"sgsn\" or \"rnc\" and end with \".gprs\", ignoring case.\n    2. Should not contain \".*.\", \".-\", \"-.\" and spaces.\n    3. Should not contain any of the characters #!$%^&*(),:;\"'|\\@. "},"username":{"pattern":"^([\\041-\\053]|[\\055-\\0176]){1,64}$","type":"string","description":"Username should contain 1 to 64 characters, spaces, comma, single quotation marks and double quotation marks are not allowed."},"password":{"pattern":"^([\\041-\\053]|[\\055-\\0176]){1,64}$","type":"string","description":"Password should contain 1 to 64 characters, spaces, comma, single quotation marks and double quotation marks are not allowed."},"authentication":{"type":"integer","description":"Authentication should be a value as follows: 0: None; 1: PAP; 2: CHAP","format":"int32"},"buildIn":{"type":"boolean","description":"Indicates whether this APN profile is a built-in APN profile for SIM card."},"applyToSIM":{"type":"integer","description":"1: apply to SIM1; 2: apply to SIM2; 3: apply to SIM1 and SIM2.","format":"int32"}}},"OperationResponseListApnProfile":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ApnProfile"}}}},"OperationResponseListPpskProfileBriefInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/PpskProfileBriefInfo"}}}},"PpskProfileBriefInfo":{"required":["profileName"],"type":"object","properties":{"id":{"type":"string","description":"PPSK Profile ID"},"profileName":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,62}[^ ]$","type":"string","description":"PPSK Profile Name, should contain 1 to 64 characters."},"ssid":{"type":"array","description":"SSIDs Bound With PPSK Profile","items":{"type":"string","description":"SSIDs Bound With PPSK Profile"}}},"description":"PPSK Profile Brief Info."},"OperationResponsePPSKProfileVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PPSKProfileVO"}}},"PPSKProfileVO":{"required":["ppsk","profileName"],"type":"object","properties":{"id":{"type":"string","description":"PPSK Profile ID"},"profileName":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,62}[^ ]$","type":"string","description":"PPSK Profile Name"},"ssid":{"type":"array","description":"Ssid List Bound With PPSK Profile","items":{"type":"string","description":"Ssid List Bound With PPSK Profile"}},"ppsk":{"type":"array","description":"PSK List In the PPSK Profile","items":{"$ref":"#/components/schemas/PSKVO"}},"type":{"type":"integer","description":"PPSK Profile type: 0：PPSK Without RADIUS; 1: PPSK With Built-In RADIUS.","format":"int32"},"rateLimit":{"$ref":"#/components/schemas/PPSKRateLimitSettingVO"},"expiration":{"$ref":"#/components/schemas/PPSKExpirationVO"},"resource":{"type":"integer","format":"int32"}}},"PSKVO":{"required":["name","psk"],"type":"object","properties":{"name":{"pattern":"^[a-zA-z0-9'!\"#$%&()*,./:;?^_`\\[\\]{|}~<>\\ ][\\041-\\0176]{0,63}$","type":"string","description":"PSK Name"},"psk":{"pattern":"^([A-Za-z0-9\\p{Punct} ]{8,63}|[0-9a-fA-F]{8,63})$","type":"string","description":"Password"},"mac":{"type":"string","description":"Mac Bound With PSK"},"vlan":{"maximum":4094,"minimum":1,"type":"integer","description":"Vlan Bound With PSK","format":"int32"}},"description":"PSK List In the PPSK Profile"},"OperationResponseListPortalResOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/PortalResOpenApiVO"}}}},"PortalResOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Portal ID"},"name":{"type":"string","description":"Portal name"},"enable":{"type":"boolean","description":"Is the portal enable."},"ssidList":{"type":"array","description":"The ssid list of the portal binding.","items":{"type":"string","description":"The ssid list of the portal binding."}},"networkList":{"type":"array","description":"The network ID list of the portal binding.","items":{"type":"string","description":"The network ID list of the portal binding."}},"authType":{"type":"integer","description":"The type of authentication should be a value as follows: 0: No Auth; 1: Simple Password; 2: External Radius; 4: External Portal Server; 11: Hotspot; 15: Ldap; 16: Social Login","format":"int32"},"hotspotTypes":{"type":"array","description":"The enable types of hotspot should be a value as follows: 3: Voucher; 5: Local user 6: SMS; 8: Hotspot Radius; 12: Form Auth","items":{"type":"integer","description":"The enable types of hotspot should be a value as follows: 3: Voucher; 5: Local user 6: SMS; 8: Hotspot Radius; 12: Form Auth","format":"int32"}},"socialLoginTypes":{"type":"array","description":"The enable types of social login should be a value as follows: 17: Google","items":{"type":"integer","description":"The enable types of social login should be a value as follows: 17: Google","format":"int32"}}}},"ExternalRadiusSettingResOpenApiVO":{"type":"object","properties":{"radiusProfileId":{"type":"string","description":"This field represents radius profile ID. Radius profile can be created using 'Create a new RADIUS profile' ('Create a new RADIUS profile template') interface, and radius profile ID can be obtained from 'Get RADIUS profile list' ('Get RADIUS profile template list') interface"},"authMode":{"type":"integer","description":"RADIUS auth mode, should be a value as follows: 1: PAP; 2: CHAP","format":"int32"},"nasId":{"type":"string","description":"RADIUS Attribute: NasID, should contain 1 to 64 characters."},"portalCustom":{"type":"integer","description":"Portal customization, should be a value as follows: 1: Local Web Portal; 2: External Web Portal.","format":"int32"},"externalUrlScheme":{"type":"string","description":"External URL scheme, required when [portalCustom] is 2, value could be 'http' or 'https'."},"externalUrl":{"type":"string","description":"External URL, required when [portalCustom] is 2"},"disconnectReq":{"type":"boolean","description":"Whether to support disconnect messages. Only for Omada Local Controller"},"receiverPort":{"type":"integer","description":"Port for listening to disconnect messages, should be within the range of 1–65535.Only for Omada Local Controller","format":"int32"},"receiverPortStatus":{"type":"integer","description":"Port binding status, should be a value as follow: 1: Disconnect Requests port status running, 2: Disconnect Requests port status disable. Only for Omada Local Controller","format":"int32"}},"description":"External RADIUS Portal setting, required when [authType] is 2."},"HotspotRadiusSettingResOpenApiVO":{"type":"object","properties":{"radiusProfileId":{"type":"string","description":"This field represents radius profile ID. Radius profile can be created using 'Create a new RADIUS profile' ('Create a new RADIUS profile template') interface, and radius profile ID can be obtained from 'Get RADIUS profile list' ('Get RADIUS profile template list') interface"},"authMode":{"type":"integer","description":"RADIUS auth mode, should be a value as follows: 1: PAP; 2: CHAP","format":"int32"},"nasId":{"type":"string","description":"RADIUS Attribute: NasID, should contain 1 to 64 characters."},"authTimeout":{"$ref":"#/components/schemas/AuthTimeOpenApiVO"},"disconnectReq":{"type":"boolean","description":"Whether to support disconnect messages. Only for Omada Local Controller"},"receiverPort":{"type":"integer","description":"Port for listening to disconnect messages, should be within the range of 1–65535.Only for Omada Local Controller","format":"int32"},"receiverPortStatus":{"type":"integer","description":"Port binding status, should be a value as follow: 1: Disconnect Requests port status running, 2: Disconnect Requests port status disable. Only for Omada Local Controller","format":"int32"}},"description":"Hotspot: RADIUS Portal setting, required when [authType] is 11 and hotspot [enabledTypes] contains 8."},"OperationResponsePortalDetailResOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PortalDetailResOpenApiVO"}}},"PortalDetailResOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Portal ID"},"name":{"type":"string","description":"Portal name, should contain 1 to 128 characters"},"enable":{"type":"boolean","description":"Portal enable status"},"ssidList":{"type":"array","description":"SSID ID list bound with this Portal. SSID can be created using 'Create new SSID' ('Create new SSID template') interface, and SSID ID can be obtained from 'Get SSID list' ('Get SSID template list') interface","items":{"type":"string","description":"SSID ID list bound with this Portal. SSID can be created using 'Create new SSID' ('Create new SSID template') interface, and SSID ID can be obtained from 'Get SSID list' ('Get SSID template list') interface"}},"networkList":{"type":"array","description":"Lan network ID list bound with this Portal. LAN Network can be created using 'Create LAN network' ('Create LAN network template') interface, and LAN Network ID can be obtained from 'Get LAN network list' ('Get LAN network template list') interface","items":{"type":"string","description":"Lan network ID list bound with this Portal. LAN Network can be created using 'Create LAN network' ('Create LAN network template') interface, and LAN Network ID can be obtained from 'Get LAN network list' ('Get LAN network template list') interface"}},"authType":{"type":"integer","description":"Auth Type, should be a value as follows: <br/>0：No Authentication; 1：Simple Password;<br/>2: External RADIUS Server; 4：External Portal Server;<br/>11：Hotspot; 15: Ldap; 16: Social Login.","format":"int32"},"authTimeout":{"$ref":"#/components/schemas/AuthTimeOpenApiVO"},"httpsRedirectEnable":{"type":"boolean","description":"With this option enabled, unauthenticated clients will be redirected to the Portal page when they are trying to browse HTTPS websites."},"landingPage":{"type":"integer","description":"LandingPage enum, should be a value as follows: 1: Redirect to the original URL, 2: Redirect to Promotional URL. <br/>With The Original URL selected, clients are directed to the URL they request for after they pass Portal authentication. <br/>With The Promotional URL selected, clients are directed to the specified URL here after they pass Portal authentication.","format":"int32"},"landingUrlScheme":{"type":"string","description":"If Parameter [landingPage] is 2(Redirect to Promotional URL),this Parameter is requested, content is http or https."},"landingUrl":{"type":"string","description":"If Parameter [landingPage] is 2(Redirect to Promotional URL),this Parameter is requested."},"noAuth":{"$ref":"#/components/schemas/NoAuthSetting"},"simplePassword":{"$ref":"#/components/schemas/SimplePasswordSetting"},"hotspot":{"$ref":"#/components/schemas/HotspotSetting"},"socialLogin":{"$ref":"#/components/schemas/SocialLoginSettingOpenApiVO"},"google":{"$ref":"#/components/schemas/GoogleOAuthSettingOpenApiVO"},"sms":{"$ref":"#/components/schemas/SmsSettingResOpenApiVO"},"portalFormId":{"type":"string","description":"Portal form ID, required when [authType] is 11 and hotspot [enabledTypes] contains 12. Portal form can be created using 'Create a new authentication survey' interface, and Portal form ID can be obtained from 'Get authentication survey list' interface"},"hotspotRadius":{"$ref":"#/components/schemas/HotspotRadiusSettingResOpenApiVO"},"externalPortal":{"$ref":"#/components/schemas/ExternalServerPortalSetting"},"externalRadius":{"$ref":"#/components/schemas/ExternalRadiusSettingResOpenApiVO"},"ldap":{"$ref":"#/components/schemas/LdapSetting"}}},"SmsSettingResOpenApiVO":{"type":"object","properties":{"sid":{"type":"string","description":"Twilio SID"},"authToken":{"type":"string","description":"Twilio auth token"},"phoneNum":{"type":"string","description":"Twilio phone number. String value, should contain at least 6 digits such as \"+123456\"."},"maxVerificationCodeEnable":{"type":"boolean","description":"Whether to control the limit of authentication for the same phone number."},"maxVerificationCodeTimes":{"type":"integer","description":"User limit with the same phone number, should be within the range of 1–10. Required when parameter [maxVerificationCodeEnable] is true.","format":"int32"},"authTimeout":{"$ref":"#/components/schemas/AuthTimeOpenApiVO"},"countryCode":{"type":"string","description":"Preset Contry code. String value such as \"+86\"."}},"description":"Hotspot: SMS Portal setting, required when [authType] is 11 and hotspot [enabledTypes] contains 6."},"AdvertisementSettingResOpenApiVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable Advertisement setting"},"pictures":{"type":"array","description":"Advertisement picture list. Up to 5 entries are allowed for the pictures list","items":{"$ref":"#/components/schemas/Portal Picture Info"}},"totalDuration":{"type":"integer","description":"Total duration of advertisement, should be within the range of 1–30 seconds","format":"int32"},"pictureInterval":{"type":"integer","description":"Advertisement picture interval, should be within the range of 1–10 seconds","format":"int32"},"skipEnable":{"type":"boolean","description":"Whether to allow users to skip the advertisement"},"skipDelay":{"type":"integer","description":"Skip delay, should be within the range of 1–10, time unit is second.","format":"int32"}},"description":"Advertisement setting"},"OperationResponsePortalCustomizationPageResOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PortalCustomizationPageResOpenApiVO"}}},"PortalCustomizationPageResOpenApiVO":{"type":"object","properties":{"pageType":{"type":"integer","description":"Page type, should be a value as follows: 1: Use default page, 2: use uploaded page. Required when portal auth type is not 4: External Portal Server","format":"int32"},"portalCustomize":{"$ref":"#/components/schemas/PortalCustomizeResOpenApiVO"},"importedPortalPage":{"$ref":"#/components/schemas/ImportedPortalPageResOpenApiVO"}}},"PortalCustomizeResOpenApiVO":{"type":"object","properties":{"defaultLanguage":{"type":"integer","description":"The controller automatically adjusts the language displayed on the Portal page according to the system language of the clients. If the language is not supported, the controller will use the default language specified here. DefaultLanguage should be a value as follows:<br/>1: en_US (English); 3: cs_CZ (Český); 4: de_DE (Deutsch); 5: da_DK (Dansk); 6: el_GR (ελληνικά);<br/>7: fr_FR (Français); 8: es_ES (Español); 9: nl_NL (Nederlands); 10: it_IT (Italiano); 11: pl_PL (Polski);<br/>12: pt_PT (Português); 13: ru_RU (Русский); 14: sv_SE (Svenska); 15: tr_TR (Türkçe);<br/>16: ar_SA (لغة عربية); <br/>17: ja_JP (日本語); 18: zh_TW (中文(繁體)); 19: th_TH (ไทย); 20: vi_VN (Tiếng Việt); 21: ko_KR (한국어)","format":"int32"},"background":{"type":"integer","description":"Background type, should be a value as follows: 0:library, 1: solid color, 2: picture","format":"int32"},"backgroundPicture":{"$ref":"#/components/schemas/Portal Picture Info"},"mobileBackgroundPicture":{"$ref":"#/components/schemas/Portal Picture Info"},"backgroundColor":{"type":"string","description":"Portal background picture color. Hex color code such as: #ffffff"},"backgroundOpacity":{"type":"integer","description":"Portal background picture transparency percentage, should be within the range of 0–100","format":"int32"},"logoPicture":{"$ref":"#/components/schemas/Portal Picture Info"},"logoDisplay":{"type":"boolean","description":"Whether to display the default logo"},"logoPosition":{"type":"integer","description":"Logo position, should be a value as follow: 1: up; 2: middle; 3: lower","format":"int32"},"logoSize":{"type":"integer","description":"Logo size, should be within the range of 1-300","format":"int32"},"logoPositionRatio":{"type":"number","description":"Logo position ratio, should be within the range of 1-100, represents from high to low.","format":"float"},"logoTranslate":{"type":"integer","description":"Distance of the logo from the top of the container, range: above 0","format":"int32"},"inputBoxColor":{"type":"string","description":"Input box color. Hex color code such as: #ffffff"},"inputBoxOpacity":{"type":"integer","description":"Input box opacity, should be within the range of 0–100","format":"int32"},"inputTextColor":{"type":"string","description":"Input text color. Hex color code such as: #ffffff"},"inputTextOpacity":{"type":"integer","description":"Input text opacity, should be within the range of 0–100","format":"int32"},"buttonColor":{"type":"string","description":"Button color. Hex color code such as: #ffffff"},"buttonOpacity":{"type":"integer","description":"Button opacity, should be within the range of 0–100","format":"int32"},"buttonTextColor":{"type":"string","description":"Button text color. Hex color code such as: #ffffff"},"buttonTextOpacity":{"type":"integer","description":"Button text opacity, should be within the range of 0–100","format":"int32"},"buttonText":{"type":"string","description":"Button text, should contain 0 to 32 characters, default value is \"Log In\""},"formAuthButtonText":{"type":"string","description":"Form auth button text, should contain 0 to 32 characters. Required when [authType] is 11 and hotspot [enabledTypes] contains 12. Default value is \"Take the Survey\""},"buttonPositionRatio":{"type":"number","description":"Button position ratio","format":"float"},"buttonTranslate":{"type":"integer","description":"The distance between the position of the button and the top","format":"int32"},"welcomeEnable":{"type":"boolean","description":"Whether to display the welcome info"},"welcomeInformation":{"type":"string","description":"Welcome information, should contain 1 to 31 characters"},"welcomeTextColor":{"type":"string","description":"Welcome text color. Hex color code such as: #ffffff"},"welcomeTextOpacity":{"type":"integer","description":"Welcome text opacity, should be within the range of 0–100","format":"int32"},"welcomeTextFontSize":{"type":"integer","description":"Welcome text font size, should be within the range of 12–18","format":"int32"},"termsOfServiceEnable":{"type":"boolean","description":"Whether to display terms of service"},"termsOfService":{"type":"string","description":"Service Terms Content"},"termsOfServiceText":{"type":"string","description":"Terms of service text, should contain 0 to 512 characters"},"termsOfServiceFontSize":{"type":"integer","description":"Terms of service text font size, should be within the range of 12–18","format":"int32"},"termsOfServiceUrlTexts":{"type":"array","description":"Terms of service URL texts, match the termsOfServiceText and turn the matching characters into an openable link. Up to 3 entries are allowed for the list","items":{"$ref":"#/components/schemas/TermsOfServiceUrlVO"}},"copyrightEnable":{"type":"boolean","description":"Whether to display the copyright"},"copyright":{"type":"string","description":"Copyright text, should contain 0 to 200 characters"},"copyrightTextColor":{"type":"string","description":"Copyright text color. Hex color code such as: #ffffff"},"copyrightTextOpacity":{"type":"integer","description":"Copyright text opacity, should be within the range of 0–100","format":"int32"},"copyrightTextFontSize":{"type":"integer","description":"Copyright text font size, should be within the range of 12–18","format":"int32"},"redirectionCountDownEnable":{"type":"boolean","description":"Whether to show redirection countdown after authorized"},"advertisement":{"$ref":"#/components/schemas/AdvertisementSettingResOpenApiVO"},"bgPicCoordinatesOfLibrary":{"$ref":"#/components/schemas/BgPicCoordinatesOfLibraryOpenApiVO"},"mobileBgPicCoordinatesOfLibrary":{"$ref":"#/components/schemas/BgPicCoordinatesOfLibraryOpenApiVO"},"bodyContainerEnable":{"type":"boolean","description":"Whether to enable body container."},"termsOfServiceTextColor":{"type":"string","description":"Terms of service text color. Hex color code such as: #ffffff."},"termsOfServiceTextOpacity":{"type":"integer","description":"Terms of service text opacity, should be within the range of 0–100.","format":"int32"},"bodyContainerType":{"type":"integer","description":"Type of body container, 0: none; 1: half; 2: all","format":"int32"},"bodyContainerColor":{"pattern":"^#[0-9A-Fa-f]{6}$","type":"string","description":"Body container color. Hex color code such as: #ffffff."},"bodyContainerOpacity":{"type":"integer","description":"Body container opacity, should be within the range of 0–100.","format":"int32"},"bodyContainerRadius":{"type":"integer","description":"Body container radius, should be within the range of 0–30.","format":"int32"},"bodyContainerBgBlurEnable":{"type":"boolean","description":"Whether to enable body container background blur."},"bodyContainerBgBlur":{"type":"integer","description":"Body container background blurriness, should be within the range of 0–10.","format":"int32"},"inputBoxRadius":{"type":"integer","description":"Input box radius, should be within the range of 0–30.","format":"int32"},"inputBoxBorderColor":{"pattern":"^#[0-9A-Fa-f]{6}$","type":"string","description":"Input box border color. Hex color code such as: #ffffff."},"inputBoxBorderOpacity":{"type":"integer","description":"Input box border opacity, should be within the range of 0–100.","format":"int32"},"backgroundMaskEnable":{"type":"boolean","description":"Whether to enable multiple language."},"backgroundMaskColor":{"pattern":"^#[0-9A-Fa-f]{6}$","type":"string","description":"Background mask color. Hex color code such as: #ffffff."},"backgroundMaskOpacity":{"type":"integer","description":"Background mask opacity, should be within the range of 0–100.","format":"int32"},"buttonRadius":{"type":"integer","description":"Button radius, should be within the range of 0–30.","format":"int32"},"logoHorizontalPosition":{"type":"integer","description":"Position of logo horizontal, 0: left; 1: medium; 2: right","format":"int32"},"descriptionText":{"type":"string","description":"Description text, should contain 0 to 256 characters."},"descriptionTextColor":{"type":"string","description":"Description text color. Hex color code such as: #ffffff."},"descriptionTextOpacity":{"type":"integer","description":"Description text opacity, should be within the range of 0–100.","format":"int32"},"descriptionTextFontSize":{"type":"integer","description":"Description text font size, should be within the range of 12–18.","format":"int32"},"backgroundPictureIndex":{"type":"integer","description":"Index of library background picture, should be within the range of 0-5.","format":"int32"},"pcAlign":{"type":"integer","description":"Position of pc align, 0: left; 1: medium; 2: right","format":"int32"},"enableDeviceSpecificBg":{"type":"boolean","description":"Whether to use different images in mobile and PC devices"},"languageSelectorTextColor":{"type":"string","description":"Language Selector text color. Hex color code such as: #ffffff."},"languageSelectorTextOpacity":{"type":"integer","description":"Language Selector text opacity, should be within the range of 0–100.","format":"int32"}},"description":"Portal customize setting, required when parameter [pageType] is 1"},"OperationResponseOuiGridVOOuiProfileQueryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OuiGridVOOuiProfileQueryOpenApiVO"}}},"OuiGridVOOuiProfileQueryOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OuiProfileQueryOpenApiVO"}},"totalCount":{"type":"integer","format":"int32"}}},"OuiProfileQueryOpenApiVO":{"required":["name"],"type":"object","properties":{"id":{"type":"string","description":"OUI Profile ID"},"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"OUI Profile name should contain 1 to 64 characters."},"count":{"type":"integer","description":"OUI Profile count","format":"int32"},"ouiCombine":{"type":"array","description":"OUI and description","items":{"$ref":"#/components/schemas/OUI and description."}}},"description":"OUIProfileQueryOpenApiVO"},"OperationResponseListOuiProfileSummaryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/OuiProfileSummaryOpenApiVO"}}}},"OuiProfileSummaryOpenApiVO":{"required":["name"],"type":"object","properties":{"id":{"type":"string","description":"OUI Profile ID"},"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"OUI Profile name should contain 1 to 64 characters."}}},"GridVOVlanNetworkAffectingSsidVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VlanNetworkAffectingSsidVO"}}}},"OperationResponseGridVOVlanNetworkAffectingSsidVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOVlanNetworkAffectingSsidVO"}}},"VlanNetworkAffectingSsidVO":{"type":"object","properties":{"id":{"type":"string","description":"SSID ID"},"name":{"type":"string","description":"SSID name"},"wlanId":{"type":"string","description":"WLAN group ID"},"wlanName":{"type":"string","description":"WLAN group name"}}},"AP radio traffic entity":{"type":"object","properties":{"rxPkts":{"type":"integer","description":"Total RX packets","format":"int64"},"txPkts":{"type":"integer","description":"Total TX packets","format":"int64"},"rx":{"type":"integer","description":"Total RX bytes","format":"int64"},"tx":{"type":"integer","description":"Total TX bytes","format":"int64"},"rxDropPkts":{"type":"integer","description":"RX dropped packets","format":"int64"},"txDropPkts":{"type":"integer","description":"TX dropped Packets","format":"int64"},"rxErrPkts":{"type":"integer","description":"RX error packets","format":"int64"},"txErrPkts":{"type":"integer","description":"TX error packets","format":"int64"},"rxRetryPkts":{"type":"integer","description":"RX retried packets","format":"int64"},"txRetryPkts":{"type":"integer","description":"TX retried packets","format":"int64"}}},"ApRadioChannel":{"type":"object","properties":{"actualChannel":{"type":"string","description":"Actual channel of the device"},"maxTxRate":{"type":"integer","description":"TxRate of the device","format":"int32"},"txPower":{"type":"integer","description":"TxPower of the device","format":"int32"},"region":{"type":"integer","description":"Region code of the device","format":"int32"},"bandWidth":{"type":"string","description":"BandWidth of the device"},"rdMode":{"type":"string","description":"RdMode of the device"},"txUtil":{"type":"integer","description":"TxUtil of the device, value range [0, 100].","format":"int32"},"rxUtil":{"type":"integer","description":"RxUtil of the device, value range [0, 100].","format":"int32"},"interUtil":{"type":"integer","description":"InterUtil of the device, value range [0, 100].","format":"int32"},"busyUtil":{"type":"integer","description":"BusyUtil of the device(Support by MTK device), value range [0, 100].","format":"int32"},"aiRoamingOffset":{"type":"integer","description":"AI Roaming offset of the device","format":"int32"}}},"CheckWanLanStatusVO":{"type":"object","properties":{"portName":{"type":"object","additionalProperties":{"type":"string"}},"networkComptent":{"type":"integer","format":"int32"},"adoptedGateway":{"type":"boolean"},"supportIpv6":{"type":"integer","format":"int32"},"wanList":{"type":"array","items":{"$ref":"#/components/schemas/OsgWanStatusVO"}},"iptvPorts":{"type":"array","items":{"type":"string"}},"preOsgModel":{"type":"integer","format":"int32"},"osgAddInAdvance":{"type":"boolean"},"wirelessRouter":{"type":"boolean"},"model":{"type":"string"},"modelVersion":{"type":"string"},"hasGateway":{"type":"boolean"}},"description":"Internet Detail."},"DslSettingsVO":{"type":"object","properties":{"modulation":{"type":"integer","format":"int32"},"annex":{"type":"integer","format":"int32"},"bitSwap":{"type":"integer","format":"int32"},"sra":{"type":"integer","format":"int32"}}},"ExistSiteSettingVO":{"type":"object","properties":{"virtualWan":{"type":"boolean"},"dnsProxy":{"type":"boolean"},"lanDns":{"type":"boolean"},"ipsecFailover":{"type":"boolean"},"wireguard":{"type":"boolean"},"sslVpn":{"type":"boolean"},"googleLdap":{"type":"boolean"},"ipMacBinding":{"type":"boolean"},"urlCategory":{"type":"boolean"},"dnsCache":{"type":"boolean"},"macFilter":{"type":"boolean"},"ipsIds":{"type":"boolean"},"vpnUser":{"type":"boolean"},"oneToOneNat":{"type":"boolean"},"disableNat":{"type":"boolean"},"qos":{"type":"boolean"},"serviceType":{"type":"boolean"},"policyRouting":{"type":"boolean"},"subVpn":{"type":"boolean"},"serviceIptv":{"type":"boolean"},"vpnServer":{"type":"boolean"},"vpnClient":{"type":"boolean"},"siteToSiteVpn":{"type":"boolean"}}},"MacDelayVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"Enable"},"delayTime":{"type":"integer","description":"DelayTime should be within the range of 0–60","format":"int32"}},"description":"Mac Delay"},"OperationResponseVlanForPortDisplayGridVOVlanNetworkAffectingDeviceDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VlanForPortDisplayGridVOVlanNetworkAffectingDeviceDetailVO"}}},"OsgCapVO":{"type":"object","properties":{"supportConfigSync":{"type":"boolean"},"needFullSync":{"type":"boolean"},"supportRunningConfig":{"type":"boolean"},"supportClientPortInfo":{"type":"boolean"},"supportDhcpClient":{"type":"boolean"},"supportArpTableGet":{"type":"boolean"}}},"OsgDetailVO":{"type":"object","properties":{"type":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"mac":{"type":"string","description":"Device mac"},"name":{"type":"string","description":"Device name,default value is the mac address of device"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"compoundModel":{"type":"string","description":"Model complex used in the backend.Ap：model+(country)+modelVersion,  EAP225(EU) v3.0 Ap: specialModel+modelVersion, EAP225-Outdoor-1a20a950b8d950e8 v1.0  Gateway/Switch：model+modelVersion, Osg v3.0"},"showModel":{"type":"string","description":"Model complex shown in the front end.Ap：model+(country)+modelVersion,EAP225(EU) v3.0  Gateway/Switch：model+modelVersion,Osg v3.0"},"specialModel":{"type":"string","description":"Special device model,for example:EAP225-Outdoor-1a20a950b8d950e8"},"firmwareVersion":{"type":"string","description":"Version of firmware,for example:2.5.0 Build 20190118 Rel. 64821"},"version":{"type":"string","description":"Simplified version of firmware,for example:2.5.0"},"hwVersion":{"type":"string","description":"Version of hardware,for example 1.0"},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected;1:Disconnected(Migrating);10:Provisioning;11:Configuring;12:Upgrading;13:Rebooting;14:Connected;15:Connected(Wireless);16:Connected(Migrating);17:Connected(Wireless,Migrating);20:Pending;21:Pending(Wireless);22:Adopting;23:Adopting(Wireless);24:Adopt Failed;25:Adopt Failed(Wireless);26:Managed By Others;27:Managed By Others(Wireless);30:Heartbeat Missed;31:Heartbeat Missed(Wireless);32:Heartbeat Missed(Migrating);33:Heartbeat Missed(Wireless,Migrating);40:Isolated;41:Isolated(Migrating);50:Slice Configuring","format":"int32"},"statusCategory":{"type":"integer","description":"Category of device status,statusCategory should be a value as follows: 0:Disconnected;1:Connected;2:Pending;3:Heartbeat Missed;4:Isolated","format":"int32"},"es":{"type":"boolean","description":"Whether the device is Agile Series Switch"},"site":{"type":"string","description":"Site of the device"},"siteName":{"type":"string","description":"Site name of the device"},"omadacId":{"type":"string","description":"OmadacId of the device"},"compatible":{"type":"integer","description":"Device firmware and controller compatibility type.Compatible should be a value as follows: 0:COMPATIBLE;1:HIGH_MAJOR_VER;2:LOW_MAJOR_VER;3:HIGH_MINOR_VER;4:LOW_MINOR_VER;7:HIGH_COMPONENT_VER;10:DEVICE_NOT_COMPATIBLE;11:HIGH_ADOPT_COMMPONENT;12:DEVICE_CATEGORY_NOT_COMPATIBLE;14:DEVICE_NOT_COMPATIBLE_IN_CLUSTER","format":"int32"},"supportAnomaly":{"type":"boolean","description":"Whether the device firmware support intelligent anomaly detection"},"supportLocatePort":{"type":"boolean","description":"Whether the device supports locating port"},"active":{"type":"boolean","description":"whether to active the device(cloud base exclusive)"},"licenseStatus":{"type":"integer","description":"License status(cloud base exclusive).LicenseStatus should be a value as follows: 0:unActive 1:Unbind 2:Expired 3:active","format":"int32"},"dueTime":{"type":"integer","description":"Expire timestamp of license(cloud base exclusive)","format":"int64"},"dueTimeLeft":{"type":"integer","description":"Milliseconds from the current moment to the expiration time(cloud base exclusive)","format":"int64"},"licenseId":{"type":"string","description":"License key on detail page of device(cloud base exclusive)"},"licenseUnbindingLimit":{"type":"integer","description":"Remaining unbind count for license on detail Page of device(cloud base exclusive)","format":"int32"},"initialUnbindingLimit":{"type":"integer","description":"Initial unbind count for license(cloud base exclusive)","format":"int32"},"category":{"type":"string","description":"Category of license"},"forgetId":{"type":"string","description":"Forget ID of device"},"sn":{"type":"string","description":"SN code of device"},"eost":{"type":"integer","description":"End of service time of device(CBC exclusive)","format":"int64"},"eos":{"type":"integer","description":"End of support time of device(CBC exclusive)","format":"int64"},"inWhitelist":{"type":"boolean","description":"Whether the device is in white list"},"location":{"$ref":"#/components/schemas/DeviceLocationDetailVO"},"addedInAdvanced":{"type":"boolean","description":"Whether the device is added in advanced."},"customId":{"type":"string","description":"Customer ID"},"customName":{"type":"string","description":"Customer name"},"moveSiteId":{"type":"string","description":"Record that the device is in a moveSite operation; if it is null, then it is not in the moveSite operation."},"remember":{"type":"boolean","description":"Whether to remember the device(deprecated)","deprecated":true},"rememberDevice":{"type":"integer","description":"Whether to remember the device.RememberDevice should be a value as follows: 0:off, 1:on, 2: follow site","format":"int32"},"description":{"type":"string","description":"Description of the device"},"disableHwReset":{"type":"boolean","description":"Whether to disable hardware reset"},"templateId":{"type":"string","description":"ID of the template bound to the device"},"templateName":{"type":"string","description":"Name of the template bound to the device"},"boundSiteTemplate":{"type":"boolean","description":"Whether the site where the device is located is bound to a site template"},"deviceTemplateAvailable":{"type":"boolean","description":"Whether there is an available device template for the device; it is false if the model is not supported or the site template has not created the corresponding device template."},"boundDeviceTemplate":{"type":"boolean","description":"Whether the device is bound to device template"},"siteTemplateName":{"type":"string","description":"Template name bound to the site"},"siteTemplateId":{"type":"string","description":"Template ID bound to the site"},"deviceSeriesType":{"type":"integer","description":"Device series type.DeviceSeriesType should be a value as follows: 0:advanced;1:pro","format":"int32"},"resource":{"type":"integer","description":"Data source.Resource should be a value as follows: 0:new created;1:from template;2:override","format":"int32"},"ecspFirstVersion":{"type":"integer","description":"Ecsp first version","format":"int32"},"latestVersion":{"type":"string","description":"Latest firmware version"},"replaceDeviceInfo":{"$ref":"#/components/schemas/DeviceReplaceSettingVO"},"devCap":{"$ref":"#/components/schemas/OsgCapVO"},"portNum":{"type":"integer","format":"int32"},"ledSetting":{"type":"integer","format":"int32"},"snmpSeting":{"$ref":"#/components/schemas/OsgSnmpVO"},"iptvSetting":{"$ref":"#/components/schemas/OsgIptvVO"},"supportHwOffload":{"type":"boolean"},"supportPoe":{"type":"boolean"},"hwOffloadEnable":{"type":"boolean"},"poeSettings":{"type":"array","items":{"$ref":"#/components/schemas/OsgPortPoeVO"}},"lldpEnable":{"type":"boolean"},"lldpSetting":{"type":"integer","format":"int32"},"echoServer":{"type":"string"},"ip":{"type":"string"},"publicIp":{"type":"string"},"ipv6List":{"type":"array","items":{"type":"string"}},"uptime":{"type":"string"},"uptimeLong":{"type":"integer","format":"int64"},"cpuUtil":{"type":"integer","format":"int32"},"memUtil":{"type":"integer","format":"int32"},"lastSeen":{"type":"integer","format":"int64"},"portStats":{"type":"array","items":{"$ref":"#/components/schemas/OsgPortStatVO"}},"virtualWanStats":{"type":"array","items":{"$ref":"#/components/schemas/OsgVirtualWanStatVO"}},"supportLanClientStats":{"type":"boolean"},"supportPortForwardingStatus":{"type":"boolean"},"supportSessionLimitStatus":{"type":"boolean"},"supportChannelUtilizationStatus":{"type":"boolean"},"supportDroppedPacketsStatus":{"type":"boolean"},"supportRetriedPacketsStatus":{"type":"boolean"},"supportBandScan":{"type":"boolean"},"supportNetworkSearch":{"type":"boolean"},"lanClientStats":{"type":"array","items":{"$ref":"#/components/schemas/OsgLanStatVO"}},"controllerId":{"type":"string"},"needUpgrade":{"type":"boolean"},"supportDsl":{"type":"boolean"},"supportVirtualWan":{"type":"boolean"},"supportDualSim":{"type":"integer","format":"int32"},"supportBatchEdit":{"type":"boolean"},"download":{"type":"integer","format":"int64"},"upload":{"type":"integer","format":"int64"},"txRate":{"type":"integer","format":"int64"},"rxRate":{"type":"integer","format":"int64"},"networkComptent":{"type":"integer","format":"int32"},"temp":{"type":"integer","format":"int32"},"fan":{"type":"array","items":{"$ref":"#/components/schemas/OsgFanStatusVO"}},"rps":{"type":"array","items":{"$ref":"#/components/schemas/OsgRpsStatusVO"}},"portConfigs":{"type":"array","items":{"$ref":"#/components/schemas/OsgPortConfigVO"}},"portGeneralConfigs":{"type":"array","items":{"$ref":"#/components/schemas/OsgPortGeneralConfigVO"}},"supportSpeedDuplex":{"type":"boolean"},"supportMirror":{"type":"boolean"},"supportPvid":{"type":"boolean"},"supportWanSetPvid":{"type":"boolean"},"supportSnmp":{"type":"boolean"},"unsupportedPorts":{"type":"array","items":{"type":"integer","format":"int32"}},"combinedGateway":{"type":"boolean"},"speeds":{"type":"array","items":{"type":"integer","format":"int32"}},"supportLte":{"type":"boolean"},"pinSetting":{"$ref":"#/components/schemas/OsgLtePinSettingVO"},"ippt":{"type":"boolean"},"ipptPreconfig":{"type":"boolean"},"supportIppt":{"type":"boolean"},"containNetType5G":{"type":"boolean"},"sshSetting":{"$ref":"#/components/schemas/SshSettingVO"},"multiChipGateway":{"type":"boolean"},"multiChipInfos":{"type":"array","items":{"type":"array","items":{"type":"integer","format":"int32"}}},"supportFlowControl":{"type":"boolean"},"supportPortControl":{"type":"boolean"},"supportLoopbackControl":{"type":"boolean"},"supportPortIsolation":{"type":"boolean"},"supportBandWidthCtrl":{"type":"boolean"},"supportStormCtrlAction":{"type":"boolean"},"supportJumbo":{"type":"boolean"},"jumboSize":{"type":"integer","format":"int32"},"jumboOptions":{"type":"array","items":{"type":"integer","format":"int32"}},"downlinkList":{"type":"array","items":{"$ref":"#/components/schemas/OsgDownLinkVO"}},"wirelessRouter":{"type":"boolean"},"wirelessHealth":{"type":"boolean"},"deviceMisc":{"$ref":"#/components/schemas/WirelessRouterMiscVO"},"wp2g":{"$ref":"#/components/schemas/ApRadioChannel"},"wp5g":{"$ref":"#/components/schemas/ApRadioChannel"},"wp5g2":{"$ref":"#/components/schemas/ApRadioChannel"},"wp6g":{"$ref":"#/components/schemas/ApRadioChannel"},"radioSetting2g":{"$ref":"#/components/schemas/ApRadioSetting"},"radioSetting5g":{"$ref":"#/components/schemas/ApRadioSetting"},"radioSetting5g2":{"$ref":"#/components/schemas/ApRadioSetting"},"radioSetting6g":{"$ref":"#/components/schemas/ApRadioSetting"},"radioTraffic2g":{"$ref":"#/components/schemas/AP radio traffic entity"},"radioTraffic5g":{"$ref":"#/components/schemas/AP radio traffic entity"},"radioTraffic5g2":{"$ref":"#/components/schemas/AP radio traffic entity"},"radioTraffic6g":{"$ref":"#/components/schemas/AP radio traffic entity"},"lbSetting2g":{"$ref":"#/components/schemas/ApLoadBalanceVO"},"lbSetting5g":{"$ref":"#/components/schemas/ApLoadBalanceVO"},"lbSetting5g2":{"$ref":"#/components/schemas/ApLoadBalanceVO"},"lbSetting6g":{"$ref":"#/components/schemas/ApLoadBalanceVO"},"rssiSetting2g":{"$ref":"#/components/schemas/ApRssiThresholdVO"},"rssiSetting5g":{"$ref":"#/components/schemas/ApRssiThresholdVO"},"rssiSetting5g2":{"$ref":"#/components/schemas/ApRssiThresholdVO"},"rssiSetting6g":{"$ref":"#/components/schemas/ApRssiThresholdVO"},"qosSetting2g":{"$ref":"#/components/schemas/ApQosVO"},"qosSetting5g":{"$ref":"#/components/schemas/ApQosVO"},"qosSetting5g2":{"$ref":"#/components/schemas/ApQosVO"},"qosSetting6g":{"$ref":"#/components/schemas/ApQosVO"},"ofdmaEnable2g":{"type":"boolean"},"ofdmaEnable5g":{"type":"boolean"},"ofdmaEnable5g2":{"type":"boolean"},"ofdmaEnable6g":{"type":"boolean"},"wlanId":{"type":"string"},"ssidOverrides":{"type":"array","items":{"$ref":"#/components/schemas/SsidOverrideVO"}},"nonPscEnable":{"type":"boolean"},"channelLimitType":{"type":"integer","format":"int32"},"supportRFScan":{"type":"boolean"},"userNum":{"type":"integer","format":"int32"},"guestNum":{"type":"integer","format":"int32"},"tagIds":{"type":"array","items":{"type":"string"}},"addByTemplate":{"type":"boolean"},"servicesResource":{"type":"integer","format":"int32"},"advancedResource":{"type":"integer","format":"int32"},"commonAdvancedResource":{"type":"integer","format":"int32"},"wirelessAdvancedResource":{"type":"integer","format":"int32"},"radiosResource":{"type":"integer","format":"int32"},"wlansResource":{"type":"integer","format":"int32"},"templateSettings":{"type":"array","items":{"type":"integer","format":"int32"}},"supportIpMacBinding":{"type":"boolean"},"supportNewIpMacBinding":{"type":"boolean"},"poeLimit":{"type":"number","format":"double"},"poeRemain":{"type":"number","format":"double"},"poeRemainPercent":{"type":"number","format":"double"},"osgCap":{"$ref":"#/components/schemas/SiteSettingCapVO"},"osgExist":{"$ref":"#/components/schemas/ExistSiteSettingVO"}},"description":"Gateway detail."},"OsgDownLinkVO":{"type":"object","properties":{"port":{"type":"integer","format":"int32"},"name":{"type":"string"},"mac":{"type":"string"},"deviceName":{"type":"string"},"speed":{"type":"integer","format":"int32"},"duplex":{"type":"integer","format":"int32"},"ip":{"type":"string"},"model":{"type":"string"},"modelVersion":{"type":"string"},"type":{"type":"string"},"wireless":{"type":"boolean"},"stackId":{"type":"string"},"stackName":{"type":"string"}}},"OsgFanStatusVO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"status":{"type":"integer","format":"int32"}}},"OsgIptvVO":{"type":"object","properties":{"igmpEnable":{"type":"boolean"},"igmpVersion":{"pattern":"[23]","type":"string"}}},"OsgLanPortIpv6ConfigVO":{"type":"object","properties":{"addr":{"type":"string","description":"LAN IPv6 address"},"gw":{"type":"string","description":"Gateway"},"priDns":{"type":"string","description":"Primary DNS"},"sndDns":{"type":"string","description":"Secondary DNS"}}},"OsgLanStatVO":{"type":"object","properties":{"lanName":{"type":"string"},"vlan":{"type":"integer","format":"int32"},"ip":{"type":"string"},"rx":{"type":"integer","format":"int64"},"tx":{"type":"integer","format":"int64"},"clientNum":{"type":"integer","format":"int32"},"lanPortIpv6Config":{"$ref":"#/components/schemas/OsgLanPortIpv6ConfigVO"}}},"OsgLinkVO":{"type":"object","properties":{"linkSpeed":{"type":"integer","format":"int32"},"duplex":{"type":"integer","format":"int32"}}},"OsgLtePinSettingVO":{"type":"object","properties":{"cardStatus":{"type":"integer","format":"int32"},"pinLock":{"type":"boolean"},"autoUnLock":{"type":"boolean"},"simCardUsed":{"type":"integer","format":"int32"}}},"OsgPortBandCtrlVO":{"required":["egressEnable","ingressEnable"],"type":"object","properties":{"egressEnable":{"type":"boolean"},"egressLimit":{"type":"integer","format":"int32"},"ingressEnable":{"type":"boolean"},"ingressLimit":{"type":"integer","format":"int32"}}},"OsgPortConfigVO":{"required":["port"],"type":"object","properties":{"portList":{"type":"array","items":{"type":"integer","format":"int32"}},"port":{"type":"integer","format":"int32"},"linkSpeed":{"type":"integer","format":"int32"},"duplex":{"type":"integer","format":"int32"},"portCap":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/OsgLinkVO"}},"supportMirror":{"type":"boolean"},"mirrorEnable":{"type":"boolean"},"mirroredPorts":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"mirrorMode":{"type":"integer","format":"int32"},"pvid":{"type":"integer","format":"int32"},"availablePvids":{"type":"array","items":{"type":"integer","format":"int32"}},"availablePvidNames":{"type":"array","items":{"$ref":"#/components/schemas/OsgPvIdNameVO"}},"portStat":{"$ref":"#/components/schemas/OsgPortStatVO"},"flowControl":{"type":"boolean"},"supportFlowControl":{"type":"boolean"},"status":{"type":"integer","format":"int32"},"supportPortControl":{"type":"boolean"},"supportLoopbackControl":{"type":"boolean"},"loopbackControl":{"type":"integer","format":"int32"},"supportPortIsolation":{"type":"boolean"},"portIsolationEnable":{"type":"boolean"},"supportBandWidthCtrl":{"type":"boolean"},"bandWidthCtrlType":{"type":"integer","format":"int32"},"bandCtrl":{"$ref":"#/components/schemas/OsgPortBandCtrlVO"},"stormCtrl":{"$ref":"#/components/schemas/OsgPortStormCtrlVO"},"resource":{"type":"integer","format":"int32"},"dslSettings":{"$ref":"#/components/schemas/DslSettingsVO"},"portSupportPoe":{"type":"boolean"},"poeMode":{"type":"integer","format":"int32"},"tagSet":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"OsgPortGeneralConfigVO":{"type":"object","properties":{"port":{"type":"integer","format":"int32"},"tagSet":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"resource":{"type":"integer","format":"int32"}}},"OsgPortStatVO":{"type":"object","properties":{"port":{"type":"integer","description":"Port serial number","format":"int32"},"name":{"type":"string","description":"Port name"},"mac":{"type":"string","description":"Port mac"},"portDesc":{"type":"string","description":"Port description"},"type":{"type":"integer","description":"Port type, 0:WAN,1:WAN/LAN,2:LAN;","format":"int32"},"physicalType":{"type":"integer","format":"int32"},"mode":{"type":"integer","description":"Port mode, 0:WAN,1:LAN;","format":"int32"},"poe":{"type":"boolean","description":"Port poe power supply, 1 for active, 0 or null for not"},"poePower":{"type":"number","description":"Port poe power","format":"double"},"status":{"type":"integer","description":"Port status, 0-disconnected; 1-connected;","format":"int32"},"internetState":{"type":"integer","description":"Wan internet state, 0-disconnected; 1-connected;","format":"int32"},"ip":{"type":"string","description":"Ip"},"onlineDetection":{"type":"integer","format":"int32"},"ip2":{"type":"string","description":"Ip2"},"speed":{"type":"integer","description":"Port speed, 1-“10M”，2-“100M”，3-“1000M”","format":"int32"},"duplex":{"type":"integer","description":"Port duplex, 1-”Half”，2-“Full”","format":"int32"},"rx":{"type":"integer","description":"Port total rx bytes","format":"int64"},"rxPkt":{"type":"integer","description":"Port total rx packets","format":"int64"},"rxPktRate":{"type":"integer","description":"Port rx Packet rate, Unit: Pkt/s;","format":"int64"},"rxRate":{"type":"integer","description":"Port rx rate, Unit: KB/s;","format":"int64"},"tx":{"type":"integer","description":"Port total tx bytes","format":"int64"},"txPkt":{"type":"integer","description":"Port total tx packets","format":"int64"},"txPktRate":{"type":"integer","description":"Port tx packet rate, Unit: Pkt/s;","format":"int64"},"txRate":{"type":"integer","description":"Port tx rate, Unit: KB/s;","format":"int64"},"proto":{"type":"string","description":"WAN IPv4 connection type, it supports Static IP, DHCP, PPPoE, L2TP, PPTP, DS-Lite, and MAP-E."},"wanIpv6Comptent":{"type":"integer","description":"Gateway wan ipv6 component version","format":"int32"},"wanPortIpv6Config":{"$ref":"#/components/schemas/OsgWanPortIpv6ConfigVO"},"wanPortIpv4Config":{"$ref":"#/components/schemas/OsgWanPortIpv4ConfigVO"},"mirroredPorts":{"type":"array","description":"Mirrored ports","items":{"$ref":"#/components/schemas/MirroredPort"}},"healthLevel":{"type":"integer","description":"Wan health level","format":"int32"},"latency":{"type":"integer","description":"Wan latency, when mode is wan and device is connected, Unit: ms","format":"int32"},"loss":{"type":"number","description":"Wan packet loss rate, Unit : %","format":"double"},"isp":{"type":"string"},"cardStatus":{"type":"integer","format":"int32"},"chargeMode":{"type":"integer","format":"int32"},"internetStatus":{"type":"integer","format":"int32"},"netType":{"type":"integer","format":"int32"},"band":{"type":"string"},"signal":{"type":"integer","format":"int32"},"rsrp":{"type":"integer","format":"int32"},"rsrq":{"type":"integer","format":"int32"},"snr":{"type":"integer","format":"int32"},"dataUsage":{"type":"number","format":"float"},"totalData":{"type":"number","format":"float"},"ispVersion":{"type":"string"},"roamingStatus":{"type":"integer","format":"int32"},"trafficStatus":{"type":"integer","format":"int32"},"supportSms":{"type":"boolean"},"smsOperator":{"type":"string"},"simCardUsed":{"type":"integer","format":"int32"},"dslModulationType":{"type":"integer","format":"int32"},"annexType":{"type":"integer","format":"int32"},"lineStatus":{"type":"integer","format":"int32"},"maxRxRate":{"type":"integer","format":"int64"},"maxTxRate":{"type":"integer","format":"int64"},"rxSnrMargin":{"type":"integer","format":"int64"},"txSnrMargin":{"type":"integer","format":"int64"},"rxLineAttenuation":{"type":"integer","format":"int64"},"txLineAttenuation":{"type":"integer","format":"int64"},"rxErrorPkts":{"type":"integer","format":"int64"},"txErrorPkts":{"type":"integer","format":"int64"},"txTrainingRate":{"type":"integer","format":"int64"},"rxTrainingRate":{"type":"integer","format":"int64"},"portUuid":{"type":"string"},"maxBandwidth":{"type":"integer","format":"int64"}}},"OsgPortStormCtrlVO":{"required":["broadcastEnable","multicastEnable","unknownUnicastEnable"],"type":"object","properties":{"unknownUnicastEnable":{"type":"boolean"},"unknownUnicast":{"type":"integer","format":"int32"},"multicastEnable":{"type":"boolean"},"multicast":{"type":"integer","format":"int32"},"broadcastEnable":{"type":"boolean"},"broadcast":{"type":"integer","format":"int32"},"action":{"type":"integer","format":"int32"},"recoverTime":{"type":"integer","format":"int32"}}},"OsgPvIdNameVO":{"type":"object","properties":{"pvId":{"type":"integer","format":"int32"},"pvName":{"type":"string"},"qosTagEnable":{"type":"boolean"}}},"OsgRpsStatusVO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"pg":{"type":"boolean"},"su":{"type":"boolean"}}},"OsgSnmpVO":{"type":"object","properties":{"location":{"pattern":"^[!-~][\\040-\\0176]{0,126}[!-~]$|^[!-~]$|$","type":"string"},"contact":{"pattern":"^[\\041-\\0176]{0,128}$","type":"string"},"type":{"type":"integer","format":"int32"}}},"OsgVirtualWanIpv4ConfigVO":{"type":"object","properties":{"gateway":{"type":"string"},"gateway2":{"type":"string"},"priDns":{"type":"string"},"sndDns":{"type":"string"},"priDns2":{"type":"string"},"sndDns2":{"type":"string"},"ip":{"type":"string"},"ip2":{"type":"string"}}},"OsgVirtualWanStatVO":{"type":"object","properties":{"virtualWanId":{"type":"string","description":"Virtual Wan Id"},"name":{"type":"string","description":"Virtual wan name"},"status":{"type":"integer","description":"Virtual Wan status, 0-disconnected; 1-connected;","format":"int32"},"internetState":{"type":"integer","description":"Virtual Wan internet state, 0-disconnected; 1-connected;","format":"int32"},"onlineDetection":{"type":"integer","format":"int32"},"type":{"type":"integer","format":"int32"},"proto":{"type":"string","description":"Virtual WAN ipv4 proto type."},"dslModulationType":{"type":"integer","format":"int32"},"annexType":{"type":"integer","format":"int32"},"lineStatus":{"type":"integer","format":"int32"},"mac":{"type":"string"},"wanPortIpv4Config":{"$ref":"#/components/schemas/OsgVirtualWanIpv4ConfigVO"}}},"OsgWanPortIpv4ConfigVO":{"type":"object","properties":{"ip":{"type":"string"},"netmask":{"type":"string"},"ip2":{"type":"string"},"gateway":{"type":"string"},"gateway2":{"type":"string"},"priDns":{"type":"string"},"sndDns":{"type":"string"},"priDns2":{"type":"string"},"sndDns2":{"type":"string"},"mac":{"type":"string"}},"description":"Wan ipv4 config"},"OsgWanPortIpv6ConfigVO":{"type":"object","properties":{"enable":{"type":"integer","description":"IPv6 enable should be a value as follows: 0: disconnected; 1: connected","format":"int32"},"proto":{"type":"string"},"addr":{"type":"string"},"gateway":{"type":"string"},"priDns":{"type":"string"},"sndDns":{"type":"string"},"internetState":{"type":"integer","description":"It should be a value as follows: 0: disconnected; 1: connected","format":"int32"},"mac":{"type":"string"}},"description":"Wan ipv6 config"},"OsgWanStatusVO":{"type":"object","properties":{"portUuid":{"type":"string"},"portName":{"type":"string"},"enable":{"type":"integer","format":"int32"},"lanId":{"type":"string"},"proto":{"type":"string"},"pdEnable":{"type":"integer","format":"int32"},"prefix":{"type":"string"},"pdSize":{"type":"integer","format":"int32"},"type":{"type":"integer","format":"int32"}}},"OswClientVO":{"type":"object","properties":{"mac":{"type":"string","description":"Client MAC Address"},"name":{"type":"string","description":"Client Name, alias"},"deviceType":{"type":"string","description":"Device Type: iPhone, iPod, Android, PC, printer, TV..."},"ip":{"type":"string","description":"IP Address"},"port":{"type":"integer","description":"(Wired) Port ID","format":"int32"},"lagId":{"type":"integer","description":"(Wired) LAG ID. Exists only when the client is connected to the LAG","format":"int32"},"unit":{"type":"integer","description":"Unit ID","format":"int32"},"standardPort":{"type":"string","description":"Standard port"},"model":{"type":"string","description":"Client Model"}},"description":"Switch downlink clients."},"OswStackDetailVO":{"type":"object","properties":{"type":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"mac":{"type":"string","description":"Device mac"},"name":{"type":"string","description":"Device name,default value is the mac address of device"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"compoundModel":{"type":"string","description":"Model complex used in the backend.Ap：model+(country)+modelVersion,  EAP225(EU) v3.0 Ap: specialModel+modelVersion, EAP225-Outdoor-1a20a950b8d950e8 v1.0  Gateway/Switch：model+modelVersion, Osg v3.0"},"showModel":{"type":"string","description":"Model complex shown in the front end.Ap：model+(country)+modelVersion,EAP225(EU) v3.0  Gateway/Switch：model+modelVersion,Osg v3.0"},"specialModel":{"type":"string","description":"Special device model,for example:EAP225-Outdoor-1a20a950b8d950e8"},"firmwareVersion":{"type":"string","description":"Version of firmware,for example:2.5.0 Build 20190118 Rel. 64821"},"version":{"type":"string","description":"Simplified version of firmware,for example:2.5.0"},"hwVersion":{"type":"string","description":"Version of hardware,for example 1.0"},"status":{"type":"integer","description":"Status is a value as follows: 0: normal; 1:abnormal; 2:stackNotReady","format":"int32"},"statusCategory":{"type":"integer","description":"Category of device status,statusCategory should be a value as follows: 0:Disconnected;1:Connected;2:Pending;3:Heartbeat Missed;4:Isolated","format":"int32"},"es":{"type":"boolean","description":"Whether the switch is Agile Series Switch"},"site":{"type":"string","description":"Site of the device"},"siteName":{"type":"string","description":"Site Name"},"omadacId":{"type":"string","description":"OmadacId of the device"},"compatible":{"type":"integer","description":"Device firmware and controller compatibility type.Compatible should be a value as follows: 0:COMPATIBLE;1:HIGH_MAJOR_VER;2:LOW_MAJOR_VER;3:HIGH_MINOR_VER;4:LOW_MINOR_VER;7:HIGH_COMPONENT_VER;10:DEVICE_NOT_COMPATIBLE;11:HIGH_ADOPT_COMMPONENT;12:DEVICE_CATEGORY_NOT_COMPATIBLE;14:DEVICE_NOT_COMPATIBLE_IN_CLUSTER","format":"int32"},"supportAnomaly":{"type":"boolean","description":"Whether the device firmware support intelligent anomaly detection"},"supportLocatePort":{"type":"boolean","description":"Whether the device supports locating port"},"active":{"type":"boolean","description":"whether to active the device(cloud base exclusive)"},"licenseStatus":{"type":"integer","description":"License status(cloud base exclusive).LicenseStatus should be a value as follows: 0:unActive 1:Unbind 2:Expired 3:active","format":"int32"},"dueTime":{"type":"integer","description":"Expire timestamp of license(cloud base exclusive)","format":"int64"},"dueTimeLeft":{"type":"integer","description":"Milliseconds from the current moment to the expiration time(cloud base exclusive)","format":"int64"},"licenseId":{"type":"string","description":"License key on detail page of device(cloud base exclusive)"},"licenseUnbindingLimit":{"type":"integer","description":"Remaining unbind count for license on detail Page of device(cloud base exclusive)","format":"int32"},"initialUnbindingLimit":{"type":"integer","description":"Initial unbind count for license(cloud base exclusive)","format":"int32"},"category":{"type":"string","description":"Category of license"},"forgetId":{"type":"string","description":"Forget ID of device"},"sn":{"type":"string","description":"Device serial number"},"eost":{"type":"integer","description":"End of service time of device(CBC exclusive)","format":"int64"},"eos":{"type":"integer","description":"End of support time of device(CBC exclusive)","format":"int64"},"inWhitelist":{"type":"boolean","description":"Whether the device is in white list"},"location":{"$ref":"#/components/schemas/DeviceLocationDetailVO"},"addedInAdvanced":{"type":"boolean","description":"Whether the device is added in advanced."},"customId":{"type":"string","description":"Customer ID"},"customName":{"type":"string","description":"Customer name"},"moveSiteId":{"type":"string","description":"Record that the device is in a moveSite operation; if it is null, then it is not in the moveSite operation."},"remember":{"type":"boolean","description":"Whether to remember the device(deprecated)","deprecated":true},"rememberDevice":{"type":"integer","description":"Whether to remember the device.RememberDevice should be a value as follows: 0:off, 1:on, 2: follow site","format":"int32"},"description":{"type":"string","description":"Description of the device"},"disableHwReset":{"type":"boolean","description":"Whether to disable hardware reset"},"templateId":{"type":"string","description":"ID of the template bound to the device"},"templateName":{"type":"string","description":"Name of the template bound to the device"},"boundSiteTemplate":{"type":"boolean","description":"Whether the site where the device is located is bound to a site template"},"deviceTemplateAvailable":{"type":"boolean","description":"Whether there is an available device template for the device; it is false if the model is not supported or the site template has not created the corresponding device template."},"boundDeviceTemplate":{"type":"boolean","description":"Whether the device is bound to device template"},"siteTemplateName":{"type":"string","description":"Template name bound to the site"},"siteTemplateId":{"type":"string","description":"Template ID bound to the site"},"deviceSeriesType":{"type":"integer","description":"Device series type.DeviceSeriesType should be a value as follows: 0:advanced;1:pro","format":"int32"},"resource":{"type":"integer","description":"Data source.Resource should be a value as follows: 0:new created;1:from template;2:override","format":"int32"},"ecspFirstVersion":{"type":"integer","description":"Ecsp first version","format":"int32"},"latestVersion":{"type":"string","description":"Latest firmware version"},"replaceDeviceInfo":{"$ref":"#/components/schemas/DeviceReplaceSettingVO"},"deviceMisc":{"$ref":"#/components/schemas/OswDeviceMiscVO"},"devCap":{"$ref":"#/components/schemas/OswDevCapVO"},"ledSetting":{"type":"integer","description":"LedSetting should be a value as follows: 0: Off; 1: On; 2:follow site","format":"int32"},"mvlanNetworkId":{"type":"string","description":"Management VLAN network ID"},"mvlanBridgeVlan":{"type":"integer","description":"Only valid when mvlanNetworkId is bridge vlan","format":"int32"},"ipSetting":{"$ref":"#/components/schemas/IpSettingVO"},"loopbackDetectEnable":{"type":"boolean","description":"Loopback Detect Enable"},"stp":{"type":"integer","description":"Spanning Tree Protocol should be a value as follows: 1: STP; 2: RSTP; 3: MSTP; 0: OFF","format":"int32"},"priority":{"type":"integer","description":"STP priority","format":"int32"},"helloTime":{"type":"integer","description":"STP helloTime","format":"int32"},"maxAge":{"type":"integer","description":"STP maxAge","format":"int32"},"forwardDelay":{"type":"integer","description":"STP forwardDelay","format":"int32"},"txHoldCount":{"type":"integer","description":"STP txHoldCount","format":"int32"},"maxHops":{"type":"integer","description":"STP maxHops","format":"int32"},"mstp":{"$ref":"#/components/schemas/OswStpMstpVO"},"qosConfig":{"$ref":"#/components/schemas/OswQosConfigVO"},"snmp":{"$ref":"#/components/schemas/OswSnmpVO"},"multicast":{"$ref":"#/components/schemas/OswLanMulticastVO"},"ports":{"type":"array","description":"Port List","items":{"$ref":"#/components/schemas/OswPortVO"}},"lags":{"type":"array","description":"Lag List","items":{"$ref":"#/components/schemas/OswLagVO"}},"tagIds":{"type":"array","description":"The bound TAG ID List","items":{"type":"string","description":"The bound TAG ID List"}},"ip":{"type":"string","description":"Switch IP"},"publicIp":{"type":"string","description":"Public IP"},"ipv6List":{"type":"array","description":"IPV6 List","items":{"type":"string","description":"IPV6 List"}},"lastSeen":{"type":"integer","description":"Last Seen","format":"int64"},"needUpgrade":{"type":"boolean","description":"Need Upgrade"},"uptime":{"type":"string","description":"Uptime"},"uptimeLong":{"type":"integer","description":"UptimeLong, Running duration, Units: seconds","format":"int64"},"cpuUtil":{"type":"integer","description":"Real-time CPU usage","format":"int32"},"memUitl":{"type":"integer","description":"Real-time memory usage","format":"int32"},"poeTotalPower":{"type":"number","description":"PoE Total Power (W)","format":"double"},"poeRemain":{"type":"number","description":"PoE Residual Power (W)","format":"double"},"poeRemainPercent":{"type":"number","description":"PoE Residual Power Percentage","format":"double"},"fanStatus":{"type":"integer","description":"Fan Status should be a value as follows: 0:normal; 1:fault; 2:no fan","format":"int32"},"uplink":{"$ref":"#/components/schemas/OswUplinkVO"},"uplinkPort":{"type":"integer","description":"Uplink port","format":"int32"},"uplinkStPort":{"type":"string","description":"Uplink standard port,unit/slot/port"},"downlinkList":{"type":"array","description":"Downlink Omada device list","items":{"$ref":"#/components/schemas/OswDownlinkVO"}},"stpLinkList":{"type":"array","description":"STP Blocked Link Omada device list","items":{"$ref":"#/components/schemas/OswDownlinkVO"}},"download":{"type":"integer","description":"Total Download (Byte)","format":"int64"},"upload":{"type":"integer","description":"Total Upload (Byte)","format":"int64"},"supportVlanIf":{"type":"boolean","description":"Support Vlan Interface"},"jumbo":{"type":"integer","description":"Jumbo should be within the range of 1518-9216.","format":"int32"},"jumboFollowSite":{"type":"boolean","description":"When enabled, the jumbo frame setting follows the site-level configuration; otherwise, a custom setting is used."},"lagHashAlg":{"type":"integer","description":"It should be a value as follows: 0: SRC MAC; 1: DST MAC; 2: SRC MAC + DST MAC; 3: SRC IP; 4: DST IP; 5: SRC IP + DST IP","format":"int32"},"lagHashAlgFollowSite":{"type":"boolean","description":"When enabled, the lag hash alg setting follows the site-level configuration; otherwise, a custom setting is used."},"speeds":{"type":"array","description":"Supported rate list for all ports. Speeds should be a value as follows: 0:auto; 1:10M; 2:100M; 3:1000M; 4:2.5G; 5:10G; 6:5G; 7:25G; 8:100G; 9:40G; -1:error; no value:all rate supported","items":{"type":"integer","description":"Supported rate list for all ports. Speeds should be a value as follows: 0:auto; 1:10M; 2:100M; 3:1000M; 4:2.5G; 5:10G; 6:5G; 7:25G; 8:100G; 9:40G; -1:error; no value:all rate supported","format":"int32"}},"supportIpv6Acl":{"type":"boolean","description":"Support Ipv6 Acl"},"stackDevice":{"type":"boolean","description":"Stack Device"},"supportVrf":{"type":"boolean","description":"Support Vrf"},"unit":{"type":"integer","description":"Unit ID","format":"int32"},"stackPorts":{"type":"array","description":"Stack Port List","items":{"$ref":"#/components/schemas/OswStackPortGroupVO"}},"stackMsg":{"$ref":"#/components/schemas/StackMsgVO"},"templateSettings":{"type":"array","description":"Template Setting List","items":{"type":"integer","description":"Template Setting List","format":"int32"}},"loop":{"type":"string","description":"Loop information"},"loopbackNum":{"type":"integer","description":"Loopback Num","format":"int32"},"block":{"type":"string","description":"Block information"},"blockNum":{"type":"integer","description":"Block Num","format":"int32"},"txRate":{"type":"integer","description":"Tx Rate","format":"int64"},"rxRate":{"type":"integer","description":"Rx Rate","format":"int64"},"mlagMsg":{"$ref":"#/components/schemas/MlagMsgVO"},"mlagPeerInfo":{"$ref":"#/components/schemas/OswMlagPeerInfoVO"},"sdm":{"$ref":"#/components/schemas/OswSdmTemplateVO"},"terminalPrefix":{"type":"string","description":"TerminalPrefix represents the device name within the terminal function, designed to prevent terminal command recognition errors when device name contains illegal characters such as '#'."},"supportHealth":{"type":"boolean","description":"Support health"},"pmtudEnable":{"type":"boolean","description":"Path MTU Discovery enable."},"supportAutoAddOuiBasedVlan":{"type":"boolean","description":"Whether support auto add oui based vlan."},"mtuList":{"type":"array","description":"MTU List","items":{"$ref":"#/components/schemas/OswMtuCountVO"}},"id":{"type":"string","description":"Stack ID"},"siteId":{"type":"string","description":"Site ID"},"masterMac":{"type":"string","description":"Master Device Mac"},"masterActive":{"type":"boolean","description":"Master Active"},"abnormalReason":{"type":"integer","description":"When status is 1, show abnormal reason.","format":"int32"},"inactiveUnits":{"type":"array","description":"Inactive units","items":{"type":"integer","description":"Inactive units","format":"int32"}},"member":{"type":"array","description":"Member List","items":{"$ref":"#/components/schemas/OswStackMemberVO"}},"stackLags":{"type":"array","description":"Stack Lag List","items":{"$ref":"#/components/schemas/OswStackMemberLagVO"}},"locateEnable":{"type":"boolean","description":"Locate Enable"},"macDelay":{"$ref":"#/components/schemas/MacDelayVO"},"virtualMac":{"type":"string","description":"Virtual Mac"}},"description":"Stack detail"},"OswStackMemberLagVO":{"type":"object","properties":{"id":{"type":"string","description":"ID"},"switchId":{"type":"string","description":"Switch ID"},"switchMac":{"type":"string","description":"Switch MAC Address"},"site":{"type":"string","description":"Site"},"lagId":{"type":"integer","description":"Lag ID","format":"int32"},"name":{"pattern":"^[^ ?\"]$|^[^ ?\"][^?\"]{0,126}[^ ?\"]$","type":"string","description":"Lag Name"},"tagIds":{"type":"array","description":"Lag label ID List","items":{"type":"string","description":"Lag label ID List"}},"tagName":{"type":"string","description":"Lag label Name"},"networkMode":{"type":"integer","description":"Network Mode should be a value as follows: 0: Trunk, 1: Access","format":"int32"},"nativeNetworkId":{"type":"string","description":"Native Network ID, Native Network cannot be selected from Tagged Networks or Untagged Networks."},"nativeBridgeVlan":{"type":"integer","description":"Native Network Bridge Vlan.","format":"int32"},"networkTagsSetting":{"type":"integer","description":"Network Tags Setting should be a value as follows: 0: Allow All; 1: Block All; 2: Custom","format":"int32"},"tagNetworkIds":{"type":"array","description":"Tag Network IDs","items":{"type":"string","description":"Tag Network IDs"}},"tagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Tag Network Bridge Vlan Map","items":{"type":"integer","description":"Tag Network Bridge Vlan Map","format":"int32"}},"description":"Tag Network Bridge Vlan Map"},"untagNetworkIds":{"type":"array","description":"Untag Network IDs","items":{"type":"string","description":"Untag Network IDs"}},"untagBridgeVlanMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Untag Network Bridge Vlan Map","items":{"type":"integer","description":"Untag Network Bridge Vlan Map","format":"int32"}},"description":"Untag Network Bridge Vlan Map"},"voiceNetworkEnable":{"type":"boolean","description":"Voice network enable status"},"voiceNetworkId":{"type":"string","description":"Voice Network ID"},"voiceBridgeVlan":{"type":"integer","description":"Voice Network Bridge Vlan","format":"int32"},"voiceDscpEnable":{"type":"boolean","description":"Voice DSCP enable status"},"voiceDscp":{"type":"integer","description":"Voice DSCP","format":"int32"},"portAlertEnable":{"type":"boolean","description":"Indicates whether port alert is enabled"},"ports":{"type":"array","description":"Lag Ports","items":{"type":"integer","description":"Lag Ports","format":"int32"}},"stPorts":{"type":"array","description":"Lag StPorts","items":{"type":"string","description":"Lag StPorts"}},"allAggregatingPorts":{"uniqueItems":true,"type":"array","description":"All aggregating ports of the current Switch","items":{"type":"integer","description":"All aggregating ports of the current Switch","format":"int32"}},"allMirroringPorts":{"uniqueItems":true,"type":"array","description":"All mirroring ports of the current Switch","items":{"type":"integer","description":"All mirroring ports of the current Switch","format":"int32"}},"allMirroredPorts":{"uniqueItems":true,"type":"array","description":"All mirrored ports on the Switch","items":{"type":"integer","description":"All mirrored ports on the Switch","format":"int32"}},"allMlagPeerLinkPorts":{"uniqueItems":true,"type":"array","description":"All ports configured with M-LAG PeerLink on the current Switch","items":{"type":"integer","description":"All ports configured with M-LAG PeerLink on the current Switch","format":"int32"}},"allMlagDadPorts":{"uniqueItems":true,"type":"array","description":"All ports configured with M-LAG DAD on the current Switch","items":{"type":"integer","description":"All ports configured with M-LAG DAD on the current Switch","format":"int32"}},"lagType":{"type":"integer","description":"Lag Type should be a value as follows: 1: STATIC; 2: LACP; 3: LACP ACTIVE; 4: LACP PASSIVE","format":"int32"},"mlagName":{"type":"string","description":"M-LAG Name"},"mlagEnable":{"type":"boolean","description":"Indicates whether M-LAG is enabled"},"mlagPeerSetting":{"$ref":"#/components/schemas/OswMlagPeerSettingVO"},"lagStatus":{"$ref":"#/components/schemas/OswLagStatusVO"},"disable":{"type":"boolean","description":"Indicates whether to disable"},"profileId":{"type":"string","description":"Profile ID"},"profileName":{"type":"string","description":"Lan Profile Name"},"profileOverrideEnable":{"type":"boolean","description":"Indicates whether to enable Profile Override before v6.2.10; Indicates the fill mode of port configuration after v6.2.10: true: custom; false: follow profile"},"profileVlanOverrideEnable":{"type":"boolean","description":"Indicates the fill mode of vlan configuration: true: custom; false: follow profile"},"linkSpeed":{"type":"integer","description":"Link Speed should be a value as follows: 0: auto; 1: 10M; 2: 100M; 3: 1000M; 4: 2.5G; 5: 10G","format":"int32"},"duplex":{"type":"integer","description":"Duplex should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"},"igmpSnoopingEnable":{"type":"boolean","description":"Indicates whether IGMP Snooping is enabled"},"bandCtrl":{"$ref":"#/components/schemas/OswBandCtrlVO"},"stormCtrl":{"$ref":"#/components/schemas/OswStormCtrlVO"},"bandWidthCtrlType":{"type":"integer","description":"BandWidthCtrlType should be a value as follows: 0: Off; 1: Rate Limit; 2: Storming Control","format":"int32"},"spanningTreeEnable":{"type":"boolean","description":"Indicates whether SpanningTree is enabled"},"spanningTreeSetting":{"$ref":"#/components/schemas/SpanningTreeSettingVO"},"loopbackDetectEnable":{"type":"boolean","description":"Indicates whether loopbackDetect port based is enabled"},"loopbackDetectVlanBasedEnable":{"type":"boolean","description":"Indicates whether loopbackDetect vlan based is enabled"},"igmpFastLeaveEnable":{"type":"boolean","description":"Indicates whether igmp fast leave is enabled"},"mldFastLeaveEnable":{"type":"boolean","description":"Indicates whether mld fast leave is enabled"},"portIsolationEnable":{"type":"boolean","description":"Indicates whether port isolation is enabled"},"eeeEnable":{"type":"boolean","description":"Indicates whether EEE is enabled"},"flowControlEnable":{"type":"boolean","description":"Indicates whether flow control is enabled"},"fastLeaveEnable":{"type":"boolean","description":"Indicates whether igmpSnooping fastLeave is enabled"},"dhcpL2RelaySettings":{"$ref":"#/components/schemas/OswPortDhcpL2RelayVO"},"dot1pPriority":{"type":"integer","description":"Dot1p Priority","format":"int32"},"trustMode":{"type":"integer","description":"TrustMode should be a value as follows: 0: Untrusted; 1: Trust 802.1p; 2: Trust DSCP","format":"int32"},"qosSupport":{"type":"boolean","description":"Indicates whether qos support is enabled"},"esQosSupport":{"type":"boolean","description":"Indicates whether the ES device port supports modification of QoS configuration"},"qosQueueEnable":{"type":"boolean","description":"Indicates whether the ES device port has enabled the Qos scheduling queue configuration"},"queueId":{"type":"integer","description":"ES Qos scheduling queue ID","format":"int32"},"esEnableAllProfileCanAdd":{"type":"boolean","description":"Indicates whether es enable of all profile can continue to add VLANs"},"networkConflict":{"type":"boolean","description":"Indicates whether the VLAN configuration activated on the port is inconsistent with the VLAN configuration in the Profile."},"resource":{"type":"integer","description":"Data Source. Resource should be a value as follows: 0: new created; 1: from template; 2: override","format":"int32"},"mlagPeerAllPortsConfigInfo":{"$ref":"#/components/schemas/OswMlagPeerAllPortsConfigInfoVO"},"locateEnable":{"type":"boolean","description":"Whether locate function is enabled"},"ouiBasedVlanNetworks":{"$ref":"#/components/schemas/OswPortOuiBasedVlanVO"},"standardPorts":{"type":"array","description":"LAG Standard ports","items":{"$ref":"#/components/schemas/OswStandPortVO"}},"allAggregatingStPorts":{"uniqueItems":true,"type":"array","description":"All Aggregating Standard Ports","items":{"$ref":"#/components/schemas/OswStandPortVO"}},"allMirroringStPorts":{"uniqueItems":true,"type":"array","description":"All Mirroring Standard Ports","items":{"$ref":"#/components/schemas/OswStandPortVO"}},"allMirroredStPorts":{"uniqueItems":true,"type":"array","description":"All Mirrored Standard Ports","items":{"$ref":"#/components/schemas/OswStandPortVO"}}},"description":"Stack lags"},"SiteSettingCapVO":{"type":"object","properties":{"firewall":{"type":"boolean"},"sslVpn":{"type":"boolean"},"vpnUser":{"type":"boolean"},"oneToOneNat":{"type":"boolean"},"disableNat":{"type":"boolean"},"ipMacBinding":{"type":"boolean"},"qos":{"type":"boolean"},"wireguard":{"type":"boolean"},"dnsProxy":{"type":"boolean"},"ipsecFailover":{"type":"boolean"},"ldapVpn":{"type":"boolean"},"serviceType":{"type":"boolean"},"dnsCache":{"type":"boolean"},"ipsIds":{"type":"boolean"},"macFilter":{"type":"boolean"},"appControl":{"type":"boolean"},"applicationControl":{"type":"boolean"},"sim":{"type":"boolean"},"clientRateLimit":{"type":"boolean"},"lockToAp":{"type":"boolean"},"voip":{"type":"boolean"},"oltVlan":{"type":"boolean"},"p2p":{"type":"boolean"},"serverOpenVpnGoogleLdap":{"type":"boolean"},"googleLdap":{"type":"boolean"},"virtualWan":{"type":"boolean"},"l2TP":{"type":"boolean"},"ipsec":{"type":"boolean"},"openVpn":{"type":"boolean"},"pptp":{"type":"boolean"},"ipPortGroup":{"type":"boolean"},"supportES":{"type":"boolean"},"supportL2":{"type":"boolean"},"supportL3":{"type":"boolean"},"urlCategory":{"type":"boolean"},"customAcl":{"type":"boolean"},"peerEndpointDomain":{"type":"boolean"},"lanDns":{"type":"boolean"},"isolationSettings":{"type":"boolean"},"dsl":{"type":"boolean"},"ldapSsl":{"type":"boolean"},"packageCaptureGateway":{"type":"boolean"},"cluster":{"type":"boolean"},"clusterModeOn":{"type":"boolean"},"initClusterReminder":{"type":"boolean"},"certProfile":{"type":"boolean"},"networkCheckSupport":{"type":"boolean"},"pingSupport":{"type":"boolean"},"tracerouteSupport":{"type":"boolean"},"dnsLoopUpSupport":{"type":"boolean"},"arpTableSupport":{"type":"boolean"},"packetCaptureSupport":{"type":"boolean"},"terminalSupport":{"type":"boolean"},"serviceIptv":{"type":"boolean"},"subVpn":{"type":"boolean"},"vpnStatus":{"type":"boolean"},"policyRouting":{"type":"boolean"},"internet":{"type":"boolean"},"wireless":{"type":"boolean"},"radios":{"type":"boolean"},"beaconControl":{"type":"boolean"},"wlans":{"type":"boolean"},"networkSecurity":{"type":"boolean"},"attackDefense":{"type":"boolean"},"transmission":{"type":"boolean"},"ddns":{"type":"boolean"},"upnp":{"type":"boolean"},"iptv":{"type":"boolean"},"dhcpReservation":{"type":"boolean"},"snmpServiceSetting":{"type":"boolean"},"ssh":{"type":"boolean"},"statistics":{"type":"boolean"},"speedTest":{"type":"boolean"},"speedTestSchedule":{"type":"boolean"},"domainNoPortGroup":{"type":"boolean"},"serverClientWireguard":{"type":"boolean"},"supportDpi":{"type":"boolean"},"vpnServer":{"type":"boolean"},"vpnClient":{"type":"boolean"},"siteToSiteVpn":{"type":"boolean"},"dpiStat":{"type":"boolean"},"supportShowServerInReservation":{"type":"boolean"},"dpi":{"type":"boolean"},"natTraversal":{"type":"boolean"},"supportGetDhcpLeaseTime":{"type":"boolean"},"clusterHsMode":{"type":"boolean"}}},"SshSettingVO":{"required":["sshEnable"],"type":"object","properties":{"sshEnable":{"type":"boolean"},"sshServerPort":{"type":"integer","format":"int32"},"layer3Access":{"type":"boolean"},"resource":{"type":"integer","format":"int32"}}},"SsidOverrideVO":{"required":["enable","index"],"type":"object","properties":{"index":{"type":"integer","format":"int32"},"globalSsid":{"type":"string"},"bandInfo":{"type":"integer","format":"int32","deprecated":true},"supportBands":{"type":"array","items":{"type":"integer","format":"int32"}},"security":{"type":"integer","format":"int32"},"enable":{"type":"boolean"},"vlanEnable":{"type":"boolean"},"vlanId":{"type":"integer","format":"int32"},"vlanPoolIds":{"type":"string"},"ssid":{"type":"string"},"psk":{"type":"string"},"ssidEnable":{"type":"boolean"},"hidePwd":{"type":"boolean"},"ssidConfigurable":{"type":"boolean"}}},"VlanForPortDisplayGridVOVlanNetworkAffectingDeviceDetailVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VlanNetworkAffectingDeviceDetailVO"}},"hasGateway":{"type":"boolean","description":"It indicates whether the vlan is affecting adopted gateway."}}},"VlanNetworkAffectingDeviceDetailVO":{"type":"object","properties":{"type":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"mac":{"type":"string","description":"Device mac"},"name":{"type":"string","description":"Device name,default value is the mac address of device"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"statusCategory":{"type":"integer","description":"Category of device status,statusCategory should be a value as follows: 0:Disconnected;1:Connected;2:Pending;3:Heartbeat Missed;4:Isolated","format":"int32"},"es":{"type":"boolean","description":"It indicates whether the device is easy managed switch."},"stackId":{"type":"string","description":"Only valid when the device is stack."},"gatewayInfo":{"$ref":"#/components/schemas/VlanNetworkAffectingOsgDetailVO"},"internetInfo":{"$ref":"#/components/schemas/VlanNetworkAffectingInternetDetailVO"},"switchInfo":{"$ref":"#/components/schemas/VlanNetworkAffectingSwitchDetailVO"},"esInfo":{"$ref":"#/components/schemas/VlanNetworkAffectingEsDetailVO"},"stackInfo":{"$ref":"#/components/schemas/VlanNetworkAffectingStackDetailVO"}}},"VlanNetworkAffectingEsDetailVO":{"type":"object","properties":{"affectedPorts":{"$ref":"#/components/schemas/OswPortAndLagNetworkVO"},"clients":{"type":"array","description":"Switch downlink clients.","items":{"$ref":"#/components/schemas/OswClientVO"}},"supportLayout":{"type":"boolean","description":"Whether the device supports reporting port layout information."},"esDetail":{"$ref":"#/components/schemas/ESDetailVO"}},"description":"Agile Series Switch detail info, only valid when type is switch and es is true."},"VlanNetworkAffectingInternetDetailVO":{"type":"object","properties":{"internetVO":{"$ref":"#/components/schemas/CheckWanLanStatusVO"},"affectedPorts":{"type":"array","description":"Affected Internet gateway port list.","items":{"type":"integer","description":"Affected Internet gateway port list.","format":"int32"}}},"description":"Internet Info, only valid when enable WAN Settings Overrides."},"VlanNetworkAffectingOsgDetailVO":{"type":"object","properties":{"gatewayDetail":{"$ref":"#/components/schemas/OsgDetailVO"},"affectedPorts":{"type":"array","description":"Affected gateway port list.","items":{"type":"integer","description":"Affected gateway port list.","format":"int32"}},"nativeVlanPorts":{"type":"array","description":"Ports using this VLAN as the Native Network.","items":{"type":"integer","description":"Ports using this VLAN as the Native Network.","format":"int32"}}},"description":"Gateway Info, only valid when type is gateway."},"VlanNetworkAffectingStackDetailVO":{"type":"object","properties":{"affectedPorts":{"$ref":"#/components/schemas/OswPortAndLagNetworkVO"},"clients":{"type":"array","description":"Switch downlink clients.","items":{"$ref":"#/components/schemas/OswClientVO"}},"supportLayout":{"type":"boolean","description":"Whether the device supports reporting port layout information."},"stackDetail":{"$ref":"#/components/schemas/OswStackDetailVO"},"stackLags":{"type":"array","description":"Stack lags","items":{"$ref":"#/components/schemas/OswStackMemberLagVO"}}},"description":"Stack info, only valid when type is switch and stackId is not empty."},"VlanNetworkAffectingSwitchDetailVO":{"type":"object","properties":{"affectedPorts":{"$ref":"#/components/schemas/OswPortAndLagNetworkVO"},"clients":{"type":"array","description":"Switch downlink clients.","items":{"$ref":"#/components/schemas/OswClientVO"}},"supportLayout":{"type":"boolean","description":"Whether the device supports reporting port layout information."},"switchDetail":{"$ref":"#/components/schemas/OswDetailVO"}},"description":"Switch Info, only valid when type is switch and es is false and stackId is empty."},"WirelessRouterMiscVO":{"type":"object","properties":{"support2g":{"type":"boolean"},"support5g":{"type":"boolean"},"support5g2":{"type":"boolean"},"support6g":{"type":"boolean"},"support11ac":{"type":"boolean"},"supportLag":{"type":"boolean"},"supportMesh":{"type":"integer","format":"int32"},"customizeRegion":{"type":"integer","format":"int32"},"minPower2G":{"type":"integer","format":"int32"},"maxPower2G":{"type":"integer","format":"int32"},"minPower5G":{"type":"integer","format":"int32"},"maxPower5G":{"type":"integer","format":"int32"},"minPower5G2":{"type":"integer","format":"int32"},"maxPower5G2":{"type":"integer","format":"int32"},"minPower6G":{"type":"integer","format":"int32"},"maxPower6G":{"type":"integer","format":"int32"},"supportChannelLimit":{"type":"boolean"},"channelLimitMode":{"type":"integer","format":"int32"},"supportDfs":{"type":"integer","format":"int32"},"supportRoaming":{"type":"integer","format":"int32"}}},"OperationResponseListVlanNetworkAffectingDeviceVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/VlanNetworkAffectingDeviceVO"}}}},"VlanNetworkAffectingDeviceVO":{"type":"object","properties":{"name":{"type":"string","description":"Device Name."},"mac":{"type":"string","description":"Device Mac."},"type":{"type":"integer","description":"Device type, 1: gateway  2: switch  3: ap","format":"int32"},"stackId":{"type":"string","description":"StackId"},"dhcpMode":{"type":"integer","description":"DHCP Mode, Only type is switch will return.","format":"int32"}}},"ApFeatureLimitVO":{"type":"object","properties":{"poeOut":{"type":"boolean","description":"Poe out"},"sfp":{"type":"boolean","description":"Sfp"}},"description":"Functions that need to be restricted under the current power supply mode."},"GridVODeviceVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceVO"}}}},"LocationVO":{"type":"object","properties":{"locked":{"type":"boolean","description":"Whether is locked"},"mapId":{"type":"string","description":"Map id"},"posX":{"type":"number","description":"X-axis position","format":"double"},"posY":{"type":"number","description":"Y-axis position","format":"double"},"installType":{"type":"integer","description":"The installation method affects the default mounting height: CEILING (0), DESK (1), PANEL (2), WALL (3), POLE (4).","format":"int32"},"height":{"type":"number","description":"Height","format":"double"},"angle":{"type":"integer","description":"Angle","format":"int32"},"located":{"type":"boolean","description":"Whether the device is located,false: indicates the disassociation of the device from the map."}},"description":"Device location information on the map; null indicates unplaced."},"OperationResponseGridVODeviceVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVODeviceVO"}}},"OperationResponseWipsConfigOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/WipsConfigOpenApiVO"}}},"WipsConfigOpenApiVO":{"type":"object","properties":{"status":{"type":"boolean","description":"Wireless IPS config status; true:enable, false:disable."},"deauthEn":{"type":"boolean","description":"Wireless IPS deauthenticate config status; true:enable, false:disable."},"dynamicEn":{"type":"boolean","description":"Wireless IPS dynamic block list config status; true:enable, false:disable."},"lockTime":{"type":"integer","description":"Wireless IPS device locking duration config status; It should be within the range of 300–36000; this field is required when parameter [dynamicEn] is true.","format":"int32"}}},"OperationResponseWidsConfigOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/WidsConfigOpenApiVO"}}},"WidsConfigOpenApiVO":{"type":"object","properties":{"status":{"type":"boolean","description":"Wireless IDS config status; true:enable, false:disable."},"level":{"type":"integer","description":"Wireless IDS detection level; It should be a value as follows: 0:High; 1:Low; 2:Custom.","format":"int32"},"detection":{"type":"array","description":"Wireless IDS detection type, the value is returned only when level is custom(2); It should be a value as follows: 0: Signature_disassociation_broadcast; 1: Signature_deauth_broadcast; 2: Detect_apspoofing; 3: Detect_adhoc_using_valid_ssid; 4: Detect_malformed_large_duration; 5: Detect_overflow_eapol_key; 6: Detect_ap_impersonation; 7: Detect_ht_greenfield; 8: Detect_incomplete_ie; 9: Detect_malformed_htie; 10: Detect_malformed_frame_auth; 11: Detect_malformed_assoc_req; 12: Detect_valid_ssid_misuse; 13: Detect_adhoc_network; 14: Detect_client_flood; 16: Detect_power_save_dos_flood_attack; 17: Detect_violence_break.","items":{"type":"integer","description":"Wireless IDS detection type, the value is returned only when level is custom(2); It should be a value as follows: 0: Signature_disassociation_broadcast; 1: Signature_deauth_broadcast; 2: Detect_apspoofing; 3: Detect_adhoc_using_valid_ssid; 4: Detect_malformed_large_duration; 5: Detect_overflow_eapol_key; 6: Detect_ap_impersonation; 7: Detect_ht_greenfield; 8: Detect_incomplete_ie; 9: Detect_malformed_htie; 10: Detect_malformed_frame_auth; 11: Detect_malformed_assoc_req; 12: Detect_valid_ssid_misuse; 13: Detect_adhoc_network; 14: Detect_client_flood; 16: Detect_power_save_dos_flood_attack; 17: Detect_violence_break.","format":"int32"}}}},"OperationResponseIpsInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/IpsInfo"}}},"OperationResponsePortForwardingOpenApiGridVOPortForwardingInfoTemplate":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PortForwardingOpenApiGridVOPortForwardingInfoTemplate"}}},"PortForwardingInfoTemplate":{"required":["dMZ","forwardIp","from","interfaceWanPortId","name","status"],"type":"object","properties":{"id":{"type":"string","description":"Port-forwarding ID"},"site id":{"type":"string","description":"Site ID"},"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name, name should contain 1 to 64 characters."},"status":{"type":"boolean","description":"Port-forwarding enable status."},"from":{"type":"integer","description":"From corresponds with source IP in web. From should be a value as follows: 0: where; 1: limited address","format":"int32"},"limitedAddresses":{"type":"array","description":"Only for limited address","items":{"type":"string","description":"Only for limited address"}},"interfaceWanPortId":{"type":"array","description":"This field represents WAN port ID. WAN port ID can be obtained from can be obtained from 'Get internet basic info' interface.","items":{"type":"string","description":"This field represents WAN port ID. WAN port ID can be obtained from can be obtained from 'Get internet basic info' interface."}},"virtualWanId":{"type":"array","description":"This field represents VirtualWan ID. VirtualWan ID can be obtained from 'Query available virtual WAN list' interface","items":{"type":"string","description":"This field represents VirtualWan ID. VirtualWan ID can be obtained from 'Query available virtual WAN list' interface"}},"wanIps":{"type":"array","description":"WAN IPs","items":{"$ref":"#/components/schemas/PortIpOpenApiVO"}},"externalPort":{"pattern":"^(([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5]))|((([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5]))-(([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5])))$","type":"string","description":"External port corresponds with source port in web. ExternalPort should be within the range of 1–65535."},"forwardIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Forward IP corresponds with destination IP in web. Forward IP"},"forwardPort":{"pattern":"^(([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5]))|((([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5]))-(([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5])))$","type":"string","description":"Forward port corresponds with destination port in web. ForwardPort should be 1 or 1-10, within the range of 1–65535."},"protocol":{"type":"integer","description":"Protocol should be a value as follows: 0: ALL; 1: TCP; 2: UDP.","format":"int32"},"dMZ":{"type":"boolean","description":"With DMZ enabled, all ports are open and the traffic from external network will be forwarded to the specific destination IP in the LAN."}}},"PortForwardingOpenApiGridVOPortForwardingInfoTemplate":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PortForwardingInfoTemplate"}},"supportWanIp":{"type":"boolean","description":"Whether Wan Alias Ip configuration is supported of port forwarding."},"supportVirtualWan":{"type":"boolean","description":"Whether Virtual Wan configuration is supported of port forwarding."},"supportByDsLiteAndMapE":{"type":"boolean","description":"Whether this feature is supported for the DS-Lite or Map-E WAN connection types."}}},"GetAlgOpenApiVO":{"required":["ftp","h323","ipSec","pptp","sip"],"type":"object","properties":{"ftp":{"type":"boolean","description":"Whether to enable the FTP ALG"},"h323":{"type":"boolean","description":"Whether to enable the H323 ALG"},"pptp":{"type":"boolean","description":"Whether to enable the PPTP ALG"},"sip":{"type":"boolean","description":"Whether to enable the SIP ALG"},"ipSec":{"type":"boolean","description":"Whether to enable the IPSec ALG"},"ftpPorts":{"type":"array","description":"The listening port for FTP signaling messages, the default port is 21","items":{"type":"integer","description":"The listening port for FTP signaling messages, the default port is 21","format":"int32"}},"sipTcp":{"type":"boolean","description":"Enable this option if your SIP signaling uses the TCP protocol and the device needs to modify the IP address and port in SIP messages, enabled by default."},"sipUdp":{"type":"boolean","description":"Enable this option if your SIP signaling uses the UDP protocol and the device needs to modify the IP address and port in SIP signaling messages, enabled by default."},"sipPorts":{"type":"array","description":"The listening ports for SIP signaling messages, the default ports are 5060 and 5061","items":{"type":"integer","description":"The listening ports for SIP signaling messages, the default ports are 5060 and 5061","format":"int32"}},"sipDirectSignaling":{"type":"boolean","description":"Enable this option if you want SIP signaling connections to only arrive from registered IP addresses, enabled by default."},"sipDirectMedia":{"type":"boolean","description":"Enable this option if you want SIP media connections to only arrive from registered IP addresses."},"sipTimeout":{"type":"boolean","description":"Enable this option if you want to apply timeout limits to SIP signaling and media connections on the device."},"sipSignalingTimeout":{"type":"integer","description":"Modify this item if you want to adjust the timeout duration for SIP signaling sessions (1 – 86,400 seconds).","format":"int32"},"sipMediaTimeout":{"type":"integer","description":"Modify this item if you want to adjust the timeout duration for SIP media sessions (1 – 86,400 seconds).","format":"int32"},"supportSipAlgConfig":{"type":"boolean","description":"Whether to support custom configuration for ALG"},"existSipAlgConfig":{"type":"boolean","description":"Whether to exist custom configuration for SIP ALG"},"existFtpAlgConfig":{"type":"boolean","description":"Whether to exist custom configuration for FTP ALG"}}},"OperationResponseGetAlgOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GetAlgOpenApiVO"}}},"OperationResponseSiteMulticastRateLimitSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteMulticastRateLimitSetting"}}},"OperationResponseSiteMeshSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteMeshSetting"}}},"GridVOMacFiltering":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/MacFiltering"}}}},"OperationResponseGridVOMacFiltering":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOMacFiltering"}}},"OperationResponseMacFilteringGeneralSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/MacFilteringGeneralSetting"}}},"MacAuthOpenApiVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"MAC-Based Authentication enable status"},"ssids":{"type":"array","description":"SSID list with MAC-Based authentication configured","items":{"$ref":"#/components/schemas/SsidSimpleOpenApiVO"}},"radiusProfileId":{"type":"string","description":"This field represents radius profile ID. Radius profile can be created using 'Create a new RADIUS profile' ('Create a new RADIUS profile template') interface, and radius profile ID can be obtained from 'Get RADIUS profile list' ('Get RADIUS profile template list') interface"},"mabEnable":{"type":"boolean","description":"MAB enable status"},"macFormat":{"type":"integer","description":"Format of the MAC address. MacFormat should be a value as follows: 0: aabbccddeeff, 1: aa-bb-cc-dd-ee-ff, 2: aa:bb:cc:dd:ee:ff, 3: AABBCCDDEEFF, 4: AA-BB-CC-DD-EE-FF, 5: AA:BB:CC:DD:EE:FF","format":"int32"},"emptyPwdEnable":{"type":"boolean","description":"Whether to enable empty password"},"nasId":{"type":"string","description":"NAS ID issued to AP. NasId should contain 1 to 64 characters"}}},"OperationResponseMacAuthOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/MacAuthOpenApiVO"}}},"SsidSimpleOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"ID of SSID"},"ssidId":{"type":"string","description":"SSID ID, kept for backward compatibility and equivalent to id. This field will be removed in a future release; use id instead.","deprecated":true},"ssidName":{"type":"string","description":"This field represents SSID name"}},"description":"SSID list with MAC-Based authentication configured"},"OperationResponseListWlanSimpleOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/WlanSimpleOpenApiVO"}}}},"WlanSimpleOpenApiVO":{"type":"object","properties":{"wlanId":{"type":"string","description":"ID of WLAN"},"wlanName":{"type":"string","description":"Name of WLAN"},"ssidList":{"type":"array","description":"SSID list that support MAC-Based authentication","items":{"$ref":"#/components/schemas/SsidSimpleOpenApiVO"}}}},"OperationResponseSiteLldpSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteLldpSetting"}}},"OperationResponseSiteLedSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteLedSetting"}}},"LanDnsGridVOLanDnsOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/LanDnsOpenApiVO"}},"supportTtl":{"type":"boolean","description":"Whether the current gateway support custom TTL config."}}},"OperationResponseLanDnsGridVOLanDnsOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/LanDnsGridVOLanDnsOpenApiVO"}}},"LanNetworkOpenApiV2GridVOLanNetworkTemplateQueryOpenApiV2VO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/LanNetworkTemplateQueryOpenApiV2VO"}},"supportMultiVlan":{"type":"boolean","description":"Whether multi vlan configuration is supported of the lan netowrk."},"supportRA":{"type":"boolean","description":"Whether Router Advertisement configuration is supported of the lan netowrk."},"supportCustomDhcpOption":{"type":"boolean","description":"Whether custom DHCP option configuration is supported of the lan netowrk."},"supportDhcpNextServer":{"type":"boolean","description":"Whether DHCP Next Server is supported of the lan network."},"supportArpDetection":{"type":"boolean","description":"Whether ARP Detection is supported of the lan network."},"dhcpRangePoolSize":{"type":"integer","description":"The size of DHCP range pool supported by the lan network DHCP.","format":"int32"}}},"LanNetworkTemplateQueryOpenApiV2VO":{"required":["igmpSnoopEnable","name","purpose"],"type":"object","properties":{"id":{"type":"string","description":"LAN network ID"},"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"LAN network name should contain 1 to 128 characters."},"purpose":{"type":"integer","description":"LAN network purpose should be a value as follows: 0: VLAN; 1: interface","format":"int32"},"interfaceIds":{"type":"array","description":"Gateway LAN port IDs (acquired from \"Check WAN/LAN status\")","items":{"type":"string","description":"Gateway LAN port IDs (acquired from \"Check WAN/LAN status\")"}},"vlanType":{"type":"integer","description":"When purpose is interface, VLANType should be a value as follows: 0: Single; 1: Multiple","format":"int32"},"vlans":{"pattern":"^[\\d|\\d-\\d]+(,[\\d|\\d-\\d]+)*$","type":"string","description":"When purpose is interface and VLANType is 1, batch create VLANs. VLAN format: 200, 1-100."},"vlan":{"type":"integer","description":"Only Valid when vlanType is 0. Vlan should be within the range of 1-4094.","format":"int32"},"application":{"type":"integer","description":"Effective device type should be a value as follows: 0: Gateway and Switch; 1: Switch","format":"int32"},"gatewaySubnet":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])/(\\d|((1|2)\\d)|(30))\\b","type":"string","description":"When purpose is interface, gateway subnet is needed. Format: IP/Mask"},"dhcpSettingsVO":{"$ref":"#/components/schemas/DhcpSettingsTemplateOpenApiVO"},"domain":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"The domain of this network"},"igmpSnoopEnable":{"type":"boolean","description":"Enable IGMP snooping"},"mldSnoopEnable":{"type":"boolean","description":"Enable MLD snooping"},"dhcpL2RelayEnable":{"type":"boolean","description":"The switch of DHCP L2 relay"},"dhcpGuard":{"$ref":"#/components/schemas/Dhcp Servers setting"},"dhcpv6Guard":{"$ref":"#/components/schemas/Dhcpv6 Servers setting"},"portal":{"type":"boolean","description":"Show portal is enabled or not"},"portalId":{"type":"string","description":"Show portal ID"},"portalName":{"type":"string","description":"Show related portal name"},"accessControlRule":{"type":"boolean","description":"Show AccessControlRule is enabled or not"},"rateLimit":{"type":"boolean","description":"Show RateLimit is enabled or not"},"lanNeworkIpv6Config":{"$ref":"#/components/schemas/LanNetworkIpv6ConfigTemplateOpenApiVO"},"allLan":{"type":"boolean","description":"When Internet pre-config is closed or Internet pre-config is Universal, allLAN is \"true\"; after adopting gateway, allLAN is \"false\"."},"primary":{"type":"boolean","description":"Primary"}}},"OperationResponseLanNetworkOpenApiV2GridVOLanNetworkTemplateQueryOpenApiV2VO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/LanNetworkOpenApiV2GridVOLanNetworkTemplateQueryOpenApiV2VO"}}},"OperationResponseLanNetworkTemplateQueryOpenApiV3VO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/LanNetworkTemplateQueryOpenApiV3VO"}}},"LanNetworkVO":{"required":["igmpSnoopEnable","name","purpose"],"type":"object","properties":{"id":{"type":"string","description":"LAN network ID"},"site":{"type":"string","description":"Site ID"},"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"LAN network name should contain 1 to 128 characters."},"purpose":{"type":"string","description":"LAN network purpose should be as follows: vlan or interface"},"interfaceIds":{"type":"array","description":"Gateway LAN port IDs (acquired from \"Check WAN/LAN status\")","items":{"type":"string","description":"Gateway LAN port IDs (acquired from \"Check WAN/LAN status\")"}},"vlanType":{"type":"integer","description":"When purpose is interface, VLANType should be a value as follows: 0: Single; 1: Multiple","format":"int32"},"vlans":{"pattern":"^[\\d|\\d-\\d]+(,[\\d|\\d-\\d]+)*$","type":"string","description":"When purpose is interface and VLANType is 1, batch create VLANs. VLAN format: 200, 1-100."},"application":{"type":"integer","description":"Effective device type should be a value as follows: 0: Gateway and Switch; 1: Switch","format":"int32"},"isolation":{"type":"boolean","description":"Whether network isolated."},"vlan":{"type":"integer","description":"Only Valid when vlanType is 0. Vlan should be within the range of 1-4094.","format":"int32"},"gatewaySubnet":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])/(\\d|((1|2)\\d)|(30))\\b","type":"string","description":"When purpose is interface, gateway subnet is needed. Format: IP/Mask"},"dhcpSettings":{"$ref":"#/components/schemas/DhcpSettingInfo"},"domain":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"The domain of this network"},"igmpSnoopEnable":{"type":"boolean","description":"Enable IGMP snooping"},"fastLeaveEnable":{"type":"boolean","description":"IGMP Snooping fast leave enable status"},"mldSnoopEnable":{"type":"boolean","description":"Enable MLD snooping"},"dhcpv6Guard":{"$ref":"#/components/schemas/Dhcpv6 Servers setting"},"dhcpL2RelayEnable":{"type":"boolean","description":"The switch of DHCP L2 relay"},"dhcpGuard":{"$ref":"#/components/schemas/Dhcp Servers setting"},"portal":{"type":"boolean","description":"Show portal is enabled or not"},"portalId":{"type":"string","description":"Show portal ID"},"portalName":{"type":"string","description":"Show related portal name"},"accessControlRule":{"type":"boolean","description":"Show AccessControlRule is enabled or not"},"rateLimit":{"type":"boolean","description":"Show RateLimit is enabled or not"},"lanNeworkIpv6Config":{"$ref":"#/components/schemas/Lan network IPV6 config"},"allLan":{"type":"boolean","description":"When Internet pre-config is closed or Internet pre-config is Universal, allLAN is \"true\"; after adopting gateway, allLAN is \"false\"."},"resource":{"type":"integer","description":"Resource is a value as follows: 0: new created; 1: from template; 2: override","format":"int32"},"origName":{"type":"string","description":"Original name"},"arpDetectionEnable":{"type":"boolean","description":"Enable arp detection. Only valid when deviceType is 1 and gateway supports this feature."},"qosQueueEnable":{"type":"boolean","description":"The switch of QoS queue."},"queueId":{"type":"integer","description":"QoS queue Id.","format":"int32"},"existMultiVlan":{"type":"boolean","description":"Whether VLAN Type is Multiple."},"existRA":{"type":"boolean","description":"Whether RA has been configured."},"existCustomDhcpOption":{"type":"boolean","description":"Whether custom DHCP Options has been configured."},"existDhcpNextServer":{"type":"boolean","description":"Whether DHCP Next Server has been configured."},"existArpDetection":{"type":"boolean","description":"Whether Arp Detection is configured."},"existNetworkIsolation":{"type":"boolean","description":"Whether Network Isolation is configured."},"deviceType":{"type":"integer","description":"DHCP Server Device type. It should be a value as follows: 0:External Device 1:gateway 2:switch 3:none","format":"int32"},"deviceMac":{"type":"string","description":"DHCP Server Device mac. Only valid when deviceType is 1 or 2. When deviceType is 1, deviceMac can be empty when there is no gateway in the site."},"stackId":{"type":"string","description":"DHCP Server Device stackId. Only valid when deviceType is 2 and the selected device is stack"},"vrfId":{"type":"string","description":"VRF ID"},"ip":{"$ref":"#/components/schemas/OswIpSettingVO"},"mode":{"type":"integer","description":"DHCP mode. 0: None 1: DHCP Server 2: DHCP Relay. Only valid when deviceType is 2.","format":"int32"},"dhcpServer":{"$ref":"#/components/schemas/OswDhcpServerVO"},"dhcpRelay":{"$ref":"#/components/schemas/OswDhcpRelayVO"},"state":{"type":"integer","description":"Network delivering state. It should be a value as follows: 0: not in delivering 1:delivering 2. deliver done","format":"int32"},"totalIpNum":{"type":"integer","description":"Total ip num","format":"int64"},"dhcpServerNum":{"type":"integer","description":"The number of dhcp server devices in effect, Only valid when vlanType is 0.","format":"int32"},"dhcpIp":{"$ref":"#/components/schemas/DhcpIpVO"},"subnetOverrideEnable":{"type":"boolean","description":"Subnet override enable status"},"subnetOverride":{"type":"boolean","description":"Subnet override"},"interface":{"type":"boolean"},"primary":{"type":"boolean","description":"Primary"}},"description":"LANNetworkVO"},"OperationResponseListLanNetworkVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/LanNetworkVO"}}}},"GridVOLanMulticastVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/LanMulticastVO"}}}},"OperationResponseGridVOLanMulticastVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOLanMulticastVO"}}},"OperationResponseSiteLagHashAlgOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteLagHashAlgOpenApiVO"}}},"OperationResponseSiteJumboOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteJumboOpenApiVO"}}},"GridVOIPMacBinding":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/IPMacBinding"}}}},"OperationResponseGridVOIPMacBinding":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOIPMacBinding"}}},"OperationResponseIPMacBindingGeneralSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/IPMacBindingGeneralSetting"}}},"OperationResponseWanLoadBalanceOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/WanLoadBalanceOpenApiVO"}}},"InternetBaseInfoTemplateOpenApiVO":{"required":["gatewayModel","interval","portList","preConfiguration"],"type":"object","properties":{"preConfiguration":{"type":"boolean","description":"You can pre-configure the model-relative settings when it is true."},"gatewayModel":{"type":"integer","description":"Gateway model should be a value as follows: 2: Universal; 9: G36 v1; 10: G611 v1; 13: G36W-4G v1.","format":"int32"},"portList":{"type":"array","description":"Port info list","items":{"$ref":"#/components/schemas/internet basic info"}},"interval":{"type":"integer","description":"Online detection interval(second), 0 means disable.","format":"int32"}}},"OperationResponseInternetBaseInfoTemplateOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/InternetBaseInfoTemplateOpenApiVO"}}},"internet basic info":{"type":"object","properties":{"portId":{"type":"string","description":"Port ID"},"portName":{"type":"string","description":"Port name"},"portMode":{"type":"integer","description":"Port mode should be a value as follows: 0: WAN; 1: LAN.","format":"int32"},"portType":{"type":"integer","description":"Port type should be a value as follows: 0: WAN; 1: WAN/LAN.","format":"int32"}},"description":"Port info list"},"GatewayTemplateInfo":{"type":"object","properties":{"id":{"type":"string","description":"The ID of gateway template"},"showModel":{"type":"string","description":"Gateway model description"},"portConfigs":{"type":"array","description":"Gateway port configs","items":{"$ref":"#/components/schemas/GatewayPortConfig"}}}},"OperationResponseGatewayTemplateInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GatewayTemplateInfo"}}},"OperationResponseListOsgPortInfoOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/OsgPortInfoOpenApiVO"}}}},"OperationResponseFirewallSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/FirewallSetting"}}},"OperationResponseDnsCacheOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DnsCacheOpenApiVO"}}},"DeviceTemplateBriefOpenApiVO":{"type":"object","properties":{"ID":{"type":"string","description":"The ID of device template."},"templateName":{"type":"string","description":"The name of device template."},"deviceType":{"type":"string","description":"The type of device."},"showModel":{"type":"string","description":"The model name of device."}}},"GridVODeviceTemplateBriefOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceTemplateBriefOpenApiVO"}}}},"OperationResponseGridVODeviceTemplateBriefOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVODeviceTemplateBriefOpenApiVO"}}},"GridVODeviceBindOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceBindOpenApiVO"}}}},"OperationResponseGridVODeviceBindOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVODeviceBindOpenApiVO"}}},"DeviceTemplateForVlanVO":{"type":"object","properties":{"id":{"type":"string","description":"Device template id."},"mac":{"type":"string","description":"Device template mac, it is the same with id. "},"name":{"type":"string","description":"Device template name."},"mode":{"type":"string","description":"Device template model."},"modelVersion":{"type":"string","description":"Device template model version."},"showModel":{"type":"string","description":"Device template show model"},"type":{"type":"string","description":"Device template type, it should be a value as follows: \"gateway\", \"switch\""}},"description":"DeviceTemplateForVlanVO"},"OperationResponseListDeviceTemplateForVlanVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/DeviceTemplateForVlanVO"}}}},"DeviceTemplateGridOpenApiVODeviceTemplateOpenApiQueryVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceTemplateOpenApiQueryVO"}},"existGateway":{"type":"boolean","description":"Exist gateway template or not."}}},"DeviceTemplateOpenApiQueryVO":{"type":"object","properties":{"id":{"type":"string"},"templateName":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string"},"model":{"type":"string"},"modelVersion":{"type":"string"},"showModel":{"type":"string"},"deviceType":{"type":"string"},"bindDeviceNum":{"type":"integer","format":"int32"},"override":{"type":"string"},"wirelessRouter":{"type":"boolean"},"autoBind":{"type":"boolean"},"status":{"type":"integer","format":"int32"},"multiBind":{"type":"boolean"},"switchType":{"type":"integer","format":"int32"},"templateSettings":{"type":"array","items":{"type":"integer","format":"int32"}}}},"OperationResponseDeviceTemplateGridOpenApiVODeviceTemplateOpenApiQueryVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceTemplateGridOpenApiVODeviceTemplateOpenApiQueryVO"}}},"AvailableTemplateOpenApiVO":{"type":"object","properties":{"templateName":{"type":"string","description":"The name of template."},"templateId":{"type":"string","description":"The id of template."},"multiBind":{"type":"boolean","description":"whether to bind multiple devices."},"model":{"type":"string","description":"The model name of template."},"modelVersion":{"type":"string","description":"The model version of template.For example: 1.0"}},"description":"The available templates of device."},"DeviceAvailableTemplateOpenApiVO":{"type":"object","properties":{"model":{"type":"string","description":"The model name of device."},"modelVersion":{"type":"string","description":"The model version of device."},"mac":{"type":"string","description":"The mac of device."},"name":{"type":"string","description":"The name of device, default value is mac."},"validTemplates":{"type":"array","description":"The available templates of device.","items":{"$ref":"#/components/schemas/AvailableTemplateOpenApiVO"}}}},"GridVODeviceAvailableTemplateOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceAvailableTemplateOpenApiVO"}}}},"OperationResponseGridVODeviceAvailableTemplateOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVODeviceAvailableTemplateOpenApiVO"}}},"OperationResponseUnSupportRadSecOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/UnSupportRadSecOpenApiVO"}}},"UnSupportRadSecOpenApiVO":{"type":"object","properties":{"exist":{"type":"boolean","description":"Whether there exists devices that do not support the RadSec feature."}}},"ApGroupStatusOpenApiVO":{"type":"object","properties":{"exceeded":{"type":"boolean","description":"whether the number of AP Groups exceeds the limit"},"apGroupNum":{"type":"integer","description":"the number of AP Groups","format":"int64"}}},"OperationResponseApGroupStatusOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApGroupStatusOpenApiVO"}}},"CliTemplateOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"CLI configuration ID"},"name":{"type":"string","description":"CLI configuration name"},"description":{"type":"string","description":"CLI configuration description, it should be within the range of 0 - 256 characters."},"status":{"type":"integer","description":"CLI configuration status, it should be a value as follows: 0: active, 1: inactive","format":"int32"},"apply":{"type":"boolean","description":"Whether the CLI configuration can be applied. Only the CLI configuration in inactive state can be applied."}},"description":"CLI template configuration entry"},"GridVOCliTemplateOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CliTemplateOpenApiVO"}}}},"OperationResponseGridVOCliTemplateOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOCliTemplateOpenApiVO"}}},"CliConfigTemplateOpenApiVO":{"required":["cliConfig"],"type":"object","properties":{"omadacId":{"type":"string","description":"Omada ID"},"siteId":{"type":"string","description":"Site ID"},"cliType":{"type":"integer","description":"CLI configuration type, it should be a value as follows: 0：site CLI.","format":"int32"},"id":{"type":"string","description":"CLI configuration ID"},"name":{"type":"string","description":"CLI configuration name"},"deviceType":{"type":"string","description":"Device type for CLI configuration application, it should be a value as follows: switch."},"description":{"type":"string","description":"CLI configuration description, it should be within the range of 0 - 256 characters."},"status":{"type":"integer","description":"CLI configuration status, it should be a value as follows: 0: active, 1: inactive","format":"int32"},"cliConfig":{"type":"string","description":"CLI configuration content"}},"description":"Get the CLI template configuration entry"},"OperationResponseCliConfigTemplateOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CliConfigTemplateOpenApiVO"}}},"OperationResponseSiteChannelLimitSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteChannelLimitSetting"}}},"OperationResponseSiteSettingCapOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteSettingCapOpenApiVO"}}},"SiteSettingCapOpenApiVO":{"type":"object","properties":{"firewall":{"type":"boolean","description":"Whether support firewall configuration."},"sslVpn":{"type":"boolean","description":"Whether support SSL VPN configuration."},"vpnUser":{"type":"boolean","description":"Whether support VPN User configuration."},"oneToOneNat":{"type":"boolean","description":"Whether support one-to-one NAT configuration."},"disableNat":{"type":"boolean","description":"Whether support disable NAT configuration."},"ipMacBinding":{"type":"boolean","description":"Whether support ipMacBinding configuration."},"qos":{"type":"boolean","description":"Whether support QOS configuration."},"wireguard":{"type":"boolean","description":"Whether support wireguard VPN configuration."},"dnsProxy":{"type":"boolean","description":"Whether support dnsProxy configuration."},"ipsecFailover":{"type":"boolean","description":"Whether support IPsec failover configuration."},"ldapVpn":{"type":"boolean","description":"Whether support VPN configuration with LDAP."},"serviceType":{"type":"boolean","description":"Whether support serviceType configuration."},"ipsIds":{"type":"boolean","description":"Whether support IPS configuration."},"macFilter":{"type":"boolean","description":"Whether support network security-mac filter configuration."},"sim":{"type":"boolean","description":"Whether support SIM configuration."},"clientRateLimit":{"type":"boolean","description":"false: there is a wireless route device that does not support ClientRateLimit.true or null: all devices support ClientRateLimit"},"lockToAp":{"type":"boolean","description":"false: there is a wireless route device that does not support LockToAp.true or null: all devices support LockToAp"},"voip":{"type":"boolean","description":"Whether support voip configuration."},"oltVlan":{"type":"boolean","description":"An OLT device exists."},"p2p":{"type":"boolean","description":"An P2P device exists."},"serverOpenVpnGoogleLdap":{"type":"boolean","description":"Whether server-openvpn support Google LDAP."},"virtualWan":{"type":"boolean","description":"Whether support virtual WAN configuration."},"l2TP":{"type":"boolean","description":"Whether support L2TP VPN configuration."},"ipsec":{"type":"boolean","description":"Whether support Ipsec VPN configuration."},"ipPortGroup":{"type":"boolean","description":"Whether support IP-Port Group configuration."},"supportES":{"type":"boolean","description":"Whether the site supports adopting Agile Series Switches"},"supportL2":{"type":"boolean","description":"Whether the site supports adopting Non-Agile Series Switches"},"urlCategory":{"type":"boolean","description":"Whether Url Filter support category mode."},"customAcl":{"type":"boolean","description":"Whether ACL support custom mode."},"peerEndpointDomain":{"type":"boolean","description":"Whether peer-endpoint support entering domain names."},"lanDns":{"type":"boolean","description":"Whether support LAN DNS configuration."},"IsolationSettings":{"type":"boolean","description":"Whether support Network Isolation."},"dsl":{"type":"boolean","description":"Whether support DSL configuration."},"ldapSsl":{"type":"boolean","description":"Whether SSL VPN support ldap."},"googleLdap":{"type":"boolean","description":"Whether support Google LDAP configuration."},"dpi":{"type":"boolean","description":"Whether support DPI configuration. Deprecated.","deprecated":true},"packageCaptureGateway":{"type":"boolean","description":"Whether the gateway can be selected in the packet capture page."},"cluster":{"type":"boolean","description":"Whether support cluster mode."},"clusterModeOn":{"type":"boolean","description":"Whether the current software is running in cluster mode."},"initClusterReminder":{"type":"boolean","description":"Whether the current cluster prompts that it has not been restarted after configuration initialization."},"dpiStat":{"type":"boolean","description":"Whether support dpi stat.Deprecated, same as dpi. Deprecated.","deprecated":true},"serviceIptv":{"type":"boolean","description":"Whether support IGMP or IPTV."},"subVpn":{"type":"boolean","description":"Whether support VPN menu in VPN module."},"vpnStatus":{"type":"boolean","description":"Whether support vpnStatus."},"policyRouting":{"type":"boolean","description":"Whether support policyRouting."},"supportDpi":{"type":"boolean","description":"Whether support Dpi."},"supportShowServerInReservation":{"type":"boolean","description":"Whether support show server in DHCP Reservation."},"speedTest":{"type":"boolean","description":"Whether support speedTest."},"natTraversal":{"type":"boolean","description":"Whether support natTraversal."}}},"BindSiteBriefOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Site Template ID"},"name":{"type":"string","description":"Name of the site template, contains 1 to 64 characters."},"status":{"type":"string","description":"Configuration status of the site."},"overrides":{"uniqueItems":true,"type":"array","description":"Override configurations of the site.","items":{"type":"string","description":"Override configurations of the site."}}}},"OperationResponseBindSiteBriefOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/BindSiteBriefOpenApiVO"}}},"OperationResponseBandwidthControl":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/BandwidthControl"}}},"GridVOBandwidthControlRule":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/BandwidthControlRule"}}}},"OperationResponseGridVOBandwidthControlRule":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOBandwidthControlRule"}}},"DeviceGatewayModelOpenApiVO":{"type":"object","properties":{"model":{"type":"string","description":"The model name of device."},"modelVersion":{"type":"string","description":"The model version of device.For example: 1.0"},"showModel":{"type":"string","description":"A complete description of the device model, including name and version."},"wirelessRouter":{"type":"boolean","description":"Whether the device supports wirelessrouter."}}},"DeviceSwitchModelOpenApiVO":{"type":"object","properties":{"model":{"type":"string","description":"The model name of device."},"modelVersion":{"type":"string","description":"The model version of device.For example: 1.0"},"showModel":{"type":"string","description":"A complete description of the device model, including name and version."},"es":{"type":"boolean","description":"Whether the device is ES or not."},"supportVlanIf":{"type":"boolean","description":"Whether the device supports VlanIf."},"supportVrf":{"type":"boolean","description":"Whether the device supports Vrf."}}},"OperationResponseValidDeviceModelOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ValidDeviceModelOpenApiVO"}}},"ValidDeviceModelOpenApiVO":{"type":"object","properties":{"gateways":{"type":"array","items":{"$ref":"#/components/schemas/DeviceGatewayModelOpenApiVO"}},"switches":{"type":"array","items":{"$ref":"#/components/schemas/DeviceSwitchModelOpenApiVO"}}}},"OperationResponseSitesSite":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SitesSite"}}},"SitesSite":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/site"}},"allSiteIds":{"type":"array","description":"all sites id.","items":{"type":"string","description":"all sites id."}}}},"site":{"type":"object","properties":{"id":{"type":"string","description":"site id"},"name":{"type":"string","description":"site name"},"type":{"type":"integer","description":"site type. 0:advanced ; 1:pro","format":"int32"}}},"OperationResponseAttackDefenseSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AttackDefenseSetting"}}},"OperationResponseDpiSettings":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DpiSettings"}}},"GridVORuleResultEntity":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RuleResultEntity"}}}},"OperationResponseGridVORuleResultEntity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVORuleResultEntity"}}},"GridVORestrictionResultEntity":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RestrictionResultEntity"}}}},"OperationResponseGridVORestrictionResultEntity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVORestrictionResultEntity"}}},"GridVOFilterEntity":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/FilterEntity"}}}},"OperationResponseGridVOFilterEntity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOFilterEntity"}}},"FamilyEntity":{"type":"object","properties":{"familyName":{"type":"string","description":"Family name"},"familyId":{"type":"integer","description":"Family ID","format":"int32"},"description":{"type":"string","description":"Description of family"}}},"OperationResponseListFamilyEntity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/FamilyEntity"}}}},"GridVOApplicationEntity":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationEntity"}}}},"OperationResponseGridVOApplicationEntity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOApplicationEntity"}}},"GridVOOuiBasedVlanApQueryOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OuiBasedVlanApQueryOpenApiVO"}}}},"OperationResponseGridVOOuiBasedVlanApQueryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOuiBasedVlanApQueryOpenApiVO"}}},"OuiBasedVlanApQueryOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Rule ID"},"enable":{"type":"boolean","description":"Ap Rule state."},"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Ap Rule name should contain 1 to 128 characters."},"ssidList":{"type":"array","description":"Configured ssid list.","items":{"$ref":"#/components/schemas/SsidOuiModeOpenApiVO"}},"ruleCombine":{"type":"array","description":"Basic vlan-oui-priority configuration of oui based rule.","items":{"$ref":"#/components/schemas/VlanOuiModeQueryOpenApiVO"}}}},"SsidOuiModeOpenApiVO":{"type":"object","properties":{"ssidId":{"type":"string","description":"Ssid ID."},"ssidName":{"type":"string","description":"Ssid Name."}},"description":"Configured ssid list."},"ApGroupGridVOApGroupOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApGroupOpenApiVO"}},"maxSsids2G":{"type":"integer","description":"2G radio max Ssid number in group","format":"int32"},"maxSsids5G":{"type":"integer","description":"5G radio max Ssid number in group","format":"int32"},"maxSsids6G":{"type":"integer","description":"6G radio max Ssid number in group","format":"int32"},"maxSsidsMlo":{"type":"integer","description":"max Mlo Ssid number in group","format":"int32"}}},"ApGroupOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"AP group ID"},"name":{"type":"string","description":"ap group name should contain 1 to 128 characters."},"primary":{"type":"boolean","description":"Whether it is the default ap group"},"apNum":{"type":"integer","description":"Number of APs in this group","format":"int64"},"remainingBinding":{"type":"object","additionalProperties":{"type":"integer","description":"Number of SSID remaining bindings for this group,  0:2g, 1:5g, 2:6g","format":"int32"},"description":"Number of SSID remaining bindings for this group,  0:2g, 1:5g, 2:6g"},"ssidNameList":{"type":"array","description":"SSID name list bound to this group","items":{"type":"string","description":"SSID name list bound to this group"}}}},"OperationResponseApGroupGridVOApGroupOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApGroupGridVOApGroupOpenApiVO"}}},"AnomalyEventSettingOpenApiVO":{"type":"object","properties":{"anomalyCode":{"type":"string","description":"For the values of Anomaly event code, refer to section 5.7.2.1 of the Open API Access","example":"01001001"},"category":{"type":"integer","description":"Anomaly event category, it should be a value as follows:11:Access, 12:Authentication, 13:Roaming, 14:Wireless Network, 15:Wired Network, 16:Link, 17:WAN and Services, 18:Device Status, 19:Security, example: 11 Or 12,13,14","format":"int32","example":11},"enable":{"type":"boolean","description":"Whether to detect anomaly events","example":false},"level":{"type":"integer","description":"Anomaly event level, it should be a value as follows: 0:Critical, 1:Error, 2:Warning, 3: Info","format":"int32","example":1},"params":{"type":"object","additionalProperties":{"type":"integer","description":"For the values of Anomaly event params, refer to section 5.7.2.1 of the Open API Access","format":"int32"},"description":"For the values of Anomaly event params, refer to section 5.7.2.1 of the Open API Access","example":{"offlineCount":2}},"objectType":{"type":"string","description":"Device type","example":"gateway"}}},"AnomalySettingGridVOAnomalyEventSettingOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AnomalyEventSettingOpenApiVO"}},"resource":{"type":"integer","description":"The anomaly event setting creation resource, such as: 0: new created, 1: from template, 2: override","format":"int32"},"statistic":{"$ref":"#/components/schemas/AnomalySettingStatOpenApiVO"}}},"AnomalySettingStatOpenApiVO":{"type":"object","properties":{"all":{"type":"integer","description":"Total number of anomaly event settings","format":"int32"},"enable":{"type":"integer","description":"Number of enabled anomaly event settings","format":"int32"},"disable":{"type":"integer","description":"Number of disabled anomaly event settings","format":"int32"},"allLevel":{"type":"integer","description":"Total number of level statistics","format":"int32"},"critical":{"type":"integer","description":"Number of critical level anomaly event settings","format":"int32"},"error":{"type":"integer","description":"Number of error level anomaly event settings","format":"int32"},"warning":{"type":"integer","description":"Number of warning level anomaly event settings","format":"int32"},"info":{"type":"integer","description":"Number of info level anomaly event settings","format":"int32"}},"description":"Anomaly setting statistic summary"},"OperationResponseAnomalySettingGridVOAnomalyEventSettingOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AnomalySettingGridVOAnomalyEventSettingOpenApiVO"}}},"NotificationOpenApiVO":{"type":"object","properties":{"alertEmailSetting":{"$ref":"#/components/schemas/AlertEmailSettingVO"},"email":{"$ref":"#/components/schemas/NotificationConfigurationOpenApiVO"},"resource":{"type":"integer","description":"The incident notifiction setting creation resource, such as: 0: new created, 1: from template, 2: override.","format":"int32"},"recipients":{"type":"array","description":"Recipients of the incident notifiction","items":{"$ref":"#/components/schemas/RecipientsVO"}}}},"OperationResponseNotificationOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/NotificationOpenApiVO"}}},"RecipientsVO":{"type":"object","properties":{"email":{"type":"string","description":"The email address of the recipient."}},"description":"Recipients of the incident notifiction"},"Gateway Custom ACL info entity":{"required":["description","destinationList","direction","id","index","logStatus","policy","protocol","sourceList","status"],"type":"object","properties":{"id":{"type":"string","description":"Custom ACL ID"},"index":{"type":"integer","description":"Custom ACL index","format":"int32"},"status":{"type":"boolean","description":"Custom ACL status"},"description":{"pattern":"^[^ ]$|^[^ ].{0,510}[^ ]$","type":"string","description":"Custom ACL description should contain 1 to 512 characters."},"direction":{"type":"integer","description":"Custom ACL direction should be a value as follows: 0: LAN-LAN; 1: LAN-WAN; 2: WAN-LAN; 3: LOCAL IN","format":"int32"},"policy":{"type":"integer","description":"Custom ACL policy should be a value as follows: 0: Drop; 1:Allow","format":"int32"},"protocol":{"type":"integer","description":"Custom ACL protocol. For the values of protocol, refer to section 5.5 of the Open API Access Guide.","format":"int32"},"sourceList":{"type":"array","description":"Custom ACL source list.","items":{"type":"string","description":"Custom ACL source list."}},"sourcePort":{"type":"string","description":"Custom ACL source port. when \"protocol\" is \"TCP\" or \"UDP\", port is valid."},"destinationList":{"type":"array","description":"Custom ACL destination list.","items":{"type":"string","description":"Custom ACL destination list."}},"destinationPort":{"type":"string","description":"Custom ACL destination port. when \"protocol\" is \"TCP\" or \"UDP\", port is valid."},"logStatus":{"type":"boolean","description":"Custom ACL log status"},"hitCounts":{"type":"integer","description":"Show custom ACL hit counts.","format":"int32"}}},"GridVOGateway Custom ACL Info Entity":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Gateway Custom ACL info entity"}}}},"OperationResponseGridVOGateway Custom ACL Info Entity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOGateway Custom ACL Info Entity"}}},"OperationResponseGateway ACL Config Mode Entity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Gateway ACL config mode entity"}}},"GatewayACLInfo":{"required":["description","destinationIds","destinationType","id","index","policy","protocols","sourceIds","sourceType","stateMode","status","syslog"],"type":"object","properties":{"id":{"type":"string","description":"ACL ID"},"index":{"type":"integer","description":"Index","format":"int32"},"description":{"pattern":"^[^ ]$|^[^ ].{0,510}[^ ]$","type":"string","description":"ACL rule description, description should contain 1 to 512 characters."},"status":{"type":"boolean","description":"Status should be a value as follows: 0: disable; 1: enable"},"policy":{"type":"integer","description":"Policy should be a value as follows: 0: drop; 1: allow;","format":"int32"},"protocols":{"type":"array","description":"For the values of protocols, refer to section 5.5 of the Open API Access Guide.","items":{"type":"integer","description":"For the values of protocols, refer to section 5.5 of the Open API Access Guide.","format":"int32"}},"sourceIds":{"type":"array","description":"Source IDs, which depends on sourceType, for example: if sourceType is network, sourceIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Source IDs, which depends on sourceType, for example: if sourceType is network, sourceIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."}},"destinationIds":{"type":"array","description":"Destination IDs, which depends on destinationType, for example: if destinationType is network, destinationIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Destination IDs, which depends on destinationType, for example: if destinationType is network, destinationIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."}},"syslog":{"type":"boolean","description":"Enable remote log"},"sourceType":{"type":"integer","description":"SourceType should be a value as follows: 0: network; 1: IP Group; 2: IP-Port Group; 4: SSID; 6: IPv6 Group; 7: IPv6-Port Group; 8: Country; 9: Country Group; 11: !Network; 12: !IP Group; 13: !IP-Port Group; 14: !IPv6 Group; 15: !IPv6-port Group","format":"int32"},"destinationType":{"type":"integer","description":"DestinationType should be a value as follows: 0: network; 1: IP Group; 2: IP-Port Group; 6: IPv6 Group; 7: IPv6-Port Group;10: Domain Group; 11: !Network; 12: !IP Group；13: !IP-Port Group；14: !IPv6 Group；15: !IPv6-port Group","format":"int32"},"direction":{"$ref":"#/components/schemas/Gateway direction entity"},"stateMode":{"type":"integer","description":"StateMode should be a value as follows: 0: auto; 1: manual","format":"int32"},"states":{"$ref":"#/components/schemas/Gateway ACL states entity"},"timeRangeId":{"type":"string","description":"Gateway ACL time range ID."}}},"GridVOGatewayACLInfo":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GatewayACLInfo"}}}},"OperationResponseGridVOGatewayACLInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOGatewayACLInfo"}}},"EapACLInfo":{"required":["description","destinationIds","destinationType","id","index","policy","protocols","sourceIds","sourceType","status"],"type":"object","properties":{"id":{"type":"string","description":"ACL ID"},"index":{"type":"integer","description":"Index","format":"int32"},"description":{"pattern":"^[^ ]$|^[^ ].{0,510}[^ ]$","type":"string","description":"ACL rule description, description should contain 1 to 512 characters."},"status":{"type":"boolean","description":"Status should be a value as follows: 0: disable; 1: enable"},"policy":{"type":"integer","description":"Policy should be a value as follows: 0: drop; 1: allow;","format":"int32"},"protocols":{"type":"array","description":"For the values of protocols, refer to section 5.5 of the Open API Access Guide.","items":{"type":"integer","description":"For the values of protocols, refer to section 5.5 of the Open API Access Guide.","format":"int32"}},"sourceIds":{"type":"array","description":"Source IDs, which depends on sourceType, for example: if sourceType is network, sourceIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Source IDs, which depends on sourceType, for example: if sourceType is network, sourceIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."}},"destinationIds":{"type":"array","description":"Destination IDs, which depends on destinationType, for example: if destinationType is network, destinationIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Destination IDs, which depends on destinationType, for example: if destinationType is network, destinationIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."}},"sourceType":{"type":"integer","description":"SourceType should be a value as follows: 0: network; 1: IP Group; 2: IP-Port Group; 4: SSID; 6: IPv6 Group; 7: IPv6-Port Group.","format":"int32"},"destinationType":{"type":"integer","description":"DestinationType should be a value as follows: 0: network; 1: IP Group; 2: IP-Port Group; 6: IPv6 Group; 7: IPv6-Port Group","format":"int32"}}},"GridVOEapACLInfo":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/EapACLInfo"}}}},"OperationResponseGridVOEapACLInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOEapACLInfo"}}},"OperationResponseSiteTemplateModulesOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteTemplateModulesOpenApiVO"}}},"SiteTemplateModulesOpenApiVO":{"type":"object","properties":{"settings":{"type":"array","description":"Setting list for creating site template.","items":{"type":"string","description":"Setting list for creating site template."}}}},"OperationResponseSiteTemplateAllModulesOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteTemplateAllModulesOpenApiVO"}}},"SiteTemplateAllModulesOpenApiVO":{"type":"object","properties":{"proSettings":{"type":"array","description":"Pro setting list for creating site template. This field applies to the Omada Pro Controller only.","items":{"type":"string","description":"Pro setting list for creating site template. This field applies to the Omada Pro Controller only."}},"basicSettings":{"type":"array","description":"Basic setting list for creating site template.","items":{"type":"string","description":"Basic setting list for creating site template."}}}},"GridVOSiteSummaryInfo":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SiteSummaryInfo"}}}},"OperationResponseGridVOSiteSummaryInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOSiteSummaryInfo"}}},"SiteSummaryInfo":{"type":"object","properties":{"siteId":{"type":"string","description":"Site ID"},"name":{"type":"string","description":"Name of the site should contain 1 to 64 characters."},"tagIds":{"uniqueItems":true,"type":"array","description":"Site tag ID","items":{"type":"string","description":"Site tag ID"}},"region":{"type":"string","description":"Country/Region of the site; For the values of region, refer to the abbreviation of the ISO country code; For example, you need to input \"United States\" for the United States of America."},"timeZone":{"type":"string","description":"For the values of the timezone of the site, refer to section 5.1 of the Open API Access Guide."},"scenario":{"type":"string","description":"For the values of the scenario of the site, refer to result of the interface for Get scenario list."},"longitude":{"type":"number","description":"Longitude of the site should be within the range of -180 - 180.","format":"double"},"latitude":{"type":"number","description":"Latitude of the site should be within the range of -90 - 90.","format":"double"},"address":{"type":"string","description":"Address of the site"},"type":{"type":"integer","description":"Site type(only for pro controller). It should be a value as follows: 0: Basic Site; 1: Pro Site","format":"int32"},"supportES":{"type":"boolean","description":"Whether the site supports adopting Agile Series Switches"},"supportL2":{"type":"boolean","description":"Whether the site supports adopting Non-Agile Series Switches"},"sitePublicIp":{"type":"string","description":"Adopted gateway public ip of the site, only useful for cloud based controller and remote management local Controller"},"primary":{"type":"boolean","description":"Default Site mark"}},"description":"Site summary info"},"OperationResponseSiteEntity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteEntity"}}},"SiteEntity":{"type":"object","properties":{"siteId":{"type":"string","description":"Site ID"},"name":{"type":"string","description":"Name of the site should contain 1 to 64 characters."},"type":{"type":"integer","description":"Type of the site should be 0 or 1, and 0 means basic site, 1 means pro site.","format":"int32"},"tagIds":{"uniqueItems":true,"type":"array","description":"Site tag ID","items":{"type":"string","description":"Site tag ID"}},"region":{"type":"string","description":"Country/Region of the site; For the values of region, refer to the abbreviation of the ISO country code; For example, you need to input \"United States\" for the United States of America."},"timeZone":{"type":"string","description":"For the values of the timezone of the site, refer to section 5.1 of the Open API Access Guide."},"ntpEnable":{"type":"boolean","description":"NTP server status of the site"},"ntpServers":{"maxItems":5,"minItems":0,"type":"array","description":"NTP server address; Up to 5 entries are allowed for the NTP server address list.","items":{"maxLength":5,"minLength":0,"type":"string","description":"NTP server address; Up to 5 entries are allowed for the NTP server address list."}},"dst":{"$ref":"#/components/schemas/DstDTO"},"scenario":{"type":"string","description":"For the values of the scenario of the site, refer to result of the interface for Get scenario list."},"longitude":{"type":"number","description":"Longitude of the site should be within the range of -180 - 180.","format":"double"},"latitude":{"type":"number","description":"Latitude of the site should be within the range of -90 - 90.","format":"double"},"address":{"type":"string","description":"Address of the site"},"supportES":{"type":"boolean","description":"Whether the site supports adopting Agile Series Switches"},"supportL2":{"type":"boolean","description":"Whether the site supports adopting Non-Agile Series Switches"}}},"GridVOSsidOverrideDetailVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SsidOverrideDetailVO"}}}},"OperationResponseGridVOSsidOverrideDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOSsidOverrideDetailVO"}}},"SsidOverrideDetailVO":{"type":"object","properties":{"name":{"type":"string","description":"AP Name"},"model":{"type":"string"},"modelVersion":{"type":"string"},"status":{"type":"integer","format":"int32"},"statusCategory":{"type":"integer","format":"int32"},"overrideName":{"type":"string","description":"SSID Override Name"},"overrideVlan":{"type":"string","description":"SSID Override Vlan"},"overridePassword":{"type":"string","description":"SSID Override Password"},"mac":{"type":"string","description":"AP MAC"},"deviceType":{"type":"string","description":"Device Type"},"ssidEnable":{"type":"boolean","description":"SSID Enable"}}},"OperationResponseSsidOverrideDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SsidOverrideDetailVO"}}},"ApGroupDetailOpenApiVO":{"type":"object","properties":{"apGroups":{"type":"array","items":{"$ref":"#/components/schemas/ApGroupDetailVO"}},"maxSsids2G":{"type":"integer","description":"2G radio max Ssid number in group","format":"int32"},"maxSsids5G":{"type":"integer","description":"5G radio max Ssid number in group","format":"int32"},"maxSsids6G":{"type":"integer","description":"6G radio max Ssid number in group","format":"int32"},"maxSsidsMlo":{"type":"integer","description":"max Mlo Ssid number in group","format":"int32"}}},"ApGroupDetailVO":{"type":"object","properties":{"id":{"type":"string","description":"AP Group ID"},"name":{"type":"string","description":"AP Group Name"},"apNum":{"type":"integer","description":"Number of APs in this group","format":"int64"},"remainingBinding":{"type":"object","additionalProperties":{"type":"integer","description":"Number of SSID remaining bindings for this group","format":"int32"},"description":"Number of SSID remaining bindings for this group"}}},"OperationResponseApGroupDetailOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApGroupDetailOpenApiVO"}}},"OperationResponseSsidVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SsidVO"}}},"ApExist6GOpenApiVO":{"type":"object","properties":{"exist6GAp":{"type":"boolean","description":"The site exists 6G ap"}}},"OperationResponseApExist6GOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApExist6GOpenApiVO"}}},"ChannelInterferenceSubHealthInfoVO":{"type":"object","properties":{"summaryScore":{"type":"integer","description":"Sub dimension health score","format":"int32"},"support":{"type":"boolean","description":"Sub dimension support"},"incidents":{"type":"array","description":"Incident information for this health dimension, null if no incidents","items":{"$ref":"#/components/schemas/AnomalyBriefCountVO"}},"averageInterf2g":{"type":"integer","description":"Average 2.4G interference","format":"int32"},"averageInterf5g":{"type":"integer","description":"Average 5G interference","format":"int32"},"averageInterf6g":{"type":"integer","description":"Average 6G interference","format":"int32"},"averageNoiseFloor":{"type":"integer","description":"Average noise floor","format":"int32"},"scores":{"type":"array","description":"List of time score items","items":{"$ref":"#/components/schemas/TimeScoreItemVO"}}},"description":"Channel interference rate score detail info"},"SubSingleHealthInfoDetailVO":{"type":"object","properties":{"summaryScore":{"type":"integer","description":"Sub dimension health score","format":"int32"},"support":{"type":"boolean","description":"Sub dimension support"},"incidents":{"type":"array","description":"Incident information for this health dimension, null if no incidents","items":{"$ref":"#/components/schemas/AnomalyBriefCountVO"}},"scores":{"type":"array","items":{"$ref":"#/components/schemas/TimeScoreItemVO"}}},"description":"Rssi score detail info"},"TimeScoreItemVO":{"type":"object","properties":{"time":{"type":"integer","description":"Time(unit:ms)","format":"int64"},"score":{"type":"integer","description":"Health score corresponding to time","format":"int32"}},"description":"List of time score items"},"WifiHealthDetailVO":{"type":"object","properties":{"wifiHealthScore":{"type":"integer","description":"Wifi health score","format":"int32"},"accessTimeScoreDetail":{"$ref":"#/components/schemas/SubSingleHealthInfoDetailVO"},"wirelessClientQualityDetail":{"$ref":"#/components/schemas/OnBoardingTimeSubHealthDetailVO"},"channelUtilScoreDetail":{"$ref":"#/components/schemas/SubSingleHealthInfoDetailVO"},"channelInterUtilDetail":{"$ref":"#/components/schemas/ChannelInterferenceSubHealthInfoVO"},"accessCapacityScoreDetail":{"$ref":"#/components/schemas/SubSingleHealthInfoDetailVO"},"rssiScoreDetail":{"$ref":"#/components/schemas/SubSingleHealthInfoDetailVO"}}},"OperationResponseTimeScoreListVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/TimeScoreListVO"}}},"TimeScoreListVO":{"type":"object","properties":{"scores":{"type":"array","items":{"$ref":"#/components/schemas/TimeScoreItemVO"}}}},"OperationResponseWanUnsupportedFunctionOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/WanUnsupportedFunctionOpenApiVO"}}},"WanUnsupportedFunctionOpenApiVO":{"type":"object","properties":{"functions":{"type":"array","description":"When [filter] is 1, list of functions that are not supported by DS-Lite and MAP-E dial-up.","items":{"type":"string","description":"When [filter] is 1, list of functions that are not supported by DS-Lite and MAP-E dial-up."}}}},"IspResultOpenApiVO":{"type":"object","properties":{"isp":{"type":"string","description":"ISP name."},"ispNum":{"type":"integer","description":"The ID of the ISP.","format":"int32"},"state":{"type":"boolean","description":"Whether the ISP available or not."}},"description":"The list of the isp, contains the ISP name and the ID and the state of the ISP."},"IspScanResultOpenApiVO":{"type":"object","properties":{"status":{"type":"integer","description":"The status of the band scan: 0 - Failed, 1 - Succeeded, 2 - Scanning.","format":"int32"},"ispList":{"type":"array","description":"The list of the isp, contains the ISP name and the ID and the state of the ISP.","items":{"$ref":"#/components/schemas/IspResultOpenApiVO"}}}},"OperationResponseIspScanResultOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/IspScanResultOpenApiVO"}}},"BandResultOpenApiVO":{"type":"object","properties":{"band":{"type":"string","description":"The name of the band."},"belong":{"type":"boolean","description":"Whether it belongs to the carrier to which the SIM card belongs."}},"description":"The result of the band scan."},"BandScanResultOpenApiVO":{"type":"object","properties":{"status":{"type":"integer","description":"The status of the band scan: 0 - Failed, 1 - Succeeded, 2 - Scanning.","format":"int32"},"bands":{"type":"array","description":"The result of the band scan.","items":{"$ref":"#/components/schemas/BandResultOpenApiVO"}},"isp":{"type":"string","description":"Internet service provider."},"simCard":{"type":"integer","description":"When the device supports Dual-SIM card, parameter [simCard] should not be null.1: SIM1; 2: SIM2.","format":"int32"}}},"OperationResponseBandScanResultOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/BandScanResultOpenApiVO"}}},"OperationResponseVpnOpenApiGridVOVPN":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VpnOpenApiGridVOVPN"}}},"VPN":{"required":["clientVpnType1","clientVpnType2","ipPool","name","purpose"],"type":"object","properties":{"id":{"type":"string","description":"ID of the VPN."},"name":{"pattern":"^[a-zA-Z0-9_]{1,63}$","type":"string","description":"Name should contain 1 to 63 characters."},"purpose":{"type":"integer","description":"Purpose of the VPN.","format":"int32"},"siteVpnType":{"type":"integer","description":"Site VPN type of the VPN.","format":"int32"},"status":{"type":"boolean","description":"Status of the VPN."},"accountAuth":{"type":"boolean","description":"Account auth of the VPN, only for server OpenVPN."},"existAccountAuth":{"type":"boolean","description":"Whether Account Auth is configured."},"remoteSite":{"type":"string","description":"Remote site of the VPN."},"remoteIp":{"type":"string","description":"Remote IP of the VPN."},"existOpenVpnDomain":{"type":"boolean","description":"Whether Open VPN Client Remote Server is Domain Name."},"remoteSubnet":{"type":"array","description":"Remote subnet of the VPN, only for Manual IPSec type.","items":{"$ref":"#/components/schemas/IPSubnetsVO"}},"networkType":{"type":"integer","description":"Network type should be a value as follows: 0: network list; 1: custom networks.","format":"int32"},"networkList":{"type":"array","description":"Network list of the VPN, only for Manual IPSec type. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Network list of the VPN, only for Manual IPSec type. Network can be created using 'Create LAN network' interface, and network ID can be obtained from 'Get LAN network list' interface."}},"customNetwork":{"type":"array","description":"Custom networks of the VPN, only for Manual IPSec type.","items":{"$ref":"#/components/schemas/IPSubnetsVO"}},"existCustomNetwork":{"type":"boolean","description":"Whether Local Network Type is Custom."},"preSharedKey":{"type":"string","description":"Pre-shared key of the VPN."},"wans":{"type":"array","description":"WAN list of the VPN. WAN port ID can be obtained from 'Get internet basic info' interface.","items":{"type":"string","description":"WAN list of the VPN. WAN port ID can be obtained from 'Get internet basic info' interface."}},"clientVpnType1":{"type":"integer","description":"Client to Site VPN : 0:VPN Server 1:VPN Client.","format":"int32"},"clientVpnType2":{"type":"integer","description":"Client Vpn type should be a value as follows: 0: L2TP; 1: PPTP; 2: IPSec; 3: OpenVPN.","format":"int32"},"existL2TP":{"type":"boolean","description":"Whether current VPN is L2TP type."},"existIPsec":{"type":"boolean","description":"Whether current VPN is IPsec type."},"openVpnTunnelMode":{"type":"integer","description":"OpenVPN tunnel mode should be a value as follows: 0: split; 1: full.","format":"int32"},"existTunnelMode":{"type":"boolean","description":"OpenVPN tunnel mode is Full."},"openVpnMode":{"type":"integer","description":"OpenVPN mode should be a value as follows: 0: certification; 1: certification+account.","format":"int32"},"serviceType":{"type":"integer","description":"Service type of the VPN.","format":"int32"},"servicePort":{"type":"integer","description":"Service port should be within the range of 1–65535.","format":"int32"},"encryption":{"type":"integer","description":"Encryption should be a value as follows: 0: Encrypted; 1: Unencrypted.","format":"int32"},"ipPoolType":{"type":"integer","description":"IP pool type should be a value as follows: 0: Ip Address/Mask; 1: Ip Address Range.","format":"int32"},"existIpRange":{"type":"boolean","description":"Whether IP pool type is Ip Address Range."},"ipPoolStart":{"type":"string","description":"The start IP of the IP pool."},"ipPoolEnd":{"type":"string","description":"The end IP of the IP pool."},"ipPool":{"$ref":"#/components/schemas/IPSubnetsVO"},"primaryDns":{"type":"string","description":"Primary DNS of the VPN."},"secondaryDns":{"type":"string","description":"Secondary DNS of the VPN."},"existCustomDns":{"type":"boolean","description":"Whether custom DNS Server has been configured in current VPN."},"authMode":{"type":"integer","description":"Authentication mode should be a value as follows: 0: Local; 1: LDAP.","format":"int32"},"ldapProfile":{"type":"string","description":"Ldap Profile."},"existLdap":{"type":"boolean","description":"Whether Auth Mode is LDAP."},"existServerOpenVpnGoogleLdap":{"type":"boolean","description":"Whether Auth Mode is Google LDAP."},"workingMode":{"type":"integer","description":"Working Mode should be a value as follow: 0:NAT 1:Routing.","format":"int32"},"clientUserName":{"type":"string","description":"Client username of the VPN."},"clientPassword":{"type":"string","description":"Client password of the VPN."},"vpnConfiguration":{"$ref":"#/components/schemas/VpnCertificateOpenApiVO"},"existPfs":{"type":"boolean","description":"Whether current VPN has configured none-default option: dh14 or dh15."},"existPhase1Proposal1":{"type":"boolean","description":"Whether current VPN has configured none-default Proposal option for IKE negotiation phase-1: SHA384 or SHA512."},"existPhase2Proposal2":{"type":"boolean","description":"Whether current VPN has configured none-default Proposal option for IKE negotiation phase-2: SHA384 or SHA512."}}},"VpnOpenApiGridVOVPN":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VPN"}},"supportVpnUserTab":{"type":"boolean","description":"Whether user tab configuration is supported of the VPN"},"supportCustomDns":{"type":"boolean","description":"Whether custom dns configuration is supported of the VPN"},"supportIpRange":{"type":"boolean","description":"Whether ip range configuration is supported of the VPN"},"supportAccountAuth":{"type":"boolean","description":"Whether account auth configuration is supported of the VPN"},"supportCustomNetwork":{"type":"boolean","description":"Whether custom network configuration is supported of the VPN"},"supportTunnelMode":{"type":"boolean","description":"Whether tunnel mode configuration is supported of the VPN"},"supportLdap":{"type":"boolean","description":"Whether LDAP authentication mode is supported of the VPN server"},"pfsCap":{"type":"array","description":"All PFS configuration types supported by the device, 1:dh1; 2:dh2; 3:dh3; 14:dh14; 15:dh15. Default: dh1、dh2、dh5","items":{"type":"integer","description":"All PFS configuration types supported by the device, 1:dh1; 2:dh2; 3:dh3; 14:dh14; 15:dh15. Default: dh1、dh2、dh5","format":"int32"}},"supportOpenVpnDomain":{"type":"boolean","description":"Whether OpenVPN supports inputting domain"},"supportL2TP":{"type":"boolean","description":"Whether L2TP VPN is supported."},"supportIPsec":{"type":"boolean","description":"Whether IPsec VPN is supported."},"phase1Proposal1Cap":{"type":"array","description":"Proposal options for IKE negotiation phase-1. 0: MD5, 1: SHA1, 2:SHA256, 3:SHA384, 4:SHA512. Default: MD5, SHA1 and SHA256","items":{"type":"integer","description":"Proposal options for IKE negotiation phase-1. 0: MD5, 1: SHA1, 2:SHA256, 3:SHA384, 4:SHA512. Default: MD5, SHA1 and SHA256","format":"int32"}},"phase2Proposal2Cap":{"type":"array","description":"Proposal options for IKE negotiation phase-2. 0: MD5, 1: SHA1, 2:SHA256, 3:SHA384, 4:SHA512.+ Default: MD5, SHA1 and SHA256","items":{"type":"integer","description":"Proposal options for IKE negotiation phase-2. 0: MD5, 1: SHA1, 2:SHA256, 3:SHA384, 4:SHA512.+ Default: MD5, SHA1 and SHA256","format":"int32"}},"supportByDsLiteAndMapE":{"type":"boolean","description":"Whether this feature is supported for the DS-Lite or Map-E WAN connection types."},"subnetsLimitSize":{"type":"integer","description":"The limit on the number of entries for remote subnets and local network.","format":"int32"}}},"FunctionOpenApiVO":{"type":"object","properties":{"functions":{"type":"array","description":"Check used function.","items":{"type":"string","description":"Check used function."}}}},"OperationResponseFunctionOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/FunctionOpenApiVO"}}},"GridVOWireguardDetailOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WireguardDetailOpenApiVO"}}}},"OperationResponseGridVOWireguardDetailOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOWireguardDetailOpenApiVO"}}},"WireguardDetailOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"The ID of WireGuard VPN."},"name":{"type":"string","description":"The name of WireGuard VPN should contain 1 to 64 characters."},"status":{"type":"boolean","description":"The status of WireGuard VPN."},"mtu":{"type":"integer","description":"The MTU of WireGuard VPN should be within the range of 576-1440.","format":"int32"},"listenPort":{"type":"integer","description":"The listening port for WireGuard VPN should be within the range of 1-65535.","format":"int32"},"privateKey":{"type":"string","description":"The private key of WireGuard VPN must have 44 character of base64 and end with '='."},"publicKey":{"type":"string","description":"The publicKey key of WireGuard VPN must have 44 character of base64 and end with '='."},"localIp":{"type":"string","description":"The local IP address of WireGuard VPN."}}},"OperationResponseResponseDataVOWireguardSummaryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ResponseDataVOWireguardSummaryOpenApiVO"}}},"ResponseDataVOWireguardSummaryOpenApiVO":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WireguardSummaryOpenApiVO"}}}},"WireguardSummaryOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"The ID of WireGuard VPN."},"name":{"type":"string","description":"The name of WireGuard VPN."}}},"OperationResponseWireguardPeerOpenApiGridVOWireguardPeerDetailOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/WireguardPeerOpenApiGridVOWireguardPeerDetailOpenApiVO"}}},"WireguardPeerDetailOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"The ID of WireGuard peer."},"name":{"type":"string","description":"The name of WireGuard peer should contain 1 to 64 characters."},"status":{"type":"boolean","description":"The status of WireGuard peer."},"interfaceId":{"type":"string","description":"The ID of WireGuard VPN to which this WireGuard peer binds. The ID can be obtained from 'Get all wireguard's id and name info' interface."},"interfaceName":{"type":"string","description":"The name of WireGuard VPN to which this WireGuard peer binds."},"publicKey":{"type":"string","description":"The public key of WireGuard peer must have 44 character of base64 and end with '='."},"endPoint":{"type":"string","description":"The end point of WireGuard peer."},"endPointPort":{"type":"integer","description":"The end point port of WireGuard peer should be within the range of 1-65535.","format":"int32"},"existDomain":{"type":"boolean","description":"Whether a domain name has been configured in Endpoint."},"allowAddress":{"type":"array","description":"IP address list of WireGuard peer allowed.","items":{"type":"string","description":"IP address list of WireGuard peer allowed."}},"presharedKey":{"type":"string","description":"The presharedKey of WireGuard peer must have 44 character of base64 and end with '='."},"keepAlive":{"type":"integer","description":"The keepalive second of WireGuard peer should be within the range of 0-65535.","format":"int32"},"comment":{"type":"string","description":"The comment of WireGuard peer should contain 0 to 128 characters."}}},"WireguardPeerOpenApiGridVOWireguardPeerDetailOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WireguardPeerDetailOpenApiVO"}},"supportDomain":{"type":"boolean","description":"Whether peer supports inputting domain."}}},"OperationResponseWireguardKeyOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/WireguardKeyOpenApiVO"}}},"WireguardKeyOpenApiVO":{"type":"object","properties":{"privateKey":{"type":"string","description":"The private key of WireGuard VPN."},"publicKey":{"type":"string","description":"The public key of WireGuard VPN."}}},"OperationResponseVpnUserOpenApiGridVOVpnUserResponse":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VpnUserOpenApiGridVOVpnUserResponse"}}},"VpnUserOpenApiGridVOVpnUserResponse":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VpnUserResponse"}},"supportLocalIp":{"type":"boolean","description":"Whether the local IP address configuration is supported by the VPN user."},"supportL2TP":{"type":"boolean","description":"Whether the L2TP configuration is supported by the VPN user."},"supportPptp":{"type":"boolean","description":"Whether the PPTP configuration is supported by the VPN user."},"supportProtocol":{"type":"boolean","description":"Whether protocol configuration is supported of the VPN user"},"supportOpenVpn":{"type":"boolean","description":"Whether the OpenVPN configuration is supported by the VPN user."},"supportSslVpn":{"type":"boolean","description":"Whether the SSLVPN configuration is supported by the VPN user."},"maxConcurrentUser":{"type":"integer","description":"The maximum number of concurrent users supported by VPN.","format":"int32"},"sslVpnMaxConUserNum":{"type":"integer","description":"The maximum number of concurrent users supported by SSL VPN.","format":"int32"},"subnetsLimitSize":{"type":"integer","description":"The maximum number of subnets allowed for a VPN user.","format":"int32"},"supportServerOptional":{"type":"boolean","description":"Whether VPN server is optional."}}},"VpnUserResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the VPN user."},"omadacId":{"type":"string","description":"ID of current Controller."},"site":{"type":"string","description":"ID of current Site."},"username":{"type":"string","description":"Username of the VPN user."},"password":{"type":"string","description":"Password of the VPN user."},"protocol":{"type":"integer","description":"Protocol should be a value as follows: 0: L2TP or PPTP; 1: openVPN.","format":"int32"},"clientMode":{"type":"integer","description":"Client mode should be a value as follows: 0: Client-To-Site, 1: Site-To-Site.","format":"int32"},"maxConnections":{"type":"integer","description":"Max connections should be within the range of 1–100.","format":"int32"},"userRemoteSubnets":{"type":"array","description":"User remote subnets of the VPN user.","items":{"$ref":"#/components/schemas/IPSubnetsVO"}},"servers":{"type":"array","description":"Servers of the VPN user. Server can be created using 'Create client-to-site VPN server' interface, and server ID can be obtained from 'Get client-to-site VPN server list' interface.","items":{"type":"string","description":"Servers of the VPN user. Server can be created using 'Create client-to-site VPN server' interface, and server ID can be obtained from 'Get client-to-site VPN server list' interface."}},"localIp":{"type":"string","description":"Local IP of the VPN user."},"serverNames":{"type":"string","description":"Server names of the VPN user."},"existLocalIp":{"type":"boolean","description":"Whether the Local IP is configured."},"existProtocol":{"type":"boolean","description":"Whether an OpenVPN user exists."},"groupId":{"type":"string","description":"Group ID of the SSL VPN user. User group can be created using 'Create SSL VPN user group' interface, and User Group ID can be obtained from 'Get user group list for SSL VPN server' interface."},"status":{"type":"boolean","description":"Status of the SSL VPN user."},"validity":{"type":"string","description":"Validity of the SSL VPN user. The format is Month/Day/Year, for example 08/20/2022."}}},"OperationResponseListVpnUserBriefVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/VpnUserBriefVO"}}}},"OperationResponseListVpnUserServerBriefVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/VpnUserServerBriefVO"}}}},"VpnUserServerBriefVO":{"type":"object","properties":{"id":{"type":"string","description":"ID of the VPN user."},"name":{"type":"string","description":"Name of the VPN user."},"vpnType":{"type":"integer","description":"Server Vpn type. 0: L2TP; 1: PPTP; 2: IPSec; 3: OpenVPN; 4: WireGuard; 5: SSL VPN.","format":"int32"}}},"OperationResponseSslVpnUserOpenApiGridVOSslVpnUserEntity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SslVpnUserOpenApiGridVOSslVpnUserEntity"}}},"SslVpnUserEntity":{"required":["concurrentNumber","name","password","status","validity"],"type":"object","properties":{"id":{"type":"string","description":"ID of the SSL VPN user"},"groupId":{"type":"string","description":"Group ID of the SSL VPN user. User group can be created using 'Create SSL VPN user group' interface, and User Group ID can be obtained from 'Get user group list for SSL VPN server' interface."},"groupName":{"type":"string","description":"Group name of the SSL VPN user"},"name":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,18}[\\041-\\0176]$","type":"string","description":"Name of the SSL VPN user"},"status":{"type":"boolean","description":"Status of the SSL VPN user"},"available":{"type":"boolean","description":"Available of the SSL VPN user"},"password":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,62}[\\041-\\0176]$","type":"string","description":"Password of the SSL VPN user"},"validity":{"type":"string","description":"Validity of the SSL VPN user"},"concurrentNumber":{"type":"integer","description":"Concurrent number of the SSL VPN user","format":"int32"}}},"SslVpnUserOpenApiGridVOSslVpnUserEntity":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SslVpnUserEntity"}},"total":{"type":"integer","description":"Total number of the SSL VPN user","format":"int32"},"available":{"type":"integer","description":"Available number of the SSL VPN user","format":"int32"},"expired":{"type":"integer","description":"Expired number of the SSL VPN user","format":"int32"},"sslVpnMaxConUserNum":{"type":"integer","format":"int32"}}},"OperationResponseSslVpnUserGroupGridVOSslVpnUserGroupEntity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SslVpnUserGroupGridVOSslVpnUserGroupEntity"}}},"SslVpnResourceGroupBriefInfo":{"type":"object","properties":{"id":{"type":"string","description":"ID of the SSL VPN resource group brief"},"name":{"type":"string","description":"Name of the SSL VPN resource group brief"}},"description":"Resource group list of the SSL VPN user group"},"SslVpnUserGroupEntity":{"required":["name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the SSL VPN user group"},"name":{"type":"string","description":"Name of the SSL VPN user group"},"radiusAttribute":{"type":"string","description":"Attribute value used for radius authentication"},"ldapAttribute":{"type":"string","description":"Attribute value used for LDAP authentication"},"resourceGroupList":{"type":"array","description":"Resource group list of the SSL VPN user group","items":{"$ref":"#/components/schemas/SslVpnResourceGroupBriefInfo"}},"userList":{"type":"array","description":"User list of the SSL VPN user group","items":{"type":"string","description":"User list of the SSL VPN user group"}},"userNumber":{"type":"integer","description":"User number of the SSL VPN user group","format":"int32"}}},"SslVpnUserGroupGridVOSslVpnUserGroupEntity":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SslVpnUserGroupEntity"}},"supportRadius":{"type":"boolean"},"supportLdap":{"type":"boolean"}}},"OperationResponseSslVpnServerSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SslVpnServerSetting"}}},"SslVpnServerSetting":{"required":["status"],"type":"object","properties":{"id":{"type":"string","description":"ID of the SSL VPN server."},"status":{"type":"boolean","description":"Status of the SSL VPN server."},"wanPort":{"type":"string","description":"WAN port of the SSL VPN server. WAN port ID can be obtained from 'Get internet basic info' interface"},"wanIp":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"WAP IP of the SSL VPN server."},"ipPoolStart":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The start IP of the IP pool."},"ipPoolEnd":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"The end IP of the IP pool."},"primaryDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Primary DNS Server of the SSL VPN server."},"secondaryDns":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Secondary DNS Server of the SSL VPN server."},"servicePort":{"type":"integer","description":"Service port of the SSL VPN server should be within the range of 1–65535","format":"int32"},"authType":{"type":"integer","description":"Authentication type of the SSL VPN server should be a value as follows: 0: local; 1: radius; 2: LDAP.","format":"int32"},"radiusSetting":{"$ref":"#/components/schemas/RadiusSettingOpenApiVO"},"LDAPSetting":{"$ref":"#/components/schemas/LdapSettingOpenApiVO"},"nameLockSetting":{"$ref":"#/components/schemas/LockSettingOpenApiVO"},"ipLockSetting":{"$ref":"#/components/schemas/LockSettingOpenApiVO"},"exitAtIdle":{"type":"boolean","description":"Whether to exit when idle"},"exitTime":{"type":"integer","description":"Exit time should be within the range of 5–3600(s). It is required when parameter [exitAtIdle] is true.","format":"int32"},"totalTraffic":{"type":"boolean","description":"Whether to proxy all traffic."},"supportRadius":{"type":"boolean","description":"Whether the adopted gateway supports Radius."},"existRadius":{"type":"boolean","description":"Whether RADIUS Authentication has been configured in SSL VPN Server."},"supportLDAP":{"type":"boolean","description":"Whether the adopted gateway supports LDAP."},"existLdap":{"type":"boolean","description":"Whether LDAP Authentication has been configured in SSL VPN Server."},"supportByDsLiteAndMapE":{"type":"boolean","description":"Whether this feature is supported for the DS-Lite or Map-E WAN connection types."}}},"GridVOSslVpnResourceEntity":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SslVpnResourceEntity"}}}},"OperationResponseGridVOSslVpnResourceEntity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOSslVpnResourceEntity"}}},"SslVpnResourceEntity":{"required":["name","type"],"type":"object","properties":{"id":{"type":"string","description":"ID of the SSL VPN resource."},"resourceGroupList":{"type":"array","description":"Resource group list of the SSL VPN resource.","items":{"$ref":"#/components/schemas/SslVpnResourceGroupBriefInfo"}},"name":{"type":"string","description":"Name of the SSL VPN resource."},"type":{"type":"integer","description":"Type of the SSL VPN resource should be a value as follows: 0: IP; 1: domain.","format":"int32"},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP of the SSL VPN resource, exists when type is 0."},"mask":{"type":"string","description":"Mask of the SSL VPN resource, exists when type is 0."},"domain":{"type":"string","description":"Domain of the SSL VPN resource, exists when type is 1."},"protocol":{"type":"integer","description":"Protocol of the SSL VPN resource should be a value as follows: 0:All; 1:TCP; 2:UDP; 3:TCP/UDP; 4:ICMP; 5:Other","format":"int32"},"srcPortStart":{"type":"integer","description":"Start source port of the SSL VPN resource, exists when protocol is TCP or UDP. It should be within the range of 0–65535","format":"int32"},"srcPortEnd":{"type":"integer","description":"End source port of the SSL VPN resource, exists when protocol is TCP or UDP. It should be within the range of 0–65535","format":"int32"},"dstPortStart":{"type":"integer","description":"Start destination port of the SSL VPN resource, exists when protocol is TCP or UDP. It should be within the range of 0–65535","format":"int32"},"dstPortEnd":{"type":"integer","description":"End destination port of the SSL VPN resource, exists when protocol is TCP or UDP. It should be within the range of 0–65535","format":"int32"},"icmpType":{"type":"integer","description":"ICMP type of the SSL VPN resource, exists when protocol is ICMP. It should be within the range of 0–255","format":"int32"},"icmpCode":{"type":"integer","description":"ICMP code of the SSL VPN resource, exists when protocol is ICMP. It should be within the range of 0–255","format":"int32"},"otherProtocol":{"type":"integer","description":"Other protocol of the SSL VPN resource. It should be within the range of 1–255","format":"int32"}}},"GridVOSslVpnResourceGroup":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SslVpnResourceGroup"}}}},"OperationResponseGridVOSslVpnResourceGroup":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOSslVpnResourceGroup"}}},"SslVpnResourceBriefInfo":{"type":"object","properties":{"id":{"type":"string","description":"ID of the SSL VPN resource brief"},"name":{"type":"string","description":"Name of the SSL VPN resource brief"}},"description":"Resources list of the SSL VPN resource group"},"SslVpnResourceGroup":{"required":["name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the SSL VPN resource group"},"name":{"type":"string","description":"Name of the SSL VPN resource group"},"resourcesList":{"type":"array","description":"Resources list of the SSL VPN resource group","items":{"$ref":"#/components/schemas/SslVpnResourceBriefInfo"}}}},"OperationResponseListRadiusServerBriefInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/radiusServerBriefInfo"}}}},"radiusServerBriefInfo":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"radius server id."},"name":{"type":"string","description":"radius server name."},"overNumLimit":{"type":"boolean","description":"Is the number of authentication/accounting Servers greater than 2."},"builtInServer":{"type":"boolean","description":"Is this RADIUS server a built-in server"}}},"GridVOSSL VPN Lock Entity":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SSL VPN lock entity"}}}},"OperationResponseGridVOSSL VPN Lock Entity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOSSL VPN Lock Entity"}}},"SSL VPN lock entity":{"required":["totalLockTime","type"],"type":"object","properties":{"id":{"type":"string","description":"ID of the SSL VPN lock"},"username":{"type":"string","description":"Username of the SSL VPN lock"},"ip":{"type":"string","description":"IP of the SSL VPN lock"},"type":{"type":"integer","description":"Type of the SSL VPN lock should be a value as follows: 0:username; 1:IP","format":"int32"},"totalLockTime":{"type":"integer","description":"Total lock time of the SSL VPN lock should be within the range of 1–1080(min).","format":"int32"},"leftLockTime":{"type":"integer","description":"Left lock time(min) of the SSL VPN lock.","format":"int32"}}},"OperationResponseListSslVpnUserGroupBriefVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/SslVpnUserGroupBriefVO"}}}},"SslVpnUserGroupBriefVO":{"type":"object","properties":{"id":{"type":"string","description":"user group id."},"name":{"type":"string","description":"user group name."}}},"OperationResponseListSslVpnResourceBriefInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/SslVpnResourceBriefInfo"}}}},"OperationResponseListSslVpnResourceGroupBriefInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/SslVpnResourceGroupBriefInfo"}}}},"OperationResponseListSiteToSiteVpn":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/SiteToSiteVpn"}}}},"OperationResponseSiteToSiteVpn":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteToSiteVpn"}}},"OperationResponseVpnPreSharedKeyVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VpnPreSharedKeyVO"}}},"VpnPreSharedKeyVO":{"type":"object","properties":{"key":{"type":"string","description":"The pre-shared key of IPSec VPN."}}},"GridVOIPsecFailover Information":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/IPsecFailover information"}}}},"IPsecFailover information":{"type":"object","properties":{"id":{"type":"string","description":"ID of the ipsec fail over."},"name":{"type":"string","description":"Name of the ipsec fail over."},"primary":{"$ref":"#/components/schemas/IPsecInfoOpenApiVO"},"candidates":{"type":"array","description":"Candidates of the ipsec fail over.","items":{"$ref":"#/components/schemas/IPsecInfoOpenApiVO"}},"failBack":{"type":"boolean","description":"FailBack of the ipsec fail over."},"failBackTime":{"type":"integer","description":"FailBackTime of the ipsec fail over.","format":"int32"}}},"IPsecInfoOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"ID of the IPSec info."},"name":{"type":"string","description":"Name of the IPSec info."},"status":{"type":"integer","description":"Status of the IPSec info. 0: Active; 1: Standby; 2: Disconnected.","format":"int32"}},"description":"Candidates of the ipsec fail over."},"OperationResponseGridVOIPsecFailover Information":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOIPsecFailover Information"}}},"OperationResponseVpnAvailableIpPoolVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VpnAvailableIpPoolVO"}}},"VpnAvailableIpPoolVO":{"type":"object","properties":{"ipPool":{"type":"array","description":"Available IP pools.","items":{"$ref":"#/components/schemas/IPSubnetsOpenApiVO"}}}},"EoGreTunnelSettingOpenApiVO":{"type":"object","properties":{"greEnable":{"type":"boolean","description":"EoGRE Tunnel global config status; True: enable, false: disable."},"tunnelMtu":{"type":"integer","description":"Maximum Transmission Unit. The value of parameter [tunnelMtu] should be between [850, 1500].","format":"int32"},"interval":{"type":"integer","description":"EoGRE Tunnel keep interval config(Unit: Seconds); It should be within the range of 10–600.","format":"int32"},"maxCount":{"type":"integer","description":"EoGRE Tunnel max keepalive skip count config; It should be within the range of 3–10.","format":"int32"},"primaryAddress":{"type":"string","description":"EoGRE Tunnel primary gateway IP address config"},"secondaryAddress":{"type":"string","description":"EoGRE Tunnel secondary gateway IP address config"}}},"OperationResponseEoGreTunnelSettingOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/EoGreTunnelSettingOpenApiVO"}}},"OperationResponseVpnOpenApiGridVOClientToSiteVpnServer":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VpnOpenApiGridVOClientToSiteVpnServer"}}},"VpnOpenApiGridVOClientToSiteVpnServer":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClientToSiteVpnServer"}},"supportVpnUserTab":{"type":"boolean","description":"Whether user tab configuration is supported of the VPN"},"supportCustomDns":{"type":"boolean","description":"Whether custom dns configuration is supported of the VPN"},"supportIpRange":{"type":"boolean","description":"Whether ip range configuration is supported of the VPN"},"supportAccountAuth":{"type":"boolean","description":"Whether account auth configuration is supported of the VPN"},"supportCustomNetwork":{"type":"boolean","description":"Whether custom network configuration is supported of the VPN"},"supportTunnelMode":{"type":"boolean","description":"Whether tunnel mode configuration is supported of the VPN"},"supportLdap":{"type":"boolean","description":"Whether LDAP authentication mode is supported of the VPN server"},"pfsCap":{"type":"array","description":"All PFS configuration types supported by the device, 1:dh1; 2:dh2; 3:dh3; 14:dh14; 15:dh15. Default: dh1、dh2、dh5","items":{"type":"integer","description":"All PFS configuration types supported by the device, 1:dh1; 2:dh2; 3:dh3; 14:dh14; 15:dh15. Default: dh1、dh2、dh5","format":"int32"}},"supportOpenVpnDomain":{"type":"boolean","description":"Whether OpenVPN supports inputting domain"},"supportL2TP":{"type":"boolean","description":"Whether L2TP VPN is supported."},"supportIPsec":{"type":"boolean","description":"Whether IPsec VPN is supported."},"phase1Proposal1Cap":{"type":"array","description":"Proposal options for IKE negotiation phase-1. 0: MD5, 1: SHA1, 2:SHA256, 3:SHA384, 4:SHA512. Default: MD5, SHA1 and SHA256","items":{"type":"integer","description":"Proposal options for IKE negotiation phase-1. 0: MD5, 1: SHA1, 2:SHA256, 3:SHA384, 4:SHA512. Default: MD5, SHA1 and SHA256","format":"int32"}},"phase2Proposal2Cap":{"type":"array","description":"Proposal options for IKE negotiation phase-2. 0: MD5, 1: SHA1, 2:SHA256, 3:SHA384, 4:SHA512.+ Default: MD5, SHA1 and SHA256","items":{"type":"integer","description":"Proposal options for IKE negotiation phase-2. 0: MD5, 1: SHA1, 2:SHA256, 3:SHA384, 4:SHA512.+ Default: MD5, SHA1 and SHA256","format":"int32"}},"supportByDsLiteAndMapE":{"type":"boolean","description":"Whether this feature is supported for the DS-Lite or Map-E WAN connection types."},"subnetsLimitSize":{"type":"integer","description":"The limit on the number of entries for remote subnets and local network.","format":"int32"}}},"OperationResponseClientToSiteVpnServer":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ClientToSiteVpnServer"}}},"OperationResponseListVpnUserResponse":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/VpnUserResponse"}}}},"OperationResponseVpnOpenApiGridVOClientToSiteVpnClient":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VpnOpenApiGridVOClientToSiteVpnClient"}}},"VpnOpenApiGridVOClientToSiteVpnClient":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClientToSiteVpnClient"}},"supportVpnUserTab":{"type":"boolean","description":"Whether user tab configuration is supported of the VPN"},"supportCustomDns":{"type":"boolean","description":"Whether custom dns configuration is supported of the VPN"},"supportIpRange":{"type":"boolean","description":"Whether ip range configuration is supported of the VPN"},"supportAccountAuth":{"type":"boolean","description":"Whether account auth configuration is supported of the VPN"},"supportCustomNetwork":{"type":"boolean","description":"Whether custom network configuration is supported of the VPN"},"supportTunnelMode":{"type":"boolean","description":"Whether tunnel mode configuration is supported of the VPN"},"supportLdap":{"type":"boolean","description":"Whether LDAP authentication mode is supported of the VPN server"},"pfsCap":{"type":"array","description":"All PFS configuration types supported by the device, 1:dh1; 2:dh2; 3:dh3; 14:dh14; 15:dh15. Default: dh1、dh2、dh5","items":{"type":"integer","description":"All PFS configuration types supported by the device, 1:dh1; 2:dh2; 3:dh3; 14:dh14; 15:dh15. Default: dh1、dh2、dh5","format":"int32"}},"supportOpenVpnDomain":{"type":"boolean","description":"Whether OpenVPN supports inputting domain"},"supportL2TP":{"type":"boolean","description":"Whether L2TP VPN is supported."},"supportIPsec":{"type":"boolean","description":"Whether IPsec VPN is supported."},"phase1Proposal1Cap":{"type":"array","description":"Proposal options for IKE negotiation phase-1. 0: MD5, 1: SHA1, 2:SHA256, 3:SHA384, 4:SHA512. Default: MD5, SHA1 and SHA256","items":{"type":"integer","description":"Proposal options for IKE negotiation phase-1. 0: MD5, 1: SHA1, 2:SHA256, 3:SHA384, 4:SHA512. Default: MD5, SHA1 and SHA256","format":"int32"}},"phase2Proposal2Cap":{"type":"array","description":"Proposal options for IKE negotiation phase-2. 0: MD5, 1: SHA1, 2:SHA256, 3:SHA384, 4:SHA512.+ Default: MD5, SHA1 and SHA256","items":{"type":"integer","description":"Proposal options for IKE negotiation phase-2. 0: MD5, 1: SHA1, 2:SHA256, 3:SHA384, 4:SHA512.+ Default: MD5, SHA1 and SHA256","format":"int32"}},"supportByDsLiteAndMapE":{"type":"boolean","description":"Whether this feature is supported for the DS-Lite or Map-E WAN connection types."},"subnetsLimitSize":{"type":"integer","description":"The limit on the number of entries for remote subnets and local network.","format":"int32"}}},"OperationResponseClientToSiteVpnClient":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ClientToSiteVpnClient"}}},"OperationResponseSslVpnUserGroupGridVOSslVpnUserGroupBriefVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SslVpnUserGroupGridVOSslVpnUserGroupBriefVO"}}},"SslVpnUserGroupGridVOSslVpnUserGroupBriefVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SslVpnUserGroupBriefVO"}},"supportRadius":{"type":"boolean"},"supportLdap":{"type":"boolean"}}},"CallLogDeviceOpenApiVO":{"type":"object","properties":{"deviceName":{"type":"string","description":"The device name of callLog."},"deviceMac":{"type":"string","description":"The device mac name of callLog."},"model":{"type":"string","description":"The device model of callLog."},"modelVersion":{"type":"string","description":"The device modelVersion of callLog."},"type":{"type":"string","description":"The device type of callLog."}},"description":"The telephonyDevice description of callLog."},"CallLogGridVOVoipCallLog":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VoipCallLog"}},"statistic":{"$ref":"#/components/schemas/CallLogStatisticVO"}}},"CallLogStatisticVO":{"type":"object","properties":{"all":{"type":"integer","format":"int32"},"incoming":{"type":"integer","format":"int32"},"outgoing":{"type":"integer","format":"int32"},"forwarding":{"type":"integer","format":"int32"},"missed":{"type":"integer","format":"int32"},"rejected":{"type":"integer","format":"int32"}}},"OperationResponseCallLogGridVOVoipCallLog":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CallLogGridVOVoipCallLog"}}},"VoipCallLog":{"type":"object","properties":{"entryId":{"type":"string","description":"The entry ID of callLog."},"dateTime":{"type":"integer","description":"The dateTime of callLog.","format":"int32"},"status":{"type":"integer","description":"The status of callLog.","format":"int32"},"duration":{"type":"integer","description":"The duration of callLog.","format":"int32"},"numberOrContact":{"type":"string","description":"The number or contact person of callLog."},"deviceNumber":{"type":"string","description":"The deviceNumber of callLog."},"port":{"type":"integer","description":"FXS port id of this call log.","format":"int32"},"telephonyDevice":{"$ref":"#/components/schemas/CallLogDeviceOpenApiVO"}}},"OperationResponseListVlanInterfaceOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/VlanInterfaceOpenApiVO"}}}},"VlanInterfaceOpenApiVO":{"type":"object","properties":{"vlanInterfaceId":{"type":"string","description":"Vlan Interface ID"},"vlanInterfaceName":{"type":"string","description":"Vlan Interface Name"},"vlanId":{"type":"integer","description":"Vlan ID","format":"int32"}}},"Activity records of a client's single connections":{"type":"object","properties":{"mac":{"type":"string","description":"Client MAC"},"start":{"type":"integer","description":"Start timestamp, unit: millisecond.","format":"int64"},"end":{"type":"integer","description":"End timestamp, unit: millisecond.","format":"int64"},"events":{"type":"array","description":"Client connection events.","items":{"$ref":"#/components/schemas/Client Connection Events"}}}},"Client Connection Events":{"type":"object","properties":{"time":{"type":"integer","description":"Event timestamp, unit: millisecond.","format":"int64"},"eventType":{"type":"integer","description":"Event type should be a value as follows: <br/>0: CONNECT_WIRELESS // Connected to [ap:{dev_mac}] with SSID {ssid_name}; <br/>1: DISCONNECT_WIRELESS // Disconnected from [ap:{dev_mac}]; <br/>2: ROAMING // Roaming from [ap:{old_dev_mac}] to [ap:{dev_mac}]; <br/>3: BLOCK_WIRELESS // Blocked by admin {admin_name}; <br/>100: CONNECT_WIRED // Connected to [{dev_type}:{dev_mac}]; <br/>101: DISCONNECT_WIRED // Disconnected from [{dev_type}:{dev_mac}]; <br/>102: BLOCK_WIRED // Blocked by admin {admin_name}; <br/>200: AUTH_SUCCESS // Authorized by {auth_type} with {username}; <br/>201: AUTH_FAIL // Failed Authorized by {auth_type} with {username}; <br/>202: UNBLOCK // Unblocked by admin {admin_name};","format":"int32"},"content":{"type":"string","description":"Client connect event description, such as: Connected to [ap:{dev_mac}] with SSID {ssid_name}."},"attributes":{"type":"object","additionalProperties":{"type":"string","description":"Client connect event attributes map, such as [{dev_mac}:{AA-BB-CC-DD-EE-FF}]."},"description":"Client connect event attributes map, such as [{dev_mac}:{AA-BB-CC-DD-EE-FF}]."}},"description":"Client connection events."},"OperationResponseListActivity Records Of A Client's Single Connections":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/Activity records of a client's single connections"}}}},"Client Connection Histories":{"type":"object","properties":{"connections":{"type":"array","description":"Client connection histories","items":{"$ref":"#/components/schemas/Client Connection Info"}},"roamings":{"type":"array","description":"Client roaming histories","items":{"$ref":"#/components/schemas/Client Roaming Info"}}}},"Client Connection Info":{"type":"object","properties":{"start":{"type":"integer","description":"Start timestamp, unit: ms","format":"int64"},"end":{"type":"integer","description":"End timestamp, unit: ms","format":"int64"},"duration":{"type":"integer","description":"Duration, unit: ms","format":"int64"}},"description":"Client connection histories"},"Client Roaming Info":{"type":"object","properties":{"start":{"type":"integer","description":"Roaming start timestamp, unit: ms.","format":"int64"},"duration":{"type":"integer","description":"Duration, unit: ms.","format":"int64"}},"description":"Client roaming histories"},"OperationResponseClient Connection Histories":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Client Connection Histories"}}},"OperationResponseSiteUrlOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteUrlOpenApiVO"}}},"SiteUrlOpenApiVO":{"type":"object","properties":{"siteUrl":{"type":"string","description":"Site url for device management"}}},"OperationResponseUrlFilterGlobalOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/UrlFilterGlobalOpenApiVO"}}},"OperationResponseUrlCategoryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/UrlCategoryOpenApiVO"}}},"UrlCategoryOpenApiVO":{"type":"object","properties":{"categories":{"type":"object","additionalProperties":{"type":"array","description":"categories of the URL filtering 5.15","items":{"type":"string","description":"categories of the URL filtering 5.15"}},"description":"categories of the URL filtering 5.15"},"protocolVer":{"type":"string","description":"protocolVer of the categories."}}},"OperationResponseListUpgradeScheduleQueryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/UpgradeScheduleQueryOpenApiVO"}}}},"UpgradeScheduleQueryOpenApiVO":{"required":["deviceMacs","name","status","type"],"type":"object","properties":{"id":{"type":"string","description":"Reboot Schedule ID."},"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Reboot Schedule name should contain 1 to 128 characters."},"status":{"type":"boolean","description":"Reboot Schedule status."},"deviceMacs":{"type":"array","description":"MAC address of the selected devices.","items":{"type":"string","description":"MAC address of the selected devices."}},"type":{"type":"integer","description":"Type should be a value as follows: 0: execute only once; 1: repeat","format":"int32"},"nextExecuteTime":{"type":"integer","description":"Execution timeStamp(ms). Required when type is 0.","format":"int64"},"occurrenceTime":{"$ref":"#/components/schemas/BaseScheduleTimeOpenApiVO"}}},"OperationResponseSwitchOverviewInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SwitchOverviewInfo"}}},"SwitchOverviewInfo":{"type":"object","properties":{"mac":{"type":"string","description":"Switch MAC address"},"ip":{"type":"string","description":"Switch IP address"},"ipv6List":{"type":"array","description":"Switch IPv6 list","items":{"type":"string","description":"Switch IPv6 list"}},"model":{"type":"string","description":"Model"},"firmwareVersion":{"type":"string","description":"Firmware Version e.g:2.5.0 Build 20190118 Rel. 64821"},"version":{"type":"string","description":"Firmware Version e.g:2.5.0"},"hwVersion":{"type":"string","description":"Hardware Version"},"cpuUtil":{"type":"integer","description":"CpuUtil","format":"int32"},"memUtil":{"type":"integer","description":"MemUtil","format":"int32"},"uptime":{"type":"string","description":"Uptime"},"portList":{"type":"array","description":"Port List","items":{"$ref":"#/components/schemas/PortInfo"}}}},"OperationResponseOswStaticRoutingGridVOOswStaticRoutingVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswStaticRoutingGridVOOswStaticRoutingVO"}}},"OswStaticRoutingGridVOOswStaticRoutingVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OswStaticRoutingVO"}},"supportIpv6StaticRouting":{"type":"boolean","description":"supportIpv6StaticRouting"}}},"OswStaticRoutingVO":{"required":["destinations","distance","status"],"type":"object","properties":{"id":{"type":"string","description":"StaticRouting ID"},"omadacId":{"type":"string","description":"Omada ID"},"siteId":{"type":"string","description":"Site ID"},"entryId":{"type":"integer","description":"The entry ID of StaticRouting","format":"int32"},"name":{"type":"string","description":"Switch name"},"description":{"pattern":"^[0-9a-zA-Z\\-_@:/.+# ]{0,128}$","type":"string","description":"The description of static routing. It may contain 0 to 128 characters, including digits (0–9), uppercase and lowercase letters (A–Z, a–z), spaces, and -_@:/.+# ."},"mac":{"type":"string","description":"Switch Mac"},"vrfId":{"type":"string"},"ipVersion":{"type":"integer","description":"The IP Version of class rule should be a value as follows: 0: IPv4; 1: IPv6.","format":"int32"},"status":{"type":"boolean","description":"StaticRouting status"},"destinations":{"type":"array","description":"IP address/SubNet, up to 16 entries are allowed for the destinations list.","items":{"type":"string","description":"IP address/SubNet, up to 16 entries are allowed for the destinations list."}},"nextHopIp":{"type":"string","description":"NextHopIp"},"nextHopVrfId":{"type":"string"},"distance":{"type":"integer","description":"Distance should be within the range of 1–255.","format":"int32"},"resource":{"type":"integer","description":"Resource is a value as follows: 0: new created; 1: from template; 2: override","format":"int32"}}},"OperationResponseOswSdmApplicationVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswSdmApplicationVO"}}},"GridVOOswRoutingOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OswRoutingOpenApiVO"}}}},"OperationResponseGridVOOswRoutingOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOswRoutingOpenApiVO"}}},"OswRoutingOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"Switch Mac."},"name":{"type":"string","description":"Switch Name."},"distance":{"type":"integer","description":"Distance.","format":"int32"},"destinationIp":{"type":"string","description":"Destination IP."},"destIpVrf":{"type":"string","description":"Destination Vrf."},"oswDestinationIps":{"type":"array","description":"Destination IP list.","deprecated":true,"items":{"type":"string","description":"Destination IP list.","deprecated":true}},"nextHops":{"type":"array","description":"Next IP list.","items":{"type":"string","description":"Next IP list."}},"nextHop":{"type":"string","description":"Next Ip."},"nextHopVrf":{"type":"string","description":"Next Vrf."},"nextHopsVrf":{"type":"array","description":"Next vrfs","items":{"type":"string","description":"Next vrfs"}},"interfaceName":{"type":"array","description":"Interface Name","items":{"type":"string","description":"Interface Name"}},"metric":{"type":"integer","description":"Metric","format":"int32"},"type":{"type":"string","description":"Type"},"stackMsg":{"$ref":"#/components/schemas/StackMsgOpenApiVO"}}},"StackMsgOpenApiVO":{"type":"object","properties":{"stackId":{"type":"string","description":"Stack Id."},"stackName":{"type":"string","description":"Stack Name."},"masterMac":{"type":"string","description":"Stack MasterMac."}},"description":"The information of the stack to which it belongs."},"OperationResponseOswOspfNeighborGridVOOswOspfNeighborVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswOspfNeighborGridVOOswOspfNeighborVO"}}},"OswOspfNeighborGridVOOswOspfNeighborVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OswOspfNeighborVO"}},"interfaces":{"type":"array","description":"List of interface name","items":{"type":"string","description":"List of interface name"}},"processes":{"type":"array","description":"List of process ID","items":{"type":"string","description":"List of process ID"}}}},"OswOspfNeighborVO":{"type":"object","properties":{"dead":{"type":"string","description":"Dead Time"},"neighborInterface":{"type":"string","description":"Neighbor Interface"},"neighborIp":{"type":"string","description":"Neighbor Ip"},"routerId":{"type":"string","description":"Router ID"},"priority":{"type":"integer","description":"Priority","format":"int32"},"state":{"type":"string","description":"State"},"processId":{"type":"string","description":"Ospf Process ID"}}},"OperationResponseOswNetworkGridOswNetworkOpenApi":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswNetworkGridOswNetworkOpenApi"}}},"OswNetworkGridOswNetworkOpenApi":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OswNetworkOpenApi"}},"supportIpv6":{"type":"boolean","description":"Switch supports ipv6 or not."}}},"GridVOOswNetworkDetailInfoOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OswNetworkDetailInfoOpenApiVO"}}}},"OswNetworkDetailInfoOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Network's ID"},"name":{"type":"string","description":"Network's name"},"vlan":{"type":"integer","description":"VLAN ID","format":"int32"},"isolation":{"type":"boolean","description":"Whether network isolated."},"portLagNetworkInfo":{"$ref":"#/components/schemas/OswPortAndLagNetworkVO"}},"description":"OswNetworkDetailInfoOpenApiVO"},"GridVOOswLldpNeighborVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OswLldpNeighborVO"}}}},"OperationResponseGridVOOswLldpNeighborVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOswLldpNeighborVO"}}},"OswLldpNeighborVO":{"type":"object","properties":{"portId":{"type":"integer","description":"Port ID","format":"int32"},"standardPort":{"type":"string","description":"Standard Port"},"deviceId":{"type":"string","description":"Device ID"},"systemName":{"type":"string","description":"System Name"},"neighborPortId":{"type":"string","description":"The port on which the neighboring device is connected to the current switch"},"ttl":{"type":"integer","description":"Time that neighbor LLDP packets can survive","format":"int32"},"capabilities":{"type":"string","description":"Capabilities"}}},"OperationResponseOswL3SdmApplicationVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswL3SdmApplicationVO"}}},"OswL3SdmApplicationVO":{"type":"object","properties":{"curTmplName":{"type":"string","description":"Current used sdm template."},"sdmResourceUsageList":{"type":"array","description":"The list contains usage details of SDM resources on the device, including used and available resources.","items":{"$ref":"#/components/schemas/SdmResourceUsage"}},"tcamUtilization":{"type":"integer","description":"The overall TCAM utilization, calculated as usedTcam / totalTcam.","format":"int32"}}},"SdmResourceUsage":{"type":"object","properties":{"category":{"type":"integer","description":"It should be a value as follows: 0:Packet Control,  1:Packet Control V6 , 2:MAC ACL Ingress,  3:IP ACL Ingress,  4:IPV6 ACL Ingress,  5:Combined ACL Ingress,  6:MAC Diffserv Ingress, 7:IP Diffserv Ingress,  8:IPV6 Diffserv Ingress,  9:MAC Diffserv Egress,  10:IP Diffserv Egress,  11:IPV6 Diffserv Egress,  12:Voice VLAN,  13:QoS VLAN,  14:VLAN VPN Ingress,  15:VLAN VPN Egress,  16:IPV4 Source Guard,  17:IPV6 Source Guard,  18:CPP Egress,  19:VRF,  20:Tunnel V4,  21:Tunnel V6 Stage0,  22:Tunnel V6 Stage1,  23:MPLS UNI,  24:MPLS NNI0,  25:MPLS NNI1,  26:VXLAN V4 UNI,  27:VXLAN V6 UNI,  28:VXLAN V4 NNI Stage0,  29:VXLAN V4 NNI Stage1,  30:VXLAN V6 NNI Stage0,  31:VXLAN V6 NNI Stage1,  32:BFD V4,  33:BFD V6,  34:VXLAN Passenger,  35:QoS Rule V4,  36:QoS Rule V6 .","format":"int32"},"usedNum":{"type":"integer","description":"The number of entries currently used by the feature.","format":"int32"},"freeNum":{"type":"integer","description":"The number of entries currently available for use by the feature.","format":"int32"}},"description":"The list contains usage details of SDM resources on the device, including used and available resources."},"OperationResponseListOswInterfaceBriefVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/OswInterfaceBriefVO"}}}},"OswInterfaceBriefVO":{"type":"object","properties":{"type":{"type":"integer","description":"Interface type, 0: Loopback interface; 1: VLAN interface","format":"int32"},"id":{"type":"string","description":"ID."},"interfaceId":{"type":"integer","description":"Interface ID. For loopback interface, the value is loopbackId. For vlan interface, the value is vlan.","format":"int32"},"name":{"type":"string","description":"Interface Name. Not Null when type is 1."}}},"FloatSubHealthInfoDetailVO":{"type":"object","properties":{"summaryScore":{"type":"integer","description":"Sub dimension health score","format":"int32"},"support":{"type":"boolean","description":"Sub dimension support"},"incidents":{"type":"array","description":"Incident information for this health dimension, null if no incidents","items":{"$ref":"#/components/schemas/AnomalyBriefCountVO"}},"averageNum":{"type":"integer","description":"Average value of common dimension, such as cpu、memory","format":"int32"},"pastNums":{"type":"array","description":"List of common dimension value , such as cpu、memory","items":{"$ref":"#/components/schemas/TimeValueItemVO"}},"averageFloat":{"type":"number","description":"Average float value of common dimension","format":"float"},"pastFloats":{"type":"array","description":"List of common dimension float value","items":{"$ref":"#/components/schemas/TimeFloatValueItemVO"}}},"description":"Error frame health info and score"},"LinkErrorHealthInfoDetailVO":{"type":"object","properties":{"summaryScore":{"type":"integer","description":"Sub dimension health score","format":"int32"},"support":{"type":"boolean","description":"Sub dimension support"},"incidents":{"type":"array","description":"Incident information for this health dimension, null if no incidents","items":{"$ref":"#/components/schemas/AnomalyBriefCountVO"}},"averageNum":{"type":"integer","description":"Average value of common dimension, such as cpu、memory","format":"int32"},"pastNums":{"type":"array","description":"List of common dimension value , such as cpu、memory","items":{"$ref":"#/components/schemas/TimeValueItemVO"}},"portNum":{"type":"integer","description":"Total number of ports.","format":"int32"}},"description":"Port link error info and score"},"OperationResponseOswHealthDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswHealthDetailVO"}}},"OswHealthDetailVO":{"type":"object","properties":{"score":{"type":"integer","description":"Device health score.","format":"int32"},"cpu":{"$ref":"#/components/schemas/CommonSubHealthInfoDetailVO"},"memory":{"$ref":"#/components/schemas/CommonSubHealthInfoDetailVO"},"incident":{"$ref":"#/components/schemas/IncidentSubHealthInfoDetailVO"},"temperature":{"$ref":"#/components/schemas/CommonSubHealthInfoDetailVO"},"packetLoss":{"$ref":"#/components/schemas/FloatSubHealthInfoDetailVO"},"errorFrame":{"$ref":"#/components/schemas/FloatSubHealthInfoDetailVO"},"linkError":{"$ref":"#/components/schemas/LinkErrorHealthInfoDetailVO"}}},"TimeFloatValueItemVO":{"type":"object","properties":{"time":{"type":"integer","description":"Time(unit:ms)","format":"int64"},"pastNum":{"type":"number","description":"Value corresponding to time","format":"float"}},"description":"List of common dimension float value"},"OperationResponseSwitchGeneralConfig":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SwitchGeneralConfig"}}},"DhcpUserGridVODhcpUserVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DhcpUserVO"}},"serverNameToMacMap":{"type":"object","additionalProperties":{"type":"array","description":"Mapping between server name and macs","items":{"type":"string","description":"Mapping between server name and macs"}},"description":"Mapping between server name and macs"},"serverNameToStackIdMap":{"type":"object","additionalProperties":{"type":"array","description":"Mapping between server name and stack IDs","items":{"type":"string","description":"Mapping between server name and stack IDs"}},"description":"Mapping between server name and stack IDs"},"netNameToIdMap":{"type":"object","additionalProperties":{"type":"string","description":"Mapping between lan network name and lan network ID"},"description":"Mapping between lan network name and lan network ID"},"selectedNum":{"type":"integer","description":"The number of DHCP users that cannot be selected when adding from the user list in DHCP reservation.","format":"int64"}}},"DhcpUserVO":{"type":"object","properties":{"type":{"type":"integer","description":"Type should be a value as follows: 0: Device; 1: Client","format":"int32"},"ipAddress":{"type":"string","description":"IP Address"},"macAddress":{"type":"string","description":"Mac Address"},"name":{"type":"string","description":"Dhcp User Name"},"showingType":{"type":"string","description":"Client Type or Device Type"},"model":{"type":"string","description":"device Model"},"modelVersion":{"type":"string","description":"device ModelVersion"},"netId":{"type":"string","description":"Network ID"},"netName":{"type":"string","description":"Network Name"},"serverName":{"type":"string","description":"Dhcp Server Device Name"},"serverMac":{"type":"string","description":"Dhcp Server Device Mac"},"serverStackId":{"type":"string","description":"Dhcp Server Stack ID"},"leftLeaseTime":{"type":"string","description":"Left Lease Time"},"status":{"type":"integer","description":"Status should be a value as follows: 0: Dynamic Binding; 1: Static Binding","format":"int32"},"ipLong":{"type":"integer","format":"int64"}}},"OperationResponseDhcpUserGridVODhcpUserVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DhcpUserGridVODhcpUserVO"}}},"OperationResponseListOswDDMInfoOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/OswDDMInfoOpenApiVO"}}}},"OswDDMInfoOpenApiVO":{"type":"object","properties":{"port":{"type":"integer","description":"Switch portId.","format":"int32"},"standardPort":{"type":"string","description":"Switch stack portId(unit/slot/port)."},"rxPower":{"type":"number","description":"The received optical power(mW) of the optical module.","format":"double"},"rxPowerDbm":{"type":"number","description":"The received optical power(dbm) of the optical module.","format":"double"},"biasCurrent":{"type":"number","description":"The biasCurrent(mA) of the optical module.","format":"double"},"dataReady":{"type":"integer","description":"Whether the DDM data is valid(0:invalid, 1:valid).","format":"int32"},"voltage":{"type":"number","description":"The voltage(V) of the optical module.","format":"double"},"transmitFault":{"type":"integer","description":"Whether the optical module is in the Transmission Fault state(0:false, 1:true).","format":"int32"},"txPower":{"type":"number","description":"The transmitted optical power(mW) of the optical module.","format":"double"},"txPowerDbm":{"type":"number","description":"The transmitted optical power(dbm) of the optical module.","format":"double"},"lossOfSignal":{"type":"integer","description":"Whether the optical module is in the Loss Of Signal state(0:false, 1:true).","format":"int32"},"temperature":{"type":"number","description":"The temperature(Celsius) of the optical module.","format":"double"},"temperatureFah":{"type":"number","description":"The temperature(Fahrenheit) of the optical module.","format":"double"}}},"OperationResponseListOswDetailForPortsViewVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/OswDetailForPortsViewVO"}}}},"OswDetailForPortsViewVO":{"type":"object","properties":{"type":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"mac":{"type":"string","description":"Device mac"},"name":{"type":"string","description":"Device name,default value is the mac address of device"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"compoundModel":{"type":"string","description":"Model complex used in the backend.Ap：model+(country)+modelVersion,  EAP225(EU) v3.0 Ap: specialModel+modelVersion, EAP225-Outdoor-1a20a950b8d950e8 v1.0  Gateway/Switch：model+modelVersion, Osg v3.0"},"showModel":{"type":"string","description":"Model complex shown in the front end.Ap：model+(country)+modelVersion,EAP225(EU) v3.0  Gateway/Switch：model+modelVersion,Osg v3.0"},"specialModel":{"type":"string","description":"Special device model,for example:EAP225-Outdoor-1a20a950b8d950e8"},"firmwareVersion":{"type":"string","description":"Version of firmware,for example:2.5.0 Build 20190118 Rel. 64821"},"version":{"type":"string","description":"Simplified version of firmware,for example:2.5.0"},"hwVersion":{"type":"string","description":"Version of hardware,for example 1.0"},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected;1:Disconnected(Migrating);10:Provisioning;11:Configuring;12:Upgrading;13:Rebooting;14:Connected;15:Connected(Wireless);16:Connected(Migrating);17:Connected(Wireless,Migrating);20:Pending;21:Pending(Wireless);22:Adopting;23:Adopting(Wireless);24:Adopt Failed;25:Adopt Failed(Wireless);26:Managed By Others;27:Managed By Others(Wireless);30:Heartbeat Missed;31:Heartbeat Missed(Wireless);32:Heartbeat Missed(Migrating);33:Heartbeat Missed(Wireless,Migrating);40:Isolated;41:Isolated(Migrating);50:Slice Configuring","format":"int32"},"statusCategory":{"type":"integer","description":"Category of device status,statusCategory should be a value as follows: 0:Disconnected;1:Connected;2:Pending;3:Heartbeat Missed;4:Isolated","format":"int32"},"es":{"type":"boolean","description":"Whether the device is Agile Series Switch"},"site":{"type":"string","description":"Site of the device"},"siteName":{"type":"string","description":"Site name of the device"},"omadacId":{"type":"string","description":"OmadacId of the device"},"compatible":{"type":"integer","description":"Device firmware and controller compatibility type.Compatible should be a value as follows: 0:COMPATIBLE;1:HIGH_MAJOR_VER;2:LOW_MAJOR_VER;3:HIGH_MINOR_VER;4:LOW_MINOR_VER;7:HIGH_COMPONENT_VER;10:DEVICE_NOT_COMPATIBLE;11:HIGH_ADOPT_COMMPONENT;12:DEVICE_CATEGORY_NOT_COMPATIBLE;14:DEVICE_NOT_COMPATIBLE_IN_CLUSTER","format":"int32"},"supportAnomaly":{"type":"boolean","description":"Whether the device firmware support intelligent anomaly detection"},"supportLocatePort":{"type":"boolean","description":"Whether the device supports locating port"},"active":{"type":"boolean","description":"whether to active the device(cloud base exclusive)"},"licenseStatus":{"type":"integer","description":"License status(cloud base exclusive).LicenseStatus should be a value as follows: 0:unActive 1:Unbind 2:Expired 3:active","format":"int32"},"dueTime":{"type":"integer","description":"Expire timestamp of license(cloud base exclusive)","format":"int64"},"dueTimeLeft":{"type":"integer","description":"Milliseconds from the current moment to the expiration time(cloud base exclusive)","format":"int64"},"licenseId":{"type":"string","description":"License key on detail page of device(cloud base exclusive)"},"licenseUnbindingLimit":{"type":"integer","description":"Remaining unbind count for license on detail Page of device(cloud base exclusive)","format":"int32"},"initialUnbindingLimit":{"type":"integer","description":"Initial unbind count for license(cloud base exclusive)","format":"int32"},"category":{"type":"string","description":"Category of license"},"forgetId":{"type":"string","description":"Forget ID of device"},"sn":{"type":"string","description":"SN code of device"},"eost":{"type":"integer","description":"End of service time of device(CBC exclusive)","format":"int64"},"eos":{"type":"integer","description":"End of support time of device(CBC exclusive)","format":"int64"},"inWhitelist":{"type":"boolean","description":"Whether the device is in white list"},"location":{"$ref":"#/components/schemas/DeviceLocationDetailVO"},"addedInAdvanced":{"type":"boolean","description":"Whether the device is added in advanced."},"customId":{"type":"string","description":"Customer ID"},"customName":{"type":"string","description":"Customer name"},"moveSiteId":{"type":"string","description":"Record that the device is in a moveSite operation; if it is null, then it is not in the moveSite operation."},"remember":{"type":"boolean","description":"Whether to remember the device(deprecated)","deprecated":true},"rememberDevice":{"type":"integer","description":"Whether to remember the device.RememberDevice should be a value as follows: 0:off, 1:on, 2: follow site","format":"int32"},"description":{"type":"string","description":"Description of the device"},"disableHwReset":{"type":"boolean","description":"Whether to disable hardware reset"},"templateId":{"type":"string","description":"ID of the template bound to the device"},"templateName":{"type":"string","description":"Name of the template bound to the device"},"boundSiteTemplate":{"type":"boolean","description":"Whether the site where the device is located is bound to a site template"},"deviceTemplateAvailable":{"type":"boolean","description":"Whether there is an available device template for the device; it is false if the model is not supported or the site template has not created the corresponding device template."},"boundDeviceTemplate":{"type":"boolean","description":"Whether the device is bound to device template"},"siteTemplateName":{"type":"string","description":"Template name bound to the site"},"siteTemplateId":{"type":"string","description":"Template ID bound to the site"},"deviceSeriesType":{"type":"integer","description":"Device series type.DeviceSeriesType should be a value as follows: 0:advanced;1:pro","format":"int32"},"resource":{"type":"integer","description":"Data source.Resource should be a value as follows: 0:new created;1:from template;2:override","format":"int32"},"ecspFirstVersion":{"type":"integer","description":"Ecsp first version","format":"int32"},"latestVersion":{"type":"string","description":"Latest firmware version"},"replaceDeviceInfo":{"$ref":"#/components/schemas/DeviceReplaceSettingVO"},"uplink":{"$ref":"#/components/schemas/OswUplinkVO"},"downlinkList":{"type":"array","description":"Downlink Omada device list","items":{"$ref":"#/components/schemas/OswDownlinkVO"}},"stpLinkList":{"type":"array","description":"STP Blocked Link Omada device list","items":{"$ref":"#/components/schemas/OswDownlinkVO"}},"clientList":{"type":"array","description":"Downlink Client device list","items":{"$ref":"#/components/schemas/OswDownLinkClientVO"}},"supportClearCounters":{"type":"boolean","description":"Clear Counters Support"},"stackMsg":{"$ref":"#/components/schemas/StackMsgVO"},"locatingPorts":{"type":"array","description":"Locating switch ports, effective when parameter[locateEnable] is true and device is not a member of stack","items":{"type":"integer","description":"Locating switch ports, effective when parameter[locateEnable] is true and device is not a member of stack","format":"int32"}},"locatingStandardPorts":{"type":"array","description":"Locating switch standard ports, effective when parameter[locateEnable] is true and device is a member of stack","items":{"type":"string","description":"Locating switch standard ports, effective when parameter[locateEnable] is true and device is a member of stack"}}}},"OswDownLinkClientVO":{"type":"object","properties":{"port":{"type":"integer","description":"(Wired) Port ID.","format":"int32"},"lagId":{"type":"integer","description":"(Wired) LAG ID. Exists only when the client is connected to the LAG.","format":"int32"},"unit":{"type":"integer","description":"Unit ID.","format":"int32"},"standardPort":{"type":"string","description":"Standard port."},"name":{"type":"string","description":"Client Name, alias"},"mac":{"type":"string","description":"Client MAC Address"},"model":{"type":"string","description":"Client Model"},"deviceType":{"type":"string","description":"Device Type: iPhone, iPod, Android, PC, printer, TV..."},"ip":{"type":"string","description":"IP Address"}},"description":"Downlink Client device list"},"GridVOOswPortsSettingPoeVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OswPortsSettingPoeVO"}}}},"OperationResponseGridVOOswPortsSettingPoeVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOswPortsSettingPoeVO"}}},"OswPortsSettingPoeVO":{"type":"object","properties":{"port":{"type":"integer","description":"Port","format":"int32"},"standardPort":{"$ref":"#/components/schemas/OswStandPortVO"},"configStack":{"type":"boolean","description":"Indicates whether the current port is configured as a stack port (joined a stack aggregation group)"},"configMlagPeerLink":{"type":"boolean","description":"Indicates whether the current port is configured as M-LAG peer Link"},"configMlagDad":{"type":"boolean","description":"Indicates whether the current port is configured as M-LAG dad Link"},"stackPortsGroupIndex":{"type":"integer","description":"Number of the stacking port aggregation group to join","format":"int32"},"portName":{"type":"string","description":"Port Name"},"switchMac":{"type":"string","description":"Switch Mac to which the port belongs"},"switchName":{"type":"string","description":"Switch Name to which the port belongs"},"switchType":{"type":"integer","description":"Switch Type to which the port belongs","format":"int32"},"switchStatusCategory":{"type":"integer","description":"Category of switch status, switchStatusCategory should be a value as follows: 0:Disconnected;1:Connected;2:Pending;3:Heartbeat Missed;4:Isolated.Only 'Disconnected' and 'Connected' and 'Heartbeat' switches ports will be displayed.","format":"int32"},"switchSupportPoe":{"type":"integer","description":"Indicates whether the switch supports PoE, switchSupportPoe should be a value as follows: 0:Not Support;1:Support.","format":"int32"},"site":{"type":"string","description":"Site to which the port belongs"},"tagIds":{"type":"array","description":"Port label ID List","items":{"type":"string","description":"Port label ID List"}},"tagName":{"type":"string","description":"Port label Name"},"connectedStatus":{"type":"integer","description":"Port connected status should be a value as follows: 0: Connected; 1: Disconnected; 2: Disable","format":"int32"},"madUsed":{"type":"boolean","description":"Mad Used"},"disable":{"type":"boolean","description":"Indicates whether to disable the port"},"type":{"type":"integer","description":"Type should be a value as follows: 1: Copper; 2: Combo; 3: SFP","format":"int32"},"operation":{"type":"string","description":"Operation should be a value as follows: SWITCHING; MIRRORING; AGGREGATING"},"supportPoe":{"type":"boolean","description":"Indicates whether PoE is supported"},"poeDisplayType":{"type":"integer","description":"PoeDisplayType should be a value as follows: -1: Not Support POE; 0: Support POE; 1: POE(4W); 2: POE(7W); 3: POE(15.4W); 4: POE+(30W); 5: POE++(45W); 6: POE++(60W); 7: POE++(75W); 8: POE++(90W); 9: POE++(100W).","format":"int32"},"poe":{"type":"integer","description":"PoE switch should be a value as follows: 0: Off; 1: 802.3at/af","format":"int32"},"portStatus":{"$ref":"#/components/schemas/OswPortStatusVO"},"linkSpeed":{"type":"integer","description":"Link Speed should be a value as follows: 0: auto; 1: 10M; 2: 100M; 3: 1000M; 4: 10G","format":"int32"},"duplex":{"type":"integer","description":"Duplex should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"},"lagSetting":{"$ref":"#/components/schemas/OswStackLagVO"},"stackId":{"type":"string","description":"Stack ID to which the port belongs"},"stackName":{"type":"string","description":"Stack Name to which the port belongs"},"unit":{"type":"integer","description":"Stack Unit to which the port belongs","format":"int32"},"poeStatus":{"type":"number","description":"Poe Status","format":"double"},"pdClass":{"type":"string","description":"Poe PD Class"},"power":{"type":"number","description":"Poe Power","format":"double"},"voltage":{"type":"number","description":"Poe Voltage","format":"double"},"current":{"type":"number","description":"Poe Current","format":"double"}}},"GridVOOswPortsSettingOverviewVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OswPortsSettingOverviewVO"}}}},"OperationResponseGridVOOswPortsSettingOverviewVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOswPortsSettingOverviewVO"}}},"OswPortsSettingOverviewVO":{"type":"object","properties":{"port":{"type":"integer","description":"Port","format":"int32"},"standardPort":{"$ref":"#/components/schemas/OswStandPortVO"},"configStack":{"type":"boolean","description":"Indicates whether the current port is configured as a stack port (joined a stack aggregation group)"},"configMlagPeerLink":{"type":"boolean","description":"Indicates whether the current port is configured as M-LAG peer Link"},"configMlagDad":{"type":"boolean","description":"Indicates whether the current port is configured as M-LAG dad Link"},"stackPortsGroupIndex":{"type":"integer","description":"Number of the stacking port aggregation group to join","format":"int32"},"portName":{"type":"string","description":"Port Name"},"switchMac":{"type":"string","description":"Switch Mac to which the port belongs"},"switchName":{"type":"string","description":"Switch Name to which the port belongs"},"switchType":{"type":"integer","description":"Switch Type to which the port belongs","format":"int32"},"switchStatusCategory":{"type":"integer","description":"Category of switch status, switchStatusCategory should be a value as follows: 0:Disconnected;1:Connected;2:Pending;3:Heartbeat Missed;4:Isolated.Only 'Disconnected' and 'Connected' and 'Heartbeat' switches ports will be displayed.","format":"int32"},"switchSupportPoe":{"type":"integer","description":"Indicates whether the switch supports PoE, switchSupportPoe should be a value as follows: 0:Not Support;1:Support.","format":"int32"},"site":{"type":"string","description":"Site to which the port belongs"},"tagIds":{"type":"array","description":"Port label ID List","items":{"type":"string","description":"Port label ID List"}},"tagName":{"type":"string","description":"Port label Name"},"connectedStatus":{"type":"integer","description":"Port connected status should be a value as follows: 0: Connected; 1: Disconnected; 2: Disable","format":"int32"},"madUsed":{"type":"boolean","description":"Mad Used"},"disable":{"type":"boolean","description":"Indicates whether to disable the port"},"type":{"type":"integer","description":"Type should be a value as follows: 1: Copper; 2: Combo; 3: SFP","format":"int32"},"operation":{"type":"string","description":"Operation should be a value as follows: SWITCHING; MIRRORING; AGGREGATING"},"supportPoe":{"type":"boolean","description":"Indicates whether PoE is supported"},"poeDisplayType":{"type":"integer","description":"PoeDisplayType should be a value as follows: -1: Not Support POE; 0: Support POE; 1: POE(4W); 2: POE(7W); 3: POE(15.4W); 4: POE+(30W); 5: POE++(45W); 6: POE++(60W); 7: POE++(75W); 8: POE++(90W); 9: POE++(100W).","format":"int32"},"poe":{"type":"integer","description":"PoE switch should be a value as follows: 0: Off; 1: 802.3at/af","format":"int32"},"portStatus":{"$ref":"#/components/schemas/OswPortStatusVO"},"linkSpeed":{"type":"integer","description":"Link Speed should be a value as follows: 0: auto; 1: 10M; 2: 100M; 3: 1000M; 4: 10G","format":"int32"},"duplex":{"type":"integer","description":"Duplex should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"},"lagSetting":{"$ref":"#/components/schemas/OswStackLagVO"},"stackId":{"type":"string","description":"Stack ID to which the port belongs"},"stackName":{"type":"string","description":"Stack Name to which the port belongs"},"unit":{"type":"integer","description":"Stack Unit to which the port belongs","format":"int32"},"networkMode":{"type":"integer","description":"Network Mode should be a value as follows: 0: Trunk, 1: Access","format":"int32"},"nativeNetworkId":{"type":"string","description":"Native Network ID, Native Network cannot be selected from Tagged Networks or Untagged Networks."},"nativeBridgeVlan":{"type":"integer","description":"Native Network Bridge Vlan.","format":"int32"},"networkTagsSetting":{"type":"integer","description":"Network Tags Setting should be a value as follows: 0: Allow All; 1: Block All; 2: Custom","format":"int32"},"profileId":{"type":"string","description":"Lan Profile ID"},"profileName":{"type":"string","description":"Lan Profile Name"},"profileOverrideEnable":{"type":"boolean","description":"Indicates whether to enable Profile Override"},"profileType":{"type":"integer","description":"Lan Profile Type","format":"int32"}}},"GridVOOswPortsSettingCountersVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OswPortsSettingCountersVO"}}}},"OperationResponseGridVOOswPortsSettingCountersVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOswPortsSettingCountersVO"}}},"OswPortsSettingCountersVO":{"type":"object","properties":{"port":{"type":"integer","description":"Port","format":"int32"},"standardPort":{"$ref":"#/components/schemas/OswStandPortVO"},"configStack":{"type":"boolean","description":"Indicates whether the current port is configured as a stack port (joined a stack aggregation group)"},"configMlagPeerLink":{"type":"boolean","description":"Indicates whether the current port is configured as M-LAG peer Link"},"configMlagDad":{"type":"boolean","description":"Indicates whether the current port is configured as M-LAG dad Link"},"stackPortsGroupIndex":{"type":"integer","description":"Number of the stacking port aggregation group to join","format":"int32"},"portName":{"type":"string","description":"Port Name"},"switchMac":{"type":"string","description":"Switch Mac to which the port belongs"},"switchName":{"type":"string","description":"Switch Name to which the port belongs"},"switchType":{"type":"integer","description":"Switch Type to which the port belongs","format":"int32"},"switchStatusCategory":{"type":"integer","description":"Category of switch status, switchStatusCategory should be a value as follows: 0:Disconnected;1:Connected;2:Pending;3:Heartbeat Missed;4:Isolated.Only 'Disconnected' and 'Connected' and 'Heartbeat' switches ports will be displayed.","format":"int32"},"switchSupportPoe":{"type":"integer","description":"Indicates whether the switch supports PoE, switchSupportPoe should be a value as follows: 0:Not Support;1:Support.","format":"int32"},"site":{"type":"string","description":"Site to which the port belongs"},"tagIds":{"type":"array","description":"Port label ID List","items":{"type":"string","description":"Port label ID List"}},"tagName":{"type":"string","description":"Port label Name"},"connectedStatus":{"type":"integer","description":"Port connected status should be a value as follows: 0: Connected; 1: Disconnected; 2: Disable","format":"int32"},"madUsed":{"type":"boolean","description":"Mad Used"},"disable":{"type":"boolean","description":"Indicates whether to disable the port"},"type":{"type":"integer","description":"Type should be a value as follows: 1: Copper; 2: Combo; 3: SFP","format":"int32"},"operation":{"type":"string","description":"Operation should be a value as follows: SWITCHING; MIRRORING; AGGREGATING"},"supportPoe":{"type":"boolean","description":"Indicates whether PoE is supported"},"poeDisplayType":{"type":"integer","description":"PoeDisplayType should be a value as follows: -1: Not Support POE; 0: Support POE; 1: POE(4W); 2: POE(7W); 3: POE(15.4W); 4: POE+(30W); 5: POE++(45W); 6: POE++(60W); 7: POE++(75W); 8: POE++(90W); 9: POE++(100W).","format":"int32"},"poe":{"type":"integer","description":"PoE switch should be a value as follows: 0: Off; 1: 802.3at/af","format":"int32"},"portStatus":{"$ref":"#/components/schemas/OswPortStatusVO"},"linkSpeed":{"type":"integer","description":"Link Speed should be a value as follows: 0: auto; 1: 10M; 2: 100M; 3: 1000M; 4: 10G","format":"int32"},"duplex":{"type":"integer","description":"Duplex should be a value as follows: 0: Auto; 1: Half; 2: Full","format":"int32"},"lagSetting":{"$ref":"#/components/schemas/OswStackLagVO"},"stackId":{"type":"string","description":"Stack ID to which the port belongs"},"stackName":{"type":"string","description":"Stack Name to which the port belongs"},"unit":{"type":"integer","description":"Stack Unit to which the port belongs","format":"int32"},"txBytes":{"type":"integer","description":"Total Tx Bytes","format":"int64"},"txFrames":{"type":"integer","description":"Total TX Packets","format":"int64"},"txMulticast":{"type":"integer","description":"Total TX Multicast Packets","format":"int64"},"txBroadcast":{"type":"integer","description":"Total TX Broadcast Packets","format":"int64"},"txErrors":{"type":"integer","description":"Total TX Errors","format":"int64"},"rxBytes":{"type":"integer","description":"Total Rx Bytes","format":"int64"},"rxFrames":{"type":"integer","description":"Total RX Packets","format":"int64"},"rxMulticast":{"type":"integer","description":"Total RX Multicast Packets","format":"int64"},"rxBroadcast":{"type":"integer","description":"Total RX Broadcast Packets","format":"int64"},"rxErrors":{"type":"integer","description":"Total RX Errors","format":"int64"}}},"HealthTimeLineVO":{"type":"object","properties":{"timeline":{"type":"array","description":"Health timeline","items":{"$ref":"#/components/schemas/MacTimeScoreListVO"}}}},"MacTimeScoreListVO":{"type":"object","properties":{"mac":{"type":"string","description":"Mac address"},"scores":{"type":"array","description":"Health score with time","items":{"$ref":"#/components/schemas/TimeScoreItemVO"}}},"description":"Health timeline"},"OperationResponseHealthTimeLineVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/HealthTimeLineVO"}}},"EasyManageOverviewInfo":{"type":"object","properties":{"mac":{"type":"string","description":"Switch MAC address"},"ip":{"type":"string","description":"Switch IP address"},"model":{"type":"string","description":"Model"},"firmwareVersion":{"type":"string","description":"Firmware Version e.g:2.5.0 Build 20190118 Rel. 64821"},"version":{"type":"string","description":"Firmware Version e.g:2.5.0"},"hwVersion":{"type":"string","description":"Hardware Version"},"uptime":{"type":"string","description":"Uptime"},"portList":{"type":"array","description":"Port List","items":{"$ref":"#/components/schemas/PortInfo"}}}},"OperationResponseEasyManageOverviewInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/EasyManageOverviewInfo"}}},"NetworkPortsAssociationVO":{"type":"object","properties":{"id":{"type":"string","description":"Network's ID"},"name":{"type":"string","description":"Network's name"},"vlan":{"type":"integer","description":"VLAN ID","format":"int32"},"nativePorts":{"type":"array","description":"Native ports list","items":{"type":"integer","description":"Native ports list","format":"int32"}},"untaggedPorts":{"type":"array","description":"Untagged ports list","items":{"type":"integer","description":"Untagged ports list","format":"int32"}},"taggedPorts":{"type":"array","description":"Tagged ports list","items":{"type":"integer","description":"Tagged ports list","format":"int32"}}},"description":"NetworkPortsAssociationVO"},"OperationResponseListNetworkPortsAssociationVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/NetworkPortsAssociationVO"}}}},"EasyManagedSwitchGeneralConfigDetail":{"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,30}[^ ]$","type":"string","description":"Device name should contain 1 to 32 characters."},"ledSetting":{"type":"integer","description":"LED setting should be a value as follows: 0:off; 1:on; 2:Use Site Settings","format":"int32"},"tagIds":{"type":"array","description":"Tag IDs","items":{"type":"string","description":"Tag IDs"}},"jumboEnable":{"type":"boolean","description":"Parameter [jumboEnable] should be true or false."},"location":{"$ref":"#/components/schemas/DeviceLocationDetailVO"},"remember":{"type":"boolean","description":"Parameter [remember] should be true or false."},"supportPowerAlert":{"type":"boolean","description":"Parameter [supportPowerAlert] should be true or false."},"powerAlertEnable":{"type":"boolean","description":"Power alert status."}}},"OperationResponseEasyManagedSwitchGeneralConfigDetail":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/EasyManagedSwitchGeneralConfigDetail"}}},"OperationResponseSiteSupportSwitchOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteSupportSwitchOpenApiVO"}}},"SiteSupportSwitchOpenApiVO":{"type":"object","properties":{"supportES":{"type":"boolean","description":"Whether the site supports adopting Agile Series Switches"},"supportL2":{"type":"boolean","description":"Whether the site supports adopting Non-Agile Series Switches"}}},"GridVOOswQosRuleVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OswQosRuleVO"}}}},"OperationResponseGridVOOswQosRuleVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOswQosRuleVO"}}},"GridVOOswDetailVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OswDetailVO"}}}},"OperationResponseGridVOOswDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOswDetailVO"}}},"OperationResponseOswMacListVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswMacListVO"}}},"OperationResponseQueueSchedulerMappingVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/QueueSchedulerMappingVO"}}},"OperationResponseOswQosModeVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswQosModeVO"}}},"DeviceOuiModeQueryOpenApiVO":{"required":["deviceMac"],"type":"object","properties":{"deviceMac":{"type":"string","description":"Device MAC. E.g. AA-BB-CC-DD-11-22 ."},"deviceName":{"type":"string","description":"Device Name"},"portList":{"type":"array","description":"Configured Switch port.","items":{"type":"integer","description":"Configured Switch port.","format":"int32"}},"lagList":{"type":"array","description":"Configured Switch lag.","items":{"type":"integer","description":"Configured Switch lag.","format":"int32"}},"lagInfo":{"type":"array","description":"Switch lag info.","items":{"$ref":"#/components/schemas/LagInfoOpenApiVO"}}},"description":"When mode is 0, Show configured device info."},"GridVOOuiBasedVlanSwitchQueryOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OuiBasedVlanSwitchQueryOpenApiVO"}}}},"LagInfoOpenApiVO":{"type":"object","properties":{"lag":{"type":"integer","description":"Lag number.","format":"int32"},"ports":{"type":"array","description":"Ports in lag","items":{"type":"integer","description":"Ports in lag","format":"int32"}},"name":{"type":"string","description":"Lag name."}},"description":"Switch lag info."},"OperationResponseGridVOOuiBasedVlanSwitchQueryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOuiBasedVlanSwitchQueryOpenApiVO"}}},"OuiBasedVlanSwitchQueryOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Rule ID"},"enable":{"type":"boolean","description":"Switch Rule state."},"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Switch Rule name should contain 1 to 128 characters."},"mode":{"type":"integer","description":"Switch Rule type should be a value as follows: 0: All device port; 1: Custom device port","format":"int32"},"deviceList":{"type":"array","description":"When mode is 0, Show configured device info.","items":{"$ref":"#/components/schemas/DeviceOuiModeQueryOpenApiVO"}},"ruleCombine":{"type":"array","description":"Basic vlan-oui-priority configuration of oui based vlan rule.","items":{"$ref":"#/components/schemas/VlanOuiModeQueryOpenApiVO"}}}},"OperationResponseStatisticsOswVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/StatisticsOswVO"}}},"OswStatDownLinkVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device mac"},"type":{"type":"string","description":"Type of down-link device"},"clientType":{"type":"string","description":"Type of down-link client"},"name":{"type":"string","description":"Device name"},"statusCategory":{"type":"integer","description":"Category of device status,statusCategory should be a value as follows: 0:Disconnected; 1:Connected; 2:Pending; 3:Heartbeat Missed; 4:Isolated","format":"int32"},"model":{"type":"string","description":"Model of device"},"modelVersion":{"type":"string","description":"Model version of device"}},"description":"Downlink devices of the port"},"OswStatPortStatusVO":{"type":"object","properties":{"linkStatus":{"type":"integer","description":"LinkStatus should be a value as follows: 0:link down; 1:link up","format":"int32"},"stkStatus":{"type":"integer","description":"Stack Status should be a value as follows: 0:DOWN; 1:AUTHFAIL; 2:IEEE; 3:OK","format":"int32"},"linkSpeed":{"type":"integer","description":"LinkSpeed should be a value as follows: 1:10Mbps; 2:100Mbps; 3:1000Mbps; 4:10Gbps","format":"int32"},"poe":{"type":"boolean","description":"Indicates whether PoE power supply is in use"},"tx":{"type":"integer","description":"Transmit traffic of the port, in bytes","format":"int64"},"rx":{"type":"integer","description":"Receive traffic of the port, in bytes","format":"int64"},"total":{"type":"integer","description":"Transmit traffic + Receive traffic of the port, in bytes","format":"int64"},"stpDiscarding":{"type":"boolean","description":"STP Discarding"}},"description":"Port Status"},"OswStatPortVO":{"type":"object","properties":{"port":{"type":"integer","description":"Port id","format":"int32"},"name":{"type":"string","description":"Port name"},"type":{"type":"integer","description":"Type should be a value as follows: 1:Copper; 2:Combo; 3:SFP","format":"int32"},"operation":{"type":"string","description":"Operation should be a value as follows: SWITCHING; MIRRORING; AGGREGATING"},"portStatus":{"$ref":"#/components/schemas/OswStatPortStatusVO"},"downlink":{"$ref":"#/components/schemas/OswStatDownLinkVO"},"maxSpeed":{"type":"integer","description":"Max speed supported by the port","format":"int32"},"disable":{"type":"boolean","description":"Whether the port is disabled"},"configStack":{"type":"boolean","description":"Indicates whether the current port is configured as a stack port (joined a stack aggregation group)"},"stackPortsGroupIndex":{"type":"integer","description":"Number of the stacking port aggregation group to join","format":"int32"},"configMlagPeerLink":{"type":"boolean","description":"Standard port information"},"configMlagDad":{"type":"boolean"},"madUsed":{"type":"boolean"},"oswStandPort":{"$ref":"#/components/schemas/OswStandPortVO"}},"description":"Ports information"},"OswStatUplinkVO":{"type":"object","properties":{"port":{"type":"integer","description":"Port ID","format":"int32"},"mac":{"type":"string","description":"Device mac"},"name":{"type":"string","description":"Device name"},"type":{"type":"string","description":"Device type"},"statusCategory":{"type":"integer","description":"Category of device status,statusCategory should be a value as follows: 0:Disconnected; 1:Connected; 2:Pending; 3:Heartbeat Missed; 4:Isolated","format":"int32"},"model":{"type":"string","description":"Model of device"},"modelVersion":{"type":"string","description":"Model version of device"}},"description":"Uplink device information"},"StatisticsOswVO":{"type":"object","properties":{"name":{"type":"string","description":"Device name,default value is the mac address of device"},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected; 1:Disconnected(Migrating); 10:Provisioning; 11:Configuring; 12:Upgrading; 13:Rebooting; 14:Connected; 15:Connected(Wireless); 16:Connected(Migrating); 17:Connected(Wireless,Migrating); 20:Pending; 21:Pending(Wireless); 22:Adopting; 23:Adopting(Wireless); 24:Adopt Failed; 25:Adopt Failed(Wireless); 26:Managed By Others; 27:Managed By Others(Wireless); 30:Heartbeat Missed; 31:Heartbeat Missed(Wireless); 32:Heartbeat Missed(Migrating); 33:Heartbeat Missed(Wireless,Migrating); 40:Isolated; 41:Isolated(Migrating); 50:Slice Configuring","format":"int32"},"statusCategory":{"type":"integer","description":"Category of device status,statusCategory should be a value as follows: 0:Disconnected; 1:Connected; 2:Pending; 3:Heartbeat Missed; 4:Isolated","format":"int32"},"portNum":{"type":"integer","description":"Port number","format":"int32"},"ports":{"type":"array","description":"Ports information","items":{"$ref":"#/components/schemas/OswStatPortVO"}},"uplink":{"$ref":"#/components/schemas/OswStatUplinkVO"},"supportPoe":{"type":"boolean","description":"Whether the device supports POE function"},"speeds":{"type":"array","description":"Supported rate list for all ports. Speeds should be a value as follows: 0:auto; 1:10M; 2:100M; 3:1000M; 4:2.5G; 5:10G; 6:5G; 7:25G; 8:100G; 9:40G; -1:error; no value:all rate supported","items":{"type":"integer","description":"Supported rate list for all ports. Speeds should be a value as follows: 0:auto; 1:10M; 2:100M; 3:1000M; 4:2.5G; 5:10G; 6:5G; 7:25G; 8:100G; 9:40G; -1:error; no value:all rate supported","format":"int32"}},"supportStack":{"type":"boolean","description":"Whether device supports stack function"},"supportSTP":{"type":"boolean","description":"Whether device supports stp function"},"mlagMsg":{"$ref":"#/components/schemas/MlagMsgVO"}}},"GridVOOswStackVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OswStackVO"}}}},"MadSettingVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"Enable"},"mode":{"type":"integer","description":"Mode should be 0","format":"int32"},"selectPorts":{"type":"array","description":"Select Ports","items":{"type":"string","description":"Select Ports"}}},"description":"Mad Setting"},"OperationResponseGridVOOswStackVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOswStackVO"}}},"OswStackVO":{"required":["name"],"type":"object","properties":{"id":{"type":"string","description":"Stack ID"},"siteId":{"type":"string","description":"Site ID"},"siteName":{"type":"string","description":"Site Name"},"name":{"type":"string","description":"Stack Name"},"status":{"type":"integer","description":"Stack Status should be a value as follows: 0: normal; 1: abnormal; 2: stack not ready","format":"int32"},"abnormalReason":{"type":"integer","description":"Abnormal Reason","format":"int32"},"ip":{"type":"string","description":"IP"},"devicesNum":{"type":"integer","description":"Number of devices","format":"int32"},"licenseStatus":{"type":"integer","description":"License Status should be a value as follows: 0: Activated; 1: Unactivated; 2: Not All Activated, 3: Expired","format":"int32"},"dueTime":{"type":"integer","description":"Expiration time","format":"int64"},"dueTimeLeft":{"type":"integer","description":"The number of milliseconds from the current time to the expiration time","format":"int64"},"trafficDown":{"type":"integer","description":"Traffic Down","format":"int64"},"trafficUp":{"type":"integer","description":"Traffic Up","format":"int64"},"clients":{"type":"integer","description":"Clients","format":"int32"},"masterMac":{"type":"string","description":"Master device mac"},"masterDeviceActive":{"type":"boolean","description":"Marks whether the master device of the stack system is activated"},"loopbackNum":{"type":"integer","description":"Loopback Num","format":"int32"},"loop":{"type":"string","description":"Loopback port"},"blockNum":{"type":"integer","description":"Block Num","format":"int32"},"block":{"type":"string","description":"Block port"},"tag":{"type":"string","description":"Tag"},"member":{"type":"array","description":"Stack member list","items":{"$ref":"#/components/schemas/OswStackMemberVO"}},"detectedMember":{"type":"array","description":"List of members that have been detected by the stack","items":{"$ref":"#/components/schemas/OswStackMemberVO"}},"locateEnable":{"type":"boolean","description":"Indicates whether the locate function is enabled"},"version":{"type":"string","description":"Version"},"latestVersion":{"type":"string","description":"Latest Version"},"needUpgrade":{"type":"boolean","description":"Indicates whether an upgrade is required"},"fwDownload":{"type":"boolean","description":"Indicates whether the upgrade status is downloading"},"description":{"type":"string"},"qosConfig":{"$ref":"#/components/schemas/OswQosConfigVO"},"macDelay":{"$ref":"#/components/schemas/MacDelayVO"},"virtualMac":{"type":"string","description":"Virtual Mac"},"madSetting":{"$ref":"#/components/schemas/MadSettingVO"},"supportMacDelay":{"type":"boolean"}}},"OperationResponseOswStackDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswStackDetailVO"}}},"OperationResponseDeviceRememberConfig":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceRememberConfig"}}},"OperationResponseListOswStackPortVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/OswStackPortVO"}}}},"OswStackPortVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device Mac"},"unit":{"type":"integer","description":"Unit","format":"int32"},"ports":{"type":"array","description":"Port list","items":{"$ref":"#/components/schemas/OswStackMemberPortVO"}}}},"OperationResponseListOswStackMemberLagVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/OswStackMemberLagVO"}}}},"OperationResponseOswStackMemberLagVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswStackMemberLagVO"}}},"OperationResponseOswStackSwitchVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswStackSwitchVO"}}},"OswStackSwitchVO":{"type":"object","properties":{"adoptedSwitches":{"type":"array","description":"Adopted Switches","items":{"$ref":"#/components/schemas/OswVO"}},"detectedSwitches":{"type":"array","description":"Detected Switches","items":{"$ref":"#/components/schemas/OswVO"}}}},"OswVO":{"type":"object","properties":{"customId":{"type":"string","description":"Customer ID"},"customName":{"type":"string","description":"Customer name displayed in MSP mode"},"siteName":{"type":"string","description":"Site name"},"type":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"subDevType":{"type":"integer","description":"Device subtype, indicating a special device type for wireless routers. This field is not present for ordinary devices, where 1 represents a wireless router.","format":"int32"},"mac":{"type":"string","description":"Mac address"},"name":{"type":"string","description":"Default uses the MAC address as the name."},"model":{"type":"string","description":"Model, such as EAP225."},"compoundModel":{"type":"string","description":"Model complex used in the backend.Ap：model+(country)+modelVersion,  EAP225(EU) v3.0 Ap: specialModel+modelVersion, EAP225-Outdoor-1a20a950b8d950e8 v1.0  Gateway/Switch：model+modelVersion, Osg v3.0"},"showModel":{"type":"string","description":"Model complex shown in the front end.Ap：model+(country)+modelVersion,EAP225(EU) v3.0  Gateway/Switch：model+modelVersion,Osg v3.0"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"firmwareVersion":{"type":"string","description":"Version of firmware,for example:2.5.0 Build 20190118 Rel. 64821"},"version":{"type":"string","description":"Software version, such as \"2.5.0,\" extracted from DeviceDO.firmwareVersion - \"2.5.0 Build 20190118 Rel. 64821.\""},"hwVersion":{"type":"string","description":"Version of hardware,for example 1.0"},"specialModel":{"type":"string","description":"Special device model,for example:EAP225-Outdoor-1a20a950b8d950e8"},"ip":{"type":"string","description":"Ip address,such as 192.168.0.105"},"publicIp":{"type":"string","description":"Public ip address"},"ipv6List":{"type":"array","description":"Ipv6 address List","items":{"type":"string","description":"Ipv6 address List"}},"uptime":{"type":"string","description":"Device uptime"},"uptimeLong":{"type":"integer","description":"Runtime duration, in seconds (s).","format":"int64"},"statusCategory":{"type":"integer","description":"Category of device status,statusCategory should be a value as follows: 0:Disconnected;1:Connected;2:Pending;3:Heartbeat Missed;4:Isolated","format":"int32"},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected;1:Disconnected(Migrating);10:Provisioning;11:Configuring;12:Upgrading;13:Rebooting;14:Connected;15:Connected(Wireless);16:Connected(Migrating);17:Connected(Wireless,Migrating);20:Pending;21:Pending(Wireless);22:Adopting;23:Adopting(Wireless);24:Adopt Failed;25:Adopt Failed(Wireless);26:Managed By Others;27:Managed By Others(Wireless);30:Heartbeat Missed;31:Heartbeat Missed(Wireless);32:Heartbeat Missed(Migrating);33:Heartbeat Missed(Wireless,Migrating);40:Isolated;41:Isolated(Migrating);50:Slice Configuring","format":"int32"},"adoptFailType":{"type":"integer","description":"Adopt fail reason should be a value as follows: -1:adopt timeout;-2:user/password error","format":"int32"},"lastSeen":{"type":"integer","description":"Last active time.","format":"int64"},"needUpgrade":{"type":"boolean","description":"Whether the device needs upgrade"},"latestVersion":{"type":"string","description":"Latest firmware version"},"fwDownload":{"type":"boolean","description":"Whether the device is downloading firmware"},"cpuUtil":{"type":"integer","description":"Cpu utilization","format":"int32"},"memUtil":{"type":"integer","description":"Memory utilization","format":"int32"},"download":{"type":"integer","description":"Real-time total downstream traffic (bytes).","format":"int64"},"upload":{"type":"integer","description":"Real-time total upstream traffic (bytes).","format":"int64"},"site":{"type":"string","description":"\"Site of the device\""},"location":{"$ref":"#/components/schemas/LocationVO"},"clientNum":{"type":"integer","description":"Number of clients.","format":"int32"},"compatible":{"type":"integer","description":"Device firmware and controller compatibility type.Compatible should be a value as follows: 0:COMPATIBLE;1:HIGH_MAJOR_VER;2:LOW_MAJOR_VER;3:HIGH_MINOR_VER;4:LOW_MINOR_VER;7:HIGH_COMPONENT_VER;10:DEVICE_NOT_COMPATIBLE;11:HIGH_ADOPT_COMMPONENT;12:DEVICE_CATEGORY_NOT_COMPATIBLE;14:DEVICE_NOT_COMPATIBLE_IN_CLUSTER","format":"int32"},"locateEnable":{"type":"boolean","description":"Whether locate function is enabled"},"active":{"type":"boolean","description":"Mark whether the device is activated: When license (specific to cloud base) is false, the status column shows the pre-bound status. When it is true or null, the status column displays as it originally did."},"licenseStatus":{"type":"integer","description":"License status should be a value as follows:0: unActive 1: Unbind 2: Expired 3: active If there is a value and it is not 3, display the Active button. license (specific to cloud base).","format":"int32"},"dueTime":{"type":"integer","description":"Expire timestamp of license(cloud base exclusive)","format":"int64"},"dueTimeLeft":{"type":"integer","description":"Milliseconds from the current moment to the expiration time(cloud base exclusive)","format":"int64"},"licenseUnbindingLimit":{"type":"integer","description":"Remaining unbind count for license on detail Page of device(cloud base exclusive)","format":"int32"},"inWhitelist":{"type":"boolean","description":"Whether the device is in white list"},"sn":{"type":"string","description":"SN code of device"},"eost":{"type":"integer","description":"End of service time of device(CBC exclusive)","format":"int64"},"eos":{"type":"integer","description":"End of support time of device(CBC exclusive)","format":"int64"},"combinedGateway":{"type":"boolean","description":"Is it an combined gateway?"},"es":{"type":"boolean","description":"Whether it is Agile Series Switch"},"ippt":{"type":"boolean","description":"Whether it is LTE Backup"},"ipptPreconfig":{"type":"boolean"},"supportIppt":{"type":"boolean"},"supportAnomaly":{"type":"boolean","description":"Whether the device firmware support intelligent anomaly detection"},"healthScore":{"type":"integer","description":"1~3: poor; 4~7: fair; 0: no data; 8~10 good.","format":"int32"},"healthScoreTime":{"type":"integer","description":"The time of healthScore","format":"int64"},"tagName":{"type":"string","description":"Device tag name"},"addedInAdvanced":{"type":"boolean","description":"Whether the device is added in advanced."},"category":{"type":"string","description":"Category of license.When activating in bulk for the pro site, the front end can only select the same type for bulk activation."},"preConfigErrorCode":{"type":"integer","description":"When the pre-added devices cannot properly pass through, an error will be returned.","format":"int32"},"preConfigRetryType":{"type":"integer","description":"When retrying the path through, if there is a value, the front end will display a retry button. The types are: 1:Requires password input.2: No password input needed.","format":"int32"},"powerMode":{"type":"integer","description":"AP power mode.The power supply types are as follows: 0: DC power supply 1: 802.3bt power supply 2: 802.3at power supply 3: 802.3af power supply 4: Switch power supply (display restart)","format":"int32"},"powerModeList":{"type":"array","description":"Indicating the power supply modes for AP devices across frequency bands, with array indices corresponding to the frequency bands: 0: 2.4G 1: 5G/5G1 2: 5G2 3: 6G. The corresponding values for power supply modes are: 0: Normal operation 1: Power limited 2: Frequency band disabled","items":{"type":"integer","description":"Indicating the power supply modes for AP devices across frequency bands, with array indices corresponding to the frequency bands: 0: 2.4G 1: 5G/5G1 2: 5G2 3: 6G. The corresponding values for power supply modes are: 0: Normal operation 1: Power limited 2: Frequency band disabled","format":"int32"}},"featureLimit":{"$ref":"#/components/schemas/ApFeatureLimitVO"},"wirelessRouter":{"type":"boolean","description":"Indicates whether it is a wireless router; it is true only when this device is a wireless router."},"description":{"type":"string"},"onlineUpgradeStatus":{"type":"integer","description":"Device online upgrade status should be a value as follows: 0:IDLE,1:DOWNLOADING,2:UPGRADING","format":"int32"},"deviceSeriesType":{"type":"integer","description":"Device type should be a value as follows:0:advanced,1:pro","format":"int32"},"configSyncStatus":{"type":"integer","description":"Device configuration synchronization status , including: 0: noConfig (No configuration) 1: success (Success) 2: fail (Failure) 3: info (Information) 4: configuring (Configuring) 5: preConfig (Pre-configuration)","format":"int32"},"supportRunningConfig":{"type":"boolean","description":"Whether the device supports show running config."},"resource":{"type":"integer","description":"Data source.Resource should be a value as follows: 0:new created;1:from template;2:override","format":"int32"},"address":{"type":"string","description":"Address"},"uplinkDeviceMac":{"type":"string","description":"Uplink device mac","deprecated":true},"uplinkDeviceName":{"type":"string","description":"Uplink device mac name","deprecated":true},"uplinkDevicePort":{"type":"string","description":"Uplink device port","deprecated":true},"linkSpeed":{"type":"integer","description":"Link speed","format":"int32"},"duplex":{"type":"integer","description":"Duplex should be a value as follows:0:Auto,1:Half, 2:Full","format":"int32"},"switchConsistent":{"type":"boolean","description":"Whether the device can be adopted by the site."},"ecspFirstVersion":{"type":"integer","description":"Ecsp first version","format":"int32"},"packageCaptureStatus":{"type":"integer","format":"int32"},"replaceDeviceInfo":{"$ref":"#/components/schemas/DeviceReplaceSettingVO"},"incidents":{"type":"integer","description":"incident number","format":"int32"},"loopbackNum":{"type":"integer","description":"Number of loops","format":"int32"},"loop":{"type":"string","description":"Set of loop port"},"blockNum":{"type":"integer","description":"Block Num","format":"int32"},"block":{"type":"string","description":"Block information"},"poeTotalPower":{"type":"number","description":"PoE Total Power (W)","format":"double"},"poeRemain":{"type":"number","description":"PoE remaining power","format":"double"},"fanStatus":{"type":"integer","description":"FanStatus should be a value as follows: 0: normal; 1: fault; 2: no fan","format":"int32"},"poeSupport":{"type":"boolean","description":"Indicates whether the switch supports PoE"},"profiles":{"type":"object","additionalProperties":{"type":"string","description":"profiles"},"description":"profiles"},"stackSupportPorts":{"type":"array","description":"Stack support ports","items":{"$ref":"#/components/schemas/OswStandPortVO"}},"stackPortCap":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"maxStackGroups":{"type":"integer","description":"The maximum number of stacking port aggregation groups that can be configured","format":"int32"},"maxStackUnitNumber":{"type":"integer","description":"The maximum unit number supported by the device","format":"int32"},"supportStackGroupSpeed":{"type":"boolean","description":"Indicates whether the member device supports configuring the link speed of the stack port aggregation group"},"stackPortConfigCaps":{"type":"array","description":"Ports capability that support configuration as stack port","items":{"$ref":"#/components/schemas/OswStackPortCapVO"}},"defaultGroupSpeedCap":{"uniqueItems":true,"type":"array","description":"Stack port aggregation group default link speed capability","items":{"type":"integer","description":"Stack port aggregation group default link speed capability","format":"int32"}},"ports":{"type":"array","description":"Ports","items":{"$ref":"#/components/schemas/OswStackMemberPortVO"}},"stackPorts":{"type":"array","description":"Stack ports","items":{"$ref":"#/components/schemas/OswStackPortGroupVO"}},"unit":{"type":"integer","description":"Unit","format":"int32"},"priority":{"type":"integer","description":"Stack member priority","format":"int32"},"stackMsg":{"$ref":"#/components/schemas/StackMsgVO"},"mlagMsg":{"$ref":"#/components/schemas/MlagMsgVO"},"stkableGroupId":{"type":"integer","description":"The stack support list number where the switch is located, used to determine whether two devices can be stacked","format":"int32"},"stkVer":{"type":"string","description":"The stacking component version number used by the switch is used to determine whether two devices can be stacked"},"supportPowerAlert":{"type":"boolean","description":"Indicates whether the switch supports power alert"},"supportStp":{"type":"boolean","description":"Indicates whether the switch supports stp"},"supportExtendStp":{"type":"boolean","description":"Indicates whether the switch supports mstp"},"mstpInsNum":{"type":"integer","description":"The number of MSTP instances","format":"int32"},"mstpInsNo":{"type":"integer","description":"The range of MSTP instanceId","format":"int32"},"rpvstExtendSupport":{"type":"boolean","description":"Indicates whether the switch supports rpvst"},"mstpPortSupport":{"type":"boolean","description":"Indicates whether the switch supports MSTP Port"},"mstpGetActiveSupport":{"type":"boolean","description":"Indicates whether the switch supports MSTP Get Active"},"rpvstInsNum":{"type":"integer","description":"The number of RPVST instances","format":"int32"},"supportCableTest":{"type":"boolean","description":"Indicates whether the switch supports cable test"},"supportDomainPing":{"type":"boolean","description":"Indicates whether the switch supports pinging domain"},"supportDomainTraceRoute":{"type":"boolean","description":"Indicates whether the switch supports tracerouting domain"},"supportCustomDhcpOption":{"type":"boolean","description":"Whether the device supports custom dhcp option. Only valid when type is switch."},"supportMacDelay":{"type":"boolean"},"supportDhcpRange":{"type":"boolean","description":"Indicates whether the switch supports DHCP Range Pool"},"supportSdm":{"type":"boolean","description":"Indicates whether the switch supports SDM template"},"supportDhcpReservation":{"type":"boolean","description":"Indicates whether the switch supports DHCP Reservation"},"supportRelayMultiServer":{"type":"boolean","description":"Whether the device supports DHCP relay multi Server"},"supportTpclResInfo":{"type":"boolean","description":"Whether the device supports returning TPCL resource information"},"maxRelayServerNum":{"type":"integer","description":"Max DHCP relay server num","format":"int32"},"sdm":{"$ref":"#/components/schemas/OswSdmTemplateVO"},"locatingPorts":{"type":"array","description":"Locating switch ports, effective when parameter[locateEnable] is true and device is not a member of stack","items":{"type":"integer","description":"Locating switch ports, effective when parameter[locateEnable] is true and device is not a member of stack","format":"int32"}},"locatingStandardPorts":{"type":"array","description":"Locating switch standard ports, effective when parameter[locateEnable] is true and device is a member of stack","items":{"type":"string","description":"Locating switch standard ports, effective when parameter[locateEnable] is true and device is a member of stack"}},"supportGetOspfNeighborTable":{"type":"boolean"},"supportVrf":{"type":"boolean","description":"Indicates whether the switch supports Vrf"},"supportSnmp":{"type":"boolean","description":"Indicates whether the switch supports SNMP"},"supportJumbo":{"type":"boolean","description":"Indicates whether the switch supports Jumbo"},"lagCap":{"$ref":"#/components/schemas/LagCapVO"},"licenseStatusStr":{"type":"string"}},"description":"Detected Switches"},"OperationResponseOswStackSdmApplicationVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswStackSdmApplicationVO"}}},"OswStackMemberSdmVO":{"type":"object","properties":{"deviceMac":{"type":"string","description":"Mac of device."},"model":{"type":"string","description":"Device model."},"modelVersion":{"type":"string","description":"Device model Version."},"isStackMaster":{"type":"boolean","description":"Whether the device is the master unit in a stack."},"status":{"type":"integer","description":"Device status.","format":"int32"},"sdmResourceUsageList":{"type":"array","description":"The list contains usage details of SDM resources on the device, including used and available resources.","items":{"$ref":"#/components/schemas/SdmResourceUsage"}}},"description":"The sdm resources usage detail of stack members"},"OswStackSdmApplicationVO":{"type":"object","properties":{"curTmplName":{"type":"string","description":"Current used sdm template."},"tcamUtilization":{"type":"integer","description":"The overall TCAM utilization, calculated as usedTcam / totalTcam.","format":"int32"},"stackMemberSdmList":{"type":"array","description":"The sdm resources usage detail of stack members","items":{"$ref":"#/components/schemas/OswStackMemberSdmVO"}}}},"GridVOStackRoutingOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/StackRoutingOpenApiVO"}}}},"OperationResponseGridVOStackRoutingOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOStackRoutingOpenApiVO"}}},"StackRoutingOpenApiVO":{"type":"object","properties":{"stackId":{"type":"string","description":"Stack ID."},"name":{"type":"string","description":"Stack Name."},"distance":{"type":"integer","description":"Distance.","format":"int32"},"destinationIp":{"type":"string","description":"Destination IP."},"nextHops":{"type":"array","description":"Next IP list.","items":{"type":"string","description":"Next IP list."}},"nextHop":{"type":"string","description":"Next Ip."},"interfaceName":{"type":"array","description":"Interface Name","items":{"type":"string","description":"Interface Name"}},"destIpVrfName":{"type":"string","description":"Destination ip vrf name"},"nextHopVrfName":{"type":"string","description":"Next ip vrf name"},"nextHopsVrf":{"type":"array","description":"Next ip vrf","items":{"type":"string","description":"Next ip vrf"}},"metric":{"type":"integer","description":"Metric","format":"int32"},"type":{"type":"string","description":"Type"}}},"Single":{"type":"object"},"OperationResponseSupportSmsOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SupportSmsOpenApiVO"}}},"SupportSmsOpenApiVO":{"type":"object","properties":{"supportSms":{"type":"boolean","description":"Whether the using SIM card supports SMS."},"supportLte":{"type":"boolean","description":"Whether the device supports LTE."},"supportDualSms":{"type":"integer","description":"Whether two SIM cards support SMS. 0: SIM1 and SIM2 not support; 1: SIM1 supports, SIM2 not supports; 2: SIM1 not supports, SIM2 supports; 3: SIM1 and SIM2 support.","format":"int32"},"supportDualSim":{"type":"integer","description":"Whether the device supports Dual-SIM card.","format":"int32"}}},"GridVOMessage":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Message"}}}},"Message":{"type":"object","properties":{"id":{"type":"integer","description":"Item ID.","format":"int32"},"content":{"type":"string","description":"Message content."},"time":{"type":"integer","description":"Time.","format":"int64"}}},"OperationResponseGridVOMessage":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOMessage"}}},"GridVOOsgVpnTunnelOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OsgVpnTunnelOpenApiVO"}}}},"OperationResponseGridVOOsgVpnTunnelOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOsgVpnTunnelOpenApiVO"}}},"OperationResponseVpnTunnelGridVOVpnTunnelStatusVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VpnTunnelGridVOVpnTunnelStatusVO"}}},"VpnTunnelGridVOVpnTunnelStatusVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VpnTunnelStatusVO"}},"lockStatus":{"type":"boolean","description":"Lock status of the SSL VPN tunnel"},"lockType":{"type":"integer","description":"Lock type of the SSL VPN tunnel","format":"int32"}}},"VpnTunnelStatusVO":{"type":"object","properties":{"id":{"type":"string"},"vpnId":{"type":"string"},"spi":{"type":"integer","format":"int64"},"name":{"type":"string"},"direction":{"type":"string"},"localPeerIp":{"type":"string"},"remotePeerIp":{"type":"string"},"localIp":{"type":"string"},"remoteIp":{"type":"string"},"localSa":{"type":"string"},"remoteSa":{"type":"string"},"protocol":{"type":"string"},"ahAuthentication":{"type":"string"},"espAuthentication":{"type":"string"},"espEncryption":{"type":"string"},"userId":{"type":"integer","format":"int32"},"userName":{"type":"string"},"interfaceName":{"type":"string"},"serverType":{"type":"integer","format":"int32"},"vpnType":{"type":"integer","format":"int32"},"clientMode":{"type":"integer","format":"int32"},"downPkts":{"type":"integer","format":"int64"},"downBytes":{"type":"integer","format":"int64"},"upPkts":{"type":"integer","format":"int64"},"upBytes":{"type":"integer","format":"int64"},"uptime":{"type":"string"},"dns":{"type":"string"},"authType":{"type":"integer","format":"int32"},"loginTime":{"type":"integer","format":"int64"},"loginIp":{"type":"string"},"virtualIp":{"type":"string"},"ipPoolType":{"type":"integer","format":"int32"},"ipPoolStart":{"type":"string"},"ipPoolEnd":{"type":"string"},"ipPool":{"type":"string"},"port":{"type":"integer","format":"int32"},"servicePort":{"type":"integer","format":"int32"},"connectedNum":{"type":"integer","format":"int64"},"disconnectedNum":{"type":"integer","format":"int64"},"totalRemoteNum":{"type":"integer","format":"int64"},"status":{"type":"integer","format":"int32"}}},"GridVOVpnTunnelRemoteStatusVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VpnTunnelRemoteStatusVO"}}}},"OperationResponseGridVOVpnTunnelRemoteStatusVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOVpnTunnelRemoteStatusVO"}}},"VpnTunnelRemoteStatusVO":{"type":"object","properties":{"id":{"type":"string"},"vpnId":{"type":"string"},"name":{"type":"string"},"remoteIp":{"type":"string"},"localIp":{"type":"string"},"downPkts":{"type":"integer","format":"int64"},"downBytes":{"type":"integer","format":"int64"},"upPkts":{"type":"integer","format":"int64"},"upBytes":{"type":"integer","format":"int64"},"loginTime":{"type":"integer","format":"int64"},"port":{"type":"integer","format":"int32"},"status":{"type":"integer","format":"int32"}}},"GetVpnResponseGridVOVpnTunnelStatusVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VpnTunnelStatusVO"}},"supportWireguardStatus":{"type":"boolean","description":"Whether the current gateway supports reporting the WireGuard tunnel status, and amount number of connected and disconnected tunnels."}}},"OperationResponseGetVpnResponseGridVOVpnTunnelStatusVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GetVpnResponseGridVOVpnTunnelStatusVO"}}},"GetVpnResponseGridVOVpnTunnelRemoteStatusVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VpnTunnelRemoteStatusVO"}},"supportWireguardStatus":{"type":"boolean","description":"Whether the current gateway supports reporting the WireGuard tunnel status, and amount number of connected and disconnected tunnels."}}},"OperationResponseGetVpnResponseGridVOVpnTunnelRemoteStatusVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GetVpnResponseGridVOVpnTunnelRemoteStatusVO"}}},"GridVOOsgVpnIpSecOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OsgVpnIpSecOpenApiVO"}}}},"OperationResponseGridVOOsgVpnIpSecOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOsgVpnIpSecOpenApiVO"}}},"OsgVpnIpSecOpenApiVO":{"type":"object","properties":{"vpnId":{"type":"integer","description":"VPN Item Id.","format":"int32"},"spi":{"type":"integer","description":"Security Parameter Index of SA.","format":"int64"},"name":{"type":"string","description":"IPsec name."},"direction":{"type":"string","description":"SA direction, in/out."},"localPeerIp":{"type":"string","description":"IP address of the local peer."},"remotePeerIp":{"type":"string","description":"IP address of the remote peer."},"localSa":{"type":"string","description":"Local network segment of SA cover."},"remoteSa":{"type":"string","description":"Remote network segment of SA cover."},"protocol":{"type":"string","description":"SA Authentication protocol and Encryption protocol."},"ahAuthentication":{"type":"string","description":"AH Authentication Algorithm."},"espAuthentication":{"type":"string","description":"ESP Authentication Algorithm."},"espEncryption":{"type":"string","description":"ESP Encryption Algorithm."}}},"GridVOVpnTunnelStatusVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VpnTunnelStatusVO"}}}},"OperationResponseGridVOVpnTunnelStatusVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOVpnTunnelStatusVO"}}},"GridVOVoipDevice":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VoipDevice"}}}},"OperationResponseGridVOVoipDevice":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOVoipDevice"}}},"TelephoneNumberAdvancedSettingOpenApiVO":{"type":"object","description":"The telephone number advanced setting of voip device."},"VoipDevice":{"required":["addedInAdvanced","wirelessLinked"],"type":"object","properties":{"id":{"type":"string","description":"The ID of voip device."},"mac":{"type":"string","description":"The mac of voip device."},"name":{"type":"string","description":"The name of voip device."},"model":{"type":"string","description":"The model of voip device."},"modelVersion":{"type":"string","description":"The model version of voip device."},"type":{"type":"string","description":"The type of voip device."},"ip":{"type":"string","description":"The IP of voip device."},"statusCategory":{"type":"integer","description":"The status category of voip device.","format":"int32"},"status":{"type":"integer","description":"The status of voip device.","format":"int32"},"addedInAdvanced":{"type":"boolean","description":"Whether the device is added in advanced."},"wirelessLinked":{"type":"boolean","description":"Whether to enable wireless linked."},"voipDeviceApConfiguration":{"$ref":"#/components/schemas/VoipDeviceApConfigurationOpenApiVO"},"voipDeviceOsgConfiguration":{"$ref":"#/components/schemas/VoipDeviceOsgConfigurationOpenApiVO"},"telephoneNumberAdvancedSetting":{"$ref":"#/components/schemas/TelephoneNumberAdvancedSettingOpenApiVO"},"voipVlanIp":{"type":"string","description":"IP address of VoIP VLAN."}}},"NumberRegistrationResult":{"type":"object","properties":{"registrationResultList":{"type":"array","description":"The list of registration result.","items":{"$ref":"#/components/schemas/TelephoneNumberWithStatusVO"}}}},"OperationResponseNumberRegistrationResult":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/NumberRegistrationResult"}}},"TelephoneNumberWithStatusVO":{"type":"object","properties":{"phoneNumberId":{"type":"string"},"profileId":{"type":"string"},"profileName":{"type":"string"},"prefix":{"type":"string"},"number":{"type":"string"},"status":{"type":"integer","format":"int32"},"port":{"type":"integer","format":"int32"},"deviceMac":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"featureDescription":{"type":"array","items":{"$ref":"#/components/schemas/FeatureInfoVO"}}},"description":"The list of registration result."},"OperationResponseTelephoneNumberWithStatusGridVOTelephoneNumberWithStatusOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/TelephoneNumberWithStatusGridVOTelephoneNumberWithStatusOpenApiVO"}}},"TelephoneNumberWithStatusGridVOTelephoneNumberWithStatusOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TelephoneNumberWithStatusOpenApiVO"}},"voipPhoneNumberPasswordLimit":{"type":"integer","format":"int32"}}},"TelephoneNumberWithStatusOpenApiVO":{"type":"object","properties":{"phoneNumberId":{"type":"string","description":"The phoneNumber ID of telephone number."},"profileId":{"type":"string","description":"The profile ID of telephone number."},"profileName":{"type":"string","description":"The profile name of telephone number."},"prefix":{"type":"string","description":"The prefix of telephone number."},"number":{"type":"string","description":"The telephone number."},"status":{"type":"integer","description":"The status of telephone number.","format":"int32"},"deviceMac":{"type":"string","description":"Device MAC."},"username":{"type":"string","description":"Username."},"password":{"type":"string","description":"Password."}}},"GridVOSimplifiedVoipDeviceOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SimplifiedVoipDeviceOpenApiVO"}}}},"OperationResponseGridVOSimplifiedVoipDeviceOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOSimplifiedVoipDeviceOpenApiVO"}}},"SimplifiedVoipDeviceOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Device ID."},"mac":{"type":"string","description":"Device MAC."},"name":{"type":"string","description":"Device name."},"model":{"type":"string","description":"Device model."},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0."},"type":{"type":"string","description":"Device type: AP or gateway."},"addedInAdvanced":{"type":"boolean","description":"Whether the device is added in advanced."}}},"DeviceTelephoneNumber":{"type":"object","properties":{"id":{"type":"string","description":"The ID of voip device."},"mac":{"type":"string","description":"The mac of voip device."},"bindNumberList":{"type":"array","description":"The list of telephone number.","items":{"$ref":"#/components/schemas/TelephoneNumberWithStatusOpenApiVO"}}}},"GridVODeviceTelephoneNumber":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceTelephoneNumber"}}}},"OperationResponseGridVODeviceTelephoneNumber":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVODeviceTelephoneNumber"}}},"OperationResponseListSimplifiedDigitMapProfile":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/SimplifiedDigitMapProfile"}}}},"SimplifiedDigitMapProfile":{"type":"object","properties":{"digitMapProfileId":{"type":"string","description":"Digit map profile ID."},"digitMapProfileName":{"type":"string","description":"Digit map profile name."}}},"OperationResponseListSimplifiedCallBlockingProfile":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/SimplifiedCallBlockingProfile"}}}},"SimplifiedCallBlockingProfile":{"type":"object","properties":{"callBlockingProfileId":{"type":"string","description":"Call blocking profile id."},"callBlockingProfileName":{"type":"string","description":"Call blocking profile name."}}},"OperationResponseVoiceMailSettingResponse":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VoiceMailSettingResponse"}}},"UsbInfo":{"type":"object","properties":{"usbUuid":{"type":"string","description":"USB UUID."},"usbName":{"type":"string","description":"USB name."},"voiceMailboxCapacity":{"type":"integer","description":"The capacity of voice mail box.","format":"int32"},"remainAvailableCapacity":{"type":"integer","description":"Remain available capacity of voice mail box.","format":"int32"},"selected":{"type":"boolean","description":"Whether selected the USB device."},"customGreetingName":{"type":"string","description":"Custom greeting name."}},"description":"USB info list."},"VoiceMailSettingResponse":{"type":"object","properties":{"omadacId":{"type":"string","description":"Omadac ID."},"siteId":{"type":"string","description":"Site ID."},"noAnswerTime":{"type":"integer","description":"The no answer time of telephone number.","format":"int32"},"remoteAccessPin":{"type":"string","description":"Remote access pin."},"voiceMailInUsb":{"type":"boolean","description":"Whether voice mail is in USB."},"greetingForVoiceMailMode":{"type":"integer","description":"Parameter [greetingForVoiceMailMode] will be 0 or 1. 0: Default, 1: Custom.","format":"int32"},"defaultGreetingName":{"type":"string","description":"Greeting name."},"usbList":{"type":"array","description":"USB info list.","items":{"$ref":"#/components/schemas/UsbInfo"}},"enable":{"type":"boolean","description":"Whether voice mail is enable."},"remoteAccessEnable":{"type":"boolean","description":"Whether voice mail allows remote access."},"duration":{"type":"integer","description":"Voice mail duration.","format":"int32"}}},"OperationResponseUsbInfoListResponse":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/UsbInfoListResponse"}}},"UsbInfoListResponse":{"type":"object","properties":{"usbList":{"type":"array","description":"USB info list.","items":{"$ref":"#/components/schemas/UsbInfo"}}}},"GridVOVoiceMail":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VoiceMail"}}}},"OperationResponseGridVOVoiceMail":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOVoiceMail"}}},"VoiceMail":{"type":"object","properties":{"id":{"type":"string","description":"Voice mail ID."},"date":{"type":"integer","description":"The date or time of voice mail.","format":"int64"},"incomingNumber":{"type":"string","description":"The incoming number of voice mail."},"telephoneNumber":{"type":"string","description":"The telephone number of voice mail."},"duration":{"type":"integer","description":"The duration of voice mail.","format":"int32"},"read":{"type":"boolean","description":"Whether the voice mail has been read, false-not read, true-read"}}},"OperationResponseMldOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/MldOpenApiVO"}}},"GridVOMdnsRuleOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/MdnsRuleOpenApiVO"}}}},"MdnsRuleOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"MDNS rule ID"},"name":{"type":"string","description":"MDNS rule name"},"status":{"type":"boolean","description":"MDNS rule enable status"},"profileIds":{"type":"array","description":"ID list of selected Bonjour Service Profile","items":{"type":"string","description":"ID list of selected Bonjour Service Profile"}},"type":{"type":"integer","description":"MDNS rule band VLAN type. Type should be a value as follows: 0: By VLAN ID, 1: By Network","format":"int32"},"ap":{"$ref":"#/components/schemas/ApMdnsRuleOpenApiVO"},"osg":{"$ref":"#/components/schemas/OsgMdnsRuleOpenApiVO"}}},"OperationResponseGridVOMdnsRuleOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOMdnsRuleOpenApiVO"}}},"MdnsExceptionInfoVO":{"type":"object","properties":{"mdnsEffect":{"type":"boolean","description":"Indicates whether the mDNS rules are in effect."},"gatewayMac":{"type":"string","description":"Gateway Mac."}}},"OperationResponseMdnsExceptionInfoVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/MdnsExceptionInfoVO"}}},"OperationResponseIgmpOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/IgmpOpenApiVO"}}},"DhcpReservationOpenApiGridVODhcpReservationOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DhcpReservationOpenApiVO"}},"supportOptions":{"type":"array","description":"Options supported by DHCP Reservation.","items":{"type":"integer","description":"Options supported by DHCP Reservation.","format":"int32"}},"netNameToIdMap":{"type":"object","additionalProperties":{"type":"string","description":"Mapping between lan network name and lan network ID"},"description":"Mapping between lan network name and lan network ID"}}},"DhcpReservationOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"DHCP reservation ID"},"description":{"type":"string","description":"Description of DHCP reservation"},"netId":{"type":"string","description":"ID of the configured LAN Network"},"netName":{"type":"string","description":"Name of the configured LAN Network"},"mac":{"type":"string","description":"Device MAC address"},"ip":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Reserved IP address"},"options":{"type":"array","description":"Advanced DHCP options","items":{"$ref":"#/components/schemas/custom DHCP Options"}},"status":{"type":"boolean","description":"DHCP reservation enable status"},"exportToIpMacBinding":{"type":"boolean","description":"Indicates whether DHCP reservation can be exported to the IP-MAC Binding list"},"clientName":{"type":"string","description":"Client name","deprecated":true},"name":{"type":"string","description":"Device Name"},"existOptions":{"type":"array","description":"Options configured in the current DHCP Reservation entry.","items":{"type":"integer","description":"Options configured in the current DHCP Reservation entry.","format":"int32"}},"type":{"type":"integer","description":"Type should be a value as follows: 0: Device; 1: Client","format":"int32"},"showingType":{"type":"string","description":"Client Type or Device Type"},"model":{"type":"string","description":"Device Model"},"modelVersion":{"type":"string","description":"Device Model Version"},"serverName":{"type":"string","description":"Dhcp Server Device Name"},"serverType":{"type":"string","description":"Dhcp Server Device Type"},"serverMac":{"type":"string","description":"Dhcp Server Device Mac"},"serverStackId":{"type":"string","description":"Dhcp Server Stack ID"},"abnormal":{"type":"integer","description":"Abnormal cause","format":"int32"},"featureDescription":{"type":"array","description":"Gateway Feature Description.","items":{"$ref":"#/components/schemas/FeatureInfoVO"}}}},"OperationResponseDhcpReservationOpenApiGridVODhcpReservationOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DhcpReservationOpenApiGridVODhcpReservationOpenApiVO"}}},"LanDnsGridVOLanDnsQueryOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/LanDnsQueryOpenApiVO"}},"supportTtl":{"type":"boolean","description":"Whether the current gateway support custom TTL config."}}},"LanDnsQueryOpenApiVO":{"required":["domain","enable","name","type"],"type":"object","properties":{"id":{"type":"string","description":"The ID of current Lan Dns entry."},"enable":{"type":"boolean","description":"off:false, on: true"},"name":{"maxLength":128,"minLength":1,"type":"string","description":"Name of Lan Dns Item"},"domain":{"pattern":"(?=^.{1,128}$)[a-zA-Z0-9][-a-zA-Z0-9]{0,62}(\\.[a-zA-Z0-9][-a-zA-Z0-9]{0,62})+","type":"string","description":"Enter the domain name."},"aliases":{"maxItems":7,"minItems":0,"type":"array","description":"Name of Lan Dns Item","items":{"maxLength":7,"minLength":0,"type":"string","description":"Name of Lan Dns Item"}},"type":{"type":"integer","description":"There are three options, IP:0, CNAME:1, and FORWARD:2.","format":"int32"},"ipAddresses":{"maxItems":32,"minItems":0,"type":"array","description":"When the Type is IP, it is the IPv4 address of the returned DNS response.","items":{"maxLength":32,"minLength":0,"type":"string","description":"When the Type is IP, it is the IPv4 address of the returned DNS response."}},"ipv6Addresses":{"maxItems":32,"minItems":0,"type":"array","description":"When the Type is IP, it is the IPv6 address of the returned DNS response.","items":{"maxLength":32,"minLength":0,"type":"string","description":"When the Type is IP, it is the IPv6 address of the returned DNS response."}},"cname":{"pattern":"(?=^.{1,128}$)[a-zA-Z0-9][-a-zA-Z0-9]{0,62}(\\.[a-zA-Z0-9][-a-zA-Z0-9]{0,62})+","type":"string","description":"When Type is CNAME, set the domain name to which Domain Name and Alias Domain Name need to be mapped."},"dnsServers":{"maxItems":2,"minItems":0,"type":"array","description":"When the Type is FORWARD, set the Domain Name and Alias Domain Name to be forwarded to a specific DNS Server, up to two DNS Servers can be configured.","items":{"maxLength":2,"minLength":0,"type":"string","description":"When the Type is FORWARD, set the Domain Name and Alias Domain Name to be forwarded to a specific DNS Server, up to two DNS Servers can be configured."}},"lanNetworkIds":{"type":"array","description":"The ids of Lan Network.","items":{"type":"string","description":"The ids of Lan Network."}},"customTtl":{"type":"boolean","description":"When custom TTL is activated, TTL will take effect as custom. Otherwise, TTL will take effect as default(3600)."},"ttl":{"type":"integer","description":"The amount of time DNS information is allowed to be cached before it expires and needs to be refreshed. It is recommended to use the default TTL (3600) for each record. The range of TTL is between 1 and 86400.","format":"int32"},"featureDescription":{"type":"array","description":"Gateway Feature Description.","items":{"$ref":"#/components/schemas/FeatureInfoVO"}}}},"OperationResponseLanDnsGridVOLanDnsQueryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/LanDnsGridVOLanDnsQueryOpenApiVO"}}},"GridVOIotDeviceRadioInfoOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/IotDeviceRadioInfoOpenApiVO"}}}},"IotDeviceRadioInfoOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device mac"},"name":{"type":"string","description":"Device name,default value is the mac address of device"},"type":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected;1:Disconnected(Migrating);10:Provisioning;11:Configuring;12:Upgrading;13:Rebooting;14:Connected;15:Connected(Wireless);16:Connected(Migrating);17:Connected(Wireless,Migrating);20:Pending;21:Pending(Wireless);22:Adopting;23:Adopting(Wireless);24:Adopt Failed;25:Adopt Failed(Wireless);26:Managed By Others;27:Managed By Others(Wireless);30:Heartbeat Missed;31:Heartbeat Missed(Wireless);32:Heartbeat Missed(Migrating);33:Heartbeat Missed(Wireless,Migrating);40:Isolated;41:Isolated(Migrating);50:Slice Configuring","format":"int32"},"statusCategory":{"type":"integer","description":"Category of device status,statusCategory should be a value as follows: 0:Disconnected;1:Connected;2:Pending;3:Heartbeat Missed;4:Isolated","format":"int32"},"ip":{"type":"string","description":"Device IP"},"override":{"type":"boolean","description":"Whether to override the configuration."},"transmitPower":{"type":"integer","description":"Broadcast transmission power.<br />The parameter [transmitPower] should be a value as follows:[-20, -18, -15, -12, -10, -9, -6, -5, -3, 0, 1, 2, 3, 4, 5, 14, 15, 16, 17, 18, 19, 20].(0 by default)","format":"int32"}}},"GridVOApBtDetailOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApBtDetailOpenApiVO"}}}},"DnsCacheQueryOpenApiV2VO":{"type":"object","properties":{"currentPage":{"type":"integer","description":"Start page number. Start from 1. This subsection is deprecated.","format":"int32"},"currentPageSize":{"type":"integer","description":"Number of entries per page. It should be within the range of 1–100. This subsection is deprecated.","format":"int32"},"type":{"type":"integer","description":"Type of DNS follows: 0: IPV4; 1: IPV6. This subsection is deprecated.","format":"int32"}}},"DisasterModeOpenApiVO":{"type":"object","properties":{"status":{"type":"integer","description":"Format should be a value as follows: 0: not support; 1: disaster mode enable; 2: disaster mode disable","format":"int32"}}},"OperationResponseDisasterModeOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DisasterModeOpenApiVO"}}},"GridVORrmIncompatibleApOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RrmIncompatibleApOpenApiVO"}}}},"OperationResponseGridVORrmIncompatibleApOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVORrmIncompatibleApOpenApiVO"}}},"RrmIncompatibleApOpenApiVO":{"type":"object","properties":{"name":{"type":"string","description":"Device name."},"mac":{"type":"string","description":"Device MAC."},"statusCategory":{"type":"integer","description":"Status category. 0 : Disconnected. 1: Connected. 2: Pending. 3: Heartbeat Missed. 4: Isolated.","format":"int32"},"status":{"type":"integer","description":"Detailed status.","format":"int32"},"version":{"type":"string","description":"Simplified version of firmware,for example:2.5.0"},"type":{"type":"string","description":"Device type."},"model":{"type":"string","description":"Device model."},"modelVersion":{"type":"string","description":"Model version."},"showModel":{"type":"string","description":"The model name of device."}}},"OperationResponseStaticRoutingOpenApiGridVOStaticRoutingInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/StaticRoutingOpenApiGridVOStaticRoutingInfo"}}},"StaticRoutingInfo":{"required":["destinations","metric","name","routeType","status"],"type":"object","properties":{"id":{"type":"string","description":"ID"},"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name, name should contain 1 to 64 characters."},"status":{"type":"boolean","description":"Status"},"destinations":{"type":"array","description":"IP address/SubNet, up to 16 entries are allowed for the destinations list.","items":{"type":"string","description":"IP address/SubNet, up to 16 entries are allowed for the destinations list."}},"routeType":{"type":"integer","description":"RouteType should be a value as follows: 0: NextHop; 1: Interface","format":"int32"},"nextHopIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Only for routeType:0 or routeType:1 and selected WAN is Static IP/Dynamic IP/MAP-E mode"},"interfaceType":{"type":"integer","description":"Only for routeType:1, interfaceType should be a value as follows: 0: Internet(WAN); 1: Network(LAN); 2: L2TP, 3: PPTP, 5: Virtual WAN.","format":"int32"},"interfaceId":{"type":"string","description":"Interface ID, for example: if interfaceType is network, interfaceId should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."},"metric":{"type":"integer","description":"Metric should be within the range of 0–15.","format":"int32"},"existVpnClient":{"type":"boolean","description":"Whether the interface option exists VPN client"},"existVirtualWan":{"type":"boolean","description":"Whether the interface option exists virtual WAN"},"featureDescription":{"type":"array","description":"Gateway Feature Description.","items":{"$ref":"#/components/schemas/FeatureInfoVO"}}}},"StaticRoutingOpenApiGridVOStaticRoutingInfo":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/StaticRoutingInfo"}},"supportVirtualWan":{"type":"boolean","description":"Whether Virtual Wan is supported in Static Route."},"supportVpnClient":{"type":"boolean","description":"Whether VPN Client is supported in Static Route."},"supportByDsLiteAndMapE":{"type":"boolean","description":"Whether this feature is supported for the DS-Lite or Map-E WAN connection types."}}},"OperationResponseStaticRoutingInterfaceResult":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/StaticRoutingInterfaceResult"}}},"StaticRoutingInterfaceInfo":{"type":"object","properties":{"interfaceType":{"type":"integer","description":"Enter a value as follows: 0: WAN; 1: LAN; 2: L2TP, 3: PPTP, 5: Virtual WAN","format":"int32"},"name":{"type":"string","description":"Interface name."},"id":{"type":"string","description":"Interface ID."},"needNextHop":{"type":"boolean","description":"Parameter [needNextHop] will be true when [interfaceType] is WAN or virtual WAN, and proto is DHCP or static."}},"description":"Interface information list."},"StaticRoutingInterfaceResult":{"type":"object","properties":{"interfaceInfoList":{"type":"array","description":"Interface information list.","items":{"$ref":"#/components/schemas/StaticRoutingInterfaceInfo"}},"hasWanEnable":{"type":"boolean","description":"Internet has enable WAN port(s)."}}},"RF Planning Deploy Result":{"type":"object","properties":{"firstDeploy":{"type":"boolean","description":"Parameter [firstDeploy] means whether WLAN Optimization has been successfully performed before. True: no. False: yes."}}},"ExcludeApVO":{"type":"object","properties":{"unsupportType":{"type":"integer","description":"0: Not support mesh(cannot be excluded). 1: Not support channel deployment. 2: Not support power deployment.","format":"int32"},"name":{"type":"string","description":"Device name."},"ip":{"type":"string","description":"IP adress."},"mac":{"type":"string","description":"Device MAC."},"statusCategory":{"type":"integer","description":"Status category. 0 : Disconnected. 1: Connected. 2: Pending. 3: Heartbeat Missed. 4: Isolated.","format":"int32"},"status":{"type":"integer","description":"Detailed status. ","format":"int32"},"model":{"type":"string","description":"Device model."},"modelVersion":{"type":"string","description":"Model version."},"showModel":{"type":"string","description":"The model name of device."},"type":{"type":"string","description":"Device type."},"addedInAdvanced":{"type":"boolean","description":"Whether the device is added in advanced."}},"description":"Info of Excluded APs."},"OperationResponseRF Planning Config":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/RF Planning Config"}}},"RF Planning Config":{"type":"object","properties":{"channelDeployEnable":{"type":"boolean","description":"Whether to enable channel deployment."},"channelWidthDeployEnable":{"type":"boolean","description":"Whether to enable channel width deployment."},"bandDeployEnable":{"type":"boolean","description":"Whether to enable band deployment."},"powerAdjustEnable":{"type":"boolean","description":"Whether to enable power adjustment."},"excludeAps":{"type":"array","description":"Info of Excluded APs.","items":{"$ref":"#/components/schemas/ExcludeApVO"}},"advancedSetting":{"$ref":"#/components/schemas/PlanningAdvancedSettingVO"},"mode":{"type":"integer","description":"0: by WLAN Optimization schedule. 1: by one-click WLAN Optimization.","format":"int32"},"resource":{"type":"integer","description":"Site setting resource. 0: New created. 1: From template. 2: Override.","format":"int32"}}},"OperationResponseRF Planning Result":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/RF Planning Result"}}},"RF Planning Result":{"required":["status"],"type":"object","properties":{"planningHistroyId":{"type":"string","description":"Planning histroy ID."},"beforeIndex":{"type":"integer","description":"Index before WLAN Optimization, between 0 and 100.","format":"int32"},"afterIndex":{"type":"integer","description":"Index after WLAN Optimization, between 0 and 100.","format":"int32"},"status":{"type":"integer","description":"0: Not in scanning status and a WLAN Optimization has been just successfully executed. 1: Not in scanning status and there's no WLAN Optimization result. 2: In RF planning status. 3: In RF planning canceling status.","format":"int32"},"failType":{"type":"integer","description":"Type of failure. 0: Failure before deployment. 1: Failure after deployment.","format":"int32"}}},"OperationResponsePlanningHistoryListVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PlanningHistoryListVO"}}},"PlanningHistoryListVO":{"type":"object","properties":{"historyList":{"type":"array","items":{"type":"object"}}}},"OperationResponseListExcludeApVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ExcludeApVO"}}}},"ApDensityCurrentDetailOpenApiVO":{"type":"object","properties":{"currentApDensityHighInfo":{"type":"array","description":"The current detail of high ap density metrics displayed on the WIFI Dashboard page.","items":{"$ref":"#/components/schemas/ApDensityInfoOpenApiVO"}},"currentApDensityMediumInfo":{"type":"array","description":"The current detail of medium ap density metrics displayed on the WIFI Dashboard page.","items":{"$ref":"#/components/schemas/ApDensityInfoOpenApiVO"}},"currentApDensityLowInfo":{"type":"array","description":"The current detail of low ap density metrics displayed on the WIFI Dashboard page.","items":{"$ref":"#/components/schemas/ApDensityInfoOpenApiVO"}},"noDataList":{"type":"array","description":"The current detail of no ap density metrics displayed on the WIFI Dashboard page.","items":{"$ref":"#/components/schemas/BaseApInfoOpenApiVO"}}},"description":"The current detail of ap density displayed on the WIFI Dashboard page."},"ApDensityInfoOpenApiVO":{"type":"object","properties":{"name":{"type":"string","description":"The name of ap."},"mac":{"type":"string","description":"The mac of ap."},"model":{"type":"string","description":"The model of ap."},"modelVersion":{"type":"string","description":"The modelVersion of ap."},"type":{"type":"string","description":"The type of ap."},"noData":{"type":"boolean","description":"This flag indicates whether data exists."},"noDataReason":{"type":"integer","description":"The no data reason of ap.","format":"int32"},"neighborApNum":{"type":"integer","description":"The neighbor ap number of ap.","format":"int32"},"neighborApPercent":{"type":"integer","description":"The neighbor ap percent","format":"int32"}},"description":"The current detail of low ap density metrics displayed on the WIFI Dashboard page."},"ApDensityItemOpenApiVO":{"type":"object","properties":{"time":{"type":"integer","description":"Time(unit:ms)","format":"int64"},"denseApNum":{"type":"integer","description":"The number of dense Ap.","format":"int32"},"denseApPercent":{"type":"integer","description":"The percent of dense Ap.","format":"int32"},"moderateApNum":{"type":"integer","description":"The number of moderate Ap.","format":"int32"},"moderateApPercent":{"type":"integer","description":"The percent of moderate Ap.","format":"int32"},"sparseApNum":{"type":"integer","description":"The number of sparse Ap.","format":"int32"},"sparseApPercent":{"type":"integer","description":"The percent of sparse Ap.","format":"int32"}},"description":"The trend of ap density metrics displayed on the WIFI Dashboard page."},"ApDensityTrendDetailOpenApiVO":{"type":"object","properties":{"apDensityItemList":{"type":"array","description":"The trend of ap density metrics displayed on the WIFI Dashboard page.","items":{"$ref":"#/components/schemas/ApDensityItemOpenApiVO"}}},"description":"The trend of ap density displayed on the WIFI Dashboard page."},"ApDetailCciInfoOpenApiOpenApiVO":{"type":"object","properties":{"name":{"type":"string","description":"The name of ap."},"mac":{"type":"string","description":"The mac of ap."},"model":{"type":"string","description":"The model of ap."},"modelVersion":{"type":"string","description":"The modelVersion of ap."},"type":{"type":"string","description":"The type of ap."},"noData":{"type":"boolean","description":"This flag indicates whether data exists."},"noDataReason":{"type":"integer","description":"The no data reason of ap.","format":"int32"},"channel":{"type":"integer","description":"The channel of ap.","format":"int32"},"channel5g2":{"type":"integer","description":"The channel of 5g2 radio of ap.","format":"int32"},"totalLevel":{"type":"integer","description":"The total CCI level of ap.","format":"int32"},"totalLevelPercent":{"type":"integer","description":"The total CCI level percent of ap.","format":"int32"},"inSiteLevel":{"type":"integer","description":"The inSite CCI level of ap.","format":"int32"},"inSiteLevelPercent":{"type":"integer","description":"The inSite CCI level percent of ap.","format":"int32"},"outSiteLevel":{"type":"integer","description":"The outSite CCI level of ap.","format":"int32"},"outSiteLevelPercent":{"type":"integer","description":"The outSite CCI level percent of ap.","format":"int32"}},"description":"The current detail of low CCI metrics displayed on the WIFI Dashboard page."},"BaseApInfoOpenApiVO":{"type":"object","properties":{"name":{"type":"string","description":"The name of ap."},"mac":{"type":"string","description":"The mac of ap."},"model":{"type":"string","description":"The model of ap."},"modelVersion":{"type":"string","description":"The modelVersion of ap."},"type":{"type":"string","description":"The type of ap."},"noData":{"type":"boolean","description":"This flag indicates whether data exists."},"noDataReason":{"type":"integer","description":"The no data reason of ap.","format":"int32"}},"description":"The current detail of no ap density metrics displayed on the WIFI Dashboard page."},"CciCurrentDetailOpenApiVO":{"type":"object","properties":{"currentHighCciInfoList":{"type":"array","description":"The current detail of high CCI metrics displayed on the WIFI Dashboard page.","items":{"$ref":"#/components/schemas/ApDetailCciInfoOpenApiOpenApiVO"}},"currentMediumCciInfoList":{"type":"array","description":"The current detail of medium CCI metrics displayed on the WIFI Dashboard page.","items":{"$ref":"#/components/schemas/ApDetailCciInfoOpenApiOpenApiVO"}},"currentLowCciInfoList":{"type":"array","description":"The current detail of low CCI metrics displayed on the WIFI Dashboard page.","items":{"$ref":"#/components/schemas/ApDetailCciInfoOpenApiOpenApiVO"}},"noDataList":{"type":"array","description":"The current detail of no CCI metrics displayed on the WIFI Dashboard page.","items":{"$ref":"#/components/schemas/BaseApInfoOpenApiVO"}}},"description":"The current detail of CCI metrics displayed on the WIFI Dashboard page."},"CciTrendDetailOpenApiVO":{"type":"object","properties":{"cciTrendItemList":{"type":"array","description":"The trend of CCI metrics displayed on the WIFI Dashboard page.","items":{"$ref":"#/components/schemas/CciTrendItemOpenApiOpenApiVO"}}},"description":"The trend of CCI metrics displayed on the WIFI Dashboard page."},"CciTrendItemOpenApiOpenApiVO":{"type":"object","properties":{"time":{"type":"integer","description":"Time(unit:ms)","format":"int64"},"strongInterferenceApNum":{"type":"integer","description":"The number of strong Interference Ap.","format":"int32"},"strongInterferenceApPercent":{"type":"integer","description":"The percent of strong Interference Ap.","format":"int32"},"moderateInterferenceApNum":{"type":"integer","description":"The number of moderate Interference Ap.","format":"int32"},"moderateInterferenceApPercent":{"type":"integer","description":"The percent of moderate Interference Ap.","format":"int32"},"weakInterferenceApNum":{"type":"integer","description":"The number of weak Interference Ap.","format":"int32"},"weakInterferenceApPercent":{"type":"integer","description":"The percent of weak Interference Ap.","format":"int32"}},"description":"The trend of CCI metrics displayed on the WIFI Dashboard page."},"OperationResponseWlanOptDashBoardOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/WlanOptDashBoardOpenApiVO"}}},"WlanOptDashBoardDetailOpenApiVO":{"type":"object","properties":{"cciTrendDetail":{"$ref":"#/components/schemas/CciTrendDetailOpenApiVO"},"cciCurrentDetail":{"$ref":"#/components/schemas/CciCurrentDetailOpenApiVO"},"apDensityTrendDetail":{"$ref":"#/components/schemas/ApDensityTrendDetailOpenApiVO"},"apDensityCurrentDetail":{"$ref":"#/components/schemas/ApDensityCurrentDetailOpenApiVO"}},"description":"The RRM 6G radio metrics displayed on the WIFI Dashboard page."},"WlanOptDashBoardOpenApiVO":{"type":"object","properties":{"wlanOptDashBoardDetail2g":{"$ref":"#/components/schemas/WlanOptDashBoardDetailOpenApiVO"},"wlanOptDashBoardDetail5g":{"$ref":"#/components/schemas/WlanOptDashBoardDetailOpenApiVO"},"wlanOptDashBoardDetail6g":{"$ref":"#/components/schemas/WlanOptDashBoardDetailOpenApiVO"}}},"OperationResponseListReportTab":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ReportTab"}}}},"OperationResponseMapStringObject":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"object","additionalProperties":{"type":"object"}}}},"NatTraversalTunnelGridVONatTraversalTunnelVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/NatTraversalTunnelVO"}},"supportSshTelnetTunnel":{"type":"boolean","description":"Whether to support SSH/Telnet tunnel"}}},"NatTraversalTunnelVO":{"required":["localPort"],"type":"object","properties":{"id":{"type":"string","description":"ID of the remote access tunnel."},"tunnelId":{"type":"integer","description":"Tunnel ID of the remote access tunnel.","format":"int32"},"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name of the remote access tunnel."},"localAddress":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"IP address of the local target device."},"localPort":{"type":"integer","description":"Port of the local target device's service.","format":"int32"},"localMac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"Mac of the local target device."},"jumpMac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"Mac of the jumper device."},"duration":{"type":"integer","description":"Valid duration time of the remote access tunnel, 1-24 hours.","format":"int32"},"type":{"type":"string","description":"Type of the remote access tunnel."},"closureTime":{"type":"integer","description":"Closure time of the remote access tunnel.","format":"int64"},"customTunnel":{"type":"boolean","description":"If the remote access tunnel is a custom tunnel."},"autoLogin":{"type":"boolean","description":"If the remote access tunnel enabled auto login."},"appType":{"type":"integer","description":"App type of the remote access tunnel for the local target device. 21:HTTP, 22:HTTPS, 31:SSH, 32:TELNET.","format":"int32"},"status":{"type":"integer","description":"Status of the remote access tunnel. 0: Disconnected, 1: Connected, 2: Opening, -1: Heartbeat Missed, -2: Expired.","format":"int32"},"openStatus":{"type":"boolean","description":"Open Status of the remote access tunnel."},"tunnelEntryType":{"type":"integer","description":"Entry of the remote access tunnel.1: custom tunnel 2: device tunnel 3:device detail 4:client detail","format":"int32"},"clientManager":{"type":"boolean","description":"Client's manager of the remote access tunnel for the client."},"clientName":{"type":"string","description":"Client's name of the remote access tunnel for the client."},"clientDeviceType":{"type":"string","description":"Client's type of the remote access tunnel for the client."},"clientModel":{"type":"string","description":"Client's model of the remote access tunnel for the client."},"supportWebAutoLogin":{"type":"boolean","description":"If the remote access tunnel supports web auto login."},"supportSshTelnetTunnel":{"type":"boolean","description":"If the remote access tunnel supports SSH and telnet connections."},"supportHttpHttpsTunnel":{"type":"boolean","description":"If the remote access tunnel supports HTTP and HTTPS connections."},"enableSsh":{"type":"boolean","description":"If the SSH Login is enabled in site settings."},"enableHttp":{"type":"boolean","description":"If the HTTP Login is enabled in global settings."},"enableHttps":{"type":"boolean","description":"If the HTTPs Login is enabled in global settings."},"ewebHost":{"type":"string","description":"Nat traversal tunnel eweb host"}}},"OperationResponseNatTraversalTunnelGridVONatTraversalTunnelVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/NatTraversalTunnelGridVONatTraversalTunnelVO"}}},"NatTraversalSingleTunnelStatusVO":{"type":"object","properties":{"tunnelId":{"type":"integer","format":"int32"},"status":{"type":"integer","description":"Status of the remote access tunnel. 0: Disconnected, 1: Connected, 2: Opening, -1: Heartbeat Missed, -2: Expired.","format":"int32"},"openStatus":{"type":"boolean","description":"The open and closed status of the remote access tunnel."},"name":{"type":"string","description":"Name of the remote access tunnel."}}},"OperationResponseNatTraversalSingleTunnelStatusVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/NatTraversalSingleTunnelStatusVO"}}},"NatTraversalEwebInfoVO":{"type":"object","properties":{"ewebHost":{"type":"string","description":"Nat traversal tunnel eweb host"},"autoLoginToken":{"type":"string","description":"Nat traversal tunnel auto login token"}}},"OperationResponseNatTraversalEwebInfoVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/NatTraversalEwebInfoVO"}}},"NatTraversalTunnelsStatusVO":{"type":"object","properties":{"tunnelsStatus":{"type":"array","items":{"$ref":"#/components/schemas/NatTraversalSingleTunnelStatusVO"}}}},"OperationResponseNatTraversalTunnelsStatusVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/NatTraversalTunnelsStatusVO"}}},"OperationResponseNatTraversalTunnelVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/NatTraversalTunnelVO"}}},"OperationResponseListRebootScheduleQueryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/RebootScheduleQueryOpenApiVO"}}}},"RebootScheduleQueryOpenApiVO":{"required":["deviceMacs","name","status","time"],"type":"object","properties":{"id":{"type":"string","description":"Reboot Schedule ID."},"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Reboot Schedule name should contain 1 to 128 characters."},"status":{"type":"boolean","description":"Reboot Schedule status."},"deviceMacs":{"type":"array","description":"MAC address of the selected devices.","items":{"type":"string","description":"MAC address of the selected devices."}},"time":{"$ref":"#/components/schemas/RebootScheduleTimeOpenApiVO"},"nextExecute":{"type":"integer","description":"Reboot Schedule next execution timestamp(ms).","format":"int64"}}},"OperationResponseLanNetworkOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/LanNetworkOpenApiVO"}}},"ClassRuleDetailOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"The ID of class rule."},"enable":{"type":"boolean","description":"The status of class rule. valid values are true or false."},"ipVersion":{"type":"integer","description":"The IP Version of class rule should be a value as follows: 0: IPv4; 1: IPv6.","format":"int32"},"localIp":{"type":"string","description":"The ID of IP Group or IPv6 Group selected in the Local Address configuration. The ID can be obtained from 'Get group profile list' interface."},"remoteIp":{"type":"string","description":"The ID of IP Group or IPv6 Group selected in the Remote Address configuration. The ID can be obtained from 'Get group profile list' interface."},"dscp":{"type":"string","description":"The DSCP value selected in the DSCP configuration should be a value as follows: any: any; 8: IP precedence 1; 16: IP precedence 2; 24: IP precedence 3; 32: IP precedence 4; 40: IP precedence 5; 48: IP precedence 6; 56: IP precedence 7; 10: AF Class 1 (Low Drop); 12: AF Class 1 (Medium Drop); 14: AF Class 1 (High Drop); 18: AF Class 2 (Low Drop); 20: AF Class 2 (Medium Drop); 22: AF Class 2 (High Drop); 26: AF Class 3 (Low Drop); 28: AF Class 3 (Medium Drop); 30: AF Class 3 (High Drop); 34: AF Class 4 (Low Drop); 36: AF Class 4 (Medium Drop); 38: AF Class 4 (High Drop); 46: EF Class."},"serviceType":{"type":"string","description":"The ID of Gateway Qos Service selected in the Service Name configuration. The ID can be obtained from 'Get all Gateway QoS Service's ID and name info' interface."},"classType":{"type":"integer","description":"The Class value selected in the Qos Class configuration should be a value as follows: 1: Class 1, 2: Class 2, 3: Class 3.","format":"int32"}}},"GridVOClassRuleDetailOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClassRuleDetailOpenApiVO"}}}},"OperationResponseGridVOClassRuleDetailOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOClassRuleDetailOpenApiVO"}}},"OperationResponseWifiCallingTrafficGridOpenApiVOWifiCallingTrafficOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/WifiCallingTrafficGridOpenApiVOWifiCallingTrafficOpenApiVO"}}},"WifiCallingTrafficGridOpenApiVOWifiCallingTrafficOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WifiCallingTrafficOpenApiVO"}},"topKSsids":{"type":"array","description":"Top k SSIDs based on voice call traffic statistics.","items":{"$ref":"#/components/schemas/WifiCallingTrafficOpenApiVO"}},"topKEPDGs":{"type":"array","description":"Top k ePDGs based on voice call traffic statistics.","items":{"$ref":"#/components/schemas/WifiCallingTrafficOpenApiVO"}}}},"WifiCallingTrafficOpenApiVO":{"type":"object","properties":{"clientName":{"type":"string","description":"Client name."},"apName":{"type":"string","description":"The name of the AP device connected to the client."},"apMac":{"type":"string","description":"Ap MAC."},"clientMac":{"type":"string","description":"Client Mac Address"},"ip":{"type":"string","description":"Client ip or ipv6."},"carrierName":{"type":"string","description":"Carrier name used by the client."},"wifiCallingProfileName":{"type":"string","description":"Wifi calling profile name used by the client."},"priority":{"type":"integer","description":"Priority of ePDG in the WiFi calling profile.","format":"int32"},"ssid":{"type":"string","description":"The name of the SSID that the client is connected to."},"band":{"type":"integer","description":"SSID band. The lowest bit indicates whether 2.4G is included; the second lowest bit indicates whether 5G is included; the third lowest bit indicates whether 6G is included; 1 means included while 0 means not included. For example, 7(111) means that 2G/5G/6G are enabled; 1(001) means that 2G is enabled. (When 5G is included，it means 5G/5G1/5G2 are enabled.)","format":"int32"},"domain":{"type":"string","description":"EPDG domain name or IP."},"totalTraffic":{"type":"integer","description":"Total traffic.","format":"int64"},"trafficDown":{"type":"integer","description":"Downlink traffic related to voice calls.","format":"int64"},"trafficUp":{"type":"integer","description":"Uplink traffic related to voice calls.","format":"int64"},"startTime":{"type":"integer","description":"Start time of the voice call.","format":"int64"},"endTime":{"type":"integer","description":"End time of the voice call.","format":"int64"},"callNum":{"type":"integer","description":"Number of calls on the same client MAC.","format":"int32"},"deviceType":{"type":"string","description":"Client device type."},"model":{"type":"string","description":"Client model."}},"description":"Top k ePDGs based on voice call traffic statistics."},"GlobalPortalDomainOpenApiVO":{"type":"object","properties":{"autoRefresh":{"type":"boolean","description":"Whether Portal URL enable Auto Refresh"},"url":{"type":"string","description":"Portal URL, valid when parameter [autoRefresh] is false"}}},"OperationResponseGlobalPortalDomainOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GlobalPortalDomainOpenApiVO"}}},"OperationResponsePortalLogoutConfigOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PortalLogoutConfigOpenApiVO"}}},"Device ports.":{"type":"object","properties":{"portNum":{"type":"integer","description":"Device total ports number.","format":"int32"},"portIds":{"type":"array","description":"List of device ports supporting port schedule.","items":{"type":"integer","description":"List of device ports supporting port schedule.","format":"int32"}}},"description":"Device ports info."},"OperationResponseListPort Device Detail.":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/Port device detail."}}}},"Port device detail.":{"type":"object","properties":{"type":{"type":"string","description":"Device type. \"gateway\", \"switch\""},"mac":{"type":"string","description":"Device mac."},"name":{"type":"string","description":"Device name."},"site":{"type":"string","description":"Site ID"},"model":{"type":"string","description":"Device model."},"modelVersion":{"type":"string","description":"Device model version."},"hwVersion":{"type":"string","description":"Device hardware version."},"status":{"type":"integer","description":"Device status.","format":"int32"},"sn":{"type":"string","description":"Device SN code."},"ports":{"$ref":"#/components/schemas/Device ports."}}},"GridVOPortScheduleQueryOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PortScheduleQueryOpenApiVO"}}}},"OperationResponseGridVOPortScheduleQueryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOPortScheduleQueryOpenApiVO"}}},"PortScheduleQueryOpenApiVO":{"required":["name","portsMap","status","turnOnTime"],"type":"object","properties":{"id":{"type":"string","description":"Port Schedule individual ID."},"siteId":{"type":"string","description":"Site ID"},"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"Port Schedule Name should contain 1 to 128 characters."},"status":{"type":"boolean","description":"Port Schedule Status."},"turnOnTime":{"type":"string","description":"Time Range ID, cannot be empty."},"portsMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Key:MAC(\"String\"), Value:Set of Ports(\"Integer\")","items":{"type":"integer","description":"Key:MAC(\"String\"), Value:Set of Ports(\"Integer\")","format":"int32"}},"description":"Key:MAC(\"String\"), Value:Set of Ports(\"Integer\")"},"nextExecute":{"type":"integer","description":"Show Poe Schedule next execution timestamp.","format":"int64"},"notInDst":{"type":"boolean","description":"When notInDst is true, Not displayed in DST."}}},"GridVOPoeScheduleQueryOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PoeScheduleQueryOpenApiVO"}}}},"OperationResponseGridVOPoeScheduleQueryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOPoeScheduleQueryOpenApiVO"}}},"PoeScheduleQueryOpenApiVO":{"required":["name","poePortsMap","status","turnOnTime"],"type":"object","properties":{"id":{"type":"string","description":"PoE Schedule Individual ID."},"siteId":{"type":"string","description":"Site ID"},"name":{"pattern":"^[^ ]$|^[^ ].{0,126}[^ ]$","type":"string","description":"PoE Schedule Name should contain 1 to 128 characters."},"status":{"type":"boolean","description":"PoE Schedule Status."},"turnOnTime":{"type":"string","description":"Time Range ID, cannot be empty."},"poePortsMap":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Key:Mac(\"String\"), Value:Set of Ports(\"Integer\")","items":{"type":"integer","description":"Key:Mac(\"String\"), Value:Set of Ports(\"Integer\")","format":"int32"}},"description":"Key:Mac(\"String\"), Value:Set of Ports(\"Integer\")"},"nextExecute":{"type":"integer","description":"Show PoE Schedule next execution timestamp.","format":"int64"},"notInDst":{"type":"boolean","description":"When notInDst is true, not displayed in DST."}}},"Device poe ports.":{"type":"object","properties":{"portNum":{"type":"integer","description":"Total port num.","format":"int32"},"poePortIds":{"type":"array","description":"List of ports supporting Poe.","items":{"type":"integer","description":"List of ports supporting Poe.","format":"int32"}}},"description":"Device poe ports info."},"OperationResponseListPoe Device Detail.":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/Poe device detail."}}}},"Poe device detail.":{"type":"object","properties":{"type":{"type":"string","description":"Device type. \"gateway\", \"switch\""},"mac":{"type":"string","description":"Device MAC."},"name":{"type":"string","description":"Device name."},"site":{"type":"string","description":"Site ID"},"model":{"type":"string","description":"Device model."},"modelVersion":{"type":"string","description":"Device model version."},"hwVersion":{"type":"string","description":"Device hardware version."},"firmwareVersion":{"type":"string","description":"Device firmware version."},"status":{"type":"integer","description":"Device status.","format":"int32"},"sn":{"type":"string","description":"Device SN code."},"combinedGateway":{"type":"boolean","description":"Indicates whether it is a combined-gateway."},"poePort":{"$ref":"#/components/schemas/Device poe ports."}}},"GridVORF Planning History":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/RF Planning History"}}}},"RF Planning History":{"type":"object","properties":{"planningHistroyId":{"type":"string","description":"Planning histroy ID."},"time":{"type":"integer","description":"Timestamp corresponding to the start of optimization.","format":"int64"},"channelDeployEnable":{"type":"boolean","description":"Whether to enable channel deployment."},"channelWidthDeployEnable":{"type":"boolean","description":"Whether to enable channel width deployment."},"powerAdjustEnable":{"type":"boolean","description":"Whether to enable power adjustment."},"bandDeployEnable":{"type":"boolean","description":"Whether to enable band deployment."},"beforeIndex":{"type":"integer","description":"Index before WLAN Optimization, between 0 and 100.","format":"int32"},"afterIndex":{"type":"integer","description":"Index after WLAN Optimization, between 0 and 100.","format":"int32"},"apNum":{"type":"integer","description":"The number of EAPs.","format":"int32"},"length":{"type":"integer","description":"Parameter [length] means the duration of the WLAN Optimization in seconds.","format":"int32"},"mode":{"type":"integer","description":"0: by WLAN Optimization schedule. 1: by one-click WLAN Optimization. 2: by RRM schedule(Deprecated). 3: by RRM adaptive.","format":"int32"},"isScanSuccess":{"type":"boolean","description":"True: Succeeded to obtain device scan results. False: Failed to obtain device scan results."},"isAppliedSuccess":{"type":"boolean","description":"True: Succeeded to apply settings recommended by the algorithm. False or null: Failed to apply settings recommended by the algorithm. "},"currentConfig":{"type":"integer","description":"0: This entry does not correspond to the current configuration. 1: The recommended values are the current configuration. 2: The previous/origin values are the current configuration.","format":"int32"},"msg":{"type":"string"},"msgType":{"type":"integer","format":"int32"},"failedMacs2g":{"type":"string"},"failedMacs5g":{"type":"string"},"failedMacs6g":{"type":"string"}}},"OperationResponseGridVORF Planning History":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVORF Planning History"}}},"GridVOOswVrrpOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OswVrrpOpenApiVO"}}}},"OperationResponseGridVOOswVrrpOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOswVrrpOpenApiVO"}}},"OswVrrpDeviceOpenApiVO":{"required":["mac","name","networks","priority","type","vlanInterface"],"type":"object","properties":{"name":{"type":"string","description":"The name of the device"},"mac":{"type":"string","description":"Device Mac"},"priority":{"type":"integer","description":"The device priority should be within the range of 1-254.","format":"int32"},"vlanInterface":{"type":"integer","description":"The Vlan Interface should be within the range of 1-4094.","format":"int32"},"trackedInterface":{"type":"integer","description":"The TrackedInterface should be within the range of 1-4094.","format":"int32"},"reducedPriority":{"type":"integer","description":"The ReducedPriority should be within the range of 1-254.","format":"int32"},"networks":{"maxItems":2,"minItems":0,"type":"array","description":"Store the IPv4 and IPv6 network segments corresponding to the VLAN interface, up to 2 entries are allowed for the networks.","items":{"maxLength":2,"minLength":0,"type":"string","description":"Store the IPv4 and IPv6 network segments corresponding to the VLAN interface, up to 2 entries are allowed for the networks."}},"type":{"type":"string","description":"Device Type"},"stackId":{"type":"string","description":"ID of stack group"},"model":{"type":"string","description":"Device model."},"modelVersion":{"type":"string","description":"Device Model Version."},"deviceSeriesType":{"type":"integer","description":"Device type.","format":"int32"}},"description":"Up to 8 entries are allowed for the deviceList, and it cannot be empty."},"OswVrrpOpenApiVO":{"required":["advertiseTimer","authentication","delayTime","name","preemptMode","vrId"],"type":"object","properties":{"id":{"type":"string","description":"VRRP ID"},"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"VRRP name, it should be visible ASCII, and should contain 1 to 64 characters."},"vrId":{"type":"integer","description":"Virtual Router ID, its value should be within the range of 1-255.","format":"int32"},"deviceList":{"maxItems":8,"minItems":1,"type":"array","description":"Up to 8 entries are allowed for the deviceList, and it cannot be empty.","items":{"$ref":"#/components/schemas/OswVrrpDeviceOpenApiVO"}},"virtualIpv4s":{"maxItems":32,"minItems":0,"type":"array","description":"Up to 32 entries are allowed for the virtualIpv4s.","items":{"maxLength":32,"minLength":0,"type":"string","description":"Up to 32 entries are allowed for the virtualIpv4s."}},"ipV6LinkLocal":{"type":"string","description":"Virtual IpV6LinkLocal Address"},"ipV6Global":{"maxItems":15,"minItems":0,"type":"array","description":"Up to 15 entries are allowed for the ipV6Global.","items":{"maxLength":15,"minLength":0,"type":"string","description":"Up to 15 entries are allowed for the ipV6Global."}},"advertiseTimer":{"type":"integer","description":"AdvertiseTimer should be within the range of 1-255, the default setting value is 100 and the unit is millimeter second.","format":"int32"},"preemptMode":{"type":"boolean","description":"Whether the preemption mode is enabled or not, it defaults to enabled."},"delayTime":{"type":"integer","description":"DelayTime should be within the range of 0-255, default setting is 0 and the unit is second","format":"int32"},"authentication":{"type":"integer","description":"Authentication type should be a value as follows: 0: NONE, 1: Simple, 2: MD5","format":"int32"},"key":{"pattern":"^(?:[A-Za-z0-9]|[-./:_@]){1,8}$","type":"string","description":"Key of VRRP"},"status":{"type":"integer","description":"The current status of VRRP, it should be a value as follows: 0: NORMAL, 1: FAILED, 2: ABNORMAL","format":"int32"},"ipv4MasterDevice":{"type":"string","description":"IPV4 Master Device"},"ipv6MasterDevice":{"type":"string","description":"IPV6 Master Device"}}},"GridVOOspfProcessOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OspfProcessOpenApiVO"}}}},"OperationResponseGridVOOspfProcessOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOspfProcessOpenApiVO"}}},"OspfProcessOpenApiVO":{"required":["areaList","connectedEnable","deviceName","mac","processId","routerMode","staticEnable"],"type":"object","properties":{"id":{"type":"string","description":"OSPF Process ID"},"deviceName":{"type":"string","description":"The name of the device"},"isStack":{"type":"boolean","description":"Indicates whether the device is a stack member device."},"mac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"Device Mac"},"stackId":{"type":"string","description":"Used for backend verification, the front-end does not need to pass a value, and there are values when the MAC is master"},"processId":{"type":"integer","description":"Process ID should be within the range of 1-65535.","format":"int32"},"routerMode":{"type":"integer","description":"RouterMode, its value should be a value as follows: 0: AUTO, 1: MANUAL.","format":"int32"},"routerId":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Router ID"},"staticEnable":{"type":"boolean","description":"Static routing protocol switch"},"staticMetric":{"type":"integer","description":"Set the metric value to be used as the metric of redistributed routes. It should be within the range of 1-16777214 and the default is equal to Default Metric configured on Basic page.","format":"int32"},"staticMetricType":{"type":"integer","description":"Set the OSPF metric type of redistributed routes. The default is External Type 2.","format":"int32"},"connectedEnable":{"type":"boolean","description":"Direct connection routing protocol switch"},"connectedMetric":{"type":"integer","description":"Set the metric value to be used as the metric of redistributed routes. It should be within the range of 1-16777214 and the default is equal to Default Metric configured on Basic page.","format":"int32"},"connectedMetricType":{"type":"integer","description":"Set the OSPF metric type of redistributed routes. The default is External Type 2.","format":"int32"},"autoCostEnable":{"type":"boolean","description":"enable Auto-Cost Reference Bandwidth."},"autoCost":{"type":"integer","description":"Auto-Cost Reference Bandwidth.","format":"int32"},"areaList":{"maxItems":16,"minItems":0,"type":"array","description":" Up to 16 entries are allowed for the areaList.","items":{"$ref":"#/components/schemas/OspfProcessAreaOpenApiVO"}}}},"GridVOOspfInterfaceOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OspfInterfaceOpenApiVO"}}}},"OperationResponseGridVOOspfInterfaceOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOspfInterfaceOpenApiVO"}}},"OspfInterfaceOpenApiVO":{"required":["authenticationType","cost","deviceName","helloInterval","mac","networkType","vlanId","vlanInterfaceId","vlanInterfaceName"],"type":"object","properties":{"id":{"type":"string","description":"OSPF Interface ID"},"deviceName":{"type":"string","description":"Device Name"},"isStack":{"type":"boolean","description":"Indicates whether the device is a stack member device."},"mac":{"pattern":"[A-Fa-f0-9]{1}[02468aceACE]{1}([-:][A-Fa-f0-9]{2}){5}","type":"string","description":"Device Mac"},"type":{"type":"integer","description":"OSPF Interface type, 0: VLAN interface; 1: Loopback interface. If null, defaults to VLAN interface (0).","format":"int32"},"stackId":{"type":"string","description":"Stack ID, used for backend verification, there is no need to transmit values, and it has value when the mac is master."},"vlanInterfaceId":{"type":"string","description":"Vlan Interface ID"},"vlanInterfaceName":{"type":"string","description":"Vlan Interface Name"},"vlanId":{"type":"integer","description":"Vlan ID should be within the range of 1–4094.","format":"int32"},"loopbackInterfaceId":{"type":"string","description":"Loopback Interface ID. Not Null when type is 1."},"loopbackId":{"type":"integer","description":"Loopback ID should be within the range of 1-64. Not Null when type is 1.","format":"int32"},"cost":{"type":"integer","description":"The link cost. OSPF uses this value in computing shortest paths. cost should be within the range of 1 to 65535.","format":"int32"},"networkType":{"type":"integer","description":"Network Type, it should be a value as follows: 0: Broadcast, 1: Non-Broadcast, 2: Point-to-Multipoint, 3: Point-to-Point. The default network type for Ethernet interfaces is broadcast.","format":"int32"},"passiveEnable":{"type":"boolean","description":"enable passive interface."},"helloInterval":{"type":"integer","description":"The hello interval for the specified interface in seconds. This parameter must be the same for all routers attached to a network. It should be within the range of 1-65535 seconds and the default is 10 seconds.","format":"int32"},"deadInterval":{"type":"integer","description":"The dead interval for the specified interface in seconds. This specifies how long a router will wait to see a neighbor router's Hello packets before declaring that the router is down. This parameter must be the same for all routers attached to a network. It should be within the range of 1-65535 seconds and the default is 40.","format":"int32"},"authenticationType":{"type":"integer","description":"Authentication Type, it should be a value as follows: 0: None, 1: Simple, 2: MD5.","format":"int32"},"simpleKey":{"maxLength":8,"minLength":1,"type":"string","description":"Displays the key used for simple authentication, its value should be within the range of 1-8."},"md5KeyId":{"type":"integer","description":"Displays the key ID used for md5 authentication, its value should be within the range of 1-255.","format":"int32"},"md5Key":{"maxLength":16,"minLength":1,"type":"string","description":"Displays the key used for md5 authentication, its value should be within the range of 1-16."}}},"OperationResponseListOspfDeviceOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/OspfDeviceOpenApiVO"}}}},"OspfDeviceOpenApiVO":{"type":"object","properties":{"deviceName":{"type":"string","description":"Device Name"},"mac":{"type":"string","description":"Device Mac"},"isStack":{"type":"boolean","description":"Indicates whether the device is a stack member device."},"supportDeadInterval":{"type":"boolean","description":"Indicates whether the device supports interface dead interval."}}},"OperationResponseSystemInfoAppDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SystemInfoAppDTO"}}},"SystemInfoAppDTO":{"type":"object","properties":{"systemDescription":{"type":"string","description":"OLT device system description."},"deviceName":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"Device name should contain 1-32 bits numbers, Upper and lower letters, -@_:/. ."},"deviceLocation":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"Device location should contain 1-32 bits numbers, Upper and lower letters, -@_:/. ."},"contactInformation":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"Contact information should contain 1-32 bits numbers, Upper and lower letters, -@_:/. ."},"mac":{"type":"string","description":"Mac address"},"serialNumber":{"type":"string","description":"SerialNumber of ONU should contain 12, 13, or 16 characters, in the format <XXXXXXXXXXXX> ,<XXXX-XXXXXXXX>,<XXXXXXXXXXXXXXXX>"},"hardwareVersion":{"type":"string","description":"Hardware version"},"firmwareVersion":{"type":"string","description":"Firmware version"},"bootLoaderVersion":{"type":"string","description":"Boot loader version"},"systemTime":{"type":"string","description":"System time"},"runningTime":{"type":"integer","description":"Uptime, unit (s).","format":"int64"},"jumboFrameStatus":{"type":"integer","description":"Whether Jumbo Frame is enabled, jumboFrameStatus should be a value as follows: 1:ENABLE;0:DISABLE.","format":"int32"},"sntpStatus":{"type":"integer","description":"Whether to obtain time from the NTP server, sntpStatus should be a value as follows:1:ENABLE;0:DISABLE.","format":"int32"},"igmpSnoopingStatus":{"type":"integer","description":"Whether IGMP Snooping is enabled, igmpSnoopingStatus should be a value as follows: 1:ENABLE;0:DISABLE.","format":"int32"},"snmpStatus":{"type":"integer","description":"Whether SNMP is enabled, snmpStatus should be a value as follows: 1:ENABLE;0:DISABLE.","format":"int32"},"spanningTreeStatus":{"type":"integer","description":"Whether Spanning Tree is enabled, spanningTreeStatus should be a value as follows: 1:ENABLE;0:DISABLE.","format":"int32"},"dhcpRelayStatus":{"type":"integer","description":"Whether DHCP Relaying is enabled, dhcpRelayStatus should be a value as follows: 1:ENABLE;0:DISABLE.","format":"int32"},"httpServerStatus":{"type":"integer","description":"Whether the HTTP Server function is enabled, httpServerStatus should be a value as follows: 1:ENABLE;0:DISABLE.","format":"int32"},"telnetStatus":{"type":"integer","description":"Whether Telnet is enabled, telnetStatus should be a value as follows: 1:ENABLE;0:DISABLE.","format":"int32"},"sshStatus":{"type":"integer","description":"Whether SSH is enabled, sshStatus should be a value as follows: 1:ENABLE;0:DISABLE.","format":"int32"}}},"OperationResponseManagementSystemInterfaceDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ManagementSystemInterfaceDTO"}}},"QuerySort":{"type":"object","properties":{"sortKey":{"type":"string","description":"The key used to sort"},"sortDirection":{"type":"string","description":"Sort direction should be a value as follows:ASC,DESC","enum":["DESC","ASC"]}},"description":"Sorting fields."},"ServicePortQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"size":{"minimum":1,"type":"integer","description":"Page size must be greater or equal to 1,with the default value of 10.","format":"int32"},"number":{"minimum":0,"type":"integer","description":"Current page number must be greater or equal to 0, with a default value of 0.","format":"int32"},"searchField":{"type":"string","description":"Search Field"}}},"OperationResponsePageResponseServicePortVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PageResponseServicePortVO"}}},"PageResponseServicePortVO":{"type":"object","properties":{"content":{"type":"array","description":"Content","items":{"$ref":"#/components/schemas/ServicePortVO"}},"totalElements":{"type":"integer","description":"Total elements","format":"int64"},"totalPages":{"type":"integer","description":"Total page number","format":"int32"},"last":{"type":"boolean","description":"Whether is in the last page"},"number":{"type":"integer","description":"Number of the current page,starting from 0.","format":"int32"},"size":{"type":"integer","description":"Page size","format":"int32"},"numberOfElements":{"type":"integer","description":"Actual number of current page","format":"int32"},"first":{"type":"boolean","description":"Whether is in the first page"}}},"ServicePortVO":{"required":["adminStatus","description","index","onuId","statisticPerformance"],"type":"object","properties":{"index":{"type":"integer","description":"ID of service port.Index should be within the range of 1 to 8100","format":"int32"},"activeStatus":{"type":"string","description":"Whether this service port is active.ActiveStatus should be a value as follows:ACTIVE,INACTIVE","enum":["ACTIVE","INACTIVE"]},"description":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"Description of service port.Description should contain 1 to 32 characters including numbers, Upper and lower letters, -@_:/. ."},"onuId":{"type":"integer","description":"OnuId should be within the range of 0 to 127","format":"int32"},"adminStatus":{"type":"string","description":"The enable status of the service flows matched by this Service Port. AdminStatus should be a value as follows: DISABLE,ENABLE. Default value: ENABLE.","enum":["DISABLE","ENABLE"]},"statisticPerformance":{"type":"string","description":"The traffic statistics switch status for the service flows matched by this Service Port. StatisticPerformance should be a value as follows: DISABLE,ENABLE. Default value: DISABLE.","enum":["DISABLE","ENABLE"]},"ponPortId":{"type":"integer","description":"PonPortId should be within the range of 1 to 16","format":"int32"},"svlan":{"type":"integer","description":"SVlan should be within the range of 1 to 4095","format":"int32"},"gemPortId":{"type":"integer","description":"GemPortId should be within the range of 1 to 1023","format":"int32"},"userVlan":{"type":"integer","description":"UserVlan should be within the range of 0 to 4095","format":"int32"},"userVlanPriority":{"type":"string","description":"UserVlanPriority should be within the range of -1 to 7"},"tagAction":{"type":"string","description":"TagAction should be a value as follows:DEFAULT,TRANSPARENT,TRANSLATE,TRANSLATE_AND_ADD,ADD_DOUBLE","enum":["DEFAULT","TRANSPARENT","TRANSLATE","TRANSLATE_AND_ADD","ADD_DOUBLE"]},"innerVlan":{"type":"integer","description":"InnerVlan should be within the range of 0 to 4095","format":"int32"},"innerVlanPriority":{"type":"string","description":"InnerVlanPriority should be within the range of -1 to 7"},"etherType":{"type":"string","description":"EtherType should be a value as follows:NONE,IPV4OE,IPV6OE,PPPOE","enum":["NONE","IPV4OE","IPV6OE","PPPOE"]},"inboundTrafficProfileId":{"type":"string","description":"InboundTrafficProfileId should be within the range of 0 to 512"},"outboundTrafficProfileId":{"type":"string","description":"OutboundTrafficProfileId should be within the range of 0 to 512"}},"description":"Content"},"OperationResponseListServicePortVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ServicePortVO"}}}},"StatisticInfoQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"size":{"minimum":1,"type":"integer","description":"Page size must be greater or equal to 1,with the default value of 10.","format":"int32"},"number":{"minimum":0,"type":"integer","description":"Current page number must be greater or equal to 0, with a default value of 0.","format":"int32"}}},"OperationResponsePageResponseStatisticInfoDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PageResponseStatisticInfoDTO"}}},"PageResponseStatisticInfoDTO":{"type":"object","properties":{"content":{"type":"array","description":"Content","items":{"$ref":"#/components/schemas/StatisticInfoDTO"}},"totalElements":{"type":"integer","description":"Total elements","format":"int64"},"totalPages":{"type":"integer","description":"Total page number","format":"int32"},"last":{"type":"boolean","description":"Whether is in the last page"},"number":{"type":"integer","description":"Number of the current page,starting from 0.","format":"int32"},"size":{"type":"integer","description":"Page size","format":"int32"},"numberOfElements":{"type":"integer","description":"Actual number of current page","format":"int32"},"first":{"type":"boolean","description":"Whether is in the first page"}}},"StatisticInfoDTO":{"required":["servicePortIndex"],"type":"object","properties":{"servicePortIndex":{"type":"integer","description":"ID of service port.ServicePortIndex should be within the range of 1 to 8100","format":"int32"},"packetsRx":{"type":"integer","description":"Packets received","format":"int64"},"packetsTx":{"type":"integer","description":"Packets transmitted","format":"int64"},"octetsRx":{"type":"integer","description":"Octets received","format":"int64"},"octetsTx":{"type":"integer","description":"Octets transmitted","format":"int64"}},"description":"Content"},"OperationResponseListStatisticInfoDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/StatisticInfoDTO"}}}},"StatisticInfoDetailQueryDTO":{"required":["servicePortIndex"],"type":"object","properties":{"servicePortIndex":{"type":"integer","description":"ID of service port.ServicePortIndex should be within the range of 1 to 8100","format":"int32"}}},"OperationResponseStatisticInfoDetailDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/StatisticInfoDetailDTO"}}},"StatisticInfoDetailDTO":{"type":"object","properties":{"servicePortIndex":{"type":"integer","description":"Service port index","format":"int32"},"receivedBroadcast":{"type":"integer","description":"Received broadcast","format":"int64"},"receivedMulticast":{"type":"integer","description":"Received multicast","format":"int64"},"receivedUnicast":{"type":"integer","description":"Received unicast","format":"int64"},"receivedJumbo":{"type":"integer","description":"Received jumbo","format":"int64"},"alignmentErrors":{"type":"integer","description":"Alignment errors","format":"int64"},"undersizePackets":{"type":"integer","description":"Undersize packets","format":"int64"},"packetsOf64Octets":{"type":"integer","description":"Packets Of 64 Octets","format":"int64"},"packetsOf65To127Octets":{"type":"integer","description":"Packets of 65 to 127 octets","format":"int64"},"packetsOf128To255Octets":{"type":"integer","description":"Packets of 128 to 255 octets","format":"int64"},"packetsOf256To511Octets":{"type":"integer","description":"Packets of 256 to511 octets","format":"int64"},"packetsOf512To1023Octets":{"type":"integer","description":"Packets of 512 to 1023 octets","format":"int64"},"packetsOf1023To1518Octets":{"type":"integer","description":"Packets of 1023 to 1518 octets","format":"int64"},"receivedPackets":{"type":"integer","description":"Received packets","format":"int64"},"receivedBytes":{"type":"integer","description":"Received bytes","format":"int64"},"sentBroadcast":{"type":"integer","description":"Sent broadcast","format":"int64"},"sentMulticast":{"type":"integer","description":"Sent multicast","format":"int64"},"sentUnicast":{"type":"integer","description":"Sent unicast","format":"int64"},"sentJumbo":{"type":"integer","description":"Sent jumbo","format":"int64"},"sentPackets":{"type":"integer","description":"Sent packets","format":"int64"},"sentBytes":{"type":"integer","description":"Sent bytes","format":"int64"},"collisionsErrors":{"type":"integer","description":"Collision errors","format":"int64"}}},"OperationResponseStatisticConfigDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/StatisticConfigDTO"}}},"TrafficProfilePageQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"size":{"minimum":1,"type":"integer","description":"Page size must be greater or equal to 1,with the default value of 10.","format":"int32"},"number":{"minimum":0,"type":"integer","description":"Current page number must be greater or equal to 0, with a default value of 0.","format":"int32"},"searchFields":{"uniqueItems":true,"type":"array","description":"Fields to search","items":{"type":"string","description":"Fields to search"}}}},"OperationResponsePageResponseTrafficProfileVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PageResponseTrafficProfileVO"}}},"PageResponseTrafficProfileVO":{"type":"object","properties":{"content":{"type":"array","description":"Content","items":{"$ref":"#/components/schemas/TrafficProfileVO"}},"totalElements":{"type":"integer","description":"Total elements","format":"int64"},"totalPages":{"type":"integer","description":"Total page number","format":"int32"},"last":{"type":"boolean","description":"Whether is in the last page"},"number":{"type":"integer","description":"Number of the current page,starting from 0.","format":"int32"},"size":{"type":"integer","description":"Page size","format":"int32"},"numberOfElements":{"type":"integer","description":"Actual number of current page","format":"int32"},"first":{"type":"boolean","description":"Whether is in the first page"}}},"TrafficProfileVO":{"required":["innerPriority","priority","priorityPolicy","priorityValue","rateLimitStatus"],"type":"object","properties":{"name":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"Name of the traffic profile. No user configuration is automatically generated by the device. The name should contain 1 to 32 characters, including upper and lower letters, numbers, and symbols (-@_:/.)."},"rateLimitStatus":{"type":"string","description":"Whether to enable rate limit.RateLimitStatus should be a value as follows:DISABLE,ENABLE.ENABLE by default.When enabled, CIR must be configured, while CBS, PIR, and PBS parameters are optional.When disabled, the CIR, CBS, PIR, and PBS parameters are grayed out and cannot be configured.","enum":["DISABLE","ENABLE"]},"cirValue":{"type":"integer","description":"CirValue should be within the range of 128 to 10240000","format":"int32"},"cbsValue":{"type":"integer","description":"CbsValue should be within the range of 2000 to 10240000","format":"int32"},"pirValue":{"type":"integer","description":"PirValue should be within the range of 128 to 10240000","format":"int32"},"pbsValue":{"type":"integer","description":"PbsValue should be within the range of 2000 to 10240000","format":"int32"},"priority":{"type":"string","description":"Priority type of the traffic profile.Priority should be a value as follows:ASSIGNED,USER_COS","enum":["ASSIGNED","USER_COS"]},"priorityValue":{"type":"integer","description":"Priority value of the traffic profile.PriorityValue should be within the range of 0 to 7","format":"int32"},"innerPriority":{"type":"string","description":"Inner priority type of the traffic profile,innerPriority should be a value as follows ASSIGNED, NONE, USER_COS, USER_INNER_COS","enum":["ASSIGNED","NONE","USER_COS","USER_INNER_COS"]},"innerPriorityValue":{"type":"integer","description":"Inner priority value of the traffic profile.InnerPriorityValue should be within the range of 0 to 7","format":"int32"},"priorityPolicy":{"type":"string","description":"Traffic priority policy should be a value as follows:LOCAL_SETTING, TAG_IN_PACKAGE, TAG_IN_INGRESS_PACKAGE","enum":["LOCAL_SETTING","TAG_IN_PACKAGE","TAG_IN_INGRESS_PACKAGE"]},"inUse":{"type":"string","description":"Whether the Traffic Profile is in use; if it is in use, it cannot be deleted."},"trafficId":{"type":"integer","description":"Traffic profile ID.TrafficId should be within the range of 1 to 512","format":"int32"}},"description":"Content"},"TrafficProfileListQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"searchFields":{"uniqueItems":true,"type":"array","description":"Fields to search","items":{"type":"string","description":"Fields to search"}}}},"OperationResponseListTrafficProfileVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/TrafficProfileVO"}}}},"OntPotsPortListQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"serviceId":{"type":"integer","description":"The associated Service Profile ID","format":"int32"}}},"OntPotsPortDTO":{"required":["vlanConfigMode"],"type":"object","properties":{"vlanConfigMode":{"type":"string","description":"Vlan config mode.VlanConfigMode should be a value as follows:TRANSPARENT,OTHERS","enum":["TRANSPARENT","OTHERS"]},"configItemList":{"type":"array","description":"Config item list","items":{"$ref":"#/components/schemas/OntPortVlanConfigItemDTO"}}}},"OperationResponseListOntPotsPortDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/OntPotsPortDTO"}}}},"OntEthPortListQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"serviceId":{"type":"integer","description":"The associated Service Profile ID","format":"int32"}}},"OntEthPortDTO":{"required":["portId"],"type":"object","properties":{"portId":{"type":"integer","description":"Port ID","format":"int32"},"vlanConfig":{"$ref":"#/components/schemas/OntEthPortVlanConfigDTO"},"priorityPolicy":{"type":"string","description":"Priority policy should be a value as follows:UNCONCERN,ASSIGNED,COPY_COS","enum":["UNCONCERN","ASSIGNED","COPY_COS"]},"igmpForward":{"$ref":"#/components/schemas/OntEthPortIGMPForwardDTO"},"maxMacCount":{"type":"integer","description":"MaxMacCount should be within the range of 0 to 255","format":"int32"},"qinQ":{"type":"string","description":"QinQ mode,qinQ should be a value as follows:UNCONCERN;DISABLE;ENABLE","enum":["UNCONCERN","DISABLE","ENABLE"]},"tlsVlan":{"type":"string","description":"Tls vlan"}}},"OntEthPortVlanConfigDTO":{"required":["vlanConfigMode"],"type":"object","properties":{"vlanConfigMode":{"type":"string","enum":["TRANSPARENT","OTHERS"]},"configItemList":{"type":"array","items":{"$ref":"#/components/schemas/OntPortVlanConfigItemDTO"}}},"description":"Configure the VLAN TAG processing mode of the ONT port"},"OperationResponseListOntEthPortDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/OntEthPortDTO"}}}},"ServiceProfilePageQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"size":{"minimum":1,"type":"integer","description":"Page size must be greater or equal to 1,with the default value of 10.","format":"int32"},"number":{"minimum":0,"type":"integer","description":"Current page number must be greater or equal to 0, with a default value of 0.","format":"int32"},"searchFields":{"uniqueItems":true,"type":"array","description":"Search fields","items":{"type":"string","description":"Search fields"}}}},"OperationResponsePageResponseServiceProfileVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PageResponseServiceProfileVO"}}},"PageResponseServiceProfileVO":{"type":"object","properties":{"content":{"type":"array","description":"Content","items":{"$ref":"#/components/schemas/ServiceProfileVO"}},"totalElements":{"type":"integer","description":"Total elements","format":"int64"},"totalPages":{"type":"integer","description":"Total page number","format":"int32"},"last":{"type":"boolean","description":"Whether is in the last page"},"number":{"type":"integer","description":"Number of the current page,starting from 0.","format":"int32"},"size":{"type":"integer","description":"Page size","format":"int32"},"numberOfElements":{"type":"integer","description":"Actual number of current page","format":"int32"},"first":{"type":"boolean","description":"Whether is in the first page"}}},"ServiceProfileVO":{"required":["ethNum","macLearning","multicastForward","multicastMode","nativeVlan","potsNum"],"type":"object","properties":{"serviceId":{"type":"integer","description":"Service profile ID should be within the range of 1 to 512 ","format":"int32"},"isInUse":{"type":"string","description":"Whether the service profile is in use"},"name":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"Name of the service profile. No user configuration is automatically generated by the device. The name should contain 1 to 32 characters, including upper and lower letters, numbers, and symbols (-@_:/.)."},"ethNum":{"type":"string","description":"Number of eth port.EthNum should be within the range of -1 to 24.-1 indicates that the number of ports is adaptive. The default value is -1."},"maxAdaptiveEthNum":{"type":"integer","description":"Set the maximum number of automatically recognized ETH ports.When ethNum is set to -1, a prompt will appear.MaxAdaptiveEthNum should be within the range of 0 to 24","format":"int32"},"potsNum":{"type":"string","description":"Number of ONU pots.PotsNum should be within the range of -1 to 8.-1 indicates that the number of ports is adaptive. The default value is -1."},"maxAdaptivePotsNum":{"type":"integer","description":"Set the maximum number of automatically recognized potsWhen potsNum is set to -1, a prompt will appear.MaxAdaptivePotsNum should be within the range of 0 to 4","format":"int32"},"macLearning":{"type":"string","description":"Enable/disable ONT MAC address learning function. MacLearning should be a value as follows:DISABLE,ENABLE","enum":["DISABLE","ENABLE"]},"nativeVlan":{"type":"string","description":"The ONT's concern for Native VLAN .NativeVlan should be a value as follows:UNCONCERN,CONCERN","enum":["UNCONCERN","CONCERN"]},"multicastMode":{"type":"string","description":"Set the multicast mode of the ONT. MulticastMode should be a value as follows:UNCONCERN,IGMP_SNOOPING,OLT_CONTROL","enum":["UNCONCERN","IGMP_SNOOPING","OLT_CONTROL"]},"multicastForward":{"type":"string","description":"Set the multicast packet forwarding mode of the ONT. NativeVlan should be a value as follows:UNCONCERN,TAGGED,UNTAGGED","enum":["UNCONCERN","TAGGED","UNTAGGED"]},"taggedType":{"type":"string","description":"TaggedType should be a value as follows:TRANSPARENT,TRANSLATION","enum":["TRANSPARENT","TRANSLATION"]},"taggedVlanId":{"type":"integer","description":"TaggedVlanId should be within the range of 1–4094","format":"int32"},"onuBindNum":{"type":"integer","description":"The number of ONU/ONT instances that use this Service template.","format":"int32"}},"description":"Content"},"ServiceProfileListQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"searchFields":{"uniqueItems":true,"type":"array","description":"Search fields","items":{"type":"string","description":"Search fields"}}}},"OperationResponseListServiceProfileVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ServiceProfileVO"}}}},"ServicePortProfilePageQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Fuzzy query parameters"},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"size":{"minimum":1,"type":"integer","description":"Page size must be greater or equal to 1,with the default value of 10.","format":"int32"},"number":{"minimum":0,"type":"integer","description":"Current page number must be greater or equal to 0, with a default value of 0.","format":"int32"},"searchFields":{"uniqueItems":true,"type":"array","description":"Query filter fields：servicePortProfileId,servicePortProfileName,entriesNumber,inUse","items":{"type":"string","description":"Query filter fields：servicePortProfileId,servicePortProfileName,entriesNumber,inUse"}}}},"OperationResponsePageResponseServicePortProfileDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PageResponseServicePortProfileDTO"}}},"PageResponseServicePortProfileDTO":{"type":"object","properties":{"content":{"type":"array","description":"Content","items":{"$ref":"#/components/schemas/ServicePortProfileDTO"}},"totalElements":{"type":"integer","description":"Total elements","format":"int64"},"totalPages":{"type":"integer","description":"Total page number","format":"int32"},"last":{"type":"boolean","description":"Whether is in the last page"},"number":{"type":"integer","description":"Number of the current page,starting from 0.","format":"int32"},"size":{"type":"integer","description":"Page size","format":"int32"},"numberOfElements":{"type":"integer","description":"Actual number of current page","format":"int32"},"first":{"type":"boolean","description":"Whether is in the first page"}}},"ServicePortProfileDTO":{"required":["inUse","servicePortProfileId","servicePortProfileName"],"type":"object","properties":{"servicePortProfileId":{"type":"string","description":"Service port template ID. The servicePortProfileId should be within the range of 1 to 512. E.g.,1."},"servicePortProfileName":{"type":"string","description":"Name of the service port template. No user configuration is automatically generated by the device. The name should contain 1 to 32 characters, including upper and lower letters, numbers, and symbols (-@_:/.)."},"entriesNumber":{"type":"integer","description":"Service port number. The entriesNumber should be within the range of 0 to 127.","format":"int32"},"inUse":{"type":"string","description":"Whether service port profile has been used."}},"description":"Content"},"OperationResponseListServicePortProfileDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ServicePortProfileDTO"}}}},"ServicePortProfileDetailPageQueryDTO":{"required":["servicePortProfileId"],"type":"object","properties":{"searchKey":{"type":"string","description":"Fuzzy query parameters"},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"size":{"minimum":1,"type":"integer","description":"Page size must be greater or equal to 1,with the default value of 10.","format":"int32"},"number":{"minimum":0,"type":"integer","description":"Current page number must be greater or equal to 0, with a default value of 0.","format":"int32"},"searchFields":{"uniqueItems":true,"type":"array","description":"Query Filter Fields.","items":{"type":"string","description":"Query Filter Fields."}},"servicePortProfileId":{"type":"string","description":"Service Port Profile ID. The servicePortProfileId should be within the range of 1 to 127."}}},"OperationResponsePageResponseServicePortProfileListDetailDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PageResponseServicePortProfileListDetailDTO"}}},"PageResponseServicePortProfileListDetailDTO":{"type":"object","properties":{"content":{"type":"array","description":"Content","items":{"$ref":"#/components/schemas/ServicePortProfileListDetailDTO"}},"totalElements":{"type":"integer","description":"Total elements","format":"int64"},"totalPages":{"type":"integer","description":"Total page number","format":"int32"},"last":{"type":"boolean","description":"Whether is in the last page"},"number":{"type":"integer","description":"Number of the current page,starting from 0.","format":"int32"},"size":{"type":"integer","description":"Page size","format":"int32"},"numberOfElements":{"type":"integer","description":"Actual number of current page","format":"int32"},"first":{"type":"boolean","description":"Whether is in the first page"}}},"ServicePortProfileListDetailDTO":{"required":["adminStatus","creationMode","description","entriesNumber","etherType","gemId","inUse","inboundTrafficProfileId","innerVlan","innerVlanPriority","outboundTrafficProfileId","servicePortId","servicePortProfileId","statisticPerformance","svlan","tagAction","userVlan","userVlanPriority"],"type":"object","properties":{"servicePortId":{"type":"string","description":"Display Service Port Entry ID. The servicePortId should be within the range of 1 to 127."},"servicePortProfileId":{"type":"string","description":"Service template ID. The servicePortProfileId should be within the range of 1 to 127."},"svlan":{"type":"integer","description":"The value of the SVLAN. The svlan should be within the range of 1 to 4094.","format":"int32"},"gemId":{"type":"integer","description":"The value of the GEM ID. The gemId should be within the range of 1-1023","format":"int32"},"userVlan":{"type":"integer","description":"The value of the User VLAN. The userVlan should be within the range of 1 to 4094.","format":"int32"},"userVlanPriority":{"type":"integer","description":"The value of the User VLAN Priority. The userVlanPriority should be within the range of 0 to 7.A value of -1 means that the item is not configured.","format":"int32"},"tagAction":{"type":"string","description":"TAG Action ","enum":["DEFAULT","TRANSPARENT","TRANSLATE","TRANSLATE_AND_ADD","ADD_DOUBLE"]},"innerVlan":{"type":"integer","description":"The innerVlan should be within the range of 1 to 4094.This configuration item appears if and only if Translate-And-Add/Add/Add-Double is selected for tag_action, using -1 means that the item is not configured, and the effect will be displayed as --.","format":"int32"},"innerVlanPriority":{"type":"integer","description":"The innerVlanPriority should be within the range of 0 to 7. Only takes effect when Translate-And-Add/Add/Add-Double is selected for tag_action. Using -1 means that the item is not configured, and is displayed as --.","format":"int32"},"etherType":{"type":"string","description":"The Ether Type value ","enum":["NONE","IPV4OE","IPV6OE","PPPOE"]},"inboundTrafficProfileId":{"type":"integer","description":"The inboundTrafficProfileId should be within the range of 1 to 1023 (Traffic profiles that already exist on the system). Using -1 means that the item is not configured, and is displayed as --.","format":"int32"},"outboundTrafficProfileId":{"type":"integer","description":"The outboundTrafficProfileId should be within the range of 1 to 1023 (Traffic profiles that already exist in the system). Using -1 means that the item is not configured, and is displayed as --.","format":"int32"},"statisticPerformance":{"type":"string","description":"The statistic performance ","enum":["DISABLE","ENABLE"]},"adminStatus":{"type":"string","description":"The admin status  ","enum":["DISABLE","ENABLE"]},"description":{"type":"string","description":"The description should be 1-32 characters, including uppercase and lowercase letters, numbers, and underscores."},"creationMode":{"type":"string","description":"The creation mode ","enum":["MANUAL","AUTO"]},"entriesNumber":{"type":"integer","description":"Number of service ports. The entriesNumber should be within the range of 0 to 127.","format":"int32"},"inUse":{"type":"string","description":"Indicate whether the profile has been used ","enum":["DISABLE","ENABLE"]}},"description":"Content"},"ServicePortProfileDetailListQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"searchFields":{"uniqueItems":true,"type":"array","description":"Query Filter Fields:servicePortId,servicePortProfileId,svlan,gemId,userVlan,userVlanPriority,tagAction,innerVlan,innerVlanPriority.","items":{"type":"string","description":"Query Filter Fields:servicePortId,servicePortProfileId,svlan,gemId,userVlan,userVlanPriority,tagAction,innerVlan,innerVlanPriority."}}}},"OperationResponseListServicePortProfileListDetailDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ServicePortProfileListDetailDTO"}}}},"TcontPageQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"size":{"minimum":1,"type":"integer","description":"Page size must be greater or equal to 1,with the default value of 10.","format":"int32"},"number":{"minimum":0,"type":"integer","description":"Current page number must be greater or equal to 0, with a default value of 0.","format":"int32"},"lineProfileId":{"type":"integer","description":"The ID of the associated Line Profile,lineProfile should be within the range of 1 to 512.","format":"int32"}}},"OperationResponsePageResponseTcontVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PageResponseTcontVO"}}},"PageResponseTcontVO":{"type":"object","properties":{"content":{"type":"array","description":"Content","items":{"$ref":"#/components/schemas/TcontVO"}},"totalElements":{"type":"integer","description":"Total elements","format":"int64"},"totalPages":{"type":"integer","description":"Total page number","format":"int32"},"last":{"type":"boolean","description":"Whether is in the last page"},"number":{"type":"integer","description":"Number of the current page,starting from 0.","format":"int32"},"size":{"type":"integer","description":"Page size","format":"int32"},"numberOfElements":{"type":"integer","description":"Actual number of current page","format":"int32"},"first":{"type":"boolean","description":"Whether is in the first page"}}},"TcontVO":{"required":["dbaId","tcontId"],"type":"object","properties":{"tcontId":{"type":"integer","description":"T-cont ID should be within the range of 1 to 127 and should not be null","format":"int32"},"dbaId":{"type":"integer","description":"The DBA template ID bound to the T-cont. DbaId should be a within the range of 0 to 512. Currently existing DBA templates, including DBA system templates, can also be referenced by the T-cont.","format":"int32"},"gemPortIds":{"type":"array","description":"A list of GEM Port IDs bound to this T-Cont.","items":{"type":"integer","description":"A list of GEM Port IDs bound to this T-Cont.","format":"int32"}},"isInUse":{"type":"boolean","description":"Whether the T-cont has been used. If it has been used, it cannot be deleted. True indicates it has been used, while false or null indicates it has not been used. "}},"description":"Content"},"TcontListQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"lineProfileId":{"type":"integer","description":"The ID of the associated Line Profile,lineProfile should be within the range of 1 to 512.","format":"int32"}}},"OperationResponseListTcontVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/TcontVO"}}}},"GemPortPageQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"size":{"minimum":1,"type":"integer","description":"Page size must be greater or equal to 1,with the default value of 10.","format":"int32"},"number":{"minimum":0,"type":"integer","description":"Current page number must be greater or equal to 0, with a default value of 0.","format":"int32"},"lineProfileId":{"type":"integer","description":"The ID of the associated Line Profile,lineProfile should be within the range of 1 to 512.","format":"int32"}}},"OperationResponsePageResponseGemPortDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PageResponseGemPortDTO"}}},"PageResponseGemPortDTO":{"type":"object","properties":{"content":{"type":"array","description":"Content","items":{"$ref":"#/components/schemas/GemPortDTO"}},"totalElements":{"type":"integer","description":"Total elements","format":"int64"},"totalPages":{"type":"integer","description":"Total page number","format":"int32"},"last":{"type":"boolean","description":"Whether is in the last page"},"number":{"type":"integer","description":"Number of the current page,starting from 0.","format":"int32"},"size":{"type":"integer","description":"Page size","format":"int32"},"numberOfElements":{"type":"integer","description":"Actual number of current page","format":"int32"},"first":{"type":"boolean","description":"Whether is in the first page"}}},"GemPortListQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"lineProfileId":{"type":"integer","description":"The ID of the associated Line Profile,lineProfile should be within the range of 1 to 512.","format":"int32"}}},"OperationResponseListGemPortDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/GemPortDTO"}}}},"GemMappingPageQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"size":{"minimum":1,"type":"integer","description":"Page size must be greater or equal to 1,with the default value of 10.","format":"int32"},"number":{"minimum":0,"type":"integer","description":"Current page number must be greater or equal to 0, with a default value of 0.","format":"int32"},"lineProfileId":{"type":"integer","description":"The ID of the associated Line Profile,lineProfile should be within the range of 1 to 512.","format":"int32"}}},"OperationResponsePageResponseGemMappingDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PageResponseGemMappingDTO"}}},"PageResponseGemMappingDTO":{"type":"object","properties":{"content":{"type":"array","description":"Content","items":{"$ref":"#/components/schemas/GemMappingDTO"}},"totalElements":{"type":"integer","description":"Total elements","format":"int64"},"totalPages":{"type":"integer","description":"Total page number","format":"int32"},"last":{"type":"boolean","description":"Whether is in the last page"},"number":{"type":"integer","description":"Number of the current page,starting from 0.","format":"int32"},"size":{"type":"integer","description":"Page size","format":"int32"},"numberOfElements":{"type":"integer","description":"Actual number of current page","format":"int32"},"first":{"type":"boolean","description":"Whether is in the first page"}}},"GemMappingListQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"lineProfileId":{"type":"integer","description":"The ID of the associated Line Profile,lineProfileId should be within the range of 1 to 512.","format":"int32"}}},"OperationResponseListGemMappingDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/GemMappingDTO"}}}},"LineProfilePageQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"size":{"minimum":1,"type":"integer","description":"Page size must be greater or equal to 1,with the default value of 10.","format":"int32"},"number":{"minimum":0,"type":"integer","description":"Current page number must be greater or equal to 0, with a default value of 0.","format":"int32"},"searchFields":{"uniqueItems":true,"type":"array","description":"Search fields","items":{"type":"string","description":"Search fields"}}}},"LineProfileVO":{"required":["mappingMode","upstreamFEC"],"type":"object","properties":{"lineProfileId":{"type":"integer","description":"ID of line profile should be within the range of 1 to 512","format":"int32"},"name":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"The name of the Line template, an optional configuration. If not configured by the user, it will be automatically generated by the device. Name should contain 1 to 32 characters including digits, upper and lower letters, and the following six characters: -@_:/. . It can be left empty; if empty, it will be assigned automatically by the device."},"isSystemProfile":{"type":"boolean","description":"IsSystemProfile should be null, because it's generated by device."},"isInUse":{"type":"string","description":"Whether the Line Profile is in use: if it is in use, deletion is not allowed. True indicates it is in use, while false indicates it is not in use. This field should not be provided."},"upstreamFEC":{"type":"string","description":"Enable/Disable Upstream FEC feature. UpstreamFEC should be a value as follows: DISABLE;ENABLE. Default value: DISABLE.","enum":["DISABLE","ENABLE"]},"mappingMode":{"type":"string","description":"Mapping method for the ONT. MappingMode should be a value as follows: VLAN, PRIORITY, VLAN_PRIORITY, PORT, PORT_VLAN, PORT_PRIORITY, PORT_VLAN_PRIORITY. Default value: VLAN.","enum":["VLAN","PRIORITY","VLAN_PRIORITY","PORT","PORT_VLAN","PORT_PRIORITY","PORT_VLAN_PRIORITY"]},"omccEncrypt":{"type":"string","description":"Whether to enable OMCC encryption feature: when OMCC encryption is enabled, OMCI messages will be encrypted; otherwise, they will not be encrypted. OmccEncrypt should be a value as follows: ENABLE;DISABLE. Default value: DISABLE.","enum":["DISABLE","ENABLE"]},"tcontNum":{"type":"integer","description":"The number of T-conts created under this Line template is non-configurable.","format":"int64"},"gemPortNum":{"type":"integer","description":"The number of gem ports created under this Line template is non-configurable.","format":"int64"}},"description":"Content"},"OperationResponsePageResponseLineProfileVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PageResponseLineProfileVO"}}},"PageResponseLineProfileVO":{"type":"object","properties":{"content":{"type":"array","description":"Content","items":{"$ref":"#/components/schemas/LineProfileVO"}},"totalElements":{"type":"integer","description":"Total elements","format":"int64"},"totalPages":{"type":"integer","description":"Total page number","format":"int32"},"last":{"type":"boolean","description":"Whether is in the last page"},"number":{"type":"integer","description":"Number of the current page,starting from 0.","format":"int32"},"size":{"type":"integer","description":"Page size","format":"int32"},"numberOfElements":{"type":"integer","description":"Actual number of current page","format":"int32"},"first":{"type":"boolean","description":"Whether is in the first page"}}},"LineProfileListQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"searchFields":{"uniqueItems":true,"type":"array","description":"Search fields","items":{"type":"string","description":"Search fields"}}}},"OperationResponseListLineProfileVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/LineProfileVO"}}}},"DBAProfilePageQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"size":{"minimum":1,"type":"integer","description":"Page size must be greater or equal to 1,with the default value of 10.","format":"int32"},"number":{"minimum":0,"type":"integer","description":"Current page number must be greater or equal to 0, with a default value of 0.","format":"int32"},"searchFields":{"uniqueItems":true,"type":"array","description":"SearchFields","items":{"type":"string","description":"SearchFields"}}}},"DBAProfileVO":{"required":["type"],"type":"object","properties":{"dbaId":{"type":"integer","description":"DBA ID should be within the range of 1 to 512.","format":"int32"},"name":{"pattern":"^[a-z0-9A-Z-@_:/.]{1,32}$","type":"string","description":"The name of the DBA profile should contain 1 to 32 characters including digits, upper and lower letters, and the following six characters: -@_:/. ."},"isSystemProfile":{"type":"boolean","description":"IsSystemProfile should be null, because it's generated by device."},"isInUse":{"type":"string","description":"Whether the DBA profile is in use.DBA Profile cannot be deleted if it has already been used. A value of true indicates that it has been used, while false indicates that it has not been used. If this field is not provided, the default value is false."},"type":{"type":"string","description":"DBA bandwidth allocation methods.Type should be a value as follows: FIX, ASSURE, MAX, ASSURE_MAX, and FIX_ASSURE_MAX. The default value is FIX.","enum":["FIX","ASSURE","MAX","ASSURE_MAX","FIX_ASSURE_MAX"]},"fix":{"type":"integer","description":"The value for fixed bandwidth is only required when the Type is set to FIX or FIX_ASSURE_MAX. Fix should be within the range of 128 to 720000, with the unit in kbit/s.","format":"int32"},"assure":{"type":"integer","description":"The value for guaranteed bandwidth is required when the Type is set to ASSURE, ASSURE_MAX, or FIX_ASSURE_MAX. Assure should be within the range of 128 to 1200000, with the unit in kbit/s.","format":"int32"},"max":{"type":"integer","description":"The value for maximum bandwidth is required when the Type is set to MAX, ASSURE_MAX, or FIX_ASSURE_MAX. Max should be within the range of 128 to 1244160, with the unit in kbit/s.","format":"int32"},"tcontNum":{"type":"integer","description":"The number of T-conts using this DBA template is not configurable and will be returned upon inquiry.","format":"int64"}},"description":"Content"},"OperationResponsePageResponseDBAProfileVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PageResponseDBAProfileVO"}}},"PageResponseDBAProfileVO":{"type":"object","properties":{"content":{"type":"array","description":"Content","items":{"$ref":"#/components/schemas/DBAProfileVO"}},"totalElements":{"type":"integer","description":"Total elements","format":"int64"},"totalPages":{"type":"integer","description":"Total page number","format":"int32"},"last":{"type":"boolean","description":"Whether is in the last page"},"number":{"type":"integer","description":"Number of the current page,starting from 0.","format":"int32"},"size":{"type":"integer","description":"Page size","format":"int32"},"numberOfElements":{"type":"integer","description":"Actual number of current page","format":"int32"},"first":{"type":"boolean","description":"Whether is in the first page"}}},"DBAProfileListQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"searchFields":{"uniqueItems":true,"type":"array","description":"Search fields.","items":{"type":"string","description":"Search fields."}}}},"OperationResponseListDBAProfileVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/DBAProfileVO"}}}},"BaseDevicePageQueryRequest":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"size":{"minimum":1,"type":"integer","description":"Page size must be greater or equal to 1,with the default value of 10.","format":"int32"},"number":{"minimum":0,"type":"integer","description":"Current page number must be greater or equal to 0, with a default value of 0.","format":"int32"}}},"OperationResponsePageResponsePonPortInformationDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PageResponsePonPortInformationDTO"}}},"PageResponsePonPortInformationDTO":{"type":"object","properties":{"content":{"type":"array","description":"Content","items":{"$ref":"#/components/schemas/PonPortInformationDTO"}},"totalElements":{"type":"integer","description":"Total elements","format":"int64"},"totalPages":{"type":"integer","description":"Total page number","format":"int32"},"last":{"type":"boolean","description":"Whether is in the last page"},"number":{"type":"integer","description":"Number of the current page,starting from 0.","format":"int32"},"size":{"type":"integer","description":"Page size","format":"int32"},"numberOfElements":{"type":"integer","description":"Actual number of current page","format":"int32"},"first":{"type":"boolean","description":"Whether is in the first page"}}},"PonPortInformationDTO":{"type":"object","properties":{"portId":{"type":"string","description":"OLT port id"},"onuNum":{"type":"integer","description":"The number of successfully registered ONU devices on this port, onuNum should be within the range of 0 to 128.","format":"int32"},"status":{"type":"string","description":"Whether to enable the laser for the PON port.Status should be a value as follows:DISABLE,ENABLE.","enum":["DISABLE","ENABLE"]},"maxBandwidth":{"type":"integer","description":"Maximum usable bandwidth of the PON port: 0 to 1310720 kbps.","format":"int32"},"actualBandwidth":{"type":"integer","description":"Actual usable bandwidth of the PON port: 0 to 1310720 kbps.","format":"int32"},"remainBandwidth":{"type":"integer","description":"Remaining usable bandwidth of the PON port: 0 to 1310720 kbps.","format":"int32"},"opticalVcc":{"type":"string","description":"PON port optical voltage, in V."},"opticalBias":{"type":"string","description":"PON port optical current, in mA."},"opticalPower":{"type":"string","description":"PON port power, in dBm."}},"description":"Content"},"OperationResponseListPonPortInformationDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/PonPortInformationDTO"}}}},"OperationResponsePageResponsePonPortDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PageResponsePonPortDTO"}}},"PageResponsePonPortDTO":{"type":"object","properties":{"content":{"type":"array","description":"Content","items":{"$ref":"#/components/schemas/PonPortDTO"}},"totalElements":{"type":"integer","description":"Total elements","format":"int64"},"totalPages":{"type":"integer","description":"Total page number","format":"int32"},"last":{"type":"boolean","description":"Whether is in the last page"},"number":{"type":"integer","description":"Number of the current page,starting from 0.","format":"int32"},"size":{"type":"integer","description":"Page size","format":"int32"},"numberOfElements":{"type":"integer","description":"Actual number of current page","format":"int32"},"first":{"type":"boolean","description":"Whether is in the first page"}}},"PonPortDTO":{"type":"object","properties":{"portId":{"type":"string","description":"Port ID"},"status":{"type":"string","description":"Whether to enable the laser for the PON port.Status should be a value as follows:DISABLE,ENABLE.","enum":["DISABLE","ENABLE"]},"downstreamFEC":{"type":"string","description":"Whether to start downstream FEC function of the port.DownstreamFEC should be a value as follows:DISABLE,ENABLE.","enum":["DISABLE","ENABLE"]},"keyExchangePeriod":{"type":"integer","description":"Configure the downstream encryption ONT key update time. KeyExchangePeriod should be a value between 0 to 60 minutes, where 0 means key update is disabled.","format":"int32"},"dbaCalculateMode":{"type":"string","description":"Configure the DBA calculation cycle mode. DbaCalculateMode should be a value as follows: MIN_DELAY:In minimum delay mode, the DBA calculation cycle is related to the number of T-CONTs. The more T-CONTs there are, the longer the calculation cycle. Under the premise that the bandwidth can complete the calculation, it is advisable to use as few calculation cycles as possible. When dealing with TDM services, the minimum delay mode must be selected; MAX_BW:In maximum bandwidth utilization mode, the DBA calculation cycle is allocated over multiple frames, with each frame lasting 125 µs. This method is suitable when the service does not have high delay requirements.","enum":["MIN_DELAY","MAX_BW"]},"maxDistance":{"type":"integer","description":"The maximum logical distance of the ONT.MaxDistance should be within the range of 1 to 60 (km). The difference between the maximum logical distance and the minimum logical distance must not exceed 40 km.","format":"int32"},"minDistance":{"type":"integer","description":"The minimum logical distance of the ONT.MinDistance should be within the range of 1 to 40 (km). The difference between the maximum logical distance and the minimum logical distance must not exceed 40 km.","format":"int32"},"portIsolate":{"type":"string","description":"Set port isolation function.(only DS-P7001-04、DS-P7001-08 OLT support this function,other olts should not provide or display this field)When enabled, the port cannot communicate with other ports, and the ONU on this port cannot communicate with ONUs on other ports.PortIsolation should be a value as follows:DISABLE,ENABLE.","enum":["DISABLE","ENABLE"]},"onuIsolate":{"type":"string","description":"Set ONU isolation function.(only DS-P7001-04、DS-P7001-08 OLT support this function,other olts should not provide or display this field)When enabled, different ONUs on the same port cannot communicate with each other.OnuIsolate should be a value as follows:DISABLE,ENABLE.","enum":["DISABLE","ENABLE"]},"longLaserOnuAutoDetect":{"type":"string","description":"Whether to enable port rogue ONU automatic detection function.LongLaserOnuAutoDetect should be a value as follows:DISABLE,ENABLE.Default value:DISABLE","enum":["DISABLE","ENABLE"]},"autoDetectInterval":{"type":"integer","description":"Set the interval time for port traffic ONU detection, unit: minutes.AutoDetectInternal should be within the range of 1 to 100.Default value:15","format":"int32"},"type":{"type":"string","description":"Pon port type,type should be a value as follows:COPPER,COMBO,SFP","enum":["COPPER","COMBO","SFP"]},"linkStatus":{"type":"string","description":"Pon port link status.LinkStatus should be a value as follows:INACTIVE,ACTIVE_WORKING,ACTIVE_WORKING_NONE,ACTIVE_STANDBY","enum":["INACTIVE","ACTIVE_WORKING","ACTIVE_WORKING_NONE","ACTIVE_STANDBY"]},"duplexLink":{"type":"string","description":"Duplex mode.DuplexLink should be a value as follows:FULL","enum":["FULL"]},"speed":{"type":"string","description":"Speed configured by customer.Speed should be a value as follows:GPON,XG_PON,XGS_PON,NONE","enum":["GPON","XG_PON","XGS_PON","NONE"]},"upLinkSpeed":{"type":"integer","description":"The upstream rate of the PON port, unit: M. The range of values varies by model.","format":"int32"},"downLinkSpeed":{"type":"integer","description":"The downstream rate of the PON port. The range of values varies by model.","format":"int32"},"longLaserOnuAutoIsolate":{"type":"string","description":"Whether to enable port rogue ONU automatic isolation function.LongLaserOnuAutoIsolate should be a value as follows:DISABLE,ENABLE.Default value:DISABLE","enum":["DISABLE","ENABLE"]},"downlinkList":{"type":"array","description":"Down link device list","items":{"$ref":"#/components/schemas/DeviceVO"}},"onuNum":{"type":"integer","description":"Online ONU number","format":"int32"}},"description":"Content"},"OperationResponseListPonPortDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/PonPortDTO"}}}},"OnuRegisterAutoFindPageQueryRequestDTO":{"required":["ponPort"],"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"size":{"minimum":1,"type":"integer","description":"Page size must be greater or equal to 1,with the default value of 10.","format":"int32"},"number":{"minimum":0,"type":"integer","description":"Current page number must be greater or equal to 0, with a default value of 0.","format":"int32"},"searchFields":{"uniqueItems":true,"type":"array","description":"Fields to search","items":{"type":"string","description":"Fields to search"}},"ponPort":{"type":"string","description":"Pon port collection.e.g.,'GPON 1/1/1'、'GPON 1/1/1-3'、'GPON 1/1/1-3,GPON 1/1/5,GPON 1/1/7-8'"}}},"OnuAutofindConfigDTO":{"type":"object","properties":{"key":{"type":"string","description":"Unique identifier for entry"},"portId":{"type":"string","description":"Automatic discovery of the PON port ID corresponding to the ONT"},"serialNumber":{"type":"string","description":"SerialNumber of ONU, serialNumber should contain 12, 13, or 16 characters, in the format XXXXXXXXXXXX,XXXX-XXXXXXXX,XXXXXXXXXXXXXXXX"},"macAddress":{"type":"string","description":"Mac address of ONU"},"passwordType":{"type":"string","description":"Indicates the password type reported by the automatic discovery of the ONT.PasswordType should be a value as follows：ASCII,HEX","enum":["ASCII","HEX"]},"password":{"type":"string","description":"Authentication password set by automatic discovery of the ONT, password should contain ASCII characters from \\x21 to \\x7e and 1 to 20 hexadecimal digits"},"loid":{"type":"string","description":"Loid set by automatic discovery of the ONT, loid should be 1-32 characters, including letters, numbers, and symbols (-@_:/.)."},"loidPassword":{"type":"string","description":"Loid password set by automatic discovery of the ONT,loidPassword should contain ASCII characters from \\x21 to \\x7e"},"hardwareVersion":{"type":"string","description":"Hardware version of the automatically discovered ONT"},"softwareVersion":{"type":"string","description":"Software version of the automatically discovered ONT"},"vendorId":{"type":"string","description":"Matching ONT vendor ID, vendorId should contain 1 to 4 ASCII characters from \\x21 to \\x7e"},"equipmentId":{"type":"string","description":"ONT device ID should contain 1 to 20 characters in ASCII code from \\x21 to \\x7e."}},"description":"Content"},"OperationResponsePageResponseOnuAutofindConfigDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PageResponseOnuAutofindConfigDTO"}}},"PageResponseOnuAutofindConfigDTO":{"type":"object","properties":{"content":{"type":"array","description":"Content","items":{"$ref":"#/components/schemas/OnuAutofindConfigDTO"}},"totalElements":{"type":"integer","description":"Total elements","format":"int64"},"totalPages":{"type":"integer","description":"Total page number","format":"int32"},"last":{"type":"boolean","description":"Whether is in the last page"},"number":{"type":"integer","description":"Number of the current page,starting from 0.","format":"int32"},"size":{"type":"integer","description":"Page size","format":"int32"},"numberOfElements":{"type":"integer","description":"Actual number of current page","format":"int32"},"first":{"type":"boolean","description":"Whether is in the first page"}}},"OperationResponseListOnuAutofindConfigDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/OnuAutofindConfigDTO"}}}},"OperationResponseAutofindConfigDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AutofindConfigDTO"}}},"OnuRegisterAuthenticationPageQueryRequestDTO":{"required":["ponPort"],"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"size":{"minimum":1,"type":"integer","description":"Page size must be greater or equal to 1,with the default value of 10.","format":"int32"},"number":{"minimum":0,"type":"integer","description":"Current page number must be greater or equal to 0, with a default value of 0.","format":"int32"},"ponPort":{"type":"string","description":"Pon port.e.g.GPON 1/0/1"}}},"OperationResponsePageResponsePonAutoAuthenticationRuleConfigDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PageResponsePonAutoAuthenticationRuleConfigDTO"}}},"PageResponsePonAutoAuthenticationRuleConfigDTO":{"type":"object","properties":{"content":{"type":"array","description":"Content","items":{"$ref":"#/components/schemas/PonAutoAuthenticationRuleConfigDTO"}},"totalElements":{"type":"integer","description":"Total elements","format":"int64"},"totalPages":{"type":"integer","description":"Total page number","format":"int32"},"last":{"type":"boolean","description":"Whether is in the last page"},"number":{"type":"integer","description":"Number of the current page,starting from 0.","format":"int32"},"size":{"type":"integer","description":"Page size","format":"int32"},"numberOfElements":{"type":"integer","description":"Actual number of current page","format":"int32"},"first":{"type":"boolean","description":"Whether is in the first page"}}},"OperationResponseListPonAutoAuthenticationRuleConfigDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/PonAutoAuthenticationRuleConfigDTO"}}}},"PonPortRequestDTO":{"required":["ponPort"],"type":"object","properties":{"ponPort":{"type":"string","description":"Pon port.e.g.GPON 1/0/1"}}},"OperationResponsePonAutoAuthenticationConfigDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PonAutoAuthenticationConfigDTO"}}},"OperationResponseAutoAuthenticationConfigDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AutoAuthenticationConfigDTO"}}},"OnuRegisterAuthenPageQueryRequestDTO":{"required":["ponPort"],"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"size":{"minimum":1,"type":"integer","description":"Page size must be greater or equal to 1,with the default value of 10.","format":"int32"},"number":{"minimum":0,"type":"integer","description":"Current page number must be greater or equal to 0, with a default value of 0.","format":"int32"},"searchFields":{"uniqueItems":true,"type":"array","description":"Fields to search","items":{"type":"string","description":"Fields to search"}},"ponPort":{"type":"string","description":"Pon port collection.e.g.,'GPON 1/1/1'、'GPON 1/1/1-3'、'GPON 1/1/1-3,GPON 1/1/5,GPON 1/1/7-8'"}}},"AuthenticationConfigDTO":{"type":"object","properties":{"key":{"type":"string","description":"Identifier of entry"},"portId":{"type":"string","description":"Pon port ID,e.g.,PON 1/0/1"},"onuId":{"type":"integer","description":"ONU ID,This parameter is optional. If not specified, the system will automatically allocate the smallest available ONU number under the current port.OnuId should be within the range of 0 to 127","format":"int32"},"description":{"type":"string","description":"Description of ONU.Only 1-32 bits numbers, Upper and lower letters, -@_:/. are allowed."},"serialNumber":{"type":"string","description":"SerialNumber of ONU should contain 12, 13, or 16 characters, in the format XXXXXXXXXXXX ,XXXX-XXXXXXXX,XXXXXXXXXXXXXXXX"},"macAddress":{"type":"string","description":"Mac address of ONU"},"passwordType":{"type":"string","description":"Indicates the password type reported by the automatic discovery of the ONT.PasswordType should be a value as follows：ASCII,HEX","enum":["ASCII","HEX"]},"password":{"type":"string","description":"Authentication password set by automatic discovery of the ONT, password should be ASCII characters from \\x21 to \\x7e and 1 to 20 hexadecimal digits"},"loid":{"type":"string","description":"Loid set by automatic discovery of the ONT, loid should be 1-32 characters, including letters, numbers, and symbols (-@_:/.)."},"loidPassword":{"type":"string","description":"Loid password set by automatic discovery of the ONT,loidPassword should be ASCII characters from \\x21 to \\x7e"},"lineProfile":{"type":"string","description":"Line profile bound to the ONU, lineProfile is displayed in the format id(name)"},"serviceProfile":{"type":"string","description":"Service profile bound to the ONU, serviceProfile displayed in the format id(name)"},"adminStatus":{"type":"string","description":"Admin status should be a value as follows:ACTIVATE,DEACTIVATE","enum":["ACTIVATE","DEACTIVATE","ACTIVATED","DEACTIVATED"]},"onlineStatus":{"type":"string","description":"Online status should be a value as follows:ONLINE: ONU is online.OFFLINE: ONU is offline; it does not support version information queries or any service operations.","enum":["ONLINE","OFFLINE"]},"configStatus":{"type":"string","description":"Config status should be a value as follows:SUCCESS: Configuration successfully delivered and recognized by the ONU.FAILED: Configuration not successfully delivered or not recognized by the ONU.","enum":["SUCCESS","FAILED"]},"matchStatus":{"type":"string","description":"Match status should be a value as follows:MATCH: ONU hardware capabilities are consistent with the bound service template.MISMATCH: ONU hardware capabilities are inconsistent with the bound service template.","enum":["MATCH","MISMATCH"]},"activeStatus":{"type":"string","description":"Active status should be a value as follows:ACTIVE: ONU is in an active state, capable of data communication and supporting services.INACTIVE: ONU is in an inactive state, which may be due to reasons such as unactivated configuration, being offline, configuration failure, or configuration mismatch.","enum":["ACTIVE","INACTIVE"]},"authenticationMethod":{"type":"string","description":"Authentication mode used by the automatically discovered ONU.AuthenticationMethod should be a value as follows:PASSWORD_AUTH,SN_AUTH,LOID_AUTH,SN_AND_PASSWORD_AUTH,LOID_AND_PASSWORD_AUTH","enum":["PASSWORD_AUTH","SN_AUTH","LOID_AUTH","SN_AND_PASSWORD_AUTH","LOID_AND_PASSWORD_AUTH"]},"reRegisterAuthentication":{"type":"string","description":"Re-Register-Authentication"},"discoveryMode":{"type":"string","description":"ONU auto discovery mode.DiscoveryMode should be a value as follows:ALWAYS_ON,ONCE_ON ","enum":["ALWAYS_ON","ONCE_ON"]},"servicePortProfile":{"type":"string","description":"Service port profile bound to the ONU is  in the format id(name)"}},"description":"Content"},"OperationResponsePageResponseAuthenticationConfigDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PageResponseAuthenticationConfigDTO"}}},"PageResponseAuthenticationConfigDTO":{"type":"object","properties":{"content":{"type":"array","description":"Content","items":{"$ref":"#/components/schemas/AuthenticationConfigDTO"}},"totalElements":{"type":"integer","description":"Total elements","format":"int64"},"totalPages":{"type":"integer","description":"Total page number","format":"int32"},"last":{"type":"boolean","description":"Whether is in the last page"},"number":{"type":"integer","description":"Number of the current page,starting from 0.","format":"int32"},"size":{"type":"integer","description":"Page size","format":"int32"},"numberOfElements":{"type":"integer","description":"Actual number of current page","format":"int32"},"first":{"type":"boolean","description":"Whether is in the first page"}}},"OperationResponseListAuthenticationConfigDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/AuthenticationConfigDTO"}}}},"OnuInformationRebootStatusConfigDTO":{"type":"object","properties":{"key":{"type":"string","description":"Identifier of ONU"},"onlineStatus":{"type":"string","description":"Online status should be a value as follows:ONLINE,OFFLINE,UPGRADING","enum":["ONLINE","OFFLINE","SUCCESSFUL","UPGRADING","FAILED","WAITING_UPGRADE"]}}},"OperationResponseListOnuInformationRebootStatusConfigDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/OnuInformationRebootStatusConfigDTO"}}}},"OnuManagementPageQueryRequestDTO":{"required":["ponPort"],"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"size":{"minimum":1,"type":"integer","description":"Page size must be greater or equal to 1,with the default value of 10.","format":"int32"},"number":{"minimum":0,"type":"integer","description":"Current page number must be greater or equal to 0, with a default value of 0.","format":"int32"},"searchFields":{"uniqueItems":true,"type":"array","description":"Fields to search","items":{"type":"string","description":"Fields to search"}},"ponPort":{"type":"string","description":"Pon port collection.e.g.,'GPON 1/1/1'、'GPON 1/1/1-3'、'GPON 1/1/1-3,GPON 1/1/5,GPON 1/1/7-8'"}}},"OnuInformationConfigDTO":{"type":"object","properties":{"key":{"type":"string","description":"Identifier of ONU"},"ponPortId":{"type":"integer","description":"PON port ID of the registered and online ONT","format":"int32"},"ponPortStr":{"type":"string","description":"String form of pon port.e.g.,PON 1/2/1"},"onuId":{"type":"integer","description":"Onu Id should be within the range of 0 to 127","format":"int32"},"onuDescription":{"type":"string","description":"Description of ONU.OnuDescription should be 1-32 characters, including letters, numbers, and symbols (-@_:/.)."},"serialNumber":{"type":"string","description":"SerialNumber should contain 12, 13, or 16 characters, formatted as `XXXXXXXXXXXX`,'XXXX-XXXXXXXX','XXXXXXXXXXXXXXXX'."},"macAddress":{"type":"string","description":"Mac address of ONU"},"lineProfile":{"type":"string","description":"Line profile.Display in the format: Line_Profile_Name + Line_Profile_ID."},"serviceProfile":{"type":"string","description":"Service profile.Display in the format: Service_Profile_Name + Service_Profile_ID."},"servicePortProfile":{"type":"string","description":"Service port profile.Display in the format: Service_Port_Profile_Name + Service_Port_Profile_ID."},"adminStatus":{"type":"string","description":"Admin status should be a value as follows:ACTIVATE,DEACTIVATE","enum":["ACTIVATE","DEACTIVATE","ACTIVATED","DEACTIVATED"]},"onlineStatus":{"type":"string","description":"Online status should be a value as follows:ONLINE,OFFLINE","enum":["ONLINE","OFFLINE","SUCCESSFUL","UPGRADING","FAILED","WAITING_UPGRADE"]},"configStatus":{"type":"string","description":"Config status should be a value as follows:SUCCESS: Configuration successfully delivered and recognized by the ONU.FAILED: Configuration not successfully delivered or not recognized by the ONU.","enum":["SUCCESS","FAILED"]},"matchStatus":{"type":"string","description":"Match status should be a value as follows:MATCH: ONU hardware capabilities are consistent with the bound service template.MISMATCH: ONU hardware capabilities are inconsistent with the bound service template.","enum":["MATCH","MISMATCH"]},"activeStatus":{"type":"string","description":"Active status should be a value as follows:ACTIVE: ONU is in an active state, capable of data communication and carrying services.\nINACTIVE: ONU is in an inactive state, possibly due to unactivated configuration, being offline, configuration failure, or mismatched configuration.","enum":["ACTIVE","INACTIVE"]},"equipmentId":{"type":"string","description":"Matched ONU device ID, equipmentId should contain 1 to 20 characters in ASCII code from \\x21 to \\x7e."},"softwareVersion":{"$ref":"#/components/schemas/OnuInformationConfigDTO"},"hardwareVersion":{"type":"string","description":"Hardware version of the ONU, hardwareVersion should contain 1 to 20 characters, including uppercase and lowercase letters, numbers, and the symbols -@_:/. "},"receivedOpticalPower":{"type":"string","description":"ONU's received power, in dBm."},"transmittedOpticalPower":{"type":"string","description":"ONU's transmission power, in dBm."},"softWareVersion":{"type":"string"}},"description":"Content"},"OperationResponsePageResponseOnuInformationConfigDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PageResponseOnuInformationConfigDTO"}}},"PageResponseOnuInformationConfigDTO":{"type":"object","properties":{"content":{"type":"array","description":"Content","items":{"$ref":"#/components/schemas/OnuInformationConfigDTO"}},"totalElements":{"type":"integer","description":"Total elements","format":"int64"},"totalPages":{"type":"integer","description":"Total page number","format":"int32"},"last":{"type":"boolean","description":"Whether is in the last page"},"number":{"type":"integer","description":"Number of the current page,starting from 0.","format":"int32"},"size":{"type":"integer","description":"Page size","format":"int32"},"numberOfElements":{"type":"integer","description":"Actual number of current page","format":"int32"},"first":{"type":"boolean","description":"Whether is in the first page"}}},"OnuManagementListQueryRequestDTO":{"required":["ponPort"],"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"searchFields":{"uniqueItems":true,"type":"array","description":"Query filter fields.","items":{"type":"string","description":"Query filter fields."}},"ponPort":{"type":"string","description":"Pon port collection.e.g.,'GPON 1/1/1'、'GPON 1/1/1-3'、'GPON 1/1/1-3,GPON 1/1/5,GPON 1/1/7-8'"}}},"OperationResponseListOnuInformationConfigDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/OnuInformationConfigDTO"}}}},"OnuInfoDetailRequestDTO":{"required":["key"],"type":"object","properties":{"key":{"type":"string","description":"Identifier of ONU"}}},"BasicDetailConfigDTO":{"required":["equipmentId"],"type":"object","properties":{"onuDescription":{"type":"string","description":"ONU description.onuDescription should contain 0 to 32 characters, including uppercase and lowercase letters, numbers, and the symbols -@_:/. "},"serialNumber":{"type":"string","description":"SerialNumber of ONU should contain 12, 13, or 16 characters, in the format XXXXXXXXXXXX ,XXXX-XXXXXXXX,XXXXXXXXXXXXXXXX"},"macAddress":{"type":"string","description":"Mac address of ONU"},"vendorId":{"type":"string","description":"The matching ONT vendor ID,vendorId should contain 1 to 4 characters in ASCII, with character range from \\x21 to \\x7e."},"equipmentId":{"type":"string","description":"ONT device ID should contain 1 to 20 characters in ASCII code from \\x21 to \\x7e."},"adminStatus":{"type":"string","description":"Admin status should be a value as follows:ACTIVATE,DEACTIVATE","enum":["ACTIVATE","DEACTIVATE","ACTIVATED","DEACTIVATED"]},"onlineStatus":{"type":"string","description":"Online status should be a value as follows:ONLINE,OFFLINE,UPGRADING","enum":["ONLINE","OFFLINE","SUCCESSFUL","UPGRADING","FAILED","WAITING_UPGRADE"]},"configStatus":{"type":"string","description":"Config status should be a value as follows:SUCCESS: Configuration successfully delivered and recognized by the ONU.FAILED: Configuration not successfully delivered or not recognized by the ONU.","enum":["SUCCESS","FAILED"]},"matchStatus":{"type":"string","description":"Match status should be a value as follows:MATCH: ONU hardware capabilities are consistent with the bound service template.MISMATCH: ONU hardware capabilities are inconsistent with the bound service template.","enum":["MATCH","MISMATCH"]},"activeStatus":{"type":"string","description":"Active status should be a value as follows:ACTIVE: ONU is in an active state, capable of data communication and carrying services.\nINACTIVE: ONU is in an inactive state, possibly due to unactivated configuration, being offline, configuration failure, or mismatched configuration.","enum":["ACTIVE","INACTIVE"]},"onuDistance":{"type":"integer","description":"Distance between ONU and OLT should be within the range of  0 to 20,000 m","format":"int32"},"onlineTime":{"type":"string","description":"Duration of ONU registration and online status, format: hh:mm:ss."},"hardwareVersion":{"type":"string","description":"Hardware version of the ONU, hardwareVersion should contain 1 to 20 characters, including uppercase and lowercase letters, numbers, and the symbols -@_:/. "},"lineProfile":{"type":"string","description":"LineProfile is displayed in the format id(name)"},"serviceProfile":{"type":"string","description":"ServiceProfile is displayed in the format id(name)"}}},"CapabilityDetailConfigDTO":{"type":"object","properties":{"omccVersion":{"type":"string","description":"OmccVersion should contain uppercase and lowercase letters, numbers, and the symbols -@_:/."},"totalEthNumber":{"type":"integer","description":"The number of Ethernet ports on the ONU, totalEthNumber should be within the range of 0 to 24. ","format":"int32"},"totalVoipNumber":{"type":"integer","description":"The number of VoIP ports on the ONU, totalVoipNumber should be within the range of 0 to 4.","format":"int32"},"totalGemPortNumber":{"type":"integer","description":"The number of configured GEM Ports,totalGemPortNumber should be within the range of 0 to 31.","format":"int32"},"totalTcontNumber":{"type":"integer","description":"The number of configured T-conts, totalTcontNumber should be within the range of 0 to 8.","format":"int32"}}},"OnuDetailConfigDTO":{"type":"object","properties":{"onuBasicInformation":{"$ref":"#/components/schemas/BasicDetailConfigDTO"},"onuCapabilityInformation":{"$ref":"#/components/schemas/CapabilityDetailConfigDTO"},"onuOpticalLinkInformation":{"$ref":"#/components/schemas/OpticalLinkDetailConfigDTO"},"onuSoftwareInformation":{"$ref":"#/components/schemas/SoftwareDetailConfigDTO"}}},"OperationResponseOnuDetailConfigDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OnuDetailConfigDTO"}}},"OpticalLinkDetailConfigDTO":{"type":"object","properties":{"receivedOpticalPower":{"type":"number","description":"ONU's received power, in dBm.","format":"double"},"transmittedOpticalPower":{"type":"number","description":"ONU's transmission power, in dBm.","format":"double"},"biasCurrent":{"type":"number","description":"ONU's bias current, in mA.","format":"double"},"workingVoltage":{"type":"integer","description":"ONU's working voltage, in mV.","format":"int32"},"workingTemperature":{"type":"number","description":"ONU's operating temperature, in °C.","format":"double"}}},"SoftwareDetailConfigDTO":{"type":"object","properties":{"software0Version":{"type":"string","description":"Software0 version should contain 1 to 14 ASCII characters."},"software0Valid":{"type":"string","description":"Validity of ONU software 0.Software0Valid should be a value as follows:VALID,INVALID","enum":["VALID","INVALID"]},"software0Active":{"type":"string","description":"Status of ONU software 0.Software0Active should be a value as follows:ACTIVE,INACTIVE","enum":["ACTIVE","INACTIVE"]},"software0Commited":{"type":"string","description":"Commit status of ONU software 0.Software0Commited should be a value as follows:COMMITED,UNCOMMITED","enum":["COMMITTED","UNCOMMITTED"]},"software1Version":{"type":"string","description":"Software1 version should contain 1 to 14 ASCII characters."},"software1Valid":{"type":"string","description":"Validity of ONU software 1.software1Valid should be a value as follows:VALID,INVALID","enum":["VALID","INVALID"]},"software1Active":{"type":"string","description":"Status of ONU software 1.software1Active should be a value as follows:ACTIVE,INACTIVE","enum":["ACTIVE","INACTIVE"]},"software1Commited":{"type":"string","description":"Commit status of ONU software 1.Software1Commited should be a value as follows:COMMITED,UNCOMMITED","enum":["COMMITTED","UNCOMMITTED"]}}},"OperationResponseOnuIsolationStatusDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OnuIsolationStatusDTO"}}},"OnuGlobalConfigStatusDTO":{"type":"object","properties":{"onuIsolation":{"type":"string","description":"Whether to enable ONU isolation,onuIsolation should be a value as follows:ENABLE,DISABLE","enum":["DISABLE","ENABLE"]},"supportOnuIsolation":{"type":"string","description":"Whether the ONU support isolation.SupportOnuIsolation should be a value as follows:ENABLE,DISABLE","enum":["DISABLE","ENABLE"]}}},"OperationResponseOnuGlobalConfigStatusDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OnuGlobalConfigStatusDTO"}}},"AutoServicePortQueryDTO":{"type":"object","properties":{"searchKey":{"type":"string","description":"Query conditions."},"sorts":{"type":"array","description":"Sorting fields.","items":{"$ref":"#/components/schemas/QuerySort"}},"size":{"minimum":1,"type":"integer","description":"Page size must be greater or equal to 1,with the default value of 10.","format":"int32"},"number":{"minimum":0,"type":"integer","description":"Current page number must be greater or equal to 0, with a default value of 0.","format":"int32"},"searchField":{"type":"string","description":"Field to search"}}},"AutoServicePortVO":{"type":"object","properties":{"autoMode":{"type":"string","description":"AutoMOde should be a value as follows:Disable,Enable","enum":["DISABLE","ENABLE"]},"ponPortId":{"type":"integer","description":"PonPortId should be within the range of 1 to 16","format":"int32"},"ponPortStr":{"type":"string","description":"String form of pon port"},"svlan":{"type":"integer","description":"SVlan should be within the range of 1 to 4095","format":"int32"},"gemPortId":{"type":"integer","description":"GemPortId should be within the range of 1 to 1023","format":"int32"},"userVlan":{"type":"integer","description":"UserVlan should be within the range of 0 to 4095","format":"int32"},"userVlanPriority":{"type":"string","description":"UserVlanPriority should be within the range of -1 to 7"},"tagAction":{"type":"string","description":"TagAction should be a value as follows:DEFAULT,TRANSPARENT,TRANSLATE,TRANSLATE_AND_ADD,ADD_DOUBLE","enum":["DEFAULT","TRANSPARENT","TRANSLATE","TRANSLATE_AND_ADD","ADD_DOUBLE"]},"innerVlan":{"type":"integer","description":"InnerVlan should be within the range of 0 to 4095","format":"int32"},"innerVlanPriority":{"type":"string","description":"InnerVlanPriority should be within the range of -1 to 7"},"etherType":{"type":"string","description":"EtherType should be a value as follows:NONE,IPV4OE,IPV6OE,PPPOE","enum":["NONE","IPV4OE","IPV6OE","PPPOE"]},"inboundTrafficProfileId":{"type":"string","description":"InboundTrafficProfileId should be within the range of 0 to 512"},"outboundTrafficProfileId":{"type":"string","description":"OutboundTrafficProfileId should be within the range of 0 to 512"}},"description":"Content"},"OperationResponsePageResponseAutoServicePortVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PageResponseAutoServicePortVO"}}},"PageResponseAutoServicePortVO":{"type":"object","properties":{"content":{"type":"array","description":"Content","items":{"$ref":"#/components/schemas/AutoServicePortVO"}},"totalElements":{"type":"integer","description":"Total elements","format":"int64"},"totalPages":{"type":"integer","description":"Total page number","format":"int32"},"last":{"type":"boolean","description":"Whether is in the last page"},"number":{"type":"integer","description":"Number of the current page,starting from 0.","format":"int32"},"size":{"type":"integer","description":"Page size","format":"int32"},"numberOfElements":{"type":"integer","description":"Actual number of current page","format":"int32"},"first":{"type":"boolean","description":"Whether is in the first page"}}},"OperationResponseListAutoServicePortVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/AutoServicePortVO"}}}},"OperationResponseListEthUnit1PortAppDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/EthUnit1PortAppDTO"}}}},"OperationResponseListEthLagPortAppDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/EthLagPortAppDTO"}}}},"EthAndPonListDTO":{"type":"object","properties":{"ethUnit1PortDTOList":{"type":"array","description":"Eth unit1 port list","items":{"$ref":"#/components/schemas/EthUnit1PortDTO"}},"ponPortDTOList":{"type":"array","description":"Pon port list","items":{"$ref":"#/components/schemas/PonPortDTO"}}}},"EthUnit1PortDTO":{"required":["port"],"type":"object","properties":{"port":{"type":"string"},"mediaType":{"type":"string","enum":["FIBER","COPPER"]},"description":{"pattern":"^[a-z0-9A-Z-@_:/.]{0,32}$","type":"string"},"status":{"type":"string","enum":["DISABLE","ENABLE"]},"speed":{"type":"integer","format":"int32"},"duplex":{"type":"string","enum":["FULL","HALF","AUTO"]},"flowControl":{"type":"string","enum":["DISABLE","ENABLE"]},"lag":{"type":"string"},"speedLink":{"type":"integer","format":"int32"},"duplexLink":{"type":"string","enum":["FULL","HALF","AUTO"]},"linkStatus":{"type":"string","enum":["LINK_UP","LINK_DOWN"]},"type":{"type":"string","enum":["COPPER","COMBO","SFP","SFP+","RJ45"]},"speedMax":{"type":"integer","format":"int32"}},"description":"Eth unit1 port list"},"OperationResponseEthAndPonListDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/EthAndPonListDTO"}}},"OperationResponseVlanNetworkDeliverDataVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VlanNetworkDeliverDataVO"}}},"VlanNetworkDeliverDataVO":{"type":"object","properties":{"successDevices":{"type":"array","description":"Successfully delivered devices","items":{"type":"string","description":"Successfully delivered devices"}},"successStacks":{"type":"array","description":"Successfully delivered stacks","items":{"type":"string","description":"Successfully delivered stacks"}},"failDevices":{"type":"array","description":"Failed devices","items":{"type":"string","description":"Failed devices"}},"failStacks":{"type":"array","description":"Failed stacks","items":{"type":"string","description":"Failed stacks"}},"deliveringDevices":{"type":"array","description":"Delivering devices","items":{"type":"string","description":"Delivering devices"}},"deliveringStacks":{"type":"array","description":"Delivering stacks","items":{"type":"string","description":"Delivering stacks"}},"doneDevicesNum":{"type":"integer","description":"Delivered device num","format":"int32"},"totalDevicesNum":{"type":"integer","description":"Total device num","format":"int32"},"state":{"type":"integer","description":"Delivering state. 0: free ( it means the network has been already delivered)  1: delivering 2. deliver done.","format":"int32"},"lanNetwork":{"$ref":"#/components/schemas/LanNetworkVO"},"affectedDeviceList":{"type":"array","description":"Affected device list","items":{"$ref":"#/components/schemas/SelectDeviceForVlanVO"}},"affectedStackList":{"type":"array","description":"Affected stack list","items":{"$ref":"#/components/schemas/SelectStackForVlanVO"}},"deviceConfig":{"$ref":"#/components/schemas/SelectPortBindingBriefVO"}}},"DhcpServerDevCapForVlanVO":{"type":"object","properties":{"supportGetDhcpClientTable":{"type":"boolean","description":"Indicates whether the device supports obtaining DHCP client table information through the GET message"},"supportGetDhcpServerInfo":{"type":"boolean","description":"Indicates whether the device supports obtaining DHCP server information through the GET message"}}},"OperationResponseDhcpServerDevCapForVlanVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DhcpServerDevCapForVlanVO"}}},"DhcpServerForVlanVO":{"type":"object","properties":{"ranges":{"type":"array","description":"Dhcp Server Ranges","items":{"$ref":"#/components/schemas/DhcpServerRangeVO"}}}},"DhcpServerRangeVO":{"type":"object","properties":{"startIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Start IP"},"endIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"End IP"},"availableIpNum":{"type":"integer","description":"The number of available IP addresses in the server address pool.","format":"int32"}},"description":"Dhcp Server Ranges"},"OperationResponseDhcpServerForVlanVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DhcpServerForVlanVO"}}},"OperationResponseVlanNetworkDeliverBriefDataVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VlanNetworkDeliverBriefDataVO"}}},"VlanNetworkDeliverBriefDataVO":{"type":"object","properties":{"successDevices":{"type":"array","description":"Successfully delivered devices","items":{"type":"string","description":"Successfully delivered devices"}},"successStacks":{"type":"array","description":"Successfully delivered stacks","items":{"type":"string","description":"Successfully delivered stacks"}},"failDevices":{"type":"array","description":"Failed devices","items":{"type":"string","description":"Failed devices"}},"failStacks":{"type":"array","description":"Failed stacks","items":{"type":"string","description":"Failed stacks"}},"deliveringDevices":{"type":"array","description":"Delivering devices","items":{"type":"string","description":"Delivering devices"}},"deliveringStacks":{"type":"array","description":"Delivering stacks","items":{"type":"string","description":"Delivering stacks"}},"doneDevicesNum":{"type":"integer","description":"Delivered device num","format":"int32"},"totalDevicesNum":{"type":"integer","description":"Total device num","format":"int32"},"state":{"type":"integer","description":"Delivering state. 0: free ( it means the network has been already delivered)  1: delivering 2. deliver done.","format":"int32"}}},"GridVOVlanLanNetworkForBtachDeleteVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VlanLanNetworkForBtachDeleteVO"}}}},"OperationResponseGridVOVlanLanNetworkForBtachDeleteVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOVlanLanNetworkForBtachDeleteVO"}}},"VlanLanNetworkForBtachDeleteVO":{"required":["purpose"],"type":"object","properties":{"name":{"type":"string","description":"network name"},"id":{"type":"string","description":"network id"},"vlan":{"type":"integer","description":"vlan id","format":"int32"},"purpose":{"type":"string","description":"LAN network purpose, 0: VLAN, 1: interface"}}},"BriefServerDeviceVO":{"type":"object","properties":{"name":{"type":"string","description":"Dhcp Server Name"},"mac":{"type":"string","description":"Dhcp Server Mac"},"stackId":{"type":"string","description":"Dhcp Server Stack ID"},"model":{"type":"string","description":"Device Model"},"modelVersion":{"type":"string","description":"Device Model Version"},"type":{"type":"string","description":"Device Type"},"ranges":{"type":"array","description":"Dhcp Server Ranges","items":{"$ref":"#/components/schemas/DhcpRangeOpenApiVO"}},"configRanges":{"type":"array","description":"Dhcp Server Config Ranges","items":{"$ref":"#/components/schemas/DhcpRangeOpenApiVO"}},"dhcpServerEnable":{"type":"boolean","description":"Whether DHCP Server is enabled"},"dhcpSettingsAuto":{"type":"boolean","description":"Whether DHCP Setting is auto"},"supportDhcpReservation":{"type":"boolean","description":"Whether the device supports DHCP Reservation"}},"description":"List of devices acting as DHCP servers in this network"},"DhcpServerInfoUnderNetworkVO":{"type":"object","properties":{"networks":{"type":"array","description":"Networks With Dhcp Servers","items":{"$ref":"#/components/schemas/NetworkWithServerVO"}}}},"NetworkWithServerVO":{"type":"object","properties":{"id":{"type":"string","description":"LAN Network ID"},"name":{"type":"string","description":"LAN Network Name"},"type":{"type":"string","description":"LAN Network Type"},"serverDevices":{"type":"array","description":"List of devices acting as DHCP servers in this network","items":{"$ref":"#/components/schemas/BriefServerDeviceVO"}}},"description":"Networks With Dhcp Servers"},"OperationResponseDhcpServerInfoUnderNetworkVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DhcpServerInfoUnderNetworkVO"}}},"GridVONetworkClientAllOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/NetworkClientAllOpenApiVO"}}}},"NetworkClientAllOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"Client MAC Address."},"name":{"type":"string","description":"Client Name, alias."},"type":{"type":"string","description":"Device Type: iphone, ipod, android, pc, printer, tv..."}}},"OperationResponseGridVONetworkClientAllOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVONetworkClientAllOpenApiVO"}}},"GridVOIpsSignatureInfo":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/IpsSignatureInfo"}}}},"IpsSignatureInfo":{"required":["category","classification","id","service","sid","signature","type"],"type":"object","properties":{"id":{"type":"string","description":"The unique identity of the signature suppresses."},"classification":{"type":"string","description":"Attack service concrete classification.","example":"misc-attack"},"category":{"type":"integer","description":"Attack service wide category.","format":"int32","example":2},"signature":{"type":"string","description":"Attack service signature."},"sid":{"type":"integer","description":"IPS signature rule SID which is from device.","format":"int64","example":240201},"service":{"type":"string","description":"Attack service service, the same as parameter[signature]"},"type":{"type":"integer","description":"Type should be a value as follow: 0: all traffic; 1: packet tracking","format":"int32","example":1},"direction":{"type":"integer","description":"Direction should be a value as follow: 0: both direction; 1: source direction; 2: destination direction","format":"int32","example":1},"trafficType":{"type":"integer","description":"TrafficType should be a value as follow: 0: ip address; 1: subnet","format":"int32","example":0},"trafficSource":{"type":"string","description":"IPS signature traffic Source. If parameter [trafficType] is 0, parameter [trafficSource] should be IPV4 address. If parameter [trafficType] is 1, parameter [trafficSource] should be subnet address.","example":"192.168.0.1"}},"description":"IPS signature Info entity"},"OperationResponseGridVOIpsSignatureInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOIpsSignatureInfo"}}},"GridVOIps Block List Entry":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Ips block list entry"}}}},"Ips block list entry":{"type":"object","properties":{"id":{"type":"string","description":"Block list entry ID."},"name":{"type":"string","description":"The name of the defined blocked or isolated policy."},"sourceIp":{"type":"string","description":"Source IP in defined blocked or isolated policy."},"destination":{"type":"string","description":"The destination IP in defined blocked or isolated policy."},"sourceLocation":{"type":"string","description":"The region code of the source IP."}}},"OperationResponseGridVOIps Block List Entry":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOIps Block List Entry"}}},"OperationResponsePortForwardingGridVOPortForwardingInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/PortForwardingGridVOPortForwardingInfo"}}},"PortForwardingGridVOPortForwardingInfo":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PortForwardingInfo"}},"supportWanIp":{"type":"boolean"},"supportVirtualWan":{"type":"boolean"},"supportByDsLiteAndMapE":{"type":"boolean"}}},"PortForwardingInfo":{"required":["dMZ","forwardIp","from","interfaceWanPortId","name","status"],"type":"object","properties":{"id":{"type":"string","description":"Port-forwarding ID"},"site id":{"type":"string","description":"Site ID"},"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name, name should contain 1 to 64 characters."},"status":{"type":"boolean","description":"Port-forwarding enable status."},"from":{"type":"integer","description":"From corresponds with source IP in web. From should be a value as follows: 0: where; 1: limited address","format":"int32"},"limitedAddresses":{"type":"array","description":"Only for limited address","items":{"type":"string","description":"Only for limited address"}},"interfaceWanPortId":{"type":"array","description":"This field represents WAN port ID. WAN port ID can be obtained from 'Get internet basic info' interface.","items":{"type":"string","description":"This field represents WAN port ID. WAN port ID can be obtained from 'Get internet basic info' interface."}},"virtualWanId":{"type":"array","description":"This field represents VirtualWan ID. VirtualWan ID can be obtained from 'Query available virtual WAN list' interface","items":{"type":"string","description":"This field represents VirtualWan ID. VirtualWan ID can be obtained from 'Query available virtual WAN list' interface"}},"wanIps":{"type":"array","description":"WAN IPs","items":{"$ref":"#/components/schemas/PortIpOpenApiVO"}},"externalPort":{"pattern":"^(([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5]))|((([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5]))-(([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5])))$","type":"string","description":"External port corresponds with source port in web. ExternalPort should be within the range of 1–65535."},"forwardIp":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\b","type":"string","description":"Forward IP corresponds with destination IP in web. Forward IP"},"forwardPort":{"pattern":"^(([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5]))|((([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5]))-(([1-9]\\d{0,3})|([1-5]\\d{4})|(6[0-4]\\d{3})|(65[0-4]\\d{2})|(655[0-2]\\d)|(6553[0-5])))$","type":"string","description":"Forward port corresponds with destination port in web. ForwardPort should be 1 or 1-10, within the range of 1–65535."},"protocol":{"type":"integer","description":"Protocol should be a value as follows: 0: ALL; 1: TCP; 2: UDP.","format":"int32"},"existWanIp":{"type":"boolean","description":"true: exist WAN IP config"},"existVirtualWan":{"type":"boolean","description":"true: exist virtual WAN config"},"featureDescription":{"type":"array","description":"Gateway Feature Description.","items":{"$ref":"#/components/schemas/FeatureInfoVO"}},"dMZ":{"type":"boolean","description":"With DMZ enabled, all ports are open and the traffic from external network will be forwarded to the specific destination IP in the LAN."}}},"OperationResponseOtoNatOpenApiGridVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OtoNatOpenApiGridVO"}}},"OtoNatInfoOpenApiVO":{"required":["dmz","externalIp","interfaceIds","internalIp","name","status"],"type":"object","properties":{"id":{"type":"string","description":"ID"},"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Name should contain 1 to 64 characters."},"status":{"type":"boolean","description":"Status"},"interfaceIds":{"type":"array","description":"This field represents WAN port ID. WAN port ID can be obtained from can be obtained from 'Get internet basic info' interface.","items":{"type":"string","description":"This field represents WAN port ID. WAN port ID can be obtained from can be obtained from 'Get internet basic info' interface."}},"internalIp":{"type":"string","description":"Internal IP"},"externalIp":{"type":"string","description":"External IP"},"dmz":{"type":"boolean","description":"Whether to enable the DMZ"},"description":{"pattern":"^$|^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Description should contain 1 to 64 characters."}}},"OtoNatOpenApiGridVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OtoNatInfoOpenApiVO"}},"supportGeneralDialingTypeWan":{"type":"boolean","description":"Whether to support Dynamic IP, Static IP, PPPoE, L2TP, PPTP dialing type wan port"}}},"OperationResponseRollingUpgradeRes":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/RollingUpgradeRes"}}},"RollingUpgradeRes":{"type":"object","properties":{"finished":{"type":"boolean","description":"Whether the task is complete"},"unfinishedCount":{"type":"integer","description":"Total number of devices that have not been upgraded","format":"int32"}}},"OperationResponseUpgradeRes":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/UpgradeRes"}}},"UpgradeRes":{"type":"object","properties":{"finished":{"type":"boolean","description":"Whether the task is complete"},"unfinishedCount":{"type":"integer","description":"Total number of devices that have not been upgraded","format":"int32"}}},"DeviceAddProcessRespVO":{"type":"object","properties":{"processStatus":{"type":"integer","description":"It should be a value as follows: 0: init; 1: doing; 2: done","format":"int32"},"devices":{"type":"array","description":"Devices add result","items":{"$ref":"#/components/schemas/SnAddResultVO"}}}},"OperationResponseDeviceAddProcessRespVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceAddProcessRespVO"}}},"SnAddResultVO":{"type":"object","properties":{"sn":{"type":"string","description":"Serial number"},"deviceKey":{"type":"string","description":"Device key(QR code)"},"name":{"type":"string","description":"Device name"},"mac":{"type":"string","description":"Device mac"},"status":{"type":"integer","description":"Device add status should be a value as follows: 0: success; 1: waiting to do; 2：importing; -51451：Device ID not found; -52201：Device is offline; -52202：Device is already bounded; -52208：Device is offline during processing; -52200：Device not exit; -53100：Invalid SN code; -53101：SN code already exists; -53102：Incorrect local Username/Password; -53103：Device error; -53113: Too many PRECONFIGURED devices in this account. Available licenses are not enough; -53114: This device has been added by another Controller; -53118: Omada Pro devices can only be added on the Omada Pro Controller; -53119: Omada devices can only be added on the Omada Controller; -39045: Failed to add the device due to duplicate SN codes. Please contact our TP-Link Support.","format":"int32"},"siteName":{"type":"string","description":"If device management records exist when adding devices by SN, you need to forget devices in this site. Otherwise this field will have no value."},"customerName":{"type":"string","description":"If device management records exist when adding devices by SN, you need to forget devices in this customer. Otherwise this field will have no value."},"online":{"type":"boolean","description":"Device online or offline"},"supportIppt":{"type":"boolean","description":"Support ip pass-through or not。"}},"description":"Devices add result"},"GridVOMonitorDevice":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/MonitorDevice"}}}},"OperationResponseGridVOMonitorDevice":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOMonitorDevice"}}},"GridVOMonitorClient":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/MonitorClient"}}}},"OperationResponseGridVOMonitorClient":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOMonitorClient"}}},"GridVOOswMlagVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OswMlagVO"}}}},"OperationResponseGridVOOswMlagVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOswMlagVO"}}},"OswMlagMemberVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device Mac"},"name":{"type":"string","description":"Device Name"},"role":{"type":"integer","description":"Role","format":"int32"},"statusCategory":{"type":"integer","description":"Category of device status,statusCategory should be a value as follows: 0:Disconnected;1:Connected;2:Pending;3:Heartbeat Missed;4:Isolated","format":"int32"},"status":{"type":"integer","description":"Device Status","format":"int32"},"ip":{"type":"string","description":"IP"},"dadStatus":{"type":"integer","description":"DAD status should be a value as follows: 0: PEER_UNDETECTED; 1: NORMAL; 2: DAD_DISABLE.","format":"int32"},"kaStatus":{"type":"integer","description":"Keep Alive status should be a value as follows: 0: HEARTBEAT_MISSED; 1: HEARTBEAT_NORMAL.","format":"int32"},"cfgCheck":{"type":"integer","description":"MLAG group configuration check status should be a value as follows: 0: All cfg pass; 1: Type2 cfg not pass;2: Type1 and Type2 not pass;3: Type1 not pass","format":"int32"},"priority":{"type":"integer","description":"Priority of the device in the M-LAG group.","format":"int32"},"dadIp":{"type":"string","description":"DAD IP Address"},"compoundModel":{"type":"string","description":"Model complex used in the backend."},"showModel":{"type":"string","description":"Model complex shown in the front end."},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"model":{"type":"string","description":"Model of device,for example:EAP225."},"firmwareVersion":{"type":"string","description":"Version of firmware,for example:2.5.0 Build 20190118 Rel. 64821."},"addedInAdvanced":{"type":"boolean"},"version":{"type":"string","description":"Simplified version of firmware,for example:2.5.0."},"hwVersion":{"type":"string","description":"Version of hardware,for example 1.0."},"specialModel":{"type":"string","description":"Special device model,for example:EAP225-Outdoor-1a20a950b8d950e8."},"category":{"type":"string","description":"Category of license."},"uptime":{"type":"string","description":"Device uptime."},"licenseStatus":{"type":"integer","description":"License status(cloud base exclusive).LicenseStatus should be a value as follows: 0:unActive 1:Unbind 2:Expired 3:active.","format":"int32"},"active":{"type":"boolean","description":"whether to active the device(cloud base exclusive)."},"deviceType":{"type":"integer","description":"Device type, 1: Gateway; 2: Switch; 3: Ap.","format":"int32"},"dueTime":{"type":"integer","description":"Expire timestamp of license(cloud base exclusive).","format":"int64"},"dueTimeLeft":{"type":"integer","description":"Milliseconds from the current moment to the expiration time(cloud base exclusive)","format":"int64"},"licenseUnbindingLimit":{"type":"integer","description":"Remaining unbind count for license on detail Page of device(cloud base exclusive).","format":"int32"},"publicIp":{"type":"string","description":"Device public IP."},"ipv6":{"type":"array","description":"Device IPv6 list.","items":{"type":"string","description":"Device IPv6 list."}},"supportMlagIpv6":{"type":"boolean","description":"Whether the device support the configuration of M-LAG group IPv6."},"dadEnable":{"type":"boolean","description":"Whether the DAD enable."},"dadLinkPorts":{"type":"array","description":"DAD Link Ports","items":{"type":"string","description":"DAD Link Ports"}},"dadLocalIp":{"type":"string","description":"DAD Local IP"},"dadLocalIpv6":{"type":"string","description":"DAD Local IPv6"},"dadPeerIp":{"type":"string","description":"DAD Peer IP"},"dadPeerIpv6":{"type":"string","description":"DAD Peer IPv6"},"peerLinkPorts":{"type":"array","description":"Peer Link Ports","items":{"type":"string","description":"Peer Link Ports"}},"locateEnable":{"type":"boolean","description":"Whether the locate function is enabled."},"inWhiteList":{"type":"boolean","description":"Whether the device is in white list."},"eost":{"type":"integer","description":"End of service time of device(CBC exclusive).","format":"int64"},"eos":{"type":"integer","description":"End of support time of device(CBC exclusive).","format":"int64"},"compatible":{"type":"integer","description":"Device firmware and controller compatibility type.Compatible should be a value as follows: 0:COMPATIBLE;1:HIGH_MAJOR_VER;2:LOW_MAJOR_VER;3:HIGH_MINOR_VER;4:LOW_MINOR_VER;7:HIGH_COMPONENT_VER;10:DEVICE_NOT_COMPATIBLE;11:HIGH_ADOPT_COMMPONENT;12:DEVICE_CATEGORY_NOT_COMPATIBLE;14:DEVICE_NOT_COMPATIBLE_IN_CLUSTER.","format":"int32"},"mlagVersion":{"type":"string","description":"M-LAG version."},"mlagGroupId":{"type":"integer","description":"M-LAG group ID.","format":"int32"},"ports":{"type":"array","description":"M-LAG group device ports.","items":{"$ref":"#/components/schemas/OswMlagPortVO"}},"supportPeerLinkPorts":{"type":"array","description":"Support the configuration of peer link ports for devices in the MLAG group.","items":{"$ref":"#/components/schemas/OswStandPortVO"}}},"description":"M-LAG Group member list"},"OswMlagPortVO":{"type":"object","properties":{"standardPort":{"$ref":"#/components/schemas/OswStandPortVO"},"portStatus":{"$ref":"#/components/schemas/OswPortStatusVO"},"selectable":{"type":"boolean","description":"whether the port can be selected to configure DAD Port or Peer Link Port."},"port":{"type":"integer","format":"int32"}},"description":"M-LAG group device ports."},"OswMlagVO":{"type":"object","properties":{"id":{"type":"string","description":"M-LAG ID"},"groupId":{"type":"string","description":"M-LAG group ID"},"name":{"type":"string","description":"M-LAG group Name"},"status":{"type":"integer","description":"M-LAG group status should be a value as follows: 0: NORMAL; 1: PEER ERROR; 2: DAD ERROR; 3: ABNORMAL; 4: CONFIGURATION UNSYNCHRONIZED; 5: MLAG MEMBERS INCOMPATIBLE; 6: MLAG MEMBERS MISMATCH.","format":"int32"},"devicesNum":{"type":"integer","description":"Number of devices","format":"int32"},"version":{"type":"string","description":"Version"},"locateEnable":{"type":"boolean","description":"Indicates whether the locate function is enabled"},"members":{"type":"array","description":"M-LAG Group member list","items":{"$ref":"#/components/schemas/OswMlagMemberVO"}}}},"MlagCccResultVO":{"type":"object","properties":{"cfgName":{"type":"string","description":"M-LAG group member configuration name"},"pathType":{"type":"integer","description":"M-LAG group member configuration path. It should be a value as follows:-1 : Settings -> CLI Configuration0 : Device configuration page -> config -> General -> Hash Algorithm1 : Device configuration page -> ports -> Profile Overrides -> Operation(Aggregating)2 : Device configuration page -> config -> Services -> Loopback Control -> Loopback Detection3 : Device configuration page -> ports -> Profile Overrides -> Loopback Control4 : Device configuration page -> config -> Services -> Loopback Control -> Spanning Tree5 : Device configuration page -> config -> Services -> Loopback Control -> CIST Priority6 : Device configuration page -> config -> Services -> Loopback Control -> MSTP Instance config7 : Device configuration page -> ports -> Profile Overrides -> Spanning Tree Config8 : Device configuration page -> ports -> Profile Overrides -> Loopback Control9 : Device configuration page -> config -> VLAN Interface10 : Settings -> Transmission -> VRRP -> Optional Settings11 : Settings -> Transmission -> VRRP12 : Settings -> Wired&Wireless Networks -> LAN -> Networks -> DHCP L2 Relay13 : Device configuration page -> ports -> LAG -> Profile14 : Settings -> Wired&Wireless Networks -> LAN -> Networks -> IGMP Snooping15 : Settings -> Wired&Wireless Networks -> LAN -> Networks -> MLD Snooping","format":"int32"},"type":{"type":"integer","description":"M-LAG group member configuration type. It should be a value as follows:1 : Critical2 : Significant","format":"int32"},"cccRslt":{"type":"string","description":"The result of the M-LAG consistency check."},"localVal":{"type":"string","description":"The local configuration values for M-LAG consistency check."},"peerVal":{"type":"string","description":"The opposite-end configuration values for M-LAG consistency check."}},"description":"M-LAG group members configuration check result"},"OperationResponseMapStringOswMlagCccVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/OswMlagCccVO"}}}},"OswMlagCccVO":{"type":"object","properties":{"mac":{"type":"string","description":"M-LAG group member mac"},"mlagCccResult":{"type":"array","description":"M-LAG group members configuration check result","items":{"$ref":"#/components/schemas/MlagCccResultVO"}}}},"MlagAdoptOswVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device mac"},"name":{"type":"string","description":"Device name,default value is the mac address of device"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"addedInAdvanced":{"type":"boolean","description":"Whether the device is added in advanced."},"version":{"type":"string","description":"Simplified version of firmware,for example:2.5.0."},"showModel":{"type":"string","description":"Model complex shown in the front end.Ap：model+(country)+modelVersion,EAP225(EU) v3.0  Gateway/Switch：model+modelVersion,Osg v3.0"},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected;1:Disconnected(Migrating);10:Provisioning;11:Configuring;12:Upgrading;13:Rebooting;14:Connected;15:Connected(Wireless);16:Connected(Migrating);17:Connected(Wireless,Migrating);20:Pending;21:Pending(Wireless);22:Adopting;23:Adopting(Wireless);24:Adopt Failed;25:Adopt Failed(Wireless);26:Managed By Others;27:Managed By Others(Wireless);30:Heartbeat Missed;31:Heartbeat Missed(Wireless);32:Heartbeat Missed(Migrating);33:Heartbeat Missed(Wireless,Migrating);40:Isolated;41:Isolated(Migrating);50:Slice Configuring","format":"int32"},"category":{"type":"string","description":"Category of license."},"licenseStatus":{"type":"integer","description":"Device license status (Only for cloud base) should be a value as follows: 0: unActive; 1: Unbind; 2: Expired; 3: active","format":"int32"},"dueTime":{"type":"integer","description":"Expire timestamp of license(cloud base exclusive).","format":"int64"},"dueTimeLeft":{"type":"integer","description":"Milliseconds from the current moment to the expiration time(cloud base exclusive)","format":"int64"},"active":{"type":"boolean","description":"whether to active the device(cloud base exclusive)."},"deviceType":{"type":"integer","description":"Device type, 1: Gateway; 2: Switch; 3: Ap.","format":"int32"},"mlagVersion":{"type":"string","description":"M-LAG version."},"mlagGroupId":{"type":"integer","description":"M-LAG group ID.","format":"int32"},"ip":{"type":"string","description":"IP"},"publicIp":{"type":"string","description":"Device public IP."},"ipv6List":{"type":"array","description":"Device IPv6 list.","items":{"type":"string","description":"Device IPv6 list."}},"supportMlagIpv6":{"type":"boolean","description":"Whether the device support the configuration of M-LAG group IPv6."},"ports":{"type":"array","description":"M-LAG group device ports.","items":{"$ref":"#/components/schemas/OswMlagPortVO"}},"supportPeerLinkPorts":{"type":"array","description":"Support the configuration of peer link ports for devices in the MLAG group.","items":{"$ref":"#/components/schemas/OswStandPortVO"}}},"description":"The switches contained in the M-LAG."},"MlagSupportOswVO":{"type":"object","properties":{"adoptedSwitches":{"type":"array","description":"The switches contained in the M-LAG.","items":{"$ref":"#/components/schemas/MlagAdoptOswVO"}}}},"OperationResponseMlagSupportOswVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/MlagSupportOswVO"}}},"BackupFileListVO":{"type":"object","properties":{"fileList":{"uniqueItems":true,"type":"array","description":"File list of backup files.","items":{"$ref":"#/components/schemas/BackupFileResultVO"}}}},"BackupFileResultVO":{"type":"object","properties":{"fileName":{"type":"string","description":"File name of backup file. Parameter [fileName] should be 1 - 128 ASCII characters."},"backupTime":{"type":"integer","description":"Backup time(ms).","format":"int64"},"size":{"type":"integer","description":"Size of backup file(Byte).","format":"int64"}},"description":"File list of backup files."},"EventLogGridVOEventLogOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/EventLogOpenApiVO"}},"eventLogStat":{"$ref":"#/components/schemas/EventLogStatOpenApiVO"}}},"EventLogOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Log ID."},"key":{"type":"string","description":"Log key."},"module":{"type":"string","description":"Log module."},"content":{"type":"string","description":"Log content."},"time":{"type":"integer","description":"Log time.","format":"int64"}}},"EventLogStatOpenApiVO":{"type":"object","properties":{"totalLogNum":{"type":"integer","description":"Total log number.","format":"int64"},"systemLogNum":{"type":"integer","description":"System event log number.","format":"int64"},"deviceLogNum":{"type":"integer","description":"Device event log number.","format":"int64"},"clientLogNum":{"type":"integer","description":"Client event log number.","format":"int64"}},"description":"Event log statistic."},"OperationResponseEventLogGridVOEventLogOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/EventLogGridVOEventLogOpenApiVO"}}},"AlertLogGridVOAlertLogOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AlertLogOpenApiVO"}},"alertLogStat":{"$ref":"#/components/schemas/AlertLogStatOpenApiVO"}}},"AlertLogOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Log ID."},"key":{"type":"string","description":"Log key."},"module":{"type":"string","description":"Log module."},"content":{"type":"string","description":"Log content."},"time":{"type":"integer","description":"Log time.","format":"int64"},"level":{"type":"string","description":"Alert log level."}}},"AlertLogStatOpenApiVO":{"type":"object","properties":{"totalLogNum":{"type":"integer","description":"Total log number.","format":"int64"},"unResolvedLogNum":{"type":"integer","description":"Unresolved alert log number.","format":"int64"},"resolvedLogNum":{"type":"integer","description":"Resolved alert log number.","format":"int64"},"systemLogNum":{"type":"integer","description":"System alert log number.","format":"int64"},"deviceLogNum":{"type":"integer","description":"Device alert log number.","format":"int64"}},"description":"Alert log statistic."},"OperationResponseAlertLogGridVOAlertLogOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AlertLogGridVOAlertLogOpenApiVO"}}},"OperationResponseLicenseAutoRenewOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/LicenseAutoRenewOpenApiVO"}}},"GridVOOswProfileOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OswProfileOpenApiVO"}}}},"OswProfileOpenApiVO":{"type":"object","properties":{"name":{"type":"string","description":"Switch name"},"mac":{"type":"string","description":"Switch MAC"},"profiles":{"type":"object","additionalProperties":{"type":"string","description":"Switch port profiles"},"description":"Switch port profiles"}}},"LanNetworkOpenApiGridVOLanNetworkQueryOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/LanNetworkQueryOpenApiVO"}},"supportMultiVlan":{"type":"boolean","description":"Whether multi vlan configuration is supported of the lan netowrk."},"supportRA":{"type":"boolean","description":"Whether Router Advertisement configuration is supported of the lan netowrk."},"supportCustomDhcpOption":{"type":"boolean","description":"Whether custom DHCP option configuration is supported of the lan netowrk."}}},"LanNetworkQueryOpenApiVO":{"required":["igmpSnoopEnable","name","purpose"],"type":"object","properties":{"id":{"type":"string","description":"LAN network ID"},"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"LAN network name should contain 1 to 128 characters."},"purpose":{"type":"integer","description":"LAN network purpose, 0: VLAN, 1: interface","format":"int32"},"interfaceIds":{"type":"array","description":"Gateway LAN port IDs (acquired from \"Check WAN/LAN status\")","items":{"type":"string","description":"Gateway LAN port IDs (acquired from \"Check WAN/LAN status\")"}},"vlanType":{"type":"integer","description":"When purpose is interface, VLANType is valid. 0: Single; 1: Multiple","format":"int32"},"vlans":{"pattern":"^[\\d|\\d-\\d]+(,[\\d|\\d-\\d]+)*$","type":"string","description":"When purpose is interface and VLANType is 1, batch create VLANs. VLAN format: 200, 1-100."},"vlan":{"type":"integer","description":"When purpose is \"VLAN\" or purpose is \"interface\" and VLANType is 0, create VLAN. VLAN range 1 to 4090.","format":"int32"},"application":{"type":"integer","description":"Effective device type. 0: Gateway, Switch; 1: Switch","format":"int32"},"gatewaySubnet":{"pattern":"\\b((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])\\.((?!\\d\\d\\d)\\d+|1\\d\\d|2[0-4]\\d|25[0-5])/(\\d|((1|2)\\d)|(30))\\b","type":"string","description":"When purpose is interface, gateway subnet is needed. Format: IP/Mask"},"dhcpSettingsVO":{"$ref":"#/components/schemas/dhcp settings"},"domain":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"The domain of this network"},"igmpSnoopEnable":{"type":"boolean","description":"Enable IGMP snooping"},"mldSnoopEnable":{"type":"boolean","description":"Enable MLD snooping"},"dhcpL2RelayEnable":{"type":"boolean","description":"The switch of DHCP L2 relay"},"dhcpGuard":{"$ref":"#/components/schemas/Dhcp Servers setting"},"dhcpv6Guard":{"$ref":"#/components/schemas/Dhcpv6 Servers setting"},"portal":{"type":"boolean","description":"Show portal is enabled or not"},"portalId":{"type":"string","description":"Show portal ID"},"portalName":{"type":"string","description":"Show related portal name"},"accessControlRule":{"type":"boolean","description":"Show AccessControlRule is enabled or not"},"rateLimit":{"type":"boolean","description":"Show RateLimit is enabled or not"},"lanNeworkIpv6Config":{"$ref":"#/components/schemas/Lan network IPV6 config"},"allLan":{"type":"boolean","description":"When Internet pre-config is closed or Internet pre-config is Universal, allLAN is \"true\"; after adopting gateway, allLAN is \"false\"."},"qosQueueEnable":{"type":"boolean","description":"The switch of QoS(Quality of Service)."},"queueId":{"type":"integer","description":"The queue Id of QoS.","format":"int32"},"primary":{"type":"boolean","description":"Primary"}},"description":"LANNetworkQueryOpenApiVO"},"OperationResponseLanNetworkOpenApiGridVOLanNetworkQueryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/LanNetworkOpenApiGridVOLanNetworkQueryOpenApiVO"}}},"OperationResponseResponseDataVOLanNetworkQueryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ResponseDataVOLanNetworkQueryOpenApiVO"}}},"ResponseDataVOLanNetworkQueryOpenApiVO":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LanNetworkQueryOpenApiVO"}}}},"Get Ips Threat Detail":{"type":"object","properties":{"id":{"type":"string","description":"IPS threat ID"},"time":{"type":"integer","description":"Timestamp, in seconds, such as 1682000000","format":"int64"},"srcIp":{"type":"string","description":"IPS threat source IP"},"srcCountry":{"type":"string","description":"IPS threat destination Country"},"dstIp":{"type":"string","description":"IPS threat destination IP"},"service":{"type":"string","description":"Ips threat description"},"severity":{"type":"integer","description":"Ips threat severity,  0：Critical, 1：Major, 2：Moderate 3：Minor 4:Low","format":"int32"},"category":{"type":"integer","description":"Ips threat category, Custom IDS/IPS categories list, if parameter[Dplevel] is 3, customCategories is needed.CustomCategories should be a list as follow: 1: Botcc, 2: Worm, 3: Malware, 4: Mobile_Malware, 6: P2P, 7: Tor, 8: Exploit, 9: Shellcode, 14: Activex, 15: DNS, 18: User Agents, 24: DShield","format":"int32"},"classification":{"type":"string","description":"Ips threat classification"},"activity":{"type":"integer","description":"Ips threat dataUsage, in Byte","format":"int64"},"protocol":{"type":"string","description":"Ips threat protocol"}}},"OperationResponseGet Ips Threat Detail":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Get Ips Threat Detail"}}},"Get Grid Ips Threat":{"type":"object","properties":{"id":{"type":"string","description":"IPS threat ID"},"time":{"type":"integer","description":"Timestamp, in seconds, such as 1682000000","format":"int64"},"srcCountry":{"type":"string","description":"IPS threat source Country"},"service":{"type":"string","description":"IPS threat description"},"severity":{"type":"integer","description":"IPS threat severity should be a value as follows: 0: Critical; 1: Major; 2: Moderate; 3: Minor; 4: Low","format":"int32"},"category":{"type":"integer","description":"IPS threat category","format":"int32"},"classification":{"type":"string","description":"Ips threat classification"}}},"GridVOGet Grid Ips Threat":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Get Grid Ips Threat"}}}},"OperationResponseGridVOGet Grid Ips Threat":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOGet Grid Ips Threat"}}},"OperationResponseWanSettingOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/WanSettingOpenApiVO"}}},"WanSettingOpenApiVO":{"type":"object","properties":{"wanPortsConfig":{"type":"array","description":"WAN ports config","items":{"$ref":"#/components/schemas/WanPortSettingOpenApiVO"}},"UsbPortsConfig":{"type":"array","description":"USB lte ports config","items":{"$ref":"#/components/schemas/UsbLteSettingOpenApiVO"}}}},"OperationResponseSupportOsgModelOpenApiAppVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SupportOsgModelOpenApiAppVO"}}},"OsgModelOpenApiInfoVO":{"required":["id","name"],"type":"object","properties":{"id":{"type":"integer","description":"Model ID","format":"int32"},"name":{"type":"string","description":"Model name"}},"description":"Model ID and name"},"SupportOsgModelOpenApiAppVO":{"required":["supportModels"],"type":"object","properties":{"supportModels":{"type":"array","description":"Model ID and name","items":{"$ref":"#/components/schemas/OsgModelOpenApiInfoVO"}}}},"OperationResponseLteWanSettingOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/LteWanSettingOpenApiVO"}}},"IspOpenApiVO":{"required":["index","name"],"type":"object","properties":{"index":{"type":"integer","description":"ISP index","format":"int32"},"name":{"type":"string","description":"ISP name"}},"description":"ISP info in the location, including index and name"},"LocationAndIspInfoOpenApiVO":{"type":"object","properties":{"locationAndIsp":{"type":"array","description":"Location and ISP info, including index and name.","items":{"$ref":"#/components/schemas/LocationOpenApiVO"}}}},"LocationOpenApiVO":{"required":["index","name"],"type":"object","properties":{"index":{"type":"integer","description":"Location index","format":"int32"},"name":{"type":"string","description":"Location name"},"ispInfo":{"type":"array","description":"ISP info in the location, including index and name","items":{"$ref":"#/components/schemas/IspOpenApiVO"}}},"description":"Location and ISP info, including index and name."},"OperationResponseLocationAndIspInfoOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/LocationAndIspInfoOpenApiVO"}}},"InternetBaseInfoOpenApiVO":{"required":["gatewayModel","interval","portList","preConfiguration"],"type":"object","properties":{"preConfiguration":{"type":"boolean","description":"You can pre-configure the model-relative settings when it is true."},"gatewayModel":{"type":"integer","description":"Gateway model. The model number refers to function can be obtained from 'Get supported gateway model list for pre-configuration' interface.","format":"int32"},"portList":{"type":"array","description":"Port info list","items":{"$ref":"#/components/schemas/internet basic info"}},"interval":{"type":"integer","description":"Online detection interval(second), 0 means disable.","format":"int32"}}},"OperationResponseInternetBaseInfoOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/InternetBaseInfoOpenApiVO"}}},"OperationResponseIntelliRecoverSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/IntelliRecoverSetting"}}},"GridVOWidsDataOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WidsDataOpenApiVO"}}}},"OperationResponseGridVOWidsDataOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOWidsDataOpenApiVO"}}},"WidsDataOpenApiVO":{"type":"object","properties":{"stationMac":{"type":"string","description":"MAC address of the device that triggered the event."},"stationMacList":{"type":"array","description":"List of MAC addresses of the device that triggered the event.","items":{"type":"string","description":"List of MAC addresses of the device that triggered the event."}},"detectMac":{"type":"string","description":"The Mac address of the AP that detects the event."},"channel":{"type":"integer","description":"The Channel of the AP that detects the event.","format":"int32"},"band":{"type":"integer","description":"Channel band of the AP detecting the event (0:2.4g,1:5g, 2:5G,3:6g).","format":"int32"},"startTime":{"type":"integer","description":"Detection time.","format":"int64"},"type":{"type":"integer","description":"Detected event type.","format":"int32"},"level":{"type":"integer","description":"Detection event level (0:Alert,1:Major,2:Normal).","format":"int32"}}},"GridVOWipsBlackListOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/WipsBlackListOpenApiVO"}}}},"OperationResponseGridVOWipsBlackListOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOWipsBlackListOpenApiVO"}}},"WipsBlackListOpenApiVO":{"type":"object","properties":{"stationMac":{"type":"string","description":"MAC address of the device that triggered the event."},"detectMac":{"type":"string","description":"The Mac address of the AP that detects the event."},"timeStamp":{"type":"integer","description":"Timestamp of the detected event.","format":"int64"}}},"GridVORogue AP Scan Result Entry":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Rogue AP Scan Result Entry"}}}},"OperationResponseGridVORogue AP Scan Result Entry":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVORogue AP Scan Result Entry"}}},"Rogue AP Scan Result Entry":{"type":"object","properties":{"id":{"type":"string","description":"ID of the entry"},"ssid":{"type":"string","description":"Name of SSID"},"bssid":{"type":"string","description":"The MAC address of the network device, used as the unique identifier of the network"},"radioId":{"type":"integer","description":"(Wireless) Radio ID should be a value as follows: 0: 2.4GHz; 1: 5GHz-1; 2:5GHz-2; 3: 6GHz","format":"int32"},"security":{"type":"integer","description":"The encryption method of the network. 0: None  1: WEP  2: WPA-Enterprise  3: WPA-Personal  4:WPA3-SAE , 15:Unknown, the other unspecified return values are also displayed as Unknown","format":"int32"},"beacon":{"type":"integer","description":"The time interval for the network device to send Beacon frames","format":"int32"},"channel":{"type":"integer","description":"Channel","format":"int32"},"nearestApMac":{"type":"string","description":"The AP that scanned the network device"},"nearestAp":{"type":"string","description":"The AP name"},"mode":{"type":"integer","description":"0: 11a  1: 11b  2: 11g  3: 11na  4: 11ng  5: 11ac  6: 11axa  7: 11axg","format":"int32"},"signal":{"type":"integer","description":"The signal strength of the network device, unit: dBm","format":"int32"},"lastSeen":{"type":"integer","description":"The timestamp corresponding to the time when the network device was last scanned, unit: ms","format":"int64"}}},"GridVOPortForwardingOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PortForwardingOpenApiVO"}}}},"OperationResponseGridVOPortForwardingOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOPortForwardingOpenApiVO"}}},"PortForwardingOpenApiVO":{"type":"object","properties":{"omadacId":{"type":"string","description":"Omada ID"},"siteId":{"type":"string","description":"Site ID"},"entryId":{"type":"integer","description":"Port Forwarding entry id.","format":"int32"},"name":{"type":"string","description":"Port Forwarding rule name."},"from":{"type":"integer","description":"0:Anywhere 1:Limited Address.","format":"int32"},"limitedAddresses":{"type":"array","description":"If the field from is 1,limitedAddresses includes limited addresses.","items":{"type":"string","description":"If the field from is 1,limitedAddresses includes limited addresses."}},"interfaceWanPortId":{"type":"array","description":"Port Forwarding item id.","items":{"type":"string","description":"Port Forwarding item id."}},"protocol":{"type":"integer","description":"0:ALL, 1:TCP, 2:UDP.","format":"int32"},"externalPort":{"type":"string","description":"External Port."},"internalIp":{"type":"string","description":"Internal IP."},"internalPort":{"type":"string","description":"Internal Port."},"packets":{"type":"integer","description":"Packet quantity.","format":"int64"},"bytes":{"type":"integer","description":"Total flow in byte.","format":"int64"},"leaseDuration":{"type":"integer","description":"Displays the duration of the UPnP port forwarding in seconds.","format":"int64"}}},"Client History Info":{"type":"object","properties":{"id":{"type":"string","description":"Client History ID."},"mac":{"type":"string","description":"Client MAC Address."},"download":{"type":"integer","description":"Downstream traffic (Byte).","format":"int64"},"upload":{"type":"integer","description":"Upstream traffic (Byte).","format":"int64"},"duration":{"type":"integer","description":"Up time (unit: s).","format":"int64"},"firstSeen":{"type":"integer","description":"The timestamp (ms) when the client connected.","format":"int64"},"lastSeen":{"type":"integer","description":"Last found time, timestamp (ms).","format":"int64"},"name":{"type":"string","description":"Client Name."},"ssid":{"type":"string","description":"(Wireless)  SSID name."},"port":{"type":"integer","description":"(Wired) Port ID.","format":"int32"},"guest":{"type":"boolean","description":"(Wireless) Whether it is Guest (used to display the wireless Guest client icon)."},"deviceName":{"type":"string","description":"Device name."},"associationTime":{"type":"integer","description":"(Wireless) The time (ms) it takes for the client to connect to SSID.","format":"int32"},"ip":{"type":"string","description":"IP Address."},"ipv6List":{"type":"array","description":"IPv6 Address.","items":{"type":"string","description":"IPv6 Address."}},"authInfo":{"type":"array","description":"Client portal authentication information","items":{"$ref":"#/components/schemas/AuthInfoOpenApiVO"}}}},"GridVOClient History Info":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Client History Info"}}}},"OperationResponseGridVOClient History Info":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOClient History Info"}}},"GridVOKnownClientVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/KnownClientVO"}}}},"KnownClientVO":{"type":"object","properties":{"name":{"type":"string"},"mac":{"type":"string"},"wireless":{"type":"boolean"},"guest":{"type":"boolean"},"download":{"type":"integer","format":"int64"},"upload":{"type":"integer","format":"int64"},"duration":{"type":"integer","format":"int64"},"lastSeen":{"type":"integer","format":"int64"},"block":{"type":"boolean"},"manager":{"type":"boolean"},"lockToAp":{"type":"boolean"},"blockDisable":{"type":"boolean"},"vid":{"type":"integer","format":"int32"}}},"OperationResponseGridVOKnownClientVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOKnownClientVO"}}},"AnomalyAggregateVO":{"type":"object","properties":{"anomalyCode":{"type":"string","description":"For the values of Anomaly event code, refer to section 5.7.2.1 of the Open API Access","example":"01001001"},"category":{"type":"integer","description":"Anomaly category. 11: Network, 12: Device, 13: Client, etc.","format":"int32"},"level":{"type":"integer","description":"Event severity level. 0: Critical, 1: Error, 2: Warning, 3: Info.","format":"int32"},"titleParams":{"type":"object","additionalProperties":{"type":"string","description":"Title parameter map for rendering the event title template."},"description":"Title parameter map for rendering the event title template."},"contentParams":{"type":"object","additionalProperties":{"type":"string","description":"Content parameter map for rendering the event content template."},"description":"Content parameter map for rendering the event content template."},"objectType":{"type":"string","description":"Object type of the anomaly target: gateway, switch, ap, wiredClient, wirelessClient."},"object":{"type":"array","description":"List of device/client names where the anomaly occurred.","items":{"type":"string","description":"List of device/client names where the anomaly occurred."}},"count":{"type":"integer","description":"Number of occurrences of this anomaly.","format":"int32"},"lastTime":{"type":"integer","description":"Last occurrence time in milliseconds (Unix timestamp).","format":"int64"},"firstTime":{"type":"integer","description":"First occurrence time in milliseconds (Unix timestamp).","format":"int64"},"status":{"type":"integer","description":"Event status. 0: Unresolved, 1: Resolved, 2: Ignored.","format":"int32"},"devices":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DeviceObjectDTO"},"description":"Device objects map. Key is MAC address, value is device info."},"clients":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ClientObjectDTO"},"description":"Client objects map. Key is MAC address, value is client info."},"influencingDevices":{"uniqueItems":true,"type":"array","description":"List of MAC addresses of influencing/impacted devices.","items":{"type":"string","description":"List of MAC addresses of influencing/impacted devices."}},"influencingClients":{"uniqueItems":true,"type":"array","description":"List of MAC addresses of influencing/impacted clients.","items":{"type":"string","description":"List of MAC addresses of influencing/impacted clients."}},"causes":{"type":"array","description":"Root causes and advices for this anomaly.","items":{"$ref":"#/components/schemas/CauseVO"}}}},"AnomalyGridVOAnomalyAggregateVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AnomalyAggregateVO"}},"statistic":{"$ref":"#/components/schemas/InsightAnomalyStatVO"}}},"CauseVO":{"type":"object","properties":{"causeCode":{"type":"string","description":"Root cause code."},"causeTitleParams":{"type":"object","additionalProperties":{"type":"string","description":"Title parameter map for rendering the root cause title template."},"description":"Title parameter map for rendering the root cause title template."},"advices":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnomalyAdviceVO"},"description":"Advices for this root cause. Key is advice code, value is advice detail."}},"description":"Root causes and advices for this anomaly."},"InsightAnomalyStatVO":{"type":"object","properties":{"all":{"type":"integer","description":"Total number of incidents.","format":"int32"},"allStatus":{"type":"integer","description":"Total number of incidents in status.","format":"int32"},"allLevel":{"type":"integer","description":"Total number of incidents in level.","format":"int32"},"critical":{"type":"integer","description":"Number of critical level incidents.","format":"int32"},"error":{"type":"integer","description":"Number of error level incidents.","format":"int32"},"warning":{"type":"integer","description":"Number of warning level incidents.","format":"int32"},"info":{"type":"integer","description":"Number of info level incidents.","format":"int32"},"unresolved":{"type":"integer","description":"Number of unresolved incidents.","format":"int32"},"resolved":{"type":"integer","description":"Number of resolved incidents.","format":"int32"},"ignored":{"type":"integer","description":"Number of ignored incidents.","format":"int32"},"ongoing":{"type":"integer","description":"Number of ongoing incidents.","format":"int32"}},"description":"Statistics of incidents."},"OperationResponseAnomalyGridVOAnomalyAggregateVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AnomalyGridVOAnomalyAggregateVO"}}},"OperationResponseVoucherOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VoucherOpenApiVO"}}},"VoucherOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Voucher ID"},"code":{"type":"string","description":"Voucher code"},"createdTime":{"type":"integer","description":"Create timestamp for the voucher, unit: millisecond","format":"int64"},"limitType":{"type":"integer","description":"The limitations of the voucher. It should be a value as follows: 0: Limited Usage Counts, 1: Limited Online Users, 2: Unlimited","format":"int32"},"limitNum":{"type":"integer","description":"The number of limitations. It should be within the range of 1–999. If Parameter [limitType] is 0 or 1, [limitNum] should not be null.When Parameter [limitType] is 0, [limitNum] represents the maximum number of times this voucher can be used.When Parameter [limitType] is 1, [limitNum] represents the maximum number of users this voucher can be used at the same time.","format":"int32"},"used":{"type":"integer","description":"The number of times the voucher is used","format":"int32"},"durationType":{"type":"integer","description":"The duration type of the voucher. It should be a value as follows: 0: Client duration, each client expires after the duration is used. 1: Voucher duration, after reaching the voucher duration, clients using the voucher will expire","format":"int32"},"duration":{"type":"integer","description":"Duration of one use, unit: minute. It should be within the range of 1–14400000.","format":"int64"},"timingType":{"type":"integer","description":"The timing type of the voucher. It should be a value as follows: 0: Timing by time, clients can use vouchers for specified time duration. 1: Timing by usage, clients can use vouchers for the duration of actual usage","format":"int32"},"expirationTime":{"type":"integer","description":"The timestamp of the expiration of the voucher, unit: millisecond","format":"int64"},"effectiveTime":{"type":"integer","description":"The timestamp when the voucher takes effect, unit: millisecond","format":"int64"},"description":{"type":"string","description":"Description of the voucher"},"rateLimit":{"$ref":"#/components/schemas/RateLimitOpenApiVO"},"trafficLimitEnable":{"type":"boolean","description":"Whether to enable traffic limit"},"trafficLimit":{"type":"integer","description":"Traffic limit in MB. It should be within the range of 1–10485760","format":"int64"},"trafficLimitFrequency":{"type":"integer","description":"Frequency of traffic limit should be a value as follows: 0: total; 1: daily; 2: weekly; 3: monthly.","format":"int32"},"trafficLeft":{"type":"boolean","description":"Is there remaining traffic of traffic for the voucher"},"startTime":{"type":"integer","description":"The time when the voucher was first used, 0 represents it hasn't started using yet","format":"int64"},"endTime":{"type":"integer","description":"The expiration date of the voucher","format":"int64"},"valid":{"type":"boolean","description":"Can the voucher still be used"},"trafficUsed":{"type":"integer","description":"Used traffic of the voucher, unit: Byte","format":"int64"},"unitPrice":{"type":"string","description":"Price of single voucher. It should be within the range of 1–999999999"},"currency":{"type":"string","description":"Currency Short Code of voucher. For the values of Currency Short Code, refer to section 5.4.2 of the Open API Access Guide."},"portalNames":{"type":"array","description":"Bound portal name list","items":{"type":"string","description":"Bound portal name list"}},"logout":{"type":"boolean","description":"Whether the voucher support portal logout functionality"},"validity":{"type":"string","description":"Information on the validity period of the voucher"},"printComments":{"type":"string","description":"Customized print information for voters"},"ssidNameList":{"type":"array","description":"SSIDs for voucher","items":{"type":"string","description":"SSIDs for voucher"}},"networkNameList":{"type":"array","description":"Networks for voucher","items":{"type":"string","description":"Networks for voucher"}},"picId":{"type":"string","description":"Voucher logo picture ID"},"title":{"type":"string","description":"Title for voucher"},"position":{"type":"integer","description":"Position for logo or title","format":"int32"},"logoSize":{"type":"integer","description":"Size of logo on the pattern of the voucher. It should be within the range of 12-18.","format":"int32"},"titleSize":{"type":"integer","description":"Size of title on the pattern of the voucher. It should be within the range of 50-175","format":"int32"}}},"AllTimeVoucherSummaryOpenApiVO":{"type":"object","properties":{"current":{"$ref":"#/components/schemas/VoucherSummaryOpenApiVO"},"inuse":{"$ref":"#/components/schemas/VoucherSummaryOpenApiVO"},"expired":{"$ref":"#/components/schemas/VoucherSummaryOpenApiVO"},"unused":{"$ref":"#/components/schemas/VoucherSummaryOpenApiVO"},"created":{"$ref":"#/components/schemas/VoucherSummaryOpenApiVO"},"supportVoucherTrafficStat":{"type":"boolean","description":"Whether the controller support voucher traffic statistics"}}},"OperationResponseAllTimeVoucherSummaryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AllTimeVoucherSummaryOpenApiVO"}}},"VoucherSummaryOpenApiVO":{"type":"object","properties":{"count":{"type":"integer","description":"Count of vouchers","format":"int64"},"amount":{"type":"string","description":"Amount of single voucher"},"duration":{"type":"integer","description":"Duration of vouchers, unit: minutes","format":"int64"},"currency":{"type":"string","description":"Currency Short Code of voucher. For the values of Currency Short Code, refer to section 5.4.2 of the Open API Access Guide."}},"description":"Summary of all created vouchers, including deleted vouchers"},"OperationResponseVoucherStatisticsHistoryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VoucherStatisticsHistoryOpenApiVO"}}},"VoucherStatisticsHistoryOpenApiVO":{"type":"object","properties":{"summary":{"$ref":"#/components/schemas/VoucherSummaryOpenApiVO"},"usage":{"type":"array","description":"Data points of vouchers","items":{"$ref":"#/components/schemas/VoucherUsageOpenApiVO"}}}},"VoucherUsageOpenApiVO":{"type":"object","properties":{"amount":{"type":"string","description":"Amount of vouchers"},"currency":{"type":"string","description":"Currency Short Code of voucher. For the values of Currency Short Code, refer to section 5.4.2 of the Open API Access Guide."},"count":{"type":"integer","description":"Count of vouchers","format":"int32"},"timeInterval":{"type":"integer","description":"Time interval of each data point","format":"int32"},"time":{"type":"integer","description":"Timestamp of the data point, unit: MS","format":"int64"}},"description":"Data points of vouchers"},"GridVOVoucherUnitPriceDistributionOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VoucherUnitPriceDistributionOpenApiVO"}}}},"OperationResponseGridVOVoucherUnitPriceDistributionOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOVoucherUnitPriceDistributionOpenApiVO"}}},"VoucherUnitPriceDistributionOpenApiVO":{"type":"object","properties":{"unitPrice":{"type":"string","description":"Price of single voucher. It should be within the range of 1–999999999"},"totalAmount":{"type":"string","description":"Total amount of vouchers"},"usedCount":{"type":"integer","description":"Used count of vouchers","format":"int32"},"currency":{"type":"string","description":"Currency Short Code of voucher. For the values of Currency Short Code, refer to section 5.4.2 of the Open API Access Guide."}}},"GridVOVoucherDurationDistributionOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VoucherDurationDistributionOpenApiVO"}}}},"OperationResponseGridVOVoucherDurationDistributionOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOVoucherDurationDistributionOpenApiVO"}}},"VoucherDurationDistributionOpenApiVO":{"type":"object","properties":{"duration":{"type":"integer","description":"Duration of single voucher, unit: minutes","format":"int64"},"durationType":{"type":"integer","description":"The duration type of the voucher. It should be a value as follows: 0: Client duration, each client expires after the duration is used. 1: Voucher duration, after reaching the voucher duration, clients using the voucher will expire","format":"int32"},"totalDuration":{"type":"integer","description":"Total duration of vouchers, unit: minutes","format":"int64"},"usedCount":{"type":"integer","description":"Used count of vouchers","format":"int32"}}},"GridVOVoucherGroupOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VoucherGroupOpenApiVO"}}}},"OperationResponseGridVOVoucherGroupOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOVoucherGroupOpenApiVO"}}},"VoucherGroupOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Voucher group ID"},"name":{"type":"string","description":"Voucher group ID"},"createdTime":{"type":"integer","description":"Create timestamp for the voucher group, unit: millisecond","format":"int64"},"creatorName":{"type":"string","description":"Role of the creator of the voucher group"},"limitType":{"type":"integer","description":"The limitations of the voucher. It should be a value as follows: 0: Limited Usage Counts, 1: Limited Online Users, 2: Unlimited","format":"int32"},"limitNum":{"type":"integer","description":"The number of limitations. It should be within the range of 1–999. If Parameter [limitType] is 0 or 1, [limitNum] should not be null.When Parameter [limitType] is 0, [limitNum] represents the maximum number of times this voucher can be used.When Parameter [limitType] is 1, [limitNum] represents the maximum number of users this voucher can be used at the same time.","format":"int32"},"durationType":{"type":"integer","description":"The duration type of the voucher. It should be a value as follows: 0: Client duration, each client expires after the duration is used. 1: Voucher duration, after reaching the voucher duration, clients using the voucher will expire","format":"int32"},"duration":{"type":"integer","description":"Duration of one use, unit: minute. It should be within the range of 1–14400000.","format":"int64"},"timingType":{"type":"integer","description":"The timing type of the voucher. It should be a value as follows: 0: Timing by time, clients can use vouchers for specified time duration. 1: Timing by usage, clients can use vouchers for the duration of actual usage","format":"int32"},"rateLimit":{"$ref":"#/components/schemas/RateLimitOpenApiVO"},"trafficLimitEnable":{"type":"boolean","description":"Whether to enable traffic limit"},"trafficLimit":{"type":"integer","description":"Traffic limit in MB. It should be within the range of 1–10485760","format":"int64"},"trafficLimitFrequency":{"type":"integer","description":"Frequency of traffic limit should be a value as follows: 0: total; 1: daily; 2: weekly; 3: monthly.","format":"int32"},"unitPrice":{"type":"string","description":"Price of single voucher. It should be within the range of 1–999999999"},"currency":{"type":"string","description":"Currency Short Code of voucher. For the values of Currency Short Code, refer to section 5.4.2 of the Open API Access Guide."},"portalNames":{"type":"array","description":"Bound portal name list","items":{"type":"string","description":"Bound portal name list"}},"applyToAllPortals":{"type":"boolean","description":"Is the voucher effective for all portals, including all newly created portals"},"expirationTime":{"type":"integer","description":"The timestamp of the expiration of the voucher, unit: millisecond","format":"int64"},"effectiveTime":{"type":"integer","description":"The timestamp when the voucher takes effect, unit: millisecond","format":"int64"},"validityType":{"type":"integer","description":"The validity type of the voucher. It should be a value as follows: 0: Voucher can be used at any time, parameter [effectiveTime], [expirationTime] and [schedule] should be null. 1: Voucher can be used between the effective time and expiration time, parameter [effectiveTime] and [expirationTime] should not be null, parameter [schedule] should be null. 2: Voucher can be used within a specified time period by schedule, parameter [effectiveTime] and [expirationTime] should be null, parameter [schedule] should not be null","format":"int32"},"schedule":{"$ref":"#/components/schemas/VoucherScheduleOpenApiVO"},"logout":{"type":"boolean","description":"Whether the voucher support portal logout functionality"},"description":{"type":"string","description":"Description of the voucher group"},"printComments":{"type":"string","description":"Print comments of the voucher group"},"unusedCount":{"type":"integer","description":"Unused voucher counts of the voucher group","format":"int32"},"usedCount":{"type":"integer","description":"Used voucher counts of the voucher group","format":"int32"},"inUseCount":{"type":"integer","description":"In use voucher counts of the voucher group","format":"int32"},"expiredCount":{"type":"integer","description":"Expired voucher counts of the voucher group","format":"int32"},"totalCount":{"type":"integer","description":"Total voucher counts of the voucher group","format":"int32"},"totalAmount":{"type":"string","description":"Total voucher amount of the voucher group"}}},"OperationResponseVoucherGroupGridOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/VoucherGroupGridOpenApiVO"}}},"SimpleVoucherOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Voucher ID"},"code":{"type":"string","description":"Voucher code"},"status":{"type":"integer","description":"Voucher status. It should be a value as follows: 0: unused, 1: in use, 2: expired","format":"int32"},"trafficUsed":{"type":"integer","description":"Used traffic of the voucher, unit: Byte","format":"int64"},"trafficUnused":{"type":"integer","description":"Unused traffic of the voucher, unit: Byte","format":"int64"},"trafficLimit":{"type":"integer","description":"Traffic limit in MB. It should be within the range of 1–10485760","format":"int64"},"trafficLimitFrequency":{"type":"integer","description":"Frequency of traffic limit should be a value as follows: 0: total; 1: daily; 2: weekly; 3: monthly.","format":"int32"},"downLimit":{"type":"integer","description":"Downlink speed limit in Kbps. The value of limit should be within the range of 0–10485760.","format":"int64"},"upLimit":{"type":"integer","description":"Uplink speed limit in Kbps. The value of limit should be within the range of 0–10485760.","format":"int64"},"startTime":{"type":"integer","description":"The expiration date of the voucher, unit: MS","format":"int64"},"timeUsedSec":{"type":"integer","description":"Used duration of voucher, unit: Second","format":"int64"},"timeLeftSec":{"type":"integer","description":"Left duration of voucher, unit: Second","format":"int64"},"timingByClientUsage":{"type":"boolean","description":"Whether the voucher is timing by usage and duration type is client duration. When this parameter is true, will not display parameter [timeUsedSec] and [timeLeftSec]"}},"description":"Voucher pagination data of the voucher group"},"StatisticsCountOpenApiVO":{"type":"object","properties":{"totalUnusedCount":{"type":"integer","description":"Unused voucher counts of the voucher group, unaffected by search","format":"int32"},"totalInUseCount":{"type":"integer","description":"In use voucher counts of the voucher group, unaffected by search","format":"int32"},"totalExpiredCount":{"type":"integer","description":"Expired voucher counts of the voucher group, unaffected by search","format":"int32"},"totalStatisticsCount":{"type":"integer","description":"Total voucher counts of the voucher group, unaffected by search","format":"int32"}},"description":"Represents the quantity of statistics for the voucher group, unaffected by search"},"VoucherGroupGridOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Voucher group ID"},"name":{"type":"string","description":"Voucher group ID"},"createdTime":{"type":"integer","description":"Create timestamp for the voucher group, unit: millisecond","format":"int64"},"creatorName":{"type":"string","description":"Role of the creator of the voucher group"},"limitType":{"type":"integer","description":"The limitations of the voucher. It should be a value as follows: 0: Limited Usage Counts, 1: Limited Online Users, 2: Unlimited","format":"int32"},"limitNum":{"type":"integer","description":"The number of limitations. It should be within the range of 1–999. If Parameter [limitType] is 0 or 1, [limitNum] should not be null.When Parameter [limitType] is 0, [limitNum] represents the maximum number of times this voucher can be used.When Parameter [limitType] is 1, [limitNum] represents the maximum number of users this voucher can be used at the same time.","format":"int32"},"durationType":{"type":"integer","description":"The duration type of the voucher. It should be a value as follows: 0: Client duration, each client expires after the duration is used. 1: Voucher duration, after reaching the voucher duration, clients using the voucher will expire","format":"int32"},"duration":{"type":"integer","description":"Duration of one use, unit: minute. It should be within the range of 1–14400000.","format":"int64"},"timingType":{"type":"integer","description":"The timing type of the voucher. It should be a value as follows: 0: Timing by time, clients can use vouchers for specified time duration. 1: Timing by usage, clients can use vouchers for the duration of actual usage","format":"int32"},"rateLimit":{"$ref":"#/components/schemas/RateLimitOpenApiVO"},"trafficLimitEnable":{"type":"boolean","description":"Whether to enable traffic limit"},"trafficLimit":{"type":"integer","description":"Traffic limit in MB. It should be within the range of 1–10485760","format":"int64"},"trafficLimitFrequency":{"type":"integer","description":"Frequency of traffic limit should be a value as follows: 0: total; 1: daily; 2: weekly; 3: monthly.","format":"int32"},"unitPrice":{"type":"string","description":"Price of single voucher. It should be within the range of 1–999999999"},"currency":{"type":"string","description":"Currency Short Code of voucher. For the values of Currency Short Code, refer to section 5.4.2 of the Open API Access Guide."},"portalNames":{"type":"array","description":"Bound portal name list","items":{"type":"string","description":"Bound portal name list"}},"applyToAllPortals":{"type":"boolean","description":"Is the voucher effective for all portals, including all newly created portals"},"expirationTime":{"type":"integer","description":"The timestamp of the expiration of the voucher, unit: millisecond","format":"int64"},"effectiveTime":{"type":"integer","description":"The timestamp when the voucher takes effect, unit: millisecond","format":"int64"},"validityType":{"type":"integer","description":"The validity type of the voucher. It should be a value as follows: 0: Voucher can be used at any time, parameter [effectiveTime], [expirationTime] and [schedule] should be null. 1: Voucher can be used between the effective time and expiration time, parameter [effectiveTime] and [expirationTime] should not be null, parameter [schedule] should be null. 2: Voucher can be used within a specified time period by schedule, parameter [effectiveTime] and [expirationTime] should be null, parameter [schedule] should not be null","format":"int32"},"schedule":{"$ref":"#/components/schemas/VoucherScheduleOpenApiVO"},"logout":{"type":"boolean","description":"Whether the voucher support portal logout functionality"},"description":{"type":"string","description":"Description of the voucher group"},"printComments":{"type":"string","description":"Print comments of the voucher group"},"voucherPattern":{"$ref":"#/components/schemas/VoucherPatternOpenApiVO"},"unusedCount":{"type":"integer","description":"Unused voucher counts of the voucher group, affected by search","format":"int32"},"usedCount":{"type":"integer","description":"Used voucher counts of the voucher group, affected by search","format":"int32"},"inUseCount":{"type":"integer","description":"In use voucher counts of the voucher group, affected by search","format":"int32"},"expiredCount":{"type":"integer","description":"Expired voucher counts of the voucher group, affected by search","format":"int32"},"totalCount":{"type":"integer","description":"Total voucher counts of the voucher group, affected by search","format":"int32"},"unusedAmount":{"type":"string","description":"Unused voucher amount of the voucher group, unaffected by search"},"usedAmount":{"type":"string","description":"Used voucher amount of the voucher group, unaffected by search"},"totalAmount":{"type":"string","description":"Total voucher amount of the voucher group, unaffected by search"},"statisticsCount":{"$ref":"#/components/schemas/StatisticsCountOpenApiVO"},"totalRows":{"type":"integer","description":"Total rows of vouchers in the voucher group, affected by search","format":"int64"},"currentPage":{"type":"integer","description":"Current page number","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page","format":"int32"},"data":{"type":"array","description":"Voucher pagination data of the voucher group","items":{"$ref":"#/components/schemas/SimpleVoucherOpenApiVO"}}}},"VoucherLogoVO":{"type":"object","properties":{"id":{"type":"string"},"fileName":{"type":"string"},"url":{"type":"string"}},"description":"Logo info of the voucher pattern, used when pattern type is 0"},"VoucherPatternOpenApiVO":{"type":"object","properties":{"patternType":{"type":"integer","description":"0: Logo, 1: Title, 2: Disable","format":"int32"},"patternCode":{"type":"string","description":"Voucher code of the previewed voucher pattern"},"position":{"type":"integer","description":"0: Left, 1: Right, 2: Middle","format":"int32"},"logoPicture":{"$ref":"#/components/schemas/VoucherLogoVO"},"logoSize":{"type":"integer","description":"Logo size of the voucher pattern, used when pattern type is 0","format":"int32"},"title":{"type":"string","description":"Title of the voucher pattern, used when pattern type is 1"},"titleSize":{"type":"integer","description":"Title size of the voucher pattern, used when pattern type is 1","format":"int32"},"ssidNetworkEnable":{"type":"boolean","description":"Whether to print SSIDs and networks on the pattern of the voucher"},"ssidNetworkNameList":{"type":"array","description":"SSID and network name list on the pattern of the voucher","items":{"type":"string","description":"SSID and network name list on the pattern of the voucher"}},"ssidList":{"type":"array","description":"IDs of the SSIDs on the pattern of the voucher","items":{"type":"string","description":"IDs of the SSIDs on the pattern of the voucher"}},"networkList":{"type":"array","description":"IDs of the networks on the pattern of the voucher","items":{"type":"string","description":"IDs of the networks on the pattern of the voucher"}},"durationEnable":{"type":"boolean","description":"Whether to print duration of the voucher"},"limitEnable":{"type":"boolean","description":"Whether to print limit info of the voucher. Limit info is limited usage count or limited online user number depending on the setting of the voucher group."},"printComments":{"type":"string","description":"Comments to print on the voucher"},"validity":{"type":"string","description":"Validity information to print on the voucher"}},"description":"Voucher pattern "},"CurrencyCandidatesOpenApiVO":{"type":"object","properties":{"currencyList":{"type":"array","description":"All currency Short Code list. For the values of Currency Short Code, refer to section 5.4.2 of the Open API Access Guide.","items":{"type":"string","description":"All currency Short Code list. For the values of Currency Short Code, refer to section 5.4.2 of the Open API Access Guide."}},"selectedCurrency":{"type":"string","description":"The currency selected for the site"}}},"OperationResponseCurrencyCandidatesOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CurrencyCandidatesOpenApiVO"}}},"OperationResponseListVoucherConfigLimitOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/VoucherConfigLimitOpenApiVO"}}}},"VoucherConfigLimitOpenApiVO":{"type":"object","properties":{"amountLimit":{"type":"integer","description":"The limit of vouchers in a voucher group","format":"int32"}}},"GridVOVoucherGroupOptionOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/VoucherGroupOptionOpenApiVO"}}}},"OperationResponseGridVOVoucherGroupOptionOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOVoucherGroupOptionOpenApiVO"}}},"VoucherGroupOptionOpenApiVO":{"type":"object","properties":{"groupId":{"type":"string","description":"Voucher group ID"},"name":{"type":"string","description":"Voucher group name"}}},"FormAuthOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Auth form ID"},"title":{"type":"string","description":"Form title (display for the authentication user). It should contain 1-2000 characters."},"name":{"type":"string","description":"Form name (display for the controller user). It should contain 1-2000 characters."},"note":{"type":"string","description":"Note should contain 1-2000 characters."},"authTimeout":{"$ref":"#/components/schemas/AuthTimeOpenApiVO"},"cardList":{"type":"array","description":"Form card list.","items":{"$ref":"#/components/schemas/FormAuthCardOpenApiVO"}},"isPublished":{"type":"boolean","description":"Whether to publish."},"createTime":{"type":"integer","description":"Created time of the form.","format":"int64"},"portals":{"type":"array","description":"Portal names corresponding to the bound portal.","items":{"type":"string","description":"Portal names corresponding to the bound portal."}},"answerNum":{"type":"integer","description":"The number of form's answers.","format":"int64"}}},"OperationResponseListFormAuthOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/FormAuthOpenApiVO"}}}},"OperationResponseFormAuthOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/FormAuthOpenApiVO"}}},"FormAuthCardAnswerOpenApiVO":{"type":"object","properties":{"type":{"type":"integer","description":"Type should be a value as follows: 0: single choice; 1: multiple choice; 2: ComboBox; 3: input; 4: score; 5: prompt box","format":"int32"},"choiceAnswer":{"type":"array","description":"Drop-down menu or answer list for multiple-choice questions (exists if and only if cardType is 0, 1, 2)","items":{"type":"integer","description":"Drop-down menu or answer list for multiple-choice questions (exists if and only if cardType is 0, 1, 2)","format":"int32"}},"inputAnswer":{"type":"string","description":"Answers entered by the user, which corresponds to the question and answer question or the scored evaluation, or the input of other options in the multiple-choice question. Determined according to the type field. 0, 1, and 2 indicate other options answers, 3 indicates the answer in the input box, and 4 indicates the scored evaluation. InputAnswer should contain 1-2000 characters"},"score":{"type":"integer","description":"User rating (should be within the range of 1-5), exists when type is 4","format":"int32"},"others":{"type":"string","description":"Exists when cardType is 0, 1 and the user adds other options. Used to save the option answer corresponding to the prompt of other options. Assuming that the user adds two other options, D and E, and choiceAnswer contains 3 ( D), 4 (E), then others[0] represents the answer of option D. Others should contain 1-2000 characters"}},"description":"Answers submitted by users."},"FormAuthResultOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Form result ID"},"formId":{"type":"string","description":"This field represents authentication survey ID. Authentication survey can be created using 'Create a new authentication survey' interface, and authentication survey ID can be obtained from 'Get authentication survey list' interface."},"answers":{"type":"array","description":"Answers submitted by users.","items":{"$ref":"#/components/schemas/FormAuthCardAnswerOpenApiVO"}},"time":{"type":"integer","description":"Authenticated timestamp in ms.","format":"int64"},"ssid":{"type":"string","description":"Client connected SSID."},"network":{"type":"string","description":"Network (exists when wired connection)."}}},"GridVOFormAuthResultOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/FormAuthResultOpenApiVO"}}}},"OperationResponseGridVOFormAuthResultOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOFormAuthResultOpenApiVO"}}},"OperationResponseFormAuthResultOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/FormAuthResultOpenApiVO"}}},"GridVOOperator Response":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Operator Response"}}}},"OperationResponseGridVOOperator Response":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOOperator Response"}}},"Operator Response":{"required":["name","password","selectedSites"],"type":"object","properties":{"id":{"type":"string","description":"Operator ID"},"name":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"Operator name should contain 1 to 128 ASCII characters."},"password":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"Operator password should contain 1 to 128 ASCII characters."},"note":{"pattern":"^[^ ]$|^[^ ].{0,254}[^ ]$","type":"string","description":"Operator note should contain 1 to 256 ASCII characters."},"operatorRoleType":{"type":"integer","description":"Operator role type should be a value as follows: 0: Administrator; 1: Viewer.","format":"int32"},"sites":{"type":"array","description":"Site ID List","items":{"$ref":"#/components/schemas/SiteInfoOpenApiVO"}},"selectedSites":{"maxItems":2147483647,"minItems":1,"type":"array","description":"Selected site ID list should contain at least one site for each operator.","items":{"maxLength":2147483647,"minLength":1,"type":"string","description":"Selected site ID list should contain at least one site for each operator."}}}},"OperationResponseOperator Response":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Operator Response"}}},"GridVOLocalUserOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/LocalUserOpenApiVO"}}}},"LocalUserOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Local user ID"},"userName":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"User name should contain 1 to 128 characters"},"password":{"type":"string","description":"Password should contain 1 to 128 characters"},"enable":{"type":"boolean","description":"Local user enable status"},"expirationTime":{"type":"integer","description":"Expiration time, unit: ms","format":"int64"},"bindingType":{"type":"integer","description":"MAC binding type should be a value as follows: 0: no binding; 1: static binding; 2: dynamic binding.","format":"int32"},"macAddress":{"type":"string","description":"Mac address,the value is only available when the macType is static binding or dynamic binding."},"maxUsers":{"type":"integer","description":"The maximum number of users online at the same time when the MAC binding type is No Binding. It cannot be modified after initialization. Value of Maximum Users should be within the range of 1-2048.","format":"int32"},"name":{"pattern":"^$|^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,126}[^ ]$","type":"string","description":"Name"},"phone":{"type":"string","description":"Phone number should contain 1 to 20 characters."},"rateLimit":{"$ref":"#/components/schemas/RateLimitOpenApiVO"},"trafficLimitEnable":{"type":"boolean","description":"Whether to enable traffic limit."},"trafficLimit":{"type":"integer","description":"Traffic limit in MB. The value should be within the range of 1–10485760.","format":"int64"},"trafficLeft":{"type":"boolean","description":"Is there any remaining traffic."},"trafficUsed":{"type":"integer","description":"Used traffic(MB).","format":"int64"},"trafficLimitFrequency":{"type":"integer","description":"Frequency of traffic limit should be a value as follows: 0: total; 1: daily; 2: weekly; 3: monthly.","format":"int32"},"used":{"type":"integer","description":"Used quantity.","format":"int32"},"overtime":{"type":"boolean","description":"Whether the current time has exceeded the expirationTime"},"portals":{"type":"array","description":"Bound portal names.","items":{"type":"string","description":"Bound portal names."}},"logout":{"type":"boolean","description":"local user logout. enable local user logout."},"applyToAllPortals":{"type":"boolean","description":"Is the localuser effective for all portals, including all newly created portals"},"dailyLimitEnable":{"type":"boolean","description":"Whether to enable localuser daily time limit"},"dailyLimit":{"$ref":"#/components/schemas/AuthTimeOpenApiVO"},"dailyLimitMs":{"type":"integer","description":"Daily time limit, unit is ms, required when parameter [dailyLimitEnable] is true","format":"int64"},"dailyLimitLeftMs":{"type":"integer","description":"Daily time left, unit is ms, required when parameter [dailyLimitEnable] is true","format":"int64"}}},"OperationResponseGridVOLocalUserOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOLocalUserOpenApiVO"}}},"OperationResponseLocalUserOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/LocalUserOpenApiVO"}}},"AuthTypeDistributionVO":{"type":"object","properties":{"noAuth":{"type":"integer","format":"int32"},"simplePassword":{"type":"integer","format":"int32"},"hotspot":{"type":"integer","format":"int32"},"facebook":{"type":"integer","format":"int32"},"externalRadius":{"type":"integer","format":"int32"},"externalPortal":{"type":"integer","format":"int32"},"ldap":{"type":"integer","format":"int32"},"google":{"type":"integer","format":"int32"}}},"AuthedClientNumVO":{"type":"object","properties":{"newNum":{"type":"integer","format":"int32"},"existingNum":{"type":"integer","format":"int32"},"startTime":{"type":"integer","format":"int64"},"endTime":{"type":"integer","format":"int64"}}},"HotspotStatisticVO":{"type":"object","properties":{"lastConnection":{"type":"array","items":{"$ref":"#/components/schemas/AuthedClientNumVO"}},"authTypeDistribution":{"$ref":"#/components/schemas/AuthTypeDistributionVO"},"hotspotDistribution":{"$ref":"#/components/schemas/HotspotTypeDistributionVO"}}},"HotspotTypeDistributionVO":{"type":"object","properties":{"total":{"type":"integer","format":"int32"},"voucher":{"type":"integer","format":"int32"},"localUser":{"type":"integer","format":"int32"},"sms":{"type":"integer","format":"int32"},"form":{"type":"integer","format":"int32"},"hotspotRadius":{"type":"integer","format":"int32"}}},"OperationResponseHotspotStatisticVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/HotspotStatisticVO"}}},"AuthClientOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"AuthRecord ID"},"name":{"type":"string","description":"Client name"},"mac":{"type":"string","description":"Client MAC"},"wireless":{"type":"boolean","description":"Is it wireless type"},"ssid":{"type":"string","description":"SSID name"},"networkName":{"type":"string","description":"Network name"},"authType":{"type":"integer","description":"Auth type should be a value as follows: 0: No Auth; 1: Simple Password; 2: Exrternal Radius; 3: Voucher; 4: External Portal Server; 5: Local User; 6: SMS; 7: Facebook; 8: Hotspot Radius; 9: Mac Auth (with fail over); 10: Admin auth; 12: Form auth","format":"int32"},"fbVer":{"type":"integer","description":"Version of Facebook Wi-Fi (authType = Facebook or Facebook V2)","format":"int32"},"download":{"type":"integer","description":"Total Download (Byte)","format":"int64"},"upload":{"type":"integer","description":"Total Upload (Byte)","format":"int64"},"duration":{"type":"integer","description":"Total Duration (s)","format":"int64"},"start":{"type":"integer","description":"Start timestamp","format":"int64"},"end":{"type":"integer","description":"End timestamp","format":"int64"},"valid":{"type":"boolean","description":"Is the client valid"},"localUserName":{"type":"string","description":"LocalUser Name (authType = Local User)"},"voucherCode":{"type":"string","description":"Voucher code (authType = Voucher)"},"formName":{"type":"string","description":"Form name (authType = form auth)"},"radiusUsername":{"type":"string","description":"Radius userName (authType = External RADIUS or Hotspot RADIUS)"},"adminName":{"type":"string","description":"Admin name (authType = ADMIN)"},"ip":{"type":"string","description":"IP address at the time of authentication"}}},"GridVOAuthClientOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AuthClientOpenApiVO"}}}},"OperationResponseGridVOAuthClientOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOAuthClientOpenApiVO"}}},"AnomalyStateVO":{"type":"object","properties":{"critical":{"type":"integer","format":"int32"},"error":{"type":"integer","format":"int32"},"warning":{"type":"integer","format":"int32"},"info":{"type":"integer","format":"int32"}},"description":"Incident counts of different severity levels"},"HealthStatisticsScoreVO":{"type":"object","properties":{"goodCount":{"type":"integer","description":"The number of good level device or client, whose health score is between 8 and 10","format":"int32"},"averageCount":{"type":"integer","description":"The number of average level device or client, whose health score is between 4 and 7","format":"int32"},"poorCount":{"type":"integer","description":"The number of good poor device or client, whose health score is between 1 and 3","format":"int32"},"noDataCount":{"type":"integer","description":"The number of noData level device or client, whose health score is 0","format":"int32"}},"description":"Client health score detail"},"OperationResponseSiteScoreTimelineListVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteScoreTimelineListVO"}}},"SiteDeviceSubHealthScoreVO":{"type":"object","properties":{"osgHealthScoreDetail":{"$ref":"#/components/schemas/HealthStatisticsScoreVO"},"oswHealthScoreDetail":{"$ref":"#/components/schemas/HealthStatisticsScoreVO"},"apHealthScoreDetail":{"$ref":"#/components/schemas/HealthStatisticsScoreVO"}},"description":"Device health score detail"},"SiteScoreTimelineListVO":{"type":"object","properties":{"scores":{"type":"array","items":{"$ref":"#/components/schemas/SiteScoreTimelineVO"}}}},"SiteScoreTimelineVO":{"type":"object","properties":{"time":{"type":"integer","description":"Time(unit:ms)","format":"int64"},"siteHealthScore":{"type":"integer","description":"Site health score","format":"int32"},"deviceHealthScore":{"type":"integer","description":"Device health score","format":"int32"},"clientHealthScore":{"type":"integer","description":"Client health score","format":"int32"},"wifiHealthScore":{"type":"integer","description":"Wifi health score","format":"int32"},"wanHealthScore":{"type":"integer","description":"WAN health score","format":"int32"},"scoreDetail":{"$ref":"#/components/schemas/SiteSubHealthScoreVO"}}},"SiteSubHealthScoreVO":{"type":"object","properties":{"deviceHealthScoreDetail":{"$ref":"#/components/schemas/SiteDeviceSubHealthScoreVO"},"clientHealthScoreDetail":{"$ref":"#/components/schemas/HealthStatisticsScoreVO"},"wanScoreDetail":{"$ref":"#/components/schemas/WanHealthListVO"},"incidentDetail":{"$ref":"#/components/schemas/AnomalyStateVO"}},"description":"Sub dimension health score Detail, such as device health、client health、wan health"},"WanHealthItemVO":{"type":"object","properties":{"name":{"type":"string","description":"WAN name"},"port":{"type":"integer","description":"WAN port number","format":"int32"},"latency":{"type":"string","description":"Latency"},"jitter":{"type":"string","description":"Jitter"},"packetLoss":{"type":"number","description":"Packet loss","format":"float"},"throughput":{"type":"integer","description":"Throughput","format":"int32"}}},"WanHealthListVO":{"type":"object","properties":{"wanList":{"type":"array","items":{"$ref":"#/components/schemas/WanHealthItemVO"}}},"description":"WAN health score detail"},"OperationResponseListAnomalyBriefCountVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/AnomalyBriefCountVO"}}}},"OperationResponseWanDetails":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/WanDetails"}}},"WanDetailVO":{"type":"object","properties":{"port":{"type":"integer","format":"int32"},"name":{"type":"string"},"ip":{"type":"string"},"proto":{"type":"integer","format":"int32"},"speed":{"type":"integer","format":"int32"},"duplex":{"type":"integer","format":"int32"},"rx":{"type":"integer","format":"int64"},"tx":{"type":"integer","format":"int64"},"rxRate":{"type":"integer","format":"int64"},"txRate":{"type":"integer","format":"int64"},"latency":{"type":"integer","format":"int32"},"loss":{"type":"number","format":"double"}},"description":"Gateway wan port detail list"},"WanDetails":{"type":"object","properties":{"wanDetails":{"type":"array","description":"Gateway wan port detail list","items":{"$ref":"#/components/schemas/WanDetailVO"}}}},"ClientScoreTimelineListVO":{"type":"object","properties":{"scores":{"type":"array","items":{"$ref":"#/components/schemas/HealthStatisticsTimeScoreItemVO"}}}},"HealthStatisticsTimeScoreItemVO":{"type":"object","properties":{"time":{"type":"integer","description":"Time(unit:ms)","format":"int64"},"scoreDetail":{"$ref":"#/components/schemas/HealthStatisticsScoreVO"}}},"OperationResponseClientScoreTimelineListVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ClientScoreTimelineListVO"}}},"EnableFullChannelDetectApInfoOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"Mac address"},"name":{"type":"string","description":"Default uses the MAC address as the name."},"model":{"type":"string","description":"Model, such as EAP225."},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"type":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"ip":{"type":"string","description":"Ip address,such as 192.168.0.105"},"statusCategory":{"type":"integer","description":"Category of device status,statusCategory should be a value as follows: 0:Disconnected;1:Connected;2:Pending;3:Heartbeat Missed;4:Isolated","format":"int32"},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected;1:Disconnected(Migrating);10:Provisioning;11:Configuring;12:Upgrading;13:Rebooting;14:Connected;15:Connected(Wireless);16:Connected(Migrating);17:Connected(Wireless,Migrating);20:Pending;21:Pending(Wireless);22:Adopting;23:Adopting(Wireless);24:Adopt Failed;25:Adopt Failed(Wireless);26:Managed By Others;27:Managed By Others(Wireless);30:Heartbeat Missed;31:Heartbeat Missed(Wireless);32:Heartbeat Missed(Migrating);33:Heartbeat Missed(Wireless,Migrating);40:Isolated;41:Isolated(Migrating);50:Slice Configuring","format":"int32"},"version":{"type":"string","description":"Software version, such as \"2.5.0,\" extracted from DeviceDO.firmwareVersion - \"2.5.0 Build 20190118 Rel. 64821.\""},"addedInAdvanced":{"type":"boolean","description":"Whether the device is added in advanced."},"uptimeLong":{"type":"integer","description":"Runtime duration, in seconds (s).","format":"int64"},"wirelessLinked":{"type":"boolean","description":"Whether the device is wireless linked."},"scanStatus":{"type":"integer","description":"Scan Status of device,status should be a value as follows:  0:Not Scanned, 1:Spectrum Scanning, 2:RFScanning, 3:packet capturing, 4:RFPlanning;","format":"int32"},"powerModeList":{"type":"array","description":"Indicating the power supply modes for AP devices across frequency bands, with array indices corresponding to the frequency bands: 0: 2.4G 1: 5G/5G1 2: 5G2 3: 6G. The corresponding values for power supply modes are: 0: Normal operation 1: Power limited 2: Frequency band disabled","items":{"type":"integer","description":"Indicating the power supply modes for AP devices across frequency bands, with array indices corresponding to the frequency bands: 0: 2.4G 1: 5G/5G1 2: 5G2 3: 6G. The corresponding values for power supply modes are: 0: Normal operation 1: Power limited 2: Frequency band disabled","format":"int32"}}}},"OperationResponseListEnableFullChannelDetectApInfoOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/EnableFullChannelDetectApInfoOpenApiVO"}}}},"GridVOUpgradeableDevices":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/upgradeableDevices"}}}},"OperationResponseGridVOUpgradeableDevices":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOUpgradeableDevices"}}},"upgradeableDevices":{"type":"object","properties":{"name":{"type":"string","description":"Device name"},"mac":{"type":"string","description":"Device MAC"},"type":{"type":"string","description":"Device type"},"model":{"type":"string","description":"Device model name with version"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected;1:Disconnected(Migrating);10:Provisioning;11:Configuring;12:Upgrading;13:Rebooting;14:Connected;15:Connected(Wireless);16:Connected(Migrating);17:Connected(Wireless,Migrating);20:Pending;21:Pending(Wireless);22:Adopting;23:Adopting(Wireless);24:Adopt Failed;25:Adopt Failed(Wireless);26:Managed By Others;27:Managed By Others(Wireless);30:Heartbeat Missed;31:Heartbeat Missed(Wireless);32:Heartbeat Missed(Migrating);33:Heartbeat Missed(Wireless,Migrating);40:Isolated;41:Isolated(Migrating);50:Slice Configuring","format":"int32"},"latestVersion":{"type":"string","description":"Latest version"},"omadacId":{"type":"string","description":"ID of current Controller."},"siteId":{"type":"string","description":"ID of current Site."},"licenseStatus":{"type":"integer","description":"Device license status (Only for cloud base) should be a value as follows: 0: unActive; 1: Unbind; 2: Expired; 3: active","format":"int32"},"statusCategory":{"type":"integer","description":"Device status category should be a value as follows: 0: Disconnected; 1: Connected; 2: Pending; 3: Heartbeat Missed; 4: Isolated","format":"int32"},"version":{"type":"string","description":"The device firmware version."},"addedInAdvanced":{"type":"boolean","description":"Whether the device is added in advanced."},"active":{"type":"boolean","description":"whether to active the device(cloud base exclusive)"},"wirelessLinked":{"type":"boolean","description":"whether ap is wireless linked"},"fwDownload":{"type":"boolean","description":"Indicates whether the upgrade status is downloading"},"needUpgrade":{"type":"boolean","description":"Indicates whether an upgrade is required"}}},"DeviceInfo":{"type":"object","properties":{"mac":{"type":"string","description":"Device MAC"},"name":{"type":"string","description":"Device name"},"type":{"type":"string","description":"Device type"},"subtype":{"type":"string","description":"Switch subtype should be a value as follows: smart: Non-Agile Series Switch; es: Agile Series Switch."},"deviceSeriesType":{"type":"integer","description":"Device series type. 0 means basic, 1 means pro.","format":"int32"},"model":{"type":"string","description":"Device model name with version"},"modelName":{"type":"string","description":"Device model name"},"ip":{"type":"string","description":"Device IP"},"ipv6":{"type":"array","description":"Device IPv6 list","items":{"type":"string","description":"Device IPv6 list"}},"uptime":{"type":"string","description":"Device uptime"},"status":{"type":"integer","description":"Device status should be a value as follows: 0: Disconnected; 1: Connected; 2: Pending; 3: Heartbeat Missed; 4: Isolated","format":"int32"},"detailStatus":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected;1:Disconnected(Migrating);10:Provisioning;11:Configuring;12:Upgrading;13:Rebooting;14:Connected;15:Connected(Wireless);16:Connected(Migrating);17:Connected(Wireless,Migrating);20:Pending;21:Pending(Wireless);22:Adopting;23:Adopting(Wireless);24:Adopt Failed;25:Adopt Failed(Wireless);26:Managed By Others;27:Managed By Others(Wireless);30:Heartbeat Missed;31:Heartbeat Missed(Wireless);32:Heartbeat Missed(Migrating);33:Heartbeat Missed(Wireless,Migrating);40:Isolated;41:Isolated(Migrating);50:Slice Configuring","format":"int32"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"lastSeen":{"type":"integer","description":"Device lastSeen","format":"int64"},"cpuUtil":{"type":"integer","description":"Device cpuUtil","format":"int32"},"memUtil":{"type":"integer","description":"Device memUtil","format":"int32"},"sn":{"type":"string","description":"Device serial number"},"licenseStatus":{"type":"integer","description":"Device license status (Only for cloud base) should be a value as follows: 0: unActive; 1: Unbind; 2: Expired; 3: active","format":"int32"},"tagName":{"type":"string","description":"Device tag name"},"uplinkDeviceMac":{"type":"string","description":"Uplink device mac"},"uplinkDeviceName":{"type":"string","description":"Uplink device name"},"uplinkDevicePort":{"type":"string","description":"Uplink device port"},"linkSpeed":{"type":"integer","description":"Device uplink port linkSpeed, linkSpeed should be a value as follows: 0: Auto; 1: 10M; 2: 100M; 3: 1000M; 4: 2500M; 5: 10G; 6: 5G; 7: 25G, 8: 100G.","format":"int32"},"duplex":{"type":"integer","description":"Device uplink port duplex mode, duplex should be a value as follows: 0: Auto; 1: Half; 2: Full.","format":"int32"},"switchConsistent":{"type":"boolean","description":"Whether the device can be adopted by the site."},"publicIp":{"type":"string","description":"Device public IP"},"firmwareVersion":{"type":"string","description":"The device firmware version."},"compatible":{"type":"integer","description":"The compatible type of device.","format":"int32"},"active":{"type":"boolean","description":"Indicates whether the device is activated."},"inWhiteList":{"type":"boolean","description":"Whether the device is in white list."},"supportAfc":{"type":"boolean","description":"Whether the device supports AFC."}}},"GridVODeviceInfo":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceInfo"}}}},"OperationResponseGridVODeviceInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVODeviceInfo"}}},"AdoptedDeviceGridVODeviceInfo":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceInfo"}},"stackData":{"type":"array","items":{"$ref":"#/components/schemas/OswStackDataVODeviceInfo"}},"mlagData":{"type":"array","items":{"$ref":"#/components/schemas/OswMlagDataVODeviceInfo"}},"p2pGroupTotalRows":{"type":"integer","format":"int64"}}},"OperationResponseAdoptedDeviceGridVODeviceInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AdoptedDeviceGridVODeviceInfo"}}},"OswMlagDataVODeviceInfo":{"type":"object","properties":{"mlagId":{"type":"string"},"mlagName":{"type":"string"},"mlagStatus":{"type":"integer","format":"int32"},"mlagMembers":{"type":"array","items":{"$ref":"#/components/schemas/OswMlagMemberPortVO"}},"member":{"type":"array","items":{"$ref":"#/components/schemas/DeviceInfo"}}}},"OswMlagMemberPortVO":{"type":"object","properties":{"lagId":{"type":"integer","format":"int32"},"mlagEnable":{"type":"boolean"},"macLagNames":{"type":"object","additionalProperties":{"type":"string"}},"macPorts":{"type":"object","additionalProperties":{"type":"array","items":{"type":"integer","format":"int32"}}}}},"OswStackDataVODeviceInfo":{"type":"object","properties":{"stackId":{"type":"string"},"stackName":{"type":"string"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"showModel":{"type":"string","description":"Model complex shown in the front end.Ap：model+(country)+modelVersion,EAP225(EU) v3.0  Gateway/Switch：model+modelVersion,Osg v3.0"},"masterMac":{"type":"string"},"unSelectedablePorts":{"type":"array","description":"The unSelectedable ports of the device.","items":{"$ref":"#/components/schemas/PortVO"}},"stackStatus":{"type":"integer","format":"int32"},"abnormalReason":{"type":"integer","format":"int32"},"member":{"type":"array","items":{"$ref":"#/components/schemas/DeviceInfo"}},"lags":{"type":"array","items":{"$ref":"#/components/schemas/OswLagStatusVO"}},"supportCustomDhcpOption":{"type":"boolean"},"supportDhcpRange":{"type":"boolean"},"supportVrf":{"type":"boolean"},"supportAutoAddVlan":{"type":"boolean"},"devCap":{"$ref":"#/components/schemas/OswDevCapVO"},"customStandardPorts":{"type":"array","description":"The standard ports that has some vlan not included in port vlan.","items":{"type":"string","description":"The standard ports that has some vlan not included in port vlan."}},"customLagIds":{"type":"array","description":"The lag ids that has some vlan not included in port vlan.","items":{"type":"integer","description":"The lag ids that has some vlan not included in port vlan.","format":"int32"}},"supportLayout":{"type":"boolean","description":"Whether the device supports reporting port layout information."}}},"GatewayInfo":{"type":"object","properties":{"mac":{"type":"string","description":"Gateway MAC address"},"showModel":{"type":"string","description":"Gateway model description"},"firmwareVersion":{"type":"string","description":"Gateway software version"},"ip":{"type":"string","description":"Gateway IPv4"},"uptime":{"type":"string","description":"Gateway uptime"},"temp":{"type":"integer","description":"Gateway temperature","format":"int32"},"cpuUtil":{"type":"integer","description":"Gateway cpu utilization rate","format":"int32"},"memUtil":{"type":"integer","description":"Gateway memory utilization rate","format":"int32"},"ipv6List":{"type":"array","description":"IPv6 address List","items":{"type":"string","description":"IPv6 address List"}},"lastSeen":{"type":"integer","description":"Last seen time","format":"int64"},"portConfigs":{"type":"array","description":"Gateway port configs","items":{"$ref":"#/components/schemas/GatewayPortConfig"}},"multiChipGateway":{"type":"boolean","description":"Whether this gateway is a multi-chip gateway"},"multiChipInfos":{"type":"array","description":"Only ports within the same group can be mirrored","items":{"type":"array","description":"Only ports within the same group can be mirrored","items":{"type":"integer","description":"Only ports within the same group can be mirrored","format":"int32"}}}}},"OperationResponseGatewayInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GatewayInfo"}}},"OperationResponseListGateway Wan Status Entity":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/gateway wan status entity"}}}},"gateway wan status entity":{"type":"object","properties":{"port":{"type":"integer","description":"Port serial number","format":"int32"},"name":{"type":"string","description":"Port name"},"mac":{"type":"string","description":"Port mac"},"portDesc":{"type":"string","description":"Port description"},"type":{"type":"integer","description":"Port type, 0:WAN,1:WAN/LAN,2:LAN;","format":"int32"},"physicalType":{"type":"integer","format":"int32"},"mode":{"type":"integer","description":"Port mode, 0:WAN,1:LAN;","format":"int32"},"poe":{"type":"boolean","description":"Port poe power supply, 1 for active, 0 or null for not"},"poePower":{"type":"number","description":"Port poe power","format":"double"},"status":{"type":"integer","description":"Port status should be a value as follows: 0: disconnected; 1: connected","format":"int32"},"internetState":{"type":"integer","description":"Wan internet state should be a value as follows: 0: disconnected; 1: connected","format":"int32"},"ip":{"type":"string","description":"Ip"},"onlineDetection":{"type":"integer","format":"int32"},"ip2":{"type":"string","description":"Ip2"},"speed":{"type":"integer","description":"Port speed, 1-10M，2-100M，3-1000M","format":"int32"},"duplex":{"type":"integer","description":"Port duplex, 1-Half，2-Full","format":"int32"},"rx":{"type":"integer","description":"Port total rx bytes","format":"int64"},"rxPkt":{"type":"integer","description":"Port total rx packets","format":"int64"},"rxPktRate":{"type":"integer","description":"Port rx Packet rate, Unit: Pkt/s;","format":"int64"},"rxRate":{"type":"integer","description":"Port rx rate, Unit: KB/s;","format":"int64"},"tx":{"type":"integer","description":"Port total tx bytes","format":"int64"},"txPkt":{"type":"integer","description":"Port total tx packets","format":"int64"},"txPktRate":{"type":"integer","description":"Port tx packet rate, Unit: Pkt/s;","format":"int64"},"txRate":{"type":"integer","description":"Port tx rate, Unit: KB/s;","format":"int64"},"proto":{"type":"string","description":"WAN IPv4 connection type, it supports Static IP, DHCP, PPPoE, L2TP, PPTP, DS-Lite, and MAP-E."},"wanIpv6Comptent":{"type":"integer","description":"Gateway wan ipv6 component version","format":"int32"},"wanPortIpv6Config":{"$ref":"#/components/schemas/OsgWanPortIpv6ConfigVO"},"wanPortIpv4Config":{"$ref":"#/components/schemas/OsgWanPortIpv4ConfigVO"},"mirroredPorts":{"type":"array","description":"Mirrored ports","items":{"$ref":"#/components/schemas/MirroredPort"}},"healthLevel":{"type":"integer","description":"Wan health level","format":"int32"},"latency":{"type":"integer","description":"Wan latency, when mode is wan and device is connected, Unit: ms","format":"int32"},"loss":{"type":"number","description":"Wan packet loss rate, Unit : %","format":"double"},"txTrainingRate":{"type":"integer","description":"Upload current training rate.","format":"int64"},"rxTrainingRate":{"type":"integer","description":"Download current training rate.","format":"int64"},"isp":{"type":"string"},"cardStatus":{"type":"integer","format":"int32"},"internetStatus":{"type":"integer","format":"int32"},"netType":{"type":"integer","format":"int32"},"band":{"type":"string"},"signal":{"type":"integer","format":"int32"},"rsrp":{"type":"integer","format":"int32"},"rsrq":{"type":"integer","format":"int32"},"snr":{"type":"integer","format":"int32"},"dataUsage":{"type":"number","format":"float"},"totalData":{"type":"number","format":"float"},"ispVersion":{"type":"string"},"roamingStatus":{"type":"integer","format":"int32"},"trafficStatus":{"type":"integer","format":"int32"},"supportSms":{"type":"boolean"},"smsOperator":{"type":"string"},"simCardUsed":{"type":"integer","format":"int32"},"dslModulationType":{"type":"integer","format":"int32"},"annexType":{"type":"integer","format":"int32"},"lineStatus":{"type":"integer","format":"int32"},"maxRxRate":{"type":"integer","format":"int64"},"maxTxRate":{"type":"integer","format":"int64"},"rxSnrMargin":{"type":"integer","format":"int64"},"txSnrMargin":{"type":"integer","format":"int64"},"rxLineAttenuation":{"type":"integer","format":"int64"},"txLineAttenuation":{"type":"integer","format":"int64"},"rxErrorPkts":{"type":"integer","format":"int64"},"txErrorPkts":{"type":"integer","format":"int64"}}},"OperationResponseSpeedTestV2ResultVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SpeedTestV2ResultVO"}}},"SpeedTestV2ResultItemVO":{"type":"object","properties":{"portId":{"type":"integer","description":"The id of physical wan port.","format":"int32"},"virtualWanEntryId":{"type":"integer","description":"The entry id of virtual wan.","format":"int32"},"time":{"type":"integer","description":"Time of speed test.","format":"int64"},"portName":{"type":"string","description":"The name of wan or virtual wan."},"isp":{"type":"string","description":"Name of isp."},"serverName":{"type":"string","description":"Name of speed test server."},"serverLocation":{"type":"string","description":"Location of speed test server."},"status":{"type":"integer","description":"The status of this wan port speed test result.","format":"int32"},"latency":{"type":"integer","description":"The latency of this wan port speed test result.","format":"int32"},"down":{"type":"integer","description":"The download speed of this wan port speed test result.","format":"int64"},"up":{"type":"integer","description":"The upload speed of this wan port speed test result.","format":"int64"},"progress":{"type":"number","description":"The progress of this wan port speed test result.","format":"double"}}},"SpeedTestV2ResultVO":{"type":"object","properties":{"status":{"type":"integer","format":"int32"},"portSpeedResults":{"type":"array","items":{"$ref":"#/components/schemas/SpeedTestV2ResultItemVO"}}}},"OperationResponseOsgSimCardOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OsgSimCardOpenApiVO"}}},"OsgSimCardOpenApiVO":{"type":"object","properties":{"simCardUsed":{"type":"integer","description":"1: SIM1; 2:SIM2","format":"int32"}}},"OperationResponseOutboxMessageOpenApiGridVOOutboxMessage":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OutboxMessageOpenApiGridVOOutboxMessage"}}},"OutboxMessage":{"type":"object","properties":{"id":{"type":"integer","description":"Item ID.","format":"int32"},"content":{"type":"string","description":"Message content."},"time":{"type":"integer","description":"Time.","format":"int64"},"receiver":{"type":"string","description":"Receiver."}}},"OutboxMessageOpenApiGridVOOutboxMessage":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OutboxMessage"}},"cardStatus":{"type":"integer","description":"Sim card status.","format":"int32"}}},"GridVOInboxMessage":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/InboxMessage"}}}},"InboxMessage":{"type":"object","properties":{"id":{"type":"integer","description":"Item ID.","format":"int32"},"content":{"type":"string","description":"Message content."},"time":{"type":"integer","description":"Time.","format":"int64"},"sender":{"type":"string","description":"Sender."},"unread":{"type":"boolean","description":"Unread or not."}}},"OperationResponseGridVOInboxMessage":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOInboxMessage"}}},"ApnProfileData":{"type":"object","properties":{"supportDualSim":{"type":"integer","description":"Support dual sim card or not","format":"int32"},"data":{"type":"array","description":"Apn profile list","items":{"$ref":"#/components/schemas/ApnProfile"}}}},"OperationResponseApnProfileData":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApnProfileData"}}},"GatewayPortInfos":{"type":"object","properties":{"osgPortInfos":{"type":"array","description":"Gateway port info list","items":{"$ref":"#/components/schemas/OsgPortInfoVO"}}}},"OperationResponseGatewayPortInfos":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GatewayPortInfos"}}},"OsgPortInfoVO":{"type":"object","properties":{"port":{"type":"integer","format":"int32"},"name":{"type":"string"},"type":{"type":"integer","format":"int32"},"physicalType":{"type":"integer","format":"int32"},"mode":{"type":"integer","format":"int32"}},"description":"Gateway port info list"},"OperationResponseOsgPinDetailOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OsgPinDetailOpenApiVO"}}},"OsgPinDetailOpenApiVO":{"type":"object","properties":{"cardStatus":{"type":"integer","description":"cardStatus: 0:no_sim, 1:unknown, 2:pin_lock, 3:pin_verified, 4:ready, 5:puk_lock, 6:blocked","format":"int32"},"pinLock":{"type":"boolean","description":"Whether the PIN has a lock or not."},"autoUnLock":{"type":"boolean","description":"Whether or not PIN is automatically unlocked."},"tryPinLimit":{"type":"integer","description":"The number of times the PIN can be entered incorrectly.","format":"int32"},"tryPukLimit":{"type":"integer","description":"The number of times the PUK can be entered incorrectly.","format":"int32"},"simCardUsed":{"type":"integer","description":"When the device supports Dual-SIM card, parameter [simCardUsed] should not be null.1: SIM1; 2: SIM2.","format":"int32"}}},"OperationResponseIpv6ForIpptOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Ipv6ForIpptOpenApiVO"}}},"LanStatus":{"type":"object","properties":{"vlan":{"type":"integer","description":"vlan","format":"int32"},"lanName":{"type":"string","description":"Lan name"},"ip":{"type":"string","description":"Ip"},"rx":{"type":"integer","description":"Lan rx","format":"int64"},"tx":{"type":"integer","description":"Lan tx","format":"int64"},"clientNum":{"type":"integer","description":"Lan client num","format":"int32"},"lanPortIpv6Config":{"$ref":"#/components/schemas/OsgLanPortIpv6ConfigVO"}}},"OperationResponseListLanStatus":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/LanStatus"}}}},"OperationResponseOsgHealthDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OsgHealthDetailVO"}}},"OsgHealthDetailVO":{"type":"object","properties":{"score":{"type":"integer","description":"Device health score.","format":"int32"},"cpu":{"$ref":"#/components/schemas/CommonSubHealthInfoDetailVO"},"memory":{"$ref":"#/components/schemas/CommonSubHealthInfoDetailVO"},"incident":{"$ref":"#/components/schemas/IncidentSubHealthInfoDetailVO"},"temperature":{"$ref":"#/components/schemas/CommonSubHealthInfoDetailVO"},"wanLatency":{"$ref":"#/components/schemas/CommonSubHealthInfoDetailVO"},"channelUtil":{"$ref":"#/components/schemas/ChannelSubHealthInfoDetailVO"},"supportedChannelUtil":{"$ref":"#/components/schemas/ChannelSubHealthInfoDetailVO"},"transmission":{"$ref":"#/components/schemas/TransmissionSubHealthInfoDetailVO"},"wanStatus":{"$ref":"#/components/schemas/WanSubHealthInfoDetailVO"},"linkError":{"$ref":"#/components/schemas/LinkErrorHealthInfoDetailVO"}}},"TransmissionSubHealthInfoDetailVO":{"type":"object","properties":{"summaryScore":{"type":"integer","description":"Sub dimension health score","format":"int32"},"support":{"type":"boolean","description":"Sub dimension support"},"incidents":{"type":"array","description":"Incident information for this health dimension, null if no incidents","items":{"$ref":"#/components/schemas/AnomalyBriefCountVO"}},"averageNumTxRetry":{"type":"integer","description":"Average value of tx retry","format":"int32"},"averageNumTxDrop":{"type":"integer","description":"Average value of tx drop","format":"int32"},"pastNumsTxRetry":{"type":"array","description":"List of tx retry","items":{"$ref":"#/components/schemas/TimeValueItemVO"}},"pastNumsTxDrop":{"type":"array","description":"List of tx drop","items":{"$ref":"#/components/schemas/TimeValueItemVO"}}},"description":"wireless transmission quality health info and score"},"WanSubHealthInfoDetailVO":{"type":"object","properties":{"summaryScore":{"type":"integer","description":"Sub dimension health score","format":"int32"},"support":{"type":"boolean","description":"Sub dimension support"},"incidents":{"type":"array","description":"Incident information for this health dimension, null if no incidents","items":{"$ref":"#/components/schemas/AnomalyBriefCountVO"}},"averageLatency":{"type":"integer","description":"Average latency","format":"int32"},"averageJitter":{"type":"integer","description":"Average jitter","format":"int32"},"averagePktLoss":{"type":"number","description":"Average packet loss","format":"float"},"averageMos":{"type":"number","description":"Average mean opinion score","format":"float"},"latency":{"type":"array","description":"List of latency","items":{"$ref":"#/components/schemas/TimeValueItemVO"}},"jitter":{"type":"array","description":"List of jitter","items":{"$ref":"#/components/schemas/TimeValueItemVO"}},"pktLoss":{"type":"array","description":"List of packet loss","items":{"$ref":"#/components/schemas/TimeFloatValueItemVO"}},"mos":{"type":"array","description":"List of mos","items":{"$ref":"#/components/schemas/TimeFloatValueItemVO"}}},"description":"WAN health info and score"},"OperationResponseGatewayGeneralConfig":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GatewayGeneralConfig"}}},"OperationResponseOsgDhcpUserGridVOOsgDhcpUserVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OsgDhcpUserGridVOOsgDhcpUserVO"}}},"OsgDhcpUserGridVOOsgDhcpUserVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OsgDhcpUserVO"}},"netNameToIdMap":{"type":"object","additionalProperties":{"type":"string","description":"Mapping between lan network name and lan network ID"},"description":"Mapping between lan network name and lan network ID"}}},"OsgDhcpUserVO":{"type":"object","properties":{"type":{"type":"integer","description":"Type should be a value as follows: 0: Device; 1: Client","format":"int32"},"ipAddress":{"type":"string","description":"IP Address"},"macAddress":{"type":"string","description":"Mac Address"},"name":{"type":"string","description":"Dhcp User Name"},"showingType":{"type":"string","description":"Client Type or Device Type"},"model":{"type":"string","description":"device Model"},"modelVersion":{"type":"string","description":"device ModelVersion"},"netId":{"type":"string","description":"Network ID"},"netName":{"type":"string","description":"Network Name"},"leftLeaseTime":{"type":"string","description":"Left Lease Time"},"status":{"type":"integer","description":"Status should be a value as follows: 0: Dynamic Binding; 1: Static Binding","format":"int32"}}},"BatchWifiInterferenceOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"id"},"bssid":{"type":"string","description":"bssid"},"ssid":{"type":"string","description":"ssid"},"radioId":{"type":"integer","description":"radio id","format":"int32"},"channel":{"type":"integer","description":"channel","format":"int32"},"mode":{"type":"integer","description":"phyMode","format":"int32"},"security":{"type":"integer","description":"security type. Security should be a value as follows:0: None;1: WEP;2: WPA;3: WPA2;4: WPA/WPA2;5: WPE3-OWE;6: WPA3-EnterPrise;7: WPA2-PSK/WPA3-SAE;8: WPA/WPA2-PSK;9: WPA/WPA2-EnterPrise.","format":"int32"},"beacon":{"type":"integer","description":"beacon Interval","format":"int32"},"signal":{"type":"integer","description":"Signal strength","format":"int32"},"lastSeen":{"type":"integer","description":"Last detect time.","format":"int64"},"nearestAp":{"type":"string","description":"MAC of the AP device closest to that wifi interference."},"bandWidth":{"type":"integer","description":"Band Width","format":"int32"}}},"GridVOBatchWifiInterferenceOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/BatchWifiInterferenceOpenApiVO"}}}},"OperationResponseGridVOBatchWifiInterferenceOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOBatchWifiInterferenceOpenApiVO"}}},"ApInterference":{"type":"object","properties":{"interferences2g":{"type":"array","description":"List of 2G interferences.","items":{"$ref":"#/components/schemas/ApInterference"}},"interferences5g":{"type":"array","description":"List of 5G interferences.","items":{"$ref":"#/components/schemas/ApInterference"}},"interferences6g":{"type":"array","description":"List of 6G interferences.","items":{"$ref":"#/components/schemas/ApInterference"}}}},"OperationResponseListApInterference":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ApInterference"}}}},"ApChannel":{"type":"object","properties":{"channel":{"type":"integer","description":"Channel.","format":"int32"},"load":{"type":"integer","description":"The channel load corresponding to the channel.","format":"int32"}},"description":"List of 6G channel loads."},"ApChannelLoadResult":{"type":"object","properties":{"channelLoads2g":{"type":"array","description":"List of 2G channel loads.","items":{"$ref":"#/components/schemas/ApChannel"}},"channelLoads5g":{"type":"array","description":"List of 5G channel loads.","items":{"$ref":"#/components/schemas/ApChannel"}},"channelLoads6g":{"type":"array","description":"List of 6G channel loads.","items":{"$ref":"#/components/schemas/ApChannel"}}}},"OperationResponseListApChannelLoadResult":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ApChannelLoadResult"}}}},"ApInfoOpenApiVO":{"type":"object","properties":{"name":{"type":"string","description":"Default uses the MAC address as the name."},"mac":{"type":"string","description":"Mac address"},"model":{"type":"string","description":"Model, such as EAP225."},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"type":{"type":"string","description":"Device type:ap、gateway、switch、olt"},"time":{"type":"integer","description":"Last active time.","format":"int64"},"hasResult":{"type":"boolean","description":"Whether the result exists."},"support2g":{"type":"boolean","description":"Whether the Ap device support 2g."},"support5g":{"type":"boolean","description":"Whether the Ap device support 5g."},"support6g":{"type":"boolean","description":"Whether the Ap device support 6g."},"supportWifiInterf":{"type":"boolean","description":"Whether the Ap device support wifi interference detection."},"supportNonWifiInterf":{"type":"boolean","description":"Whether the Ap device support non-wifi interference detection."},"supportChannelUtil":{"type":"boolean","description":"Whether the Ap device support channel util detection."},"supportReturnBandWidth":{"type":"boolean","description":"Whether the Ap device support get band width by interference detection."},"actualChannel2g":{"type":"string","description":"Actual 2.4G channel of the device."},"bandWidth2g":{"type":"string","description":"2.4G bandWidth of the device."},"actualChannel5g":{"type":"string","description":"Actual 5G channel of the device."},"bandWidth5g":{"type":"string","description":"5G bandWidth of the device."},"actualChannel6g":{"type":"string","description":"Actual 6G channel of the device."},"bandWidth6g":{"type":"string","description":"6G bandWidth of the device."}},"description":"A list of information for AP devices."},"BatchFullChannelDetectApListOpenApiVO":{"type":"object","properties":{"scanApNum":{"type":"integer","description":"The number of AP devices participating in batch full channel detection.","format":"int32"},"deviceInfoList":{"type":"array","description":"A list of information for AP devices.","items":{"$ref":"#/components/schemas/ApInfoOpenApiVO"}}}},"OperationResponseBatchFullChannelDetectApListOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/BatchFullChannelDetectApListOpenApiVO"}}},"BatchFullChannelDetectGridBatchFullChannelDetectHistoryOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/BatchFullChannelDetectHistoryOpenApiVO"}},"limit":{"type":"integer","format":"int32"}}},"BatchFullChannelDetectHistoryOpenApiVO":{"type":"object","properties":{"historyId":{"type":"string","description":"Id of batch full channel detect history."},"lastSeen":{"type":"integer","description":"Last full channel detect time.","format":"int64"},"scanApNum":{"type":"integer","description":"The total number of APs participating in the full channel detect.","format":"int32"},"status":{"type":"integer","description":"full channel detect status. 0: finish, 1: scanning.","format":"int32"},"enableInterference":{"type":"boolean","description":"Whether to enable interference detect"},"deviceInfoList":{"type":"array","description":"Device information list","items":{"$ref":"#/components/schemas/ApInfoOpenApiVO"}}}},"OperationResponseBatchFullChannelDetectGridBatchFullChannelDetectHistoryOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/BatchFullChannelDetectGridBatchFullChannelDetectHistoryOpenApiVO"}}},"DisableFullChanDetectApListOpenApiVO":{"type":"object","properties":{"macList":{"type":"array","description":"List of macs for APs that can not perform interference detection.","items":{"type":"string","description":"List of macs for APs that can not perform interference detection."}}}},"OperationResponseDisableFullChanDetectApListOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DisableFullChanDetectApListOpenApiVO"}}},"ExportFormOpenApiVO":{"required":["ids","type"],"type":"object","properties":{"ids":{"type":"string","description":"Form auth result ids."},"type":{"type":"string","description":"include or exclude ids. Value: include, exclude"}}},"Experience Index":{"type":"object","properties":{"lastScan":{"type":"array","description":"The results of the last scan.","items":{"$ref":"#/components/schemas/LastScanResultVO"}}}},"LastScanResultVO":{"type":"object","properties":{"time":{"type":"integer","description":"Timestamp corresponding to the start of optimization.","format":"int64"},"beforeIndex":{"type":"integer","description":"Index before WLAN Optimization, between 0 and 100.","format":"int32"},"afterIndex":{"type":"integer","description":"Index after WLAN Optimization, between 0 and 100.","format":"int32"},"isAppliedSuccess":{"type":"boolean","description":"Parameter [isAppliedSuccess] means whether WLAN Optimization executes successfully."},"apNum":{"type":"integer","description":"The number of EAPs.","format":"int32"},"length":{"type":"integer","description":"Parameter [length] means the duration of the WLAN Optimization in seconds.","format":"int32"},"mode":{"type":"integer","description":"0: by WLAN Optimization schedule. 1: by one-click WLAN Optimization. 2: by RRM schedule(Deprecated). 3: by RRM adaptive.","format":"int32"}},"description":"The results of the last scan."},"ApHealthDetailVO":{"type":"object","properties":{"score":{"type":"integer","description":"Device health score.","format":"int32"},"cpu":{"$ref":"#/components/schemas/CommonSubHealthInfoDetailVO"},"memory":{"$ref":"#/components/schemas/CommonSubHealthInfoDetailVO"},"incident":{"$ref":"#/components/schemas/IncidentSubHealthInfoDetailVO"},"channelUtil":{"$ref":"#/components/schemas/ChannelSubHealthInfoDetailVO"},"supportedChannelUtil":{"$ref":"#/components/schemas/ChannelSubHealthInfoDetailVO"},"channelInterf":{"$ref":"#/components/schemas/ChannelSubHealthInfoDetailVO"},"supportedChannelInterf":{"$ref":"#/components/schemas/ChannelInterferenceSubHealthDetailVO"},"transmission":{"$ref":"#/components/schemas/TransmissionSubHealthInfoDetailVO"}}},"ChannelInterferenceSubHealthDetailVO":{"type":"object","properties":{"summaryScore":{"type":"integer","description":"Sub dimension health score","format":"int32"},"support":{"type":"boolean","description":"Sub dimension support"},"incidents":{"type":"array","description":"Incident information for this health dimension, null if no incidents","items":{"$ref":"#/components/schemas/AnomalyBriefCountVO"}},"averageNum2g":{"type":"integer","description":"Average value of 2g channel","format":"int32"},"averageNum5g":{"type":"integer","description":"Average value of 5g channel","format":"int32"},"averageNum6g":{"type":"integer","description":"Average value of 6g channel","format":"int32"},"pastNums2g":{"type":"array","description":"List of 2g channel value","items":{"$ref":"#/components/schemas/TimeValueItemVO"}},"pastNums5g":{"type":"array","description":"List of 5g channel value","items":{"$ref":"#/components/schemas/TimeValueItemVO"}},"pastNums6g":{"type":"array","description":"List of 6g channel value","items":{"$ref":"#/components/schemas/TimeValueItemVO"}},"averageNoiseFloor":{"type":"integer","description":"Average value of noise floor","format":"int32"},"pastNoiseFloor":{"type":"array","description":"List of noise floor","items":{"$ref":"#/components/schemas/TimeValueItemVO"}}},"description":"Channel interference rate health info and score of supported channel"},"OperationResponseApHealthDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApHealthDetailVO"}}},"OperationResponseDstOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DstOpenApiVO"}}},"Dot1xSwitchResOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Switch 802.1x function enable status"},"radiusProfileId":{"type":"string","description":"This field represents radius profile ID. Radius profile can be created using 'Create a new RADIUS profile' ('Create a new RADIUS profile template') interface, and radius profile ID can be obtained from 'Get RADIUS profile list' ('Get RADIUS profile template list') interface"},"authMode":{"type":"integer","description":"Mode of authentication protocol. AuthMode should be a value as follows: 0: PAP, 1: EAP","format":"int32"},"authType":{"type":"integer","description":"Type of the authentication. AuthType should be a value as follows: 0: Port based, 1: Mac based","format":"int32"},"vlanAssign":{"type":"boolean","description":"VLAN Assignment enable status"},"mab":{"type":"boolean","description":"MAB enable status"},"macFormat":{"type":"integer","description":"Format of the MAC address. MacFormat should be a value as follows: 0: aabbccddeeff, 1: aa-bb-cc-dd-ee-ff, 2: aa:bb:cc:dd:ee:ff, 3: AABBCCDDEEFF, 4: AA-BB-CC-DD-EE-FF, 5: AA:BB:CC:DD:EE:FF","format":"int32"},"nasId":{"pattern":"^(?![\\x20-\\x7E]*[?\"][\\x20-\\x7E]*$)[\\x20-\\x7E]{1,31}$","type":"string","description":"Nas ID,NasId should contain 1~31 characters, except the question mark (?) and double quote (\")."},"guestVlan":{"type":"integer","description":"Guest VLAN, clients that have not been authorized will be added to the guest VLAN.The value of guest VLAN should be selected from the created LAN Network.","format":"int32"}}},"OperationResponseDot1xSwitchResOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Dot1xSwitchResOpenApiVO"}}},"Dot1xBasicInfoEapOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"EAP 802.1x function enable status"},"radiusProfileId":{"type":"string","description":"This field represents radius profile ID. Radius profile can be created using 'Create a new RADIUS profile' ('Create a new RADIUS profile template') interface, and radius profile ID can be obtained from 'Get RADIUS profile list' ('Get RADIUS profile template list') interface"},"guestVlanSetting":{"$ref":"#/components/schemas/Dot1xGuestVlanSettingOpenApiVO"},"macFormat":{"type":"integer","description":"Format of the MAC address. MacFormat should be a value as follows: 0: aabbccddeeff, 1: aa-bb-cc-dd-ee-ff, 2: aa:bb:cc:dd:ee:ff, 3: AABBCCDDEEFF, 4: AA-BB-CC-DD-EE-FF, 5: AA:BB:CC:DD:EE:FF","format":"int32"}}},"OperationResponseDot1xBasicInfoEapOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Dot1xBasicInfoEapOpenApiVO"}}},"Dot1xEapInfoOpenApiVO":{"type":"object","properties":{"name":{"type":"string","description":"EAP name"},"mac":{"type":"string","description":"EAP MAC address"},"model":{"type":"string","description":"EAP model"},"version":{"type":"string","description":"EAP firmwareVersion"},"status":{"type":"string","description":"Device status"},"statusCategory":{"type":"integer","description":"Device status category, 0: Disconnected, 1: Connected, 2: Pending,3: Heartbeat Missed, 4: Isolated","format":"int32"},"ports":{"type":"array","description":"EAP port information","items":{"$ref":"#/components/schemas/Dot1xEapPortInfoOpenApiVO"}}}},"Dot1xEapPortInfoOpenApiVO":{"type":"object","properties":{"port":{"type":"string","description":"Port number"},"dot1xEnable":{"type":"boolean","description":"802.1x enable status"},"mabEnable":{"type":"boolean","description":"MAB enable status"},"supportDot1x":{"type":"boolean","description":"Whether this port support configuring dot1x."}},"description":"EAP port information"},"OperationResponseListDot1xEapInfoOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/Dot1xEapInfoOpenApiVO"}}}},"Dot1xPortInfoOpenApiVO":{"type":"object","properties":{"port":{"type":"integer","description":"Port number","format":"int32"},"dot1xEnable":{"type":"boolean","description":"802.1x enable status"},"mabEnable":{"type":"boolean","description":"MAB enable status"},"authType":{"type":"integer","description":"The auth type of the port. AuthType should be a value as follows: 0: Authentication not enabled, 1: Only 802.1x auth enabled, 2: Only MAB auth enabled, 3: Both 802.1x auth and MAB auth, it will perform 802.1x auth first, and perform MAB auth after 802.1x auth failed.","format":"int32"},"operation":{"type":"string","description":"switching or mirroring or aggregating"},"lag":{"type":"boolean","description":"Whether the port is a lag port. Lag ports do not suppot 802.1x or MAB authentication."}},"description":"Switch port information"},"Dot1xSwitchInfoOpenApiVO":{"type":"object","properties":{"name":{"type":"string","description":"Switch name"},"mac":{"type":"string","description":"Switch MAC address"},"model":{"type":"string","description":"Switch model"},"version":{"type":"string","description":"Switch firmwareVersion"},"status":{"type":"string","description":"Device status"},"statusCategory":{"type":"integer","description":"Device status category, 0: Disconnected, 1: Connected, 2: Pending,3: Heartbeat Missed, 4: Isolated","format":"int32"},"addedInAdvanced":{"type":"boolean","description":"Whether the device is added offline"},"ports":{"type":"array","description":"Switch port information","items":{"$ref":"#/components/schemas/Dot1xPortInfoOpenApiVO"}},"supportVrf":{"type":"boolean","description":"Whether the switch supports VRF"},"accountVrfId":{"type":"string","description":"Account VRF ID"},"authVrfId":{"type":"string","description":"Auth VRF ID"},"supportSingleMabAuth":{"type":"boolean","description":"Whether the switch supports single MAB Authentication.If not supported, it will not take effect when configuring single MAB authentication for the port of the switch."},"portConfigured":{"type":"boolean","description":"Is there any port configured with 802.1x or MAB authentication."}}},"OperationResponseListDot1xSwitchInfoOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/Dot1xSwitchInfoOpenApiVO"}}}},"TimeIntervalQueryOpenApiVO":{"required":["end","start"],"type":"object","properties":{"start":{"type":"integer","description":"StartTime is seconds since UTC 1970/01/01","format":"int64"},"end":{"type":"integer","description":"EndTime is seconds since UTC 1970/01/01","format":"int64"}}},"ConnectPeriodVO":{"type":"object","properties":{"start":{"type":"integer","description":"Start timestamp of a connect interval. unit: millisecond.","format":"int64"},"end":{"type":"integer","description":"End timestamp of a connect interval. unit: millisecond.","format":"int64"},"duration":{"type":"integer","description":"Duration of a connect interval. unit: millisecond.","format":"int64"}},"description":"The collection of device online intervals."},"OperationResponseTimelineOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/TimelineOpenApiVO"}}},"TimelineOpenApiVO":{"type":"object","properties":{"connections":{"type":"array","description":"The collection of device online intervals.","items":{"$ref":"#/components/schemas/ConnectPeriodVO"}}}},"OnlineUpgradeRes":{"type":"object","properties":{"finished":{"type":"boolean","description":"Whether the task is complete"},"success":{"type":"boolean","description":"Whether the task is successful"}}},"OperationResponseOnlineUpgradeRes":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OnlineUpgradeRes"}}},"DeviceFirmwareInfo":{"type":"object","properties":{"curFwVer":{"type":"string","description":"Current firmware version"},"lastFwVer":{"type":"string","description":"Latest firmware version"},"fwReleaseLog":{"type":"string","description":"Firmware release log"}}},"OperationResponseDeviceFirmwareInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceFirmwareInfo"}}},"CheckMacTypeOpenApiVO":{"type":"object","properties":{"device":{"type":"boolean","description":"Whether the mac is device"},"deviceType":{"type":"string","description":"Device type:ap、switch、gateway、olt、IPC、NVR."}}},"OperationResponseCheckMacTypeOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CheckMacTypeOpenApiVO"}}},"AdoptResult":{"type":"object","properties":{"deviceMac":{"type":"string","description":"Device MAC"},"adoptErrorCode":{"type":"integer","description":"Adopt result should be a value as follows: 0: Adopt Device Success; -39002: Device adoption failed because the device does not respond to adopt commands; -39003: Failed to adopt the Device. The username or password  is incorrect; -39004: Failed to adopt device; -39005: Failed to adopt this device because the device is not connected; -39329: Failed to link to the uplink AP.","format":"int32"},"adoptFailedType":{"type":"integer","description":"Adopt failed type should be a value as follows: -1: No need print username or password;-2: Need print username or password.","format":"int32"}}},"OperationResponseAdoptResult":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AdoptResult"}}},"OperationResponseListDeviceInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/DeviceInfo"}}}},"OperationResponseListWhiteDeviceInfoOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/WhiteDeviceInfoOpenApiVO"}}}},"WhiteDeviceInfoOpenApiVO":{"type":"object","properties":{"model":{"type":"string","description":"device model"},"hwVersion":{"type":"string","description":"device hwVersion"}}},"OperationResponseDeviceAccountSettingOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceAccountSettingOpenApiVO"}}},"ListTabs":{"type":"object","properties":{"id":{"type":"string","description":"A unique identifier"},"name":{"type":"string","description":"Name cannot be duplicated on the dashboard page, it should contain 1 to 64 characters."},"type":{"type":"integer","description":"Type should be a value as follows: 1: Network; 2: Clients; 3: Customized.","format":"int32"},"cards":{"type":"array","description":"Card list displayed in Tab. Each number indicates a type of card. card should be a value as follows:  0: Controller Snapshot, 101: Alerts, 102: ISP Load, 103: L2TP/PPTP VPN, 104: Channel Distribution and Usage, 105: Most Active EAPs, 106: Most Active Switches, 108: WiFi/Switching Summary, 109: Traffic Distribution, 110: Traffic Activities, 111: Clients Distribution, 112: Retry Rate/Dropped Rate, 117: Top Device CPU/Memory Usage, 118: IPSEC VPN, 119: OPEN VPN, 120: SSL VPN, 200: Most Active Clients, 201: Longest client uptime, 202: Clients Freq Distribution, 203: Clients Activities, 204: Clients Association Activities, 205: Association Failures, 206: Clients Association Time Distribution, 207: Clients SSID Distribution, 208: Clients RSSI Distribution","items":{"type":"integer","description":"Card list displayed in Tab. Each number indicates a type of card. card should be a value as follows:  0: Controller Snapshot, 101: Alerts, 102: ISP Load, 103: L2TP/PPTP VPN, 104: Channel Distribution and Usage, 105: Most Active EAPs, 106: Most Active Switches, 108: WiFi/Switching Summary, 109: Traffic Distribution, 110: Traffic Activities, 111: Clients Distribution, 112: Retry Rate/Dropped Rate, 117: Top Device CPU/Memory Usage, 118: IPSEC VPN, 119: OPEN VPN, 120: SSL VPN, 200: Most Active Clients, 201: Longest client uptime, 202: Clients Freq Distribution, 203: Clients Activities, 204: Clients Association Activities, 205: Association Failures, 206: Clients Association Time Distribution, 207: Clients SSID Distribution, 208: Clients RSSI Distribution","format":"int32"}}}},"OperationResponseListListTabs":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ListTabs"}}}},"OperationResponseWifiSummary":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/WifiSummary"}}},"WifiSummary":{"type":"object","properties":{"connectedApNum":{"type":"integer","description":"The number of connected APs","format":"int32"},"clients":{"type":"integer","description":"The number of connected wireless clients","format":"int32"},"channelUtilization":{"type":"integer","description":"The average channel utilization of the 2.4GHz and 5GHz band for each AP in percentage. Null means no value.","format":"int32"},"totalTraffic":{"type":"number","description":"Total traffic measured in KB","format":"double"}}},"DashboardVpnStats":{"type":"object","properties":{"site":{"type":"string","description":"Site"},"name":{"type":"string","description":"VPN name"},"status":{"type":"boolean","description":"Whether VPN is enabled"},"tunnels":{"type":"integer","description":"The number of tunnels included in the VPN server","format":"int32"},"txData":{"type":"integer","description":"The total tx traffic of the channels included in the server/client, in Byte","format":"int64"},"rxData":{"type":"integer","description":"The total rx traffic of the tunnels included in the server/client, in Byte","format":"int64"}}},"OperationResponseListDashboardVpnStats":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/DashboardVpnStats"}}}},"DeviceTrafficDistribution":{"type":"object","properties":{"name":{"type":"string","description":"Device Name"},"mac":{"type":"string","description":"Device MAC"},"traffic":{"type":"number","description":"Device traffic measured in MB","format":"double"},"trafficProportion":{"type":"number","description":"The proportion of AP traffic in percentage","format":"double"}},"description":"Current Site Switch List"},"OperationResponseTrafficDistribution":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/TrafficDistribution"}}},"TrafficDistribution":{"type":"object","properties":{"aps":{"type":"array","description":"Current Site Ap List","items":{"$ref":"#/components/schemas/DeviceTrafficDistribution"}},"switches":{"type":"array","description":"Current Site Switch List","items":{"$ref":"#/components/schemas/DeviceTrafficDistribution"}}}},"DeviceTrafficActivity":{"type":"object","properties":{"time":{"type":"integer","description":"The timestamp of this data sample, in seconds, such as 1682000000","format":"int64"},"txData":{"type":"number","description":"Uplink traffic in MB","format":"double"},"rxData":{"type":"number","description":"Downlink traffic in MB","format":"double"}},"description":"Wired network total traffic timing list"},"OperationResponseTrafficActivities":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/TrafficActivities"}}},"TrafficActivities":{"type":"object","properties":{"apTrafficActivities":{"type":"array","description":"Wireless network total traffic timing list","items":{"$ref":"#/components/schemas/DeviceTrafficActivity"}},"switchTrafficActivities":{"type":"array","description":"Wired network total traffic timing list","items":{"$ref":"#/components/schemas/DeviceTrafficActivity"}}}},"ApInterferences":{"type":"object","properties":{"apInterference2g":{"type":"array","description":"2GHz device interference intensity information","items":{"$ref":"#/components/schemas/ApInterference"}},"apInterference5g":{"type":"array","description":"5GHz device interference intensity information","items":{"$ref":"#/components/schemas/ApInterference"}},"apInterference5g2":{"type":"array","description":"5GHz-2 device interference intensity information","items":{"$ref":"#/components/schemas/ApInterference"}},"apInterference6g":{"type":"array","description":"6GHz device interference intensity information","items":{"$ref":"#/components/schemas/ApInterference"}}}},"OperationResponseApInterferences":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApInterferences"}}},"MemUsage":{"type":"object","properties":{"name":{"type":"string","description":"Device name"},"mac":{"type":"string","description":"Device MAC"},"memUsage":{"type":"integer","description":"Device memory usage such as 60 : 60%","format":"int32"},"model":{"type":"string","description":"Device model"},"modelVersion":{"type":"string","description":"Device model version"},"type":{"type":"string","description":"Device type"}}},"OperationResponseListMemUsage":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/MemUsage"}}}},"CpuUsage":{"type":"object","properties":{"name":{"type":"string","description":"Device name"},"mac":{"type":"string","description":"Device MAC"},"cpuUtil":{"type":"integer","description":"Device CPU utilization","format":"int32"},"model":{"type":"string","description":"Device model"},"modelVersion":{"type":"string","description":"Device model version"},"type":{"type":"string","description":"Device type"}}},"OperationResponseListCpuUsage":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/CpuUsage"}}}},"OperationResponseTopApByRtDropVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/TopApByRtDropVO"}}},"OperationResponseSwitchSummary":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SwitchSummary"}}},"SwitchSummary":{"type":"object","properties":{"clients":{"type":"integer","description":"Number of wired clients","format":"int32"},"portUtilization":{"type":"integer","description":"Port occupancy rate (integer)","format":"int32"},"connectedSwitchNum":{"type":"integer","description":"Number of online switches","format":"int32"},"totalTraffic":{"type":"integer","description":"Upstream and downstream traffic and the unit (Byte) of online switches","format":"int64"}}},"ApplicationBasicInfo":{"type":"object","properties":{"applicationName":{"type":"string","description":"The name of the application."},"applicationId":{"type":"integer","description":"The id of the application.","format":"int32"}},"description":"The applications info using by the client."},"ApplicationStatTraffic":{"type":"object","properties":{"applicationName":{"type":"string","description":"The name of the application."},"applicationId":{"type":"integer","description":"The id of the application.","format":"int32"},"applicationDescription":{"type":"string","description":"The description of the application."},"familyName":{"type":"string","description":"The name of the family."},"familyId":{"type":"integer","description":"The id of the family.","format":"int32"},"traffic":{"type":"integer","description":"The total amount of traffic used by the app.","format":"int64"},"trafficPercent":{"type":"number","description":"The percentage of traffic used by the app.","format":"double"},"block":{"type":"integer","description":"The number of times this app has been blocked.","format":"int64"},"activeUser":{"type":"integer","description":"The number of active users under this app.","format":"int32"},"download":{"type":"integer","description":"The download traffic used by the app.","format":"int64"},"upload":{"type":"integer","description":"The upload traffic used by the app.","format":"int64"},"clientsCount":{"type":"integer","description":"The number of clients using the app.","format":"int32"},"clients":{"type":"array","description":"The clients info.","items":{"$ref":"#/components/schemas/ClientTrafficWithApplications"}}}},"ClientTrafficWithApplications":{"type":"object","properties":{"type":{"type":"string","description":"The type of the client."},"manager":{"type":"boolean","description":"Whether the client is managed by the controller.."},"clientName":{"type":"string","description":"The name of the client."},"mac":{"type":"string","description":"The mac of the client."},"traffic":{"type":"integer","description":"The total amount of traffic used by the client.","format":"int64"},"trafficPercent":{"type":"number","description":"The percentage of download traffic used by the client.","format":"double"},"upload":{"type":"integer","description":"The upload traffic used by the client.","format":"int64"},"download":{"type":"integer","description":"The download traffic used by the client.","format":"int64"},"totalApplications":{"type":"integer","description":"The number of applications using by the client.","format":"int32"},"applicationList":{"type":"array","description":"The applications info using by the client.","items":{"$ref":"#/components/schemas/ApplicationBasicInfo"}}},"description":"The clients info."},"OperationResponseListApplicationStatTraffic":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationStatTraffic"}}}},"OperationResponseListClientTrafficWithApplicationDetail":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ClientTrafficWithApplicationDetail"}}}},"Drop":{"type":"object","properties":{"time":{"type":"integer","description":"Sampling time second","format":"int64"},"dropTimes":{"type":"integer","description":"Number of drop packets within one hour, such as 60 : 60%","format":"int32"},"dropRate":{"type":"number","description":"AP drop packet rate within one hour","format":"double"}},"description":"AP dropouts timing list"},"DropEap":{"type":"object","properties":{"dropouts":{"type":"array","description":"AP dropouts timing list","items":{"$ref":"#/components/schemas/Drop"}},"apMac":{"type":"string","description":"AP MAC"},"name":{"type":"string","description":"AP name"},"model":{"type":"string","description":"AP model"},"modelVersion":{"type":"string","description":"AP model Version"},"avg":{"type":"number","description":"Average current AP drop packet rate","format":"double"},"status":{"type":"integer","description":"AP status, 0: connected, 1: disconnected","format":"int32"}},"description":"AP list of packet loss rate tab, in descending order of average value"},"OperationResponseRetryDropRate":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/RetryDropRate"}}},"Retry":{"type":"object","properties":{"time":{"type":"integer","description":"Sampling time second","format":"int64"},"retryTimes":{"type":"integer","description":"Number of new contracts within one hour, such as 60 : 60%","format":"int32"},"retryRate":{"type":"number","description":"AP re-contracting rate within one hour","format":"double"}},"description":"AP retries timing list"},"RetryDropRate":{"type":"object","properties":{"retryEaps":{"type":"array","description":"AP list of retransmission packet rates tab, in descending order of average","items":{"$ref":"#/components/schemas/RetryEap"}},"droppedEaps":{"type":"array","description":"AP list of packet loss rate tab, in descending order of average value","items":{"$ref":"#/components/schemas/DropEap"}}}},"RetryEap":{"type":"object","properties":{"retries":{"type":"array","description":"AP retries timing list","items":{"$ref":"#/components/schemas/Retry"}},"apMac":{"type":"string","description":"AP MAC"},"name":{"type":"string","description":"AP name"},"model":{"type":"string","description":"AP model"},"modelVersion":{"type":"string","description":"AP model Version"},"avg":{"type":"number","description":"Average current AP retransmission packet rate","format":"double"},"status":{"type":"integer","description":"AP status, 0: connected, 1: disconnected","format":"int32"}},"description":"AP list of retransmission packet rates tab, in descending order of average"},"OperationResponseListPoeUsage":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/PoeUsage"}}}},"PoeUsage":{"type":"object","properties":{"mac":{"type":"string","description":"Device MAC"},"name":{"type":"string","description":"Device name"},"portNum":{"type":"integer","description":"Device port Number","format":"int32"},"totalPowerUsed":{"type":"integer","description":"Total power used (in watts)","format":"int32"},"totalPercentUsed":{"type":"number","description":"Percentage of total power used (integer reserved)","format":"double"},"totalPower":{"type":"integer","description":"The total power of the switch port's POE (in watts)","format":"int32"},"poePorts":{"type":"array","description":"Device PoE Ports","items":{"$ref":"#/components/schemas/PortPoe"}}}},"PortPoe":{"type":"object","properties":{"portId":{"type":"integer","description":"Switch port ID","format":"int32"},"poeSupported":{"type":"boolean","description":"Switch port supported"},"poeEnabled":{"type":"boolean","description":"Switch port enable"},"poePower":{"type":"integer","description":"Switch port power","format":"int32"},"poePercent":{"type":"integer","description":"Switch port percent","format":"int32"}},"description":"Device PoE Ports"},"ClientSummaryVO":{"type":"object","properties":{"total":{"type":"integer","format":"int32"},"wiredClient":{"type":"integer","format":"int32"},"wirelessClient":{"type":"integer","format":"int32"}}},"OperationResponseClientSummaryVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ClientSummaryVO"}}},"GetDashboardOverview":{"type":"object","properties":{"totalGatewayNum":{"type":"integer","description":"The total number of gateways","format":"int32"},"connectedGatewayNum":{"type":"integer","description":"The number of connected gateways","format":"int32"},"disconnectedGatewayNum":{"type":"integer","description":"The number of disconnected gateways","format":"int32"},"netCapacity":{"type":"integer","description":"Network Capacity measured in Mbps. Null means no value.","format":"int32"},"netUsage":{"type":"number","description":"The current link usage rate under the Gateway node (percent conversion has been performed, such as 98.1)","format":"double"},"totalSwitchNum":{"type":"integer","description":"Total number of switches","format":"int32"},"connectedSwitchNum":{"type":"integer","description":"Number of switches in connected state ","format":"int32"},"disconnectedSwitchNum":{"type":"integer","description":"Number of switches in disconnected state","format":"int32"},"totalPorts":{"type":"integer","description":"Total number of ports","format":"int32"},"availablePorts":{"type":"integer","description":"Number of valid ports","format":"int32"},"powerConsumption":{"type":"number","description":"Power consumption (unit: W)","format":"double"},"totalApNum":{"type":"integer","description":"Total number of APs","format":"int32"},"connectedApNum":{"type":"integer","description":"Number of APs in connected state","format":"int32"},"isolatedApNum":{"type":"integer","description":"Number of APs in isolated state","format":"int32"},"disconnectedApNum":{"type":"integer","description":"Number of APs in disconnected state","format":"int32"},"totalClientNum":{"type":"integer","description":"Total number of clients","format":"int32"},"wiredClientNum":{"type":"integer","description":"Number of wired clients","format":"int32"},"wirelessClientNum":{"type":"integer","description":"Number of wireless clients","format":"int32"},"guestNum":{"type":"integer","description":"Number of wireless guest clients","format":"int32"}}},"OperationResponseGetDashboardOverview":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GetDashboardOverview"}}},"OperationResponseListApplicationTrafficWithClientCount":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationTrafficWithClientCount"}}}},"OperationResponseListActiveDevice":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ActiveDevice"}}}},"IpsecVpnStats":{"type":"object","properties":{"site":{"type":"string"},"name":{"type":"string","description":"VPN name"},"id":{"type":"integer","description":"VPN ID","format":"int32"},"status":{"type":"boolean","description":"VPN status, whether to enable VPN "},"direction":{"type":"string","description":"SA direction should be a value as follows: in; out"},"localPeerIp":{"type":"string","description":"IP address of the local peer"},"remotePeerIp":{"type":"string","description":"IP address of the remote peer"},"localSa":{"type":"string","description":"Local network segment of SA Cover"},"remoteSa":{"type":"string","description":"Remote network segment of SA Cover"}}},"OperationResponseListIpsecVpnStats":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/IpsecVpnStats"}}}},"IspLoad":{"type":"object","properties":{"portId":{"type":"integer","description":"Port ID","format":"int32"},"portName":{"type":"string","description":"Port name"},"data":{"type":"array","description":"WAN port data list","items":{"$ref":"#/components/schemas/IspLoadStat"}}}},"IspLoadStat":{"type":"object","properties":{"totalRate":{"type":"integer","description":"WAN port rate (rxR+txR)","format":"int64"},"latency":{"type":"integer","description":"WAN port delay should be within the range of 0 or 1000. (in ms)","format":"int32"},"time":{"type":"integer","description":"Timestamp of statistical data (in seconds)","format":"int64"}},"description":"WAN port data list"},"OperationResponseListIspLoad":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/IspLoad"}}}},"DashboardIspLoadDetailVO":{"type":"object","properties":{"data":{"type":"array","description":"Gateway isp info list.","items":{"$ref":"#/components/schemas/GatewayIspLoadInfoVO"}}}},"GatewayIspLoadInfoVO":{"type":"object","properties":{"name":{"type":"string","description":"Gateway name."},"mac":{"type":"string","description":"Gateway MAC."},"status":{"type":"integer","description":"Gateway status, should be a value as follows:-1 : disconnected1 : active0 : backup gateway under multiple gateways","format":"int32"},"ispInfo":{"$ref":"#/components/schemas/IspInfoVO"},"speedTestLimit":{"type":"integer","description":"The limited bandwidth of the gateway speed test.","format":"int64"},"supportSpeedTest":{"type":"boolean","description":"Whether speed measurement is supported."}},"description":"Gateway isp info list."},"IspInfoVO":{"type":"object","properties":{"type":{"type":"integer","description":"Isp type, should be a value as follows:0 : single ISP1 : multiple ISPs","format":"int32"},"ispArr":{"type":"array","description":"Isp info detail.","items":{"$ref":"#/components/schemas/IspVO"}}},"description":"Isp info."},"IspVO":{"type":"object","properties":{"port":{"type":"integer","description":"Port id.","format":"int32"},"name":{"type":"string","description":"Port name."},"portUuid":{"type":"string","description":"Port uuid."},"maxBandwidth":{"type":"integer","description":"Port max bandwidth.","format":"int64"},"downloadSpeedSet":{"type":"integer","description":"The set download speed.","format":"int64"},"uploadSpeedSet":{"type":"integer","description":"The set upload speed.","format":"int64"},"downloadSpeed":{"type":"string","description":"The current download speed."},"uploadSpeed":{"type":"string","description":"The current upload speed."},"downloadPercent":{"type":"number","description":"Download utilization.","format":"double"},"uploadPercent":{"type":"number","description":"Upload utilization.","format":"double"},"ip":{"type":"string","description":"Port ip."},"loadBalance":{"type":"string","description":"Port load balance."},"status":{"type":"integer","description":"Isp status, should be a value as follows:2 : normal ISP1 : primary ISP0 : backup ISP","format":"int32"},"onLineStatus":{"type":"integer","description":"onLine status, should be a value as follows:1 : online0 : offline","format":"int32"},"ipv4Proto":{"type":"string","description":"WAN IPv4 proto."}},"description":"Isp info detail."},"OperationResponseDashboardIspLoadDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DashboardIspLoadDetailVO"}}},"ActiveClientBubbleVO":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"mac":{"type":"string"},"apName":{"type":"string"},"traffic":{"type":"integer","format":"int64"},"trafficPercent":{"type":"integer","format":"int32"},"upload":{"type":"integer","format":"int64"},"uploadPercent":{"type":"integer","format":"int32"},"download":{"type":"integer","format":"int64"},"downloadPercent":{"type":"integer","format":"int32"},"healthScore":{"type":"integer","format":"int32"},"txRate":{"type":"integer","format":"int64"},"snr":{"type":"integer","format":"int32"},"wifiProtocol":{"type":"string"},"rssi":{"type":"integer","format":"int32"},"signalLevel":{"type":"integer","format":"int32"},"channel":{"type":"integer","format":"int32"},"radioId":{"type":"integer","format":"int32"},"bandWidth":{"type":"integer","format":"int32"},"incidents":{"type":"integer","format":"int32"}}},"OperationResponseListActiveClientBubbleVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ActiveClientBubbleVO"}}}},"ClientDistributionVO":{"type":"object","properties":{"totalClients":{"type":"integer","format":"int32"},"clientsPercent":{"type":"integer","format":"int32"},"clients2g":{"type":"integer","format":"int32"},"clients5g":{"type":"integer","format":"int32"},"clients6g":{"type":"integer","format":"int32"}}},"ClientSignalDistributionVO":{"type":"object","properties":{"poorSignal":{"$ref":"#/components/schemas/ClientDistributionVO"},"weakSignal":{"$ref":"#/components/schemas/ClientDistributionVO"},"averageSignal":{"$ref":"#/components/schemas/ClientDistributionVO"},"stableSignal":{"$ref":"#/components/schemas/ClientDistributionVO"},"strongSignal":{"$ref":"#/components/schemas/ClientDistributionVO"}}},"OperationResponseClientSignalDistributionVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ClientSignalDistributionVO"}}},"ClientRssiChannelDistributionVO":{"type":"object","properties":{"lessThan72":{"type":"integer","format":"int32"},"from71To65":{"type":"integer","format":"int32"},"from65To55":{"type":"integer","format":"int32"},"from55To45":{"type":"integer","format":"int32"},"moreThan45":{"type":"integer","format":"int32"},"distribution2G":{"$ref":"#/components/schemas/ClientsRssiDistributionVO"},"distribution5G":{"$ref":"#/components/schemas/ClientsRssiDistributionVO"},"distribution6G":{"$ref":"#/components/schemas/ClientsRssiDistributionVO"}}},"ClientsRssiDistributionVO":{"type":"object","properties":{"lessThan72":{"type":"integer","format":"int32"},"from71To65":{"type":"integer","format":"int32"},"from65To55":{"type":"integer","format":"int32"},"from55To45":{"type":"integer","format":"int32"},"moreThan45":{"type":"integer","format":"int32"}}},"OperationResponseClientRssiChannelDistributionVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ClientRssiChannelDistributionVO"}}},"DashboardDistributionVO":{"type":"object","properties":{"eapDistribution":{"$ref":"#/components/schemas/EapDistributionVO"},"switchDistribution":{"$ref":"#/components/schemas/SwitchDistributionVO"}}},"DeviceClientVO":{"type":"object","properties":{"name":{"type":"string"},"totalClients":{"type":"integer","format":"int32"},"totalDistribution":{"type":"number","format":"double"}}},"EapClientVO":{"type":"object","properties":{"name":{"type":"string"},"totalClients":{"type":"integer","format":"int32"},"totalDistribution":{"type":"number","format":"double"},"clients2g":{"type":"integer","format":"int32"},"distribution2g":{"type":"number","format":"double"},"clients5g":{"type":"integer","format":"int32"},"distribution5g":{"type":"number","format":"double"},"clients6g":{"type":"integer","format":"int32"},"distribution6g":{"type":"number","format":"double"},"wiredClients":{"type":"integer","format":"int32"},"wiredDistribution":{"type":"number","format":"double"}}},"EapDistributionVO":{"type":"object","properties":{"eaps":{"type":"array","items":{"$ref":"#/components/schemas/EapClientVO"}},"others":{"$ref":"#/components/schemas/EapClientVO"},"totalEapClients":{"type":"integer","format":"int32"},"totalEapDistribution":{"type":"number","format":"double"}}},"OperationResponseDashboardDistributionVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DashboardDistributionVO"}}},"SwitchDistributionVO":{"type":"object","properties":{"switches":{"type":"array","items":{"$ref":"#/components/schemas/DeviceClientVO"}},"others":{"$ref":"#/components/schemas/DeviceClientVO"},"totalSwitchClients":{"type":"integer","format":"int32"},"totalSwitchDistribution":{"type":"number","format":"double"}}},"ClientAssociationTimeDistributionVO":{"type":"object","properties":{"lessThan2sNum":{"type":"integer","format":"int32"},"from2To4sNum":{"type":"integer","format":"int32"},"from4To6sNum":{"type":"integer","format":"int32"},"from6To8sNum":{"type":"integer","format":"int32"},"from8To10sNum":{"type":"integer","format":"int32"},"moreThan10sNum":{"type":"integer","format":"int32"},"fails":{"type":"integer","format":"int32"},"lessThan10sPercent":{"type":"integer","format":"int32"}}},"OperationResponseClientAssociationTimeDistributionVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ClientAssociationTimeDistributionVO"}}},"ClientActivitiesVO":{"type":"object","properties":{"newEapClientNum":{"type":"integer","format":"int32"},"newSwitchClientNum":{"type":"integer","format":"int32"},"activeEapClientNum":{"type":"integer","format":"int32"},"activeSwitchClientNum":{"type":"integer","format":"int32"},"disconnectEapClientNum":{"type":"integer","format":"int32"},"disconnectSwitchClientNum":{"type":"integer","format":"int32"},"time":{"type":"integer","format":"int64"}}},"OperationResponseListClientActivitiesVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ClientActivitiesVO"}}}},"ApChannelStat":{"type":"object","properties":{"channel":{"type":"integer","description":"This entry indicates the channel index. For example, 36 means the 36 / 2160MHz channel.","format":"int32"},"apNum":{"type":"integer","description":"AP number of the channel","format":"int32"},"clientNum":{"type":"integer","description":"Client number of the channel","format":"int32"},"channelUtilization":{"type":"number","description":"The average utilization of the channel by APs in percentage. Null means no data.","format":"double"}},"description":"6g channel stat"},"ApChannelStats":{"type":"object","properties":{"2g channel stat":{"type":"array","description":"2g channel stat","items":{"$ref":"#/components/schemas/ApChannelStat"}},"5g channel stat":{"type":"array","description":"5g channel stat","items":{"$ref":"#/components/schemas/ApChannelStat"}},"6g channel stat":{"type":"array","description":"6g channel stat","items":{"$ref":"#/components/schemas/ApChannelStat"}}}},"OperationResponseApChannelStats":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApChannelStats"}}},"ApplicationGridVOCategoryTraffic":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CategoryTraffic"}},"stat":{"$ref":"#/components/schemas/ApplicationStatVO"}}},"ApplicationStatVO":{"type":"object","properties":{"allowApps":{"type":"integer","format":"int32"},"blockApps":{"type":"integer","format":"int32"}}},"CategoryTraffic":{"type":"object","properties":{"familyId":{"type":"integer","description":"The id of the category.","format":"int32"},"familyName":{"type":"string","description":"The name of the category."},"traffic":{"type":"integer","description":"The total amount of traffic used by the category.","format":"int64"},"upload":{"type":"integer","description":"The upload traffic used by the category.","format":"int64"},"download":{"type":"integer","description":"The download traffic used by the category.","format":"int64"},"trafficPercent":{"type":"number","description":"The percentage of traffic used by the category.","format":"double"},"totalApplications":{"type":"integer","description":"The number of applications used in this category.","format":"int32"},"applications":{"type":"array","description":"The applications used in this category.","items":{"$ref":"#/components/schemas/ApplicationTrafficWithClientCount"}},"totalClients":{"type":"integer","description":"The number of clients using the app in this category.","format":"int32"},"clients":{"type":"array","description":"The clients using the app in this category.","items":{"$ref":"#/components/schemas/ClientTrafficWithApplications"}}}},"OperationResponseApplicationGridVOCategoryTraffic":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApplicationGridVOCategoryTraffic"}}},"CardOverviewOpenApiVO":{"type":"object","properties":{"type":{"type":"string","description":"The type of data"},"total":{"type":"integer","description":"The total number of devices","format":"int32"},"preConfig":{"type":"integer","description":"The number of preConfig devices","format":"int32"},"connected":{"type":"integer","description":"The number of connected devices","format":"int32"},"disconnectedCount":{"type":"integer","description":"The number of disconnected devices","format":"int32"}}},"OperationResponseListCardOverviewOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/CardOverviewOpenApiVO"}}}},"ApplicationGridVOApplicationStatTraffic":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationStatTraffic"}},"stat":{"$ref":"#/components/schemas/ApplicationStatVO"}}},"OperationResponseApplicationGridVOApplicationStatTraffic":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApplicationGridVOApplicationStatTraffic"}}},"EapRssiChannelDistributionVO":{"type":"object","properties":{"existAp":{"type":"boolean"},"existApClient":{"type":"boolean"},"lessThan90":{"type":"array","items":{"$ref":"#/components/schemas/EapRssiChannelVO"}},"from90To85":{"type":"array","items":{"$ref":"#/components/schemas/EapRssiChannelVO"}},"from85To80":{"type":"array","items":{"$ref":"#/components/schemas/EapRssiChannelVO"}},"from80To75":{"type":"array","items":{"$ref":"#/components/schemas/EapRssiChannelVO"}},"from75To70":{"type":"array","items":{"$ref":"#/components/schemas/EapRssiChannelVO"}},"from70To65":{"type":"array","items":{"$ref":"#/components/schemas/EapRssiChannelVO"}},"from65To60":{"type":"array","items":{"$ref":"#/components/schemas/EapRssiChannelVO"}},"from60To55":{"type":"array","items":{"$ref":"#/components/schemas/EapRssiChannelVO"}},"from55To50":{"type":"array","items":{"$ref":"#/components/schemas/EapRssiChannelVO"}},"from50To45":{"type":"array","items":{"$ref":"#/components/schemas/EapRssiChannelVO"}},"from45To40":{"type":"array","items":{"$ref":"#/components/schemas/EapRssiChannelVO"}},"from40To35":{"type":"array","items":{"$ref":"#/components/schemas/EapRssiChannelVO"}},"from35To30":{"type":"array","items":{"$ref":"#/components/schemas/EapRssiChannelVO"}},"moreThan30":{"type":"array","items":{"$ref":"#/components/schemas/EapRssiChannelVO"}}}},"EapRssiChannelVO":{"type":"object","properties":{"name":{"type":"string"},"mac":{"type":"string"},"model":{"type":"string"},"type":{"type":"string"},"modelVersion":{"type":"string"},"traffic":{"type":"integer","format":"int64"},"trafficPercent":{"type":"integer","format":"int32"},"clientsCount":{"type":"integer","format":"int32"},"healthScore":{"type":"integer","format":"int32"},"signalLevel":{"type":"integer","format":"int32"},"rssi":{"type":"integer","format":"int32"}}},"OperationResponseEapRssiChannelDistributionVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/EapRssiChannelDistributionVO"}}},"OperationResponseNetworkActivityVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/NetworkActivityVO"}}},"ActiveClientVO":{"type":"object","properties":{"name":{"type":"string"},"wireless":{"type":"boolean"},"type":{"type":"string"},"model":{"type":"string"},"mac":{"type":"string"},"totalTraffic":{"type":"integer","format":"int64"}}},"OperationResponseListActiveClientVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ActiveClientVO"}}}},"ClientHealthDetailVO":{"type":"object","properties":{"score":{"type":"integer","format":"int32"},"associationTime":{"$ref":"#/components/schemas/CommonSubHealthInfoDetailVOInteger"},"rssi":{"$ref":"#/components/schemas/CommonSubHealthInfoDetailVOInteger"},"rate":{"$ref":"#/components/schemas/CommonSubHealthInfoDetailVOLong"},"snr":{"$ref":"#/components/schemas/CommonSubHealthInfoDetailVOInteger"},"incident":{"$ref":"#/components/schemas/IncidentSubHealthInfoDetailVO"},"connectScore":{"$ref":"#/components/schemas/CommonSubHealthInfoDetailVOInteger"},"linkErrorScore":{"$ref":"#/components/schemas/CommonSubHealthInfoDetailVOInteger"}}},"CommonSubHealthInfoDetailVOInteger":{"type":"object","properties":{"summaryScore":{"type":"integer","description":"Sub dimension health score","format":"int32"},"averageNum":{"type":"array","description":"List of common dimension value, such as rssi","items":{"$ref":"#/components/schemas/TimeValueItemVOInteger"}}},"description":"Link error score info (wired clients only)"},"CommonSubHealthInfoDetailVOLong":{"type":"object","properties":{"summaryScore":{"type":"integer","description":"Sub dimension health score","format":"int32"},"averageNum":{"type":"array","description":"List of common dimension value, such as rssi","items":{"$ref":"#/components/schemas/TimeValueItemVOLong"}}},"description":"Negotiation rate health info and score"},"OperationResponseClientHealthDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ClientHealthDetailVO"}}},"TimeValueItemVOInteger":{"type":"object","properties":{"time":{"type":"integer","description":"Time(unit:ms)","format":"int64"},"pastNum":{"type":"integer","description":"Value corresponding to time","format":"int32"}},"description":"List of common dimension value, such as rssi"},"TimeValueItemVOLong":{"type":"object","properties":{"time":{"type":"integer","description":"Time(unit:ms)","format":"int64"},"pastNum":{"type":"integer","description":"Value corresponding to time","format":"int64"}},"description":"List of common dimension value, such as rssi"},"AuthInfoVO":{"type":"object","properties":{"authType":{"type":"integer","format":"int32"},"info":{"type":"string"}}},"ClientHistoryVO":{"type":"object","properties":{"id":{"type":"string"},"mac":{"type":"string"},"download":{"type":"integer","format":"int64"},"upload":{"type":"integer","format":"int64"},"duration":{"type":"integer","format":"int64"},"lastSeen":{"type":"integer","format":"int64"},"name":{"type":"string"},"ssid":{"type":"string"},"port":{"type":"integer","format":"int32"},"vid":{"type":"integer","format":"int32"},"reason":{"type":"string"},"reasonType":{"type":"integer","format":"int32"},"guest":{"type":"boolean"},"deviceName":{"type":"string"},"associationTime":{"type":"integer","format":"int32"},"associated":{"type":"integer","format":"int64"},"ip":{"type":"string"},"ipv6List":{"type":"array","items":{"type":"string"}},"authInfo":{"type":"array","items":{"$ref":"#/components/schemas/AuthInfoVO"}}}},"GridVOClientHistoryVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ClientHistoryVO"}}}},"OperationResponseGridVOClientHistoryVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOClientHistoryVO"}}},"Client Filtering Options":{"type":"object","properties":{"deviceType":{"type":"array","description":"Type list of clients.","items":{"$ref":"#/components/schemas/ClientCategoryOptionsOpenApiVO"}},"vendor":{"type":"array","description":"Vendor list of clients.","items":{"type":"string","description":"Vendor list of clients."}},"device":{"type":"array","description":"Device list.","items":{"type":"string","description":"Device list."}},"network":{"type":"array","description":"Network list.","items":{"type":"string","description":"Network list."}},"ssid":{"type":"array","description":"Ssid list.","items":{"type":"string","description":"Ssid list."}},"deviceDetail":{"type":"array","description":"Device detail info list.","items":{"$ref":"#/components/schemas/ClientFilteringDeviceDetailOpenApiVO"}}}},"ClientCategoryOptionsOpenApiVO":{"type":"object","properties":{"category":{"type":"string","description":"Name of client category."},"type":{"type":"array","description":"Type list of clients.","items":{"type":"string","description":"Type list of clients."}}},"description":"Type list of clients."},"ClientFilteringDeviceDetailOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device MAC"},"name":{"type":"string","description":"Device name"},"stack":{"type":"boolean","description":"Does this device belong to a stack group"},"stackName":{"type":"string","description":"Stack group name"}},"description":"Device detail info list."},"OperationResponseClient Filtering Options":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Client Filtering Options"}}},"OpenApiQueryDataV2VO":{"required":["page","pageSize"],"type":"object","properties":{"page":{"type":"integer","description":"Start from 1.","format":"int32"},"pageSize":{"type":"integer","description":"It should be within the range of 1–100.","format":"int32"},"sorts":{"type":"object","additionalProperties":{"type":"string"}},"searchKey":{"type":"string","description":"Look for a specific piece of data."},"filters":{"type":"object","additionalProperties":{"type":"object"}},"searchField":{"type":"string"}}},"ClientGridVOSsidClientVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SsidClientVO"}},"clientStat":{"$ref":"#/components/schemas/ClientStatVO"},"clientTypeStat":{"$ref":"#/components/schemas/ClientTypeStatVO"}}},"OperationResponseClientGridVOSsidClientVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ClientGridVOSsidClientVO"}}},"SsidClientVO":{"type":"object","properties":{"clientMac":{"type":"string","description":"Client Mac."},"name":{"type":"string","description":"Client Name, alias."},"clientModel":{"type":"string","description":"Model of client device."},"clientType":{"type":"string","description":"Type of client device: iphone, ipod, android, pc, printer, tv..."},"deviceMac":{"type":"string","description":"Device Mac."},"deviceName":{"type":"string","description":"Device Name."},"deviceType":{"type":"string","description":"Type of the device that client is connected to."},"deviceModel":{"type":"string","description":"Model of the device that client is connected to."},"deviceModelVersion":{"type":"string","description":"Model version of the device that client is connected to."},"ip":{"type":"string","description":"IP Address."},"downTraffic":{"type":"integer","description":"Downstream traffic (Byte).","format":"int64"},"upTraffic":{"type":"integer","description":"Upstream traffic (Byte).","format":"int64"},"traffic":{"type":"integer","description":"Total traffic (Byte).","format":"int64"}}},"ModelAndModelVersionVO":{"type":"object","properties":{"model":{"type":"string","description":"Model of device"},"modelVersion":{"type":"string","description":"Model version of device"}}},"OperationResponseListModelAndModelVersionVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ModelAndModelVersionVO"}}}},"CliVO":{"type":"object","properties":{"id":{"type":"string","description":"CLI configuration ID"},"name":{"type":"string","description":"CLI configuration name"},"description":{"type":"string","description":"CLI configuration description, it should be within the range of 0 - 256 characters."},"status":{"type":"integer","description":"CLI configuration status, it should be a value as follows: 0: active, 1: inactive","format":"int32"},"apply":{"type":"boolean","description":"Whether the CLI configuration can be applied. Only the CLI configuration in inactive state can be applied."},"devices":{"type":"array","description":"List of devices bound to the CLI configuration, only device CLI has this field.","items":{"$ref":"#/components/schemas/DeviceCliVO"}},"stacks":{"type":"array","description":"List of stacks bound to the CLI configuration, only device CLI has this field.","items":{"$ref":"#/components/schemas/StackCliVO"}},"model":{"type":"string"},"modelVersion":{"type":"string"}}},"GridVOCliVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CliVO"}}}},"OperationResponseGridVOCliVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOCliVO"}}},"OperationResponseListSupportCliDeviceVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/SupportCliDeviceVO"}}}},"SupportCliDeviceVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device mac"},"name":{"type":"string","description":"Device name"},"model":{"type":"string","description":"Model of device"},"modelVersion":{"type":"string","description":"Model version of device"},"ip":{"type":"string","description":"Ip address"},"ipLong":{"type":"integer","format":"int64"},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected; 1:Disconnected(Migrating); 10:Provisioning; 11:Configuring; 12:Upgrading; 13:Rebooting; 14:Connected; 15:Connected(Wireless); 16:Connected(Migrating); 17:Connected(Wireless,Migrating); 20:Pending; 21:Pending(Wireless); 22:Adopting; 23:Adopting(Wireless); 24:Adopt Failed; 25:Adopt Failed(Wireless); 26:Managed By Others; 27:Managed By Others(Wireless); 30:Heartbeat Missed; 31:Heartbeat Missed(Wireless); 32:Heartbeat Missed(Migrating); 33:Heartbeat Missed(Wireless,Migrating); 40:Isolated; 41:Isolated(Migrating); 50:Slice Configuring","format":"int32"},"supportCli":{"type":"boolean","description":"Whether the device supports Cli"},"stackId":{"type":"string","description":"The ID of the associated stack. If the device is not a member of stack, stackId should be null"},"stackName":{"type":"string","description":"The name of the associated stack. If the device is not a member of stack, stackName should be null"},"masterMac":{"type":"string","description":"Master mac. If the device is not a member of stack, masterMac should be null"},"addedInAdvanced":{"type":"boolean","description":"Whether the device is added offline in advance."},"deviceSeriesType":{"type":"integer","description":"DeviceSeriesType should be a value as follows: 0:advanced; 1:pro","format":"int32"},"type":{"type":"string","description":"Type of device should be a value as follows: switch"}}},"CliDeviceListVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device mac"},"name":{"type":"string","description":"Device name"},"model":{"type":"string","description":"Model of device"},"modelVersion":{"type":"string","description":"Model version of device"},"ip":{"type":"string","description":"Ip address"},"status":{"type":"integer","description":"Status of device.Status should be a value as follows: 0:Disconnected; 1:Disconnected(Migrating); 10:Provisioning; 11:Configuring; 12:Upgrading; 13:Rebooting; 14:Connected; 15:Connected(Wireless); 16:Connected(Migrating); 17:Connected(Wireless,Migrating); 20:Pending; 21:Pending(Wireless); 22:Adopting; 23:Adopting(Wireless); 24:Adopt Failed; 25:Adopt Failed(Wireless); 26:Managed By Others; 27:Managed By Others(Wireless); 30:Heartbeat Missed; 31:Heartbeat Missed(Wireless); 32:Heartbeat Missed(Migrating); 33:Heartbeat Missed(Wireless,Migrating); 40:Isolated; 41:Isolated(Migrating); 50:Slice Configuring","format":"int32"},"supportCli":{"type":"boolean","description":"Whether the device supports Cli"},"stackId":{"type":"string","description":"The ID of the associated stack. If the device is not a member of stack, stackId should be null"},"stackName":{"type":"string","description":"The name of the associated stack. If the device is not a member of stack, stackName should be null"},"masterMac":{"type":"string","description":"Master mac. If the device is not a member of stack, masterMac should be null"},"deviceSeriesType":{"type":"integer","description":"DeviceSeriesType should be a value as follows: 0:advanced; 1:pro","format":"int32"},"type":{"type":"string","description":"Type of device should be a value as follows: switch"}}},"OperationResponseListCliDeviceListVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/CliDeviceListVO"}}}},"CliConfigOpenApiVO":{"required":["cliConfig"],"type":"object","properties":{"omadacId":{"type":"string","description":"Omada ID"},"siteId":{"type":"string","description":"Site ID"},"cliType":{"type":"integer","description":"CLI configuration type, it should be a value as follows: 0：site CLI； 1：device CLI.","format":"int32"},"id":{"type":"string","description":"CLI configuration ID"},"name":{"type":"string","description":"CLI configuration name"},"deviceType":{"type":"string","description":"Device type for CLI configuration application, it should be a value as follows: switch."},"description":{"type":"string","description":"CLI configuration description, it should be within the range of 0 - 256 characters."},"status":{"type":"integer","description":"CLI configuration status, it should be a value as follows: 0: active, 1: inactive","format":"int32"},"cliConfig":{"type":"string","description":"CLI configuration content"},"devices":{"type":"array","description":"List of devices bound to the CLI configuration. Only device CLI has this field.","items":{"$ref":"#/components/schemas/DeviceCliVO"}},"stacks":{"type":"array","description":"List of stacks bound to the CLI configuration, only device CLI has this field.","items":{"$ref":"#/components/schemas/StackCliVO"}},"model":{"type":"string","description":"Device model of model cli"},"modelVersion":{"type":"string","description":"Device model version of model cli"}},"description":"Get the CLI configuration entry"},"OperationResponseCliConfigOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CliConfigOpenApiVO"}}},"DeviceInterfaces":{"type":"object","properties":{"interfaces":{"type":"array","items":{"$ref":"#/components/schemas/InterfaceInfo"}},"supportLayout":{"type":"boolean","description":"Whether the device supports reporting port layout information."}}},"InterfaceInfo":{"type":"object","properties":{"interfaceType":{"type":"integer","description":"Parameter [interfaceType] should be a value as follows: 0: Wired, 1: Wireless.","format":"int32"},"interfaceName":{"type":"string","description":"Interface name."},"channel":{"type":"integer","description":"Parameter [channel] should be a value as follows: 0: 2.4GHz  1: 5GHz-1  2:5GHz-2 3: 6GHz","format":"int32"},"interfaceId":{"type":"string","description":"Interface ID, for example: if interfaceType is network, interfaceId should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."},"linkStatus":{"type":"integer","description":"Link status should be a value as follows: 0:LINK_DOWN;1:LINK_UP","format":"int32"},"isCopper":{"type":"boolean","description":"Whether the port is copper when the port is combo."},"downlinkDevices":{"type":"array","description":"Downlink Devices","items":{"$ref":"#/components/schemas/DeviceBriefVO"}}}},"OperationResponseDeviceInterfaces":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceInterfaces"}}},"CaptureResult":{"type":"object","properties":{"status":{"type":"integer","description":"The Status of package capturing. 0: Ongoing, 1: Some error occurs, 2: Local mode capture done, which can download capture file, 3: Default status, which can not download capture file.","format":"int32"}}},"OperationResponseCaptureResult":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CaptureResult"}}},"ChannelInfo":{"type":"object","properties":{"channel":{"type":"integer","description":"Channel that device supports.","format":"int32"},"dfsFlag":{"type":"boolean","description":"Whether the channel is DFS channel."}},"description":"Channel list that device supports in 6 GHz."},"DeviceCaptureInfo":{"type":"object","properties":{"mac":{"type":"string","description":"Device MAC."},"name":{"type":"string","description":"Device name."},"model":{"type":"string","description":"Model of device,for example:EAP225."},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"},"showModel":{"type":"string","description":"Model complex shown in the front end.Ap：model+(country)+modelVersion,EAP225(EU) v3.0  Gateway/Switch：model+modelVersion,Osg v3.0"},"ip":{"type":"string","description":"IP Address."},"supportCapture":{"type":"boolean","description":"Parameter [supportCapture] indicates whether the device supports packet capture."},"support2g":{"type":"boolean","description":"Whether the device supports 2.4GHz."},"support5g":{"type":"boolean","description":"Whether the device supports 5GHz."},"support5g2":{"type":"boolean","description":"Whether the device supports 5GHz frequency splitting into two parts."},"support6g":{"type":"boolean","description":"Whether the device supports 6GHz."},"firmwareVersion":{"type":"string","description":"Device firmware version."},"supportLanCapture":{"type":"boolean","description":"Parameter [supportLanCapture] indicates whether the device supports LAN port packet capture."},"interfaces":{"type":"array","description":"Interface info.","items":{"$ref":"#/components/schemas/InterfaceInfo"}},"deviceSeriesType":{"type":"integer","description":"Device type: 0: Advanced; 1: Pro.","format":"int32"},"type":{"type":"string","description":"Device Type."},"stack":{"type":"boolean","description":"Parameter [stack] indicates whether the device supports stacking."},"stackId":{"type":"string","description":"Stack ID."},"supportOTACapture":{"type":"boolean","description":"Parameter [supportOTACapture] indicates whether the device supports air interface packet capture and flow-mode packet capture."},"currentChannel2g":{"type":"integer","description":"Current channel of 2.4 GHz.","format":"int32"},"channelList2g":{"type":"array","description":"Channel list that device supports in 2.4 GHz.","items":{"$ref":"#/components/schemas/ChannelInfo"}},"currentChannel5g":{"type":"integer","description":"Current channel of 5 GHz.","format":"int32"},"channelList5g":{"type":"array","description":"Channel list that device supports in 5 GHz.","items":{"$ref":"#/components/schemas/ChannelInfo"}},"currentChannel5g2":{"type":"integer","description":"Current channel of 5 GHz(2).","format":"int32"},"channelList5g2":{"type":"array","description":"Channel list that device supports in 5 GHz(2).","items":{"$ref":"#/components/schemas/ChannelInfo"}},"currentChannel6g":{"type":"integer","description":"Current channel of 6 GHz.","format":"int32"},"channelList6g":{"type":"array","description":"Channel list that device supports in 6 GHz.","items":{"$ref":"#/components/schemas/ChannelInfo"}},"fileSize":{"type":"integer","description":"Size limit of the captured file, in MB.","format":"int32"},"supportStreamCapture":{"type":"boolean","description":"Parameter [supportStreamCapture] indicates whether the device supports flow-mode packet capture."},"supportScanRadio":{"type":"boolean","description":"Parameter [supportScanRadio] indicates whether the device has independent radio frequency capabilities."},"scanStatus":{"type":"integer","description":"Scan Status of device,status should be a value as follows:  0:Not Scanned, 1:Spectrum Scanning, 2:RFScanning, 3:packet capturing, 4:RFPlanning, 5:Interference Detecting;","format":"int32"}}},"GridVODeviceCaptureInfo":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/DeviceCaptureInfo"}}}},"OperationResponseGridVODeviceCaptureInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVODeviceCaptureInfo"}}},"OperationResponseListOswCableTestPortVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/OswCableTestPortVO"}}}},"OswCableTestPortVO":{"type":"object","properties":{"port":{"type":"integer","description":"Port Id","format":"int32"},"standardPort":{"$ref":"#/components/schemas/OswStandPortVO"},"type":{"type":"integer","description":"Port type, it should be a value as follows: 1: Copper, 2: Combo, 3: SFP","format":"int32"},"name":{"type":"string","description":"Port name."},"editEnable":{"type":"boolean","description":"It indicates whether the port can run cable test."},"isUpperPort":{"type":"boolean","description":"It indicates whether the port is upper port."},"isDisabled":{"type":"boolean","description":"It indicates whether the port is disabled."},"isStackPort":{"type":"boolean","description":"It indicates whether the port is stack port"},"reasons":{"type":"array","description":"Only valid when editEnable is false.It indicates why the port can not run cable test. Each item should be a value as follows: -1:uplink port. -2:disabled port. -3:SFP port. -4:console port. -5:USB port. -5:Stack port","items":{"type":"integer","description":"Only valid when editEnable is false.It indicates why the port can not run cable test. Each item should be a value as follows: -1:uplink port. -2:disabled port. -3:SFP port. -4:console port. -5:USB port. -5:Stack port","format":"int32"}},"downlinkDevices":{"type":"array","description":"Downlink Devices","items":{"$ref":"#/components/schemas/DeviceBriefVO"}},"isCopper":{"type":"boolean","description":"Whether the port is copper when the port is combo."}}},"OperationResponseListOswCableTestLogOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/OswCableTestLogOpenApiVO"}}}},"OswCableTestLogOpenApiVO":{"type":"object","properties":{"type":{"type":"integer","description":"Log type. It should be a value as follows: 0:start test. 1: test done. 2:test interrupts 3:time out","format":"int32"},"timeStamp":{"type":"integer","description":"Timestamp of the log","format":"int64"},"testPortList":{"type":"array","description":"All test port. Used for type 0","items":{"$ref":"#/components/schemas/OswBriefPortInfoOpenApiVO"}},"completePortList":{"type":"array","description":"Ports that have been tested completely. Used for type 1,2,3","items":{"$ref":"#/components/schemas/OswBriefPortInfoOpenApiVO"}},"cancelPortList":{"type":"array","description":"Ports that were not detected due to cancel. Used for type 2","items":{"$ref":"#/components/schemas/OswBriefPortInfoOpenApiVO"}},"timeoutPortList":{"type":"array","description":"Timeout ports. Used for type 3","items":{"$ref":"#/components/schemas/OswBriefPortInfoOpenApiVO"}}}},"OperationResponseOswCableTestResultWithStatusVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswCableTestResultWithStatusVO"}}},"OswCableTestResultVO":{"type":"object","properties":{"port":{"type":"integer","description":"Port","format":"int32"},"standardPort":{"$ref":"#/components/schemas/OswStandPortVO"},"state":{"type":"array","description":"Cable state List. Each item should be a value as follows: 0:OK  1:OPEN  2:short 3:crosstalk 4:unknown-error 5:not-support 6:openshort","items":{"type":"integer","description":"Cable state List. Each item should be a value as follows: 0:OK  1:OPEN  2:short 3:crosstalk 4:unknown-error 5:not-support 6:openshort","format":"int32"}},"length":{"type":"array","description":"Cable length List.","items":{"type":"integer","description":"Cable length List.","format":"int32"}},"timeStamp":{"type":"integer","description":"Timestamp of the test result","format":"int64"}},"description":"Test results."},"OswCableTestResultWithStatusVO":{"type":"object","properties":{"status":{"type":"integer","description":"Test status.It should be a value as follows: 0:free. 1:testing. 2:test done. 3:time out.","format":"int32"},"data":{"type":"array","description":"Test results.","items":{"$ref":"#/components/schemas/OswCableTestResultVO"}},"stackData":{"type":"array","description":"Stack Test results","items":{"$ref":"#/components/schemas/OswStackMemberCableTestResultVO"}}}},"OswStackMemberCableTestResultVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device Mac."},"unit":{"type":"integer","description":"unit","format":"int32"},"data":{"type":"array","description":"Test results.","items":{"$ref":"#/components/schemas/OswCableTestResultVO"}}},"description":"Stack Test results"},"OperationResponseOswStackCableTestVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OswStackCableTestVO"}}},"OswStackCableTestVO":{"type":"object","properties":{"name":{"type":"string","description":"stack name"},"stackId":{"type":"string","description":"stack ID"},"member":{"type":"array","description":"stack member list","items":{"$ref":"#/components/schemas/OswStackMemberCableTestVO"}}}},"OswStackMemberCableTestVO":{"type":"object","properties":{"mac":{"type":"string","description":"MAC"},"unit":{"type":"integer","description":"Unit","format":"int32"},"model":{"type":"string","description":"Device Model."},"modelVersion":{"type":"string","description":"Device Model Version."},"portList":{"type":"array","description":"Port list","items":{"$ref":"#/components/schemas/OswCableTestPortVO"}}},"description":"stack member list"},"OperationResponseSiteBeaconControlSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteBeaconControlSetting"}}},"OperationResponseSiteBandSteeringSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteBandSteeringSetting"}}},"BackupResultOpenApiVO":{"type":"object","properties":{"status":{"type":"integer","description":"Backup status should be a value as follows: 0: finished or init; 1: backup running.","format":"int32"}}},"AuditLogOpenApiVO":{"type":"object","properties":{"time":{"type":"integer","description":"Log Creation TimeStamp, Unit:ms","format":"int64","example":1677660067182},"operator":{"type":"string","description":"Operator","example":"user1"},"resource":{"type":"string","description":"Log Creation Resource. It should be a value as follows: WEB、Open API","example":"WEB"},"ip":{"type":"string","description":"User Login IP address","example":"127.0.0.1"},"auditType":{"type":"string","description":"Log Type","example":"Log"},"level":{"type":"string","description":"Log Level. It should be a value as follows: Error, Warning, Information.","example":"Information"},"result":{"type":"string","description":"Operation Result, it should be a value as follows: Succeed、Failed","example":"Succeed"},"content":{"type":"string","description":"Log Content","example":"Dashboard Tab test-Tab added successfully."},"label":{"type":"string","description":"Configuration card or request path, may be empty.","example":"MENU.CLIENTS or /openapi/v1/{omadacId}/sites/{siteId}/site/reset/log-notification"},"oldValue":{"type":"object","description":"Configuration before modification, may be empty.","example":{"dpi":"false","loggingTraffic":"false"}},"newValue":{"type":"object","description":"Configuration after modification, may be empty.","example":{"dpi":"true","loggingTraffic":"true"}}}},"GridVOAuditLogOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/AuditLogOpenApiVO"}}}},"OperationResponseGridVOAuditLogOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOAuditLogOpenApiVO"}}},"ApOverrideAuditLogVO":{"type":"object","properties":{"globalSsid":{"type":"string"},"oldSsidName":{"type":"string"},"newSsidName":{"type":"string"},"oldVlanId":{"type":"string"},"newVlanId":{"type":"string"},"ssidNameModified":{"type":"boolean"},"passwordModified":{"type":"boolean"},"vlanIdModified":{"type":"boolean"}}},"GridVOApOverrideAuditLogVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApOverrideAuditLogVO"}}}},"OperationResponseGridVOApOverrideAuditLogVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOApOverrideAuditLogVO"}}},"AttackDefenseSettingForQuery":{"type":"object","properties":{"tcpConnEnable":{"type":"boolean","description":"Multi-connections TCP SYN flood enable of the attack defense setting."},"tcpConnLimit":{"type":"integer","description":"Multi-connections TCP SYN flood limit should be within the range of 100–99999.","format":"int32"},"udpConnEnable":{"type":"boolean","description":"Multi-connections UDP flood enable of the attack defense setting."},"udpConnLimit":{"type":"integer","description":"Multi-connections UDP flood limit should be within the range of 100–99999.","format":"int32"},"icmpConnEnable":{"type":"boolean","description":"Multi-connections ICMP flood enable of the attack defense setting."},"icmpConnLimit":{"type":"integer","description":"Multi-connections ICMP flood limit should be within the range of 100–99999.","format":"int32"},"tcpSrcEnable":{"type":"boolean","description":"Stationary source TCP SYN flood enable of the attack defense setting."},"tcpSrcLimit":{"type":"integer","description":"Stationary source TCP SYN flood limit should be within the range of 100–99999.","format":"int32"},"udpSrcEnable":{"type":"boolean","description":"Stationary source UDP flood enable of the attack defense setting."},"udpSrcLimit":{"type":"integer","description":"Stationary source UDP flood limit should be within the range of 100–99999.","format":"int32"},"icmpSrcEnable":{"type":"boolean","description":"Stationary source ICMP flood enable of the attack defense setting."},"icmpSrcLimit":{"type":"integer","description":"Stationary source ICMP flood limit should be within the range of 100–99999.","format":"int32"},"tcpScanEnable":{"type":"boolean","description":"Block TCP scan enable of the attack defense setting."},"tcpScanReject":{"type":"boolean","description":"Block TCP scan with reject of the attack defense setting."},"supportTcpScanReject":{"type":"boolean","description":"Whether Block TCP scan with reject of the attack defense setting is supported."},"existTcpScanReject":{"type":"boolean","description":"Whether Block TCP scan with reject of the attack defense setting is ON."},"pingDeathEnable":{"type":"boolean","description":"Block ping of death of the attack defense setting."},"largePingEnable":{"type":"boolean","description":"Block Large Ping Threshold of the attack defense setting."},"largePingThreshold":{"type":"integer","description":"Block Large Ping Threshold of the attack defense setting, Value is between 28 and 65535.","format":"int32"},"supportLargePingThreshold":{"type":"boolean","description":"Whether custom Block Large Ping Threshold of the attack defense is supported."},"existLargePingThreshold":{"type":"boolean","description":"Whether custom Block Large Ping Threshold of attack defense is configured."},"pingWanEnable":{"type":"boolean","description":"Block ping from WAN of the attack defense setting."},"winNukeAttackEnable":{"type":"boolean","description":"Block WinNuke attack of the attack defense setting."},"tcpSynFinEnable":{"type":"boolean","description":"Block TCP packets with SYN and FIN Bits set of the attack defense setting."},"tcpFinNoAckEnable":{"type":"boolean","description":"Block TCP packets with FIN Bit set but no ACK Bit set of the attack defense setting."},"specifiedOptionEnable":{"type":"boolean","description":"Block packets with specified options of the attack defense setting."},"specifiedOption":{"$ref":"#/components/schemas/SpecifiedOptionOpenApiVO"},"icmpTimestampRequestReject":{"type":"boolean","description":"ICMP Timestamp Request setting of the attack defense setting."},"supportIcmpTimestampRequestReject":{"type":"boolean","description":"Whether ICMP Timestamp Request is supported of the attack defense setting."},"existIcmpTimestampRequestReject":{"type":"boolean","description":"Whether ICMP Timestamp Request of the attack defense setting is ON."},"featureDescription":{"type":"array","description":"Gateway Feature Description.","items":{"$ref":"#/components/schemas/FeatureInfoVO"}}}},"OperationResponseAttackDefenseSettingForQuery":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AttackDefenseSettingForQuery"}}},"ApOverviewInfo":{"type":"object","properties":{"type":{"type":"string","description":"Device type"},"mac":{"type":"string","description":"Device MAC, e.g. 00-00-FF-FF-0C-E9"},"name":{"type":"string","description":"Device name"},"ip":{"type":"string","description":"Device IP"},"ipv6List":{"type":"array","description":"Device IPv6","items":{"type":"string","description":"Device IPv6"}},"wlan group id":{"type":"string","description":"WLAN group ID"},"wirelessLinked":{"type":"boolean","description":"Whether AP is wireless linked"},"wireless uplink info":{"$ref":"#/components/schemas/ApWirelessUplink"},"model":{"type":"string","description":"Device model"},"firmwareVersion":{"type":"string","description":"Device firmware version"},"cpuUtil":{"type":"integer","description":"Device cpu util(like 1 means 1% cpu util)","format":"int32"},"memoryUtil":{"type":"integer","description":"Device memory util(like 50 means 50% memory util)","format":"int32"},"uptimeLong":{"type":"integer","description":"Device uptime(unit:second)","format":"int64"},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected; 1:Disconnected(Migrating); 10:Provisioning; 11:Configuring; 12:Upgrading; 13:Rebooting; 14:Connected; 15:Connected(Wireless); 16:Connected(Migrating); 17:Connected(Wireless,Migrating); 20:Pending; 21:Pending(Wireless); 22:Adopting; 23:Adopting(Wireless); 24:Adopt Failed; 25:Adopt Failed(Wireless); 26:Managed By Others; 27:Managed By Others(Wireless); 30:Heartbeat Missed; 31:Heartbeat Missed(Wireless); 32:Heartbeat Missed(Migrating); 33:Heartbeat Missed(Wireless,Migrating); 40:Isolated; 41:Isolated(Migrating); 50:Slice Configuring","format":"int32"},"statusCategory":{"type":"integer","description":"Category of device status, statusCategory should be a value as follows: 0:Disconnected; 1:Connected; 2:Pending; 3:Heartbeat Missed; 4:Isolated","format":"int32"}}},"ApWirelessUplink":{"type":"object","properties":{"uplinkMac":{"type":"string","description":"Uplink AP MAC"},"name":{"type":"string","description":"Uplink AP name"},"channel":{"type":"integer","description":"Uplink AP channel","format":"int32"},"rssi":{"type":"integer","description":"Uplink AP rssi","format":"int32"},"snr":{"type":"integer","description":"Uplink AP Signal-noise ratio","format":"int32"},"txRate":{"type":"string","description":"Uplink AP txRate"},"txRateInt":{"type":"integer","description":"Uplink AP txRateInt; Unit: Mbps","format":"int32"},"rxRate":{"type":"string","description":"Uplink AP rxRate"},"rxRateInt":{"type":"integer","description":"Uplink AP rxRateInt; Unit: Mbps","format":"int32"},"upBytes":{"type":"integer","description":"Uplink AP upBytes; Unit: Byte","format":"int64"},"downBytes":{"type":"integer","description":"Uplink AP downBytes; Unit:Byte","format":"int64"},"upPackets":{"type":"integer","description":"Uplink AP upPackets","format":"int64"},"downPackets":{"type":"integer","description":"Uplink AP downPackets","format":"int64"},"activity":{"type":"integer","description":"Uplink AP activity: (change of(downBytes+upBytes))/time","format":"int64"},"supportSpeedTest":{"type":"boolean","description":"Whether speed measurement is supported."},"model":{"type":"string","description":"Device model.(Used to display the device model diagram)"},"modelVersion":{"type":"string","description":"Device model version.(Used to display the device model diagram)"},"ip":{"type":"string","description":"Device IP."},"type":{"type":"string","description":"Device type."},"uplinkPort":{"type":"string","description":"Uplink port of current device. To mark that this port cannot be configured."},"partnerLinks":{"type":"array","description":"Mlo link Info","items":{"$ref":"#/components/schemas/PartnerLinkVO"}}},"description":"Wireless uplink info"},"OperationResponseApOverviewInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApOverviewInfo"}}},"PartnerLinkVO":{"type":"object","properties":{"radioId":{"type":"integer","description":"radioId, 0:2.4G, 1:5G, 2:5G2, 3:6G","format":"int32"},"channel":{"type":"integer","description":"Uplink AP channel","format":"int32"},"rssi":{"type":"integer","description":"Uplink AP rssi","format":"int32"},"snr":{"type":"integer","description":"Uplink AP Signal-noise ratio","format":"int32"},"txRate":{"type":"string","description":"Uplink AP txRate"},"txRateInt":{"type":"integer","description":"Uplink AP txRateInt; Unit: Mbps","format":"int32"},"rxRate":{"type":"string","description":"Uplink AP rxRate"},"rxRateInt":{"type":"integer","description":"Uplink AP rxRateInt; Unit: Mbps","format":"int32"},"upBytes":{"type":"integer","description":"Uplink AP upBytes; Unit: Byte","format":"int64"},"downBytes":{"type":"integer","description":"Uplink AP downBytes; Unit:Byte","format":"int64"},"upPackets":{"type":"integer","description":"Uplink AP upPackets","format":"int64"},"downPackets":{"type":"integer","description":"Uplink AP downPackets","format":"int64"},"activity":{"type":"integer","description":"Uplink AP activity: (change of(downBytes+upBytes))/time","format":"int64"},"upRate":{"type":"integer","description":"Uplink AP upRate: the txRate calculate by Controller","format":"int64"},"downRate":{"type":"integer","description":"Uplink AP downRate: the rxRate calculate by Controller","format":"int64"}},"description":"Mlo link Info"},"ApWiredUplink":{"type":"object","properties":{"wiredUplink":{"$ref":"#/components/schemas/ApWiredUplinkInfo"}}},"ApWiredUplinkInfo":{"type":"object","properties":{"uplinkMac":{"type":"string","description":"Uplink device MAC address"},"stackId":{"type":"string"},"type":{"type":"string","description":"Uplink device type"},"name":{"type":"string","description":"Uplink device name"},"rate":{"type":"string","description":"Negotiation rate, LAN(connected): 10,100,1000,2500,10000, LAN(disconnected):0, Unit:Mbps"},"duplex":{"type":"integer","description":"Duplex should be a value as follows: 0: LAN disconnected; 1: half; 2: full","format":"int32"},"upBytes":{"type":"integer","description":"Unit: Byte","format":"int64"},"downBytes":{"type":"integer","description":"Unit: Byte","format":"int64"},"upPackets":{"type":"integer","description":"Uplink Device upPackets","format":"int64"},"downPackets":{"type":"integer","description":"Uplink Device downPackets","format":"int64"},"upDropPackets":{"type":"integer","description":"Uplink Device upDropPackets","format":"int64"},"downDropPackets":{"type":"integer","description":"Uplink Device downDropPackets","format":"int64"},"upErrorsPackets":{"type":"integer","description":"Uplink Device upErrorsPackets","format":"int64"},"downErrorsPackets":{"type":"integer","description":"Uplink Device downErrorsPackets","format":"int64"},"activity":{"type":"integer","description":"(Change of( downBytes+upBytes))/ time, Unit: Bytes/s","format":"int64"},"port":{"type":"string","description":"Uplink port ID, only supported by some devices."},"ip":{"type":"string","description":"Uplink device ip."},"portType":{"type":"integer","description":"Port Type, 0:ETH, 1:POTS, 2:SFP","format":"int32"},"txPower":{"type":"number","description":"Tx power, only supported by some devices.","format":"double"},"rxPower":{"type":"number","description":"Rx Power, only supported by some devices.","format":"double"},"temp":{"type":"number","description":"Temperature, only supported by some devices.","format":"double"},"voltage":{"type":"number","description":"Voltage, only supported by some devices.","format":"double"},"current":{"type":"number","description":"Current, only supported by some devices.","format":"double"},"model":{"type":"string","description":"Uplink device model"},"modelVersion":{"type":"string","description":"Uplink device modelVersion"},"uplinkPort":{"type":"string","description":"Uplink device port"},"linkStatus":{"type":"integer","description":"Uplink port link status","format":"int32"},"linkSpeed":{"type":"integer","description":"Uplink port link speed","format":"int32"},"poeState":{"type":"integer","description":"PoE state, 0: powering, 1: not powering","format":"int32"},"voipState":{"type":"integer","description":"VoIP state, 0: off-hook, 1: on-hook","format":"int32"}},"description":"Wired uplink info"},"OperationResponseApWiredUplink":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApWiredUplink"}}},"ApDownLinkStatusVO":{"type":"object","properties":{"port":{"type":"string"},"portType":{"type":"integer","format":"int32"},"duplex":{"type":"integer","format":"int32"},"link":{"type":"integer","format":"int32"},"speed":{"type":"integer","format":"int32"},"poeState":{"type":"integer","format":"int32"},"voipState":{"type":"integer","format":"int32"},"mac":{"type":"string"},"ip":{"type":"string"},"type":{"type":"string"},"deviceName":{"type":"string"},"model":{"type":"string"},"modelVersion":{"type":"string"},"txPower":{"type":"number","format":"double"},"rxPower":{"type":"number","format":"double"},"temp":{"type":"number","format":"double"},"voltage":{"type":"number","format":"double"},"current":{"type":"number","format":"double"},"rxPkts":{"type":"integer","format":"int64"},"txPkts":{"type":"integer","format":"int64"},"rx":{"type":"integer","format":"int64"},"tx":{"type":"integer","format":"int64"},"rxDropPkts":{"type":"integer","format":"int64"},"txDropPkts":{"type":"integer","format":"int64"},"rxErrPkts":{"type":"integer","format":"int64"},"txErrPkts":{"type":"integer","format":"int64"},"downLinkPort":{"type":"string"},"display":{"type":"boolean"}},"description":"Wired downlink device list"},"ApWiredDownlink":{"type":"object","properties":{"wiredDownlinkList":{"type":"array","description":"Wired downlink device list","items":{"$ref":"#/components/schemas/ApDownLinkStatusVO"}}}},"OperationResponseApWiredDownlink":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApWiredDownlink"}}},"ApVlanConfigOpenApiVO":{"required":["mode"],"type":"object","properties":{"mode":{"type":"integer","description":"Mode for the AP management VLAN configuration to take effect.[0:Default,1:Custom]","format":"int32"},"lanNetworkId":{"type":"string","description":"This field indicates the currently effective lanNetworkId."},"bridgeVlan":{"type":"integer","description":"When mvlanNetworkId is bridge vlan, mvlanBridgeVlan has a value.","format":"int32"}}},"OperationResponseApVlanConfigOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApVlanConfigOpenApiVO"}}},"OperationResponseListApUplinkConfigOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ApUplinkConfigOpenApiVO"}}}},"ApTrunkSettingOpenApiVO":{"type":"object","properties":{"supportTrunkSetting":{"type":"boolean","description":"Whether the device supports trunk setting (LAG)."},"enable":{"type":"boolean","description":"Whether the device enables trunk setting (LAG)."},"mode":{"type":"integer","description":"Trunk setting (LAG) mode. Mode should be a value as follows: 0：SRC MAC + DST MAC; 1：DST MAC; 2：SRC MAC.","format":"int32"}}},"OperationResponseApTrunkSettingOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApTrunkSettingOpenApiVO"}}},"ApSpeedTestResultOpenApiVO":{"type":"object","properties":{"role":{"type":"integer","description":"Uplink or downlink AP for the current AP. The parameter [role] should be a value as follows:[0:Uplink; 1:Downlink].","format":"int32"},"downRate":{"type":"number","description":"Downlink rate","format":"double"},"upRate":{"type":"number","description":"Uplink rate","format":"double"},"time":{"type":"integer","description":"Time in milliseconds.","format":"int64"},"status":{"type":"integer","description":"The parameter [status] should be a value as follows:[-2:Device error; -1:System error; 0:No result; 1:Normal results].","format":"int32"},"errorCode":{"type":"integer","description":"This field will only be present if status is an error status.","format":"int32"},"errorMsg":{"type":"string","description":"This field will only be present if status is an error status."}},"description":"Speed measurement results of uplink and downlink devices."},"ApSpeedTestResultsOpenApiVO":{"type":"object","properties":{"mainTesting":{"type":"boolean","description":"Whether the main AP is currently measuring speed."},"sourceAP":{"type":"string","description":"The MAC address of the AP that initiates the speed measurement when the current device is measuring."},"targetAP":{"type":"string","description":"The MAC address of the AP whose speed is being measured when the current device is measuring."},"speedTestResult":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ApSpeedTestResultOpenApiVO"},"description":"Speed measurement results of uplink and downlink devices."}}},"OperationResponseApSpeedTestResultsOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApSpeedTestResultsOpenApiVO"}}},"ApSnmpConfigOpenApiVO":{"type":"object","properties":{"location":{"pattern":"^[!-~][\\040-\\0176]{0,126}[!-~]$|^[!-~]$|$","type":"string","description":"SNMP parameter [location] is required only when [type] = 1, location should contain 0 to 128 ASCII characters, spaces are allowed, and leading and trailing spaces are not allowed."},"contact":{"pattern":"^[\\041-\\0176]{0,128}$","type":"string","description":"SNMP parameter [contact] is required only when [type] = 1, contact should contain 0 to 128 ASCII characters, spaces are not allowed."},"type":{"type":"integer","description":"SNMP parameter [type] should be a value as follows: 0: Use Site Settings; 1: Custom.","format":"int32"}}},"OperationResponseApSnmpConfigOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApSnmpConfigOpenApiVO"}}},"ApRFScanInfo":{"type":"object","properties":{"channel2g":{"type":"array","description":"Channel 2g","items":{"$ref":"#/components/schemas/RFScanRadio"}},"channel5g":{"type":"array","description":"Channel 5g","items":{"$ref":"#/components/schemas/RFScanRadio"}},"channel5g2":{"type":"array","description":"Channel 5g2","items":{"$ref":"#/components/schemas/RFScanRadio"}},"channel6g":{"type":"array","description":"Channel 6g","items":{"$ref":"#/components/schemas/RFScanRadio"}},"currentChan2g":{"type":"string","description":"The 2G channel of AP, such as 1,6,11,13. It should be within the range of 1–13."},"currentChan5g":{"type":"string","description":"The 5G channel of AP, such as 36,161. It should be within the range of 36–161."},"currentChan5g2":{"type":"string","description":"The 5G2 channel of AP,such as 36,161. It should be within the range of 36–161."},"currentChan6g":{"type":"string","description":"The 6G channel of AP,such as 36,161. It should be within the range of 36–161."},"currentChanW2g":{"type":"integer","description":"The 2g channel bandwidth of the AP. It should be a value as follows: 2:20MHz, 3: 40MHz","format":"int32"},"currentChanW5g":{"type":"integer","description":"The 5g channel bandwidth of the AP. It should be a value as follows: 2:20MHz, 3: 40MHz, 5: 80MHz2 menas 20MHz, 3 means 40MHz, 5 means 80MHz","format":"int32"},"currentChanW5g2":{"type":"integer","description":"The 5g2 channel bandwidth of the AP. It should be a value as follows: 2:20MHz, 3: 40MHz, 5: 80MHz","format":"int32"},"currentChanW6g":{"type":"integer","description":"The 6g channel bandwidth of the AP. It should be a value as follows: 2:20MHz, 3: 40MHz, 5: 80MHz","format":"int32"},"time":{"type":"integer","description":"The scan time(13 bits), Unit: ms","format":"int64"},"status":{"type":"integer","description":"Status should be a value as follows: 0: the scan result is displayed; 1: no scan result; 2: Scanning","format":"int32"}}},"OperationResponseApRFScanInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApRFScanInfo"}}},"RFScanRadio":{"type":"object","properties":{"chan":{"type":"integer","description":"Channel number","format":"int32"},"chanWidth":{"type":"integer","description":"ChanWidth should be a value as follows: 2: 20MHz, 3: 40MHz, 5: 80MHz","format":"int32"},"util":{"type":"integer","description":"Channel utilization should be within the range of 0–100.","format":"int32"},"inter":{"type":"array","description":"At most two types of interference data are reported in Inter, sorted in descending order of interference intensity","items":{"$ref":"#/components/schemas/Interference"}}},"description":"Channel 6g"},"ApRadiosDetail":{"type":"object","properties":{"radioTraffic2g":{"$ref":"#/components/schemas/AP radio traffic entity"},"radioTraffic5g":{"$ref":"#/components/schemas/AP radio traffic entity"},"radioTraffic5g2":{"$ref":"#/components/schemas/AP radio traffic entity"},"radioTraffic6g":{"$ref":"#/components/schemas/AP radio traffic entity"},"wp2g":{"$ref":"#/components/schemas/ApRadioChannel"},"wp5g":{"$ref":"#/components/schemas/ApRadioChannel"},"wp5g2":{"$ref":"#/components/schemas/ApRadioChannel"},"wp6g":{"$ref":"#/components/schemas/ApRadioChannel"}}},"OperationResponseApRadiosDetail":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApRadiosDetail"}}},"OperationResponseApRadiosConfig":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApRadiosConfig"}}},"ApAdvancedQosOpenApiVO":{"type":"object","properties":{"support2g":{"type":"boolean","description":"Whether the device supports 2.4GHz."},"support5g":{"type":"boolean","description":"Whether the device supports 5GHz."},"support5g2":{"type":"boolean","description":"Whether the device supports 5GHz frequency splitting into two parts."},"support6g":{"type":"boolean","description":"Whether the device supports 6GHz."},"deliveryEnable2g":{"type":"boolean","description":"Whether Unscheduled Automatic Power Save Delivery enabled in 2.4GHz."},"deliveryEnable5g":{"type":"boolean","description":"Whether Unscheduled Automatic Power Save Delivery enabled in 5GHz. The field [deliveryEnable5g] will be filled in when the device supports 5GHz. If the device supports frequency division, the field indicates 5GHZ-1.(5GHZ-1 is the second part of the 5GHz band) If the device does not support frequency division, the field indicates the entire band of 5GHz."},"deliveryEnable5g2":{"type":"boolean","description":"Whether Unscheduled Automatic Power Save Delivery enabled in 5GHz-2.(5GHZ-2 is the second part of the 5GHz band) The field [deliveryEnable5g2] will be filled in when the device supports 5GHz and frequency splitting."},"deliveryEnable6g":{"type":"boolean","description":"Whether Unscheduled Automatic Power Save Delivery enabled in 6GHz."}}},"OperationResponseApAdvancedQosOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApAdvancedQosOpenApiVO"}}},"ApPowerSavingConfigOpenApiVO":{"type":"object","properties":{"mode":{"type":"integer","description":"Power Saving Mode of device. 0: OFF, 1: Standard( based on the user‑specified time and/or band settings ), 2: Smart, 3: Deep Power‑Saving","format":"int32"},"timeEnable":{"type":"boolean","description":"Power Saving trigger by time config status. True: enable, false: disable."},"startTimeH":{"type":"integer","description":"Start time of trigger by time(unit: hour); It should be within the range of 0–23.","format":"int32"},"startTimeM":{"type":"integer","description":"Start time of trigger by time(unit: minute); It should be within the range of 0–59.","format":"int32"},"endTimeH":{"type":"integer","description":"End time of trigger by time(unit: hour); It should be within the range of 0–23.","format":"int32"},"endTimeM":{"type":"integer","description":"End time of trigger by time(unit: minute); It should be within the range of 0–59.","format":"int32"},"bandEnable":{"type":"boolean","description":"Power Saving trigger by band config status. True: enable, false: disable."},"bands":{"type":"array","description":"Select bands list config of trigger by band;It should be a value as follows: 0: 2.4GHz; 1: 5GHz; 2: 5G2Hz; 3: 6GHz.","items":{"type":"integer","description":"Select bands list config of trigger by band;It should be a value as follows: 0: 2.4GHz; 1: 5GHz; 2: 5G2Hz; 3: 6GHz.","format":"int32"}},"idleDuration":{"type":"integer","description":"Idle duration config of trigger by band.","format":"int32"},"supportPowerSaving":{"type":"boolean","description":"Indicates whether the device supports power saving. True: support, false: unSupport."}}},"OperationResponseApPowerSavingConfigOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApPowerSavingConfigOpenApiVO"}}},"ApVlansVO":{"type":"object","properties":{"localVlanId":{"type":"integer","description":"Vlan ID","format":"int32"},"localVlanNetworkId":{"type":"string","description":"Network ID"},"name":{"type":"string","description":"Network Name"},"ipaddr":{"type":"string","description":"IP address."},"nativePort":{"type":"array","description":"Native Port List","items":{"type":"string","description":"Native Port List"}},"tagPort":{"type":"array","description":"Tag Port List","items":{"type":"string","description":"Tag Port List"}},"untagPort":{"type":"array","description":"Untag Port List","items":{"type":"string","description":"Untag Port List"}}}},"GridVOApVlansVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApVlansVO"}}}},"OperationResponseGridVOApVlansVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOApVlansVO"}}},"AP Bridge Paring Window Result":{"type":"object","properties":{"status":{"type":"integer","format":"int32"},"countdown":{"type":"integer","format":"int64"},"clientAps":{"type":"array","items":{"$ref":"#/components/schemas/ApBridgeClientApOpenApiVO"}}}},"ApBridgeClientApOpenApiVO":{"type":"object","properties":{"mac":{"type":"string"},"status":{"type":"integer","description":"Status of device,status should be a value as follows: 0:Disconnected;1:Disconnected(Migrating);10:Provisioning;11:Configuring;12:Upgrading;13:Rebooting;14:Connected;15:Connected(Wireless);16:Connected(Migrating);17:Connected(Wireless,Migrating);20:Pending;21:Pending(Wireless);22:Adopting;23:Adopting(Wireless);24:Adopt Failed;25:Adopt Failed(Wireless);26:Managed By Others;27:Managed By Others(Wireless);30:Heartbeat Missed;31:Heartbeat Missed(Wireless);32:Heartbeat Missed(Migrating);33:Heartbeat Missed(Wireless,Migrating);40:Isolated;41:Isolated(Migrating);50:Slice Configuring","format":"int32"},"rssi":{"type":"integer","format":"int32"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"}}},"OperationResponseAP Bridge Paring Window Result":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AP Bridge Paring Window Result"}}},"ApP2pInfo":{"type":"object","properties":{"mainAp":{"$ref":"#/components/schemas/P2pInfoOpenApiVO"},"childAps":{"type":"array","description":"Child aps info","items":{"$ref":"#/components/schemas/P2pInfoOpenApiVO"}}}},"OperationResponseApP2pInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApP2pInfo"}}},"P2pInfoOpenApiVO":{"type":"object","properties":{"deviceMac":{"type":"string","description":"Device MAC."},"deviceName":{"type":"string","description":"Device name."}},"description":"Child aps info"},"ApOfdmaConfigOpenApiVO":{"type":"object","properties":{"ofdmaEnable2g":{"type":"boolean","description":"Advanced feature OFDMA 2G config status. True: enable, false: disable."},"ofdmaEnable5g":{"type":"boolean","description":"Advanced feature OFDMA 5G config status. True: enable, false: disable."},"ofdmaEnable5g2":{"type":"boolean","description":"Advanced feature OFDMA 5G2 config status. True: enable, false: disable."},"ofdmaEnable6g":{"type":"boolean","description":"Advanced feature OFDMA 6G config status. True: enable, false: disable."},"supportOfdma2g":{"type":"boolean","description":"Indicates whether the device supports OFDMA 2G. True: support, false: unSupport."},"supportOfdma5g":{"type":"boolean","description":"Indicates whether the device supports OFDMA 5G. True: support, false: unSupport."},"supportOfdma5g2":{"type":"boolean","description":"Indicates whether the device supports OFDMA 5G2. True: support, false: unSupport."},"supportOfdma6g":{"type":"boolean","description":"Indicates whether the device supports OFDMA 6G. True: support, false: unSupport."}}},"OperationResponseApOfdmaConfigOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApOfdmaConfigOpenApiVO"}}},"ApMeshStatisticsOpenApiVO":{"type":"object","properties":{"status":{"type":"integer","description":"ap status","format":"int32"},"statusCategory":{"type":"integer","description":"ap status category","format":"int32"},"wirelessLinked":{"type":"boolean","description":"whether ap is wireless linked"},"scanStatus":{"type":"integer","description":"0-init; 1-scanning; 2-scan success; 3-fail","format":"int32"},"childAps":{"type":"array","description":"List of child aps","items":{"$ref":"#/components/schemas/ChildApOpenApiVO"}},"wirelessUplink":{"$ref":"#/components/schemas/ApWirelessUplink"},"candidateParents":{"type":"array","description":"candidate parent aps info","items":{"$ref":"#/components/schemas/CandidateParentOpenApiVO"}}}},"CandidateParentOpenApiVO":{"type":"object","properties":{"priorityStatus":{"type":"integer","description":"priority parent ap status","format":"int32"},"mac":{"type":"string","description":"candidate parent ap mac"},"name":{"type":"string","description":"candidate parent ap name"},"linkStatus":{"type":"integer","description":"0-init; 1-linking; 2-linked; 3-link fail; 4-offline","format":"int32"},"hop":{"type":"integer","description":"The number of hops to mesh with the candidate parent AP","format":"int32"},"childsnum":{"type":"integer","description":"The number of child aps already connected to the candidate parent ap","format":"int32"},"support5gMultiBand":{"type":"boolean","description":"5G support 5G1 & 5G2 multi band"},"model":{"type":"string","description":"Model"},"modelVersion":{"type":"string","description":"Model version"},"multiBandInfo":{"type":"array","description":"multi band info of candidate parent ap","items":{"$ref":"#/components/schemas/MultiBandInfoOpenApiVO"}}},"description":"Candidate parent ap info"},"ChildApOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"parent ap mac"},"name":{"type":"string","description":"parent ap name"},"rssi":{"type":"integer","description":"rssi","format":"int32"},"model":{"type":"string","description":"model"},"modelVersion":{"type":"string","description":"model version"},"ip":{"type":"string","description":"ip"},"deviceSeriesType":{"type":"integer","description":"0-advanced; 1-pro","format":"int32"},"supportSpeedTest":{"type":"boolean","description":"bridge device support speed test"},"type":{"type":"string","description":"device type"}},"description":"List of child aps"},"MultiBandInfoOpenApiVO":{"type":"object","properties":{"radioId":{"type":"integer","description":"band radio Id","format":"int32"},"channel":{"type":"integer","description":"channel","format":"int32"},"rssi":{"type":"integer","description":"rssi","format":"int32"}},"description":"mesh ap multi band info"},"OperationResponseApMeshStatisticsOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApMeshStatisticsOpenApiVO"}}},"OperationResponseApManagementSsidConfig":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApManagementSsidConfig"}}},"ApAdvancedLoadBalanceOpenApiVO":{"type":"object","properties":{"maxClientsEnable2g":{"type":"boolean","description":"Whether the device enable maximum associated clients 2g."},"maxClients2g":{"type":"integer","description":"The maximum number of clients connected to the 2G band. MaxClients2g should be within the range of 1–512.","format":"int32"},"rssiEnable2g":{"type":"boolean","description":"Whether the device enable rssi 2g."},"threshold2g":{"type":"integer","description":"The RSSI threshold for the 2G band. threshold2g should be within the range of -95–0.","format":"int32"},"maxClientsEnable5g":{"type":"boolean","description":"Whether the device enable maximum associated clients 5g."},"maxClients5g":{"type":"integer","description":"The maximum number of clients connected to the 5G band. MaxClients5g should be within the range of 1–512.","format":"int32"},"rssiEnable5g":{"type":"boolean","description":"Whether the device enable rssi 5g."},"threshold5g":{"type":"integer","description":"The RSSI threshold for the 5G band. threshold5g should be within the range of -95–0.","format":"int32"},"maxClientsEnable5g2":{"type":"boolean","description":"Whether the device enable maximum associated clients 5g2."},"maxClients5g2":{"type":"integer","description":"The maximum number of clients connected to the 5G2 band. MaxClients5g2 should be within the range of 1–512.","format":"int32"},"rssiEnable5g2":{"type":"boolean","description":"Whether the device enable rssi 5g2."},"threshold5g2":{"type":"integer","description":"The RSSI threshold for the 5G2 band. threshold5g2 should be within the range of -95–0.","format":"int32"},"maxClientsEnable6g":{"type":"boolean","description":"Whether the device enable maximum associated clients 6g."},"maxClients6g":{"type":"integer","description":"The maximum number of clients connected to the 6G band. MaxClients6g should be within the range of 1–512.","format":"int32"},"rssiEnable6g":{"type":"boolean","description":"Whether the device enable rssi 6g."},"threshold6g":{"type":"integer","description":"The RSSI threshold for the 6G band. threshold6g should be within the range of -95–0.","format":"int32"}}},"OperationResponseApAdvancedLoadBalanceOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApAdvancedLoadBalanceOpenApiVO"}}},"ApLldpConfigOpenApiVO":{"type":"object","properties":{"lldpEnable":{"type":"integer","description":"Parameter [lldpEnable] should be a value as follows: 0:off; 1:on; 2:Use Site Settings.","format":"int32"},"supportLldp":{"type":"boolean","description":"Whether the lldp function is supported."}}},"OperationResponseApLldpConfigOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApLldpConfigOpenApiVO"}}},"ApLanTraffic":{"type":"object","properties":{"lanTraffic":{"$ref":"#/components/schemas/LanTraffic"}}},"LanTraffic":{"type":"object","properties":{"rxPkts":{"type":"integer","description":"Total RX packets","format":"int64"},"txPkts":{"type":"integer","description":"Total TX packets","format":"int64"},"rx":{"type":"integer","description":"Total RX bytes, Unit: Byte","format":"int64"},"tx":{"type":"integer","description":"Total TX bytes, Unit: Byte","format":"int64"},"rxDropPkts":{"type":"integer","description":"RX dropped packets","format":"int64"},"txDropPkts":{"type":"integer","description":"TX dropped packets","format":"int64"},"rxErrPkts":{"type":"integer","description":"RX error packets","format":"int64"},"txErrPkts":{"type":"integer","description":"TX error packets","format":"int64"}},"description":"LAN traffic info"},"OperationResponseApLanTraffic":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApLanTraffic"}}},"ApL3AccessConfigOpenApiVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the EAP L3 Accessibility setting."},"supportL3Access":{"type":"boolean","description":"Whether the L3Access function is supported."}}},"OperationResponseApL3AccessConfigOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApL3AccessConfigOpenApiVO"}}},"OperationResponseApIPv6Setting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApIPv6Setting"}}},"OperationResponseApIPSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApIPSetting"}}},"CandidateParentForAdoptOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"candidate parent ap mac"},"name":{"type":"string","description":"candidate parent ap name"},"linkStatus":{"type":"integer","description":"0-init; 1-linking; 2-linked; 3-link fail; 4-offline","format":"int32"},"hop":{"type":"integer","description":"The number of hops to mesh with the candidate parent AP","format":"int32"},"childsnum":{"type":"integer","description":"The number of child aps already connected to the candidate parent ap","format":"int32"},"recommend":{"type":"boolean","description":"Whether the ap is recommended by the algorithm for connection"},"recommendRadioId":{"type":"integer","description":"The radio ID for mesh recommended by the algorithm","format":"int32"},"multiBandInfo":{"type":"array","description":"multi band info of candidate parent ap","items":{"$ref":"#/components/schemas/MultiBandInfoOpenApiVO"}}}},"GridVOCandidateParentForAdoptOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CandidateParentForAdoptOpenApiVO"}}}},"OperationResponseGridVOCandidateParentForAdoptOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOCandidateParentForAdoptOpenApiVO"}}},"OperationResponseApGeneralConfig":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApGeneralConfig"}}},"ApWifiInterferenceResult":{"type":"object","properties":{"id":{"type":"string","description":"id"},"bssid":{"type":"string","description":"bssid"},"ssid":{"type":"string","description":"ssid"},"radioId":{"type":"integer","description":"radio id","format":"int32"},"channel":{"type":"integer","description":"channel","format":"int32"},"mode":{"type":"integer","description":"phyMode","format":"int32"},"security":{"type":"integer","description":"security type. Security should be a value as follows:0: None;1: WEP;2: WPA;3: WPA2;4: WPA/WPA2;5: WPE3-OWE;6: WPA3-EnterPrise;7: WPA2-PSK/WPA3-SAE;8: WPA/WPA2-PSK;9: WPA/WPA2-EnterPrise.","format":"int32"},"beacon":{"type":"integer","description":"beacon Interval","format":"int32"},"signal":{"type":"integer","description":"Signal strength","format":"int32"},"lastSeen":{"type":"integer","description":"Last detect time.","format":"int64"},"bandWidth":{"type":"integer","description":"Band Width","format":"int32"}}},"GridVOApWifiInterferenceResult":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApWifiInterferenceResult"}}}},"OperationResponseGridVOApWifiInterferenceResult":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOApWifiInterferenceResult"}}},"ApFullChannelScanStatus":{"type":"object","properties":{"status":{"type":"integer","description":"Full channel detection status of the AP device. Status should be a value as follows: 0: In the unscanned state but the scan result is displayed;1: In the unscanned state, and there is no scan result;3: Scanning.","format":"int32"},"wifiInterfStatus":{"type":"integer","description":"Wifi interference detection status of the AP device. Status should be a value as follows: 0: In the unscanned state but the scan result is displayed;1: In the unscanned state, and there is no scan result;3: Scanning.","format":"int32"},"interfStatus":{"type":"integer","description":"Interference detection status of the AP device. Status should be a value as follows: 0: In the unscanned state but the scan result is displayed;1: In the unscanned state, and there is no scan result;3: Scanning.","format":"int32"},"channelLoadStatus":{"type":"integer","description":"Channel load detection status of the AP device. Status should be a value as follows: 0: In the unscanned state but the scan result is displayed;1: In the unscanned state, and there is no scan result;3: Scanning.","format":"int32"},"lastSeen":{"type":"integer","description":"The last time full channel detection was triggered.","format":"int64"},"fromGlobal":{"type":"boolean","description":"If the status from batch full channel detect"}}},"OperationResponseApFullChannelScanStatus":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApFullChannelScanStatus"}}},"OperationResponseApInterference":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApInterference"}}},"OperationResponseApChannelLoadResult":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApChannelLoadResult"}}},"ChannelLimitConfigOpenApiVO":{"type":"object","properties":{"supportChannelLimit":{"type":"boolean","description":"Indicates whether the device supports channel limit"},"channelLimitType":{"type":"integer","description":"Channel limit enable status. It should be a value as follows: 0: default, 1: false, 2: true.","format":"int32"},"defaultInstType5g":{"type":"boolean","description":"default mode in 5g radio. true: outdoor; false: indoor"},"defaultInstType6g":{"type":"boolean","description":"default mode in 6g radio. true: outdoor; false: indoor"}}},"OperationResponseChannelLimitConfigOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ChannelLimitConfigOpenApiVO"}}},"ApBridgeInfo":{"type":"object","properties":{"bridgeSsidName":{"type":"string","description":"Bridge SSID name. It should contain 1 to 32 UTF-8 characters."},"bridgeSsidPassword":{"type":"string","description":"Bridge SSID password. It should contain 8-63 printable ASCII characters."},"hwSwitch":{"type":"integer","description":"Bridge DIP Switch config status. 0: disable, 1: enable.","format":"int32"},"paringCode":{"type":"integer","description":"Bridge paring code.","format":"int32"},"tdmaConfig":{"$ref":"#/components/schemas/ApBridgeTdmaSettingOpenApiVO"}}},"ApBridgeNotSupportTdmaClientApOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device mac"},"name":{"type":"string","description":"Device name,default value is the mac address of device"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"}},"description":"Bridge Not Support TDMA Client AP info."},"ApBridgeTdmaClientApOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"Bridge TDMA Client AP mac."},"priority":{"type":"integer","description":"Bridge TDMA Client AP priority. 0: high, 1:base, 2:low.","format":"int32"},"name":{"type":"string","description":"Device name,default value is the mac address of device"},"model":{"type":"string","description":"Model of device,for example:EAP225"},"modelVersion":{"type":"string","description":"Model version of device,for example:3.0"}},"description":"Bridge TDMA Client AP config."},"ApBridgeTdmaSettingOpenApiVO":{"type":"object","properties":{"status":{"type":"integer","description":"Bridge TDMA Switch config status. 0: disable, 1: enable.","format":"int32"},"clients":{"type":"array","description":"Bridge TDMA Client AP config.","items":{"$ref":"#/components/schemas/ApBridgeTdmaClientApOpenApiVO"}},"notSupportTdmaClients":{"type":"array","description":"Bridge Not Support TDMA Client AP info.","items":{"$ref":"#/components/schemas/ApBridgeNotSupportTdmaClientApOpenApiVO"}}},"description":"Bridge TDMA config."},"OperationResponseApBridgeInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApBridgeInfo"}}},"ApAvailableChannelOpenApiVO":{"type":"object","properties":{"radioId":{"type":"integer","description":"(Wireless) Radio ID should be a value as follows: 0: 2.4GHz; 1: 5GHz-1; 2: 5GHz-2; 3: 6GHz.","format":"int32"},"apChannelDetailList":{"type":"array","description":"channels detail supported by device configuration.","items":{"$ref":"#/components/schemas/ApChannelDetailOpenApiVO"}}}},"ApChannelDetailOpenApiVO":{"type":"object","properties":{"channel":{"type":"integer","description":"channel value; For example, 1 in 1/2412MHz.","format":"int32"},"freq":{"type":"integer","description":"channel frequency; For example, 2412 in 1/2412MHz.","format":"int32"},"availableChannelWidthList":{"type":"array","description":"Available bandwidth list for the channel configuration; For example: [20, 40, 80, 160, 240, 320].","items":{"type":"integer","description":"Available bandwidth list for the channel configuration; For example: [20, 40, 80, 160, 240, 320].","format":"int32"}},"index":{"type":"integer","description":"channel index; For example, if channel 36 is the first channel of the device's 5 GHz frequency band, its index is 1.","format":"int32"}},"description":"channels detail supported by device configuration."},"OperationResponseListApAvailableChannelOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ApAvailableChannelOpenApiVO"}}}},"ApAnteGainConfig":{"type":"object","properties":{"anteGainList":{"type":"array","description":"Antenna gain list.","items":{"$ref":"#/components/schemas/ApRadioAnteGainConfigOpenApiVO"}}}},"ApRadioAnteGainConfigOpenApiVO":{"type":"object","properties":{"radioId":{"type":"integer","description":"The value of parameter [radioId] is between 0 and 3. 0： 2.4 GHz, 1: 5 GHz, 2: 5 GHz-2, 3: 6 GHz.","format":"int32"},"anteGain":{"type":"integer","description":"Antenna Gain. The value of parameter [anteGain] is between 0 and 30","format":"int32"}},"description":"Antenna gain list."},"OperationResponseApAnteGainConfig":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApAnteGainConfig"}}},"AntSettingVO":{"type":"object","properties":{"antMode":{"type":"integer","description":"antenna mode","format":"int32"},"antGain":{"type":"integer","description":"antenna gain","format":"int32"},"antPattern":{"type":"integer","description":"antenna pattern,0 is built-In and 1 is External.","format":"int32"},"customGainLimit":{"type":"integer","description":"custom antMode max antenna gain.","format":"int32"},"defaultOmniGain":{"type":"integer","description":"default Omni Antenna Mode gain.","format":"int32"}},"description":"Antenna Setting in radio 6g."},"ApAntSwitchConfigOpenApiVO":{"type":"object","properties":{"antMode":{"type":"integer","description":"antenna mode. 0: Auto; 1: Built-in; 2: Omni; 3:Custom","format":"int32"},"omniAntState":{"type":"integer","description":"omni antenna install state. 0: Not Installed; 1: Abnormal installation status; 2: Normal.","format":"int32"},"antSetting2g":{"$ref":"#/components/schemas/AntSettingVO"},"antSetting5g":{"$ref":"#/components/schemas/AntSettingVO"},"antSetting5g2":{"$ref":"#/components/schemas/AntSettingVO"},"antSetting6g":{"$ref":"#/components/schemas/AntSettingVO"}}},"OperationResponseApAntSwitchConfigOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApAntSwitchConfigOpenApiVO"}}},"ApAfcInfoOpenApiVO":{"type":"object","properties":{"status":{"type":"boolean","description":"Ap AFC working status"},"expirationTimeSec":{"type":"integer","description":"The expiration timestamp of the current AFC information of the AP","format":"int64"},"lastResponse":{"type":"boolean","description":"The status of the last AFC information obtained by the AP"},"lastResponseTimeSec":{"type":"integer","description":"The timestamp of the last AFC information obtained by the AP","format":"int64"},"errCode":{"type":"integer","description":"The error code of last afc status","format":"int32"},"errMain":{"type":"integer","description":"The error main reason","format":"int32"},"errDetail":{"type":"integer","description":"The error detail","format":"int32"},"processing":{"type":"boolean","description":"Whether the afc status is being retrieved"},"available6g":{"type":"boolean","description":"6G radio available status"}}},"OperationResponseApAfcInfoOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApAfcInfoOpenApiVO"}}},"AfcConfigOpenApiVO":{"type":"object","properties":{"supportAfc":{"type":"boolean","description":"Indicates whether the device supports AFC"},"enable":{"type":"boolean","description":"Whether to enable AFC"}}},"OperationResponseAfcConfigOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AfcConfigOpenApiVO"}}},"GridVOAp Brief Info":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Ap Brief Info"}}}},"OperationResponseListTrafficOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/TrafficOpenApiVO"}}}},"TrafficOpenApiVO":{"type":"object","properties":{"id":{"type":"integer","description":"Application id","format":"int32"},"name":{"type":"string","description":"Application name"},"familyId":{"type":"integer","description":"Family id","format":"int32"},"familyName":{"type":"string","description":"Family name"},"up":{"type":"integer","description":"Upload bytes used of the application","format":"int64"},"down":{"type":"integer","description":"Download bytes used of the application","format":"int64"},"traffic":{"type":"integer","description":"Total bytes used of the application","format":"int64"}}},"OperationResponseApGroupOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ApGroupOpenApiVO"}}},"GridVOSsidDeviceOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SsidDeviceOpenApiVO"}}}},"OperationResponseGridVOSsidDeviceOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOSsidDeviceOpenApiVO"}}},"GridVOInfluencingDeviceVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/InfluencingDeviceVO"}}}},"InfluencingDeviceVO":{"type":"object","properties":{"mac":{"type":"string","description":"MAC address of the device"},"deviceName":{"type":"string","description":"Display name of the device"},"deviceType":{"type":"string","description":"Device type (e.g. ap, gateway, switch)"},"model":{"type":"string","description":"Device model (e.g. EAP225)"},"modelVersion":{"type":"string","description":"Device model version (e.g. 3.0)"},"ip":{"type":"string","description":"IP address of the device"},"status":{"type":"integer","description":"Device status","format":"int32"},"health":{"type":"integer","description":"Device health score","format":"int32"}}},"OperationResponseGridVOInfluencingDeviceVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOInfluencingDeviceVO"}}},"GridVOInfluencingClientVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/InfluencingClientVO"}}}},"InfluencingClientVO":{"type":"object","properties":{"mac":{"type":"string","description":"MAC address of the client"},"clientName":{"type":"string","description":"Display name of the client"},"clientType":{"type":"string","description":"Type of the client device"},"ip":{"type":"string","description":"IP address of the client"},"manager":{"type":"boolean","description":"Whether the client is a managing host"},"active":{"type":"boolean","description":"Client status (true = connected, false = disconnected)"},"authStatus":{"type":"integer","description":"Authentication status.0: CONNECTED // Access without any authentication method.1: PENDING // Access to Portal, but authentication failed.2: AUTHORIZED // Pass through portal, pass other authentication without portal.3: AUTH-FREE // No portal authentication required.4: OFFLINE // Offline client.","format":"int32"},"health":{"type":"integer","description":"Client health score","format":"int32"},"model":{"type":"string","description":"Client model"}}},"OperationResponseGridVOInfluencingClientVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOInfluencingClientVO"}}},"ActiveIncidentCountVO":{"type":"object","properties":{"activeNum":{"type":"integer","description":"Total number of unresolved incidents.","format":"int32"}}},"AnomalyCategoryEventCountVO":{"type":"object","properties":{"anomalyCode":{"type":"string","description":"For the values of Anomaly event code, refer to section 5.7.2.1 of the Open API Access","example":"01001001"},"counts":{"type":"integer","description":"Total count of unresolved and ongoing events","format":"int32"},"totalCounts":{"type":"integer","description":"Total count of events in all status","format":"int32"},"currentStatusCounts":{"type":"integer","description":"Count of events in the current status","format":"int32"},"influencingDevices":{"type":"integer","description":"Number of influenced devices","format":"int32"},"influencingClients":{"type":"integer","description":"Number of influenced clients","format":"int32"},"level":{"type":"integer","description":"Level of this incident","format":"int32"}},"description":"Anomaly category event count information"},"OperationResponseOverviewStatisticsOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OverviewStatisticsOpenApiVO"}}},"OverviewStatisticsOpenApiVO":{"type":"object","properties":{"allStatus":{"type":"integer","description":"Total incident count across all statuses","format":"int32","example":20},"ongoing":{"type":"integer","description":"Number of ongoing incidents","format":"int32","example":5},"resolved":{"type":"integer","description":"Number of resolved incidents","format":"int32","example":15},"ignored":{"type":"integer","description":"Number of ignored incidents","format":"int32","example":0},"unresolved":{"type":"integer","description":"Number of unresolved incidents","format":"int32","example":0},"all":{"type":"integer","description":"Total incident count across all categories","format":"int32","example":20},"security":{"type":"integer","description":"Number of security incidents (category code 19)","format":"int32","example":5},"deviceStatus":{"type":"integer","description":"Number of device status incidents (category code 18)","format":"int32","example":3},"wanAndServices":{"type":"integer","description":"Number of WAN and services incidents (category code 17)","format":"int32","example":7},"link":{"type":"integer","description":"Number of link incidents (category code 16)","format":"int32","example":2},"wiredNetwork":{"type":"integer","description":"Number of wired network incidents (category code 15)","format":"int32","example":4},"wirelessNetwork":{"type":"integer","description":"Number of wireless network incidents (category code 14)","format":"int32","example":6},"roaming":{"type":"integer","description":"Number of roaming incidents (category code 13)","format":"int32","example":1},"authentication":{"type":"integer","description":"Number of authentication incidents (category code 12)","format":"int32","example":8},"access":{"type":"integer","description":"Number of access incidents (category code 11)","format":"int32","example":9},"allLevel":{"type":"integer","description":"Total incident count across all levels","format":"int32","example":20},"critical":{"type":"integer","description":"Number of critical-level incidents","format":"int32","example":2},"error":{"type":"integer","description":"Number of error-level incidents","format":"int32","example":5},"warning":{"type":"integer","description":"Number of warning-level incidents","format":"int32","example":10},"info":{"type":"integer","description":"Number of info-level incidents","format":"int32","example":3},"others":{"type":"integer","description":"Deprecated events since v6.3","format":"int32","example":2},"anomalyCategoryEventCounts":{"type":"array","description":"Anomaly-code level event count information","items":{"$ref":"#/components/schemas/AnomalyCategoryEventCountVO"}}}},"IncidentCountOpenApiVO":{"type":"object","properties":{"critical":{"type":"integer","description":"Number of critical incidents in this time bucket","format":"int32"},"error":{"type":"integer","description":"Number of error incidents in this time bucket","format":"int32"},"warning":{"type":"integer","description":"Number of warning incidents in this time bucket","format":"int32"},"info":{"type":"integer","description":"Number of info incidents in this time bucket","format":"int32"},"access":{"type":"integer","description":"Number of access incidents in this time bucket","format":"int32"},"authentication":{"type":"integer","description":"Number of authentication incidents in this time bucket","format":"int32"},"roaming":{"type":"integer","description":"Number of roaming incidents in this time bucket","format":"int32"},"wirelessNetwork":{"type":"integer","description":"Number of wireless network incidents in this time bucket","format":"int32"},"wiredNetwork":{"type":"integer","description":"Number of wired network incidents in this time bucket","format":"int32"},"link":{"type":"integer","description":"Number of link incidents in this time bucket","format":"int32"},"wanAndServices":{"type":"integer","description":"Number of WAN and services incidents in this time bucket","format":"int32"},"deviceStatus":{"type":"integer","description":"Number of device status incidents in this time bucket","format":"int32"},"security":{"type":"integer","description":"Number of security incidents in this time bucket","format":"int32"},"all":{"type":"integer","description":"Total incident count across all levels in this time bucket","format":"int32"},"time":{"type":"integer","description":"Timestamp in seconds representing this time bucket","format":"int64"}},"description":"List of incident count items grouped by severity level (critical/error/warning/info) and by function type (category)"},"IncidentDistributionOpenApiVO":{"type":"object","properties":{"incidentCounts":{"type":"array","description":"List of incident count items grouped by severity level (critical/error/warning/info) and by function type (category)","items":{"$ref":"#/components/schemas/IncidentCountOpenApiVO"}}}},"OperationResponseIncidentDistributionOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/IncidentDistributionOpenApiVO"}}},"AnomalyVO":{"type":"object","properties":{"incidentId":{"type":"string"},"anomalyCode":{"type":"string","description":"For the values of Anomaly event code, refer to section 5.7.2.1 of the Open API Access","example":"01001001"},"category":{"type":"integer","description":"Anomaly category. 11: Network, 12: Device, 13: Client, etc.","format":"int32"},"level":{"type":"integer","description":"Event severity level. 0: Critical, 1: Error, 2: Warning, 3: Info.","format":"int32"},"objectType":{"type":"string","description":"Object type of the anomaly target: gateway, switch, ap, wiredClient, wirelessClient."},"object":{"type":"array","description":"List of device/client names where the anomaly occurred.","items":{"type":"string","description":"List of device/client names where the anomaly occurred."}},"status":{"type":"integer","description":"Event status. 0: Unresolved, 1: Resolved, 2: Ignored.","format":"int32"},"time":{"type":"integer","description":"Event creation time in milliseconds (Unix timestamp).","format":"int64"},"startTime":{"type":"integer","description":"Continuous event start time in milliseconds (Unix timestamp).","format":"int64"},"endTime":{"type":"integer","description":"Continuous event end time in milliseconds (Unix timestamp).","format":"int64"},"titleParams":{"type":"object","additionalProperties":{"type":"string","description":"Title parameter map for rendering the event title template."},"description":"Title parameter map for rendering the event title template."},"contentParams":{"type":"object","additionalProperties":{"type":"string","description":"Content parameter map for rendering the event content template."},"description":"Content parameter map for rendering the event content template."},"detail":{"type":"object","additionalProperties":{"type":"object","description":"Detailed chart data for the event content display (line chart, timeline, list, bar chart, protocol replay, port POE, etc.)."},"description":"Detailed chart data for the event content display (line chart, timeline, list, bar chart, protocol replay, port POE, etc.)."},"devices":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DeviceObjectDTO"},"description":"Device objects map. Key is MAC address, value is device info."},"clients":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ClientObjectDTO"},"description":"Client objects map. Key is MAC address, value is client info."},"impactedDevices":{"uniqueItems":true,"type":"array","description":"Set of MAC addresses of all devices impacted by this incident.","items":{"type":"string","description":"Set of MAC addresses of all devices impacted by this incident."}},"impactedClients":{"uniqueItems":true,"type":"array","description":"Set of MAC addresses of all clients impacted by this incident.","items":{"type":"string","description":"Set of MAC addresses of all clients impacted by this incident."}},"causes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/AnomalyCauseVO"},"description":"Root causes map. Key is cause code, value is cause detail."}}},"OperationResponseAnomalyVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AnomalyVO"}}},"OperationResponseListAnomalyCategoryEventCountVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/AnomalyCategoryEventCountVO"}}}},"CheckFirmwareRes":{"type":"object","properties":{"finished":{"type":"boolean","description":"Whether the task is complete"},"apMacList":{"type":"array","description":"List of the ap MAC address with firmware updates. E.g. AA-BB-CC-DD-11-22","items":{"type":"string","description":"List of the ap MAC address with firmware updates. E.g. AA-BB-CC-DD-11-22"}},"switchMacList":{"type":"array","description":"List of switch MAC address with firmware updates. E.g. AA-BB-CC-DD-11-22","items":{"type":"string","description":"List of switch MAC address with firmware updates. E.g. AA-BB-CC-DD-11-22"}},"gatewayMacList":{"type":"array","description":"List of gateway MAC address with firmware updates. E.g. AA-BB-CC-DD-11-22","items":{"type":"string","description":"List of gateway MAC address with firmware updates. E.g. AA-BB-CC-DD-11-22"}}}},"OperationResponseCheckFirmwareRes":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CheckFirmwareRes"}}},"GridVOSwitchACLInfo":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SwitchACLInfo"}}}},"OperationResponseGridVOSwitchACLInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOSwitchACLInfo"}}},"SwitchACLInfo":{"required":["bindingType","description","destinationIds","destinationType","etherType","id","index","policy","protocols","sourceIds","sourceType","status"],"type":"object","properties":{"id":{"type":"string","description":"ACL ID"},"index":{"type":"integer","description":"Index","format":"int32"},"description":{"pattern":"^[^ ]$|^[^ ].{0,510}[^ ]$","type":"string","description":"ACL rule description, description should contain 1 to 512 characters."},"status":{"type":"boolean","description":"Status should be a value as follows: 0: disable; 1: enable"},"policy":{"type":"integer","description":"Policy should be a value as follows: 0: drop; 1: allow;","format":"int32"},"protocols":{"type":"array","description":"For the values of protocols, refer to section 5.5 of the Open API Access Guide.","items":{"type":"integer","description":"For the values of protocols, refer to section 5.5 of the Open API Access Guide.","format":"int32"}},"sourceIds":{"type":"array","description":"Source IDs, which depends on sourceType, for example: if sourceType is network, sourceIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Source IDs, which depends on sourceType, for example: if sourceType is network, sourceIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."}},"destinationIds":{"type":"array","description":"Destination IDs, which depends on destinationType, for example: if destinationType is network, destinationIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface.","items":{"type":"string","description":"Destination IDs, which depends on destinationType, for example: if destinationType is network, destinationIds should be LAN network ID. LAN Network can be created using 'Create LAN network' interface, and LAN Network ID can be obtained from 'Get LAN network list' interface."}},"sourceType":{"type":"integer","description":"SourceType should be a value as follows: 0: network; 1: IP Group; 2: IP-Port Group; 4: SSID; 6: IPv6 Group; 7: IPv6-Port Group","format":"int32"},"destinationType":{"type":"integer","description":"DestinationType should be a value as follows: 0: network; 1: IP Group; 2: IP-Port Group; 6: IPv6 Group; 7: IPv6-Port Group","format":"int32"},"bindingType":{"type":"integer","description":"BindingType should be a value as follows: 0: all ports; 1: custom ports; 2: all switch vlan; 3: custom switch vlan","format":"int32"},"customAclPorts":{"type":"array","description":"Only for bindingType is custom ports, select the custom port or LAG of the device","items":{"$ref":"#/components/schemas/Switch ACL port entity"}},"networkId":{"type":"string","description":"Only for bindingType VLAN"},"bindingBridgeVlan":{"type":"integer","description":"Only for bindingType VLAN and network of bridge VLAN","format":"int32"},"customAclOsws":{"type":"array","description":"Only for bindingType is custom switch vlan, list of selected switch mac","items":{"type":"string","description":"Only for bindingType is custom switch vlan, list of selected switch mac"}},"customAclStacks":{"type":"array","description":"Only for bindingType is custom switch vlan, list of selected stack id","items":{"type":"string","description":"Only for bindingType is custom switch vlan, list of selected stack id"}},"customAclDevices":{"type":"array","description":"Only for bindingType is custom switch vlan, list of selected device","items":{"$ref":"#/components/schemas/CustomAclOswOpenApiVO"}},"etherType":{"$ref":"#/components/schemas/Switch ACL ether type entity"},"timeRangeId":{"type":"string","description":"Time range profile ID"}}},"OperationResponseSiteOverrideResultOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SiteOverrideResultOpenApiVO"}}},"SiteOverrideOpenApiVO":{"type":"object","properties":{"siteId":{"type":"string","description":"site id"},"overrides":{"uniqueItems":true,"type":"array","description":"override module","items":{"type":"string","description":"override module"}}},"description":"sites with override module"},"SiteOverrideResultOpenApiVO":{"type":"object","properties":{"sites":{"type":"array","description":"sites with override module","items":{"$ref":"#/components/schemas/SiteOverrideOpenApiVO"}}}},"ClassificationOpenApiVO":{"type":"object","properties":{"classification":{"type":"string","description":"Classification."},"attempts":{"type":"integer","description":"Attempts.","format":"int64"}},"description":"Classification List."},"GeoOpenApiVO":{"type":"object","properties":{"country":{"type":"string","description":"Country code."},"attempts":{"type":"integer","description":"Attempts.","format":"int64"},"source":{"type":"string","description":"Source Ip, shown as Multiple when there are more than one ip."}},"description":"Geo List."},"OperationResponseTop5ThreatNumOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Top5ThreatNumOpenApiVO"}}},"Top5ThreatNumOpenApiVO":{"type":"object","properties":{"geo":{"type":"array","description":"Geo List.","items":{"$ref":"#/components/schemas/GeoOpenApiVO"}},"classification":{"type":"array","description":"Classification List.","items":{"$ref":"#/components/schemas/ClassificationOpenApiVO"}}}},"OperationResponseThreatSeverityOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ThreatSeverityOpenApiVO"}}},"ThreatSeverityOpenApiVO":{"type":"object","properties":{"critical":{"type":"integer","description":"0：Critical, 1：Major, 2：Moderate 3：Minor 4:Low.","format":"int64"},"major":{"type":"integer","description":"Major.","format":"int64"},"moderate":{"type":"integer","description":"Moderate.","format":"int64"},"minor":{"type":"integer","description":"Minor.","format":"int64"},"low":{"type":"integer","description":"Low.","format":"int64"}}},"GridVOSdWanGroupDetail":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SdWanGroupDetail"}}}},"OperationResponseGridVOSdWanGroupDetail":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOSdWanGroupDetail"}}},"SdWanGroupDetail":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the SD-WAN group"},"name":{"type":"string","description":"The name of the SD-WAN group"},"description":{"type":"string","description":"The description of the SD-WAN group"},"ipPoolStart":{"type":"string","description":"The start of the IP pool of the SD-WAN group","deprecated":true},"ipPoolEnd":{"type":"string","description":"The end of the IP pool of the SD-WAN group","deprecated":true},"memberList":{"type":"array","description":"A list of members of the SD-WAN group","items":{"$ref":"#/components/schemas/SdWanMemberInfo"}},"linkedSpokes":{"type":"array","description":"A list of linked-spokes of the SD-WAN group","items":{"$ref":"#/components/schemas/SdWanLinkedSpoke"}},"enableNat":{"type":"boolean","description":"Whether the group enable SD-WAN virtual network Map"},"natInfo":{"$ref":"#/components/schemas/SdWanNatInfo"}}},"SdWanLinkedSpoke":{"type":"object","properties":{"deviceMac1":{"type":"string","description":"The device MAC of one of the two linked-spokes"},"deviceMac2":{"type":"string","description":"Another device MAC of the two linked-spokes"},"status":{"type":"integer","description":"The connection status of SD-WAN tunnel between spokes","format":"int32"}},"description":"A list of linked-spokes of the SD-WAN group"},"SdWanMemberInfo":{"type":"object","properties":{"role":{"type":"integer","description":"The role of sdWan member, hub or spoke.","format":"int32"},"deviceMac":{"type":"string","description":"The device MAC of the sdWan member."},"deviceName":{"type":"string","description":"The device name of the sdWan member."},"onlineStatus":{"type":"integer","description":"The device online status of the sdWan member.","format":"int32"},"type":{"type":"string","description":"The device type of the sdWan member."},"model":{"type":"string","description":"The device model of the sdWan member."},"modelVersion":{"type":"string","description":"The device model version of the sdWan member."},"showModel":{"type":"string","description":"The device showmodel of the sdWan member."},"siteId":{"type":"string","description":"The ID of the site where the sdWan member is located."},"siteName":{"type":"string","description":"The name of the site where the sdWan member is located."},"region":{"type":"string","description":"The region where the site is located."},"longitude":{"type":"number","description":"The map longitude of the site.","format":"double"},"latitude":{"type":"number","description":"The map latitude of the site.","format":"double"},"regionLongitude":{"type":"number","description":"The region longitude of the site.","format":"double"},"regionLatitude":{"type":"number","description":"The region latitude of the site.","format":"double"},"unplaced":{"type":"boolean","description":"Whether the site is placed on the map."},"address":{"type":"string","description":"The address where the site is located."},"wanPortsInfo":{"type":"array","description":"A list of device port status info for SdWan Member.","items":{"$ref":"#/components/schemas/OsgPortStatBrief"}},"lanNetworkInfo":{"type":"array","description":"A list of lan network info for SdWan Member.","items":{"$ref":"#/components/schemas/LanNetworkBrief"}},"publicIp":{"type":"boolean","description":"Whether the sdWan member has a public IP."},"sdWanIp":{"type":"string","description":"The sdWan IP of the sdWan member."},"linkedToHub":{"type":"integer","description":"If a member is a spoke, the link connection to the hub is identified.","format":"int32"},"supportSdWanNat":{"type":"boolean","description":"Whether the device support SD-WAN NAT."}},"description":"A list of members of the SD-WAN group"},"SdWanNatInfo":{"type":"object","properties":{"defaultMapNetworkList":{"type":"array","description":"A list of the default mapping network","items":{"type":"string","description":"A list of the default mapping network"}},"customMapNetworkList":{"type":"array","description":"A list of the customized mapping network","items":{"type":"string","description":"A list of the customized mapping network"}},"networkMapList":{"type":"array","description":"A list of the network map item","items":{"$ref":"#/components/schemas/SdWanNetworkMap"}}},"description":"The NAT info of the SD-WAN group"},"OperationResponseSdWanGroupDetail":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SdWanGroupDetail"}}},"OperationResponseSdWanGroupTunnelStatus":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SdWanGroupTunnelStatus"}}},"SdWanGroupTunnelStatus":{"type":"object","properties":{"firstCheck":{"type":"boolean","description":"Whether the first check has been completed."},"linkedSpokes":{"type":"array","description":"A list of hub-spokes of the sdWan group","items":{"$ref":"#/components/schemas/SdWanLinksToHub"}}}},"SdWanLinksToHub":{"type":"object","properties":{"deviceMac":{"type":"string","description":"The device MAC of the sdWan member."},"type":{"type":"string","description":"The device type of a SD-WAN candidate device."},"model":{"type":"string","description":"The model of a SD-WAN candidate device."},"modelVersion":{"type":"string","description":"The model version of a SD-WAN candidate device."},"linkedToHub":{"type":"integer","description":"If a member is a spoke, the link connection to the hub is identified.","format":"int32"},"onlineStatus":{"type":"integer","description":"The device online status of the sdWan member.","format":"int32"}},"description":"A list of hub-spokes of the sdWan group"},"OperationResponseSdWanCurrentSelectedDeviceInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SdWanCurrentSelectedDeviceInfo"}}},"SdWanCurrentSelectedDeviceInfo":{"type":"object","properties":{"port":{"type":"array","description":"The port sequence number of the device.","items":{"$ref":"#/components/schemas/SdWanCandidateDevice"}}}},"GridVOSdWanGroupBrief":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/SdWanGroupBrief"}}}},"OperationResponseGridVOSdWanGroupBrief":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOSdWanGroupBrief"}}},"SdWanGroupBrief":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the SD-WAN group"},"name":{"type":"string","description":"The name of the SD-WAN group"},"hubDeviceType":{"type":"string","description":"The type of the hub device of this SD-WAN group"},"hubModel":{"type":"string","description":"The model of the hub device of this SD-WAN group"},"hubModelVersion":{"type":"string","description":"The model version of the hub device of this SD-WAN group"},"deviceNum":{"type":"integer","description":"The number of device in this SD-WAN group","format":"int32"}}},"OperationResponseSetScenarioDifferenceVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/ScenarioDifferenceVO"}}}},"ScenarioDifferenceVO":{"type":"object","properties":{"name":{"type":"string","description":"Scenario name should contain 1 to 128 visible ASCII characters."},"isDefault":{"type":"boolean","description":"Identify whether the current scene is the default scenario."}}},"ControllerRoleDetailVO":{"type":"object","properties":{"id":{"type":"string","description":"Role ID"},"name":{"type":"string","description":"Role Name"},"type":{"type":"integer","description":"Role Type should be a value as follows: 0: standard; 1: customer; 2: msp.","format":"int32"},"defaultRole":{"type":"boolean","description":"Whether role is default role"},"source":{"type":"integer","description":"Role created resource. It should be a value as follows: 0: default; 1:create by standard controller or customer controller; 2: create by MSP","format":"int32"},"privilege":{"$ref":"#/components/schemas/ControllerRoleVO"}}},"OperationResponseListControllerRoleDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/ControllerRoleDetailVO"}}}},"OperationResponseControllerRoleDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ControllerRoleDetailVO"}}},"OperationResponseListRoleBriefVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/RoleBriefVO"}}}},"RoleBriefVO":{"type":"object","properties":{"id":{"type":"string","description":"Role ID"},"name":{"type":"string","description":"Role Name"},"type":{"type":"integer","description":"Role Type should be a value as follows: 0: standard; 1: customer; 2: msp.","format":"int32"},"defaultRole":{"type":"boolean","description":"Whether role is default role"},"source":{"type":"integer","description":"Role created resource. It should be a value as follows: 0: default; 1:create by standard controller or customer controller; 2: create by MSP","format":"int32"}}},"OperationResponseHistory Retention":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/History Retention"}}},"OperationResponsePrivacy Policy":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Privacy Policy"}}},"Privacy Policy":{"required":["status"],"type":"object","properties":{"status":{"type":"integer","description":"Status should be a value as follows: 0: disable; 1: enable","format":"int32"}}},"OperationResponseListPlaced Site":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/placed site"}}}},"placed site":{"type":"object","properties":{"id":{"type":"string","description":"site id"},"region":{"type":"string","description":"site region"},"name":{"type":"string","description":"site name"},"longitude":{"type":"number","description":"site longitude","format":"double"},"latitude":{"type":"number","description":"site latitude","format":"double"},"address":{"type":"string","description":"site address"}}},"RestoreResultVO":{"type":"object","properties":{"status":{"type":"integer","description":"Status should be a value as follows: 0: restore finished; 1: restore prepared; 2: restore running; 3: restore failed","format":"int32"}}},"FailedDeviceUpgradeFirmwareInfo":{"type":"object","properties":{"firmwareStatus":{"type":"integer","description":"Target firmware status. 0: normal. 1: The target firmware has been removed/deleted.","format":"int32"}}},"OperationResponseFailedDeviceUpgradeFirmwareInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/FailedDeviceUpgradeFirmwareInfo"}}},"GridVOUpgradeFailedDeviceInfo":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UpgradeFailedDeviceInfo"}}}},"OperationResponseGridVOUpgradeFailedDeviceInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOUpgradeFailedDeviceInfo"}}},"UpgradeFailedDeviceInfo":{"type":"object","properties":{"modelTypeInfo":{"$ref":"#/components/schemas/ModelTypeInfoOpenApiVO"},"deviceName":{"type":"string","description":"Name of the device which failed to upgrade."},"mac":{"type":"string","description":"Mac address of device which upgrade failed."},"currentVersion":{"type":"string","description":"The current firmware version of the device which upgrade failed."},"siteName":{"type":"string","description":"The siteName of the device which upgrade failed."},"type":{"type":"string","description":"Device type should be a value as follows: gateway, switch, ap."}}},"LicenseBindAvailableNumOpenApiVO":{"type":"object","properties":{"trial":{"type":"integer","description":"trial license num","format":"int32"},"others":{"type":"integer","description":"Used license num","format":"int32"},"permanent":{"type":"integer","format":"int32"},"1year":{"type":"integer","description":"1year license num","format":"int32"},"2years":{"type":"integer","description":"2years license num","format":"int32"},"3years":{"type":"integer","description":"3years license num","format":"int32"},"4years":{"type":"integer","description":"4years license num","format":"int32"},"5years":{"type":"integer","description":"5years license num","format":"int32"},"7years":{"type":"integer","description":"7years license num","format":"int32"},"1month":{"type":"integer","description":"1month license num","format":"int32"}}},"OperationResponseLicenseAutoActiveOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/LicenseAutoActiveOpenApiVO"}}},"OperationResponseListRateLimitProfileVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/RateLimitProfileVO"}}}},"RateLimitProfileVO":{"required":["downLimitEnable","name","upLimitEnable"],"type":"object","properties":{"id":{"type":"string","description":"Rate limit profile id."},"name":{"pattern":"^[^ ]$|^[^ ].{0,62}[^ ]$","type":"string","description":"Rate limit profile name."},"site":{"type":"string","description":"Site ID"},"downLimitEnable":{"type":"boolean","description":"Down limit enable."},"downLimit":{"type":"integer","description":"Down limit. Unit is Kbps, integer from 1 to 10485760.","format":"int64"},"upLimitEnable":{"type":"boolean","description":"Up limit enable."},"upLimit":{"type":"integer","description":"Up limit. Unit is Kbps, integer from 1 to 10485760.","format":"int64"},"isDefault":{"type":"boolean","description":"Whether it is default profile."},"resource":{"type":"integer","format":"int32"}}},"GridVOGateway Infos":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/gateway infos"}}}},"OperationResponseGridVOGateway Infos":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOGateway Infos"}}},"gateway infos":{"type":"object","properties":{"siteId":{"type":"string","description":"site id."},"deviceMac":{"type":"string","description":"device mac."},"uptime":{"type":"string","description":"up time."},"wanStatus":{"type":"array","description":"wan status infos.","items":{"$ref":"#/components/schemas/gateway wan status"}}}},"gateway wan status":{"type":"object","properties":{"port":{"type":"integer","description":"Port serial number","format":"int32"},"name":{"type":"string","description":"Port name"},"type":{"type":"integer","description":"Port type, 0:WAN,1:WAN/LAN,2:LAN,3:SFP WAN;","format":"int32"},"physicalType":{"type":"integer","description":"SFP port type, 0:normal,1:SFP,2:SFP+;","format":"int32"},"mode":{"type":"integer","description":"Port mode, 0:WAN,1:LAN;","format":"int32"},"status":{"type":"integer","description":"Port status should be a value as follows: 0: disconnected; 1: connected","format":"int32"},"internetState":{"type":"integer","description":"Wan internet state should be a value as follows: 0: disconnected; 1: connected","format":"int32"},"ip":{"type":"string","description":"WAN ip address."},"onlineDetection":{"type":"integer","description":"online status, 0-offline, 1-online","format":"int32"},"ip2":{"type":"string","description":"Secondary ip address."},"speed":{"type":"integer","description":"Port speed, 1-10M，2-100M，3-1000M","format":"int32"},"duplex":{"type":"integer","description":"Port duplex, 1-Half，2-Full","format":"int32"},"rx":{"type":"integer","description":"Port total rx bytes","format":"int64"},"rxPkt":{"type":"integer","description":"Port total rx packets","format":"int64"},"rxPktRate":{"type":"integer","description":"Port rx Packet rate, Unit: Pkt/s;","format":"int64"},"rxRate":{"type":"integer","description":"Port rx rate, Unit: KB/s;","format":"int64"},"tx":{"type":"integer","description":"Port total tx bytes","format":"int64"},"txPkt":{"type":"integer","description":"Port total tx packets","format":"int64"},"txPktRate":{"type":"integer","description":"Port tx packet rate, Unit: Pkt/s;","format":"int64"},"txRate":{"type":"integer","description":"Port tx rate, Unit: KB/s;","format":"int64"},"proto":{"type":"string","description":"Wan ipv4 proto type, use static，dhcp，pppoe，l2tp，pptp."},"healthLevel":{"type":"integer","description":"Wan health level. 0-GOOD, 1-FAIR, 2-POOR, 3-NO_DATA, 4-OFFLINE, 5-DISABLE, 6-ONLINE","format":"int32"},"latency":{"type":"integer","description":"Wan latency, when mode is wan and device is connected, Unit: ms","format":"int32"},"loss":{"type":"number","description":"Wan packet loss rate, Unit : %","format":"double"},"rxErrorPkts":{"type":"integer","description":"rx error pkts.","format":"int64"},"txErrorPkts":{"type":"integer","description":"tx error pkts.","format":"int64"}},"description":"wan status infos."},"OperationResponseRemote Log":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Remote Log"}}},"CustomerRemoteLogTipOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the feature"},"host":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"The IP address of the remote log server"},"port":{"type":"integer","description":"Port of the remote log server, port should be within the range of 1-65535","format":"int32"}}},"OperationResponseCustomerRemoteLogTipOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CustomerRemoteLogTipOpenApiVO"}}},"Built In RADIUS Server Setting Result":{"required":["authServerPort","enable","secret","serverAddressType","tunnelReplyEnable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the Built-In RADIUS server is enabled."},"authServerPort":{"type":"integer","description":"Server port.","format":"int32"},"secret":{"type":"string","description":"Server secrect."},"tunnelReplyEnable":{"type":"boolean","description":"Whether the Tunneled Reply is enabled."},"status":{"type":"boolean","description":"Built-In RADIUS server real running status."},"failReason":{"type":"string","description":"Startup failed reason, required when parameter [status] is false."},"serverAddressType":{"type":"integer","description":"Built In RADIUS server address type, 0: Auto generated, 1: Custom","format":"int32"},"customAddress":{"type":"string","description":"Customize server address, required when parameter [serverAddressType] is 1."},"radiusServerCertificate":{"$ref":"#/components/schemas/RADIUS Server Certificate Setting"},"requireMessageAuthenticator":{"type":"boolean","description":"Message-Authenticator parameter verification enable status"},"limitProxyState":{"type":"boolean","description":"Proxy-State parameter limit status"}}},"OperationResponseBuilt In RADIUS Server Setting Result":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Built In RADIUS Server Setting Result"}}},"OperationResponseRadius Proxy Server Setting Result":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Radius Proxy Server Setting Result"}}},"Radius Proxy Server Setting Result":{"required":["enable","port"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the RADIUS proxy server is enabled."},"port":{"type":"integer","description":"Server port.","format":"int32"},"status":{"type":"boolean","description":"RADIUS proxy server real running status."},"failReason":{"type":"string","description":"Startup failed reason, required when parameter [status] is false."},"requireMessageAuthenticator":{"type":"boolean","description":"Message-Authenticator parameter verification enable status"},"limitProxyState":{"type":"boolean","description":"Proxy-State parameter limit status"}}},"OperationResponseGeneral Setting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/General Setting"}}},"OperationResponseExperience Improvement Program":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Experience Improvement Program"}}},"DeviceGlobalSearchSummary":{"type":"object","properties":{"mac":{"type":"string"},"active":{"type":"boolean"},"status":{"type":"integer","format":"int32"},"statusCategory":{"type":"integer","format":"int32"},"fwDownload":{"type":"boolean"},"needUpgrade":{"type":"boolean"},"name":{"type":"string"},"site":{"type":"string"},"model":{"type":"string"},"modelVersion":{"type":"string"},"type":{"type":"string"},"addedInAdvance":{"type":"boolean"}},"description":"device list result"},"GlobalSearchResultOpenApiVO":{"type":"object","properties":{"siteNames":{"type":"object","additionalProperties":{"type":"string","description":"site name"},"description":"site name"},"devices":{"type":"array","description":"device list result","items":{"$ref":"#/components/schemas/DeviceGlobalSearchSummary"}}}},"OperationResponseGlobalSearchResultOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GlobalSearchResultOpenApiVO"}}},"DeviceStatOpenApiVO":{"type":"object","properties":{"ecspV1Num":{"type":"integer","description":"The Number of device using Ecsp version 1.","format":"int32"},"upgradeEcspV1Num":{"type":"integer","description":"The Number of upgradable device using Ecsp version 1.","format":"int32"}},"description":"Device statistics of upgradeable device."},"OperationResponseUpgradeableDevicesStat":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/upgradeableDevicesStat"}}},"upgradeableDevicesStat":{"type":"object","properties":{"deviceStat":{"$ref":"#/components/schemas/DeviceStatOpenApiVO"}}},"GlobalUnknownDeviceOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device MAC"},"name":{"type":"string","description":"Device name"},"type":{"type":"string","description":"Device type"},"subtype":{"type":"string","description":"Switch subtype should be a value as follows: smart: Non-Agile Series Switch; es: Agile Series Switch."},"deviceSeriesType":{"type":"integer","description":"Device series type. 0 means basic, 1 means pro.","format":"int32"},"model":{"type":"string","description":"Device model name"},"ip":{"type":"string","description":"Device IP"},"uptime":{"type":"string","description":"Device uptime"},"status":{"type":"integer","description":"Device status should be a value as follows: 0: Disconnected; 1: Connected; 2: Pending; 3: Heartbeat Missed; 4: Isolated","format":"int32"},"lastSeen":{"type":"integer","description":"Device lastSeen, unit: ms","format":"int64"}}},"GridVOGlobalUnknownDeviceOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GlobalUnknownDeviceOpenApiVO"}}}},"OperationResponseGridVOGlobalUnknownDeviceOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOGlobalUnknownDeviceOpenApiVO"}}},"GlobalDeviceStatOpenApiVO":{"type":"object","properties":{"switchHealth":{"$ref":"#/components/schemas/HealthStatOpenApiVO"},"eapHealth":{"$ref":"#/components/schemas/HealthStatOpenApiVO"},"allDevices":{"type":"integer","description":"the number of all devices","format":"int32"},"allSwitchsAndGateway":{"type":"integer","description":"the number of switchs and gateway","format":"int32"},"allAps":{"type":"integer","description":"eap health stat","format":"int32"},"allOlts":{"type":"integer","description":"eap health stat","format":"int32"},"mesh":{"type":"integer","description":"device mesh","format":"int32"},"config":{"type":"integer","description":"device config","format":"int32"},"performance":{"type":"integer","description":"device performance","format":"int32"},"unActivated":{"type":"integer","description":"device unActivated","format":"int32"},"activated":{"type":"integer","description":"device activated","format":"int32"},"expired":{"type":"integer","description":"device expired","format":"int32"},"good":{"type":"integer","description":"device health stat is good","format":"int32"},"fair":{"type":"integer","description":"device health stat is fair","format":"int32"},"poor":{"type":"integer","description":"device health stat is poor","format":"int32"},"noData":{"type":"integer","description":"no health stat data","format":"int32"},"gatewayHealth":{"$ref":"#/components/schemas/HealthStatOpenApiVO"}}},"HealthStatOpenApiVO":{"type":"object","properties":{"good":{"type":"integer","description":"device health stat is good","format":"int32"},"fair":{"type":"integer","description":"device health stat is fair","format":"int32"},"poor":{"type":"integer","description":"device health stat is poor","format":"int32"},"noData":{"type":"integer","description":"no health stat data","format":"int32"}},"description":"the health stat of gateway"},"OperationResponseGlobalDeviceStatOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GlobalDeviceStatOpenApiVO"}}},"GlobalKnownDeviceOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device MAC"},"name":{"type":"string","description":"Device name"},"type":{"type":"string","description":"Device type"},"subtype":{"type":"string","description":"Switch subtype should be a value as follows: smart: Non-Agile Series Switch; es: Agile Series Switch."},"deviceSeriesType":{"type":"integer","description":"Device series type. 0 means basic, 1 means pro.","format":"int32"},"model":{"type":"string","description":"Device model name"},"ip":{"type":"string","description":"Device IP"},"ipv6":{"type":"array","description":"Device IPv6 list","items":{"type":"string","description":"Device IPv6 list"}},"uptime":{"type":"string","description":"Device uptime"},"status":{"type":"integer","description":"Device status should be a value as follows: 0: Disconnected; 1: Connected; 2: Pending; 3: Heartbeat Missed; 4: Isolated","format":"int32"},"lastSeen":{"type":"integer","description":"Device lastSeen","format":"int64"},"cpuUtil":{"type":"integer","description":"Device cpuUtil","format":"int32"},"memUtil":{"type":"integer","description":"Device memUtil","format":"int32"},"sn":{"type":"string","description":"Device serial number"},"licenseStatus":{"type":"integer","description":"Device license status(Only for cloud base) should be a value as follows: 0: unActive; 1: Unbind; 2: Expired; 3: active","format":"int32"},"needActive":{"type":"boolean","description":"Device license status(Only for cloud base).If the value is true, the device is ready to be activated;If the value is false, the device cannot be activated or has already been activated."},"siteName":{"type":"string","description":"The name of the site where the device is located"},"tagName":{"type":"string","description":"Device tag name"}}},"GridVOGlobalKnownDeviceOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/GlobalKnownDeviceOpenApiVO"}}}},"OperationResponseGridVOGlobalKnownDeviceOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOGlobalKnownDeviceOpenApiVO"}}},"BriefDeviceInfoDetailForBatchAdoptOpenApiVO":{"type":"object","properties":{"type":{"type":"string","description":"device type"},"mac":{"type":"string","description":"device mac"},"name":{"type":"string","description":"device name"},"model":{"type":"string","description":"device model"},"licenseStatus":{"type":"integer","description":"license status. 0 means unactive; 1 means unbind; 2 means expired; 3 means active; 4 means incompatible","format":"int32"},"compatible":{"type":"integer","description":"device compatible","format":"int32"},"inWhitelist":{"type":"boolean","description":"device inWhitelist"},"statusCategory":{"type":"integer","description":"device status: connected, pending, and disconnected","format":"int32"},"status":{"type":"integer","description":"device status subcategory: connected， pending， wireless pending","format":"int32"},"hwVersion":{"type":"string","description":"device hardware version"},"modelVersion":{"type":"string","description":"device model version"},"omadacId":{"type":"string","description":"the omadacId of device"},"wireless":{"type":"boolean","description":"Whether the device is wireless"},"es":{"type":"boolean","description":"Whether it is an ES device or not"},"deviceSeriesType":{"type":"integer","description":"Device type: 0: advanced 1: pro","format":"int32"}}},"OperationResponseListBriefDeviceInfoDetailForBatchAdoptOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/BriefDeviceInfoDetailForBatchAdoptOpenApiVO"}}}},"OperationResponseDeviceAccessManagementSetting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeviceAccessManagementSetting"}}},"GlobalOverViewOpenApiVO":{"type":"object","properties":{"totalGatewayNum":{"type":"integer","description":"total number of gateways","format":"int32"},"connectedGatewayNum":{"type":"integer","description":"total number of connected gateways","format":"int32"},"disconnectedGatewayNum":{"type":"integer","description":"total number of disconnected gateways","format":"int32"},"totalSwitchNum":{"type":"integer","description":"total number of switch","format":"int32"},"connectedSwitchNum":{"type":"integer","description":"total number of connected switch","format":"int32"},"disconnectedSwitchNum":{"type":"integer","description":"total number of disconnected switch","format":"int32"},"totalApNum":{"type":"integer","description":"total number of ap","format":"int32"},"connectedApNum":{"type":"integer","description":"total number of connected ap","format":"int32"},"isolatedApNum":{"type":"integer","description":"total number of isolated ap","format":"int32"},"disconnectedApNum":{"type":"integer","description":"total number of disconnected ap","format":"int32"},"totalOltNum":{"type":"integer","description":"total number of olt","format":"int32"},"connectedOltNum":{"type":"integer","description":"total number of connected olt","format":"int32"},"disconnectedOltNum":{"type":"integer","description":"total number of disconnected olt","format":"int32"},"totalClientNum":{"type":"integer","description":"total number of client","format":"int32"},"wiredClientNum":{"type":"integer","description":"total number of wired client","format":"int32"},"wirelessClientNum":{"type":"integer","description":"total number of wireless client","format":"int32"},"guestNum":{"type":"integer","description":"total number of wireless guest","format":"int32"},"siteNum":{"type":"integer","description":"total number of site","format":"int32"},"countryNum":{"type":"integer","description":"total number of country","format":"int32"},"cloudAccessStatus":{"type":"integer","description":"the status of cloud access. -1: disabled  0: disconneted  1: conneted","format":"int32"},"preConfigOsgNum":{"type":"integer","description":"the number of preconfig gateway.","format":"int32"},"preConfigOswNum":{"type":"integer","description":"the number of preconfig switch.","format":"int32"},"preConfigApNum":{"type":"integer","description":"the number of preconfig ap.","format":"int32"},"preConfigOltNum":{"type":"integer","description":"the number of preconfig olt.","format":"int32"},"totalConnectedNum":{"type":"integer","description":"total number of connected devices","format":"int32"}}},"OperationResponseGlobalOverViewOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GlobalOverViewOpenApiVO"}}},"ClientCorrectionOptionListVO":{"type":"object","properties":{"typeList":{"type":"array","items":{"$ref":"#/components/schemas/ClientCorrectionOptionVO"}},"vendorList":{"type":"array","items":{"$ref":"#/components/schemas/ClientCorrectionOptionVO"}}}},"ClientCorrectionOptionVO":{"type":"object","properties":{"name":{"type":"string"},"key":{"type":"string"},"icon":{"type":"string"}}},"OperationResponseClientCorrectionOptionListVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ClientCorrectionOptionListVO"}}},"CustomerInfoOpenApiVO":{"type":"object","properties":{"customerName":{"type":"string","description":"Customer name"},"customerId":{"type":"string","description":"Customer ID"},"description":{"type":"string","description":"Customer description"}}},"OperationResponseListCustomerInfoOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/CustomerInfoOpenApiVO"}}}},"OperationResponseUI Interface":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/UI Interface"}}},"OperationResponseController General Setting":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Controller General Setting"}}},"OperationResponseClientRecognitionEnableOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ClientRecognitionEnableOpenApiVO"}}},"OperationResponseClient Active Timeout":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Client Active Timeout"}}},"OperationResponseRead Features Result":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/Read Features Result"}}},"Read Features Result":{"type":"object","properties":{"healthTip":{"type":"integer","description":"    Whether to display a health notification pop-up (pop-up styles vary). 0: No further prompts after the user acknowledges and confirms.\n    1: During an upgrade, if device thresholds are exceeded and the client health feature is disabled by default, a pop-up will be shown.\n    2: In a restore scenario, when health settings are migrated from a higher-spec model to a lower-spec model, the number of devices may exceed the threshold, triggering a pop-up.\n    null: No prompt will be displayed. For example, {healthTip:null} or {}: No prompt will be displayed.\n","format":"int32"},"widsTip":{"type":"integer","description":"    Whether to display a wids notification pop-up (pop-up styles vary). 0: No further prompts after the user acknowledges and confirms.\n    1: During an upgrade, when wids settings are migrated from a higher-spec model to a lower-spec model, the number of devices may exceed the threshold, triggering a pop-up.\n    2: In a restore scenario, when wids settings are migrated from a higher-spec model to a lower-spec model, the number of devices may exceed the threshold, triggering a pop-up.\n    null: No prompt will be displayed. For example, {widsTip:null} or {}: No prompt will be displayed.\n","format":"int32"},"anomalyDetectTip":{"type":"integer","description":"    Whether to display an incident detect notification pop-up (pop-up styles vary). 0: No further prompts after the user acknowledges and confirms.\n    1: During an upgrade, if device thresholds are exceeded and the incident detection feature is disabled by default, a pop-up will be shown.\n    2: In a restore scenario, when incident settings are migrated from a higher-spec model to a lower-spec model, the number of devices may exceed the threshold, triggering a pop-up.\n    null: No prompt will be displayed. For example, {anomalyDetectTip:null} or {}: No prompt will be displayed.\n","format":"int32"}}},"OmadacClientSettingOpenApiVO":{"required":["clientStatEnable","clientsDataEnable"],"type":"object","properties":{"clientsDataEnable":{"type":"boolean","description":"Enable client history data."},"clientStatEnable":{"type":"boolean","description":"Enable clients data trend record."}}},"OperationResponseOmadacClientSettingOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OmadacClientSettingOpenApiVO"}}},"CloudAccessOpenApiVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"enable"},"owner":{"type":"string","description":"owner"},"status":{"type":"integer","description":"status, DISABLED = -1; CONNECTED = 1; DISCONNECTED = 0","format":"int32"}}},"OperationResponseCloudAccessOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CloudAccessOpenApiVO"}}},"OperationResponseRemoteBindingOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/RemoteBindingOpenApiVO"}}},"RemoteBindingOpenApiVO":{"type":"object","properties":{"enable":{"type":"boolean","description":"enable"}}},"OperationResponseClientDetailInformationSettingVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ClientDetailInformationSettingVO"}}},"OperationResponseAutoBackupOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AutoBackupOpenApiVO"}}},"ControllerUserAppVO":{"required":["type"],"type":"object","properties":{"id":{"type":"string"},"type":{"type":"integer","format":"int32"},"roleDetail":{"$ref":"#/components/schemas/RoleDetailVO"},"roleType":{"type":"integer","format":"int32"},"name":{"type":"string"},"email":{"type":"string"},"omadacId":{"type":"string"},"verified":{"type":"boolean"},"alert":{"type":"boolean"},"privilege":{"$ref":"#/components/schemas/PrivilegeResultVO"},"viewerParentUserId":{"type":"string"},"parentUserId":{"type":"string"},"showTree":{"type":"boolean"},"incidentNotification":{"type":"boolean","deprecated":true},"userLevel":{"type":"integer","format":"int32"},"temporaryEnable":{"type":"boolean"},"startTime":{"type":"integer","format":"int64"},"endTime":{"type":"integer","format":"int64"},"temporaryValidity":{"type":"integer","format":"int32"}}},"GridVOControllerUserAppVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ControllerUserAppVO"}}}},"OperationResponseGridVOControllerUserAppVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOControllerUserAppVO"}}},"PrivilegeResultVO":{"type":"object","properties":{"sites":{"type":"array","description":"user site privilege list","items":{"type":"object","additionalProperties":{"type":"object","description":"user site privilege list"},"description":"user site privilege list"}},"last visited":{"type":"string","description":"user last visited site"},"lastSiteCategory":{"type":"string"},"all":{"type":"boolean","description":"whether user has all site privilege"},"siteNum":{"type":"integer","description":"user site num","format":"int32"},"favorites":{"type":"array","items":{"type":"string"}},"serviceType":{"type":"integer","format":"int32"}}},"RoleDetailVO":{"required":["name"],"type":"object","properties":{"id":{"type":"string","description":"Role Detail ID"},"name":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string","description":"Role name should contain 1 to 128 ASCII characters."},"type":{"type":"integer","description":"Role Type should be a value as follows: 0: standard; 1: customer; 2: msp.","format":"int32"},"defaultRole":{"type":"boolean","description":"Whether role is default role."},"source":{"type":"integer","description":"Role created resource. It should be a value as follows: 0: default; 1:create by standard controller or customer controller; 2: create by MSP","format":"int32"},"privilege":{"$ref":"#/components/schemas/RoleVO"},"hasAllPrivilege":{"type":"boolean","description":"Whether role has all site privilege."},"owner":{"type":"boolean","description":"Whether role is owner."}}},"AdoptTipOpenApiVO":{"type":"object","properties":{"adoptDeviceNum":{"type":"integer","description":"Adopted device num","format":"int32"},"recommendDeviceNum":{"type":"integer","description":"Recommend adopt device num","format":"int32"}}},"OperationResponseAdoptTipOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/AdoptTipOpenApiVO"}}},"FavoriteSitesVO":{"type":"object","properties":{"siteIds":{"type":"array","description":"List of site IDs bookmarked by users","items":{"type":"string","description":"List of site IDs bookmarked by users"}}}},"OperationResponseFavoriteSitesVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/FavoriteSitesVO"}}},"GridVOMspUserDetailVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/MspUserDetailVO"}}}},"MspUserDetailVO":{"type":"object","properties":{"id":{"type":"string","description":"User ID"},"type":{"type":"integer","description":"Type of user should be a value as follows: 0:local user; 1: cloud user","format":"int32"},"roleId":{"type":"string","description":"Msp user role ID in MSP"},"roleName":{"type":"string","description":"User bind role name"},"name":{"type":"string","description":"User name"},"email":{"type":"string","description":"User email"},"mspId":{"type":"string","description":"MSP ID"},"verified":{"type":"boolean","description":"Whether this cloud user has verified"},"alert":{"type":"boolean","description":"Whether this user wants to receive alert, event, and incident emails. Make sure your email is not null."},"parentUserId":{"type":"string","description":"User's parent user ID"},"customerRoleId":{"type":"string","description":"Msp user's customer role ID when visit customer"},"customerRoleName":{"type":"string","description":"Msp user's customer role name when visit customer"},"customerIds":{"uniqueItems":true,"type":"array","description":"User customer privilege list","items":{"type":"string","description":"User customer privilege list"}},"showTree":{"type":"boolean","description":"Whether msp user has Sub-users."},"allCustomer":{"type":"boolean","description":"Whether msp user has all customer permission, including new created customer"},"temporaryEnable":{"type":"boolean","description":"Whether the user wants to enable the temporary worker permission"},"startTime":{"type":"integer","description":"The start time of the user's validity period. time range: start timestamp (Millisecond).","format":"int64"},"endTime":{"type":"integer","description":"The end time of the user's validity period. time range: end timestamp (Millisecond).","format":"int64"},"temporaryValidity":{"type":"integer","description":"Whether the temporary user is still valid","format":"int32"}}},"OperationResponseGridVOMspUserDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOMspUserDetailVO"}}},"OperationResponseMspUserDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/MspUserDetailVO"}}},"OperationResponseMspUiInterfaceOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/MspUiInterfaceOpenApiVO"}}},"GridVOMspExternalUserDetailOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/MspExternalUserDetailOpenApiVO"}}}},"MspExternalUserDetailOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"External user ID."},"name":{"type":"string","description":"External user name."},"idpId":{"type":"string","description":"The ID of IdP which is used by this user."},"idpName":{"type":"string","description":"The name of IdP which is used by this user."},"roleId":{"type":"string","description":"The ID of role which is used by this user."},"roleName":{"type":"string","description":"The name of role which is used by this user."},"customerRoleId":{"type":"string","description":"The ID of customer role which is used by this user."},"customerRoleName":{"type":"string","description":"The name of customer role which is used by this user."},"mspPrivilege":{"$ref":"#/components/schemas/MspPrivilegeOpenApiVO"},"temporaryEnable":{"type":"boolean","description":"Whether the user wants to enable the temporary worker permission"},"startTime":{"type":"integer","description":"The start time of the user's validity period. time range: start timestamp (Millisecond).","format":"int64"},"endTime":{"type":"integer","description":"The end time of the user's validity period. time range: end timestamp (Millisecond).","format":"int64"},"temporaryValidity":{"type":"integer","description":"Whether the temporary user is still valid","format":"int32"}}},"MspPrivilegeOpenApiVO":{"type":"object","properties":{"all":{"type":"boolean","description":"Whether having all customer privilege."},"customers":{"uniqueItems":true,"type":"array","description":"The IDs of customer that can be accessed by this user.","items":{"type":"string","description":"The IDs of customer that can be accessed by this user."}}},"description":"The customer's privilege of this user."},"OperationResponseGridVOMspExternalUserDetailOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOMspExternalUserDetailOpenApiVO"}}},"GridVOMspExternalUserGroupDetailOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/MspExternalUserGroupDetailOpenApiVO"}}}},"MspExternalUserGroupDetailOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Msp external user group ID."},"name":{"type":"string","description":"Msp external user group name."},"roleId":{"type":"string","description":"Msp role ID."},"roleName":{"type":"string","description":"Msp role name."},"roleType":{"type":"integer","description":"Msp role type.","format":"int32"},"customerRoleId":{"type":"string","description":"Customer role ID."},"customerRoleName":{"type":"string","description":"Customer role name."},"customerRoleType":{"type":"integer","description":"Customer role type.","format":"int32"},"allCustomer":{"type":"boolean","description":"Whether having all customer permissions."},"customers":{"type":"array","description":"The customers which can be accessed. Required when allCustomer is false.","items":{"$ref":"#/components/schemas/OmadacInfoOpenApiVO"}},"temporaryEnable":{"type":"boolean","description":"Whether the user wants to enable the temporary worker permission"},"startTime":{"type":"integer","description":"The start time of the user's validity period. time range: start timestamp (Millisecond).","format":"int64"},"endTime":{"type":"integer","description":"The end time of the user's validity period. time range: end timestamp (Millisecond).","format":"int64"},"temporaryValidity":{"type":"integer","description":"Whether the temporary user is still valid","format":"int32"}}},"OmadacInfoOpenApiVO":{"type":"object","properties":{"id":{"type":"string","description":"Customer ID."},"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,30}[^ ]$","type":"string","description":"Customer name should contain 1 to 32 characters."}},"description":"The customers which can be accessed. Required when allCustomer is false."},"OperationResponseGridVOMspExternalUserGroupDetailOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOMspExternalUserGroupDetailOpenApiVO"}}},"GridVOMspSiteSummaryInfo":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/MspSiteSummaryInfo"}}}},"MspSiteSummaryInfo":{"type":"object","properties":{"siteId":{"type":"string","description":"Site ID"},"siteName":{"type":"string","description":"Site name"},"tagIds":{"uniqueItems":true,"type":"array","description":"Site tag ID","items":{"type":"string","description":"Site tag ID"}},"customerId":{"type":"string","description":"Customer ID"},"customerName":{"type":"string","description":"Customer name"},"region":{"type":"string","description":"Country/Region of the site; For the values of region, refer to the abbreviation of the ISO country code; For example, you need to input \"United States\" for the United States of America."},"timeZone":{"type":"string","description":"For the values of the timezone of the site, refer to section 5.1 of the Open API Access Guide."},"scenario":{"type":"string","description":"Site scenario"},"longitude":{"type":"number","description":"Site longitude should be within the range of -180~180","format":"double"},"latitude":{"type":"number","description":"Site latitude should be within the range of -90~90","format":"double"},"address":{"type":"string","description":"Site address"},"wan":{"type":"boolean","description":"Whether exists gateway is connected of current site"},"connectedApNum":{"type":"integer","description":"Connected ap num of current site","format":"int64"},"disconnectedApNum":{"type":"integer","description":"Disconnected ap num of current site","format":"int64"},"isolatedApNum":{"type":"integer","description":"Isolated ap num of current site","format":"int64"},"connectedSwitchNum":{"type":"integer","description":"Connected switch num of current site","format":"int64"},"disconnectedSwitchNum":{"type":"integer","description":"Disconnected switch num of current site","format":"int64"},"type":{"type":"integer","description":"Site type(only for pro controller). It should be a value as follows: 0: Basic Site; 1: Pro Site","format":"int32"},"supportES":{"type":"boolean","description":"Whether the site supports adopting Agile Series Switches"},"supportL2":{"type":"boolean","description":"Whether the site supports adopting Non-Agile Series Switches"},"sitePublicIp":{"type":"string","description":"Adopted gateway public ip of the site, only useful for cloud based controller and remote management local Controller"}}},"OperationResponseGridVOMspSiteSummaryInfo":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOMspSiteSummaryInfo"}}},"OperationResponseMspUserInterfaceOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/MspUserInterfaceOpenApiVO"}}},"OperationResponseSendMailServerOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/SendMailServerOpenApiVO"}}},"MspRoleDetailVO":{"type":"object","properties":{"id":{"type":"string","description":"Role ID"},"name":{"type":"integer","description":"Role type","format":"int32"},"defaultRole":{"type":"boolean","description":"Whether role is default role"},"privilege":{"$ref":"#/components/schemas/MspRoleVO"}}},"OperationResponseListMspRoleDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/MspRoleDetailVO"}}}},"OperationResponseMspRoleDetailVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/MspRoleDetailVO"}}},"MspRemoteLoggingSettingOpenApiVO":{"required":["enable"],"type":"object","properties":{"enable":{"type":"boolean","description":"Whether to enable the feature."},"host":{"pattern":"((\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])(\\.(\\d{1,2}|1\\d\\d|2[0-4]\\d|25[0-5])){3}|([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,6})","type":"string","description":"The IP address of the remote log server."},"port":{"type":"integer","description":"Port of the remote log server, port should be within the range of 1-65535.","format":"int32"}}},"OperationResponseMspRemoteLoggingSettingOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/MspRemoteLoggingSettingOpenApiVO"}}},"OperationResponseMFAConfigOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/MFAConfigOpenApiVO"}}},"GridVOUsedLicenseDetailOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/UsedLicenseDetailOpenApiVO"}}}},"UsedLicenseDetailOpenApiVO":{"type":"object","properties":{"licenseId":{"type":"string","description":"License key"},"expirationTime":{"type":"integer","description":"License expiration time, unit: ms","format":"int64"}}},"LicenseAvailableRecycleOpenApiVO":{"type":"object","properties":{"licenseNum":{"type":"array","items":{"$ref":"#/components/schemas/LicenseNumOpenApiVO"}}}},"LicenseAvailableAssignOpenApiVO":{"type":"object","properties":{"licenseNum":{"type":"array","items":{"$ref":"#/components/schemas/LicenseNumOpenApiVO"}}}},"MspGeneralSettingOpenApiVO":{"type":"object","properties":{"name":{"pattern":"^[^ \\+\\-\\@\\=]$|^[^ \\+\\-\\@\\=].{0,34}[^ ]$","type":"string","description":"Parameter [name] should be within the range of 1–32 visible ASCII characters."},"timeZone":{"type":"string","description":"For the values of timeZone, refer to section 5.1 of the Open API Access Guide."},"dst":{"$ref":"#/components/schemas/DstDTO"}}},"OperationResponseMspGeneralSettingOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/MspGeneralSettingOpenApiVO"}}},"GridVOMspUnknownDeviceOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/MspUnknownDeviceOpenApiVO"}}}},"MspUnknownDeviceOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device MAC"},"name":{"type":"string","description":"Device name"},"type":{"type":"string","description":"Device type"},"subtype":{"type":"string","description":"Switch subtype should be a value as follows: smart: Non-Agile Series Switch; es: Agile Series Switch."},"deviceSeriesType":{"type":"integer","description":"Device series type. 0 means basic, 1 means pro.","format":"int32"},"model":{"type":"string","description":"Device model name"},"ip":{"type":"string","description":"Device IP"},"uptime":{"type":"string","description":"Device uptime"},"status":{"type":"integer","description":"Device status should be a value as follows: 0: Disconnected; 1: Connected; 2: Pending; 3: Heartbeat Missed; 4: Isolated","format":"int32"},"lastSeen":{"type":"integer","description":"Device lastSeen, unit: ms","format":"int64"}}},"OperationResponseGridVOMspUnknownDeviceOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOMspUnknownDeviceOpenApiVO"}}},"OperationResponseListTagRespOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/TagRespOpenApiVO"}}}},"GridVOMspKnownDeviceOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/MspKnownDeviceOpenApiVO"}}}},"MspKnownDeviceOpenApiVO":{"type":"object","properties":{"mac":{"type":"string","description":"Device MAC"},"name":{"type":"string","description":"Device name"},"type":{"type":"string","description":"Device type"},"subtype":{"type":"string","description":"Switch subtype should be a value as follows: smart: Non-Agile Series Switch; es: Agile Series Switch."},"deviceSeriesType":{"type":"integer","description":"Device series type. 0 means basic, 1 means pro.","format":"int32"},"model":{"type":"string","description":"Device model name"},"ip":{"type":"string","description":"Device IP"},"ipv6":{"type":"array","description":"Device IPv6 list","items":{"type":"string","description":"Device IPv6 list"}},"uptime":{"type":"string","description":"Device uptime"},"status":{"type":"integer","description":"Device status should be a value as follows: 0: Disconnected; 1: Connected; 2: Pending; 3: Heartbeat Missed; 4: Isolated","format":"int32"},"lastSeen":{"type":"integer","description":"Device lastSeen, unit: ms","format":"int64"},"cpuUtil":{"type":"integer","description":"Device cpuUtil","format":"int32"},"memUtil":{"type":"integer","description":"Device memUtil","format":"int32"},"sn":{"type":"string","description":"Device serial number"},"licenseStatus":{"type":"integer","description":"Device license status(Only for pro site) should be a value as follows: 0:unActive; 1:Unbind; 2:Expired; 3:active","format":"int32"},"needActive":{"type":"boolean","description":"Device license status(Only for pro site).If the value is true, the device is ready to be activated;If the value is false, the device cannot be activated or has already been activated."},"customerName":{"type":"string","description":"The name of the customer where the device is located"},"siteName":{"type":"string","description":"The name of the site where the device is located"},"tagName":{"type":"string","description":"Device tag name"}}},"OperationResponseGridVOMspKnownDeviceOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOMspKnownDeviceOpenApiVO"}}},"MspClientOverallVO":{"type":"object","properties":{"totalClientNum":{"type":"integer","format":"int32"},"wiredUser":{"type":"integer","format":"int32"},"wirelessUser":{"type":"integer","format":"int32"},"wirelessGuest":{"type":"integer","format":"int32"}}},"OperationResponseMspClientOverallVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/MspClientOverallVO"}}},"GridVOCustomerInfoOpenApiVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerInfoOpenApiVO"}}}},"OperationResponseGridVOCustomerInfoOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOCustomerInfoOpenApiVO"}}},"OperationResponseCustomerInfoOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CustomerInfoOpenApiVO"}}},"NodeInfoVO":{"type":"object","properties":{"nodeName":{"type":"string"},"currentNode":{"type":"string"},"role":{"type":"string"},"systemTime":{"type":"integer","format":"int64"},"status":{"type":"string"},"managedSites":{"type":"integer","format":"int32"},"managedDevices":{"type":"integer","format":"int32"}}},"OperationResponseListNodeInfoVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"type":"array","items":{"$ref":"#/components/schemas/NodeInfoVO"}}}},"CustomerVO":{"type":"object","properties":{"customerId":{"type":"string"},"name":{"type":"string"}}},"GridVOMspUserVO":{"type":"object","properties":{"totalRows":{"type":"integer","description":"Total rows of all items.","format":"int64"},"currentPage":{"type":"integer","description":"Current page number.","format":"int32"},"currentSize":{"type":"integer","description":"Number of entries per page.","format":"int32"},"data":{"type":"array","items":{"$ref":"#/components/schemas/MspUserVO"}}}},"MspPrivilegeVO":{"type":"object","properties":{"lastCustomer":{"type":"string"},"customers":{"type":"array","items":{"$ref":"#/components/schemas/CustomerVO"}},"all":{"type":"boolean"},"favoriteCustomers":{"type":"array","items":{"type":"string"}}}},"MspUserVO":{"required":["name","type"],"type":"object","properties":{"id":{"type":"string"},"type":{"type":"integer","format":"int32"},"roleId":{"type":"string"},"roleName":{"type":"string"},"name":{"pattern":"^(?![+=@-])[\\041-\\0176]$|^(?![+=@-])[\\041-\\0176][\\040-\\0176]{0,126}[\\041-\\0176]$","type":"string"},"password":{"pattern":"^[\\041-\\0176]$|^[\\041-\\0176][\\040-\\0176]{6,126}[\\041-\\0176]$","type":"string"},"email":{"type":"string"},"omadacId":{"type":"string"},"verified":{"type":"boolean"},"alert":{"type":"boolean"},"token":{"type":"string"},"viewerParentUserId":{"type":"string"},"showTree":{"type":"boolean"},"parentUserId":{"type":"string"},"forceModify":{"type":"boolean"},"customerRoleId":{"type":"string"},"customerRoleName":{"type":"string"},"privilege":{"$ref":"#/components/schemas/MspPrivilegeVO"},"owner":{"type":"boolean"},"temporaryEnable":{"type":"boolean"},"startTime":{"type":"integer","format":"int64"},"endTime":{"type":"integer","format":"int64"},"temporaryValidity":{"type":"integer","format":"int32"},"enable2FA":{"type":"boolean"}}},"OperationResponseGridVOMspUserVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GridVOMspUserVO"}}},"ListUsersResponseDTO":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/UserResponseDTO"}}}},"OperationResponseListUsersResponseDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/ListUsersResponseDTO"}}},"UserResponseDTO":{"type":"object","properties":{"customizeOmadacId":{"type":"string"},"email":{"type":"string"},"accountId":{"type":"string"},"verified":{"type":"boolean"},"roleType":{"type":"integer","format":"int32"}}},"GetSiteListByPageResponseDTO":{"type":"object","properties":{"totalNum":{"type":"integer","format":"int64"},"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"siteList":{"type":"array","items":{"$ref":"#/components/schemas/SiteDetailResponseDTO"}}}},"OperationResponseGetSiteListByPageResponseDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GetSiteListByPageResponseDTO"}}},"SiteDetailResponseDTO":{"type":"object","properties":{"siteName":{"type":"string"},"siteId":{"type":"string"},"alertNum":{"type":"integer","format":"int64"},"wan":{"type":"boolean"},"lan":{"type":"boolean"},"wlan":{"type":"boolean"}}},"OmadacDetailResponseDTO":{"type":"object","properties":{"customizeOmadacId":{"type":"string"},"controllerName":{"type":"string"},"controllerId":{"type":"string"},"role":{"type":"integer","format":"int32"},"totalDeviceNum":{"type":"integer","format":"int64"},"disconnectedDeviceNum":{"type":"integer","format":"int64"},"clientNum":{"type":"integer","format":"int64"},"guestNum":{"type":"integer","format":"int64"},"alertNum":{"type":"integer","format":"int64"},"alertObscured":{"type":"boolean"},"siteNum":{"type":"integer","format":"int64"},"controllerVersion":{"type":"string"},"timeZone":{"type":"string"},"newUiConfig":{"type":"boolean"},"region":{"type":"string"},"url":{"type":"string"},"allSite":{"type":"boolean"},"informUrl":{"type":"string"},"siteByPage":{"type":"boolean"},"apiUrl":{"type":"string"},"configured":{"type":"boolean"},"sites":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"customers":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"originOmadacId":{"type":"string"},"category":{"type":"string"},"mspMode":{"type":"boolean"},"customerNum":{"type":"integer","format":"int64"},"deviceUpgrade":{"type":"boolean"},"connectedDeviceNum":{"type":"integer","format":"int64"},"hasMspPermission":{"type":"boolean"}}},"OperationResponseOmadacDetailResponseDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/OmadacDetailResponseDTO"}}},"CustomerInfoResponseDTO":{"type":"object","properties":{"customerId":{"type":"string"},"customerName":{"type":"string"},"siteNum":{"type":"integer","format":"int64"}}},"GetCustomerListByPageResponseDTO":{"type":"object","properties":{"totalNum":{"type":"integer","format":"int64"},"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"customerList":{"type":"array","items":{"$ref":"#/components/schemas/CustomerInfoResponseDTO"}}}},"OperationResponseGetCustomerListByPageResponseDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/GetCustomerListByPageResponseDTO"}}},"CheckStatusResponseDTO":{"type":"object","properties":{"online":{"type":"boolean"}}},"OperationResponseCheckStatusResponseDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CheckStatusResponseDTO"}}},"CheckInProWhitelistDTO":{"type":"object","properties":{"inProWhitelist":{"type":"boolean"}}},"OperationResponseCheckInProWhitelistDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CheckInProWhitelistDTO"}}},"CheckCBCPrivilegesDTO":{"type":"object","properties":{"owner":{"type":"boolean"}}},"OperationResponseCheckCBCPrivilegesDTO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/CheckCBCPrivilegesDTO"}}},"BatchDeleteCommonOpenApiVO":{"type":"object","properties":{"ids":{"type":"array","description":"A set of Bluetooth Advertising entry ids to be deleted.","items":{"type":"string","description":"A set of Bluetooth Advertising entry ids to be deleted."}}}},"DeleteUserVO":{"type":"object","properties":{"forceDelete":{"type":"boolean","description":"Force delete target user. If false, target user can not be deleted, when target user has child users. If true, target user will be deleted anyway. Target user's child users will be root's child user."}}},"VoipDeleteTelephoneBook":{"required":["forceDelete"],"type":"object","properties":{"forceDelete":{"type":"boolean","description":"Other configurations depending on this contact (call forwarding rules for instance) will be deleted together if this field is true. Otherwise, a pre-check will be executed and an error message will be returned when this contact is already used in some other configurations."}}},"DeleteCallForwardingRules":{"type":"object","properties":{"ruleIds":{"type":"array","description":"Ids of call forwarding rules to be deleted.","items":{"type":"string","description":"Ids of call forwarding rules to be deleted."}}}},"DeletePortTagOpenApiVO":{"required":["tagId"],"type":"object","properties":{"tagId":{"type":"string","description":"Port label ID"}}},"DeleteProviderProfileTemplateEntity":{"required":["profileIds"],"type":"object","properties":{"profileIds":{"type":"array","description":"Provider profile IDs","items":{"type":"string","description":"Provider profile IDs"}}}},"DeleteCertOpenApiVO":{"type":"object","properties":{"name":{"type":"string","description":"Certificate profile name of deleted item."}},"description":"DeleteCertOpenApiVO"},"OperationResponseDeleteCertOpenApiVO":{"type":"object","properties":{"errorCode":{"type":"integer","format":"int32"},"msg":{"type":"string"},"result":{"$ref":"#/components/schemas/DeleteCertOpenApiVO"}}},"DeleteCliTemplateOpenApiVO":{"type":"object","properties":{"configId":{"type":"string","description":"CLI ID to be deleted."}},"description":"Delete the CLI template configuration entry"},"BatchSelectVpnUserVO":{"type":"object","properties":{"ids":{"type":"array","description":"ID list of batch selected VPN users.","items":{"type":"string","description":"ID list of batch selected VPN users."}},"searchKey":{"type":"string","description":"The keywords of the searchIt is effected when [selectAll] is 'true'."},"selectAll":{"type":"boolean","description":"Indicates whether to select all VPN users for deletion. The behavior depends on the combination with 'ids': 1: If selectAll is true and ids is not empty: perform a reverse selection (excluding the specified IDs). 2: If selectAll is true and ids is empty: select all VPN users. 3: If selectAll is false and ids is not empty: select only the specified VPN users in the ID list."},"protocol":{"type":"integer","description":"Protocol should be a value as follows: 0: L2TP or PPTP; 1: OpenVPN, 2: SSL VPN.","format":"int32"}}},"BatchSelectSslUserVO":{"type":"object","properties":{"ids":{"type":"array","description":"ID list of batch selected SSL VPN users.","items":{"type":"string","description":"ID list of batch selected SSL VPN users."}},"searchKey":{"type":"string","description":"The keywords of the searchIt is effected when [selectAll] is 'true'."},"selectAll":{"type":"boolean","description":"Indicates whether to select all SSL VPN users for deletion.The behavior depends on the combination with 'ids':\n- If selectAll is true and ids is not empty: perform a reverse selection (excluding the specified IDs).\n- If selectAll is true and ids is empty: select all SSL VPN users.\n- If selectAll is false and ids is not empty: select only the specified SSL VPN users in the ID list."}}},"ClearDpiDataRequest":{"required":["end","start"],"type":"object","properties":{"start":{"type":"integer","description":"Start timestamp, in seconds, such as 1682000000","format":"int64"},"end":{"type":"integer","description":"End timestamp, in seconds, such as 1682000000","format":"int64"}}},"VoiceMailBatchDelete":{"required":["voiceMailList"],"type":"object","properties":{"voiceMailList":{"type":"array","description":"Voice mail list.","items":{"type":"string","description":"Voice mail list."}}}},"DeleteIntelliRecoverDevice":{"type":"object","properties":{"deleteMacs":{"type":"array","description":"The device macs to be deleted from intelli recover device list.","items":{"type":"string","description":"The device macs to be deleted from intelli recover device list."}}}},"DeleteIntelliRecoverClient":{"type":"object","properties":{"deleteMacs":{"type":"array","description":"The client macs to be deleted from intelli recover client list.","items":{"type":"string","description":"The client macs to be deleted from intelli recover client list."}}}},"DeleteSiteEventLogListOpenApiVO":{"required":["endTime","selectType","startTime"],"type":"object","properties":{"logs":{"type":"array","description":"Select the logs to delete; Log ID list can be obtained from 'Get site event log list' interface.","items":{"type":"string","description":"Select the logs to delete; Log ID list can be obtained from 'Get site event log list' interface."}},"selectType":{"type":"string","description":"Select type of logs. include: include selected logs, exclude: all but exclude selected logs, all: include all logs(Parameter [logs] need input '[]')."},"startTime":{"type":"integer","description":"The start timeStamp of the delete site event log, unit: MS.","format":"int64"},"endTime":{"type":"integer","description":"The end timeStamp of the delete site event log, unit: MS.","format":"int64"},"filterModule":{"type":"string","description":"The module of the delete site event log; It is required when [selectType] is 'all', filterModule should be a value as follows: ['System', 'Device', 'Client']."}}},"DeleteSiteAlertLogListOpenApiVO":{"required":["endTime","selectType","startTime"],"type":"object","properties":{"logs":{"type":"array","description":"Select the logs to delete; Log ID list can be obtained from 'Get site alert log list' interface.","items":{"type":"string","description":"Select the logs to delete; Log ID list can be obtained from 'Get site alert log list' interface."}},"selectType":{"type":"string","description":"Select type of logs. include: include selected logs, exclude: all but exclude selected logs, all: include all logs(Parameter [logs] need input '[]')."},"startTime":{"type":"integer","description":"The start timeStamp of the delete site alert log, unit: MS.","format":"int64"},"endTime":{"type":"integer","description":"The end timeStamp of the delete site alert log, unit: MS.","format":"int64"},"filterModule":{"type":"string","description":"The module of the delete site alert log; It is required when [selectType] is 'all', filterModule should be a value as follows: 'System' or 'Device'."}}},"DeleteTagOpenApiVO":{"required":["tagId"],"type":"object","properties":{"tagId":{"type":"string","description":"Tag ID"}}},"DeleteCliOpenApiVO":{"type":"object","properties":{"configIds":{"type":"array","description":"List of IDs to be deleted.","items":{"type":"string","description":"List of IDs to be deleted."}}},"description":"Delete the CLI configuration entry"},"DeleteAnomalyListSettingVO":{"type":"object","properties":{"incidents":{"type":"array","description":"List of anomaly event IDs to operate on.","items":{"type":"string","description":"List of anomaly event IDs to operate on."}},"selectAll":{"type":"boolean","description":"Whether to select all incidents. If true, 'incidents' list items are excluded; otherwise only listed items are processed."},"object":{"type":"string","description":"Device or client MAC, multiple MACs separated by comma. Required when selectAll is true."},"anomalyCode":{"type":"string","description":"Anomaly event code. Required when selectAll is true."},"start":{"type":"integer","description":"Start time in seconds. If both start and end are omitted, the server defaults to the last 30 days.","format":"int64"},"end":{"type":"integer","description":"End time in seconds. If both start and end are omitted, the server defaults to the last 30 days.","format":"int64"},"status":{"type":"integer","description":"Current event status. 0: Unresolved, 1: Resolved, 2: Ignored. 3：Ongoing","format":"int32"}}},"DeleteSiteTagOpenApiVO":{"required":["tagId"],"type":"object","properties":{"tagId":{"type":"string","description":"Tag ID"}}},"DeleteGlobalEventLogListOpenApiVO":{"required":["endTime","selectType","startTime"],"type":"object","properties":{"logs":{"type":"array","description":"Select the logs to delete; Log ID list can be obtained from 'Get global event log list' interface.","items":{"type":"string","description":"Select the logs to delete; Log ID list can be obtained from 'Get global event log list' interface."}},"selectType":{"type":"string","description":"Select type of logs. include: include selected logs, exclude: all but exclude selected logs, all: include all logs(Parameter [logs] need input '[]')."},"startTime":{"type":"integer","description":"The start timeStamp of the delete global event log, unit: MS.","format":"int64"},"endTime":{"type":"integer","description":"The end timeStamp of the delete global event log, unit: MS.","format":"int64"},"filterModule":{"type":"string","description":"The module of the delete global log; It is required when [selectType] is 'all', filterModule should be a value as follows: 'System' or 'Device'."}}},"DeleteGlobalAlertLogListOpenApiVO":{"required":["endTime","selectType","startTime"],"type":"object","properties":{"logs":{"type":"array","description":"Select the logs to delete; Log ID list can be obtained from 'Get global alert log list' interface.","items":{"type":"string","description":"Select the logs to delete; Log ID list can be obtained from 'Get global alert log list' interface."}},"selectType":{"type":"string","description":"Select type of logs. include: include selected logs, exclude: all but exclude selected logs, all: include all logs(Parameter [logs] need input '[]')."},"startTime":{"type":"integer","description":"The start timeStamp of the delete global alert log, unit: MS.","format":"int64"},"endTime":{"type":"integer","description":"The end timeStamp of the delete global alert log, unit: MS.","format":"int64"},"filterModule":{"type":"string","description":"The module of the delete global log; It is required when [selectType] is 'all', filterModule should be a value as follows: 'System' or 'Device'."}}},"DeleteMspEventLogListOpenApiVO":{"required":["endTime","selectType","startTime"],"type":"object","properties":{"logs":{"type":"array","description":"Select the logs to delete; Log ID list can be obtained from 'Get MSP event log list' interface.","items":{"type":"string","description":"Select the logs to delete; Log ID list can be obtained from 'Get MSP event log list' interface."}},"selectType":{"type":"string","description":"Select type of logs. include: include selected logs, exclude: all but exclude selected logs, all: include all logs(Parameter [logs] need input '[]')."},"startTime":{"type":"integer","description":"The start timeStamp of the delete msp event log, unit: MS.","format":"int64"},"endTime":{"type":"integer","description":"The end timeStamp of the delete msp event log, unit: MS.","format":"int64"},"filterModule":{"type":"string","description":"The module of the delete msp event log; It is required when [selectType] is 'all', filterModule should be a value as follows: 'System' or 'Device'."}}},"DeleteMspAlertLogListOpenApiVO":{"required":["endTime","selectType","startTime"],"type":"object","properties":{"logs":{"type":"array","description":"Select the logs to delete; Log ID list can be obtained from 'Get MSP alert log list' interface.","items":{"type":"string","description":"Select the logs to delete; Log ID list can be obtained from 'Get MSP alert log list' interface."}},"selectType":{"type":"string","description":"Select type of logs. include: include selected logs, exclude: all but exclude selected logs, all: include all logs(Parameter [logs] need input '[]')."},"startTime":{"type":"integer","description":"The start timeStamp of the delete msp alert log, unit: MS.","format":"int64"},"endTime":{"type":"integer","description":"The end timeStamp of the delete msp alert log, unit: MS.","format":"int64"},"filterModule":{"type":"string","description":"The module of the delete msp alert log; It is required when [selectType] is 'all', filterModule should be a value as follows: 'System' or 'Device'."}}},"UnbindOmadacRequestDTO":{"type":"object","properties":{"accountId":{"type":"string"},"customizeOmadacId":{"type":"string"}}}}},"x-openapi":{"x-setting":{"customCode":200,"language":"en-US","enableSwaggerModels":false,"swaggerModelName":"Swagger Models","enableReloadCacheParameter":false,"enableAfterScript":true,"enableDocumentManage":false,"enableVersion":false,"enableRequestCache":true,"enableFilterMultipartApis":false,"enableFilterMultipartApiMethodType":"POST","enableHost":false,"enableHostText":"","enableDynamicParameter":false,"enableDebug":false,"enableFooter":false,"enableFooterCustom":true,"footerCustomContent":"Omada Open API v1.0","enableSearch":true,"enableOpenApi":true,"enableHomeCustom":true,"homeCustomLocation":"# Open API Access Guide\n\n# 1 Overview\n\n## 1.1  Status Code\n\n| **Status Code** | Explain                     |\n| ------- | :-------------------------- |\n| **400** | Bad Request                 |\n| **401** | Unauthorized access         |\n| **403** | Forbidden                   |\n| **413** | Request-size limit exceeded |\n| **417** | Request-size limit exceeded |\n| **429** | API Rate limit exceeded     |\n| **500** | Internal server error       |\n\n## 1.2 General Error Code In Result\n\n| **Error Code** | Explain |\n| ------- | :-------------------------- |\n| **-1005** | Operation forbidden |\n| **-1505** | The current user does not have permissions to access this site | \n| **-44106** | The client id or client secret is invalid |\n| **-44107** | The response type is invalid |\n| **-44108** | The CSRF token is invalid |\n| **-44109** | The session id is invalid |\n| **-44110** | The auth code has expired |\n| **-44111** | The grant type is invalid |\n| **-44112** | The access token has expired. Please re-initiate the refreshToken process to obtain the access token. |\n| **-44113** | The access token is Invalid |\n| **-44114** | The refresh token has expired. Please re-initiate the authentication process to obtain the refresh token. |\n| **-44116** | Open API authorized failed, please check whether the input parameters are legal. |\n| **-44118** | This interface only supports the authorization code mode, not the client credentials mode. |\n\n## 1.3  Process Introduction\n\nOmada's Open API supports the REST API of most Controller services. This feature allows Omada users to write custom applications, embed APIs, or combine their own applications. The REST API supports HTTP GET and POST operations by providing specific URLs for each query. The output of these operations is returned in JSON format. To access the API securely, the Omada API framework supports the OAuth 2.0 protocol for authentication and authorization, which allows you to access resources authorized by users without obtaining user names and passwords, and supports the authorization code mode and client credentials mode.\n\nThe authorization code grant type is used to obtain both access tokens and refresh tokens and is optimized for confidential clients. Since this is a redirection-based flow, the client must be capable of interacting with the resource owner's user-agent (typically a web browser) and capable of receiving incoming requests (via redirection) from the authorization server.\n\nThe following is the authorization code mode process：  \n1、The user visits the client.  \n2、The client directs the user to the authentication server (Omada).  \n3、User logs in (/openapi/login), and authorize the third-party client.  \n4、The authentication server directs the user to the redirection URL specified by the client in advance, and attaches an authorization code (redirect URL + ?code={authorization code}, if the redirect URL is `https://redirect.com`, it is `https://redirect.com?code=authCode`).    \n5、The client uses the authorization code to exchange the accessToken from the authentication server (Omada).    \n6、The authentication server (Omada) authenticates the client and issues an access token.  \n7、The client uses the access token to apply for resources from the resource server (Omada).  \n8、The resource server (Omada) confirms the access token and opens resources to the client.  \n9、The client can exchange an access token through refresh token, client ID, and client secret.\n\nThe client can request an access token using only its client credentials (or other supported means of authentication) when the client is requesting access to the protected resources under its control, or those of another resource owner that have been previously arranged with the authorization server (the method of which is beyond the scope of this specification).\n\nThe following is the client credentials mode process：  \n1、The user opens the client, and the client requires the user to authorize.  \n2、The user agrees to authorize the client.  \n3、The client uses the authorization obtained to apply for an access token from the authentication server (Omada).  \n4、The authentication server (Omada) authenticates the client and issues an access token.  \n5、The client uses the access token to apply for resources from the resource server (Omada).  \n6、The resource server (Omada) confirms the access token and open resources to the client.  \n7、The client can exchange an access token through refresh token, client ID, and client secret.\n\n**Note**:  \n1、Each Omada Pro controller and each Omada organization has an API call budget of **10 requests per second**.  \n2、Most interface has a concurrency limit. We recommend that you modify global configurations before other configurations of the site.\n\n# 2 Access Process\n\n## 2.1 Create Application\n\n1、To access the Open API, first create an application at **Settings > Platform Integration** in the MSP or Global view. You can customize the content.：\n-   **Authorization code mode**: You can define the Application name and Redirect URL. When calling the interface in this mode, the authority is the same as that of the login user.\n-   **Client mode**: You can define the Application name and access permissions. When calling the interface in this mode, the rights are the same as the login Application.\n\n2、After the creation is successful, each Application will have a corresponding client ID and client secret, which will be used for subsequent access to the Open API. You can view the details on the interface to know the Omada ID and the access address of the Open API.\n\n## 2.2 Authorization Code Mode Access Process\n\n### 2.2.1 Login Authentication & Obtain Authorization Code\n\n#### 2.2.1.1 redirect URL not specified\nWhen the redirect URL is not specified, the operation process is as follows.\n\nFirst of all, you need to log in. When using the Open API function later, its authority is the same as that of the current login user. The login interface uses the **POST** method, the interface path is **/openapi/authorize/login.**\n-   In the **Query**, fill in the **client ID** (The field name is **client_id**) and **msp id** or **customer id**(The field name is **omadac_id**).\n-   In the **Body**, fill in the **user name**(The field name is **username**) and **password**(The field name is **password**).\n\nAfter logging in successfully, it will return the **csrfToken**, **sessionId**.  \n**Note**: Please save the return parameters for later use.\n\nAn example of the curl command of the login interface is as follows:  \n**Request:**\n~~~\ncurl \"https://localhost:8043/openapi/authorize/login?client_id=38f2d1b616434374b3f3215246f39940&omadac_id=beed48c7a2b0ea97c9698408843119f3\" -H 'content-type:application/json' -d '{\"username\":\"admin\",\"password\":\"tplink123\"}' -X POST -i -k --insecure\n~~~\n**Response:**\n~~~\n{\"errorCode\":0,\"msg\":\"Open API Log in successfully.\",\"result\":{\"csrfToken\":\"51cb83c7d00a4e85b3dd2d6174a614d9\",\"sessionId\":\"2fc0ca155ab94957a9a9e6a3b00662ea\"}}\n~~~\n\nAfter logging in, you need to obtain the authorization code. The **obtaining the authorization** interface uses the **POST** method, the interface path is as follows: **/openapi/authorize/code**.\n\n-   In the **Query**, fill in the **client ID**(The field name is **client_id**) and **response type**(The field name is **response_type**), **msp id** or **customer id**(The field name is **omadac_id**). The response_type represents the reply type, and is filled with \"**code**\" by default in authorization code mode.\n-   In the **Headers**, fill in the **csrf token**(The field name is **Csrf-Token**) and **cookie**(The field name is **Cookie**) obtained in the login step. Note that the prefix **\"TPOMADA_SESSIONID=\"** is required when filling in the **cookie**.\n    After obtaining authorization code successfully, it will return the authorization code.\n\n**Note**: The authorization code is only available for 2 minutes. If it expires, you need to obtain it again.\n\nAn example of the curl command of the **obtaining authorization code** interface is as follows:  \n**Request:**\n~~~\ncurl \"https://localhost:8043/openapi/authorize/code?client_id=29f2fdbeb5a84d50b9b1cdd08cd1a3ff&omadac_id=de382a0e78f4deb681f3128c3e75dbd1&response_type=code\" -H 'content-type:application/json' -H 'Csrf-Token:ae6b935c92cf4b1b9f3eb852e20ed2b8' -H 'Cookie:TPOMADA_SESSIONID=9cb86bf3a99e48a59e4f3bb464a3c443' -X POST -i -k --insecure\n~~~\n**Response:**\n~~~\n{\"errorCode\":0,\"msg\":\"Open API Authorize successfully.\",\"result\":\"OC-9iyxaKVOVMBpYhQ4NryaYBjghj3dTY32\"}\n~~~\n\n#### 2.2.1.2 redirect URL already specified\n\nWhen the redirect URL is specified, the operation process is as follows.\n\nOmada customized the login page for the third party. Note that client ID is required to carry. When logging in directly through the login page, the user will be redirected to the third-party service with the authorization code. For example, if the redirect URL is `https://test.com:8082/redirect/test`, Omada will send a redirect request `https://test.com:8082/redirect/test?code={authorization_code}`, and the client can directly parse the authorization code for subsequent processing. If you don't know your login URL, go to **Settings > Platform Integration > Open API**, find your application and click the View button to check the **Oauth Login Page Address**.\n-   In the **Query**, fill in the **client ID**(The field name is **client_id**)\n\n**Note**: If you need to redirect the authorization code, please contact our technical support to add your domain name to the trusted list of the Omada system.\n\n### 2.2.2 Obtain Access Token\nAfter the authorization code is obtained, it will be used to obtain the access token. The **obtaining the access token** interface uses the **POST** method, the interface path is as follows: **/openapi/authorize/token**.\n\n-   In the **Query**, fill in the **grant type**(The field name is **grant_type**). The grant type indicates the authentication method, and the authorization code needs to be filled in with \"**authorization_code**\"\n-   In the **Body**, fill in the **client ID**(the field name is **client_id**) and **client secret**(the field name is **client_secret**).\n\nAfter obtaining access token successfully, it will return the **access token**(The field name is **accessToken**), **token type**(The field name is **tokenType**), **expire time**(The field name is **expiresIn**, unit is second), **refresh token**(The field name is **refreshToken**).\n\nAn example of the curl command of the **obtaining access token** interface is as follows:  \n**Request:**\n~~~\ncurl \"https://localhost:8043/openapi/authorize/token?grant_type=authorization_code&code=OC-y8fyWAyICCqCWw44Oi9GeSr7fQIKHg7g\" -H 'content-type:application/json' -d '{\"client_id\": \"29f2fdbeb5a84d50b9b1cdd08cd1a3ff\", \"client_secret\": \"cf6b13af0dd045628c9f05f088eb5493\"}' -X POST -i -k --insecure\n~~~\n**Response:**\n~~~\n{\"errorCode\":0,\"msg\":\"Open API Get Access Token successfully.\",\"result\":{\"accessToken\":\"AT-bllLYOOYASck11SBSDmmHs85lCrkN6Gi\",\"tokenType\":\"bearer\",\"expiresIn\":7200,\"refreshToken\":\"RT-HqvaDuSxEqayM75U2ukTRnBl6f6fiRAc\"}}\n~~~\n\n**Note**:\nAccess Token will become invalid in the following scenarios and require re-authentication:\n\n1. Open API application deletion\n2. Controller deletion\n3. Controller restoration\n4. MSP mode disabling\n5. MSP mode enabling\n6. Open API application modification\n7. Token expiration\n\n\n### 2.2.3 Access API Interface\n\nAfter obtaining access token, it will be used to access API interfaces.\n\n-   In the **Header**, fill in the access token. Note prefix of the access token in the Authorization header is **\"AccessToken=\"** .\n\nOther parameters can be filled in according to the description in the online document\n\nAn example of the curl command of the **get site list interface** is as follows:  \n**Request:**\n~~~\ncurl \"https://localhost:8043/openapi/v1/de382a0e78f4deb681f3128c3e75dbd1/sites?pageSize=1&page=1\" -H 'content-type:application/json' -H 'Authorization:AccessToken=AT-RCio7FS9p46wSD7dM8CwNQA7ylcrmAcV' -X GET -i -k --insecure\n~~~\n**Response:**\n~~~\n{\"errorCode\":0,\"msg\":\"Success.\",\"result\":{\"totalRows\":1,\"currentPage\":1,\"currentSize\":1,\"data\":[{\"siteId\":\"640effd1b3f2ae5b912275ec\",\"name\":\"323233232\",\"region\":\"China mainland\",\"timeZone\":\"UTC\",\"scenario\":\"Hotel\",\"type\":0}]}}\n~~~\n\n\n### 2.2.4 Refresh Access Token\n\nCurrently, the **access token** is valid for **2 hours**, and the **refresh token** is valid for **14 days**. If the access token expires, you can use the **refresh token** interface to obtain a new access token. The refresh access token interface uses the **POST** method, the interface path is as follows: **/openapi/authorize/token**. If the refresh token also expires, you will need to go through the previous authentication process again.\n\n-   In the **Query**, fill in the **grant type**(The field name is **grant_type**), **refresh token**(The field name is **refresh_token**). The grant type indicate the authentication method, and the refresh token needs to be filled in with \"**refresh_token**\"\n-   In the **Body**, fill in the **client ID**(the field name is **client_id**) and **client secret**(the field name is **client_secret**).\n\nAn example of the curl command of the **refresh token** interface is as follows:\n**Request:**\n~~~\ncurl \"https://localhost:8043/openapi/authorize/token?client_id=185586e0df424f5ea938de13cba91e01&client_secret=767372a5258a4fc1a03c57f3d071fc35&refresh_token=RT-AhzwqCenDCZ84qpBHnZhYs3j2RGw9q8E&grant_type=refresh_token\" -H 'content-type:application/json' -X POST -i -k --insecure\n~~~\n**Response:**\n~~~\n{\"errorCode\":0,\"msg\":\"Open API Get Access Token successfully.\",\"result\":{\"accessToken\":\"AT-w9veJNQlaK8dH08qEQZCTas6y70IRAii\",\"tokenType\":\"bearer\",\"expiresIn\":7001,\"refreshToken\":\"RT-AhzwqCenDCZ84qpBHnZhYs3j2RGw9q8E\"}}\n~~~\n**Note:** A refresh token can be used only once within its validity period. After you use the refresh token to refresh the access token, the current refresh token will become invalid and the interface response will return a new valid refresh token. Please update the refresh token for the next access token refresh.\n\n\n## 2.3 Client Credentials Mode Access Process\n\n### 2.3.1 Obtain Access Token\n\nThe client credentials mode can directly obtain the access token without the need to **obtain the authorization code**.\n\n-   In the **Query**, fill in the **grant type**(the field name is **grant_type**). The grant type indicate the authentication method, and the client credentials code needs to be filled in with \"**client_credentials**\"\n-   In the **Body**, fill in the **msp id** or **customer id**(The field name is **omadacId**), **client ID**(the field name is **client_id**) and **client secret**(the field name is **client_secret**).\n\nAn example of the curl command of the **obtaining access token** interface is as follows:\n**Request:**\n~~~\ncurl \"https://localhost:8043/openapi/authorize/token?grant_type=client_credentials\" -H 'content-type:application/json' -d '{\"omadacId\": \"de382a0e78f4deb681f3128c3e75dbd1\", \"client_id\": \"185586e0df424f5ea938de13cba91e01\", \"client_secret\": \"767372a5258a4fc1a03c57f3d071fc35\"}' -X POST -i -k --insecure\n~~~\n**Response:**\n~~~\n{\"errorCode\":0,\"msg\":\"Open API Get Access Token successfully.\",\"result\":{\"accessToken\":\"AT-bjaJkIMIiekZY6NBufoQO4hdmJTswlwU\",\"tokenType\":\"bearer\",\"expiresIn\":7200,\"refreshToken\":\"RT-3ZjJgcORJSh76UCh7pj0rs5VRISIpagV\"}}\n~~~\n\n**Note**: After obtaining the token, if you copy or import sites, or change application permission-related parameters (such as role/site/customer privilege) in the controller, the original token will become invalid and you need to authorize it again.\n\n### 2.3.2 Access API Interface\n\nThis step is the same as the authorization code mode.\n\n### 2.3.3 Refresh Access Token\n\nThis step is the same as the authorization code mode.\n\n## 2.4 Batch Processing OpenAPIs\n\nYou can process up to 20 other OpenAPIs through the OpenAPI **Batch Processing OpenAPIs**, excluding MSP OpenAPIs. All processing should use the same omadacId.\n\nIn MSP mode, You can process up to 20 other OpenAPIs through the OpenAPI **Batch Processing MSP OpenAPIs**. For dealing with MSP OpenAPIs, the same mspId should be used. For dealing with other non MSP OpenAPIs, the corresponding customerId should be used.\n\n# 3 Domain Name (Dedicated to CBC)\n\n## 3.1 Front-end Login Domain Name\nSingapore：[aps1-omada-controller.tplinkcloud.com](https://aps1-omada-controller.tplinkcloud.com/)  \nEurope：[euw1-omada-controller.tplinkcloud.com](https://euw1-omada-controller.tplinkcloud.com/)  \nUS：[use1-omada-controller.tplinkcloud.com](https://use1-omada-controller.tplinkcloud.com/)\n\n**Note**: If you don't know your service area, find the domain name as follows: go to **Settings > Platform Integration > Open API**, find your application and click the View button to check the **Oauth Login Page Address**.\n\n## 3.2 Rest API Domain Name\nSingapore：[aps1-omada-northbound.tplinkcloud.com](https://aps1-omada-northbound.tplinkcloud.com/)  \nEurope：[euw1-omada-northbound.tplinkcloud.com](https://euw1-omada-northbound.tplinkcloud.com/)  \nUS：[use1-omada-northbound.tplinkcloud.com](https://use1-omada-northbound.tplinkcloud.com/)\n\n**Note**: If you don't know your service area, find the domain name as follows: go to **Settings > Platform Integration > Open API**, find your application and click the View button to check the **Interface Access Address**.\n\n# 4 Domain Name (Dedicated to local)\n\n## 4.1 Front-end Login Domain Name\nFind the domain name as follows: go to **Settings > Platform Integration > Open API**, find your application and click the View button to check the **Oauth Login Page Address**.\n\n## 4.2 Rest API Domain Name\nFind the domain name as follows: go to **Settings > Platform Integration > Open API**, find your application and click the View button to check the **Interface Access Address**.\n\n# 5 Appendix\n\n## 5.1 Time Zone\nSome interfaces may require Time Zone. The table below lists the Time Zone values of the controller.\n\n| **Time Zone** |\n| ------- |\n| **Pacific/Wake** |\n| **Pacific/Midway** |\n| **Pacific/Honolulu** |\n| **America/Anchorage** |\n| **America/Los_Angeles** |\n| **America/Phoenix** |\n| **America/Chihuahua** |\n| **America/Denver** |\n| **America/Tegucigalpa** |\n| **America/Chicago** |\n| **America/Mexico_City** |\n| **Canada/Saskatchewan** |\n| **America/Bogota** |\n| **America/New_York** |\n| **America/Indiana/Indianapolis** |\n| **America/Caracas** |\n| **America/Asuncion** |\n| **America/Halifax** |\n| **America/Cuiaba** |\n| **America/La_Paz** |\n| **Canada/Newfoundland** |\n| **America/Sao_Paulo** |\n| **America/Buenos_Aires** |\n| **America/Cayenne** |\n| **America/Godthab** |\n| **America/Montevideo** |\n| **America/Santiago** |\n| **Atlantic/South_Georgia** |\n| **Atlantic/Azores** |\n| **Atlantic/Cape_Verde** |\n| **Africa/Casablanca** |\n| **UTC** |\n| **Europe/London** |\n| **Atlantic/Reykjavik** |\n| **Europe/Amsterdam** |\n| **Europe/Belgrade** |\n| **Europe/Brussels** |\n| **Europe/Sarajevo** |\n| **Africa/Algiers** |\n| **Europe/Athens** |\n| **Asia/Beirut** |\n| **Africa/Cairo** |\n| **Asia/Damascus** |\n| **Africa/Harare** |\n| **Europe/Vilnius** |\n| **Asia/Jerusalem** |\n| **Asia/Amman** |\n| **Asia/Baghdad** |\n| **Europe/Minsk** |\n| **Asia/Kuwait** |\n| **Africa/Nairobi** |\n| **Asia/Istanbul** |\n| **Asia/Tehran** |\n| **Asia/Muscat** |\n| **Asia/Baku** |\n| **Europe/Moscow** |\n| **Asia/Tbilisi** |\n| **Asia/Yerevan** |\n| **Asia/Kabul** |\n| **Asia/Karachi** |\n| **Asia/Yekaterinburg** |\n| **Asia/Tashkent** |\n| **Asia/Kolkata** |\n| **Asia/Colombo** |\n| **Asia/Katmandu** |\n| **Asia/Dhaka** |\n| **Asia/Rangoon** |\n| **Asia/Bangkok** |\n| **Asia/Novosibirsk** |\n| **Asia/Hong_Kong** |\n| **Asia/Krasnoyarsk** |\n| **Asia/Kuala_Lumpur** |\n| **Australia/Perth** |\n| **Asia/Taipei** |\n| **Asia/Ulaanbaatar** |\n| **Asia/Irkutsk** |\n| **Asia/Tokyo** |\n| **Asia/Seoul** |\n| **Australia/Adelaide** |\n| **Australia/Darwin** |\n| **Australia/Brisbane** |\n| **Australia/Canberra** |\n| **Pacific/Guam** |\n| **Australia/Hobart** |\n| **Asia/Yakutsk** |\n| **Pacific/Noumea** |\n| **Asia/Vladivostok** |\n| **Pacific/Auckland** |\n| **Pacific/Fiji** |\n| **Asia/Magadan** |\n| **Asia/Kamchatka** |\n| **Pacific/Tongatapu** |\n\n## 5.2 Audit Log\n\n### 5.2.1 Audit Log Notification\nSome interfaces may require Audit Log Notification Category Key. The tables below lists the Audit Log Notification Category Key of the controller.\n\n#### 5.2.1.1 Msp Level\n| **Audit Log Notification Category Key** |\n| ------- |\n| **ACCOUNT** |\n| **BACKUP** |\n| **CLOUD_ACCESS** |\n| **DASHBOARD** |\n| **DATA_EXPORT** |\n| **DEVICE_MANAGEMENT** |\n| **LICENSE** |\n| **LOG** |\n| **MSP_SETTINGS** |\n| **RESTORE** |\n| **SITE_MANAGEMENT** |\n| **SYSTEM_SETTINGS** |\n| **USER_INTERFACE** |\n| **WEBHOOK_SETTINGS** |\n\n#### 5.2.1.2 Global/Customer Level\n| **Audit Log Notification Category Key** |\n| ------- |\n| **ACCOUNT** |\n| **BACKUP** |\n| **CLOUD_ACCESS** |\n| **CONTROLLER_SETTINGS** |\n| **DATA_EXPORT** |\n| **IPS** |\n| **LICENSE** |\n| **LOG** |\n| **MIGRATION** |\n| **RESTORE** |\n| **SITE_MANAGEMENT** |\n| **SYSTEM_SETTINGS** |\n| **USER_ACTIVITY** |\n| **USER_INTERFACE** |\n| **WEBHOOK_SETTINGS** |\n\n#### 5.2.1.3 Site Level\n| **Audit Log Notification Category Key** |\n| ------- |\n| **ABNORMAL** |\n| **APPLICATION_CONTROL** |\n| **AUTHENTICATION** |\n| **CLI** |\n| **CLIENTS** |\n| **DASHBOARD** |\n| **DEVICE_MANAGEMENT** |\n| **HOTSPOT_MANAGER** |\n| **INSIGHT** |\n| **IPS** |\n| **LOG** |\n| **MAP** |\n| **NETWORK_SECURITY** |\n| **PROFILES** |\n| **REPORT** |\n| **SIM** |\n| **SITE_SERVICES** |\n| **SITE_SETTINGS** |\n| **TOOLS** |\n| **TRANSMISSION** |\n| **VPN** |\n| **WIRED_NETWORKS** |\n| **WIRELESS_NETWORKS** |\n\n\n### 5.2.2 Audit Log Type\nSome interfaces may require Audit Log Type. The tables below lists the Audit Log Type of the controller.\n\n#### 5.2.1.1 Msp Level\n| **Audit Log Type** |\n| ------- |\n| **Account** |\n| **Backup** |\n| **Cloud Access** |\n| **Dashboard** |\n| **Data Export** |\n| **Device Management** |\n| **License** |\n| **Log** |\n| **MSP Settings** |\n| **Restore** |\n| **Site Management** |\n| **System Settings** |\n| **User Interface** |\n| **Webhook Settings** |\n\n#### 5.2.1.2 Global/Customer Level\n| **Audit Log Type** |\n| ------- |\n| **Account** |\n| **Backup** |\n| **Cloud Access** |\n| **Controller Settings** |\n| **Data Export** |\n| **IPS** |\n| **License** |\n| **Log** |\n| **Migration** |\n| **Restore** |\n| **Site Management** |\n| **System Settings** |\n| **User Activity** |\n| **User Interface** |\n| **Webhook Settings** |\n\n#### 5.2.1.3 Site Level\n| **Audit Log Type** |\n| ------- |\n| **Abnormal** |\n| **Application Control** |\n| **Authentication** |\n| **CLI** |\n| **Clients** |\n| **Dashboard** |\n| **Device Management** |\n| **Hotspot Manager** |\n| **IPS** |\n| **Insight** |\n| **Log** |\n| **Map** |\n| **Network Security** |\n| **Profiles** |\n| **Report** |\n| **SIM** |\n| **Site Services** |\n| **Site Settings** |\n| **Tools** |\n| **Transmission** |\n| **VPN** |\n| **Wired Networks** |\n| **Wireless Networks** |\n\n## 5.3 Webhook\n### 5.3.1 Webhook Message Template\nThe template of webhook message is as follows.\n\n```json\n{\n  \"Site\": \" site-name (Only the site-level log will have this field) \", \n  \"description\": \"This is a webhook message from Omada Controller\",\n  \"shardSecret\": \"shard secret of webhook\",\n  \"text\": [\n    \"content of audit log\"\n  ],\n  \"Controller\": \"USA-Toast\",\n  \"timestamp\": 1692128478856\n}\n```\n## 5.4 Country\n### 5.4.1 Country Template\n| **Country Name/Country Code/Calling Code** |\n| ------- |\n| **Afghanistan/AF/+93** |\n| **Albania/AL/+355** |\n| **Algeria/DZ/+213** |\n| **Angola/AO/+244** |\n| **Anguilla/AI/+1264** |\n| **Antigua and Barbuda/AG/+1268** |\n| **Argentina/AR/+54** |\n| **Armenia/AM/+374** |\n| **Aruba/AW/+297** |\n| **Australia/AU/+61** |\n| **Austria/AT/+43** |\n| **Azerbaijan/AZ/+994** |\n| **Bahamas/BS/+1242** |\n| **Bahrain/BH/+973** |\n| **Bangladesh/BD/+880** |\n| **Barbados/BB/+1246** |\n| **Belarus/BY/+375** |\n| **Belgium/BE/+32** |\n| **Belize/BZ/+501** |\n| **Benin/BJ/+229** |\n| **Bermuda/BM/+1441** |\n| **Bhutan/BT/+975** |\n| **Bolivia/BO/+591** |\n| **Botswana/BW/+267** |\n| **Brazil/BR/+55** |\n| **Brunei/BN/+673** |\n| **Burkina Faso/BF/+226** |\n| **Burundi/BI/+257** |\n| **Cabo Verde/CV/+238** |\n| **Cambodia/KH/+855** |\n| **Cameroon/CM/+237** |\n| **Canada/CA/+1** |\n| **Cayman Islands/KY/+1345** |\n| **Central African Republic/CF/+236** |\n| **Chad/TD/+235** |\n| **Chile/CL/+56** |\n| **China/CN/+86** |\n| **Christmas Island/CX/+618** |\n| **Christmas Island/CX/+61** |\n| **Colombia/CO/+57** |\n| **Comoros/KM/+269** |\n| **Congo (Democratic Republic)/CD/+243** |\n| **Congo (Republic)/CG/+242** |\n| **Costa Rica/CR/+506** |\n| **Côte d'Ivoire/CI/+225** |\n| **Croatia/HR/+385** |\n| **Cuba/CU/+53** |\n| **Cyprus/CY/+357** |\n| **Czech Republic/CZ/+420** |\n| **Denmark/DK/+45** |\n| **Djibouti/DJ/+253** |\n| **Dominica/DM/+1767** |\n| **Dominican Republic/DO/+1809** |\n| **Dominican Republic/DO/+1829** |\n| **Dominican Republic/DO/+1849** |\n| **Ecuador/EC/+593** |\n| **Egypt/EG/+20** |\n| **Equatorial Guinea/GQ/+240** |\n| **Eritrea/ER/+291** |\n| **Estonia/EE/+372** |\n| **Ethiopia/ET/+251** |\n| **Falkland Islands/FK/+500** |\n| **Fiji/FJ/+679** |\n| **Finland/FI/+358** |\n| **France/FR/+33** |\n| **French Guiana/GF/+594** |\n| **French Polynesia/PF/+689** |\n| **Gabon/GA/+241** |\n| **Gambia/GM/+220** |\n| **Georgia/GE/+995** |\n| **Germany/DE/+49** |\n| **Ghana/GH/+233** |\n| **Greece/GR/+30** |\n| **Greenland/GL/+299** |\n| **Grenada/GD/+1473** |\n| **Guam/GU/+1** |\n| **Guatemala/GT/+502** |\n| **Guinea/GN/+224** |\n| **Guinea-Bissau/GW/+245** |\n| **Guyana/GY/+592** |\n| **Haiti/HT/+509** |\n| **Honduras/HN/+504** |\n| **Hong Kong/HK/+852** |\n| **Hungary/HU/+36** |\n| **Iceland/IS/+354** |\n| **India/IN/+91** |\n| **Indonesia/ID/+62** |\n| **Iran/IR/+98** |\n| **Iraq/IQ/+964** |\n| **Ireland/IE/+353** |\n| **Israel/IL/+972** |\n| **Italy/IT/+39** |\n| **Jamaica/JM/+876** |\n| **Japan/JP/+81** |\n| **Jordan/JO/+962** |\n| **Kazakhstan/KZ/+7** |\n| **Kenya/KE/+254** |\n| **Kiribati/KI/+686** |\n| **South Korea/KR/+82** |\n| **Kuwait/KW/+965** |\n| **Kyrgyzstan/KG/+996** |\n| **Laos/LA/+856** |\n| **Latvia/LV/+371** |\n| **Lebanon/LB/+961** |\n| **Lesotho/LS/+266** |\n| **Liberia/LR/+231** |\n| **Libya/LY/+218** |\n| **Liechtenstein/LI/+423** |\n| **Lithuania/LT/+370** |\n| **Luxembourg/LU/+352** |\n| **Macau/MO/+853** |\n| **North Macedonia/MK/+389** |\n| **Madagascar/MG/+261** |\n| **Malawi/MW/+265** |\n| **Malaysia/MY/+60** |\n| **Maldives/MV/+960** |\n| **Mali/ML/+223** |\n| **Malta/MT/+356** |\n| **Marshall Islands/MH/+692** |\n| **Mauritania/MR/+222** |\n| **Mauritius/MU/+230** |\n| **Mexico/MX/+52** |\n| **Micronesia/FM/+691** |\n| **Moldova/MD/+373** |\n| **Monaco/MC/+377** |\n| **Mongolia/MN/+976** |\n| **Montenegro/ME/+382** |\n| **Morocco/MA/+212** |\n| **Mozambique/MZ/+258** |\n| **Myanmar/MM/+95** |\n| **Namibia/NA/+264** |\n| **Nauru/NR/+674** |\n| **Nepal/NP/+977** |\n| **Netherlands/NL/+31** |\n| **Netherlands Antilles/AN/+599** |\n| **New Caledonia/NC/+687** |\n| **New Zealand/NZ/+64** |\n| **Nicaragua/NI/+505** |\n| **Niger/NE/+227** |\n| **Nigeria/NG/+234** |\n| **Niue/NU/+683** |\n| **North Korea/KP/+850** |\n| **Norway/NO/+47** |\n| **Oman/OM/+968** |\n| **Pakistan/PK/+92** |\n| **Palau/PW/+680** |\n| **Palestine/PS/+970** |\n| **Panama/PA/+507** |\n| **Papua New Guinea/PG/+675** |\n| **Paraguay/PY/+595** |\n| **Peru/PE/+51** |\n| **Philippines/PH/+63** |\n| **Pitcairn Islands/PN/+64** |\n| **Poland/PL/+48** |\n| **Portugal/PT/+351** |\n| **Puerto Rico/PR/+1787** |\n| **Puerto Rico/PR/+1939** |\n| **Qatar/QA/+974** |\n| **Romania/RO/+40** |\n| **Russia/RU/+7** |\n| **Rwanda/RW/+250** |\n| **Saint Kitts and Nevis/KN/+1869** |\n| **Saint Lucia/LC/+1758** |\n| **Saint Vincent and the Grenadines/VC/+1784** |\n| **Saint Martin (Dutch part)/MF/+1721** |\n| **El Salvador/SV/+503** |\n| **Samoa/WS/+685** |\n| **San Marino/SM/+378** |\n| **Sao Tome and Principe/ST/+239** |\n| **Saudi Arabia/SA/+966** |\n| **Senegal/SN/+221** |\n| **Serbia/RS/+381** |\n| **Seychelles/SC/+248** |\n| **Sierra Leone/SL/+232** |\n| **Singapore/SG/+65** |\n| **Slovakia/SK/+421** |\n| **Slovenia/SI/+386** |\n| **Solomon Islands/SB/+677** |\n| **Somalia/SO/+252** |\n| **South Africa/ZA/+27** |\n| **South Sudan/SS/+211** |\n| **Spain/ES/+34** |\n| **Sri Lanka/LK/+94** |\n| **Sudan/SD/+249** |\n| **Suriname/SR/+597** |\n| **Eswatini (Swaziland)/SZ/+268** |\n| **Sweden/SE/+46** |\n| **Switzerland/CH/+41** |\n| **Syria/SY/+963** |\n| **Taiwan/TW/+886** |\n| **Tajikistan/TJ/+992** |\n| **Tanzania/TZ/+255** |\n| **Thailand/TH/+66** |\n| **Cook Islands/CK/+682** |\n| **Turks and Caicos Islands/TC/+1649** |\n| **United States Virgin Islands/VI/+1340** |\n| **Timor-Leste/TL/+670** |\n| **Togo/TG/+228** |\n| **Tokelau/TK/+690** |\n| **Tonga/TO/+676** |\n| **Trinidad and Tobago/TT/+1868** |\n| **Tunisia/TN/+216** |\n| **Turkey/TR/+90** |\n| **Turkmenistan/TM/+993** |\n| **Tuvalu/TV/+688** |\n| **Uganda/UG/+256** |\n| **Ukraine/UA/+380** |\n| **United Arab Emirates/AE/+971** |\n| **United Kingdom/GB/+44** |\n| **United States/US/+1** |\n| **Uruguay/UY/+598** |\n| **Uzbekistan/UZ/+998** |\n| **Vanuatu/VU/+678** |\n| **Vatican City/VA/+379** |\n| **Venezuela/VE/+58** |\n| **Vietnam/VN/+84** |\n| **Yemen/YE/+967** |\n| **Zambia/ZM/+260** |\n| **Zimbabwe/ZW/+263** |\n\n### 5.4.2 Currency Short Code\n| Currency Short Code | Currency Full Name | Code Number |\n|---------------------|--------------------|-------------|\n| **AUD**             | Australian Dollar  | 36          |\n| **BIF**             | Burundi Franc      | 108         |\n| **BRL**             | Brazilian Real     | 986         |\n| **CAD**             | Canadian Dollar    | 124         |\n| **CHF**             | Swiss Franc        | 756         |\n| **CLP**             | Chilean Peso       | 152         |\n| **CNY**             | Yuan Renminbi      | 156         |\n| **CZK**             | Czech Koruna       | 203         |\n| **DJF**             | Djibouti Franc     | 262         |\n| **DKK**             | Danish Krone       | 208         |\n| **EUR**             | Euro               | 978         |\n| **GBP**             | Pound Sterling     | 826         |\n| **GNF**             | Guinean Franc      | 324         |\n| **HKD**             | Hong Kong Dollar   | 344         |\n| **HUF**             | Forint             | 348         |\n| **ILS**             | New Israeli Sheqel | 376         |\n| **INR**             | Indian Rupee       | 356         |\n| **JPY**             | Yen                | 392         |\n| **KMF**             | Comorian Franc     | 174         |\n| **KRW**             | Won                | 410         |\n| **MGA**             | Malagasy Ariary    | 969         |\n| **MXN**             | Mexican Peso       | 484         |\n| **MYR**             | Malaysian Ringgit  | 458         |\n| **NOK**             | Norwegian Krone    | 578         |\n| **NZD**             | New Zealand Dollar | 554         |\n| **PHP**             | Philippine Peso    | 608         |\n| **PLN**             | Zloty              | 985         |\n| **PYG**             | Guarani            | 600         |\n| **RUB**             | Russian Ruble      | 643         |\n| **RWF**             | Rwanda Franc       | 646         |\n| **SEK**             | Swedish Krona      | 752         |\n| **SGD**             | Singapore Dollar   | 702         |\n| **THB**             | Baht               | 764         |\n| **TWD**             | New Taiwan Dollar  | 901         |\n| **UGX**             | Uganda Shilling    | 800         |\n| **USD**             | US Dollar          | 840         |\n| **VND**             | Dong               | 704         |\n| **VUV**             | Vatu               | 548         |\n| **XAF**             | CFA Franc BEAC     | 950         |\n| **XOF**             | CFA Franc BCEAO    | 952         |\n| **XPF**             | CFP Franc          | 953         |\n\n## 5.5 Protocol\n### 5.5.1 ACL Protocol Template\n\n| **ACL Protocol**    | Code Integer |\n|---------------------|:-------------|\n| **ICMP**            | 1            |\n| **IGMP**            | 2            |\n| **GGP**             | 3            |\n| **IP/IPENCAP**      | 4            |\n| **ST**              | 5            |\n| **TCP**             | 6            |\n| **EGP**             | 8            |\n| **IGP**             | 9            |\n| **PUP**             | 12           |\n| **UDP**             | 17           |\n| **HMP**             | 20           |\n| **XNS-IDP**         | 22           |\n| **RDP**             | 27           |\n| **ISO-TP4**         | 29           |\n| **DCCP**            | 33           |\n| **XTP**             | 36           |\n| **DDP**             | 37           |\n| **IDRP-CMTP**       | 38           |\n| **IDRP**            | 45           |\n| **RSVP**            | 46           |\n| **GRE**             | 47           |\n| **ESP**             | 50           |\n| **AH**              | 51           |\n| **SKIP**            | 57           |\n| **VMTP**            | 81           |\n| **EIGRP**           | 88           |\n| **OSPF**            | 89           |\n| **AX.25**           | 93           |\n| **IPIP**            | 94           |\n| **EtherIP**         | 97           |\n| **ENCAP**           | 98           |\n| **PIM**             | 103          |\n| **IPComp**          | 108          |\n| **VRRP**            | 112          |\n| **L2TP**            | 115          |\n| **IS-IS**           | 124          |\n| **SCTP**            | 132          |\n| **FC**              | 133          |\n| **Mobility Header** | 135          |\n| **UDP-Lite**        | 136          |\n| **MPLS-in-IP**      | 137          |\n| **MANET**           | 138          |\n| **HIP**             | 139          |\n| **Shim6**           | 140          |\n| **WESP**            | 141          |\n| **ROHC**            | 142          |\n| **ALL**             | 256          |\n\n### 5.5.2 Routing Protocol Template\n| **Routing Protocol** | Code Integer |\n|----------------------|:-------------|\n| **ICMP**             | 1            |\n| **GGP**              | 3            |\n| **IP**               | 4            |\n| **ST**               | 5            |\n| **TCP**              | 6            |\n| **EGP**              | 8            |\n| **IGP**              | 9            |\n| **PUP**              | 12           |\n| **UDP**              | 17           |\n| **HMP**              | 20           |\n| **XNS-IDP**          | 22           |\n| **RDP**              | 27           |\n| **ISO-TP4**          | 29           |\n| **DCCP**             | 33           |\n| **XTP**              | 36           |\n| **DDP**              | 37           |\n| **IDRP-CMTP**        | 38           |\n| **IDRP**             | 45           |\n| **RSVP**             | 46           |\n| **GRE**              | 47           |\n| **ESP**              | 50           |\n| **AH**               | 51           |\n| **SKIP**             | 57           |\n| **VMTP**             | 81           |\n| **EIGRP**            | 88           |\n| **OSPF**             | 89           |\n| **AX.25**            | 93           |\n| **IPIP**             | 94           |\n| **EtherIP**          | 97           |\n| **ENCAP**            | 98           |\n| **PIM**              | 103          |\n| **IPComp**           | 108          |\n| **VRRP**             | 112          |\n| **L2TP**             | 115          |\n| **IS-IS**            | 124          |\n| **SCTP**             | 132          |\n| **FC**               | 133          |\n| **Mobility Header**  | 135          |\n| **UDP-Lite**         | 136          |\n| **MPLS-in-IP**       | 137          |\n| **MANET**            | 138          |\n| **HIP**              | 139          |\n| **Shim6**            | 140          |\n| **WESP**             | 141          |\n| **ROHC**             | 142          |\n| **VOIP**             | 255          |\n| **ALL**              | 256          |\n\n## 5.6 Log\n\n### 5.6.1 Log Notification Key\nSome interfaces may require Log Notification Key. The tables below lists the Log Notification Key of the controller.\n\n#### 5.6.1.1 Msp Level\n| **Module** | **Log Notification Key** | **Log Notification Name** | **Pro** | **Non-Pro** | **Restriction** |\n| ----- | ----- | ----- | -----  | ----- | ----- |\n| Operation | LOGIN_OK | User Logged In | No Support | Support | -- |\n| Operation | LOGIN_FL | User Login Failed | No Support | Support | -- |\n| Operation | MSP_DEV_MOVED_OK | Device Moved to another Customer | No Support | Support | -- |\n| Operation | MSP_DEV_MOVED_FL | Device Move to another Customer Failed | No Support | Support | -- |\n| System | RO_O_SS | Running Out Of Storage Space | Support | Support | No Support on CBC |\n| System | MSP_LOG_MAIL_OK | MSP Logs Mailed Automatically | Support | Support | -- |\n| System | MSP_LOG_MAIL_FL | Automatic MSP Logs Mail Failed | Support | Support | -- |\n| System | MSP_LOG_SRV_OK | MSP Logs Sent to Log Server | Support | Support | -- |\n| System | MSP_LOG_SRV_FL | Sending MSP Logs to Log Server Failed | Support | Support | -- |\n| Device | DEV_DISCOVER | Device Discovered | Support | Support | -- |\n| System | MNG_PORT_C | Controller Access Port Changed | Support | Support | No Support on CBC |\n| System | PRT_PORT_C | Portal Port Changed | Support | Support | No Support on CBC |\n| System | CONNECTED_CLOUD_ACCESS_SUCCESS | Cloud Access Success | Support | Support | No Support on CBC |\n| System | CLOUD_ACCESS_CONNECTION_FAILED | Network Disconnection | Support | Support | No Support on CBC |\n| System | CLOSE_CLOUD_ACCESS_SUCCESS | Cloud Access Closed | Support | Support | No Support on CBC |\n\n#### 5.6.1.2 Global Level\n| **Module** | **Log Notification Key** | **Log Notification Name** | **Pro** | **Non-Pro** | **On Customer Level** | **Restriction** |\n| ----- | ----- | ----- | -----  | ----- | ----- | ----- |\n| Operation | LOGIN_OK | User Logged In | No Support | Support | No Support | -- |\n| Operation | LOGIN_FL | User Login Failed | No Support | Support | No Support | -- |\n| Operation | HS_LOGIN_OK | Hotspot Operator Logged In | No Support | Support | Support | -- |\n| Operation | HS_LOGIN_FL | Hotspot Operator Login Failed | No Support | Support | Support | -- |\n| Operation | SITE_ADD | Site Created | No Support | Support | Support | -- |\n| Operation | SITE_MIGR | Site Migrated | No Support | Support | Support | -- |\n| System | AUTO_BK_OK | Auto Backup Executed | Support | Support | Support | -- |\n| System | AUTO_BK_FL | Auto Backup Failed | Support | Support | Support | -- |\n| System | RO_O_SS | Running Out Of Storage Space | Support | Support | No Support | No Support on CBC |\n| System | GLOBAL_LOG_MAIL_OK | Global Logs Mailed Automatically | Support | Support | Support | -- |\n| System | GLOBAL_LOG_MAIL_FL | Automatic Global Logs Mail Failed | Support | Support | Support | -- |\n| System | DEVICE_LIST_MAIL_FL | Device List Schedule Mail Failed | Support | Support | Support | -- |\n| System | NETWORK_CHECK_MAIL_FL | Network check Mail Failed | Support | Support | Support | Only Support on OC |\n| System | DEVICE_LIST_SCHEDULE_EXECUTED | Device List Schedule Executed | Support | Support | Support | -- |\n| System | GLOBAL_LOG_SRV_OK | Global Logs Sent to Log Server | Support | Support | Support | -- |\n| System | GLOBAL_LOG_SRV_FL | Sending Global Logs to Log Server Failed | Support | Support | Support | -- |\n| Device | DEV_DISCOVER | Device Discovered | Support | Support | Support | -- |\n| System | MNG_PORT_C | Controller Access Port Changed | Support | Support | No Support | No Support on CBC |\n| System | PRT_PORT_C | Portal Port Changed | Support | Support | No Support | No Support on CBC |\n| System | LOG_FULL | Log Full | Support | Support | Support | Only Support on OC |\n| System | EMAIL_LIMIT_REACHED | Email Limit Reached | Support | Support | Support | -- |\n| System | CONNECTED_CLOUD_ACCESS_SUCCESS | Cloud Access Success | Support | Support | Support | No Support on CBC |\n| System | CLOUD_ACCESS_CONNECTION_FAILED | Network Disconnection | Support | Support | Support | No Support on CBC |\n| System | CLOSE_CLOUD_ACCESS_SUCCESS | Cloud Access Closed | Support | Support | Support | No Support on CBC |\n\n#### 5.6.1.3 Site Level\n| **Module** | **Log Notification Key** | **Log Notification Name** | **Pro Controller** | **Non-Pro Controller** | **Restriction** |\n| ----- | ----- | ----- | -----  | ----- | ----- |\n| Operation | ADV_FEA_EN | Advanced Features Enabled | No Support | Support | -- |\n| Operation | MVLAN_CH | Management VLAN Changed | No Support | Support | -- |\n| Operation | VOCH_ADD | Voucher Created | No Support | Support | -- |\n| Operation | VOCH_DEL | Voucher Deleted | No Support | Support | -- |\n| Operation | FORM_ADD | Form Auth Created | No Support | Support | -- |\n| Operation | FORM_DEL | Form Auth Deleted | No Support | Support | -- |\n| Operation | AP_ROLL_UP | Rolling Upgrade Triggered | No Support | Support | -- |\n| Operation | DEV_ADOPT_OK | Device Adopted | No Support | Support | -- |\n| Operation | DEV_ADOPT_FL | Device Adoption Failed | No Support | Support | -- |\n| Operation | DEV_ADOPT_BATCH | Device Adoption in Batch | No Support | Support | -- |\n| Operation | DEV_REBOOT | Device Rebooted | No Support | Support | -- |\n| Operation | DEV_REBOOT_FL | Device Reboot Failed | No Support | Support | -- |\n| Operation | DEV_FORGET_OK | Device Forgotten | No Support | Support | -- |\n| Operation | DEV_FORGET_FL | Device Forgotten Failed | No Support | Support | -- |\n| Operation | STACK_FORGET_OK | Switch Stack Forgotten | No Support | Support | -- |\n| Operation | STACK_FORGET_FL | Switch Stack Forgotten Failed | No Support | Support | -- |\n| Operation | STACK_OPT | Switch Stack Created/ Deleted | No Support | Support | -- |\n| Operation | DEV_FORGET_BATCH | Device Forgotten in Batch | No Support | Support | -- |\n| Operation | DEV_MOVED_OK | Device Moved | No Support | Support | -- |\n| Operation | DEV_MOVED_FL | Device Move Failed | No Support | Support | -- |\n| Operation | WLAN_OPT | WLAN Group Added/ Deleted | No Support | Support | -- |\n| Operation | SSID_OPT | Wireless Network Created/Deleted | No Support | Support | -- |\n| Operation | DEV_MAN_UP_OK | Device Upgraded Manually | No Support | Support | -- |\n| Operation | DEV_MAN_UP_FL | Device Manual Upgrade Failed | No Support | Support | -- |\n| Operation | STACK_MAN_UP_OK | Switch Stack Upgraded Manually | No Support | Support | -- |\n| Operation | STACK_MAN_UP_FL | Switch Stack Manual Upgrade Failed | No Support | Support | -- |\n| Operation | DEV_UP_CANCEL | Device Upgrade Cancelled | No Support | Support | -- |\n| Operation | C_BLOCK | Client Blocked | No Support | Support | -- |\n| Operation | C_UNBLOCK | Client Unblocked | No Support | Support | -- |\n| System | REBOOT_SC_OK | Reboot Schedule Executed | Support | Support | -- |\n| System | REBOOT_SC_FL | Reboot Schedule Execution Failed | Support | Support | -- |\n| System | POE_SC_OK | PoE Schedule Executed | Support | Support | -- |\n| System | POE_SC_FL | PoE Schedule Execution Failed | Support | Support | -- |\n| System | PORT_SC_OK | Port Schedule Executed | Support | Support | -- |\n| System | PORT_SC_FL | Port Schedule Execution Failed | Support | Support | -- |\n| System | LOG_MAIL_OK | Logs Mailed Automatically | Support | Support | -- |\n| System | LOG_MAIL_FL | Automatic Logs Mail Failed | Support | Support | -- |\n| System | SITE_DEVICE_LIST_MAIL_FL | Site Device List Schedule Mail Failed | Support | Support | -- |\n| System | SITE_NETWORK_CHECK_MAIL_FL | Site Network check Mail Failed | Support | Support | -- |\n| System | TERMINAL_MAIL_FL | Site Terminal Mail Failed | Support | Support | -- |\n| System | SITE_DEVICE_LIST_SCHEDULE_EXECUTED | Site Device List Schedule Executed | Support | Support | -- |\n| System | LOG_SRV_OK | Site Logs Sent to Log Server | Support | Support | -- |\n| System | LOG_SRV_FL | Sending Site Logs to Log Server Failed | Support | Support | -- |\n| Device | DEV_DISCONN | Device Disconnected | Support | Support | -- |\n| Device | DEV_CONN | Device Connected | Support | Support | -- |\n| Device | AP_ISOLATE | EAP Isolated | Support | Support | -- |\n| Device | DEV_IP_C | Device IP Changed | Support | Support | -- |\n| Device | AP_RADAR | EAP Detected Radar | Support | Support | -- |\n| Device | DEV_UP_OL_OK | Device Upgrade Online | No Support | Support | -- |\n| Device | DEV_UP_OL_FL | Device Upgrade Online Failed | No Support | Support | -- |\n| Device | STACK_UP_OL_OK | Switch Stack Upgrade Online | No Support | Support | -- |\n| Device | STACK_UP_OL_FL | Switch Stack Upgrade Online No Support | Support | Support | -- |\n| Device | DEV_READOPT_OK | Device Readopted Automatically | Support | Support | -- |\n| Device | DEV_READOPT_FL | Automatic Device Readopt Failed | Support | Support | -- |\n| Device | AP_CH_C | EAP Channel Changed | Support | Support | -- |\n| Device | OSG_WAN_UP | WAN is up | Support | Support | -- |\n| Device | OSG_WAN_DOWN | WAN is down | Support | Support | -- |\n| Device | OSG_BK_WAN_UP | Backup WAN Takes Effect | Support | Support | -- |\n| Device | OSG_PRI_WAN_UP | Primary WAN Recovered | Support | Support | -- |\n| Device | WAN_ONLINE_DETECTION | WAN Online Detection | Support | Support | -- |\n| Device | WAN_LINK_BACKUP | WAN Link Backup | Support | Support | -- |\n| Device | OSG_ATK | Gateway Detected Attack | Support | Support | -- |\n| Device | OSG_SF_ATK | Gateway Detected Stationary Flood Attack | Support | Support | -- |\n| Device | OSG_ARP_ATK | Gateway Detected ARP Conflicts | Support | Support | -- |\n| Device | OSW_DET_STORM | Switch Detected Storm | Support | Support | -- |\n| Device | OSW_DET_LOOP | Detected Loops | Support | Support | -- |\n| Device | OSW_PB | Port Blocked | Support | Support | -- |\n| Device | OSW_LOOP_C | Loop Cleared | Support | Support | -- |\n| Device | OSG_IPSEC_OK | IPsec Connection Established | Support | Support | -- |\n| Device | OSG_IPSEC_FL | IPsec Connection Disconnected | Support | Support | -- |\n| Device | OSG_IPSEC_FO | IPsec failover took effect | Support | Support | -- |\n| Device | OSG_C_VPN_OK | PPTP/L2TP Client Connected | Support | Support | -- |\n| Device | OSG_C_VPN_FL | PPTP/L2TP Client Connection Failed | Support | Support | -- |\n| Device | OSG_RC_VPN_OK | Remote PPTP/L2TP Client Connected | Support | Support | -- |\n| Device | OSG_RC_VPN_FL | Remote PPTP/L2TP Client Connection Failed | Support | Support | -- |\n| Device | OSG_RC_VPN_LO | Remote PPTP/L2TP Client Logged Out | Support | Support | -- |\n| Device | OSG_PPPOE_OK | PPPoE Connection Established | Support | Support | -- |\n| Device | OSG_PPPOE_FL | PPPoE Connection Failed | Support | Support | -- |\n| Device | OSW_TOPO_C | STP Topology Changed | Support | Support | -- |\n| Client | AP_C_FL | Client Connection Failed (Wireless) | Support | Support | -- |\n| Client | AP_C_OK | Client Online (Wireless) | Support | Support | -- |\n| Client | W_C_PRT_OK | Client Authenticated with Portal (Wireless) | Support | Support | -- |\n| Client | W_C_PRT_FL | Portal Authentication Failed (Wireless) | Support | Support | -- |\n| Client | W_C_PRT_EXP | Client Authentication Expired (Wireless) | Support | Support | -- |\n| Client | W_C_DISCONN | Client Offline (Wireless) | Support | Support | -- |\n| Client | W_C_ROAM | Client Roaming (Wireless) | Support | Support | -- |\n| Client | L_C_CONN | Client Online (Wired) | Support | Support | -- |\n| Client | L_C_PTR_OK | Client Authenticated with Portal (Wired) | Support | Support | -- |\n| Client | L_C_PTR_FL | Portal Authentication Failed (Wired) | Support | Support | -- |\n| Client | L_C_AUTH_EXP | Client Authenticated Expired (Wired) | Support | Support | -- |\n| Client | L_C_DISCONN | Client Offline (Wired) | Support | Support | -- |\n| Client | C_AUTH_OPT | Client Authorized/Unauthorized by Admin | Support | Support | -- |\n| Client | C_PRT_EXT | Client Authentication Extended by Admin | Support | Support | -- |\n| Client | OSW_C_1X_OK | Client Authenticated with 802.1X | Support | Support | -- |\n| Client | OSW_C_1X_FL | 802.1X Authentication Failed | Support | Support | -- |\n| Device | DEV_C_DSYNC | Device Configurations Desynchronized | Support | Support | -- |\n| Device | WAN_IP_O_F | WAN IP address Obtaining Failed | Support | Support | -- |\n| System | REPORT_GENERATION_FAILED | Report Generation Failed | Support | Support | -- |\n| System | REPORT_SENDING_FAILED | Report Sending Failed | Support | Support | -- |\n| System | REPORT_SCHEDULE_EXECUTED | Report Schedule Executed | Support | Support | -- |\n| Device | OSG_LARGE_PING_ATTACK | Large Ping Attack | Support | Support | -- |\n| Device | OSG_DDNS | Gateway DDNS Module Information | Support | Support | -- |\n| Device | OSG_IPSEC | Gateway IPsec Module Information | Support | Support | -- |\n| Device | OSG_IPV6 | Gateway IPv6 Module Information | Support | Support | -- |\n| Device | OSG_PPP | Gateway PPP Module Information | Support | Support | -- |\n| Device | OSG_PPPOE | Gateway PPPoE Module Information | Support | Support | -- |\n| Device | OSG_SSL_VPN | Gateway SSL VPN Module Information | Support | Support | -- |\n| Device | OSG_DHCP_C | Gateway DHCP Client Module Information | Support | Support | -- |\n| Device | OSG_DHCP_S | Gateway DHCP Server Module Information | Support | Support | -- |\n| System | INCIDENT_MAILED_FAILED | Incidents auto mailed failed | No Support on Basic Site | No Support | -- |\n| System | DST_C_FAIL | DST configuration error. | Support | Support | No Support on CBC |\n| Device | OSG_DHCP_LEASE_POOL_EXHAUSTED | The DHCP lease pool is exhausted | Support | Support | -- |\n| Device | OSG_ROGUE_DHCP_SERVER_DETECTED | A rogue DHCP server is detected | Support | Support | -- |\n| Device | OSG_IP_CONFLICT_DETECTED | An IP conflict is detected | Support | Support | -- |\n| Device | OSW_OUI_BASED_VLAN_EFFECT | Switch OUI Based VLAN rule applied | No Support on Basic Site | No Support | -- |\n| Device | OSW_OUI_BASED_VLAN_NUM_LIMIT_EXCEED | Switch OUI Based VLAN rules exceeded the maximum simultaneous entry limit | No Support on Basic Site | No Support | -- |\n\n\n## 5.7 Insight\n\n### 5.7.1 Insight Notification Key\nSome interfaces may require Insight Notification Key. The tables below lists the Insight Notification Key of the controller.\n\n#### 5.7.1.1 event category Key\n| **Web** | **Event category Key** |\n| ----- | ----- |\n| **Networking** | **networking** |\n| **Mesh** | **mesh** |\n| **Access** | **access** |\n| **Roaming** | **roaming** |\n| **Network Service** | **networkService** |\n| **Software/Configuration** | **software** |\n| **Hardware** | **hardware** |\n| **Security** | **security** |\n| **Throughput** | **throughput** |\n| **Coverage** | **cover** |\n\n### 5.7.2 Anomaly Settings\n\n#### 5.7.2.1 Effective parameter ranges for each event\nThe table below lists the effective parameter ranges for each event.\n\n| **Incident Code** | **Title**                                                                                       | **Params and Effective Range**                                                                                                                                                                                                                                                                                    |\n|-------------------|-------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **01001001**      | AP frequently offline                                                                           | **offlineCount\\[1, 15]**                                                                                                                                                                                                                                                                                          |\n| **01001003**      | APs on site going offline in batches                                                            | **avgDisconnectCount\\[1, 15], disconnectApPercent\\[40, 90], disconnectCount\\[1, 20]**                                                                                                                                                                                                                             |\n| **~~01002001~~**  | ~~AP receives weak mesh signals~~                                                               | **~~count\\[1, 100], threshold\\[-90, -60]~~**                                                                                                                                                                                                                                                                      |\n| **~~01002003~~**  | ~~Uplink AP goes offline~~                                                                      | **~~--~~**                                                                                                                                                                                                                                                                                                        |\n| **~~01002004~~**  | ~~The uplink AP is disconnected and the device is not within the detection range of other APs~~ | **~~--~~**                                                                                                                                                                                                                                                                                                        |\n| **~~01002005~~**  | ~~Mesh AP isolated~~                                                                            | **~~--~~**                                                                                                                                                                                                                                                                                                        |\n| **~~01003001~~**  | ~~Client association failure~~                                                                  | **~~--~~**                                                                                                                                                                                                                                                                                                        |\n| **~~01003002~~**  | ~~Client frequently offline~~                                                                   | **~~offlineCount\\[1, 15]~~**                                                                                                                                                                                                                                                                                      |\n| **~~01003004~~**  | ~~Low client association success rate~~                                                         | **~~threshold\\[1, 100]~~**                                                                                                                                                                                                                                                                                        |\n| **~~01003005~~**  | ~~Client authentication failure~~                                                               | **~~--~~**                                                                                                                                                                                                                                                                                                        |\n| **~~01003007~~**  | ~~Low client authentication success rate~~                                                      | **~~threshold\\[1, 100]~~**                                                                                                                                                                                                                                                                                        |\n| **~~01003010~~**  | ~~Low AP client association success rate~~                                                      | **~~threshold\\[1, 100]~~**                                                                                                                                                                                                                                                                                        |\n| **~~01003011~~**  | ~~Low AP client authentication success rate~~                                                   | **~~threshold\\[1, 100]~~**                                                                                                                                                                                                                                                                                        |\n| **~~01003013~~**  | ~~Client abnormal offline~~                                                                     | **~~--~~**                                                                                                                                                                                                                                                                                                        |\n| **01003014**      | Client failed to connect                                                                        | **--**                                                                                                                                                                                                                                                                                                            |\n| **~~01003015~~**      | ~~Client slow to connect~~                                                                          | **~~threshold\\[5000, 30000]~~**                                                                                                                                                                                                                                                                                       |\n| **01003016**      | Client failed to obtain IP                                                                      | **--**                                                                                                                                                                                                                                                                                                            |\n| **~~01003017~~**      | ~~Client slow to obtain IP~~                                                                        | **~~threshold\\[500, 10000]~~**                                                                                                                                                                                                                                                                                        |\n| **~~01004001~~**  | ~~Low AP client roaming success rate~~                                                          | **~~threshold\\[1, 100]~~**                                                                                                                                                                                                                                                                                        |\n| **01004002**      | Client Ping-pong roaming                                                                        | **threshold\\[2, 100]**                                                                                                                                                                                                                                                                                            |\n| **~~01004003~~**  | ~~Client roams frequently~~                                                                     | **~~threshold\\[1, 100]~~**                                                                                                                                                                                                                                                                                        |\n| **~~01004004~~**  | ~~Client roams slowly~~                                                                         | **~~duration\\[1, 5], threshold\\[1, 100]~~**                                                                                                                                                                                                                                                                       |\n| **01004005**      | Client sticky roaming                                                                           | **--**                                                                                                                                                                                                                                                                                                            |\n| **~~01006001~~**  | ~~AP abnormal reboot~~                                                                          | **~~--~~**                                                                                                                                                                                                                                                                                                        |\n| **01007001**      | High AP CPU risk                                                                                | **count\\[50, 100], threshold\\[50, 100]**                                                                                                                                                                                                                                                                          |\n| **~~01007003~~**  | ~~AP temperature too high~~                                                                     | **~~count\\[1, 100], threshold\\[1, 100]~~**                                                                                                                                                                                                                                                                        |\n| **01009001**      | Client SNR exception                                                                            | **count\\[50, 100], threshold\\[10, 30]**                                                                                                                                                                                                                                                                           |\n| **01009002**      | High AP channel utilization                                                                     | **count\\[50, 100], threshold\\[50, 95]**                                                                                                                                                                                                                                                                           |\n| **01009003**      | Client negotiation rate exception                                                               | **count\\[50, 100]**                                                                                                                                                                                                                                                                                               |\n| **~~01009004~~**  | ~~Client negotiation rate distribution exception~~                                              | **~~count2g\\[1, 100], count5g\\[1, 100], count5g2\\[1, 100], count6g\\[1, 100]~~**                                                                                                                                                                                                                                   |\n| **~~01009006~~**  | ~~Client interferes with low negotiation rate~~                                                 | **~~throughput2g\\[1, 4950], util2g\\[1, 100], throughput5g\\[1, 4950], util5g\\[1, 100], throughput5g2\\[1, 4950], util5g2\\[1, 100], throughput6g\\[1, 4950], util6g\\[1, 100]~~**                                                                                                                                      |\n| **~~01009007~~**  | ~~Client high retransmission rate~~                                                             | **~~count\\[1, 100], threshold\\[1, 100]~~**                                                                                                                                                                                                                                                                        |\n| **~~01009008~~**  | ~~Client high packet loss rate~~                                                                | **~~count\\[1, 100], threshold\\[1, 100]~~**                                                                                                                                                                                                                                                                        |\n| **01009009**      | AP noise floor too high                                                                         | **count\\[50, 100], threshold\\[-90, -60]**                                                                                                                                                                                                                                                                         |\n| **01009010**      | AP wireless interference rate too high                                                          | **count\\[50, 100], threshold\\[40, 95]**                                                                                                                                                                                                                                                                           |\n| **~~01009011~~**  | ~~AP high retransmission rate~~                                                                 | **~~count2g\\[1, 100], count5g\\[1, 100], count5g2\\[1, 100], count6g\\[1, 100], threshold2g\\[1, 100], threshold5g\\[1, 100], threshold5g2\\[1, 100], threshold6g\\[1, 100]~~**                                                                                                                                          |\n| **~~01009012~~**  | ~~AP high packet loss rate~~                                                                    | **~~count2g\\[1, 100], count5g\\[1, 100], count5g2\\[1, 100], count6g\\[1, 100], threshold2g\\[1, 100], threshold5g\\[1, 100], threshold5g2\\[1, 100], threshold6g\\[1, 100]~~**                                                                                                                                          |\n| **~~01010001~~**  | ~~Client signal strength distribution exception~~                                               | **~~lowerThreshold2g\\[-95, -46], upperThreshold2g\\[-46, 0], ratio2g\\[1, 100], lowerThreshold5g\\[-95, -46], upperThreshold5g\\[-46, 0], ratio5g\\[1, 100], lowerThreshold5g2\\[-95, -46], upperThreshold5g2\\[-46, 0], ratio5g2\\[1, 100], lowerThreshold6g\\[-95, -46], upperThreshold6g\\[-46, 0], ratio6g\\[1, 100]~~** |\n| **02001001**      | Gateway goes offline from the Controller frequently                                             | **offlineCount\\[1, 15]**                                                                                                                                                                                                                                                                                          |\n| **02003001**      | Gateway client limit reached                                                                    | **--**                                                                                                                                                                                                                                                                                                            |\n| **~~02005001~~**  | ~~WAN port dial-up failed~~                                                                     | **~~--~~**                                                                                                                                                                                                                                                                                                        |\n| **02005002**      | VPN connection failure                                                                          | **--**                                                                                                                                                                                                                                                                                                            |\n| **02005003**      | DDNS service is abnormal                                                                        | **--**                                                                                                                                                                                                                                                                                                            |\n| **~~02005004~~**  | ~~DNS service is abnormal~~                                                                     | **~~--~~**                                                                                                                                                                                                                                                                                                        |\n| **~~02007001~~**      | ~~Gateway fan is abnormal~~                                                                         | **~~--~~**                                                                                                                                                                                                                                                                                                            |\n| **02007002**      | Gateway CPU utilization rate too high                                                           | **count\\[30, 100], threshold\\[70, 100]**                                                                                                                                                                                                                                                                          |\n| **~~02007003~~**  | ~~Gateway temperature too high~~                                                                | **~~count\\[1, 100], threshold\\[1, 100]~~**                                                                                                                                                                                                                                                                        |\n| **02008001**      | Unauthorized log in from a gateway                                                              | **--**                                                                                                                                                                                                                                                                                                            |\n| **02008002**      | Gateway WAN or LAN port detects attack packets                                                  | **--**                                                                                                                                                                                                                                                                                                            |\n| **02009001**      | Gateway WAN port bandwidth utilization rate too high                                            | **count\\[30, 100], threshold\\[50, 100]**                                                                                                                                                                                                                                                                          |\n| **~~02009002~~**      | ~~Gateway WAN port packet loss rate too high~~                                                      | **~~count\\[30, 100], threshold\\[1, 30]~~**                                                                                                                                                                                                                                                                            |\n| **02009003**      | Gateway WAN port latency too high                                                               | **count\\[30, 100], threshold\\[20, 1900]**                                                                                                                                                                                                                                                                         |\n| **03001001**      | Loop detected                                                                                   | **--**                                                                                                                                                                                                                                                                                                            |\n| **03001002**      | Switch goes offline frequently                                                                  | **offlineCount\\[1, 15]**                                                                                                                                                                                                                                                                                          |\n| **~~03003001~~**  | ~~802.1X authentication success rate is low~~                                                   | **~~successRate\\[1, 100]~~**                                                                                                                                                                                                                                                                                      |\n| **~~03003002~~**  | ~~802.1X authentication takes too much time~~                                                   | **~~count\\[1, 100], threshold\\[1, 5000]~~**                                                                                                                                                                                                                                                                       |\n| **03003003**      | Switch 802.1X authentication failure                                                            | **--**                                                                                                                                                                                                                                                                                                            |\n| **~~03003005~~**  | ~~Layer 3 interface down~~                                                                      | **~~--~~**                                                                                                                                                                                                                                                                                                        |\n| **03003006**      | Switch 802.1X authentication took too long                                                      | **threshold\\[1000, 10000]**                                                                                                                                                                                                                                                                                       |\n| **03003008**      | Interface IP address conflict                                                                   | **--**                                                                                                                                                                                                                                                                                                            |\n| **03003009**      | DHCP servers conflicted                                                                         | **--**                                                                                                                                                                                                                                                                                                            |\n| **~~03003010~~**  | ~~DHCP address pool warning~~                                                                   | **~~addressPoolRate\\[70, 95]~~**                                                                                                                                                                                                                                                                                  |\n| **~~03003011~~**  | ~~DHCP address pool exhausted~~                                                                 | **~~--~~**                                                                                                                                                                                                                                                                                                        |\n| **~~03005003~~**  | ~~Address table overflow alarm~~                                                                | **~~--~~**                                                                                                                                                                                                                                                                                                        |\n| **~~03005004~~**  | ~~Repeated address migrations~~                                                                 | **~~timeRange_s\\[1, 300], changedTimes\\[1, 100]~~**                                                                                                                                                                                                                                                               |\n| **03005005**      | LACP convergence failure                                                                        | **--**                                                                                                                                                                                                                                                                                                            |\n| **03005006**      | Host routing entry overflow                                                                     | **--**                                                                                                                                                                                                                                                                                                            |\n| **03005007**      | ARP table overflow                                                                              | **--**                                                                                                                                                                                                                                                                                                            |\n| **03005009**      | Multicast table overflow was detected                                                           | **--**                                                                                                                                                                                                                                                                                                            |\n| **03005010**      | Illegal multicast packet                                                                        | **--**                                                                                                                                                                                                                                                                                                            |\n| **03007001**      | Switch temperature too high                                                                     | **--**                                                                                                                                                                                                                                                                                                            |\n| **~~03007006~~**  | ~~PoE power supply disruption~~                                                                 | **~~--~~**                                                                                                                                                                                                                                                                                                        |\n| **~~03007008~~**  | ~~PoE short circuit~~                                                                           | **~~--~~**                                                                                                                                                                                                                                                                                                        |\n| **03007009**      | Excessive PoE power                                                                             | **--**                                                                                                                                                                                                                                                                                                            |\n| **03007011**      | Switch CPU utilization rate too high                                                            | **count\\[50, 100], threshold\\[50, 100]**                                                                                                                                                                                                                                                                          |\n| **03007013**      | Switch port detects an error packets                                                            | **count\\[1, 100], threshold\\[1, 100]**                                                                                                                                                                                                                                                                            |\n| **03007015**      | Switch Port goes up/down frequently                                                             | **timeRange\\[1, 60], changedTimes\\[3, 100]**                                                                                                                                                                                                                                                                      |\n| **03007016**      | Abnormal optical module DDM                                                                     | **--**                                                                                                                                                                                                                                                                                                            |\n| **~~03007017~~**  | ~~Optical module DDM below threshold~~                                                          | **~~--~~**                                                                                                                                                                                                                                                                                                        |\n| **~~03007018~~**  | ~~Optical module not recognized~~                                                               | **~~--~~**                                                                                                                                                                                                                                                                                                        |\n| **03008001**      | Unauthorized log in from a switch                                                               | **retryCnt\\[1, 100]**                                                                                                                                                                                                                                                                                             |\n| **03009001**      | Switch port traffic too high                                                                    | **count\\[50, 100], threshold\\[30, 100]**                                                                                                                                                                                                                                                                          |\n| **03009002**      | Switch LAG Group member port load too different                                                 | **count\\[50, 100], threshold\\[50, 90]**                                                                                                                                                                                                                                                                           |\n| **03009003**      | Switch port packet loss rate too high                                                           | **count\\[50, 100], threshold\\[1, 30]**                                                                                                                                                                                                                                                                            |\n| **03009004**      | Storm control event                                                                             | **--**                                                                                                                                                                                                                                                                                                            |\n| **04003001**      | Client Portal authentication failure                                                            | **--**                                                                                                                                                                                                                                                                                                            |\n| **04003002**      | Client Portal authentication slow                                                               | **threshold\\[1, 10]**                                                                                                                                                                                                                                                                                             |\n| **~~06003001~~**  | ~~Site's successful portal authentication rate low~~                                            | **~~threshold\\[1, 100]~~**                                                                                                                                                                                                                                                                                        |\n\n## 5.8 MSP\n\nHardware controller currently does not support MSP mode.\n\n## 5.9 Device\n\n### 5.9.1 Device Statistics\n\nThe Device Statistics OpenAPI uses common response type `BaseDeviceStatDTO` in the online schema, but the actual response fields are determined by the `type` query parameter. This chapter lists the supported `attrs` and response fields for each device type.\n\n#### 5.9.1.1 Interfaces\n\n| **Interface** | **Method** | **Path** | **Granularity** |\n| ----- | ----- | ----- | ----- |\n| **Get device statistic data 5 min** | **POST** | **/openapi/v2/{omadacId}/sites/{siteId}/stat/{deviceMac}/5min** | 5 minutes |\n| **Get device statistic data hourly** | **POST** | **/openapi/v2/{omadacId}/sites/{siteId}/stat/{deviceMac}/hourly** | 1 hour |\n| **Get device statistic data daily** | **POST** | **/openapi/v2/{omadacId}/sites/{siteId}/stat/{deviceMac}/daily** | 1 day |\n\n#### 5.9.1.2 Request Parameters\n\n| **Parameter** | **Location** | **Required** | **Description** |\n| ----- | ----- | ----- | ----- |\n| **omadacId** | Path | Yes | Omada ID. |\n| **siteId** | Path | Yes | Site ID. |\n| **deviceMac** | Path | Yes | Device MAC address. |\n| **type** | Query | Yes | Device type. Supported values: **ap**, **gateway**, **switch**, **olt**. |\n| **start** | Body | Yes | Start time, number of seconds from UTC 1970-01-01. |\n| **end** | Body | Yes | End time, number of seconds from UTC 1970-01-01. |\n| **attrs** | Body | Yes | Attributes to be queried. Supported values depend on `type` and granularity. Attributes not included in `attrs` will return a default value of 0 or be omitted. |\n| **ports** | Body | No | Port list for **gateway** and **switch**. Each item is an integer, for example `[1, 2]`. Empty or absent means all ports. |\n| **oltPorts** | Body | No | Port list for **olt**. Each item is a string. Empty or absent means all OLT ports. |\n| **standardPorts** | Body | No | Port list for switch stack statistics. It is not used by these common device statistic interfaces. |\n\n**Request Example (Switch):**\n\n~~~bash\ncurl -X POST \"https://{host}/openapi/v2/{omadacId}/sites/{siteId}/stat/{deviceMac}/5min?type=switch\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"start\": 1782021780,\n    \"end\": 1782108180,\n    \"attrs\": [\"cpu\", \"mem\", \"tx\", \"rx\"],\n    \"ports\": [1, 2]\n  }'\n~~~\n\n\n**Response Example (Switch):**\n\n```json\n{\n  \"errorCode\": 0,\n  \"msg\": \"Success.\",\n  \"result\": [\n    {\n      \"time\": 1782021900,\n      \"ports\": [\n        { \"port\": 1 },\n        { \"port\": 2 }\n      ]\n    },\n    {\n      \"time\": 1782022200,\n      \"ports\": [\n        { \"port\": 1 },\n        { \"port\": 2 }\n      ]\n    },\n\n    \"...\",\n\n    {\n      \"time\": 1782108000,\n      \"cpu\": 23,\n      \"mem\": 45,\n      \"ports\": [\n        {\n          \"port\": 1,\n          \"tx\": 123,\n          \"rx\": 123,\n          \"txRate\": 0,\n          \"rxRate\": 0,\n          \"txPkts\": 0,\n          \"rxPkts\": 0,\n          \"txBroadPkts\": 0,\n          \"rxBroadPkts\": 0,\n          \"txMultiPkts\": 0,\n          \"rxMultiPkts\": 0,\n          \"dropPkts\": 0,\n          \"txErrPkts\": 0,\n          \"rxErrPkts\": 0,\n          \"linkDownCnt\": 0\n        },\n        {\n          \"port\": 2,\n          \"tx\": 233,\n          \"rx\": 233,\n          \"txRate\": 0,\n          \"rxRate\": 0,\n          \"txPkts\": 0,\n          \"rxPkts\": 0,\n          \"txBroadPkts\": 0,\n          \"rxBroadPkts\": 0,\n          \"txMultiPkts\": 0,\n          \"rxMultiPkts\": 0,\n          \"dropPkts\": 0,\n          \"txErrPkts\": 0,\n          \"rxErrPkts\": 0,\n          \"linkDownCnt\": 0\n        }\n      ]\n    }\n  ]\n}\n```\n**Note:**\n\n- The `result` array contains time-series data points at fixed intervals (e.g., every 5 minutes).\n- The example above is truncated for brevity.\n\n#### 5.9.1.3 Common Response Fields\n\nAll device-type responses inherit the following common fields.\n\n| **Field** | **Type** | **Description** | **Unit** |\n| ----- | ----- | ----- | ----- |\n| **time** | Long | Sampling moment. | second |\n| **cpu** | Integer | CPU utilization. | % |\n| **mem** | Integer | Memory utilization. | % |\n| **rebootTimes** | Integer | Reboot count during the statistic interval. | count |\n| **mac** | String | Device MAC address. | -- |\n\n#### 5.9.1.4 Supported attrs by Device Type\n\n##### AP attrs, type = ap\n\nFor AP, 5-minute, hourly, and daily interfaces support the following `attrs`.\n\n| **Attr** | **Result Field** | **Description** | **Unit** |\n| ----- | ----- | ----- | ----- |\n| **cpu** | cpu | CPU utilization. | % |\n| **mem** | mem | Memory utilization. | % |\n| **chanUtil2g** | chanUtil2g | 2.4 GHz channel utilization. | % |\n| **chanUtil5g** | chanUtil5g | 5 GHz channel utilization. | % |\n| **chanUtil5g2** | chanUtil5g2 | Secondary 5 GHz channel utilization. | % |\n| **chanUtil6g** | chanUtil6g | 6 GHz channel utilization. | % |\n| **interUtil2g** | interUtil2g | 2.4 GHz interference utilization. | % |\n| **interUtil5g** | interUtil5g | 5 GHz interference utilization. | % |\n| **interUtil5g2** | interUtil5g2 | Secondary 5 GHz interference utilization. | % |\n| **interUtil6g** | interUtil6g | 6 GHz interference utilization. | % |\n| **noiseFloor2g** | noiseFloor2g | 2.4 GHz noise floor. | dBm |\n| **noiseFloor5g** | noiseFloor5g | 5 GHz noise floor. | dBm |\n| **noiseFloor5g2** | noiseFloor5g2 | Secondary 5 GHz noise floor. | dBm |\n| **noiseFloor6g** | noiseFloor6g | 6 GHz noise floor. | dBm |\n| **snr2g** | snr2g | 2.4 GHz signal-to-noise ratio. | dB |\n| **snr5g** | snr5g | 5 GHz signal-to-noise ratio. | dB |\n| **rssi2g** | rssi2g | 2.4 GHz RSSI. | dBm |\n| **rssi5g** | rssi5g | 5 GHz RSSI. | dBm |\n| **tx2g** | tx2g | 2.4 GHz transmitted traffic. | bytes |\n| **rx2g** | rx2g | 2.4 GHz received traffic. | bytes |\n| **txPkts2g** | txPkts2g | 2.4 GHz transmitted packets. | packets |\n| **rxPkts2g** | rxPkts2g | 2.4 GHz received packets. | packets |\n| **mtx2g** | mtx2g | 2.4 GHz multicast transmitted traffic. | bytes |\n| **mrx2g** | mrx2g | 2.4 GHz multicast received traffic. | bytes |\n| **mtxPkts2g** | mtxPkts2g | 2.4 GHz multicast transmitted packets. | packets |\n| **mrxPkts2g** | mrxPkts2g | 2.4 GHz multicast received packets. | packets |\n| **txDropPkts2g** | txDropPkts2g | 2.4 GHz transmitted dropped packets. | packets |\n| **rxDropPkts2g** | rxDropPkts2g | 2.4 GHz received dropped packets. | packets |\n| **dropPkts2g** | dropPkts2g | 2.4 GHz total dropped packets. | packets |\n| **txRetryPkts2g** | txRetryPkts2g | 2.4 GHz transmitted retried packets. | packets |\n| **rxRetryPkts2g** | rxRetryPkts2g | 2.4 GHz received retried packets. | packets |\n| **retryPkts2g** | retryPkts2g | 2.4 GHz total retried packets. | packets |\n| **txErrPkts2g** | txErrPkts2g | 2.4 GHz transmitted error packets. | packets |\n| **rxErrPkts2g** | rxErrPkts2g | 2.4 GHz received error packets. | packets |\n| **tx5g** | tx5g | 5 GHz transmitted traffic. | bytes |\n| **rx5g** | rx5g | 5 GHz received traffic. | bytes |\n| **txPkts5g** | txPkts5g | 5 GHz transmitted packets. | packets |\n| **rxPkts5g** | rxPkts5g | 5 GHz received packets. | packets |\n| **mtx5g** | mtx5g | 5 GHz multicast transmitted traffic. | bytes |\n| **mrx5g** | mrx5g | 5 GHz multicast received traffic. | bytes |\n| **mtxPkts5g** | mtxPkts5g | 5 GHz multicast transmitted packets. | packets |\n| **mrxPkts5g** | mrxPkts5g | 5 GHz multicast received packets. | packets |\n| **txDropPkts5g** | txDropPkts5g | 5 GHz transmitted dropped packets. | packets |\n| **rxDropPkts5g** | rxDropPkts5g | 5 GHz received dropped packets. | packets |\n| **dropPkts5g** | dropPkts5g | 5 GHz total dropped packets. | packets |\n| **txRetryPkts5g** | txRetryPkts5g | 5 GHz transmitted retried packets. | packets |\n| **rxRetryPkts5g** | rxRetryPkts5g | 5 GHz received retried packets. | packets |\n| **retryPkts5g** | retryPkts5g | 5 GHz total retried packets. | packets |\n| **txErrPkts5g** | txErrPkts5g | 5 GHz transmitted error packets. | packets |\n| **rxErrPkts5g** | rxErrPkts5g | 5 GHz received error packets. | packets |\n| **tx5g2** | tx5g2 | Secondary 5 GHz transmitted traffic. | bytes |\n| **rx5g2** | rx5g2 | Secondary 5 GHz received traffic. | bytes |\n| **txPkts5g2** | txPkts5g2 | Secondary 5 GHz transmitted packets. | packets |\n| **rxPkts5g2** | rxPkts5g2 | Secondary 5 GHz received packets. | packets |\n| **mtx5g2** | mtx5g2 | Secondary 5 GHz multicast transmitted traffic. | bytes |\n| **mrx5g2** | mrx5g2 | Secondary 5 GHz multicast received traffic. | bytes |\n| **mtxPkts5g2** | mtxPkts5g2 | Secondary 5 GHz multicast transmitted packets. | packets |\n| **mrxPkts5g2** | mrxPkts5g2 | Secondary 5 GHz multicast received packets. | packets |\n| **txDropPkts5g2** | txDropPkts5g2 | Secondary 5 GHz transmitted dropped packets. | packets |\n| **rxDropPkts5g2** | rxDropPkts5g2 | Secondary 5 GHz received dropped packets. | packets |\n| **dropPkts5g2** | dropPkts5g2 | Secondary 5 GHz total dropped packets. | packets |\n| **txRetryPkts5g2** | txRetryPkts5g2 | Secondary 5 GHz transmitted retried packets. | packets |\n| **rxRetryPkts5g2** | rxRetryPkts5g2 | Secondary 5 GHz received retried packets. | packets |\n| **retryPkts5g2** | retryPkts5g2 | Secondary 5 GHz total retried packets. | packets |\n| **txErrPkts5g2** | txErrPkts5g2 | Secondary 5 GHz transmitted error packets. | packets |\n| **rxErrPkts5g2** | rxErrPkts5g2 | Secondary 5 GHz received error packets. | packets |\n| **tx6g** | tx6g | 6 GHz transmitted traffic. | bytes |\n| **rx6g** | rx6g | 6 GHz received traffic. | bytes |\n| **txPkts6g** | txPkts6g | 6 GHz transmitted packets. | packets |\n| **rxPkts6g** | rxPkts6g | 6 GHz received packets. | packets |\n| **mtx6g** | mtx6g | 6 GHz multicast transmitted traffic. | bytes |\n| **mrx6g** | mrx6g | 6 GHz multicast received traffic. | bytes |\n| **mtxPkts6g** | mtxPkts6g | 6 GHz multicast transmitted packets. | packets |\n| **mrxPkts6g** | mrxPkts6g | 6 GHz multicast received packets. | packets |\n| **txDropPkts6g** | txDropPkts6g | 6 GHz transmitted dropped packets. | packets |\n| **rxDropPkts6g** | rxDropPkts6g | 6 GHz received dropped packets. | packets |\n| **dropPkts6g** | dropPkts6g | 6 GHz total dropped packets. | packets |\n| **txRetryPkts6g** | txRetryPkts6g | 6 GHz transmitted retried packets. | packets |\n| **rxRetryPkts6g** | rxRetryPkts6g | 6 GHz received retried packets. | packets |\n| **retryPkts6g** | retryPkts6g | 6 GHz total retried packets. | packets |\n| **txErrPkts6g** | txErrPkts6g | 6 GHz transmitted error packets. | packets |\n| **rxErrPkts6g** | rxErrPkts6g | 6 GHz received error packets. | packets |\n| **arp** | arp | ARP traffic. | packets |\n| **igmp** | igmp | IPv4 IGMP traffic. | packets |\n| **mdnsV4** | mdnsV4 | IPv4 mDNS traffic. | packets |\n| **ssdpV4** | ssdpV4 | IPv4 SSDP traffic. | packets |\n| **dhcp** | dhcp | IPv4 DHCP traffic. | packets |\n| **mld** | mld | IPv6 MLD traffic. | packets |\n| **mdnsV6** | mdnsV6 | IPv6 mDNS traffic. | packets |\n| **ssdpV6** | ssdpV6 | IPv6 SSDP traffic. | packets |\n| **nsNa** | nsNa | IPv6 NS/NA traffic. | packets |\n| **rsRa** | rsRa | IPv6 RS/RA traffic. | packets |\n| **redirect** | redirect | IPv6 redirect traffic. | packets |\n| **dhcpV6** | dhcpV6 | IPv6 DHCPv6 traffic. | packets |\n| **otherBroad** | otherBroad | Other broadcast traffic. | packets |\n| **otherMulti** | otherMulti | Other multicast traffic. | packets |\n\n##### Gateway attrs, type = gateway\n\nFor gateway, 5-minute, hourly, and daily interfaces use the same `attrs` set.\n\n| **Attr** | **Result Field** | **Description** | **Unit** |\n| ----- | ----- | ----- | ----- |\n| **cpu** | cpu | CPU utilization. | % |\n| **mem** | mem | Memory utilization. | % |\n| **tx** | tx | Transmitted traffic of the port. | bytes |\n| **rx** | rx | Received traffic of the port. | bytes |\n| **txPkts** | txPkts | Transmitted packets of the port. | packets |\n| **rxPkts** | rxPkts | Received packets of the port. | packets |\n| **dropPkts** | dropPkts | Dropped packets of the port. | packets |\n| **errPkts** | errPkts | Error packets of the port. | packets |\n| **latency** | latency | Latency of the port. | ms |\n| **pktLoss** | loss | Packet loss rate of the port. | % |\n| **name** | name | Port name. | -- |\n\n##### Switch attrs, type = switch\n\nFor switch, 5-minute, hourly, and daily interfaces use the same `attrs` set.\n\n| **Attr** | **Result Field** | **Description** | **Unit** |\n| ----- | ----- | ----- | ----- |\n| **cpu** | cpu | CPU utilization. | % |\n| **mem** | mem | Memory utilization. | % |\n| **tx** | tx | Transmitted traffic of the port. | bytes |\n| **rx** | rx | Received traffic of the port. | bytes |\n| **txRate** | txRate | Transmit rate of the port. | byte/s |\n| **rxRate** | rxRate | Receive rate of the port. | byte/s |\n| **txPkts** | txPkts | Transmitted packets of the port. | packets |\n| **rxPkts** | rxPkts | Received packets of the port. | packets |\n| **txBroadPkts** | txBroadPkts | Transmitted broadcast packets of the port. | packets |\n| **rxBroadPkts** | rxBroadPkts | Received broadcast packets of the port. | packets |\n| **txMultiPkts** | txMultiPkts | Transmitted multicast packets of the port. | packets |\n| **rxMultiPkts** | rxMultiPkts | Received multicast packets of the port. | packets |\n| **dropPkts** | dropPkts | Dropped packets of the port. | packets |\n| **txErrPkts** | txErrPkts | Transmitted error packets of the port. | packets |\n| **rxErrPkts** | rxErrPkts | Received error packets of the port. | packets |\n\n##### OLT attrs, type = olt\n\nFor OLT, 5-minute, hourly, and daily interfaces use the same `attrs` set.\n\n| **Attr** | **Result Field** | **Description** | **Unit** |\n| ----- | ----- | ----- | ----- |\n| **cpu** | cpu | CPU utilization. | % |\n| **mem** | mem | Memory utilization. | % |\n| **up** | up | Uplink traffic. | bytes |\n| **down** | down | Downlink traffic. | bytes |\n| **onuCount** | onuCount | Number of ONUs. | count |\n| **tx** | tx | Transmitted traffic of the port. | bytes |\n| **rx** | rx | Received traffic of the port. | bytes |\n| **txRate** | txRate | Transmit rate of the port. | byte/s |\n| **rxRate** | rxRate | Receive rate of the port. | byte/s |\n| **txPackets** | txPackets | Transmitted packets of the port. | packets |\n| **rxPackets** | rxPackets | Received packets of the port. | packets |\n| **txBroadcastPackets** | txBroadcastPackets | Transmitted broadcast packets of the port. | packets |\n| **rxBroadcastPackets** | rxBroadcastPackets | Received broadcast packets of the port. | packets |\n| **txMulticastPackets** | txMulticastPackets | Transmitted multicast packets of the port. | packets |\n| **rxMulticastPackets** | rxMulticastPackets | Received multicast packets of the port. | packets |\n| **txPacketRate** | txPacketRate | Transmit packet rate of the port. | packet/s |\n| **rxPacketRate** | rxPacketRate | Receive packet rate of the port. | packet/s |\n\n#### 5.9.1.5 Result Fields by Device Type\n\n##### AP response, type = ap\n\n| **Field** | **Description** | **Unit** |\n| ----- | ----- | ----- |\n| **chanUtil2g / chanUtil5g / chanUtil5g2 / chanUtil6g** | Channel utilization by radio band. | % |\n| **interUtil2g / interUtil5g / interUtil5g2 / interUtil6g** | Interference utilization by radio band. | % |\n| **noiseFloor2g / noiseFloor5g / noiseFloor5g2 / noiseFloor6g** | Noise floor by radio band. | dBm |\n| **snr2g / snr5g** | Signal-to-noise ratio. | dB |\n| **rssi2g / rssi5g** | RSSI. | dBm |\n| **tx2g / tx5g / tx5g2 / tx6g** | Transmitted traffic by radio band. | bytes |\n| **rx2g / rx5g / rx5g2 / rx6g** | Received traffic by radio band. | bytes |\n| **txPkts2g / txPkts5g / txPkts5g2 / txPkts6g** | Transmitted packets by radio band. | packets |\n| **rxPkts2g / rxPkts5g / rxPkts5g2 / rxPkts6g** | Received packets by radio band. | packets |\n| **mtx2g / mtx5g / mtx5g2 / mtx6g** | Multicast transmitted traffic by radio band. | bytes |\n| **mrx2g / mrx5g / mrx5g2 / mrx6g** | Multicast received traffic by radio band. | bytes |\n| **mtxPkts2g / mtxPkts5g / mtxPkts5g2 / mtxPkts6g** | Multicast transmitted packets by radio band. | packets |\n| **mrxPkts2g / mrxPkts5g / mrxPkts5g2 / mrxPkts6g** | Multicast received packets by radio band. | packets |\n| **txDropPkts2g / txDropPkts5g / txDropPkts5g2 / txDropPkts6g** | Transmitted dropped packets by radio band. | packets |\n| **rxDropPkts2g / rxDropPkts5g / rxDropPkts5g2 / rxDropPkts6g** | Received dropped packets by radio band. | packets |\n| **dropPkts2g / dropPkts5g / dropPkts5g2 / dropPkts6g** | Total dropped packets by radio band. | packets |\n| **txRetryPkts2g / txRetryPkts5g / txRetryPkts5g2 / txRetryPkts6g** | Transmitted retried packets by radio band. | packets |\n| **rxRetryPkts2g / rxRetryPkts5g / rxRetryPkts5g2 / rxRetryPkts6g** | Received retried packets by radio band. | packets |\n| **retryPkts2g / retryPkts5g / retryPkts5g2 / retryPkts6g** | Total retried packets by radio band. | packets |\n| **txErrPkts2g / txErrPkts5g / txErrPkts5g2 / txErrPkts6g** | Transmitted error packets by radio band. | packets |\n| **rxErrPkts2g / rxErrPkts5g / rxErrPkts5g2 / rxErrPkts6g** | Received error packets by radio band. | packets |\n| **arp / igmp / mdnsV4 / ssdpV4 / dhcp / mld / mdnsV6 / ssdpV6 / nsNa / rsRa / redirect / dhcpV6 / otherBroad / otherMulti** | LAN broadcast/multicast traffic fields. | packets |\n\n##### Gateway response, type = gateway\n\n| **Field** | **Description** | **Unit** |\n| ----- | ----- | ----- |\n| **ports** | Gateway port statistic list. | -- |\n| **port** | Port index. | -- |\n| **name** | Port name. | -- |\n| **tx / rx** | Transmitted/received traffic. | bytes |\n| **txPkts / rxPkts** | Transmitted/received packets. | packets |\n| **latency** | Port latency. | ms |\n| **dropPkts** | Dropped packets. | packets |\n| **errPkts** | Error packets. | packets |\n| **loss** | Packet loss rate. | % |\n| **linkDownCnt** | Link-down count. | count |\n\n##### Switch response, type = switch\n\n| **Field** | **Description** | **Unit** |\n| ----- | ----- | ----- |\n| **ports** | Switch port statistic list. | -- |\n| **port** | Port index. | -- |\n| **standardPort** | Standard port name, mainly used in stack scenarios. | -- |\n| **tx / rx** | Transmitted/received traffic. | bytes |\n| **txRate / rxRate** | Transmit/receive rate. | byte/s |\n| **txPkts / rxPkts** | Transmitted/received packets. | packets |\n| **txBroadPkts / rxBroadPkts** | Transmitted/received broadcast packets. | packets |\n| **txMultiPkts / rxMultiPkts** | Transmitted/received multicast packets. | packets |\n| **dropPkts** | Dropped packets. | packets |\n| **txErrPkts / rxErrPkts** | Transmitted/received error packets. | packets |\n| **linkDownCnt** | Link-down count. | count |\n| **poeUtil** | PoE utilization. | % |\n| **poePower** | PoE power. | W |\n\n##### OLT response, type = olt\n\n| **Field** | **Description** | **Unit** |\n| ----- | ----- | ----- |\n| **name** | OLT name. | -- |\n| **onuCount** | Number of ONUs. | count |\n| **up / down** | Uplink/downlink traffic. | bytes |\n| **ports** | OLT port statistic list. | -- |\n| **port** | OLT port index. | -- |\n| **status** | Port status. | -- |\n| **tx / rx** | Transmitted/received traffic. | bytes |\n| **txPackets / rxPackets** | Transmitted/received packets. | packets |\n| **txBroadcastPackets / rxBroadcastPackets** | Transmitted/received broadcast packets. | packets |\n| **txMulticastPackets / rxMulticastPackets** | Transmitted/received multicast packets. | packets |\n| **txRate / rxRate** | Transmit/receive rate. | byte/s |\n| **txPacketRate / rxPacketRate** | Transmit/receive packet rate. | packet/s |\n\n#### 5.9.1.6 Notes\n\n1. The `attrs` values are case-sensitive.\n2. If `attrs` contains no valid value for the specified `type`, the API returns an invalid-parameter error.\n3. For **gateway**, **switch**, and **olt**, when any port field is requested, the response contains the `ports` array. If `ports` or `oltPorts` is empty, statistics for all ports are returned.\n4. For **ap**, port parameters are ignored.\n5. The tables list user-facing `attrs` and result field names only. They do not describe internal storage fields or implementation paths.\n6. The OpenAPI schema shows `BaseDeviceStatDTO` because this is a common API. Use this chapter to identify the actual response fields by `type`.","homeCustomPath":"classpath:markdown/openApiHome.md","enableGroup":true,"enableResponseCode":false},"x-markdownFiles":[]}}