The Traffic Acceleration service (TrafficStats Web Service) performs one or more of the following actions:
-
getAllClassMap
-
getMonitoredApplications
-
retrieveAppTrafficStats
-
retrieveAverageThroughPutClassStats
-
retrieveAverageThroughPutStats
-
retrieveClassTrafficStats
-
retrieveConnection
-
retrieveConnectionTrendClassStats
-
retrieveConnectionTrendStats
-
retrieveCPUUtilization
-
retrievePeakThroughPutClassStats
-
retrievePeakThroughPutStats
-
retrieveTrafficStats
getAllClassMap
Retrieves all of the monitored class map names.
Input Parameter
None.
Return
The output parameter ClassMaps[] returns an array of ClassMaps values, each of which lists the name of a monitored class map.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
TrafficStatsService.getAllClassMap: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
TrafficStatsService.getAllClassMap: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
TrafficStatsService.getAllClassMap: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
TrafficStatsService.getAllClassMap: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
TrafficStatsService.getAllClassMap: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
TrafficStatsService.getAllClassMap: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
TrafficStatsService.getAllClassMap: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
TrafficStatsService.getAllClassMap: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
TrafficStatsService.getAllClassMap: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
TrafficStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
TrafficStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
TrafficStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
getAllClassMap:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
getMonitoredApplications
Retrieves a list of all types of applications known in the scope of the system.
Input Parameter
The keyword name requires a string that describes the name application. Note: The input parameter name is optional and is not used.
Return
The output parameter MonitoredApps[] returns a list of all applicable application names and the monitoring status.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
TrafficStatsService.getMonitoredApplications:ERROR:Invalid name=
|
Unhandled exception.
|
AxisFault
|
TrafficStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
TrafficStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
TrafficStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
getMonitoredApplications:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveAppTrafficStats
Retrieves overall traffic statistics collected on either a WAE device, WAEs within a device group, or all WAEs system wide.
The traffic is further filtered based on the specified application names.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
Note: name is not used for filtering the data.
|
objType
|
A string that describes the object type. Valid values include the following:
-
wae
-
waegroup
-
devicegroup
-
system
|
trafficType
|
A string that describes the type of traffic. Valid values include the following:
Note: trafficType is not used for filtering the data.
|
direction
|
A string that describes the direction of the traffic. Valid values include the following:
-
inbound
-
outbound
-
bidirectional
Note: direction is not used for filtering the data.
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency. If the custom option is not selected for
this filter, the start time and end time will be ignored.
|
applicationName
|
A string value that specifies an application. Each application should be specified in an <serv:appName> element.
|
Return
The output parameter TrafficStats[] returns a TrafficStats value that provides an array of traffic statistics.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
TrafficStatsService.retrieveAppTrafficStats: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
TrafficStatsService.retrieveAppTrafficStats: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
TrafficStatsService.retrieveAppTrafficStats: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
TrafficStatsService.retrieveAppTrafficStats: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
TrafficStatsService.retrieveAppTrafficStats: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
TrafficStatsService.retrieveAppTrafficStats: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
TrafficStatsService.retrieveAppTrafficStats: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
TrafficStatsService.retrieveAppTrafficStats: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
TrafficStatsService.retrieveAppTrafficStats: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
TrafficStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
TrafficStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
TrafficStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveAppTrafficStats:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveAverageThroughPutClassStats
Retrieves average throughput counts for a set of class map names.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
-
wae
-
waegroup
-
device
-
devicegroup
-
system
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
classNames
|
A set of zero or more classNames elements, each of which is a string that describes a single class map name.
|
Return
The output parameter AverageThroughputClassStats[] returns an array of AverageThroughputClassStats values, each of which lists the average throughput counts for a specific
class map name.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
TrafficStatsService.retrieveAverageThroughPutClassStats : ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
TrafficStatsService.retrieveAverageThroughPutClassStats : ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
TrafficStatsService.retrieveAverageThroughPutClassStats : ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
TrafficStatsService.retrieveAverageThroughPutClassStats : ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
TrafficStatsService.retrieveAverageThroughPutClassStats : ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
TrafficStatsService.retrieveAverageThroughPutClassStats : ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
TrafficStatsService.retrieveAverageThroughPutClassStats : ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
TrafficStatsService.retrieveAverageThroughPutClassStats : ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
TrafficStatsService.retrieveAverageThroughPutClassStats : ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
TrafficStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
TrafficStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
TrafficStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveAverageThroughPutClassStats :The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveAverageThroughPutStats
Retrieves the average throughput values collected on a device.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
-
wae
-
device
-
devicegroup
-
location
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
applicationName
|
A string value that includes a comma-separated list of all required application names.
|
Return
The output parameter AverageThroughPutStats[] returns an array of AverageThroughPutStats values, each of which provides information about the traffic processed for a
specific application on the WAE device.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
TrafficStatsService.retrieveAverageThroughPutStats: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
TrafficStatsService.retrieveAverageThroughPutStats: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
TrafficStatsService.retrieveAverageThroughPutStatss: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
TrafficStatsService.retrieveAverageThroughPutStats: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
AxisFault
|
TrafficStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
TrafficStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
TrafficStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveTrafficStats:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveClassTrafficStats
Retrieves traffic byte counts for the specified class map names.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
-
wae
-
waegroup
-
device
-
devicegroup
-
system
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
classNames
|
A set of zero or more classNames elements, each of which is a string that describes a single class map name.
|
Return
The output parameter ClassifierStats[] returns an array of ClassifierStats values, each of which lists the traffic bytes counts for a specific class map name.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
TrafficStatsService.retrieveClassTrafficStats : ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
TrafficStatsService.retrieveClassTrafficStats : ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
TrafficStatsService.retrieveClassTrafficStats : ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
TrafficStatsService.retrieveClassTrafficStats : ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
TrafficStatsService.retrieveClassTrafficStats : ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
TrafficStatsService.retrieveClassTrafficStats : ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
TrafficStatsService.retrieveClassTrafficStats : ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
TrafficStatsService.retrieveClassTrafficStats : ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
TrafficStatsService.retrieveClassTrafficStats : ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
TrafficStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
TrafficStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
TrafficStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveClassTrafficStats :The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveConnection
Retrieves overall connection details for the current time.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
-
wae
-
device
-
devicegroup
-
location
|
srcip
|
A string that contains the source IP address, which is ignored if the string is empty.
|
dstip
|
A string that contains the destination IP address, which is ignored if the string is empty.
|
srcport
|
A string that contains the source port number, which is ignored if the string is empty.
|
dstport
|
A string that contains the destination port number, which is ignored if the string is empty.
|
Return
The output parameter ConnectionStats[] returns a ConnectionStats value that provides a list of connections.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
TrafficStatsService.retrieveConnection: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
TrafficStatsService.retrieveConnection: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
TrafficStatsService.retrieveConnection: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
TrafficStatsService.retrieveConnection: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
AxisFault
|
TrafficStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
TrafficStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
TrafficStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveTrafficStats:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveConnectionTrendClassStats
Retrieves connection counts for the specified set of class map names.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
-
wae
-
waegroup
-
device
-
devicegroup
-
system
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
classNames
|
A set of zero or more classNames elements, each of which is a string that describes a single class map name.
|
Return
The output parameter ConnectionTrendClassStats[] returns an array of ConnectionTrendClassStats values, each of which contains connection trend details for a specific class
map name.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
TrafficStatsService.retrieveConnectionTrendClassStats : ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
TrafficStatsService.retrieveConnectionTrendClassStats : ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
TrafficStatsService.retrieveConnectionTrendClassStats : ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
TrafficStatsService.retrieveConnectionTrendClassStats : ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
TrafficStatsService.retrieveConnectionTrendClassStats : ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
TrafficStatsService.retrieveConnectionTrendClassStats : ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
TrafficStatsService.retrieveConnectionTrendClassStats : ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
TrafficStatsService.retrieveConnectionTrendClassStats : ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
TrafficStatsService.retrieveConnectionTrendClassStats : ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
TrafficStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
TrafficStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
TrafficStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveConnectionTrendClassStats :The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveConnectionTrendStats
Retrieves overall connection trend details of applications collected on a device.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the device, device group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
-
wae
-
waegroup
-
device
-
devicegroup
-
location
-
system
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
applicationName
|
A string value that includes a comma-separated list of all required application names.
|
Return
The output parameter ConnectionTrendStats[] returns an array of ConnectionTrendStats values, each of which provides connection trend details for a specific application.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
TrafficStatsService.retrieveConnectionTrendStats: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
TrafficStatsService.retrieveConnectionTrendStats: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
TrafficStatsService.retrieveConnectionTrendStats: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
TrafficStatsService.retrieveConnectionTrendStats: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
AxisFault
|
TrafficStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
TrafficStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
TrafficStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveTrafficStats:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveCPUUtilization
Retrieves the CPU utilization information for a specified WAE.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE.
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter CPUUtilizationStats[] returns a CPUUtilizationStats value that provides an array of CPU utilization statistics for various time points.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
TrafficStatsService.retrieveCPUUtilization: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
TrafficStatsService.retrieveCPUUtilization: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
TrafficStatsService.retrieveCPUUtilization: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
TrafficStatsService.retrieveCPUUtilization: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
TrafficStatsService.retrieveCPUUtilization: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
TrafficStatsService.retrieveCPUUtilization: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
TrafficStatsService.retrieveCPUUtilization: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
TrafficStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
TrafficStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
TrafficStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveTrafficStats:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrievePeakThroughPutClassStats
Retrieves peak throughput values for the specified set of class map names.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
-
wae
-
waegroup
-
device
-
devicegroup
-
system
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
classNames
|
A set of zero or more classNames elements, each of which is a string that describes a single class map name.
|
Return
The output parameter PeakThroughputClassStats[] returns an array of PeakThroughPutClassStats values, each of which lists the peak throughput values for a specific class
map name.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
TrafficStatsService.retrievePeakThroughPutClassStats : ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
TrafficStatsService.retrievePeakThroughPutClassStats : ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
TrafficStatsService.retrievePeakThroughPutClassStats : ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
TrafficStatsService.retrievePeakThroughPutClassStats : ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
TrafficStatsService.retrievePeakThroughPutClassStats : ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
TrafficStatsService.retrievePeakThroughPutClassStats : ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
TrafficStatsService.retrievePeakThroughPutClassStats : ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
TrafficStatsService.retrievePeakThroughPutClassStats : ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
TrafficStatsService.retrievePeakThroughPutClassStats : ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
TrafficStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
TrafficStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
TrafficStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrievePeakThroughPutClassStats :The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrievePeakThroughPutStats
Retrieves the peak throughput values collected on a device.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
-
wae
-
device
-
devicegroup
-
location
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
applicationName
|
A string value that includes a comma-separated list of all required application names.
|
Return
The output parameter PeakThroughPutStats[] returns an array of PeakThroughPutStats values, each of which provides information about the traffic processed for a specific
application on the WAE device.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
TrafficStatsService.retrievePeakThroughPutStats: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
TrafficStatsService.retrievePeakThroughPutStats: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
TrafficStatsService.retrievePeakThroughPutStats: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
TrafficStatsService.retrievePeakThroughPutStats: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
TrafficStatsService.retrievePeakThroughPutStats: ERROR:UnSupported frequency=
|
The frequency is not supported.
|
AxisFault
|
TrafficStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
TrafficStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
TrafficStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveTrafficStats:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveTrafficStats
Retrieves the overall statistics collected on either a WAE device, WAEs within a device group, or all WAEs system wide.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
-
wae
-
waegroup
-
device
-
devicegroup
-
system
|
trafficType
|
A string that describes the type of traffic. Valid values include the following:
Note: trafficType is not used in filtering the data.
|
direction
|
A string that describes the direction of the traffic. Valid values include the following:
-
inbound
-
outbound
-
bidirectional
Note: direction is not used in filtering the data.
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter TrafficStats[] returns a TrafficStats value that provides an array of traffic statistics.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
TrafficStatsService.retrieveTrafficStats: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
TrafficStatsService.retrieveTrafficStats: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
TrafficStatsService.retrieveTrafficStats: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
TrafficStatsService.retrieveTrafficStats: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
TrafficStatsService.retrieveTrafficStats: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
TrafficStatsService.retrieveTrafficStats: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
TrafficStatsService.retrieveTrafficStats: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
TrafficStatsService.retrieveTrafficStats: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
TrafficStatsService.retrieveTrafficStats: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
TrafficStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
TrafficStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
TrafficStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveTrafficStats:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveDeviceStats
Retrieves the overall device statistics for the traffic details collected on either a WAE device, WAEs within a device group,
or all WAEs system wide.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
-
wae
-
waegroup
-
device
-
devicegroup
-
system
|
Return
The output parameter DeviceStats[] returns a DeviceStats value that provides an array of traffic statistics for the device.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
DeviceStatsService.retrieveDeviceStats: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
DeviceStatsService.retrieveDeviceStats: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
DeviceStatsService.retrieveDeviceStats: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
DeviceStatsService.retrieveDeviceStats: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
DeviceStatsService.retrieveDeviceStats: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
DeviceStatsService.retrieveDeviceStats: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
DeviceStatsService.retrieveDeviceStats: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
DeviceStatsService.retrieveDeviceStats: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
DeviceStatsService.retrieveDeviceStats: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
DeviceStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
DeviceStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
DeviceStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveDeviceStats:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|