The ICA Statistics (ICA Web Service) performs one or more of the following actions:
-
getBypassedReasons
-
getConnStats
-
getDroppedReasons
-
getEncryptionStats
-
getVersionStats
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 <FIX XREF> 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.
|