The AppNav Statistics service (AppNavStats Web Service) performs one or more of the following actions:
-
retrieveAppNavPassthroughStats
-
retrieveAppNavPolicyStats
-
retrieveOverallAppNavPolicyStats
-
retrieveWNGDistributionStats
-
retrieveWNGDistributionStatsXe
-
retrieveAppNavPassthroughStatsXe
Note that you can request statistics for multiple clusters or controller in any of the above requests.
retrieveAppNavPassthroughStats
Retrieves the pass-through statistics collected on an AppNav controller or cluster.
This API is supported for AppNav-XE device/cluster.
Input Parameters
Parameter
|
Description
|
name
|
An array of ser:name elements, each of which is a string that describes the name of the AppNav controller or cluster.
|
objType
|
An array of ser:objType elements, each of which is a string that describes the object type. Valid values include the following:
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter appNavPTStats[] returns a AppNavPTStats value that provides pass-through statistics.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
AppNavStatsService.retrieveAppNavPassthroughStats: ERROR:Invalid name=
|
The controller or cluster name is invalid.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPassthroughStats: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPassthroughStats: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPassthroughStats: ERROR:Device does not exist.DeviceName=
|
The controller name is not found.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPassthroughStats: ERROR:Cluster does not exist.Cluster=
|
The cluster name is not found.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPassthroughStats: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPassthroughStats: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPassthroughStats: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPassthroughStats: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
AppNavStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
AppNavStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
AppNavStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveAppNavPassthroughStats:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveAppNavPolicyStats
Retrieves the AppNav controller or cluster statistics for a specified policy map/class map pair, including the intercepted,
distributed, and pass-through traffic for the default policy for that pair.
Note |
The parameter classMapName is not supported for IOS-XE devices/Cluster. Please use API without classMapName for IOS-XE devices/Cluster
: " + deviceName.
|
Input Parameters
Parameter
|
Description
|
name
|
An array of ser:name elements, each of which is a string that describes the name of the AppNav controller or cluster.
|
objType
|
An array of ser:objType elements, each of which is a string that describes the object type. Valid values include the following:
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
policyMapName
|
A string that describes the name of the policy map.
|
classMapName
|
A string that describes the name of the class map.
|
Return
The output parameter AppNavPolicyStats[] returns a AppNavStats value that provides information about the intercepted traffic, pass-through traffic, and redirected
traffic for the specified policy map/class map pair.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
AppNavStatsService.retrieveAppNavPolicyStats: ERROR:Invalid name=
|
The controller or cluster name is invalid.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPolicyStats: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPolicyStats: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPolicyStats: ERROR:Device does not exist.DeviceName=
|
The controller name is not found.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPolicyStats: ERROR:Cluster does not exist.Cluster=
|
The cluster name is not found.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPolicyStats: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPolicyStats: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPolicyStats: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPolicyStats: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPolicyStats:ERROR:PolicyMapName does not exist. PolicyMapName :
|
The Policy Map Name is not valid.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPolicyStats:ERROR:The parameter classMapName is not supported for IOS-XE devices/Cluster.
Please use API without classMapName for IOS-XE devices/Cluster :
|
The Policy Map Name is not supported for IOS-XE devices/Cluster.
|
AxisFault
|
AppNavStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
AppNavStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
AppNavStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveAppNavPolicyStats:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveOverallAppNavPolicyStats
Retrieves the overall AppNav controller or cluster statistics, including the intercepted, distributed, and pass-through traffic
for the default policy.
This API is supported for AppNav-XE device/cluster.
Input Parameters
Parameter
|
Description
|
name
|
An array of ser:name elements, each of which is a string that describes the name of the AppNav controller or cluster.
|
objType
|
An array of ser:objType elements, each of which is a string that describes the object type. Valid values include the following:
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter AppNavOverallPolicyStats[] returns a AppNavOverallStats value that provides overall traffic information for the controller or cluster.
Type
|
String
|
Description
|
RemoteException
|
AppNavStatsService.retrieveOverallAppNavPolicyStats: ERROR:Invalid name=
|
The controller or cluster name is invalid.
|
RemoteException
|
AppNavStatsService.retrieveOverallAppNavPolicyStats: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
AppNavStatsService.retrieveOverallAppNavPolicyStats: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
AppNavStatsService.retrieveOverallAppNavPolicyStats: ERROR:Device does not exist.DeviceName=
|
The controller name is not found.
|
RemoteException
|
AppNavStatsService.retrieveOverallAppNavPolicyStats: ERROR:Cluster does not exist.Cluster=
|
The cluster name is not found.
|
RemoteException
|
AppNavStatsService.retrieveOverallAppNavPolicyStats: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
AppNavStatsService.retrieveOverallAppNavPolicyStats: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
AppNavStatsService.retrieveOverallAppNavPolicyStats: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
AppNavStatsService.retrieveOverallAppNavPolicyStats: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
AppNavStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
AppNavStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
AppNavStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveOverallAppNavPolicyStats:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveWNGDistributionStats
Retrieves AppNav controller received and redirected data statistics for a specified WAAS Node Group.
This API is supported for AppNav-XE device/cluster.
Input Parameters
Parameter
|
Description
|
name
|
An array of ser:name elements, each of which is a string that describes the name of the AppNav controller or cluster.
|
objType
|
An array of ser:objType elements, each of which is a string that describes the object type. Valid values include the following:
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
wngName
|
A string that describes the name of the WAAS Node Group.
|
Return
The output parameter AppnavWNGDistributionstats[] returns a AppNavRedStats value that provides information about the number of received and redirected bytes for the specified
WAAS Node Group. The XML output values will include the WN names only if the WNG name is passed as a parameter.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStats: ERROR:Invalid name=
|
The controller, cluster, or WNG name is invalid.
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStats: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStats: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStats: ERROR:Device does not exist.DeviceName=
|
The controller name is not found.
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStats: ERROR:Cluster does not exist.Cluster=
|
The cluster name is not found.
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStats: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStats: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStats: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStats: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
AppNavStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
AppNavStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
AppNavStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveWNGDistributionStats:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveWNGDistributionStatsXe
Retrieves AppNav-XE controller received and redirected data statistics for a specified WAAS Node Group.
Note |
This API is supported only for IOS-XE devices/Cluster. Please use API without context for non IOS-XE devices/Cluster : "
+ deviceName.
|
Input Parameters
Parameter
|
Description
|
name
|
An array of ser:name elements, each of which is a string that describes the name of the AppNav-XE controller or cluster.
|
objType
|
An array of ser:objType elements, each of which is a string that describes the object type. Valid values include the following:
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
wngName
|
A string that describes the name of the WAAS Node Group.
|
context
|
A string that describes the name of the Service Context.
|
Result
The output parameter AppnavWNGDistributionstats[] returns a AppNavRedStats value that provides information about the number of received and redirected bytes for the specified
WAAS Node Group.
Exception
Type
|
String
|
Description
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStatsXe:ERROR:WNG does not exist for the given context. WNGName :
|
Wrong WNG Name has been given for the context.
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStatsXe:ERROR:Service Context does not exist. Service Context :
|
The Service context name is not valid.
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStatsXe:ERROR:WNG does not exist. WNGName :
|
The WNG Name is not valid.
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStatsXe: ERROR:Invalid name=
|
The controller, cluster, or WNG name is invalid.
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStatsXe: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStatsXe: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStatsXe: ERROR:Device does not exist.DeviceName=
|
The controller name is not found.
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStatsXe: ERROR:Cluster does not exist.Cluster=
|
The cluster name is not found.
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStatsXe: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStatsXe: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStatsXe: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
AppNavStatsService.retrieveWNGDistributionStatsXe: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
AppNavStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
AppNavStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
AppNavStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveWNGDistributionStatsXe:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveAppNavPassthroughStatsXe
Retrieves the pass-through statistics collected on an AppNav-XE controller or cluster.
Note |
This API is supported only for IOS-XE devices/Cluster. Please use API without context for non IOS-XE devices/Cluster : "
+ deviceName.
|
Input Parameters
Parameter
|
Description
|
name
|
An array of ser:name elements, each of which is a string that describes the name of the AppNav-XE controller or cluster.
|
objType
|
An array of ser:objType elements, each of which is a string that describes the object type. Valid values include the following:
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
context
|
A string that describes the name of the Service Context.
|
Result
The output parameter appNavPTStats[] returns a AppNavPTStats value that provides pass-through statistics.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
AppNavStatsService.retrieveAppNavPassthroughStatsXe:ERROR:Service Context does not exist. Service Context :
|
The Service context name is not valid
|
RemoteException
|
AppNavStatsService.retrieveAppNavPassthroughStatsXe: ERROR:Invalid name=
|
The controller or cluster name is invalid.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPassthroughStatsXe: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPassthroughStatsXe: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPassthroughStatsXe: ERROR:Device does not exist.DeviceName=
|
The controller name is not found.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPassthroughStatsXe: ERROR:Cluster does not exist.Cluster=
|
The cluster name is not found.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPassthroughStatsXe: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPassthroughStatsXe: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPassthroughStatsXe: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
AppNavStatsService.retrieveAppNavPassthroughStatsXe: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
AppNavStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
AppNavStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
AppNavStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveAppNavPassthroughStatsXe:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|