- Preface
- Introduction to the Cisco WAAS Central Manager Monitoring API
- Device Configuration Service
- Traffic Acceleration Service
- Events and Status Service
- AppNav Statistics Service
- CIFS Statistics Service
- SMB Statistics Service
- ICA Statistics Service
- HTTP and HTTPS Statistics Services
- MAPI Statistics Service
- NFS Statistics Service
- SSL Statistics Service
- Video Streaming Statistics Service
- Cache Statistics
- Web Service Objects
- Index
Cisco Wide Area Application Services API Reference (Software Version 6.2.3)
Bias-Free Language
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
- Updated:
- April 30, 2013
Chapter: MAPI Statistics Service
- MAPI Statistics Service Syntax
- MAPI Statistics Service Actions
- getDroppedConnCount
- getOptConnCount
- getSessionCount
- getUnaccelConnCount
- retrieveClientConnCount
- retrieveClientSecuredConnCount
- retrieveDataReadStats
- retrieveEncAndNonEncResponseStats
- retrieveEncryptedAndNonEncryptedOptimizedConnCount
- retrieveRequestTypeStats
- retrieveResponseStats
MAPI Statistics Service
This chapter describes the MAPI Statistics service, which returns MAPI data and statistics for individual WAEs, device groups, and for the WAAS network.
MAPI Statistics Service Syntax
This section contains the following topics:
MAPI Statistics Informational URLs
This section provides informational URLs for the MAPI Statistics service.
- Service URL—https:// <host/ip> :8443/ws/ MapiStats
- WSDL URL—https:// <host/ip> :8443/ws/ MapiStats?wsdl
- To obtain a description of all the operations and parameters for the MapiStats Service, submit a URL to the service with the suffix ?wsdl as follows:
https://<host/ip>:8443/ws/MapiStats?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/MapiStats
Next, submit a SOAP request written in an XML format to retrieve the information.
MAPI Statistics Example Request
The following example shows an XML-formatted SOAP request to perform the retrieveDataReadStats action. The request includes the input parameters for this particular action shown in bold. For more information on this action, see retrieveDataReadStats.
MAPI Statistics Example Response
The following example shows the XML response that contains the output values for the retrieveDataReadStats action. For more information on this action, see retrieveDataReadStats.
MAPI Statistics Service Actions
The MAPI Statistics (MapiStats Web Service) performs one or more of the following actions:
- getDroppedConnCount
- getOptConnCount
- getSessionCount
- getUnaccelConnCount
- retrieveClientConnCount
- retrieveClientSecuredConnCount
- retrieveDataReadStats
- retrieveEncAndNonEncResponseStats
- retrieveEncryptedAndNonEncryptedOptimizedConnCount
- retrieveRequestTypeStats
- retrieveResponseStats
getDroppedConnCount
Retrieves a list of dropped connection counts.
Input Parameters
|
|
|
|---|---|
A string that describes the name of the WAE, WAE group, or system. |
|
A string that describes the object type. Valid values include the following: |
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter MapiDroppedConnCount[] returns a MapiDroppedConnCount value that provides dropped connection counts.
Exceptions
|
|
|
|
MapiStatsService.getDroppedConnCount:ERROR:Unable to get MapiDroppedConnCount= |
getOptConnCount
Retrieves a list of optimized connection counts.
Input Parameters
|
|
|
|---|---|
A string that describes the name of the WAE, WAE group, or system. |
|
A string that describes the object type. Valid values include the following: |
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter MapiOptConnCount[] returns a MapiClientSecuredConnCount value that provides optimized connection counts.
Exceptions
|
|
|
|
getSessionCount
Retrieves the number of MAPI sessions completed on either a WAE device, WAEs within a device group, or all WAEs system wide.
Input Parameters
|
|
|
|---|---|
A string that describes the name of the WAE, WAE group, or system. |
|
A string that describes the object type. Valid values include the following: |
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter MapiSessionCount[] returns a HttpsStats value that provides the number of sessions completed.
Exceptions
getUnaccelConnCount
Retrieves a list of unaccelerated connection counts.
Input Parameters
|
|
|
|---|---|
A string that describes the name of the WAE, WAE group, or system. |
|
A string that describes the object type. Valid values include the following: |
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter MapiUnaccelConnCount[] returns a MapiUnaccelConnCount value that provides unaccelerated connection counts.
Exceptions
|
|
|
|
MapiStatsService.getUnaccelConnCount:ERROR:Unable to get MapiUnaccelConnCount= |
retrieveClientConnCount
Retrieves the number of past connections from each client type on either a WAE device, WAEs within a device group, or all WAEs system wide.
Input Parameters
|
|
|
|---|---|
A string that describes the name of the WAE, WAE group, or system. |
|
A string that describes the object type. Valid values include the following: |
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter MapiClientConnCount[] returns a MapiClientConnCount value that provides the number of past connections from each client type.
Exceptions
retrieveClientSecuredConnCount
Retrieves the number of secured client connections from each Outlook version on either a WAE device, WAEs within a device group, or all WAEs system wide.
Input Parameters
|
|
|
|---|---|
A string that describes the name of the WAE, WAE group, or system. |
|
A string that describes the object type. Valid values include the following: |
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter MapiClientSecuredConnCount[] returns MapiClientSecuredConnCount value that provides the count of encrypted client connections for each version of Outlook.
Exceptions
retrieveDataReadStats
Retrieves the MAPI date read statistics collected on either a WAE device, WAEs within a device group, or all WAEs system wide.
Input Parameters
|
|
|
|---|---|
A string that describes the name of the WAE, WAE group, or system. |
|
A string that describes the object type. Valid values include the following: |
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter MapiDataReadStats[] returns a MapiDataReadStats value that provides the minimum, maximum, and average size of the SychronizationGetBuffer, the ReadStream, and the accumulated read ahead.
Exceptions
retrieveEncAndNonEncResponseStats
Retrieves encrypted and unencrypted connection count and response time information.
Input Parameters
|
|
|
|---|---|
A string that describes the name of the WAE, WAE group, or system. |
|
A string that describes the object type. Valid values include the following: |
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter MAPIEncAndNonEncResponseStats[] returns a MapiEncAndNonEncResponseStats value that specifies the number of encrypted and unencrypted connections, along with the average local and response times for encrypted and unencrypted connections.
Exceptions
retrieveEncryptedAndNonEncryptedOptimizedConnCount
Retrieves counts of the encrypted and unencrypted connections optimized by the MAPI Application Optimizer.
Input Parameters
|
|
|
|---|---|
A string that describes the name of the WAE, WAE group, or system. |
|
A string that describes the object type. Valid values include the following: |
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter MAPIEncAndNonEncOptimizedConnCount[] returns a MapiEncAndNonEncOptimizedConnCount value that provides the number of encrypted and unencrypted connections that have been optimized by the MAPI AO.
Exceptions
retrieveRequestTypeStats
Retrieves the MAPI request type statistics collected on either a WAE device, WAEs within a device group, or all WAEs system wide.
Input Parameters
|
|
|
|---|---|
A string that describes the name of the WAE, WAE group, or system. |
|
A string that describes the object type. Valid values include the following: |
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter MapiRequestTypeStats[] returns a MapiRequestTypeStats value that provides the request type statistics.
Exceptions
retrieveResponseStats
Retrieves the MAPI response statistics collected on either a WAE device, WAEs within a device group, or all WAEs system wide.
Input Parameters
|
|
|
|---|---|
A string that describes the name of the WAE, WAE group, or system. |
|
A string that describes the object type. Valid values include the following: |
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter MapiResponseStats[] returns a MapiResponseStats value that provides the number of local and remote responses, the average local response time, and the average remote response time.
Exceptions
Feedback