CIFS Statistics Service

This chapter describes the CIFS Statistics service, which returns the overall CIFS statistics collected on either a WAE device, WAEs within a device group, or all WAEs system wide. This service returns statistics for devices running in CIFS accelerator or CIFS legacy mode.

This chapter contains the following sections:

CIFS Statistics Service Syntax

This section contains the following topics:

CIFS Statistics Informational URLs

This section provides informational URLs for the CIFS Statistics service.

  • Service URL: https://<host/ip>:8443/ws/CIFSStats

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

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

    https://<host/ip>:8443/ws/CIFSStats?wsdl

    To obtain management information using the Central Manager monitoring API, first call the service by using the service URL for this service as follows:

    https://<host/ip>:8443/ws/CIFSStats

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

CIFS Statistics Example Request

The following example shows an XML-formatted SOAP request to perform the retrieveRequestHitRate action. The request includes the input parameters shown in bold. 


<?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#PasswordText">default</wsse:Password> 
  </wsse:UsernameToken>
  </wsse:Security>
  </soapenv:Header>
- <soapenv:Body>
- <ns1:retrieveRequestHitRate
 xmlns:ns1="http://service.stats.ws.waas.cisco.com">
  <ns1:name
>ce-119-40</ns1:name> 
  <ns1:objType
>wae</ns1:objType> 
  <ns1:trafficType
>not used</ns1:trafficType> 
  <ns1:direction
>bidirectional</ns1:direction> 
- <ns1:timeframe
>
  <ns4:endTime
 xmlns:ns4="http://util.ws.waas.cisco.com/xsd">2008-01-25T08:00:00.000Z</ns4:endTime> 
  <ns4:frequency xmlns:ns4="http://util.ws.waas.cisco.com/xsd">lasthour</ns4:frequency> 
  <ns4:startTime xmlns:ns4="http://util.ws.waas.cisco.com/xsd">2008-01-25T08:00:00.000Z</ns4:startTime> 
  <ns4:timezone xmlns:ns4="http://util.ws.waas.cisco.com/xsd">UTC</ns4:timezone> 
  </ns1:timeframe>
  </ns1:retrieveRequestHitRate>
  </soapenv:Body>
  </soapenv:Envelope>

CIFS Statistics Example Response

The following example shows the XML response that contains the output values for the retrieveRequestHitRate action.


<?xml version="1.0" encoding="utf-8" ?> 
- <soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
- <soapenv:Body>
- <ns:retrieveRequestHitRateResponse xmlns:ns="http://service.stats.ws.waas.cisco.com" xmlns:ax29="http://io.java/xsd" xmlns:ax28="http://rmi.java/xsd" xmlns:ax210="http://util.ws.waas.cisco.com/xsd" xmlns:ax211="http://stats.ws.waas.cisco.com/xsd">
- <ns:return type="com.cisco.waas.ws.stats.CIFSHitRateStats">
  <ax211:frequency
>min</ax211:frequency> 
  <ax211:inHitrate
>0</ax211:inHitrate> 
  <ax211:outHitrate
>-1</ax211:outHitrate> 
  <ax211:timestamp
>1970-01-14T23:39:47.100Z</ax211:timestamp> 
  </ns:return>
  </ns:retrieveRequestHitRateResponse>
  </soapenv:Body>
  </soapenv:Envelope>

CIFS Statistics Service Actions

The CIFS Statistics service (CIFSStats Web Service) performs one or more of the following actions:

  • getCIFSClientAvgThroughput

  • getCIFSCoreCount

  • getCIFSCoreEdgeTraffic

  • getCIFSEdgeCoreTraffic

  • getCIFSEdgeCount

  • getDiskCapacity

  • getOpenFileCount

  • getOptCIFSSessionCount

  • getRequestCount

  • retrieveCacheObjectCount

  • retrieveCacheUtilization

  • retrieveRequestHitRate

getCIFSClientAvgThroughput

Retrieves the average throughput between the Edge device and its clients, measured over the Edge device up time (including idle time). Supported for CIFS Legacy Edge and CIFS AO mode.

Input Parameters

Parameter

Description

name

A string that describes the name of the WAE.

objType

A string that describes the object type. Valid values include the following:

  • wae

trafficType

A string that describes the type of traffic. Valid values include the following:

  • passthrough

  • optimized

Note: trafficType is not used in filtering the data.

direction

A string that describes the direction of the traffic. Valid values include the following:

  • inbound

  • outbound

  • bidirectional

Note: direction is not used in filtering the data.

timeframe

A TimeFrameFilter value that includes the time interval, time zone, and frequency.

Return

The output parameter ClientAvgThroughputStats[] returns an ClientAvgThroughputStats value that provides a list of client average throughput history.

Exceptions

Type

String

Description

RemoteException

CIFSStatsService.getCIFSClientAvgThroughput: ERROR:Invalid name=

The device name is invalid.

RemoteException

CIFSStatsService.getCIFSClientAvgThroughput: ERROR:Invalid objType=

The object type name is invalid.

RemoteException

CIFSStatsService.getCIFSClientAvgThroughput: ERROR:Invalid objType=wae Only wae supported.

The object type is other than wae.

RemoteException

CIFSStatsService.getCIFSClientAvgThroughput: ERROR:Invalid TimeFrame

The timeframe is invalid.

RemoteException

CIFSStatsService.getCIFSClientAvgThroughput: ERROR:Device does not exist.DeviceName=

The device name is not found.

RemoteException

CIFSStatsService.getCIFSClientAvgThroughput: ERROR:Unsupported frequency=

The frequency is not supported.

RemoteException

CIFSStatsService.getCIFSClientAvgThroughput: ERROR:Invalid frequency=

The frequency is invalid.

RemoteException

CIFSStatsService.getCIFSClientAvgThroughput: ERROR:Invalid startTime=

The start time is invalid.

RemoteException

CIFSStatsService.getCIFSClientAvgThroughput: ERROR:Invalid endTime=

The end time is invalid.

RemoteException

CIFSStatsService.getCIFSClientAvgThroughput: ERROR:startTime should be less than endTime startTime=

The start time is less than the end time.

AxisFault

CIFSStats:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

CIFSStats:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

CIFSStats:The Requested WebService is not available

The service requested is not supported.

AxisFault

getCIFSClientAvgThroughput:The SOAP Body doesn’t have all the required elements

The SOAP body does not have all the required elements.

RemoteException

CIFSStatsService.getCIFSClientAvgThroughput: ERROR:API is not supported. cifsDevType=core

The device is running Legacy Core Mode.

getCIFSCoreCount

Retrieves the overall CIFS core count statistics collected on a WAE device. Supported for CIFS Legacy and CIFS AO mode.

Input Parameters

Parameter

Description

name

A string that describes the name of the WAE.

objType

A string that describes the object type. Valid values include the following:

  • wae

trafficType

A string that describes the type of traffic. Valid values include the following:

  • passthrough

  • optimized

Note: trafficType is not used in filtering the data.

direction

A string that describes the direction of the traffic. Valid values include the following:

  • inbound

  • outbound

  • bidirectional

Note: direction is not used in filtering the data.

timeframe

A TimeFrameFilter value that includes the time interval, time zone, and frequency.

Return

The output parameter coreCountStats[] returns a CoreCountStats value that provides a list of the core device count history.

Exceptions

Type

String

Description

RemoteException

CIFSStatsService.getCIFSCoreCount: ERROR:Invalid name=

The device name is invalid.

RemoteException

CIFSStatsService.getCIFSCoreCount: ERROR:Invalid objType=

The object type name is invalid.

RemoteException

CIFSStatsService.getCIFSCoreCount: ERROR:Invalid objType=wae Only wae supported.

The object type is other than wae.

RemoteException

CIFSStatsService.getCIFSCoreCount: ERROR:Invalid TimeFrame

The timeframe is invalid.

RemoteException

CIFSStatsService.getCIFSCoreCount: ERROR:Device does not exist.DeviceName=

The device name is not found.

RemoteException

CIFSStatsService.getCIFSCoreCount: ERROR:Unsupported frequency=

The frequency is not supported.

RemoteException

CIFSStatsService.getCIFSCoreCount: ERROR:Invalid frequency=

The frequency is invalid.

RemoteException

CIFSStatsService.getCIFSCoreCount: ERROR:Invalid startTime=

The start time is invalid.

RemoteException

CIFSStatsService.getCIFSCoreCount: ERROR:Invalid endTime=

The end time is invalid.

RemoteException

CIFSStatsService.getCIFSCoreCount: ERROR:startTime should be less than endTime startTime=

The start time is less than the end time.

AxisFault

CIFSStats:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

CIFSStats:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

CIFSStats:The Requested WebService is not available

The service requested is not supported.

AxisFault

getCIFSCoreCount:The SOAP Body doesn’t have all the required elements

The SOAP body does not have all the required elements.

RemoteException

CIFSStatsService.getCIFSCoreCount: ERROR:API is not supported. cifsDevType=

The device is running on CIFS AO mode or Legacy Core Mode.

getCIFSCoreEdgeTraffic

Retrieves the total traffic between CIFS Core and the CIFS Edges connected to it. Supported for CIFS Legacy Core mode only.

Input Parameters

Parameter

Description

name

A string that describes the name of the WAE.

objType

A string that describes the object type. Valid values include the following:

  • wae

trafficType

A string that describes the type of traffic. Valid values include the following:

  • passthrough

  • optimized

Note: trafficType is not used in filtering the data.

direction

A string that describes the direction of the traffic. Valid values include the following:

  • inbound

  • outbound

  • bidirectional

Note: direction is not used in filtering the data.

timeframe

A TimeFrameFilter value that includes the time interval, time zone, and frequency.

Return

The output parameter CIFSTrafficStats[] returns an CacheCountStats value that provides a list of traffic between Core and Edges connected to it.

Exceptions

Type

String

Description

RemoteException

CIFSStatsService.getCIFSCoreEdgeTraffic: ERROR:Invalid name=

The device name is invalid.

RemoteException

CIFSStatsService.getCIFSCoreEdgeTraffic: ERROR:Invalid objType=

The object type name is invalid.

RemoteException

CIFSStatsService.getCIFSCoreEdgeTraffic: ERROR:Invalid objType=wae Only wae supported.

The object type is other than wae.

RemoteException

CIFSStatsService.getCIFSCoreEdgeTraffic: ERROR:Invalid TimeFrame

The timeframe is invalid.

RemoteException

CIFSStatsService.getCIFSCoreEdgeTraffic: ERROR:Device does not exist.DeviceName=

The device name is not found.

RemoteException

CIFSStatsService.getCIFSCoreEdgeTraffic: ERROR:Unsupported frequency=

The frequency is not supported.

RemoteException

CIFSStatsService.getCIFSCoreEdgeTraffic: ERROR:Invalid frequency=

The frequency is invalid.

RemoteException

CIFSStatsService.getCIFSCoreEdgeTraffic: ERROR:Invalid startTime=

The start time is invalid.

RemoteException

CIFSStatsService.getCIFSCoreEdgeTraffic: ERROR:Invalid endTime=

The end time is invalid.

RemoteException

CIFSStatsService.getCIFSCoreEdgeTraffic: ERROR:startTime should be less than endTime startTime=

The start time is less than the end time.

AxisFault

CIFSStats:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

CIFSStats:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

CIFSStats:The Requested WebService is not available

The service requested is not supported.

AxisFault

getCIFSCoreEdgeTraffic:The SOAP Body doesn’t have all the required elements

The SOAP body does not have all the required elements.

RemoteException

CIFSStatsService.getCIFSCoreEdgeTraffic: ERROR:API is not supported. cifsDevType=edge

The device is running Legacy Edge Mode.

RemoteException

CIFSStatsService.getCIFSCoreEdgeTraffic: ERROR:API is not supported. cifsDevType=cifsao

The device is running CIFSAO Mode.

getCIFSEdgeCoreTraffic

Retrieves the total traffic between CIFS Edge and CIFS Cores connected to it. Supported for CIFS Legacy Edge mode only.

Input Parameters

Parameter

Description

name

A string that describes the name of the WAE.

objType

A string that describes the object type. Valid values include the following:

  • wae

trafficType

A string that describes the type of traffic. Valid values include the following:

  • passthrough

  • optimized

Note: trafficType is not used in filtering the data.

direction

A string that describes the direction of the traffic. Valid values include the following:

  • inbound

  • outbound

  • bidirectional

Note: direction is not used in filtering the data.

timeframe

A TimeFrameFilter value that includes the time interval, time zone, and frequency.

Return

The output parameter CIFSTrafficStats[] returns an CacheCountStats value that provides a list of traffic between Edge and Cores connected to it.

Exceptions

Type

String

Description

RemoteException

CIFSStatsService.getCIFSEdgeCoreTraffic: ERROR:Invalid name=

The device name is invalid.

RemoteException

CIFSStatsService.getCIFSEdgeCoreTraffic: ERROR:Invalid objType=

The object type name is invalid.

RemoteException

CIFSStatsService.getCIFSEdgeCoreTraffic: ERROR:Invalid objType=wae Only wae supported.

The object type is other than wae.

RemoteException

CIFSStatsService.getCIFSEdgeCoreTraffic: ERROR:Invalid TimeFrame

The timeframe is invalid.

RemoteException

CIFSStatsService.getCIFSEdgeCoreTraffic: ERROR:Device does not exist.DeviceName=

The device name is not found.

RemoteException

CIFSStatsService.getCIFSEdgeCoreTraffic: ERROR:Unsupported frequency=

The frequency is not supported.

RemoteException

CIFSStatsService.getCIFSEdgeCoreTraffic: ERROR:Invalid frequency=

The frequency is invalid.

RemoteException

CIFSStatsService.getCIFSEdgeCoreTraffic: ERROR:Invalid startTime=

The start time is invalid.

RemoteException

CIFSStatsService.getCIFSEdgeCoreTraffic: ERROR:Invalid endTime=

The end time is invalid.

RemoteException

CIFSStatsService.getCIFSEdgeCoreTraffic: ERROR:startTime should be less than endTime startTime=

The start time is less than the end time.

AxisFault

CIFSStats:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

CIFSStats:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

CIFSStatsService:The Requested WebService is not available

The service requested is not supported.

AxisFault

getCIFSEdgeCoreTraffic:The SOAP Body doesn’t have all the required elements

The SOAP body does not have all the required elements.

RemoteException

CIFSStatsService.getCIFSEdgeCoreTraffic: ERROR:API is not supported. cifsDevType=core

The device is running Legacy Mode.

RemoteException

CIFSStatsService.getCIFSEdgeCoreTraffic: ERROR:API is not supported. cifsDevType=cifsao

The device is running CIFSAO Mode.

getCIFSEdgeCount

Retrieves the total number of CIFS Edges connected to the CIFS Core. Supported for CIFS Legacy Core mode only.

Input Parameters

Parameter

Description

name

A string that describes the name of the WAE.

objType

A string that describes the object type. Valid values include the following:

  • wae

trafficType

A string that describes the type of traffic. Valid values include the following:

  • passthrough

  • optimized

Note: trafficType is not used in filtering the data.

direction

A string that describes the direction of the traffic. Valid values include the following:

  • inbound

  • outbound

  • bidirectional

Note: direction is not used in filtering the data.

timeframe

A TimeFrameFilter value that includes the time interval, time zone, and frequency.

Return

The output parameter EdgeCountStats[] returns an EdgeCountStats value that provides a list of edges connected to the Core.

Exceptions

Type

String

Description

RemoteException

CIFSStatsService.getCIFSEdgeCount: ERROR:Invalid name=

The device name is invalid.

RemoteException

CIFSStatsService.getCIFSEdgeCount: ERROR:Invalid objType=

The object type name is invalid.

RemoteException

CIFSStatsService.getCIFSEdgeCount: ERROR:Invalid objType=wae Only wae supported.

The object type is other than wae.

RemoteException

CIFSStatsService.getCIFSEdgeCount: ERROR:Invalid TimeFrame

The timeframe is invalid.

RemoteException

CIFSStatsService.getCIFSEdgeCount: ERROR:Device does not exist.DeviceName=

The device name is not found.

RemoteException

CIFSStatsService.getCIFSEdgeCount: ERROR:Unsupported frequency=

The frequency is not supported.

RemoteException

CIFSStatsService.getCIFSEdgeCount: ERROR:Invalid frequency=

The frequency is invalid.

RemoteException

CIFSStatsService.getCIFSEdgeCount: ERROR:Invalid startTime=

The start time is invalid.

RemoteException

CIFSStatsService.getCIFSEdgeCount: ERROR:Invalid endTime=

The end time is invalid.

RemoteException

CIFSStatsService.getCIFSEdgeCount: ERROR:startTime should be less than endTime startTime=

The start time is less than the end time.

AxisFault

CIFSStats:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

CIFSStats:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

CIFSStatsService:The Requested WebService is not available

The service requested is not supported.

AxisFault

getCIFSEdgeCount:The SOAP Body doesn’t have all the required elements

The SOAP body does not have all the required elements.

RemoteException

CIFSStatsService.getCIFSEdgeCount: ERROR:API is not supported. cifsDevType=edge

The device is running Legacy Edge Mode.

RemoteException

CIFSStatsService.getCIFSEdgeCount: ERROR:API is not supported. cifsDevType=cifsao

The device is running Legacy CIFSAO Mode.

getDiskCapacity

Retrieves the overall disk capacity statistics collected on a WAE device. Supported for CIFS Legacy and CIFS AO mode.

Input Parameters

Parameter

Description

name

A string that describes the name of the WAE.

objType

A string that describes the object type. Valid values include the following:

  • wae

trafficType

A string that describes the type of traffic. Valid values include the following:

  • passthrough

  • optimized

Note: trafficType is not used in filtering the data.

direction

A string that describes the direction of the traffic. Valid values include the following:

  • inbound

  • outbound

  • bidirectional

Note: trafficType is not used in filtering the data.

timeframe

A TimeFrameFilter value that includes the time interval, time zone, and frequency.

Return

The output parameter diskCapacityStats[] returns a DiskCapacityStats value that provides a list of the disk capacity history.

Exceptions

Type

String

Description

RemoteException

CIFSStatsService.getDiskCapacity: ERROR:Invalid name=

The device name is invalid.

RemoteException

CIFSStatsService.getDiskCapacity: ERROR:Invalid objType=

The object type name is invalid.

RemoteException

CIFSStatsService.getDiskCapacity: ERROR:Invalid objType=wae Only wae supported.

The object type is other than wae.

RemoteException

CIFSStatsService.getDiskCapacity: ERROR:Invalid TimeFrame

The timeframe is invalid.

RemoteException

CIFSStatsService.getDiskCapacity: ERROR:Device does not exist.DeviceName=

The device name is not found.

RemoteException

CIFSStatsService.getDiskCapacity: ERROR:Unsupported frequency=

The frequency is not supported.

RemoteException

CIFSStatsService.getDiskCapacity: ERROR:Invalid frequency=

The frequency is invalid.

RemoteException

CIFSStatsService.getDiskCapacity: ERROR:Invalid startTime=

The start time is invalid.

RemoteException

CIFSStatsService.getDiskCapacity: ERROR:Invalid endTime=

The end time is invalid.

RemoteException

CIFSStatsService.getDiskCapacity: ERROR:startTime should be less than endTime startTime=

The start time is less than the end time.

AxisFault

CIFSStats:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

CIFSStats:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

CIFSStats:The Requested WebService is not available

The service requested is not supported.

AxisFault

getDiskCapacity:The SOAP Body doesn’t have all the required elements

The SOAP body does not have all the required elements.

RemoteException

CIFSStatsService.getDiskCapacity: ERROR:API is not supported. cifsDevType=core

The device is running Legacy Core Mode.

getOpenFileCount

Retrieves the overall open file count statistics statistics collected on a WAE device. Supported for CIFS Legacy and CIFS AO mode.

Input Parameters

Parameter

Description

name

A string that describes the name of the WAE.

objType

A string that describes the object type. Valid values include the following:

  • wae

trafficType

A string that describes the type of traffic. Valid values include the following:

  • passthrough

  • optimized

Note: trafficType is not used in filtering the data.

direction

A string that describes the direction of the traffic. Valid values include the following:

  • inbound

  • outbound

  • bidirectional

Note: direction is not used in filtering the data.

timeframe

A TimeFrameFilter value that includes the time interval, time zone, and frequency.

Return

The output parameter fileCountStats[] returns a FileCountStats value that provides a list of the open files history.

Exceptions

Type

String

Description

RemoteException

CIFSStatsService.getOpenFileCount: ERROR:Invalid name=

The device name is invalid.

RemoteException

CIFSStatsService.getOpenFileCount: ERROR:Invalid objType=

The object type name is invalid.

RemoteException

CIFSStatsService.getOpenFileCount: ERROR:Invalid objType=wae Only wae supported.

The object type is other than wae.

RemoteException

CIFSStatsService.getOpenFileCount: ERROR:Invalid TimeFrame

The timeframe is invalid.

RemoteException

CIFSStatsService.getOpenFileCount: ERROR:Device does not exist.DeviceName=

The device name is not found.

RemoteException

CIFSStatsService.getOpenFileCount: ERROR:Unsupported frequency=

The frequency is not supported.

RemoteException

CIFSStatsService.getOpenFileCount: ERROR:Invalid frequency=

The frequency is invalid.

RemoteException

CIFSStatsService.getOpenFileCount: ERROR:Invalid startTime=

The start time is invalid.

RemoteException

CIFSStatsService.getOpenFileCount: ERROR:Invalid endTime=

The end time is invalid.

RemoteException

CIFSStatsService.getOpenFileCount: ERROR:startTime should be less than endTime startTime=

The start time is less than the end time.

AxisFault

CIFSStats:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

CIFSStats:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

CIFSStats:The Requested WebService is not available

The service requested is not supported.

AxisFault

getOpenFileCount:The SOAP Body doesn’t have all the required elements

The SOAP body does not have all the required elements.

RemoteException

CIFSStatsService.getOpenFileCount: ERROR:API is not supported. cifsDevType=core

The device is running Legacy Core Mode.

getOptCIFSSessionCount

Retrieves the overall open CIFS session count statistics collected on a WAE device. Supported for CIFS Legacy and CIFS AO mode.

Input Parameters

Parameter

Description

name

A string that describes the name of the WAE.

objType

A string that describes the object type. Valid values include the following:

  • wae

trafficType

A string that describes the type of traffic. Valid values include the following:

  • passthrough

  • optimized

Note: trafficType is not used in filtering the data.

direction

A string that describes the direction of the traffic. Valid values include the following:

  • inbound

  • outbound

  • bidirectional

Note: direction is not used in filtering the data.

timeframe

A TimeFrameFilter value that includes the time interval, time zone, and frequency.

Return

The output parameter sessionCountStats[] returns a SessionCountStats value that provides a list of the session history.

Exceptions

Type

String

Description

RemoteException

CIFSStatsService.getOptCIFSSessionCount: ERROR:Invalid name=

The device name is invalid.

RemoteException

CIFSStatsService.getOptCIFSSessionCount: ERROR:Invalid objType=

The object type name is invalid.

RemoteException

CIFSStatsService.getOptCIFSSessionCount: ERROR:Invalid objType=wae Only wae supported.

The object type is other than wae.

RemoteException

CIFSStatsService.getOptCIFSSessionCount: ERROR:Invalid TimeFrame

The timeframe is invalid.

RemoteException

CIFSStatsService.getOptCIFSSessionCount: ERROR:Device does not exist.DeviceName=

The device name is not found.

RemoteException

CIFSStatsService.getOptCIFSSessionCount: ERROR:Unsupported frequency=

The frequency is not supported.

RemoteException

CIFSStatsService.getOptCIFSSessionCount: ERROR:Invalid frequency=

The frequency is invalid.

RemoteException

CIFSStatsService.getOptCIFSSessionCount: ERROR:Invalid startTime=

The start time is invalid.

RemoteException

CIFSStatsService.getOptCIFSSessionCount: ERROR:Invalid endTime=

The end time is invalid.

RemoteException

CIFSStatsService.getOptCIFSSessionCount: ERROR:startTime should be less than endTime startTime=

The start time is less than the end time.

AxisFault

CIFSStats:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

CIFSStats:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

CIFSStats:The Requested WebService is not available

The service requested is not supported.

AxisFault

getOptCIFSSessionCount:The SOAP Body doesn’t have all the required elements

The SOAP body does not have all the required elements.

RemoteException

CIFSStatsService.getDiskCapacityCount: ERROR:API is not supported. cifsDevType=core

The device is running Legacy Core Mode.

getRequestCount

Retrieves the overall request count statistics statistics collected on a WAE device. Supported for CIFS Legacy and CIFS AO mode.

Input Parameters

Parameter

Description

name

A string that describes the name of the WAE.

objType

A string that describes the object type. Valid values include the following:

  • wae

trafficType

A string that describes the type of traffic. Valid values include the following:

  • passthrough

  • optimized

Note: trafficType is not used in filtering the data.

direction

A string that describes the direction of the traffic. Valid values include the following:

  • inbound

  • outbound

  • bidirectional

Note: direction is not used in filtering the data.

timeframe

A TimeFrameFilter value that includes the time interval, time zone, and frequency.

Return

The output parameter requestCountStats[] returns a RequestCountStats value that provides a list of the request count history.

Exceptions

Type

String

Description

RemoteException

CIFSStatsService.getRequestCount: ERROR:Invalid name=

The device name is invalid.

RemoteException

CIFSStatsService.getRequestCount: ERROR:Invalid objType=

The object type name is invalid.

RemoteException

CIFSStatsService.getRequestCount: ERROR:Invalid objType=wae Only wae supported.

The object type is other than wae.

RemoteException

CIFSStatsService.getRequestCount: ERROR:Invalid TimeFrame

The timeframe is invalid.

RemoteException

CIFSStatsService.getRequestCount: ERROR:Device does not exist.DeviceName=

The device name is not found.

RemoteException

CIFSStatsService.getRequestCount: ERROR:Unsupported frequency=

The frequency is not supported.

RemoteException

CIFSStatsService.getRequestCount: ERROR:Invalid frequency=

The frequency is invalid.

RemoteException

CIFSStatsService.getRequestCount: ERROR:Invalid startTime=

The start time is invalid.

RemoteException

CIFSStatsService.getRequestCount: ERROR:Invalid endTime=

The end time is invalid.

RemoteException

CIFSStatsService.getRequestCount: ERROR:startTime should be less than endTime startTime=

The start time is less than the end time.

AxisFault

CIFSStats:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

CIFSStats:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

CIFSStats:The Requested WebService is not available

The service requested is not supported.

AxisFault

getRequestCount:The SOAP Body doesn’t have all the required elements

The SOAP body does not have all the required elements.

RemoteException

CIFSStatsService.getRequestCount: ERROR:API is not supported. cifsDevType=core

The device is running Legacy Core Mode.

retrieveCacheObjectCount

Retrieves the overall cache object count statistics collected on a WAE device. Supported for CIFS Legacy and CIFS AO mode.

Input Parameters

Parameter

Description

name

A string that describes the name of the WAE.

objType

A string that describes the object type. Valid values include the following:

  • wae

trafficType

A string that describes the type of traffic. Valid values include the following:

  • passthrough

  • optimized

Note: trafficType is not used in filtering the data.

direction

A string that describes the direction of the traffic. Valid values include the following:

  • inbound

  • outbound

  • bidirectional

Note: direction is not used in filtering the data.

timeframe

A TimeFrameFilter value that includes the time interval, time zone, and frequency.

Return

The output parameter cacheCountStats[] returns a CacheCountStats value that provides a list of the cache count history.

Exceptions

Type

String

Description

RemoteException

CIFSStatsService.retrieveCacheObjectCount: ERROR:Invalid name=

The device name is invalid.

RemoteException

CIFSStatsService.retrieveCacheObjectCount: ERROR:Invalid objType=

The object type name is invalid.

RemoteException

CIFSStatsService.retrieveCacheObjectCount: ERROR:Invalid objType=wae Only wae supported.

The object type is other than wae.

RemoteException

CIFSStatsService.retrieveCacheObjectCount: ERROR:Invalid TimeFrame

The timeframe is invalid.

RemoteException

CIFSStatsService.retrieveCacheObjectCount: ERROR:Device does not exist.DeviceName=

The device name is not found.

RemoteException

CIFSStatsService.retrieveCacheObjectCount: ERROR:Unsupported frequency=

The frequency is not supported.

RemoteException

CIFSStatsService.retrieveCacheObjectCount: ERROR:Invalid frequency=

The frequency is invalid.

RemoteException

CIFSStatsService.retrieveCacheObjectCount: ERROR:Invalid startTime=

The start time is invalid.

RemoteException

CIFSStatsService.retrieveCacheObjectCount: ERROR:Invalid endTime=

The end time is invalid.

RemoteException

CIFSStatsService.retrieveCacheObjectCount: ERROR:startTime should be less than endTime startTime=

The start time is less than the end time.

AxisFault

CIFSStats:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

CIFSStats:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

CIFSStats:The Requested WebService is not available

The service requested is not supported.

AxisFault

retrieveCacheObjectCount:The SOAP Body doesn’t have all the required elements

The SOAP body does not have all the required elements.

RemoteException

CIFSStatsService.retrieveCacheObjectCount: ERROR:API is not supported. cifsDevType=core

The device is running Legacy Core Mode.

retrieveCacheUtilization

Retrieves the overall cache utilization statistics collected on a WAE device.

Input Parameters

Parameter

Description

name

A string that describes the name of the WAE.

objType

A string that describes the object type. Valid values include the following:

  • wae

trafficType

A string that describes the type of traffic. Valid values include the following:

  • passthrough

  • optimized

Note: trafficType is not used in filtering the data.

direction

A string that describes the direction of the traffic. Valid values include the following:

  • inbound

  • outbound

  • bidirectional

Note: direction is not used in filtering the data.

timeframe

A TimeFrameFilter value that includes the time interval, time zone, and frequency.

Return

The output parameter cacheUtilizationStats[] returns a CacheUtilizationStats value that provides a list of the utilization history.

Exceptions

Type

String

Description

RemoteException

CIFSStatsService.retrieveCacheUtilization: ERROR:Invalid name=

The device name is invalid.

RemoteException

CIFSStatsService.retrieveCacheUtilization: ERROR:Invalid objType=

The object type name is invalid.

RemoteException

CIFSStatsService.retrieveCacheUtilization: ERROR:Invalid objType=wae Only wae supported.

The object type is other than wae.

RemoteException

CIFSStatsService.retrieveCacheUtilization: ERROR:Invalid TimeFrame

The timeframe is invalid.

RemoteException

CIFSStatsService.retrieveCacheUtilization: ERROR:Device does not exist.DeviceName=

The device name is not found.

RemoteException

CIFSStatsService.retrieveCacheUtilization: ERROR:Unsupported frequency=

The frequency is not supported.

RemoteException

CIFSStatsService.retrieveCacheUtilization: ERROR:Invalid frequency=

The frequency is invalid.

RemoteException

CIFSStatsService.retrieveCacheUtilization: ERROR:Invalid startTime=

The start time is invalid.

RemoteException

CIFSStatsService.retrieveCacheUtilization: ERROR:Invalid endTime=

The end time is invalid.

RemoteException

CIFSStatsService.retrieveCacheUtilization: ERROR:startTime should be less than endTime startTime=

The start time is less than the end time.

AxisFault

CIFSStats:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

CIFSStats:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

CIFSStats:The Requested WebService is not available

The service requested is not supported.

AxisFault

retrieveCacheUtilization:The SOAP Body doesn’t have all the required elements

The SOAP body does not have all the required elements.

RemoteException

CIFSStatsService.retrieveCacheUtilization: ERROR:API is not supported. cifsDevType=core

The device is running Legacy Core Mode.

retrieveRequestHitRate

Retrieves the overall hit rate statistics collected on a WAE device. Supported for CIFS Legacy and CIFS AO mode.

Input Parameters

Parameter

Description

name

A string that describes the name of the WAE.

objType

A string that describes the object type. Valid values include the following:

  • wae

trafficType

A string that describes the type of traffic. Valid values include the following:

  • passthrough

  • optimized

Note: trafficType is not used in filtering the data.

direction

A string that describes the direction of the traffic. Valid values include the following:

  • inbound

  • outbound

  • bidirectional

Note: direction is not used in filtering the data.

timeframe

A TimeFrameFilter value that includes the time interval, time zone, and frequency.

Return

The output parameter HitRateStats[] returns a HitRateStats value that provides a list of the hit rate history.

Exceptions

Type

String

Description

RemoteException

CIFSStatsService.retrieveRequestHitRate: ERROR:Invalid name=

The device name is invalid.

RemoteException

CIFSStatsService.retrieveRequestHitRate: ERROR:Invalid objType=

The object type name is invalid.

RemoteException

CIFSStatsService.retrieveRequestHitRate: ERROR:Invalid objType=wae Only wae supported.

The object type is other than wae.

RemoteException

CIFSStatsService.retrieveRequestHitRate: ERROR:Invalid TimeFrame

The timeframe is invalid.

RemoteException

CIFSStatsService.retrieveRequestHitRate: ERROR:Device does not exist.DeviceName=

The device name is not found.

RemoteException

CIFSStatsService.retrieveRequestHitRate: ERROR:Unsupported frequency=

The frequency is not supported.

RemoteException

CIFSStatsService.retrieveRequestHitRate: ERROR:Invalid frequency=

The frequency is invalid.

RemoteException

CIFSStatsService.retrieveRequestHitRate: ERROR:Invalid startTime=

The start time is invalid.

RemoteException

CIFSStatsService.retrieveRequestHitRate: ERROR:Invalid endTime=

The end time is invalid.

RemoteException

CIFSStatsService.retrieveRequestHitRate: ERROR:startTime should be less than endTime startTime=

The start time is less than the end time.

AxisFault

CIFSStats:The Method Name is not supported. MethodName=

The method name is not supported for a given service.

AxisFault

CIFSStats:The SOAP Envelope Body is Null

The SOAP envelope is missing for a given service.

AxisFault

CIFSStats:The Requested WebService is not available

The service requested is not supported.

AxisFault

retrieveCIFSStats:The SOAP Body doesn’t have all the required elements

The SOAP body does not have all the required elements.

RemoteException

CIFSStatsService.retrieveRequestHitRate: ERROR:API is not supported. cifsDevType=core

The device is running Legacy Core Mode.