The SMB Statistics (SMB Web Service) performs one or more of the following actions:
getConnOptCount
Retrieves a count of the number of SMB optimized connections.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
-
wae
-
waegroup
-
device
-
devicegroup
-
system
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter SmbOptConnCount[] returns a SmbOptConnCount value that provides the total number of optimized connections.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
SmbStatsService.getConnOptCount: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
SmbStatsService.getConnOptCount: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
SmbStatsService.getConnOptCount: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
SmbStatsService.getConnOptCount: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
SmbStatsService.getConnOptCount: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
SmbStatsService.getConnOptCount: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
SmbStatsService.getConnOptCount: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
SmbStatsService.getConnOptCount: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
SmbStatsService.getConnOptCount: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
SmbStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
SmbStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
SmbStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
getConnOptCount:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
getConnOptRate
Retrieves the average amount of time saved due to SMB AO optimizations.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
-
wae
-
waegroup
-
device
-
devicegroup
-
system
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter SmbConnOptRate[] returns a <FIX XREF> SmbConnOptRate value that provides the average amount of time saved.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
SmbStatsService.getConnOptRate: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
SmbStatsService.getConnOptRate: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
SmbStatsService.getConnOptRate: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
SmbStatsService.getConnOptRate: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
SmbStatsService.getConnOptRate: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
SmbStatsService.getConnOptRate: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
SmbStatsService.getConnOptRate: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
SmbStatsService.getConnOptRate: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
SmbStatsService.getConnOptRate: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
SmbStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
SmbStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
SmbStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
getConnOptRate:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
getConnOptSavingsByType
Retrieves information about how much time was saved for different types of data optimizations.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
-
wae
-
waegroup
-
device
-
devicegroup
-
system
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter SmbConnOptSavings[] returns a SmbConnOptSavings value that provides information about the amount of time saved for different operation types,
including meta data, named pipe, MS Office, and read-ahead traffic.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
SmbStatsService.getConnOptSavingsByType: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
SmbStatsService.getConnOptSavingsByType: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
SmbStatsService.getConnOptSavingsByType: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
SmbStatsService.getConnOptSavingsByType: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
SmbStatsService.getConnOptSavingsByType: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
SmbStatsService.getConnOptSavingsByType: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
SmbStatsService.getConnOptSavingsByType: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
SmbStatsService.getConnOptSavingsByType: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
SmbStatsService.getConnOptSavingsByType: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
SmbStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
SmbStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
SmbStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
getConnOptSavingsByType:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
getRequestOptStats
Retrieves statistics about the SMB optimization rates for various SMB optimization techniques.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
-
wae
-
waegroup
-
device
-
devicegroup
-
system
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter SmbRequestOptStats[] returns a <FIX XREF> SmbRequestOptStats value that provides optimization rates for metadata, read-ahead, write, and other
requests.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
SmbStatsService.getRequestOptStats: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
SmbStatsService.getRequestOptStats: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
SmbStatsService.getRequestOptStats: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
SmbStatsService.getRequestOptStats: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
SmbStatsService.getRequestOptStats: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
SmbStatsService.getRequestOptStats: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
SmbStatsService.getRequestOptStats: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
SmbStatsService.getRequestOptStats: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
SmbStatsService.getRequestOptStats: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
SmbStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
SmbStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
SmbStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
getRequestOptStats:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
getTotalConnCount
Retrieves a count of the number of SMB LAN connections.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
-
wae
-
waegroup
-
device
-
devicegroup
-
system
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter SmbTotalConnCount[] returns a SmbTotalConnCount value that provides the total number of LAN connections.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
SmbStatsService.getTotalConnCount: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
SmbStatsService.getTotalConnCount: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
SmbStatsService.getTotalConnCount: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
SmbStatsService.getTotalConnCount: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
SmbStatsService.getTotalConnCount: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
SmbStatsService.getTotalConnCount: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
SmbStatsService.getTotalConnCount: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
SmbStatsService.getTotalConnCount: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
SmbStatsService.getTotalConnCount: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
SmbStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
SmbStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
SmbStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
getTotalConnCount:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveStats
Retrieves SMB connection statistics collected on either a WAE device, WAEs within a device group, or all WAEs system wide.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
-
wae
-
waegroup
-
device
-
devicegroup
-
system
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter SmbConnStats[] returns a SmbConnStats value that provides statistics including the number of currently active connections, and the total
number of dropped, handled, and optimized connections.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
SmbStatsService.retrieveStats: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
SmbStatsService.retrieveStats: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
SmbStatsService.retrieveStats: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
SmbStatsService.retrieveStats: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
SmbStatsService.retrieveStats: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
SmbStatsService.retrieveStats: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
SmbStatsService.retrieveStats: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
SmbStatsService.retrieveStats: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
SmbStatsService.retrieveStats: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
SmbStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
SmbStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
SmbStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveStats:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|