Web Service Objects

This chapter describes the data types that are defined structures or objects in the Central Manager monitoring API. Web Service objects perform the following functions:

  • Parse input parameters and validate their values
  • Invoke the appropriate Central Manager function
  • Assemble the returned result and pass it to the SOAP endpoint
  • Handle exceptions from the Central Manager by reporting the error to the client

This chapter describes the following Web Service objects:

Alarm

This section lists and describes the Alarm object attributes.

 

Attribute
Description

alarmId

A long value that contains the alarm ID.

alarmName

A string value that contains the alarm name.

description

A string value that contains the alarm description.

deviceId

A string value that contains the device ID.

deviceIpAddress

A string value that contains the device IP address.

deviceName

A string value that contains the device name.

deviceStatus

A string value that describes the device status.

severity

An int value that describes the severity of the alarm.

AppNavOverallStats

This section lists and describes the AppNavOverallStats object attributes.

 

Attribute
Description

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

interceptedTraffic

A long value that contains the intercepted traffic count.

name

The name of the AppNav controller or cluster.

passthroughTraffic

A long value that contains the passed through traffic count.

redirectedTraffic

A long value that contains the redirected traffic count.

starttime

A dateTime value that contains the start time.

AppNavPTStats

This section lists and describes the AppNavPTStats object attributes.

 

Attribute
Description

elPTADAOIMProgress

A long value that contains the number of bytes of traffic that were passed through while auto discovery of application optimizers was in progress.

elPTADAOIncompatible

A long value that contains the number of bytes of traffic that were passed through because of auto discovery of application optimizers revealed an incompatibility.

elPTADVersionMismatch

A long value that contains the number of bytes of traffic that were passed through due to an auto discovery version mismatch.

elPTAppConfig

A long value that contains the number of bytes of traffic that were passed through because the application is configured as pass-through.

elPTAppNavInProgress

A long value that contains the aggregrate number of ANC traffic, in bytes, that was passed through because the controller did not see the connection during setup (syn/syn-ack).

This typically occurs if the controller is inserted into the network while connections are active.

elPTAppNavInterceptACL

A long value that contains the number of bytes of traffic that were passed through because an intercept ACL was configured with deny statements matched by these connections.

elPTAppNavPolicy

A long value that contains the number of bytes of traffic that were passed through due to policy settings.

elPTAppOverride

A long value that contains the number of bytes of traffic that were passed through because the internal application explicitly requested that the connection not be optimized.

This value only includes connections that would have otherwise been optimized.

elPTAsymmetric

A long value that contains the number of bytes of traffic that were passed through due to the WAE only seeing one side of the TCP connection (where the src is the client and the dst is the server).

elPTBadADOptions

A long value that contains the number of bytes of traffic that were passed through due to incorrect auto discovery options.

elPTDegraded

A long value that contains the number of bytes of traffic that were passed through because the cluster has degraded.

elPTDMVersionMismatch

A long value that contains the number of bytes of traffic that were passed through due a version mismatch.

elPTFlowLearnFail

A long value that contains the number of bytes of traffic that were passed through due to a query failure because the owner could not be determined.

This indicates an interception problem; ANCs may not be positioned at all entry/exit points in the network.

elPTFlowQueryFail

A long value that contains the number of bytes of traffic that were passed through because the ANC sees the synack but does not see the syn packet, which is possibly tdue to assymetric setup.

This indicates an interception problem; ANCs may not be positioned at all entry and exit points in the network.

elPTGlobalConfig

A long value that contains the global aggregate number of of bytes of traffic that were passed through because the application is configured as pass-through.

elPTInProgress

A long value that contains the number of bytes of traffic that were passed through because the controller did not see the connection during setup (syn/syn-ack).

This typically occurs if the controller is inserted into the network while connections are active.

elPTIntermediate

A long value that contains the number of bytes of traffic that were passed through due to the WAE being in the middle of the best local and remote WAE's (relative to the client and server).

elPTInternalError

A long value that contains the number of bytes of traffic that were passed through due to an internal error during processing in the policy engine.

elPTIPFragUnSuppoPeer

A long value that contains the number of bytes of traffic that were passed through because the peer device is running older software that does not support optimization of fragmented data packets.

elPTNon_optimizingPeer

A long value that contains the number of bytes of traffic that were passed through because the only peer found is a serially clustered peer and optimization is disabled to the peer.

elPTNoPeer

A long value that contains the number of bytes of traffic that were passed through due to no peer WAE being found during TFO auto-discovery.

elPTOverload

A long value that contains the number of bytes of traffic that were passed through because the application is overloaded. New connections not handled by an application accelerator are configured as pass-through.

elPTPeerOverride

A long value that contains the number of bytes of traffic that were passed through because the peer.

elPTRjctCapabilities

A long value that contains the number of bytes of traffic that were passed through due to auto discovery finding that the peer WAE does not have the required capabilities

elPTRjctNoLicense

A long value that contains the number of bytes of traffic that were passed through because the WN is not licensed.

elPTRjctResources

A long value that contains the number of bytes of traffic that were passed through due to due to auto discovery finding that the peer WAE does not have the required resources

elPTServerBlackList

A long value that contains the number of bytes of traffic that were passed through because the server is on the TFO blacklist as not supporting TCP Option (0x21) being present in the SYN packet.

elPTTCPTotal

A long value that contains the aggregate number of bytes of traffic that were passed through for any reason.

elPTWNAppNavMember

A long value that contains the number of bytes of traffic that were passed through because the originating and terminating connections are in the same AppNav cluster.

elPTWNGOverload

A long value that contains the number of bytes of traffic that were passed through because all WNs in the WNG were unavailable to service new connections.

elPTWNInterceptionACL

A long value that contains the number of bytes of traffic that were passed through because an intercept ACL was configured for a WN with deny statements matched by these connections.

elPTWNOffload

A long value that contains the number of bytes of traffic that were passed through as a result of the following scenario: the WN decided to pass the connection through and to offload the pass through to the ANC.

elUnknown

A long value that contains the number of bytes of traffic that were passed through due for unknown reasons. This typically happens if the WN decides to pass the connection through for a reason that cannot be determined by the controller.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

name

The name of the ANC.

starttime

A dateTime value that contains the start time.

AppNavRedStats

This section lists and describes the AppNavRedStats object attributes.

 

Attribute
Description

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

id

A string value that contains one of two values:

  • The ID of the WAAS Node Group (WNG) if the request did not contain a WNG.
  • The individual WAAS Node IDs, if the request explicitly included a WNG ID.

name

The name of the AppNav controller or cluster.

nReceivedBytes

A long value that contains the number of received bytes.

nRedirectedBytes

A long value that contains the number of redirected bytes.

starttime

A dateTime value that contains the start time.

wngName

A string value that describes the name of the WAAS node group.

wnName

A string value that describes the name of the WAAS node.

AppNavStats

This section lists and describes the AppNavStats object attributes.

 

Attribute
Description

classMapName

A string that describes the name of the class map.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

interceptedTraffic

A long value that contains the intercepted traffic count.

name

The name of the AppNav controller or cluster.

passthroughTraffic

A long value that contains the passed through traffic count.

policyMapName

A string that describes the name of the policy map.

redirectedTraffic

A long value that contains the redirected traffic count.

starttime

A dateTime value that contains the start time.

AverageThroughPutStats

This section lists and describes the AverageThroughPutStats object attributes.

 

Attribute
Description

applicationname

A string value that describes the application name.

devicename

A string value that describes the device name.

endtime

A dateTime value that describes the end time.

frequency

A string value that describes the frequency.

optimizedInThroughPut

A double value that describes the optimized throughput of inbound traffic.

optimizedOutThroughPut

A double value that describes the optimized throughput of outbound traffic.

originalInThroughPut

A double value that describes the original throughput of inbound traffic.

originalOutThroughPut

A double value that describes the original throughput of outbound traffic.

starttime

A dateTime value that describes the start time.

AverageThroughputClassStats

This section lists and describes the AverageThroughPutStats object attributes.

 

Attribute
Description

className

A string value that describes the class map name.

devicename

A string value that describes the device name.

endtime

A dateTime value that describes the end time.

frequency

A string value that describes the frequency.

optimizedInThroughPut

A double value that describes the optimized throughput of inbound traffic.

optimizedOutThroughPut

A double value that describes the optimized throughput of outbound traffic.

originalInThroughPut

A double value that describes the original throughput of inbound traffic.

originalOutThroughPut

A double value that describes the original throughput of outbound traffic.

starttime

A dateTime value that describes the start time.

CacheCountStats

This section lists and describes the CacheCountStats object attributes.

 

Attribute
Description

cachecount

An int value that describes the cache count statistics.

frequency

A string value that describes the frequency.

timestamp

A dateTime value that describes the time stamp.

CacheUtilizationStats

This section lists and describes the CacheUtilizationStats object attributes.

 

Attribute
Description

cacheutilization

An int value that describes the cache utilization statistics.

frequency

A string value that describes the frequency.

timestamp

A dateTime value that describes the time stamp.

CIFSTrafficStats

This section lists and describes the CIFSTrafficStats object attributes.

 

Attribute
Description

frequency

A string value that describes the frequency.

timestamp

A dateTime value that describes the time stamp.

trafficreceived

An int value that describes the received traffic.

trafficsent

An int value that describes the sent traffic.

ClassifierStats

This section lists and describes the ClassifierStats object attributes.

 

Attribute
Description

classname

A string value that describes the class map name.

compressedin

A long value that describes the incoming compressed traffic. (bytes)

compressedout

A long value that describes the outgoing compressed traffic. (bytes)

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that describes the end time.

frequency

A string value that describes the frequency.

passthroughintermediatein

A long value that describes the incoming intermediate pass through the traffic. (bytes)

passthroughintermediateout

A long value that describes the outgoing intermediate pass through the traffic. (bytes)

passthroughotherin

A long value that describes the incoming pass through due to other reasons.

passthroughotherout

A long value that describes the outgoing pass through due to other reasons.

passthroughoverloadin

A long value that describes the pass through the overload statistics for the incoming traffic. (bytes). This attribute is deprecated.

passthroughoverloadout

A long value that describes the pass through the overload statistics for the outgoing traffic. (bytes). This attribute is deprecated.

passthroughpeerin

A long value that describes the incoming pass through peer traffic. (bytes)

passthroughpeerout

A long value that describes the outgoing pass through peer traffic. (bytes)

passthroughpolicyin

A long value that describes the incoming pass through the policy. (bytes)

passthroughpolicyout

A long value that describes the outgoing pass through the policy. (bytes)

starttime

A dateTime value that describes the start time.

uncompressedin

A long value that describes the incoming uncompressed traffic. (bytes)

uncompressedout

A long value that describes the outgoing uncompressed traffic. (bytes)

ClassMaps

This section lists and describes the ClassMaps object attributes.

 

Attribute
Description

className

A string value that describes the class map name.

monitored

A boolean value that specifies whether or not the class map is monitored.

ClientAvgThroughputStats

This section lists and describes the ClientAvgThroughputStats object attributes.

 

Attribute
Description

clientavgthroughput

An int value that describes the average throughput between edge and its clients.

frequency

A string value that describes the frequency.

timestamp

A dateTime value that describes the time stamp.

ConnectionStats

This section lists and describes the ConnectionStats object attributes.

 

Attribute
Description

appliedpolicy

A string value that describes the applied policy.

classifier

A string value that describes the classifier.

compressratio

A double value that describes the compression ratio.

devicename

A string value that describes the device name.

dstip

A string value that describes the destination IP address.

dstport

An int value that describes the destination port.

duration

A string value that describes the time duration.

optimizedbytes

A long value that describes the optimized bytes.

originalbytes

A long value that describes the original bytes.

peername

A string value that describes the peer name.

srcip

A string value that describes the source IP address.

srcport

An int value that describes the source port.

starttime

A dateTime value that describes the start time.

ConnectionTrendClassStats

This section lists and describes the ConnectionTrendStats object attributes.

 

Attribute
Description

classname

A string value that describes the class map name.

devicename

A string value that describes the device name.

endtime

A dateTime value that describes the end time.

frequency

A string value that describes the frequency.

optimizedPrepositionConnections

A long value that describes the optimized proposition connections.

optimizedTcpOnlyConnections

A long value that describes the optimized TCP only connections.

optimizedTcpPlusConnections

A long value that describes the optimized TCP plus connections.

ptIntermediateConnections

A double value that describes the pt intermediate connections.

ptOtherConnections

A double value that describes the pt other connections.

ptPeerConnections

A long value that describes the pt peer connections.

ptPolicyConnections

A long value that describes the pt policy connections.

starttime

A dateTime value that describes the start time.

ConnectionTrendStats

This section lists and describes the ConnectionTrendStats object attributes.

 

Attribute
Description

applicationname

A string value that describes the application name.

devicename

A string value that describes the device name.

endtime

A dateTime value that describes the end time.

frequency

A string value that describes the frequency.

optimizedPrepositionConnections

A long value that describes the optimized proposition connections.

optimizedTcpOnlyConnections

A long value that describes the optimized TCP only connections.

optimizedTcpPlusConnections

A long value that describes the optimized TCP plus connections.

ptIntermediateConnections

A double value that describes the pt intermediate connections.

ptOtherConnections

A double value that describes the pt other connections.

ptPeerConnections

A long value that describes the pt peer connections.

ptPolicyConnections

A long value that describes the pt policy connections.

starttime

A dateTime value that describes the start time.

CoreCountStats

This section lists and describes the CoreCountStats object attributes.

 

Attribute
Description

corecount

An int value that describes the core count statistics.

frequency

A string value that describes the frequency.

timestamp

A dateTime value that describes the time stamp.

CPUUtilizationStats

This section lists and describes the CPUUtilizationStats object attributes.

 

Attribute
Description

cpuutilization

A long value that describes the CPU utilization statistics.

endtime

A dateTime value that describes the end time.

frequency

A string value that describes the frequency.

starttime

A dateTime value that describes the start time.

Device

This section lists and describes the Device object attributes.

 

Attribute
Description

hostName

A string value that contains the hostname.

id

A long value that contains the device ID.

ipAddress

A string value that contains the device IP address.

location

A string value that contains the device location.

macAddress

A string value that contains the device MAC address.

model

A string value that contains the device model.

name

A string value that contains the device name.

role

A string value that contains the device role.

softwareVersion

A string value that contains the software version.

status

A string value that contains the device status.

type

A string value that contains the device type.

DeviceGroup

This section lists and describes the DeviceGroup object attributes.

 

Attribute
Description

description

A string value that contains the device description.

groupType

A string value that contains the device group type.

Id

A long value that contains the device ID.

name

A string value that contains the device name.

DeviceStatus

This DeviceStatus object contains the Status attribute. The Status attribute is a string value that describes the device status as either Online, Offline, Pending, or Unknown.

DiskCapacityStats

This section lists and describes the DiskCapacityStats object attributes.

 

Attribute
Description

diskcapacity

An int value that describes the disk capacity statistics.

frequency

A string value that describes the frequency.

timestamp

A dateTime value that describes the time stamp.

DiskEncryption

This section lists and describes the DiskEncryption object attributes.

 

Attribute
Description

currentDiskEncryptionStatus

A string value that contains the current disk encryption status.

futureDiskEncryptionStatus

A string value that contains the future disk encryption status.

DiskInformation

This section lists and describes the DiskInformation object attributes.

 

Attribute
Description

config

A string value that describes the disk configuration.

name

A string value that contains the disk name.

presence

A string value that describes the disk availability.

serialNumber

A string value that contains the disk serial number.

size

A string value that contains the disk size.

status

A string value that describes the disk status.

DiskStatus

This section lists and describes the DiskStatus object attributes.

 

Attribute
Description

presentDisks

An int value that contains the number of disks present.

raidLevel

A string value that contains the RAID level.

EdgeCountStats

This section lists and describes the EdgeCountStats object attributes.

 

Attribute
Description

edgecount

An int value that describes the number of Edge connected to Core.

frequency

A string value that describes the frequency.

timestamp

A dateTime value that describes the time stamp.

FileCountStats

This section lists and describes the FileCountStats object attributes.

 

Attribute
Description

filecount

An int value that describes the file count statistics.

frequency

A string value that describes the frequency.

timestamp

A dateTime value that describes the time stamp.

HitRateStats

This section lists and describes the HitRateStats object attributes.

 

Attribute
Description

frequency

A string value that describes the frequency.

hitrate

An int value that describes the hit rate statistics.

timestamp

A dateTime value that describes the time stamp.

HttpConnOptRate

This section lists and describes the HttpConnOptRate object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

percentConnectionTimeSaved

A long value that contains the percentage of time saved for the connection setup.

HttpConnOptType

This section lists and describes the HttpConnOptType object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

dreHintsFlush

Total number of hints sent to DRE layer with m_dre_flush set to true.

dreHintsSkipAllHeaders

Total number of hints sent to DRE layer with m_skip_bytes set to skip all headers.

dreHintsSkipLz

Total number of hints sent to DRE layer with ch_comp_off set to skip LZ.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

locallyServedIfNotModified

A long value that contains the number of locally served 304 messages.

locallyServedRedirect

A long value that contains the number of locally served 301 responses.

locallyServedUnauthorized

A long value that contains the number of locally served 401 messages.

HttpConnStats

This section lists and describes the HttpConnStats object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

idle

A long value that contains the number of active connections currently idle.

max_reused

A long value that contains the high water mark for the reused count.

pct_rtt_saved

A long value that contains the percentage of time saved expressed as (reused_rtt / set_rtt) * 100.

resused_peer

A long value that contains the number of connections reinitiated by the peer.

reused

A long value that contains the number of times that the connections were reused.

total_handoff

A long value that contains the number of connection handoffs.

HttpMaxConnReuseCount

This section lists and describes the HttpMaxConnReuseCount object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

maxReuseCount

A long value that contains the high water mark for the reused connections count.

HttpOptConnCount

This section lists and describes the HttpOptConnCount object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

fastConnectionSetupsCount

A long value that contains the number of accelerated connections.

frequency

A string value that describes the frequency.

HttpResponseStats

This section lists and describes the HttpResponseStats object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

fastConnReuse

A long value that contains the total time saved by fast connection use (ms).

frequency

A string value that describes the frequency.

ifNotModifiedCache

A long value that contains the RTT saved by content refresh check metadata cache (ms).

redirectMetadataCache

A long value that contains the RTT saved by redirect metadata cache (ms).

unauthorizedMetadataCache

A long value that contains the RTT saved by authorization redirect metadata cache (ms).

HttpTotalConnCount

This section lists and describes the HttpTotalConnCount object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

totalLanConnectionCount

A long value that contains the number of connections currently established.

HttpUnaccelConnCount

This section lists and describes the HttpUnaccelConnCount object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

pipe_through_connections

A long value that contains the number of connections that are unaccelerated.

HttpsConnOptType

This section lists and describes the HttpsConnOptType object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

dreHintsFlush

Total number of hints sent to DRE layer with m_dre_flush set to true.

dreHintsSkipAllHeaders

Total number of hints sent to DRE layer with m_skip_bytes set to skip all headers.

dreHintsSkipLz

Total number of hints sent to DRE layer with ch_comp_off set to skip LZ.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

locallyServedIfNotModified

A long value that contains the number of locally served 304 messages.

locallyServedRedirect

A long value that contains the number of locally served 301 responses.

locallyServedUnauthorized

A long value that contains the number of locally served 401 messages.

HttpsResponseStats

This section lists and describes the HttpsResponseStats object attributes.

 

Attribute
Description

acceptEncodingRemoved

A long value that contains the RTT saved by total server compression suppression.

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

ifNotModifiedCache

A long value that contains the RTT saved by content refresh check metadata cache (ms).

redirectMetadataCache

A long value that contains the RTT saved by redirect metadata cache (ms).

totalSaved

A long value that contains the total time saved by fast connection use (ms).

unauthorizedMetadataCache

A long value that contains the RTT saved by authorization redirect metadata cache (ms).

HttpsStats

This section lists and describes the HttpsStats object attributes.

 

Attribute
Description

activeHttpsConnections

A long value that contains the number of connections that are active.

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

handledHttpsConnections

A long value that contains the total number of connections that are handled.

totalOptimizedHttpsConnections

A long value that contains the total number of connections that are optimized.

ICABypassedReasons

This section lists and describes the ICABypassedReasons object attributes.

 

Attribute
Description

clientOnDeniedList

A long value that contains the count of connections that were bypassed because the client is on the denied list.

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

otherReasons

A long value that contains the number of connections that were bypassed for other reasons.

resourceLimit

A long value that contains the number of connections that were bypassed due to resource limitations.

unKnownCGPId

A long value that contains the number of connections that were bypassed due to having an unknown CGP id.

unRecognizedProtocol

A long value that contains the number of connections that were bypassed due to using an unrecognized protocol.

unSupportedClientVersion

A long value that contains the number of connections that were bypassed due to the client using an unsupported version.

ICAConnectionStats

This section lists and describes the ICAConnectionStats object attributes.

 

Attribute
Description

cgpConnections

A long value that contains the number of CGP connections.

cgpreconnections

A long value that contains the number of CGP reconnections.

currentActiveConnections

A long value that contains the number of currently active connections.

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

icaConnections

A long value that contains the number of ICA connections.

maxActiveConnections

A long value that contains the maximum number of active connections.

pendingConnections

A long value that contains the number of pending connections.

totalDroppedConnections

A long value that contains the total number of dropped connections.

totalHandedOffConnections

A long value that contains the total number of connections that were handed off.

totalHandledConnections

A long value that contains the total number of handled connections.

totalOptimizedConnections

A long value that contains the total number of optimizied connections.

ICADroppedReasons

This section lists and describes the ICADroppedReasons object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

ioError

A long value that contains the number of connections that were dropped due to I/O errors.

maxSessionsInUse

A long value that contains the number of connections that were dropped because too many sessions were in use.

otherReasons

A long value that contains the number of connections that were dropped for other reasons.

parsingError

A long value that contains the number of connections that were dropped due to parsing errors.

resourceLimit

A long value that contains the number of connections that were dropped due to resource limitations.

unsupportedClientVersions

A long value that contains the number of connections that were bypassed due to the client using an unsupported version.

ICAEncryptStats

This section lists and describes the ICAEncryptStats object attributes.

 

Attribute
Description

basicEncryptSessions

A long value that contains the number of basic encryption sessions.

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

rc5128EncryptSessions

A long value that contains the number of RC5128 encryption sessions.

rc540EncryptSessions

A long value that contains the number of RC540 encryption sessions.

rc556EncryptSessions

A long value that contains the number of RC556 encryption sessions.

ICAVersionStats

This section lists and describes the ICAVersionStats object attributes.

 

Attribute
Description

citrixReceiver13_0_Sessions

A long value that contains the number of sessions using Citrix receiver version 13.0.

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

online_Plugin_11_0_Sessions

A long value that contains the number of sessions using version 11.0 of the Citrix online plug-in.

online_Plugin_11_2_Sessions

A long value that contains the number of sessions using version 11.2 of the Citrix online plug-in.

online_Plugin_12_0_Sessions

A long value that contains the number of sessions using version 12.0 of the Citrix online plug-in.

online_Plugin_12_1_Sessions

A long value that contains the number of sessions using version 12.1 of the Citrix online plug-in.

Location

This section lists and describes the Location object attributes.

 

Attribute
Description

description

A string value that describes the description of the location

id

A long value that contains the ID of the location.

level

An int value that contains the level of the location in the hierarchy.

name

A string value that describes the name of the location.

parentId

A long value that contains the ID of the parent location.

MapiClientConnCount

This section lists and describes the MapiClientConnCount object attributes.

 

Attribute
Description

client2k

A long value that contains the number of past connections from Outlook 2000 clients.

client2k3

A long value that contains the number of past connections from Outlook 2003 clients.

client2k7

A long value that contains the number of past connections from Outlook 2007 clients.

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

MapiClientSecuredConnCount

This section lists and describes the MapiClientSecuredConnCount object attributes.

 

Attribute
Description

client2k10

A long value that contains the number of Outlook 2010 encrypted client connections handled by the MAPI Application Optimizer.

client2k3

A long value that contains the number of Outlook 2003 encrypted client connections handled by the MAPI Application Optimizer.

client2k7

A long value that contains the number of Outlook 2007 encrypted client connections handled by the MAPI Application Optimizer.

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

MapiDataReadStats

This section lists and describes the MapiDataReadStats object attributes.

 

Attribute
Description

avgReadAhead

A long value that contains the average accumulated ReadAhead value.

avgReadStream

A long value that contains the average ReadStream value.

avgSyncGetBuffer

A long value that contains the average SynchronizationGetBuffer size.

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

maxReadAhead

A long value that contains the maximum accumulated ReadAhead value.

maxReadStream

A long value that contains the maximum ReadStream value.

maxSyncGetBuffer

A long value that contains the maximum SynchronizationGetBuffer size.

minReadAhead

A long value that contains the minimum accumulated ReadAhead value.

minReadStream

A long value that contains the minimum ReadStream value.

minSyncGetBuffer

A long value that contains the minimum SynchronizationGetBuffer size.

MapiDroppedConnCount

This section lists and describes the MapiDroppedConnCount object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

dropped_connections

A long value that contains the number of dropped connections.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

MapiEncAndNonEncOptimizedConnCount

This section lists and describes the MapiEncAndNonEncOptimizedConnCount object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

optEncConn

A long that contains the number of encrypted connections that have been optimized.

optNonEncConn

A long that contains the number of unencrypted connections that have been optimized.

MapiEncAndNonEncResponseStats

This section lists and describes the MapiEncAndNonEncResponseStats object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

secAvgLocalResponseTime

A long value that contains the average local response time for encrypted connections.

secAvgRemoteResponseTime

A long value that contains the average remote response time for encrypted connections.

secLocalResp

A long value that contains the number of local responses for encrypted connections.

secRemoteResp

A long value that contains the number of local responses for encrypted connections.

unsecAvgLocalResponseTime

A long value that contains the average local response time for unencrypted connections.

unsecAvgRemoteResponseTime

A long value that contains the average remote response time for unencrypted connections.

unsecLocalResp

A long value that contains the number of local responses for unencrypted connections.

unsecRemoteResp

A long value that contains the number of local responses for unencrypted connections.

MapiOptConnCount

This section lists and describes the MapiOptConnCount object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

optimized_connections

A long value that contains the number of connections accelerated/optimized.

MapiRequestTypeStats

This section lists and describes the MapiRequestTypeStats object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

higherthan2kConnections

A long value of the number of connections from clients using a version of Outlook later than Outlook 2000.

lowerthan2kConnections

A long value of the number of connections from clients using a version of Outlook previous to Outlook 2000.

securedConnections

A long value of the secured connection count.

MapiResponseStats

This section lists and describes the MapiResponseStats object attributes.

 

Attribute
Description

avgLocalResp

A long value that contains the average local response time.

avgRemoteResp

A long value that contains the average remote response time.

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

localResp

A long value that contains the number of local responses.

remoteResp

A long value that contains the number of remote responses.

MapiSessionCount

This section lists and describes the MapiSessionCount object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

sessionCount

A long value that contains the number of sessions completed.

MapiUnaccelConnCount

This section lists and describes the MapiUnaccelConnCount object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

pipe_through_connections

A long value that contains the number of connections unaccelerated.

MonitoredAO

This section lists and describes the Monitored AO object attributes.

 

Attribute
Description

deviceName

A string value that describes the device name.

isCifsEnabled

A boolean value that describes the CIFS accelerator status.

isEpmEnabled

A boolean value that describes the EPM accelerator status.

isHttpEnabled

A boolean value that describes the HTTP accelerator status.

isIcaEnabled

A boolean value that describes the ICA accelerator status.

isMapiEnabled

A boolean value that describes the MAPI accelerator status.

isNfsEnabled

A boolean value that describes the NFS accelerator status.

isSmbEnabled

A boolean value that describes the SMB accelerator status.

isSSLEnabled

A boolean value that describes the SSL accelerator status.

isVideoEnabled

A boolean value that describes the Video accelerator status.

isWafsCoreEnabled

A boolean value that describes the WAFS core status.

isWafsEdgeEnabled

A boolean value that describes the WAFS edge status.

MonitoredApps

This section lists and describes the MonitoredApps object attributes.

 

Attribute
Description

applicationName

A string value that describes the application name.

monitored

A boolean value that describes the status of the application that is monitored. Set to true if monitored and set to false if not monitored.

NfsDroppedConnCount

This section lists and describes the NFSDroppedConnCount object attributes.

Attribute
Description

deviceName

A string value that describes the name of the device.

dropped_connections

A long value that contains the number of connections dropped.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

NfsOptConnCount

This section lists and describes the NFSOptConnCount object attributes.

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

optimized_connections

A long value that contains the number of connections accelerated/optimized.

NfsReqTypeStats

This section lists and describes the NfsReqTypeStats object attributes.

 

Attribute
Description

authflavor0Count

The number of RPC calls for authentication flavor 0.

authflavor1Count

The number of RPC calls for authentication flavor 1.

authflavor2Count

The number of RPC calls for authentication flavor 2.

authflavor3Count

The number of RPC calls for authentication flavor 3.

authflavorUnknown

The number of RPC calls for unknown authentication flavor.

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

NfsRespTypeStats

This section lists and describes the NfsRespTypeStats object attributes.

 

Attribute
Description

avgLocalResp

A long value that contains the average local response time.

avgRemoteResp

A long value that contains the average remote response time.

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

localResp

A long value that contains the number of local responses.

remoteResp

A long value that contains the number of remote responses.

NfsSessionCount

This section lists and describes the NfsSessionCount object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

sessionCount

A long value that contains the number of sessions completed.

NfsTypeStats

This section lists and describes the NFSTypeStats object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

nfsUnknownCount

A long value that contains the number of packets of NFS version unknown.

nfsv0Count

A long value that contains the number of packets of NFS version NFSv0.

nfsv2Count

A long value that contains the number of packets of NFS version NFSv2.

nfsv3Count

A long value that contains the number of packets of NFS version NFSv3.

nfsv4Count

A long value that contains the number of packets of NFS version NFSv4.

NfsUnaccelConnCount

This section lists and describes the NFSUnaccelConnCount object attributes.

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

pipe_through_connections

A long value that contains the number of connections unaccelerated.

PeakThroughPutClassStats

This section lists and describes the PeakThroughPutClassStats object attributes.

 

Attribute
Description

classname

A string value that describes the class map name.

devicename

A string value that describes the device name.

endtime

A dateTime value that describes the end time.

frequency

A string value that describes the frequency.

optimizedInThroughPut

A double value that describes the peak optimized throughput of inbound traffic.

optimizedOutThroughPut

A double value that describes the peak optimized throughput of outbound traffic.

originalInThroughPut

A double value that describes the peak original throughput of inbound traffic.

originalOutThroughPut

A double value that describes the peak original throughput of outbound traffic.

starttime

A dateTime value that describes the start time.

PeakThroughPutStats

This section lists and describes the PeakThroughPutStats object attributes.

 

Attribute
Description

applicationname

A string value that describes the application name.

devicename

A string value that describes the device name.

endtime

A dateTime value that describes the end time.

frequency

A string value that describes the frequency.

optimizedInThroughPut

A double value that describes the optimized throughput of inbound traffic.

optimizedOutThroughPut

A double value that describes the optimized throughput of outbound traffic.

originalInThroughPut

A double value that describes the original throughput of inbound traffic.

originalOutThroughPut

A double value that describes the original throughput of outbound traffic.

starttime

A dateTime value that describes the start time.

RequestCountStats

This section lists and describes the RequestCountStats object attributes.

 

Attribute
Description

frequency

A string value that describes the frequency.

requestcount

An int value that describes the request count statistics.

timestamp

A dateTime value that describes the time stamp.

SessionCountStats

This section lists and describes the SessionCountStats object attributes.

 

Attribute
Description

frequency

A string value that describes the frequency.

sessioncount

An int value that describes the session count statistics.

timestamp

A dateTime value that describes the time stamp.

SmbConnOptRate

This section lists and describes the SmbConnOptRate object attributes.

 

Attribute
Description

averageTimeSaved

A long value that contains an estimate of time saved by SMB AO optimizations

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

SmbConnOptSavings

This section lists and describes the SmbConnOptSavings object attributes.

 

Attribute
Description

assyncWriteOptTimeSaving

A long value that contains the average amount of time (in milliseconds) saved by SMB AO optimizations.

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

metaDataOptTimeSaving

A long value that contains the amount of time saved due by optimizing handling of asynchronous requests.

namedPipeOptTimeSaving

A long value that contains the amount of time saved by optimization of named pipes.

officeOptTimeSaving

A long value that contains the amount of time saved by optimization of MS Office.

otherOptTimeSaving

A long value that contains the amount of time saved by other optimizations.

readAheadOptTimeSaving

A long value that contains the amount of time saved by read-ahead optimizations.

SmbConnStats

This section lists and describes the SmbConnStats object attributes.

 

Attribute
Description

currentActiveConnections

A long value that contains the number of active connections.

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

totalDroppedConnections

A long value that contains the total number of dropped connections.

totalHandledConnections

A long value that contains the total number of handled connections.

totalOptimizedConnections

A long value that contains the total number of optimized connections.

SmbOptConnCount

This section lists and describes the SmbOptConnCount object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

totalOptimizedConnections

A long value that contains the total number of optimized connections.

SmbRequestOptStats

This section lists and describes the SmbRequestOptStats object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

metaDataOptimizationRate

A double value that contains the rate of meta data optimization.

otherOptimizationRate

A double value that contains the rate of other kinds of optimization.

readAheadOptimizationRate

A double value that contains the rate of read-ahead optimization.

writeOptimizationRate

A double value that contains the rate of data write optimization.

SmbTotalConnCount

This section lists and describes the SmbTotalConnCount object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

totalLanConnectionCount

A long value that contains the total number of LAN connections.

SSLActiveConnCount

This section lists and describes the SSLActiveConnCount object attributes.

 

Attribute
Description

active_connections

A long value that contains the number of active connections.

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

SSLBytesCount

This section lists and describes the SSLBytesCount object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

lan_bytes_read_ins

A long value that describes the number of LAN bytes read.

lan_bytes_written_out

A long value that describes the number of LAN bytes written out.

wan_bytes_read_in

A long value that describes the number of WAN bytes read.

wan_bytes_written_out

A long value that describes the number of WAN bytes written out.

SSLErrorConnCount

This section lists and describes the SSLErrorConnCount object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

drop_other_count

A long value that describes the flows dropped due to other reasons.

drop_revocation_count

A long value that describes the flows dropped due to revocation check.

drop_verification_count

A long value that describes the flows dropped due to verification check.

dropped_connections

A long value that describes the number of dropped connections.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

SSLOptConnCount

This section lists and describes the SSLOptConnCount object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

optimized_connections

A long value that contains the number of accelerated connections.

SSLTotalConnCount

This section lists and describes the SSLTotalConnCount object attributes.

 

Attribute
Description

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

handled_connections

A long value that contains the number of connections currently established.

SSLUnAccelConnCount

This section lists and describes the SSLUnAccelConnCount object attributes.

 

Attribute
Description

cipher_mismatch_count

A long value that describes the number of pipe-throughs due to cipher mismatch.

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that contains the end time.

frequency

A string value that describes the frequency.

nossl_count

A long value that describes the number of non-SSL flows piped through.

num_pipethru_rdnst

A long value that describes the number of pipe-throughs due to domain mismatch.

num_pipethru_unknown

A long value that describes the number of pipe-throughs due to unknown reasons.

pipe_through_connections

A long value that describes the number of connections that are unaccelerated.

version_mismatch_count

A long value that describes the number of pipe-throughs due to version mismatch.

String

This section lists and describes the String object attributes.

 

Attribute
Description

string

A string value that describes a list of the device names.

TimeFrameFilter

This section lists and describes the TimeFrameFilter object attributes.

 

Attribute
Description

endtime

A dateTime value that describes the end time.

frequency

A string that describes the frequency. Valid values include the following:

  • last5min
  • lasthour
  • lastweek
  • lastday
  • lastmonth
  • lastyear
  • custom

starttime

A dateTime value that describes the start time.

timezone

A string that describes the time zone. The valid value for this string is utc.

TrafficStats

This section lists and describes the TrafficStats object attributes.

 

Attribute
Description

applicationname

A string value that describes the application name.

compressedin

A long value that describes the incoming compressed traffic. (bytes)

compressedout

A long value that describes the outgoing compressed traffic. (bytes)

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that describes the end time.

frequency

A string value that describes the frequency.

passthroughintermediatein

A long value that describes the incoming intermediate pass through the traffic. (bytes)

passthroughintermediateout

A long value that describes the outgoing intermediate pass through the traffic. (bytes)

passthroughotherin

A long value that describes the incoming pass through due to other reasons.

passthroughotherout

A long value that describes the outgoing pass through due to other reasons.

passthroughoverloadin

A long value that describes the pass through the overload statistics for the incoming traffic. (bytes). This attribute is deprecated.

passthroughoverloadout

A long value that describes the pass through the overload statistics for the outgoing traffic. (bytes). This attribute is deprecated.

passthroughpeerin

A long value that describes the incoming pass through peer traffic. (bytes)

passthroughpeerout

A long value that describes the outgoing pass through peer traffic. (bytes)

passthroughpolicyin

A long value that describes the incoming pass through the policy. (bytes)

passthroughpolicyout

A long value that describes the outgoing pass through the policy. (bytes)

starttime

A dateTime value that describes the start time.

uncompressedin

A long value that describes the incoming uncompressed traffic. (bytes)

uncompressedout

A long value that describes the outgoing uncompressed traffic. (bytes)

VideoAccelBypassReasons

This section lists and describes the VideoAccelBypassReasons object attributes.

 

Attribute
Description

agg_bitrate_overload_count

A long value that contains the unaccelerated aggregate bitrate overload connections.

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that describes the end time.

frequency

A string value that describes the frequency.

max_stream_bitrate_exceeded_count

A long value that contains the unaccelerated maximum stream bitrate exceeded connections.

others_count

A long value that contains the unaccelerated other connections.

session_count_overload_count

A long value that contains the unaccelerated session count overload connections.

unsupport_player_count

A long value that contains the unaccelerated unsupported player connections.

unsupport_protocol_count

A long value that contains the unaccelerated unsupported protocol connections.

unsupport_transport_count

A long value that contains the unaccelerated unsupported transport connections.

wm_vod_count

A long value that contains the unaccelerated windows-media VoD connections.

VideoActiveConnCount

This section lists and describes the VideoActiveConnCount object attributes.

 

Attribute
Description

active_connections

A long value that contains the number of active connections.

deviceName

A string value that describes the name of the device.

endtime

A dateTime value that describes the end time.

frequency

A string value that describes the frequency.

VideoClient

This section lists and describes the VideoClient object attributes.

 

Attribute
Description

bw

An int value that describes the bandwith usage.

bytessent

A long value that describes the number of bytes sent by the edge WAE to the client.

ip

A string value that contains the IP address of the client.

VideoStats

This section lists and describes the VideoStats object attributes.

 

Attribute
Description

acceleratedconnections

An int value that describes the total number of accelerated connections.

deviceName

A string value that describes the name of the device.

errorconnections

An int value that describes the total number of errors or dropped connections.

frequency

A string value that describes the frequency.

incomingbytesttotal

An int value that describes the total incoming bandwith server in kilobits per second (kbps).

outgoingbytesttotal

An int value that describes the total outgoing bandwith for the client (in kbps).

receivedconnections

An int value that describes the total number of received connections.

savedpercent

An int value that describes the saved percentage as a ratio of incoming and outgoing bytes served.

timestamp

A dateTime value that describes the time stamp.

unacceleratedconnections

An int value that describes the total number of unaccelerated connections.

VideoStreamStats

This section lists and describes the VideoStreamStats object attributes.

 

Attribute
Description

bytesrcvd

A long value that describes the number of bytes received by the edge WAE from the server.

client[]

A VideoClient value that includes a list of clients.

clientcount

An int value that describes the number of clients connected or using the stream.

deviceName

A string value that describes the name of the device.

frequency

A string value that describes the frequency.

inbw

An int value that describes the incoming bandwith.

timestamp

A dateTime value that contains the time stamp.

url

A string value that describes the stream URL.