- Index
- Preface
- Introduction to the Cisco WAAS Central Manager Monitoring API
- Device Configuration Service
- Traffic Acceleration Service
- CIFS Statistics Service
- Video Streaming Statistics Service
- HTTP Statistics Service
- MAPI Statistics Service
- NFS Statistics Service
- Events and Status Service
- SSL Statistics Service
- Web Service Objects
SSL Statistics Service
This chapter describes the SSL service and the actions it performs. The SSL service returns SSL connection information and statistics for individual WAEs, device groups, and for the WAAS network as a whole.
The SSL service is the SslStats Web Service. This Web Service performs one or more of the following actions:
Syntax
Service URL: https://<host/ip>:8443/ws/SslStats
WSDL URL: https://<host/ip>:8443/ws/SslStats?wsdl
To obtain a description all of the operations and parameters for the SslStats service, submit a URL to the service with the suffix "?wsdl". For example:
https://<host/ip>:8443/ws/SslStats?wsdl
To obtain management information using the WAAS Central Manager Monitoring API, first call the service by using the service URL for this service. For example:
https://<host/ip>:8443/ws/SslStats
Next, submit a SOAP request written in XML format to retrieve the information.
The following example shows an XML-formatted SOAP request perform the getOptConnCount 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>
- <ns3:getOptConnCount xmlns:ns3="http://service.stats.ws.waas.cisco.com">
<ns3:name>ce-119-40</ns3:name>
<ns3:objType>wae</ns3:objType>
- <ns3:timeframe>
<ns2:endTime
xmlns:ns2="http://util.ws.waas.cisco.com/xsd">2008-01-30T08:00:00.000Z</ns2:endTime>
<ns2:frequency xmlns:ns2="http://util.ws.waas.cisco.com/xsd">lasthour</ns2:frequency>
<ns2:startTime xmlns:ns2="http://util.ws.waas.cisco.com/xsd">2008-01-01T08:00:00.000Z</ns2:startTime>
<ns2:timezone xmlns:ns2="http://util.ws.waas.cisco.com/xsd">UTC</ns2:timezone>
</ns3:timeframe>
</ns3:getOptConnCount>
</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:getOptConnCountResponse xmlns:ns="http://service.stats.ws.waas.cisco.com" xmlns:ax218="http://util.ws.waas.cisco.com/xsd" xmlns:ax216="http://rmi.java/xsd" xmlns:ax219="http://stats.ws.waas.cisco.com/xsd" xmlns:ax217="http://io.java/xsd">
- <ns:return type="com.cisco.waas.ws.stats.SSLOptConnCount">
<ax219:endtime>2008-04-16T17:39:17.818Z</ax219:endtime>
<ax219:optimized_connections>31</ax219:optimized_connections >
<ax219:frequency>min</ax219:frequency>
</ns:return>
- <ns:return type="com.cisco.waas.ws.stats.SSLOptConnCount">
<ax219:endtime>2008-04-16T17:44:18.703Z</ax219:endtime>
<ax219:optimized_connections >23</ax219:optimized_connections >
<ax219:frequency>min</ax219:frequency>
</ns:return>
</ns:getOptConnCountResponse>
</soapenv:Body>
</soapenv:Envelope>
getOptConnCount
Retrieves the number of optimized HTTPS connections. If a time interval is specified, the time frame will be divided into time slices. In each time slice, the connection count is calculated.
Input Parameters
|
|
|
|---|---|
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: • • • |
timeframe |
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter SSLOptConnCount [] returns an SSLOptConnCount value that provides an array of HTTPS traffic optimized connection statistics.
Exceptions
getTotalConnCount
Retrieves the total number of HTTPS connections. If a time interval is specified, the time frame will be divided into time slices. In each of the time slices, the connection count is calculated.
Input Parameters
|
|
|
|---|---|
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: • • • |
timeframe |
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter SSLTotalConnCount [] returns an SSLTotalConnCount value that provides an array of HTTPS traffic total connection statistics.
Exceptions
getUnAccelConnCount
Retrieves the number of unaccelerated HTTPS connections. If a time interval is specified, the time frame will be divided into time slices. In each of the time slices, the connection count is calculated.
Input Parameters
|
|
|
|---|---|
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: • • • |
timeframe |
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter SSLUnAccelConnCount [] returns an SSLUnAccelConnCount value that provides an array of HTTPS traffic unaccelerated connection statistics.
Exceptions
getErrorConnCount
Retrieves the total number of dropped HTTPS connections. If a time interval is specified, the time frame will be divided into time slices. In each of the time slices, the connection count is calculated.
Input Parameters
|
|
|
|---|---|
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: • • • |
timeframe |
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter SSLErrorConnCount [] returns an SSLErrorConnCount value that provides an array of HTTPS traffic dropped connection statistics.
Exceptions
getBytesCount
Retrieves the total number of bytes read/written out on LAN and WAN. If a time interval is specified, the time frame will be divided into time slices. In each of the time slices, the connection count is calculated.
Input Parameters
|
|
|
|---|---|
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: • • • |
timeframe |
A TimeFrameFilter value that includes the time interval, time zone, and frequency. |
Return
The output parameter SSLBytesCount [] returns an SSLBytesCount value that provides an array of HTTPS traffic dropped connection statistics.
Exceptions
Feedback