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:
•TimeFrameFilter
•TrafficStats
•CPUUtilizationStats
•ConnectionStats
•HitRateStats
•CacheCountStats
•CacheUtilizationStats
•DiskCapacityStats
•SessionCountStats
•CoreCountStats
•FileCountStats
•RequestCountStats
•VideoStats
•VideoStreamStats
•VideoClient
•Device
•DeviceGroup
•DiskEncryption
•DeviceStatus
•DiskStatus
•DiskInformation
•Alarm
•HttpOptConnCount
•HttpMaxConnReuseCount
•HttpConnOptRate
•HttpTotalConnCount
•HttpConnStats
•MapiSessionCount
•MapiDataReadStats
•MapiResponseStats
•MapiRequestTypeStats
•MapiClientConnCount
•NfsSessionCount
•NfsRespTypeStats
•NfsReqTypeStats
•NfsTypeStats
TimeFrameFilter
This section lists and describes the TimeFrameFilter object attributes.
|
|
starttime |
A dateTime value that describes the start time. |
endtime |
A dateTime value that describes the end time. |
frequency |
A string that describes the frequency. Valid values include the following: •lasthour •lastweek •lastday •lastmonth •lastyear •custom |
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.
|
|
compressedin |
A long value that describes the incoming compressed traffic. (bytes) |
compressedout |
A long value that describes the outgoing compressed traffic. (bytes) |
uncompressedin |
A long value that describes the incoming uncompressed traffic. (bytes) |
uncompressedout |
A long value that describes the outgoing uncompressed traffic. (bytes) |
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) |
passthroughoverloadin |
A long value that describes the pass through the overload statistics for the incoming traffic. (bytes) |
passthroughoverloadout |
A long value that describes the pass through the overload statistics for the outgoing traffic. (bytes) |
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) |
applicationname |
A string value that describes the application name. |
frequency |
A string value that describes the frequency. |
starttime |
A dateTime value that describes the start time. |
endtime |
A dateTime value that describes the end time. |
CPUUtilizationStats
This section lists and describes the CPUUtilizationStats object attributes.
|
|
cpuutilization |
A long value that describes the CPU utilization statistics. |
frequency |
A string value that describes the frequency. |
starttime |
A dateTime value that describes the start time. |
endtime |
A dateTime value that describes the end time. |
ConnectionStats
This section lists and describes the ConnectionStats object attributes.
|
|
devicename |
A string value that describes the device name. |
srcip |
A string value that describes the source IP address. |
dstip |
A string value that describes the destination IP address. |
srcport |
An int value that describes the source port. |
dstport |
An int value that describes the destination port. |
peername |
A string value that describes the peer name. |
appliedpolicy |
A string value that describes the applied policy. |
duration |
A string value that describes the time duration. |
originalbytes |
A long value that describes the original bytes. |
optimizedbytes |
A long value that describes the optimized bytes. |
compressratio |
A double value that describes the compression ratio. |
HitRateStats
This section lists and describes the HitRateStats object attributes.
|
|
hitrate |
An int value that describes the hit rate statistics. |
frequency |
A string value that describes the frequency. |
timestamp |
A dateTime value that describes the time stamp. |
CacheCountStats
This section lists and describes the CacheCountStats object attributes.
|
|
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.
|
|
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. |
DiskCapacityStats
This section lists and describes the DiskCapacityStats object attributes.
|
|
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. |
SessionCountStats
This section lists and describes the SessionCountStats object attributes.
|
|
sessioncount |
An int value that describes the session count statistics. |
frequency |
A string value that describes the frequency. |
timestamp |
A dateTime value that describes the time stamp. |
CoreCountStats
This section lists and describes the CoreCountStats object attributes.
|
|
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. |
FileCountStats
This section lists and describes the FileCountStats object attributes.
|
|
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. |
RequestCountStats
This section lists and describes the RequestCountStats object attributes.
|
|
requestcount |
An int value that describes the request count statistics. |
frequency |
A string value that describes the frequency. |
timestamp |
A dateTime value that describes the time stamp. |
VideoStats
This section lists and describes the VideoStats object attributes.
|
|
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). |
savedpercent |
An int value that describes the saved percentage as a ratio of incoming and outgoing bytes served. |
receivedconnections |
An int value that describes the total number of received connections. |
unacceleratedconnections |
An int value that describes the total number of unaccelerated connections. |
acceleratedconnections |
An int value that describes the total number of accelerated connections. |
errorconnections |
An int value that describes the total number of errors or dropped connections. |
frequency |
A string value that describes the frequency. |
timestamp |
A dateTime value that describes the time stamp. |
VideoStreamStats
This section lists and describes the VideoStreamStats object attributes.
|
|
url |
A string value that describes the stream URL. |
inbw |
An int value that describes the incoming bandwith. |
clientcount |
An int value that describes the number of clients connected or using the stream. |
client[] |
A VideoClient value that includes a list of clients. |
frequency |
A string value that describes the frequency. |
timestamp |
A dateTime value that contains the time stamp. |
bytesrcvd |
A long value that describes the number of bytes receivd by the edge WAE from the server. |
VideoClient
This section lists and describes the VideoClient object attributes.
|
|
ip |
A string value that contains the IP address of the client. |
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. |
Device
This section lists and describes the Device object attributes.
|
|
id |
A long value that contains the device ID. |
name |
A string value that contains the device name. |
hostName |
A string value that contains the hostname. |
type |
A string value that contains the device type. |
role |
A string value that contains the device role. |
softwareVersion |
A string value that contains the software version. |
model |
A string value that contains the device model. |
ipAddress |
A string value that contains the device IP address. |
status |
A string value that contains the device status. |
location |
A string value that contains the device location. |
macAddress |
A string value that contains the device MAC address. |
DeviceGroup
This section lists and describes the DeviceGroup object attributes.
|
|
Id |
A long value that contains the device ID. |
name |
A string value that contains the device name. |
groupType |
A string value that contains the device group type. |
description |
A string value that contains the device description. |
DiskEncryption
This section lists and describes the DiskEncryption object attributes.
|
|
currentDiskEncryptionStatus |
A string value that contains the current disk encryption status. |
futureDiskEncryptionStatus |
A string value that contains the future disk encryption status. |
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.
DiskStatus
This section lists and describes the DiskStatus object attributes.
|
|
presentDisks |
An int value that contains the number of disks present. |
raidLevel |
A string value that contains the RAID level. |
DiskInformation
This section lists and describes the DiskInformation object attributes.
|
|
name |
A string value that contains the disk name. |
serialNumber |
A string value that contains the disk serial number. |
size |
A string value that contains the disk size. |
presence |
A string value that describes the disk availability. |
status |
A string value that describes the disk status. |
config |
A string value that describes the disk configuration. |
Alarm
This section lists and describes the Alarm object attributes.
|
|
alarmId |
A long value that contains the alarm ID. |
deviceId |
A string value that contains the device ID. |
severity |
An int value that describes the severity of the alarm. |
description |
A string value that contains the alarm description. |
alarmName |
A string value that contains the alarm name. |
deviceName |
A string value that contains the device name. |
deviceStatus |
A string value that describes the device status. |
deviceIpAddress |
A string value that contains the device IP address. |
HttpOptConnCount
This section lists and describes the HttpOptConnCount object attributes.
|
|
fastConnectionSetupsCount |
A long value that contains the number of accelerated connections. |
frequency |
A string value that describes the frequency. |
endtime |
A dateTime value that contains the end time. |
HttpMaxConnReuseCount
This section lists and describes the HttpMaxConnReuseCount object attributes.
|
|
maxReuseCount |
A long value that contains the high water mark for the reused connections count. |
frequency |
A string value that describes the frequency. |
endtime |
A dateTime value that contains the end time. |
HttpConnOptRate
This section lists and describes the HttpConnOptRate object attributes.
|
|
percentConnectionTimeSaved |
A long value that contains the percentage of time saved for the connection setup. |
frequency |
A string value that describes the frequency. |
endtime |
A dateTime value that contains the end time. |
HttpTotalConnCount
This section lists and describes the HttpTotalConnCount object attributes.
|
|
totalLanConnectionCount |
A long value that contains the number of connections currently established. |
frequency |
A string value that describes the frequency. |
endtime |
A dateTime value that contains the end time. |
HttpConnStats
This section lists and describes the HttpConnStats object attributes.
|
|
idle |
A long value that contains the number of active connections currently idle. |
reused |
A long value that contains the number of times that the connections were reused. |
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. |
frequency |
A string value that describes the frequency. |
endtime |
A dateTime value that contains the end time. |
total_handoff |
A long value that contains the number of connection handoffs. |
resused_peer |
A long value that contains the number of connections reinitiated by the peer. |
MapiSessionCount
This section lists and describes the MapiSessionCount object attributes.
|
|
sessionCount |
A long value that contains the number of sessions completed. |
frequency |
A string value that describes the frequency. |
endtime |
A dateTime value that contains the end time. |
MapiDataReadStats
This section lists and describes the MapiDataReadStats object attributes.
|
|
minSyncGetBuffer |
A long value that contains the minimum SynchronizationGetBuffer size. |
maxSyncGetBuffer |
A long value that contains the maximum SynchronizationGetBuffer size. |
avgSyncGetBuffer |
A long value that contains the average SynchronizationGetBuffer size. |
minReadStream |
A long value that contains the minimum ReadStream value. |
maxReadStream |
A long value that contains the maximum ReadStream value. |
avgReadStream |
A long value that contains the average ReadStream value. |
minReadAhead |
A long value that contains the minimum accumulated ReadAhead value. |
maxReadAhead |
A long value that contains the maximum accumulated ReadAhead value. |
avgReadAhead |
A long value that contains the average accumulated ReadAhead value. |
frequency |
A string value that describes the frequency. |
endtime |
A dateTime value that contains the end time. |
MapiResponseStats
This section lists and describes the MapiResponseStats object attributes.
|
|
localResp |
A long value that contains the number of local responses. |
remoteResp |
A long value that contains the number of remote responses. |
avgLocalResp |
A long value that contains the average local response time. |
avgRemoteResp |
A long value that contains the average remote response time. |
frequency |
A string value that describes the frequency. |
endtime |
A dateTime value that contains the end time. |
MapiRequestTypeStats
This section lists and describes the MapiRsequestTypeStats object attributes.
|
|
frequency |
A string value that describes the frequency. |
endtime |
A dateTime value that contains the end time. |
securedConnections |
A long value of the secured connection count. |
lowerthan2kConnections |
A long value of the number of connections lower than 2k connections. |
higherthan2kConnections |
A long value of the number of connections higher than 2K7 connections. |
MapiClientConnCount
This section lists and describes the MapiClientConnCount object attributes.
|
|
client2k |
A long value that contains the number of past connections from client 2K. |
client2k3 |
A long value that contains the number of past connections from client 2K3. |
client2k7 |
A long value that contains the number of past connections from client 2K7. |
frequency |
A string value that describes the frequency. |
endtime |
A dateTime value that contains the end time. |
NfsSessionCount
This section lists and describes the NfsSessionCount object attributes.
|
|
sessionCount |
A long value that contains the number of sessions completed. |
frequency |
A string value that describes the frequency. |
endtime |
A dateTime value that contains the end time. |
NfsRespTypeStats
This section lists and describes the NfsRespTypeStats object attributes.
|
|
localResp |
A long value that contains the number of local responses. |
remoteResp |
A long value that contains the number of remote responses. |
avgLocalResp |
A long value that contains the average local response time. |
avgRemoteResp |
A long value that contains the average remote response time. |
frequency |
A string value that describes the frequency. |
endtime |
A dateTime value that contains the end time. |
NfsReqTypeStats
This section lists and describes the NfsReqTypeStats object attributes.
|
|
frequency |
A string value that describes the frequency. |
endtime |
A dateTime value that contains the end time. |
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. |
NfsTypeStats
This section lists and describes the MapiRequestTypeStats object attributes.
|
|
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. |
frequency |
A string value that describes the frequency. |
endtime |
A dateTime value that contains the end time. |
nfsv0Count |
A long value that contains the number of packets of NFS version NFSv0. |
nfsUnknownCount |
A long value that contains the number of packets of NFS version unknown. |