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.
There is a WADL document available that describes the resources API.
Name | Path | Methods | Description |
---|---|---|---|
AAAPolicyManager |
|
|
AAAPolicyManager - This resource manager serves all resource requests and initiates all operations on the AAAPolicy entity. |
AccessControlManager |
|
|
AccessControlManager -
This resource manager serves all resource requests and initiates all operations on a AccessControlMacList entity. |
AccessPointManager |
|
|
This resource manager serves all resource requests and initiates all operations on the AccessPoint entity. |
AdministratorManager |
|
|
AdministratorManager - This resource manager serves all resource requests and initiates all operations on the administrator entity. |
AdspManager |
|
|
AirDefenseManager - Air Defense Resource Manager
This resource manager will serve all resource requests and initiate all operations on Air Defense entity |
AuditlogManager |
|
|
AuditlogManager
This resource manager serves all resource requests and initiates all operations on the Auditlog entity. |
CaptivePortalManager |
|
|
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 |
|
|
CoSManager -
This resource manager serves all resource requests and initiates all operations on a CoS entity. |
CustomerManager |
|
|
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 |
|
|
DeviceImageManager - This resource manager serves all resource requests and initiates all operations on the DeviceImage entity. |
DeviceManager |
|
|
AbstractManager - Handles all common methods across all resource managers. |
DeviceRegistrar |
|
|
DeviceRegistrar - This resource serves all of the requests related to device and site registration. |
DiagnosticManager |
|
|
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 |
|
|
DpiSignatureManager - This resource manager serves all resource requests and initiates all operations on the DpiSignature entity. |
EntityStateManager |
|
|
State Retriever Manager - This resource manager serves all resource requests and initiates all operations on the State Retriever entity. |
EventsManager |
|
|
Events Manager -
This resource manager serves all resource requests and initiates all operations on events entities. |
ExtendedBridgeManager |
|
|
ExtendedBridgeManager - This resource manager serves all resource requests and initiates all operations on the extended bridge entity. |
GlobalSettingManager |
|
|
Global Settings Manager - This resource manager serves all resource requests and initiates all operations related to global settings. |
IotProfileManager |
|
|
IotProfileManager - This resource manager serves all resource requests and initiates all operations on the IotProfile entity. |
LegacyLogsDownloadManager |
|
|
LegacyLogsDownloadManager - This resource provides the links to download the legacy audit and event logs from S3. |
LicenseManager |
|
|
AbstractManager - Handles all common methods across all resource managers. |
MLAGManager |
|
|
MLAGManager - This resource manager serves all resource requests and initiates all operations on the MLAGManager entity. |
MSPManager |
|
|
MSPManager - This resource manager serves all resource requests and initiates all operations on the MSP entity. |
MapStatsManager |
|
|
Serves all RF Planner requests related to viewing and editing of floors, as well as calculating their maps (heat map, channel map, etc.). |
NetworkTopologyManager |
|
|
Network Topology Manager |
NotificationManager |
|
|
NotificationManager - This resource manager serves all resource requests and initiates all operations on a notification entity. |
OrderManager |
|
|
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 |
|
|
PocManager - This manager serves all resource requests and initiates all operations on the PoC entity. |
ProfileManager |
|
|
Profile resource manager
This resource manager will serve all resource requests and initiate all operations on a profile entity |
RadioManager |
|
|
RadioManager - This resource manager serves all resource requests and initiates all operations related to access point (AP) radios. |
|
|
|
|
RateLimiterManager |
|
|
RateLimiterManager - This resource manager serves all resource requests and initiates all operations on the RateLimiter entity. |
ReportTemplateManager |
|
|
AbstractManager - Handles all common methods across all resource managers. |
ReportsManager |
|
|
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 |
|
|
RfMgmtPolicyManager - This resource manager serves all resource requests and initiates all operations on the RfMgmtPolicy entity. |
RoleManager |
|
|
RoleManager - This resource manager serves all resource requests and initiates all operations on the Role entity. |
ServiceManager |
|
|
ServiceManager - This resource manager serves all resource requests and initiates all operations on the Service entity. |
SiteManager |
|
|
SiteManager - This resource manager serves all resource requests and initiates all operations on a Site entity. |
StatisticsManager |
|
|
Access Point Manager -
This resource manager serves all resource requests and initiates all operations on an access point entity. |
SwitchManager |
|
|
SwitchManager - This resource manager serves all resource requests and initiates all operations on the Switch entity. |
TenantSNMPConigurationManager |
|
|
TenantSNMPConigurationManager - This resource manager serves all resource requests and initiates all operations on the TenantSNMPConiguration entity. |
TopologyGroupManager |
|
|
TopologyGroupManager - This resource manager serves all resource requests and initiates all operations on the topologyGroup entity. |
TopologyManager |
|
|
TopologyManager - This resource manager serves all resource requests and initiates all operations on the Topology entity. |
UpgradeScheduleManager |
|
|
UpgradeScheduleManager - This resource manager provides methods to get, create, update and cancel the upgrade schedules. |
XLocationManager |
|
|
XLocationManager - This resource manager serves all resource requests and initiates all operations on the XLocation entity. |
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.
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 | |
|
|
|
|
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. |
|
|
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. |
|
|
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 | |
|
|
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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. |
|
|
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 | |
|
|
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. |
|
|
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 | |
|
|
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 |
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:
|
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:
|
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 | |
|
|
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. |
|
|
XaiActivityTypeReportEnum | |
XaiChannelElement | |
XaiChannelElementBandSettings | |
XaiRfPolicyElement | This POJO is for the XAI RF Policy configuration. |
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 |