Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

Name Path Methods Description
AAAPolicyManager
  • /v1/aaapolicy
  • /v1/aaapolicy/{id}
  • /v1/aaapolicy/{policyId}
  • GET, POST
  • GET, PUT
  • DELETE
AAAPolicyManager - This resource manager serves all resource requests and initiates all operations on the AAAPolicy entity.
AccessControlManager
  • /v1/accesscontrol
  • GET, POST, PUT
AccessControlManager -
This resource manager serves all resource requests and initiates all operations on a AccessControlMacList entity.
AccessPointManager
  • /v1/aps
  • /v1/aps/clone
  • /v1/aps/default
  • /v1/aps/displaynames
  • /v1/aps/manualupgradeschedule
  • /v1/aps/paginator
  • /v1/aps/partnumbers
  • /v1/aps/reboot
  • /v1/aps/upgradeschedule
  • /v1/aps/{apSerialNumber}
  • /v1/aps/all/{tenantId}
  • /v1/aps/antenna/{apSerialNumber}
  • /v1/aps/{apSerialNumber}/logs
  • /v1/aps/{apSerialNumber}/password
  • /v1/aps/{apSerialNumber}/realcapture
  • /v1/aps/{apSerialNumber}/reboot
  • /v1/aps/{apSerialNumber}/reset
  • /v1/aps/{apSerialNumber}/ssh
  • /v1/aps/{apSerialNumber}/traceurls
  • /v1/aps/{apSerialNumber}/upgrade
  • /v1/aps/{apserialnum}/stations
  • GET
  • POST
  • GET
  • GET
  • PUT
  • GET
  • GET
  • PUT
  • PUT
  • DELETE, GET, PUT
  • GET
  • GET
  • PUT
  • PUT
  • PUT
  • PUT
  • PUT
  • PUT
  • GET
  • PUT
  • GET
This resource manager serves all resource requests and initiates all operations on the AccessPoint entity.
AdministratorManager
  • /v1/acceptancerecords
  • /v1/adlogin
  • /v1/administrators
  • /v1/oictoken
  • /v1/acceptancerecords/duration
  • /v1/administrators/adminpassword
  • /v1/administrators/backupcodes
  • /v1/administrators/default
  • /v1/administrators/expiredpassword
  • /v1/administrators/feedbacks
  • /v1/administrators/password
  • /v1/administrators/resetpassword
  • /v1/administrators/role
  • /v1/administrators/securityanswer
  • /v1/administrators/securitysettings
  • /v1/administrators/{userId}
  • /v1/administratorsTimeout/{userId}
  • /v1/oauth2/introspecttoken
  • /v1/oauth2/mfatoken
  • /v1/oauth2/refreshToken
  • /v1/oauth2/token
  • /v1/administrators/activate/{activateId}
  • /v1/administrators/contract/{contractId}
  • /v1/administrators/mfa/{userId}
  • /v1/administrators/password/{userId}
  • /v1/administrators/resetpassword/emailnotification
  • /v1/administrators/{userId}/feedbacks
  • /v1/oauth2/token/{token}
  • GET
  • GET
  • GET, POST
  • POST
  • GET
  • PUT
  • GET
  • POST
  • POST
  • GET, PUT
  • POST
  • POST
  • PUT
  • PUT
  • GET, PUT
  • DELETE, GET, PUT
  • PUT
  • POST
  • POST
  • POST
  • POST
  • GET
  • GET
  • PUT
  • GET
  • POST
  • POST
  • DELETE
AdministratorManager - This resource manager serves all resource requests and initiates all operations on the administrator entity.
AdspManager
  • /v4/adsp
  • /v4/adsp/default
  • /v4/adsp/nametoidmap
  • /v4/adsp/{adspId}
  • GET, POST
  • GET
  • GET
  • DELETE, GET, PUT
AirDefenseManager - Air Defense Resource Manager
This resource manager will serve all resource requests and initiate all operations on Air Defense entity
AuditlogManager
  • /v1/auditlogs
  • GET
AuditlogManager
This resource manager serves all resource requests and initiates all operations on the Auditlog entity.
CaptivePortalManager
  • /v1/captiveportals
  • /v1/captiveportals/default
  • /v1/captiveportals/usagereports
  • /v1/captiveportals/{captivePortalId}
  • GET, POST
  • GET
  • GET
  • DELETE, GET, PUT
CaptivePortalManager - This resource manager serves all resource requests and initiates all operations on a CaptivePortal entity. Note: APIs in this resource are not supported anymore
CoSManager
  • /v1/cos
  • /v1/cos/default
  • /v1/cos/nametoidmap
  • /v1/cos/{cosId}
  • GET, POST
  • GET
  • GET
  • DELETE, GET, PUT
CoSManager -
This resource manager serves all resource requests and initiates all operations on a CoS entity.
CustomerManager
  • /v1/customers
  • /v1/endcustomers
  • /v1/customers/activesessions
  • /v1/customers/merge
  • /v1/customers/move
  • /v1/tenants/merge
  • /v1/customers/findcustomer/{matchedString}
  • GET
  • GET
  • GET
  • PUT
  • PUT
  • PUT
  • GET
CustomerManager - This resource manager serves resource requests for the customer entity within Extreme Networks GTAC. Currently, the CustomerManager only supports "get all" customers for GTAC account.
DeviceImageManager
  • /v1/deviceimages
  • /v1/deviceimages/{hwType}
  • DELETE, GET, POST, PUT
  • GET
DeviceImageManager - This resource manager serves all resource requests and initiates all operations on the DeviceImage entity.
DeviceManager
  • /v1/devices/adoptionrules
  • GET, PUT
AbstractManager - Handles all common methods across all resource managers.
DeviceRegistrar
  • /v1/deviceregistration
  • /v1/deviceregistration/ap/{tenantId}
  • /v1/deviceregistration/switch/{tenantId}
  • POST
  • POST
  • POST
DeviceRegistrar - This resource serves all of the requests related to device and site registration.
DiagnosticManager
  • /v1/diagnostics/database
  • /v1/diagnostics/eventlogger
  • /v1/diagnostics/jobstore
  • /v1/diagnostics/notificationservice
  • /v1/diagnostics/scheduleLoatTest
  • /v1/diagnostics/scheduler
  • /v1/diagnostics/statisticsprocessor
  • /v1/diagnostics/statisticsrecorder
  • /v1/diagnostics/trapreceiver
  • /v1/tools/statisticsprocessor
  • /v1/diagnostics/statemanager/{serial}
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
Diagnostic Resource Manager This resource manager provides a path for obtaining diagnostics information from the deployment. This API is not a public API, and it is not integrated with any other code. NOTE: A tenant ID must be included with the DEV_OPS access token in the Bearer header to provide a customer context. -H "Authorization: Bearer access-token tenant-id" This API is designed to be used with curl, for example: curl -X POST -H "Content-Type:text/plain" -H "Accept:text/plain" -H "Authorization: Bearer 09c9f2eb809b87f8f90664a8bb55e08d 4-25ROO1C" --data "tenant.reports" http://10.49.24.108:8080/management/v1/diagnostics/databaseThis resource manager provides a path for obtaining diagnostics information from the deployment. This API is not a public API, and it is not integrated with any other code. NOTE: A tenant ID must be included with the DEV_OPS access token in the Bearer header to provide a customer context. -H "Authorization: Bearer access-token tenant-id" This API is designed to be used with curl, for example: curl -X POST -H "Content-Type:text/plain" -H "Accept:text/plain" -H "Authorization: Bearer 09c9f2eb809b87f8f90664a8bb55e08d 4-25ROO1C" --data "tenant.reports" http://10.49.24.108:8080/management/v1/diagnostics/database
DpiSignatureManager
  • /v1/dpisignatures
  • /v3/dpisignatures
  • /v1/dpisignatures/custom
  • /v3/dpisignatures/custom
  • GET, PUT
  • GET, PUT
  • GET
  • GET
DpiSignatureManager - This resource manager serves all resource requests and initiates all operations on the DpiSignature entity.
EntityStateManager
  • /v1/state/aps
  • /v1/state/entityDistribution
  • /v1/state/sites
  • /v1/state/summary
  • /v1/state/switches
  • /v1/state/aps/{apSerialNumber}
  • /v1/state/mlags/all
  • /v1/state/mlags/{mlagId}
  • /v1/state/msp/tenantdetails
  • /v1/state/msp/tenantdistribution
  • /v1/state/sites/{siteId}
  • /v1/state/summary/{tenantId}
  • /v1/state/switches/environment
  • /v1/state/switches/ports
  • /v1/state/switches/{switchSerialNumber}
  • /v1/state/upgrade/devicedistribution
  • /v1/state/upgrade/faileddevices
  • /v1/state/msp/upgrade/devicedistribution
  • /v1/state/msp/upgrade/faileddevices
  • /v1/state/msp/upgrade/tenantdetails
  • /v1/state/msp/upgrade/tenantdistribution
  • /v1/state/sites/{siteId}/aps
  • /v1/state/sites/{siteId}/groups
  • /v1/state/sites/{siteId}/switches
  • /v1/state/switches/{switchSerialNumber}/environment
  • /v1/state/switches/{switchSerialNumber}/ports
  • /v1/state/sites/{siteId}/groups/{groupId}
  • /v1/state/sites/{siteId}/groups/{groupId}/aps
  • /v1/state/sites/{siteId}/groups/{groupId}/switches
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
State Retriever Manager - This resource manager serves all resource requests and initiates all operations on the State Retriever entity.
EventsManager
  • /v1/events/aps/{serialNo}
  • /v1/events/sites/{siteId}
  • /v1/events/stations/{mac}
  • /v1/events/switches/{serialNo}
  • /v1/events/stations/{mac}/widgets
  • GET
  • GET
  • GET
  • GET
  • GET
Events Manager -
This resource manager serves all resource requests and initiates all operations on events entities.
ExtendedBridgeManager
  • /v1/extendedbridges
  • /v1/extendedbridges/nametoidmap
  • /v1/extendedbridges/{id}
  • GET
  • GET
  • GET
ExtendedBridgeManager - This resource manager serves all resource requests and initiates all operations on the extended bridge entity.
GlobalSettingManager
  • /v1/globalSettings
  • GET, POST
Global Settings Manager - This resource manager serves all resource requests and initiates all operations related to global settings.
IotProfileManager
  • /v3/iotprofile
  • /v3/iotprofile/default
  • /v3/iotprofile/nametoidmap
  • /v3/iotprofile/{iotprofileId}
  • GET, POST
  • GET
  • GET
  • DELETE, GET, PUT
IotProfileManager - This resource manager serves all resource requests and initiates all operations on the IotProfile entity.
LegacyLogsDownloadManager
  • /v1/legacyaudits/{mspname}
  • /v1/legacyevents/{tenantid}
  • GET
  • GET
LegacyLogsDownloadManager - This resource provides the links to download the legacy audit and event logs from S3.
LicenseManager
  • /v1/licenses/xai/activityreport
  • /v1/licenses/xai/asudetailsreport
  • /v1/licenses/xai/supported
  • /v1/licenses/xai/testactivationreport
  • /v1/licenses/xai/activityreport/{tenantId}
  • /v1/licenses/sites/{siteId}/devicegroups/{deviceGroupId}
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
AbstractManager - Handles all common methods across all resource managers.
MLAGManager
  • /v1/mlagpeers
  • /v1/mlagpeers/{id}
  • GET, POST
  • DELETE, GET, PUT
MLAGManager - This resource manager serves all resource requests and initiates all operations on the MLAGManager entity.
MSPManager
  • /v1/mspadministrators
  • /v1/msppartners
  • /v1/msps
  • /v1/msptenants
  • /v1/mspadministrators/{tenantId}
  • /v1/mspadministrators/{userId}
  • /v1/msppartners/nametoidmap
  • /v1/msppartners/{tenantId}
  • /v1/msps/nametoidmap
  • /v1/msps/{tenantId}
  • /v1/msptemplate/{id}
  • /v1/msptenants/nametoidmap
  • /v1/msptenants/{tenantId}
  • /v1/msp/briefsites/{tenantId}
  • /v1/msptemplate/type/{typeId}
  • GET, POST
  • GET, POST
  • GET, POST
  • GET, POST
  • PUT
  • DELETE, GET
  • GET
  • DELETE, GET, PUT
  • GET
  • GET, PUT
  • GET
  • GET
  • DELETE, GET, PUT
  • GET
  • GET
MSPManager - This resource manager serves all resource requests and initiates all operations on the MSP entity.
MapStatsManager
  • /v1/maps/calculate
  • /v1/maps/plan
  • /v1/maps/floor/{floorUuid}
  • /v1/maps/plan/{siteUuid}
  • /v1/maps/floor/aps/{apSerial}
  • /v1/maps/floor/switches/{switchSerial}
  • POST
  • POST
  • DELETE, GET
  • GET
  • GET
  • GET
Serves all RF Planner requests related to viewing and editing of floors, as well as calculating their maps (heat map, channel map, etc.).
NetworkTopologyManager
  • /v1/topology/nodes
  • /v1/topology/sites/{siteId}/nodes
  • GET, PUT
  • GET
Network Topology Manager
NotificationManager
  • /v1/notifications
  • /v1/notifications/regional
  • /v1/notifications/{notificationid}
  • GET, POST
  • GET
  • DELETE, PUT
NotificationManager - This resource manager serves all resource requests and initiates all operations on a notification entity.
OrderManager
  • /v1/deviceentitlements
  • /v1/vouchers
  • /v1/customers/{tenantId}
  • /v1/delete/deviceentitlements
  • /v1/deviceentitlements/assign
  • /v1/deviceentitlements/beforeexpired
  • /v1/deviceentitlements/getlist
  • /v1/deviceentitlements/mappartnumtohwtype
  • /v1/deviceentitlements/unassign
  • /v1/deviceentitlements/{tenantId}
  • /v1/sample/deviceentitlements
  • /v1/update/deviceentitlements
  • /v1/vouchers/{tenantId}
  • /v1/deviceentitlements/beforeexpired/{tenantId}
  • /v1/devices/registered/{serialNumber}
  • /v1/vouchers/{serialNumber}/associate
  • GET
  • GET
  • DELETE
  • POST
  • PUT
  • GET
  • POST
  • GET
  • PUT
  • GET
  • GET
  • POST
  • GET
  • GET
  • GET
  • PUT
OrderManager - This resource manager serves requests on device entitlements for callers that have the ERP admin role. The primary methods used by Extreme Business Systems are the 'update' and 'delete' methods. The others are meant for debugging and support. It is possible to delete 'all' data associated with a customer with this interface !!! DO NOT USE THIS WITHOUT EXPLICIT PERMISSION. !!!
PocManager
  • /v1/poc
  • /v1/salesengineers
  • /v1/poc/salesengineer
  • /v1/poc/{accountCsn}
  • /v1/pocs/activityreport
  • /v1/poc/salesengineer/{userId}
  • /v1/poc/{accountCsn}/{id}
  • /v1/poc/{id}/{timestamp}
  • /v1/pocs/activityreport/{id}
  • POST, PUT
  • GET
  • POST
  • GET
  • GET
  • DELETE, GET, PUT
  • DELETE
  • GET
  • GET
PocManager - This manager serves all resource requests and initiates all operations on the PoC entity.
ProfileManager
  • /v3/profiles
  • /v3/profiles/nametoidmap
  • /v3/profiles/{profileId}
  • GET, POST
  • GET
  • DELETE, GET, PUT
Profile resource manager
This resource manager will serve all resource requests and initiate all operations on a profile entity
RadioManager
  • /v1/radio1/smartrfchannels
  • /v1/radio2/smartrfchannels
  • /v1/radios/channels
  • /v1/radios/modes
  • /v3/radios/modes
  • /v3/radios/smartrfchannels
  • /v4/radios/channels
  • /v4/radios/modes
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • PUT
  • PUT
RadioManager - This resource manager serves all resource requests and initiates all operations related to access point (AP) radios.
RadiusServerManager
  • /v1/radiusservers
  • /v1/radiusservers/default
  • GET
  • GET
RadiusServerManager - This resource manager serves all resource requests and initiates all operations on the RADIUS server entity.
RateLimiterManager
  • /v1/ratelimiters
  • /v1/ratelimiters/nametoidmap
  • /v1/ratelimiters/{rateLimiterId}
  • GET, POST
  • GET
  • DELETE, GET, PUT
RateLimiterManager - This resource manager serves all resource requests and initiates all operations on the RateLimiter entity.
ReportTemplateManager
  • /v1/reports/generated
  • /v1/reports/scheduled
  • /v1/reports/templates
  • /v1/reports/widgetdefinitions
  • /v1/reports/generated/bulkdelete
  • /v1/reports/generated/{filename}
  • /v1/reports/scheduled/bulkdelete
  • /v1/reports/scheduled/{scheduledReportId}
  • /v1/reports/templates/{templateId}
  • GET
  • GET, POST
  • GET, POST
  • GET
  • POST
  • DELETE, GET
  • POST
  • DELETE, GET, PUT
  • DELETE, GET, PUT
AbstractManager - Handles all common methods across all resource managers.
ReportsManager
  • /v1/report/msp
  • /v1/report/sites
  • /v1/report/aps/{apSerialNumber}
  • /v1/report/extendedbridge/{ebuuid}
  • /v1/report/lagports/{portId}
  • /v1/report/msp/devicestatedistribution
  • /v1/report/msp/topapsbyclientcount
  • /v1/report/msp/topapsbythroughput
  • /v1/report/msp/topclientsbythroughput
  • /v1/report/msp/topswitchesbythroughput
  • /v1/report/msp/toptenantsbyapcount
  • /v1/report/msp/toptenantsbyclientcount
  • /v1/report/msp/toptenantsbycriticaldevicespercentage
  • /v1/report/msp/toptenantsbydevicecount
  • /v1/report/msp/toptenantsbyswitchcount
  • /v1/report/msp/toptenantsbythroughput
  • /v1/report/ports/{portId}
  • /v1/report/roles/{roleId}
  • /v1/report/services/security
  • /v1/report/services/{serviceId}
  • /v1/report/sites/{siteId}
  • /v1/report/stations/{stationId}
  • /v1/report/switches/{switchSerialNumber}
  • /v1/report/upgrade/global
  • /v1/report/upgrade/sites
  • /v1/report/details/appgroupsbyclientcount/sites
  • /v1/report/details/appgroupsbythroughput/sites
  • /v1/report/msp/devicestatedistribution/devicedetails
  • /v1/report/sites/widget/{widgetId}
  • /v1/report/upgrade/devices/{deviceSerialNumber}
  • /v1/report/upgrade/sites/nosite
  • /v1/report/upgrade/sites/{siteId}
  • /v1/report/aps/{apSerialNumber}/widget/{widgetId}
  • /v1/report/details/appgroupsbyclientcount/aps/{apSerialNumber}
  • /v1/report/details/appgroupsbyclientcount/roles/{roleId}
  • /v1/report/details/appgroupsbyclientcount/services/{serviceId}
  • /v1/report/details/appgroupsbyclientcount/sites/{siteId}
  • /v1/report/details/appgroupsbythroughput/aps/{apSerialNumber}
  • /v1/report/details/appgroupsbythroughput/roles/{roleId}
  • /v1/report/details/appgroupsbythroughput/services/{serviceId}
  • /v1/report/details/appgroupsbythroughput/sites/{siteId}
  • /v1/report/details/appgroupsbythroughput/stations/{stationId}
  • /v1/report/manualupgrade/sites/{siteId}/devices
  • /v1/report/ports/{portId}/widget/{widgetId}
  • /v1/report/roles/{roleId}/widget/{widgetId}
  • /v1/report/services/{serviceId}/widget/{widgetId}
  • /v1/report/sites/{siteId}/widget/{widgetId}
  • /v1/report/stations/{stationId}/widget/{widgetId}
  • /v1/report/switches/{switchSerialNumber}/widget/{widgetId}
  • /v1/report/upgrade/sites/{siteId}/devices
  • /v1/report/upgrade/tenants/{tenantid}/orphandevices
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
ReportsManager - This resource manager serves all resource requests and initiates all operations on tenant, site, service, AP, station, switch, port, role or application reports.
RfMgmtPolicyManager
  • /v3/rfmgmt
  • /v3/rfmgmt/default
  • /v3/rfmgmt/nametoidmap
  • /v3/rfmgmt/{rfmgmtId}
  • GET, POST
  • GET
  • GET
  • DELETE, GET, PUT
RfMgmtPolicyManager - This resource manager serves all resource requests and initiates all operations on the RfMgmtPolicy entity.
RoleManager
  • /v1/roles
  • /v3/roles
  • /v1/roles/appFilters
  • /v1/roles/default
  • /v1/roles/nametoidmap
  • /v1/roles/{captiveportalid}
  • /v1/roles/{roleId}
  • /v3/roles/appFilters
  • /v3/roles/default
  • /v3/roles/nametoidmap
  • /v3/roles/{roleId}
  • /v1/roles/{roleid}/stations
  • GET, POST
  • GET, POST
  • PUT
  • GET
  • GET
  • POST
  • DELETE, GET, PUT
  • PUT
  • GET
  • GET
  • DELETE, GET, PUT
  • GET
RoleManager - This resource manager serves all resource requests and initiates all operations on the Role entity.
ServiceManager
  • /v1/services
  • /v1/services/default
  • /v1/services/nametoidmap
  • /v1/services/{serviceId}
  • /v1/services/{serviceId}/deviceids
  • /v1/services/{serviceId}/siteids
  • /v1/services/{serviceid}/stations
  • GET, POST
  • GET
  • GET
  • DELETE, GET, PUT
  • GET
  • GET
  • GET
ServiceManager - This resource manager serves all resource requests and initiates all operations on the Service entity.
SiteManager
  • /v1/sites
  • /v1/snmp
  • /v2/sites
  • /v2/snmp
  • /v3/sites
  • /v3/snmp
  • /v1/sites/default
  • /v1/sites/discoveredAps
  • /v1/sites/nametoidmap
  • /v1/sites/{siteId}
  • /v1/snmp/default
  • /v2/sites/default
  • /v2/sites/nametoidmap
  • /v2/sites/{siteId}
  • /v2/snmp/default
  • /v3/sites/default
  • /v3/sites/nametoidmap
  • /v3/sites/paginator
  • /v3/sites/{siteId}
  • /v3/snmp/default
  • /v1/sites/clone/{siteId}
  • /v1/sites/{siteID}/discoveredAps
  • /v1/sites/{siteId}/acs
  • /v1/sites/{siteid}/stations
  • /v2/sites/clone/{siteId}
  • /v2/sites/{siteId}/acs
  • /v3/sites/clone/{siteId}
  • /v3/sites/{siteId}/acs
  • GET, POST
  • GET
  • GET, POST
  • GET
  • GET, POST
  • GET
  • GET
  • GET
  • GET
  • DELETE, GET, PUT
  • GET
  • GET
  • GET
  • DELETE, GET, PUT
  • GET
  • GET
  • GET
  • GET
  • DELETE, GET, PUT
  • GET
  • POST
  • GET
  • POST
  • GET
  • POST
  • POST
  • POST
  • POST
SiteManager - This resource manager serves all resource requests and initiates all operations on a Site entity.
StatisticsManager
  • /v1/stations
  • /v1/stations/{macaddress}
  • GET
  • GET
Access Point Manager -
This resource manager serves all resource requests and initiates all operations on an access point entity.
SwitchManager
  • /v1/switches
  • /v1/switches/categories
  • /v1/switches/clone
  • /v1/switches/default
  • /v1/switches/displaynames
  • /v1/switches/manualupgradeschedule
  • /v1/switches/partnumbers
  • /v1/switches/portmanager
  • /v1/switches/ports
  • /v1/switches/reboot
  • /v1/switches/upgradeschedule
  • /v1/switches/{serialNumber}
  • /v1/switches/all/{tenantId}
  • /v1/switches/{serialNumber}/clibackups
  • /v1/switches/{serialNumber}/login
  • /v1/switches/{serialNumber}/logs
  • /v1/switches/{serialNumber}/ports
  • /v1/switches/{serialNumber}/realcapture
  • /v1/switches/{serialNumber}/reboot
  • /v1/switches/{serialNumber}/reset
  • /v1/switches/{serialNumber}/traceurls
  • /v1/switches/{serialNumber}/upgrade
  • /v1/switches/{serialNumber}/cliconfigs/backup
  • /v1/switches/{serialNumber}/configurationmode/{configurationMode}
  • /v1/switches/{serialNumber}/console/{consoleAction}
  • /v1/switches/{serialNumber}/ports/{portNumber}
  • /v1/switches/{serialNumber}/cliconfigs/restore/{name}
  • /v1/switches/{serialNumber}/slots/{slotNumber}/ports/{portNumber}
  • GET
  • GET
  • POST
  • GET
  • GET
  • PUT
  • GET
  • POST
  • POST
  • PUT
  • PUT
  • DELETE, GET, PUT
  • GET
  • GET
  • PUT
  • PUT
  • GET
  • PUT
  • PUT
  • PUT
  • GET
  • PUT
  • PUT
  • PUT
  • PUT
  • GET, PUT
  • PUT
  • GET, PUT
SwitchManager - This resource manager serves all resource requests and initiates all operations on the Switch entity.
TenantSNMPConigurationManager
  • /v1/trapreceivers
  • /v1/trapreceivers/{tenantId}
  • GET, POST, PUT
  • DELETE
TenantSNMPConigurationManager - This resource manager serves all resource requests and initiates all operations on the TenantSNMPConiguration entity.
TopologyGroupManager
  • /v1/topologygroups
  • /v1/topologygroups/nametoidmap
  • /v1/topologygroups/{topologyGroupId}
  • GET, POST
  • GET
  • DELETE, GET, PUT
TopologyGroupManager - This resource manager serves all resource requests and initiates all operations on the topologyGroup entity.
TopologyManager
  • /v1/topologies
  • /v3/topologies
  • /v1/topologies/default
  • /v1/topologies/nametoidmap
  • /v1/topologies/{topologyId}
  • /v3/topologies/default
  • /v3/topologies/nametoidmap
  • /v3/topologies/{topologyId}
  • GET, POST
  • GET, POST
  • GET
  • GET
  • DELETE, GET, PUT
  • GET
  • GET
  • DELETE, GET, PUT
TopologyManager - This resource manager serves all resource requests and initiates all operations on the Topology entity.
UpgradeScheduleManager
  • /v1/upgradeschedules
  • /v1/upgradeschedulesites
  • /v1/upgradeschedules/cancellation
  • /v1/upgradeschedules/reset
  • /v1/upgradeschedulesites/cancellation
  • GET, POST, PUT
  • GET, POST
  • PUT
  • PUT
  • PUT
UpgradeScheduleManager - This resource manager provides methods to get, create, update and cancel the upgrade schedules.
XLocationManager
  • /v3/xlocation
  • /v3/xlocation/default
  • /v3/xlocation/nametoidmap
  • /v3/xlocation/{xlocationId}
  • GET, POST
  • GET
  • GET
  • DELETE, GET, PUT
XLocationManager - This resource manager serves all resource requests and initiates all operations on the XLocation entity.

Services

Namespace http://getupgradekey.licensing_webservice_sync_wsd_provider.nc_wm9_d1.extremenetworks.com/ (wsdl)
Name Description
GetUpgradeKeyPortType This class was generated by the JAX-WS RI. JAX-WS RI 2.2.6-1b01 Generated source version: 2.2

The services API is also accessible by a set of client-side libraries that can be downloaded from the files and libraries page.

Data Types

JSON

Default Namespace
Type Description
AAAPolicyElement This POJO represents the AAA policy.
AbstractEntity
AccessControlMacList This POJO represents a user or organization that has purchased at least one ExtremeCloud edge device and has an active service contract. A customer is connected (data-wise) to ExtremeCloud through the Extreme Networks ERP system.
AccessLevel
AccessPointAntennaInfoElement A POJO representing the configuration details about the access point antenna types and sockets.
AccessPointElement This POJO represents an access point being managed by ExtremeCloud service.
AccountEntity
AccountState
AclTemplate
AcsChannelSelection1
AcsChannelSelection2
Action
ActionRequired
ActivationElement A record describing one of activation of a feature. The activation can contain or permit many instances of the single feature.
AdminChangePasswordElement
AdminChangeSecurityAnswerElement
AdminRoleElement This POJO represents function that is responsible for modifying the administrator's role by DEVOPS.
AdministratorElement This POJO represents the a person or function that is responsible for administering the customer sites. Three types of administrator exist. A full administrator has the complete ability to configure any of the customer sites, networks, devices, or roles, and assign users to roles. A read-only administrator can view and report on the status of the customer sites but cannot make configuration changes. A guest access administrator is typically a non-technical person responsible for creating temporary accounts for guest network access.
AdspProfileV4Element
AdspServerAddressElement POJO containing the Adsp server address and port number.
AllowedRangeElement This Pojo represents type of allowed IP address ranges
AntennaElement A POJO representing the configuration of the antenna socket and model ID.
AntennaSocketElement A POJO representing the configuration of the antenna socket.
AntennaTypeElement A POJO representing the configuration of the antenna type.
ApElement Representation of an access point (or AP) used in the definition of site plans and various simulations (eg: heat-map, channel-map, etc).
These APs are positioned on a FloorElement and have impact on the simulations depending on their configuration (eg channel, transmit power, etc).
ApEnvironment
ApSerialList Contain a list of AP serial numbers.
ApStatusElement
ApplianceElement A POJO for the switch appliance details.
AreaElement Representation of a FloorElement area, also referred to as a "floor boundary".
It consists of a series of 2d coordinate pairs that form a LinearRingElement, thus defining a floor's boundary (or exterior walls).
AreasElement Representation of the areas associated with a FloorElement, also referred to as boundaries.
Although rf-maps supports a list of such areas, the UI currently allows only one such definition per FloorElement. Most likely it exists for backwards-compatibility reasons only.
AssetElement This POJO contains fields to hold data about the assets.
AssetType
AssignEntitlementElement This POJO contains the fields for assigning entiltlement.
AsuGetDetailsResponseElement
AsuTestActivateResponseElement
AuditlogElement An element representing the audit log details.
AuditlogQueryElement Represents the audit log query details.
AutoLogin
BPEConfigElement This POJO represents the configurations for a BPE.
BandAwareMapsOfBasicMap
BandAwareMapsOfBasicMapWithLegend
BandAwareMapsOfHeatMap
BaseBatchedDataPointElement
BasicMap
BasicMapWithLegend
BasicReportElement
BasicRollupDataPointElement
BatchDeleteRequestElement
BatchedBasicRollupDataPointElement
BatchedSetRollupDataPointElement
BatchedThroughputDataPointsElement
BridgePortExtenderElement This POJO represents an Extreme Networks Bridge Port Extender device being managed by ExtremeCloud.
BridgingMode
CalculateRequest
CalculateResponse
Capacity
CaptivePortalElement A captive portal is a Web page that the user of a public-access network is obliged to view and interact with before access is granted.
CaptivePortalUsageReportElement
ChannelData
ChannelDistributionElement
ChannelElement
ChannelListElement
ChannelMapColors
ChannelPlan
ChannelWidth
CliConfigElement This class represents the cli config of switch being managed by ExtremeCloud.
CliConfigName
CompositeAPElement A wrapper POJO containing both the status and config data of an AccessPoint.
CompositeSiteElement A wrapper POJO containing both the status and config data of a Site.
ConfigurationMode
ContractInfo
Country
CpAuthType
CpType
CustElement This POJO holds customer information related configurations.
CustomFilterElement This POJO is used to configure custom filtering.
CustomTemplateElement This POJO is used to configure a custom template.
CustomerElement This POJO represents a user or organization that has purchased at least one ExtremeCloud edge device and has an active service contract. A customer is connected (data-wise) to ExtremeCloud through the Extreme Networks ERP system.
CustomerTypeReportEnum
DHCPElement This Pojo holds information about the dhcp configurations.
DHCPPoolElement This Pojo holds information about the dhcp pool configurations.
DHCPServerActivationCriteria
DashboardReportElement
DataPointElement
DataPointMetaDataElement
DefaultAdminElement This POJO represents the default administrator account. This account must be the first administrator account created for this customer under the current contract.
DeploymentIdElement An identifier that the product understands and uses to identify a specific license or activation.

for e.g. UUID - 898406db-a2a7-4baa-99dc-a20d16c678db

DetailedTableDataElement
DetailedTableReportElement
DeviceAdoptionRuleElement This class represents one DeviceAdoptionRule and customer can have 0 or more device adoption rules.
DeviceAssetsUpgradeScheduleElement This Pojo contains information about scheduling Device Assets Upgrade.
DeviceBatchedThroughputStatisticsElement This POJO represents the Usage statistics of particular type of statistic of a device for some time duration. More information on representation of statistics fetched can be found at BatchedThroughputDataPointsElement
DeviceElement A class representing the application of a single device.
DeviceEntitlementElement A class representing the application of a single entitlement to a device, or the bulk entitlement of one or more devices. The primary key of a DeviceEntitlement is the combination of entitlementId + serialNumber (which may be null for bulk entitlements).
DeviceGroupElement A DeviceGroupElement is a single, topologically contiguous location. A Device group consists of a set of ExtremeCloud edge devices and a set of networks offered by the devices. A site must have a minimum of one network.
DeviceGroupElement A DeviceGroupElement is a single, topologically contiguous location. A DeviceGroup consists of a set of ExtremeCloud edge devices and a set of networks offered by the devices. A site must have a minimum of one network.
DeviceGroupLicenseDetails
DeviceImageElement A POJO representing device image.
DeviceImageList A wrapper class to hold a list of device image elements.
DevicePortActionsElement This POJO represents configurations for bulk port actions.
DevicePortElement This pojo contains the details about the device port to be updated.
DevicePortLagAssignmentElement This Pojo contains fields for lag assignment via Port Manager.
DeviceRegistration A POJO representing the minimum identification information about a device that is being registered to be managed by the ExtremeCloud service. Devices registered through this interface typically are Extreme Networks access points and access layer switches.
DeviceReportElement
DeviceThroughputStatisticsElement This POJO represents the Usage statistics of particular type of statistic of a device for some time duration. More information on representation of statistics fetched can be found at ThroughputStatisticsElement
DeviceUpgradeScheduleElement This Pojo holds the information about scheduling the device upgrade schedule.
DeviceUpgradeScheduleReportElement This POJO represents the Upgrade Schedule Report for a device.
DiscoveredAPElement A POJO representing the configuration for the DiscoveredAP element.
DistributionReportElement
DosAction
DosAttacksElement
Dot11nChannelWidth1
Dot11nChannelWidth2
Dot1xElement This POJO represent the 802.1X configuration on the switch.
DpiApplicationElement This POJO represents the application signature.
DpiApplicationElement This POJO represents the application signature.
DpiApplicationListElement A POJO that contains a list of DPI application elements.
DpiApplicationListElement A POJO that contains a list of DPI application elements.
DpiGroupElement This POJO represents the DPI Group element. A user will never pass DpiGroupElement to the backend. This class will be returned only by the backend to the user, so no validation is needed.
DpiSignatureElement This POJO represents the signatures for DPI. It contains the list of groups and the DPI application signature element.
DpiSignatureElement This POJO represents the signatures for DPI. It contains the list of groups and the DPI application signature element.
DwellTimeDataHelperElement
DwellTimeDistributionElement
EffectiveLicenseLevel
EmailNotification
EnforceVersion
EntitlementElement
EntitlementKey
EntitlementReason
EntitlementStatus
EntityDetailsElement
EntityStatusDetailsElement
EntityStatusElement
EntityType
Environment
EthMode
Ethertype
EventElement POJO containing the information about a Event.
EventLogging
EventTarget
ExcludeRangeElement This Pojo contains properties to configure exclude IP Range.
ExpiredPasswordElement This POJO represents the operation of resetting an administrator's expired password.
ExpiringDeviceEntitlementElement This POJO holds information about the expiring device entitlements.
ExtendedBridgeElement This pojo is used to configure an Extended Bridge.
For 4.41 release this element is read-only.
ExtendedBridgeReportElement
FailedDeviceEntitlementElement This Pojo holds information about the failed device entitlements.
FailedDeviceRegistration A simple POJO containing the attributes of a device that could not be registered. The class contains the submitted attributes of the device and information useful for understanding why a failure occurred.
FanStatus
FanTrayElement Represents the details of a fan tray element, which is read-only element and not being used now.
FanTrayStatus
FanTrayStatusElement
FeaturePack
FeedbackElement This POJO represents the feedback received from the customer for the ExtremeCloud product
FilterElement This Pojo contains common Filter fields of L2,L3\L4 & L7 Filters.
FilterElement A pojo containing the Filter data.
FilterName
FirewallPolicyElement This Pojo represents the Firewall policy configurations.
FloorElement Representation of a floor used to define site plans and various simulations (eg: heat map, channel map, etc).
Among other properties, it usually contains a boundary (AreasElement), possibly a list of WallElement, a background and a list of ApElement and SwitchElement that participate in the simulations.
FloorType
FruStatus
FruStatusElement
GeneratedReportAction
GeneratedReportElement This POJO is used to configure the generated reports.
GlobalSettingsElement Contains attributes that can be configured globally per tenant.
GlobalUpgradeScheduleReportElement This POJO represents the global Upgrade Schedule Report.
GroupStatusElement
HardwareImageMappingElement This Pojo holds information about the hardware Image mappings.
HardwareMode
HeatMap
ISCInfoElement This POJO represents the ISC information.
InetAddress
IoTApplicationId
IoTProfileEddystoneAdvertisementElement
IoTProfileElement
IoTProfileThreadGatewayElement
IoTProfileiBeaconAdvertisementElement
IpRangeElement This Pojo holds information about the range of IP address.
IpRouteElement This Pojo represents the IP route configurations.
L2FilterElement This Pojo represents the L2 Filter configurations.
L3FilterElement This Pojo represents the L3 Filter configurations.
L7FilterElement This Pojo represents the L7 Filter configurations.
LAGElement This POJO represents the LAG configuration on a switch.
LLDPElement This POJO represents the LLDP configuration on the switch.
LagAction
LagPortType
LagReportElement * This POJO represents the complete LAG Report comprising of LAG subReports for specific time duration. More information on representation of statistics fetched can be found at BatchedThroughputDataPointsElement
Layout
LedStatus
Legend
LicenseElement This Pojo represents the License details.
LicenseMode
LicenseMode
LicenseModeReportEnum
LinearRingElement A series of 2d coordinate pairs that define the boundary of a FloorElement.
Logging
LoggingLevel
MACAuthElement This POJO represents the MAC authentication configuration on the switch. ExtremeCloud provides macAuth configuration for all ports on the switch, one with macAuth enabled and one with macAuth disabled. In V3.11, if a port has both dot1x and macAuth enabled, ExtremeCloud does not allow the user to specify the order of authentication. ExtremeCloud expects a fixed order of dot1x followed by the macAuth. In future releases this may change by allowing the user to set the authentication order.
MLAGInstanceElement This POJO represents the configuration of MLAG instances with mlagId and mlagPorts.
MLAGPeerElement This POJO represents the configuration for MLAG.
MLAGPortInfoElement This POJO represents information about the MLAG members/ports participating in the MLAG.
MLAGState
MLag
MSPAdministratorElement This POJO represents the MSP administrator configuration.
MSPContactElement This class contains the MSP contact information.
MSPDeviceEntitlementElement This POJO represents the MSP device entitlement configuration.
MSPElement This POJO represents the MSP configuration.
MSPPartnerElement Represents the MSP Partner configuration.
MSPStateDistributionElement
MSPTenantElement This POJO represents the MSP tenant configuration.
MacFormat
ManagementPolicyElement This Pojo represents the management policy configurations.
ManualUpgradeDeviceStatusElement
MaxAllowedPower
MergeElement This POJO represents the merge function of two companies.
MfaCodeType
MfaTokenRequestElement This class represents the request to generate the access token with multifactor authentication code.
MgmtFrameProrection
MgmtFrameProrection
Mode
MspBasicReportElement
MspBriefSiteElement
MspDashboardReportElement
MspDistributionReportElement
MulticastFilterElement A class representing multicast filter rule.
NSightServer
NSightServerPolicyElement This Pojo represents the Nsight server policy configurations.
Node
NotificationElement This POJO represents notification details.
OffChannelScanDataBuffer
OperationalStatus
OrderRequest A class that wraps a list of DeviceEntitlement objects.
PCIDetailsElement This POJO is used to configure the PCI reports.
POCDeviceEntitlementReportElement
POEDisconnectPrecedence
PagedParamsElement The POJO contains all the mandatory and optional fields used in a paginated URL.
PassPhraseInputType
Peer
Period
PeriodElement This POJO is used to the configure the Period information.
PinnedType Representation of the "pinned" state of an ApElement.
It influences some of the rf-maps algorithms, such as auto-placement of APs.
Mapping with the FE requests and responses is done via the ordinal.
PlanElement A representation of a site "map plan" where the user can define and experiment with various FloorElement configurations, and run simulations (eg heat map, channel map, etc) to see how the ApElement placement fares against the floor layout (area coverage, wall interference, etc).
It usually contains a list of FloorElement, each one with their own configuration (boundary - AreasElement, walls - WallElement, APs - ApElement, etc).
PmfMode
PoEElement This Pojo contains information about the PoE configurations.
PoEPortElement This Pojo represents the POE port configurations.
PocActivityReportElement
PocElement This POJO represents creating a PoC, which contains the contact information for an organization.
PocReportElement
PocUdtElement This POJO represents details of a PoC.
PoeDetection
PoePriority
Policy1pPriority
PolicyAccessControlAction
PolicyApplicationRuleTypes
PolicyClassOfServiceElement A class encapsulating the Quality of Service (QoS) settings that can be applied to a frame. This includes assigning a rate limit to the traffic when it is ingressing the network, assigning a rate limit to the traffic when it is egressing the network, and remarking the layer 2 and layer 3 QoS fields so that downstream network elements give the frame appropriate priority handling.
PolicyQoSMarkingElement A class that encapsulates layer 2 and layer 3 quality of service markings. When used in the match portion of a rule it represents the layer 2 and layer 3 markings to match. When used in a Class of Service it indicates whether and if so how a frame should be remarked for quality of service.
PolicyRateLimiterElement A class representing a rate limiter resource on the network element. A rate limiter is assigned to traffic by a policy rule or a role's default action. The rate limiter prevents a station from sending (or receiving) more than a fixed traffic rate when the network is saturated. If a frame being processed would cause the traffic to exceed the rate limiter the frame is dropped. A rate limiter is an actual entity. Different policy rules can share a rate limiter, in which case all traffic assigned to the rate limiter counts against the limit it is monitoring. For example if a role assigns rate limiter 'a' set to 500kbps to traffic destined to port 80 and to traffic destined to port 443 then a station assigned to that role can send a maximum of 500kbps of http and https traffic. Two different rate limiters could be set to the same maximum rate. In that case the rate limiters act independently off of each other. For example rate limiter 'a' might specify a limit of 500kbps and is applied to traffic destined for port 80; rate limiter 'b' also is set to 500kbps and applies to traffic going to port 443. If a single role uses both rate limiters then it allows stations to which the role is applied to send up to 500kbps to port 80 and up to 500kbps to port 443. A single station can be assigned up to 8 distinct ingress rate limiters and 8 distinct egress rate limiters.
PolicyRuleElement Represents a rule that can be associated with roles.
PolicyRuleFiltersOn
PolicyRuleIpSubnetType
PolicyRuleMacAddressType
PolicyRuleProtocolType
PolicyRuleWellKnownPort
Port
PortAdminStatus
PortConfigElement This pojo supports bulk update configurations of Port management
PortElement A POJO that represents a port on an edge switch managed by the ExtremeCloud nms.
PortManagerElement
PortMediaType
PortReportElement * This POJO represents the complete Port Report comprising of many other port related subReports for specific time duration. More information on representation of statistics fetched can be found at BatchedThroughputDataPointsElement
PortSpeedEnum
PortType
PowerSupplyElement Represents the details of the power supply on the switch. It is read-only element and not being used now.
PowerSupplyStatus
PrivacyElement
ProfileElement This Pojo contains the configurations of a Profile. For 4.51.02 release it will be having only airdefenseId.
RFSensitivity
RadioAssignmentElement This Pojo contains information about the Radio Assignment.
RadioBSSIDInfoElement
RadioBand
RadioElement Representation of an ApElement radio describing its current configuration (eg: antenna, channel, etc), statistics (RadioStatsElement) and Status.
It has impact in the simulations corresponding to the associated 2.4GHz or 5GHz band (eg: heat map, channel map, etc).
RadioElement This POJO represents the radio attached to the access point (AP).
RadioMode
RadioModeElement This Pojo represents the Radio Mode configurations.
RadioStatsElement
RadioTxBf
RadiusAuthProtocol
RadiusServerElement This POJO represents the RADIUS server.
RangeType
RecordAcceptanceElement This POJO contains the acceptance details of the terms and conditions accepted by the user.
Recurrence
RedirUrlSelect
RefreshTokenElement
RegistrationFailureReason
RegistrationRequest A simple POJO representing an attempt to register a set of Extreme Network devices to a customer account.
RegistrationResponse A class that contains the response to an attempt to register devices for a customer.
ReportFormat
ReportTemplateElement This POJO is used to configure the report template.
RequestPasswordElement This POJO represents a request to reset an administrator's password.
RequestTokenElement This POJO represents the Oauth2 authorization grant type: password, for example, using the user name and password as an authorization grant to obtain an access token. The grandType must be password.
ResetPasswordElement This POJO represents the operation of resetting the administrator password.
RfMgmtPolicyElement This POJO is for the RfMgmtPolicy configuration. Currently XC only supports XAI.
RfMgmtPolicyType
RoleElement Represents an instance of ExtremeCloud access control policy. It can be used as a default role for a service or it can be sent to the site and will only be used if a RADIUS server assigns it explicitly. It must be assigned to a site to be usable.
RoleElement Represents an instance of ExtremeCloud access control policy. It can be used as a default role for a service or it can be sent to the site and will only be used if a RADIUS server assigns it explicitly. It must be assigned to a site to be usable.
RoleReportElement
Rollup
RssHistElement
SNMPAccessLevel
SNMPAuthAlgorithm
SNMPCommunity This Pojo represents the snmp community configurations.
SNMPElement This Pojo represents the snmp configurations.
SNMPGroup This pojo represents the snmp Group configurations.
SNMPLogging
SNMPNotification This Pojo represents the SnmpNotification configurations.
SNMPPrivAlgorithm
SNMPTrapReceiverElement Represents trap receiver details based on the SNMP version.
SNMPUSMElement This POJO represents the SNMP User-based Security Model specific to Azara.
SNMPUser This Pojo represents the snmp user configurations.
SNMPUserSecurity
SNMPVersion
SNMPv1Element This pojo represents the snmp v1 related configurations.
SNMPv2Element This pojo represents the snmp v2 related configurations.
SNMPv3Element This pojo represents the snmp v3 related configurations.
SNMPv3ParamsElement This entity captures the trap receiver’s SNMPv3 user and authoritative engine ID details.
SSIDClassification
SSIDElement
SSIDStatus
SSIDTimeElement A class representing a one-day time period during which an SSID is enabled. The representation is assumed to be in the user's local time. If the start and stop times are identical, then the SSID is off for the day.
SSIDWeeklyScheduleElement A class representing a weekly schedule for a network service.
STPElement This POJO represents the STP configuration on the switch. ExtremeCloud will set the name and the port to the STP, but will use all other STP parameters as default. All ports have to be listed in both the “spanGuard” and “loopProtect” lists, but in one list it will be enabled and in the other list it will be disabled. It is a very rare case that someone will need to enable both protocols on the same port.
SalesEngineerElement This POJO represents the sales engineer account.
ScheduleInstantElement A class that represents the hour and minute at which an event occurs.
ScheduleLoatTestElement
ScheduleType
ScheduleUpgradeInfoElement This class helps to specify the preferred day of two-week for upgrades and the preferred time of day. A customer only needs to set his preference once per site, and can change them at any time. If the customer does not care, we will pick a day of week for upgrade that allows us to distribute the load on the cloud more uniformly.
ScheduledReportInfoElement This POJO is used to configure the scheduled reports.
ScheduledUserReportElement This POJO is used to configure the scheduled user report.
SecurityPolicySettingsElement This POJO represents the security policy configuration.
Sensitivity
SensorScanMode
ServiceAssignmentElement This object represents the association of a network with a port or radio. This feature is only supported on AP3912.
ServiceElement A set of one or more topologies that also include a network authentication, an authorization strategy, an edge privacy (encryption) policy (open, WPAv2), a default access control policy, and can be enabled or disabled manually or (eventually) on a schedule.
ServiceQuality
ServiceReportElement ServiceReportElement to represent the reporting data for a service. It contains usage data for a specific service like usage statistics, outstanding alerts, device distribution statistics, application distribution statistics, floor plan, busiest access points and busiest users of a site.
ServiceStatsElement This POJO represents the statistics data for a service.
ServiceStatus
ServiceTimeElement A class representing a one day increment of time during which a network service is enabled. The representation is assumed to be in the user's local time. If the start and stop times are identical then the service is off for the day.
ServiceWeeklyScheduleElement A class representing a weekly schedule for a network service.
Severity
Severity
SiteElement A site is a single, topologically contiguous location. A site consists of a set of ExtremeCloud edge devices and a set of networks offered by the devices. A site must have a minimum of one network.
SiteElement A site is a single, topologically contiguous location, which consists of a set of ExtremeCloud edge devices and a set of networks offered by the devices. A site must have a minimum of one network.
SiteElement A site is a single, topologically contiguous location, a site consists of a set of Extreme Online Edge Devices & set of networks offered by the devices. A site must have a minimum of 1 network.
SiteRegistration A POJO representing the minimum identification information about a device that is being registered by the ExtremeCloud service. Devices registered through this interface typically are Extreme Networks access points and access layer switches.
SiteReportElement
SiteStatusElement
SiteType
SiteUpgradeScheduleElement This Pojo represents the Site upgrade schedule configurations.
SiteUpgradeScheduleReportElement This POJO represents the Upgrade Schedule Report for a site.
SiteUpgradeSiteStatusElement This Pojo represents the Site Upgrade status configurations.
SmartRFPolicyElement This POJO is for the Smart RF configuration.
SmartRFPolicyElement This POJO is for Smart RF configuration.
SmartRfChannelPlan
SnmpNotification
SnmpVersion
SpanningTreeVersion
StackTopology
StackingElement A POJO for switch stack details.
State
State
StateDistributionElement
StateToTenantDistributionElement
StationElement
StationEventReportElement
StationReportElement This POJO represents the complete Station Report for specific time duration. The station report describes one host that is using a customer’s network. More information on representation of statistics fetched can be found at List and BatchedCounterDataPointsElement
StatisticDataType
StatisticTargetType
StatisticTypesEnum
Status Radio status matching the one from the rf-engine. Based on this, the GUI will render the AP radio badge icon with a different color:
  • configured ok
  • configured error
  • not configured
  • no badges when configured sensor
Status
Status AP status matching the one from the rf-engine. Based on this, the GUI will render the AP icon with a different color:
  • in service
  • in service trouble
  • critical
  • unknown
Status
StpStatus
SubDevice
SwitchCapabilityElement Represents the capability and software/hardware of a switch. These attributes are all designated as Read Only.
SwitchElement
SwitchElement This POJO represents an Extreme Networks edge switch being managed by ExtremeCloud.
SwitchEnvironmentStatusElement
SwitchLedStatus
SwitchLoginElement The POJO for switch login details.
SwitchPortAttributesElement
SwitchPortCapabilityElement This POJO represents the software and hardware capabilities of a switch port.
SwitchPortStatusElement
SwitchPortStatusInfoElement
SwitchReportElement * This POJO represents the complete Switch Report comprising of many other switch related subReports for specific time duration. More information on representation of statistics fetched can be found at BatchedThroughputDataPointsElement
SwitchSerialNumberList Represents a list of switch serial numbers.
SwitchStatusElement
SyslogElement
SyslogElement The SyslogConfiguration object representing the switch level configuration with a collection of destination IP address of the servers and UDP ports.
SyslogLogging
TableDataElement
TableReportElement
TemperatureElement Contains the temperature details of the switch. This is a read-only element and is not being used now.
TemperatureStatus
TemplateType
TenantMergeElement Represents the merging details of two tenants.
TenantMoveElement
TenantSNMPConfigurationElement The SNMP notification configuration applicable for MSPs and MSP partners. This configuration will be used to send Trap/Inform notifications to the trap receivers at the MSP and MSP partner end.
ThreadGatewayWhiteListElement
ThroughputStatisticsElement This Pojo represents the data usage statistics like successfulReceivedBytes, successfulSentBytes, successfulReceivedPackets, successfulSentPackets for a device/station/site. count - represents number of points included which is equals to values.size() unit - represents unit of measurement like bits/sec. values - represents the actual data point elements of type BasicRollupStatisticsDataPointElement fetched based on query
TimeSeriesSetRollupReportElement
TokenInfoElement
TopologyElement A named VLAN. The VLAN topology is bridged at the access point (AP). The VLAN is named so that it can be referenced from multiple roles and rules.
TopologyElement A named VLAN. The VLAN topology is bridged at the access point (AP). The VLAN is named so that it can be referenced from multiple roles and rules.
TopologyGroupElement This Pojo is used to configure the topology groups.
TrapType
TreeNodeElement This pojo represents the tree node related configurations.
TroubleDescriptionElement
UpdateAdminElement This POJO represents function that is responsible for modifying the administrator.
UpdateAdminTimeoutElement This POJO is used to update the administrator timeout.
UpgradeScheduleDeviceImageElement
UpgradeScheduleElement Represents the upgrade schedule instance.
UserElement This POJO represents a user device connected through an access point. (Commenting out most of the attributes as not support for configuring users until release 1.1.)
UserInfoElement This Pojo represents the User Info configurations.
UserReportScheduleInfoElement This POJO is used to configure the schedule for the User report.
UserReportStatus
VimElement This class represents the vim module.
Vlan
VlanElement
VlanIPAddressElement This Pojo holds config of VlanIPAddress/netmask.
VlanInterfaceElement This POJO contains the configuration information for the VlanInterfaces element.
VoiceAware
VsaType
WallElement Representation of a wall which can be placed on a FloorElement, and which has impact in the simulations (eg: heat map, channel map).
WepElement A class containing the settings required to enable WEP privacy for a network service.
WepKeyLength
WidgetDefinitionElement This POJO is used to configure the widget definition.
WidgetsElement This POJO contains the configuration for the widgets.
WingTrapReceiverElement This POJO is used to configure SNMP trap receivers specific to Azara.
WiredInterfaceAssignmentElement This POJO contains information about the Wired Interface (Port) Assignment.
WiredInterfaceElement This POJO represents the configuration information for wired interfaces.
WizardDataElement A POJO that holds lists of services, sites, roles, topologies, roles, access points, COSs, and rate limiters to help with configuration during the first login.
WpaEnterpriseElement A class that holds all the encryption-related configuration settings for a WLAN service protected by WPA Enterprise (802.1x).
WpaPskElement A class containing the settings required to enable WPA PreShared Key (PSK) privacy for a network service. WPAv2 is the only WPA implementation that can be used, but it is possible to enable legacy TKIP support in conjunction with the modern AES support.
WpaV2Mode
WriteOnlyStringElement
XLocationProfileElement This POJO captures the Extreme Location configuration.
XaiActivityReportElement
XaiActivityTypeReportEnum
XaiChannelElement
XaiChannelElementBandSettings
XaiRfPolicyElement This POJO is for the XAI RF Policy configuration.

XML

Default Namespace (schema)
Type Description
deviceRegistration A POJO representing the minimum identification information about a device that is being registered to be managed by the ExtremeCloud service. Devices registered through this interface typically are Extreme Networks access points and access layer switches.
siteRegistration A POJO representing the minimum identification information about a device that is being registered by the ExtremeCloud service. Devices registered through this interface typically are Extreme Networks access points and access layer switches.
apElement Representation of an access point (or AP) used in the definition of site plans and various simulations (eg: heat-map, channel-map, etc).
These APs are positioned on a FloorElement and have impact on the simulations depending on their configuration (eg channel, transmit power, etc).
areaElement Representation of a FloorElement area, also referred to as a "floor boundary".
It consists of a series of 2d coordinate pairs that form a LinearRingElement, thus defining a floor's boundary (or exterior walls).
areasElement Representation of the areas associated with a FloorElement, also referred to as boundaries.
Although rf-maps supports a list of such areas, the UI currently allows only one such definition per FloorElement. Most likely it exists for backwards-compatibility reasons only.
floorElement Representation of a floor used to define site plans and various simulations (eg: heat map, channel map, etc).
Among other properties, it usually contains a boundary (AreasElement), possibly a list of WallElement, a background and a list of ApElement and SwitchElement that participate in the simulations.
floorType
linearRingElement A series of 2d coordinate pairs that define the boundary of a FloorElement.
pinnedType Representation of the "pinned" state of an ApElement.
It influences some of the rf-maps algorithms, such as auto-placement of APs.
Mapping with the FE requests and responses is done via the ordinal.
radioElement Representation of an ApElement radio describing its current configuration (eg: antenna, channel, etc), statistics (RadioStatsElement) and Status.
It has impact in the simulations corresponding to the associated 2.4GHz or 5GHz band (eg: heat map, channel map, etc).
radioStatsElement
rssHistElement
switchElement
status
wallElement Representation of a wall which can be placed on a FloorElement, and which has impact in the simulations (eg: heat map, channel map).
registrationRequest A simple POJO representing an attempt to register a set of Extreme Network devices to a customer account.
calculateRequest
failedDeviceRegistration A simple POJO containing the attributes of a device that could not be registered. The class contains the submitted attributes of the device and information useful for understanding why a failure occurred.
registrationResponse A class that contains the response to an attempt to register devices for a customer.
registrationFailureReason
holder