Traffic Acceleration Service
This chapter describes the Traffic Acceleration service, which returns traffic and application statistics for individual WAEs, device groups, and for the WAAS network.
The Traffic Acceleration service (TrafficStats Web Service) performs one or more of the following actions:
Syntax
Service URL: https:// <host/ip> :8443/ws/ TrafficStats
WSDL URL: https:// <host/ip> :8443/ws/ TrafficStats?wsdl
To obtain a description of all the operations and parameters for the TrafficStats service, submit a URL to the service with the suffix ?wsdl as follows:
https://<host/ip>:8443/ws/TrafficStats?wsdl
To obtain management information using the Central Manager monitoring API, first call the service by using the service URL for this service as follows:
https://<host/ip>:8443/ws/TrafficStats
Next, submit a SOAP request written in XML format to retrieve the information.
The following example shows an XML-formatted SOAP request to perform the retrieveTrafficStats action. The request includes the input parameters for this particular action shown in bold. The next example shows the XML response that contains the output values for this action.
Example Request
<?xml version="1.0" encoding="utf-8" ?>
- <soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
- <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:Username>admin</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">default</wsse:Password>
- <ns2:retrieveTrafficStats xmlns:ns2="http://service.stats.ws.waas.cisco.com">
<ns2:name>ce-119-40</ns2:name>
<ns2:objType>wae</ns2:objType>
<ns2:trafficType>ttype</ns2:trafficType>
<ns2:direction>bidirectional</ns2:direction>
<ns5:endTime xmlns:ns5="http://util.ws.waas.cisco.com/xsd">2008-01-25T08:00:00.000Z</ns5:endTime>
<ns5:frequency xmlns:ns5="http://util.ws.waas.cisco.com/xsd">lastday</ns5:frequency>
<ns5:startTime xmlns:ns5="http://util.ws.waas.cisco.com/xsd">2008-01-25T08:00:00.000Z</ns5:startTime>
<ns5:timezone xmlns:ns5="http://util.ws.waas.cisco.com/xsd">UTC</ns5:timezone>
</ns2:retrieveTrafficStats>
Example Response
<?xml version="1.0" encoding="utf-8" ?>
- <soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
- <ns:retrieveTrafficStatsResponse xmlns:ns="http://service.stats.ws.waas.cisco.com" xmlns:ax25="http://io.java/xsd" xmlns:ax24="http://rmi.java/xsd" xmlns:ax26="http://util.ws.waas.cisco.com/xsd" xmlns:ax27="http://stats.ws.waas.cisco.com/xsd">
- <ns:return type="com.cisco.waas.ws.stats.TrafficStats">
<ax27:applicationname xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true" />
<ax27:compressedin>278892</ax27:compressedin>
<ax27:compressedout>167328</ax27:compressedout>
<ax27:endtime>2008-04-15T21:00:00.000Z</ax27:endtime>
<ax27:frequency>hour</ax27:frequency>
<ax27:passthroughintermediatein>55773</ax27:passthroughintermediatein>
<ax27:passthroughintermediateout>55773</ax27:passthroughintermediateout>
<ax27:passthroughoverloadin>41823</ax27:passthroughoverloadin>
<ax27:passthroughoverloadout>55773</ax27:passthroughoverloadout>
<ax27:passthroughpeerin>111546</ax27:passthroughpeerin>
<ax27:passthroughpeerout>111546</ax27:passthroughpeerout>
<ax27:passthroughpolicyin>83655</ax27:passthroughpolicyin>
<ax27:passthroughpolicyout>111546</ax27:passthroughpolicyout>
<ax27:starttime>2008-04-15T20:00:00.000Z</ax27:starttime>
<ax27:uncompressedin>1673361</ax27:uncompressedin>
<ax27:uncompressedout>3346731</ax27:uncompressedout>
.
.
.
</ns:retrieveTrafficStatsResponse>
getAllClassMap
Retrieves all of the monitored class map names.
Return
The output parameter ClassMaps[] returns an array of ClassMaps values, each of which lists the name of a monitored class map.
Exceptions
|
|
|
|
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
|
|
|
|
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
|
|
|
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. |
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
|
|
|
|
RemoteException |
TrafficStatsService.retrieveAppTraffic
Stats: ERROR:Invalid name= |
The device name is invalid. |
RemoteException |
TrafficStatsService.retrieveAppTraffic
Stats: ERROR:Invalid objType= |
The object type name is invalid. |
RemoteException |
TrafficStatsService.retrieveAppTraffic
Stats: ERROR:Invalid TimeFrame |
The timeframe is invalid. |
RemoteException |
TrafficStatsService.retrieveAppTraffic
Stats: ERROR:Device does not exist.DeviceName= |
The device name is not found. |
RemoteException |
TrafficStatsService.retrieveAppTraffic
Stats: ERROR:Device Group does not exist.DeviceGroup= |
The device group name is not found. |
RemoteException |
TrafficStatsService.retrieveAppTraffic
Stats: ERROR:Invalid frequency= |
The frequency is invalid. |
RemoteException |
TrafficStatsService.retrieveAppTraffic
Stats: ERROR:Invalid startTime= |
The start time is invalid. |
RemoteException |
TrafficStatsService.retrieveAppTraffic
Stats: ERROR:Invalid endTime= |
The end time is invalid. |
RemoteException |
TrafficStatsService.retrieveAppTraffic
Stats: 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
|
|
|
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
|
|
|
|
RemoteException |
TrafficStatsService.retrieveAverage
ThroughPutClassStats : ERROR:Invalid name= |
The device name is invalid. |
RemoteException |
TrafficStatsService.retrieveAverage
ThroughPutClassStats : ERROR:Invalid objType= |
The object type name is invalid. |
RemoteException |
TrafficStatsService.retrieveAverage
ThroughPutClassStats : ERROR:Invalid TimeFrame |
The timeframe is invalid. |
RemoteException |
TrafficStatsService.retrieveAverage
ThroughPutClassStats : ERROR:Device does not exist.DeviceName= |
The device name is not found. |
RemoteException |
TrafficStatsService.retrieveAverage
ThroughPutClassStats : ERROR:Device Group does not exist.DeviceGroup= |
The device group name is not found. |
RemoteException |
TrafficStatsService.retrieveAverage
ThroughPutClassStats : ERROR:Invalid frequency= |
The frequency is invalid. |
RemoteException |
TrafficStatsService.retrieveAverage
ThroughPutClassStats : ERROR:Invalid startTime= |
The start time is invalid. |
RemoteException |
TrafficStatsService.retrieveAverage
ThroughPutClassStats : ERROR:Invalid endTime= |
The end time is invalid. |
RemoteException |
TrafficStatsService.retrieveAverage
ThroughPutClassStats : 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
|
|
|
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
|
|
|
|
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
|
|
|
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
|
|
|
|
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
|
|
|
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
|
|
|
|
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
|
|
|
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
|
|
|
|
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
|
|
|
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
|
|
|
|
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
|
|
|
name |
A string that describes the name of the WAE, WAE group, or system. |
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
|
|
|
|
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
|
|
|
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
|
|
|
|
RemoteException |
TrafficStatsService.retrievePeak
ThroughPutClassStats : ERROR:Invalid name= |
The device name is invalid. |
RemoteException |
TrafficStatsService.retrievePeak
ThroughPutClassStats : ERROR:Invalid objType= |
The object type name is invalid. |
RemoteException |
TrafficStatsService.retrievePeak
ThroughPutClassStats : ERROR:Invalid TimeFrame |
The timeframe is invalid. |
RemoteException |
TrafficStatsService.retrievePeak
ThroughPutClassStats : ERROR:Device does not exist.DeviceName= |
The device name is not found. |
RemoteException |
TrafficStatsService.retrievePeak
ThroughPutClassStats : ERROR:Device Group does not exist.DeviceGroup= |
The device group name is not found. |
RemoteException |
TrafficStatsService.retrievePeak
ThroughPutClassStats : ERROR:Invalid frequency= |
The frequency is invalid. |
RemoteException |
TrafficStatsService.retrievePeak
ThroughPutClassStats : ERROR:Invalid startTime= |
The start time is invalid. |
RemoteException |
TrafficStatsService.retrievePeak
ThroughPutClassStats : ERROR:Invalid endTime= |
The end time is invalid. |
RemoteException |
TrafficStatsService.retrievePeak
ThroughPutClassStats : 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
|
|
|
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
|
|
|
|
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
|
|
|
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
|
|
|
|
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. |
Feedback