Cisco Wide Area Application Services API Reference (Software Version 5.2.1)
ICA Statistics Service
Downloads: This chapterpdf (PDF - 245.0KB) The complete bookPDF (PDF - 2.59MB) | Feedback

ICA Statistics Service

Table Of Contents

ICA Statistics Service

getBypassedReasons

getConnStats

getDroppedReasons

getEncryptionStats

getVersionStats


ICA Statistics Service


This chapter describes the ICAStatistics service, which returns ICA accelerator data and statistics for individual WAEs, device groups, and for the WAAS network.

The ICA Statistics (ICA Web Service) performs one or more of the following actions:

getBypassedReasons

getConnStats

getDroppedReasons

getEncryptionStats

getVersionStats

Syntax

Service URL: https://<host/ip>:8443/ws/ICAStats

WSDL URL: https://<host/ip>:8443/ws/ICAStats?wsdl

 
   

To obtain a description of all the operations and parameters for the ICAStats Service, submit a URL to the service with the suffix ?wsdl as follows:

https://<host/ip>:8443/ws/ICAStats?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/ICAStats
 
   

Next, submit a SOAP request written in an XML format to retrieve the information.

The following example shows an XML-formatted SOAP request to perform the retrieveAppNavPolicyStats 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">
- <soapenv:Header>
- <wsse:Security 
xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.
xsd">
- <wsse:UsernameToken>
  <wsse:Username>admin</wsse:Username> 
  <wsse:Password 
Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#P
asswordText">default</wsse:Password> 
  </wsse:UsernameToken>
  </wsse:Security>
  </soapenv:Header>
- <soapenv:Body>
- <ns2:getConnStats xmlns:ns2="http://service.stats.ws.waas.cisco.com">
  <ns2:name>ce-119-40</ns2:name> 
  <ns2:objType>wae</ns2:objType> 
- <ns2:timeframe>
  <ns1:endTime 
xmlns:ns1="http://util.ws.waas.cisco.com/xsd">2008-01-30T08:00:00.000Z</ns1:endTime> 
  <ns1:frequency xmlns:ns1="http://util.ws.waas.cisco.com/xsd">lasthour</ns1:frequency> 
  <ns1:startTime 
xmlns:ns1="http://util.ws.waas.cisco.com/xsd">2012-04-16T17:59:24.000Z</ns1:startTime> 
  <ns1:timezone xmlns:ns1="http://util.ws.waas.cisco.com/xsd">UTC</ns1:timezone> 
  </ns2:timeframe>
  </ns2:getConnStats>
  </soapenv:Body>
  </soapenv:Envelope>
 
   

Example Response

<?xml version="1.0" encoding="utf-8" ?> 
- <soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
- <soapenv:Body>
- <ns:getConnStatsResponse xmlns:ns="http://service.stats.ws.waas.cisco.com" 
xmlns:ax225="http://io.java/xsd" xmlns:ax227="http://stats.ws.waas.cisco.com/xsd" 
xmlns:ax226="http://util.ws.waas.cisco.com/xsd" xmlns:ax224="http://rmi.java/xsd">
- <ns:return type="com.cisco.waas.ws.stats.ICAConnectionStats">
  <ax227:cgpConnections>66</ax227:cgpConnections> 
  <ax227:cgpreconnections>24</ax227:cgpreconnections> 
  <ax227:currentActiveConnections>100</ax227:currentActiveConnections> 
  <ax227:deviceName>someName</ax227:deviceName> 
  <ax227:endtime>2012-04-16T17:59:26.628Z</ax227:endtime> 
  <ax227:frequency>min</ax227:frequency> 
  <ax227:icaConnections>44</ax227:icaConnections> 
  <ax227:maxActiveConnections>123</ax227:maxActiveConnections> 
  <ax227:pendingConnections>18</ax227:pendingConnections> 
  <ax227:totalDroppedConnections>7</ax227:totalDroppedConnections> 
  <ax227:totalHandedOffConnections>21</ax227:totalHandedOffConnections> 
  <ax227:totalHandledConnections>88</ax227:totalHandledConnections> 
  <ax227:totalOptimizedConnections>66</ax227:totalOptimizedConnections> 
  </ns:return>
  </ns:getConnStatsResponse>
  </soapenv:Body>
  </soapenv:Envelope>
 
   

getBypassedReasons

Retrieves statistics about why connections were bypassed for ICA optimization.

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.


Return

The output parameter ICABypassedReasons[] returns a ICABypassedReasons value that provides the statistics about why connections were bypassed, including a client being on the denied list, resource limitations, unrecognized protocols, and other reasons.

Exceptions

Type
String
Description

RemoteException

IcaStatsService.getBypassedReasons: ERROR:Invalid name=

The device name is invalid.

RemoteException

IcaStatsService.getBypassedReasons: ERROR:Invalid objType=

The object type name is invalid.

RemoteException

IcaStatsService.getBypassedReasons: ERROR:Invalid TimeFrame

The timeframe is invalid.

RemoteException

IcaStatsService.getBypassedReasons: ERROR:Device does not exist.DeviceName=

The device name is not found.

RemoteException

IcaStatsService.getBypassedReasons: ERROR:Device Group does not exist.DeviceGroup=

The device group name is not found.

RemoteException

IcaStatsService.getBypassedReasons: ERROR:Invalid frequency=

The frequency is invalid.

RemoteException

IcaStatsService.getBypassedReasons: ERROR:Invalid startTime=

The start time is invalid.

RemoteException

IcaStatsService.getBypassedReasons: ERROR:Invalid endTime=

The end time is invalid.

RemoteException

IcaStatsService.getBypassedReasons: ERROR:startTime should be less than endTime startTime=

The start time is less than the end time.

AxisFault

IcaStats:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

IcaStats:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

IcaStats:The Requested WebService is not available

The service requested is not supported.

AxisFault

getBypassedReasons:The SOAP Body doesn't have all the required elements

The SOAP body does not have all the required elements.


getConnStats

Retrieves statistics about the numbers of connections handled by the ICA AO.

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.


Return

The output parameter ICAConnectionsStats[] returns a ICAConnectionStats value that provides statistical information about various connection values, including the number of ICA connections, the number of acdtive connections, the number of dropped connections, and others.

Exceptions

Type
String
Description

RemoteException

IcaStatsService.getConnStats: ERROR:Invalid name=

The device name is invalid.

RemoteException

IcaStatsService.getConnStats: ERROR:Invalid objType=

The object type name is invalid.

RemoteException

IcaStatsService.getConnStats: ERROR:Invalid TimeFrame

The timeframe is invalid.

RemoteException

IcaStatsService.getConnStats: ERROR:Device does not exist.DeviceName=

The device name is not found.

RemoteException

IcaStatsService.getConnStats: ERROR:Device Group does not exist.DeviceGroup=

The device group name is not found.

RemoteException

IcaStatsService.getConnStats: ERROR:Invalid frequency=

The frequency is invalid.

RemoteException

IcaStatsService.getConnStats: ERROR:Invalid startTime=

The start time is invalid.

RemoteException

IcaStatsService.getConnStats: ERROR:Invalid endTime=

The end time is invalid.

RemoteException

IcaStatsService.getConnStats: ERROR:startTime should be less than endTime startTime=

The start time is less than the end time.

AxisFault

IcaStats:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

IcaStats:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

IcaStats:The Requested WebService is not available

The service requested is not supported.

AxisFault

getConnStats:The SOAP Body doesn't have all the required elements

The SOAP body does not have all the required elements.


getDroppedReasons

Retrieves information about how many connections were dropped for each of a variety of reasons.

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.


Return

The output parameter ICADroppedReasons[] returns a ICADroppedReasons value that provides information about how many connections were dropped for various reasons.

Exceptions

Type
String
Description

RemoteException

IcaStatsService.getDroppedReasons: ERROR:Invalid name=

The device name is invalid.

RemoteException

IcaStatsService.getDroppedReasons: ERROR:Invalid objType=

The object type name is invalid.

RemoteException

IcaStatsService.getDroppedReasons: ERROR:Invalid TimeFrame

The timeframe is invalid.

RemoteException

IcaStatsService.getDroppedReasons: ERROR:Device does not exist.DeviceName=

The device name is not found.

RemoteException

IcaStatsService.getDroppedReasons: ERROR:Device Group does not exist.DeviceGroup=

The device group name is not found.

RemoteException

IcaStatsService.getDroppedReasons: ERROR:Invalid frequency=

The frequency is invalid.

RemoteException

IcaStatsService.getDroppedReasons: ERROR:Invalid startTime=

The start time is invalid.

RemoteException

IcaStatsService.getDroppedReasons: ERROR:Invalid endTime=

The end time is invalid.

RemoteException

IcaStatsService.getDroppedReasons: ERROR:startTime should be less than endTime startTime=

The start time is less than the end time.

AxisFault

IcaStats:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

IcaStats:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

IcaStats:The Requested WebService is not available

The service requested is not supported.

AxisFault

getDroppedReasons:The SOAP Body doesn't have all the required elements

The SOAP body does not have all the required elements.


getEncryptionStats

Retrieves statistics about the number of ICA sessions using different encryption protocols.

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.


Return

The output parameter ICAEncyptStats[] returns a ICAEncryptStats value that provides information about how many sessions were encrypted using different encryption protocols, including RC5128, RC540, and RC556.

Exceptions

Type
String
Description

RemoteException

IcaStatsService.getEncryptionStats: ERROR:Invalid name=

The device name is invalid.

RemoteException

IcaStatsService.getEncryptionStats: ERROR:Invalid objType=

The object type name is invalid.

RemoteException

IcaStatsService.getEncryptionStats: ERROR:Invalid TimeFrame

The timeframe is invalid.

RemoteException

IcaStatsService.getEncryptionStats: ERROR:Device does not exist.DeviceName=

The device name is not found.

RemoteException

IcaStatsService.getEncryptionStats: ERROR:Device Group does not exist.DeviceGroup=

The device group name is not found.

RemoteException

IcaStatsService.getEncryptionStats: ERROR:Invalid frequency=

The frequency is invalid.

RemoteException

IcaStatsService.getEncryptionStats: ERROR:Invalid startTime=

The start time is invalid.

RemoteException

IcaStatsService.getEncryptionStats: ERROR:Invalid endTime=

The end time is invalid.

RemoteException

IcaStatsService.getEncryptionStats: ERROR:startTime should be less than endTime startTime=

The start time is less than the end time.

AxisFault

IcaStats:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

IcaStats:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

IcaStats:The Requested WebService is not available

The service requested is not supported.

AxisFault

getEncryptionStats:The SOAP Body doesn't have all the required elements

The SOAP body does not have all the required elements.


getVersionStats

Retrieves information about how many sessions are using different virtualization software versions.

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.


Return

The output parameter ICAVersionStats[] returns a ICAVersionStats value that provides details of how many sessions are using each of several different session management software, including Citrix Receiver 13.0 and four different versions (11.0, 11.2, 12.0, and 12.2) of the Citrix online plug-in.

Exceptions

Type
String
Description

RemoteException

IcaStatsService.getVersionStats: ERROR:Invalid name=

The device name is invalid.

RemoteException

IcaStatsService.getVersionStats: ERROR:Invalid objType=

The object type name is invalid.

RemoteException

IcaStatsService.getVersionStats: ERROR:Invalid TimeFrame

The timeframe is invalid.

RemoteException

IcaStatsService.getVersionStats: ERROR:Device does not exist.DeviceName=

The device name is not found.

RemoteException

IcaStatsService.getVersionStats: ERROR:Device Group does not exist.DeviceGroup=

The device group name is not found.

RemoteException

IcaStatsService.getVersionStats: ERROR:Invalid frequency=

The frequency is invalid.

RemoteException

IcaStatsService.getVersionStats: ERROR:Invalid startTime=

The start time is invalid.

RemoteException

IcaStatsService.getVersionStats: ERROR:Invalid endTime=

The end time is invalid.

RemoteException

IcaStatsService.getVersionStats: ERROR:startTime should be less than endTime startTime=

The start time is less than the end time.

AxisFault

IcaStats:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

IcaStats:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

IcaStats:The Requested WebService is not available

The service requested is not supported.

AxisFault

getVersionStats:The SOAP Body doesn't have all the required elements

The SOAP body does not have all the required elements.