Class: IControl::System::Statistics

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/system/statistics.rb,
lib/icontrol/system.rb

Overview

The Statistics interface enables you to get information on various system statistics.

Defined Under Namespace

Classes: GlobalHostStatistics, GlobalTMMStatistics, GtmIQueryState, GtmIQueryStatisticEntry, GtmIQueryStatisticEntrySequence, GtmIQueryStatistics, GtmLdnsStatisticEntry, GtmLdnsStatisticEntrySequence, GtmLdnsStatistics, GtmPathStatisticEntry, GtmPathStatisticEntrySequence, GtmPathStatisticObjectID, GtmPathStatisticObjectIDSequence, GtmPathStatisticObjectType, GtmPathStatistics, HostStatisticEntry, HostStatisticEntrySequence, HostStatistics, PVAStatisticEntry, PVAStatisticEntrySequence, PVAStatistics, PerformanceGraph, PerformanceGraphDataCSV, PerformanceGraphDataCSVSequence, PerformanceGraphSequence, PerformanceStatisticQuery, PerformanceStatisticQuerySequence, PerformanceTable, PerformanceTableData, PerformanceTableDataSequence, PerformanceTableSequence, SystemStatistics, TMMStatisticEntry, TMMStatisticEntrySequence, TMMStatistics, VirtualCompressionStatisticEntry, VirtualCompressionStatisticEntrySequence, VirtualCompressionStatistics

Instance Method Summary (collapse)

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class IControl::Base

Instance Method Details

- (GtmIQueryStatistics) all_gtm_iquery_statistics

Gets the statistics for all the iQueries.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



54
55
56
 
# File 'lib/icontrol/system/statistics.rb', line 54

def all_gtm_iquery_statistics
  super
end

- (HostStatistics) all_host_statistics

Gets all of the system's host statistics. Note that CPU usage statistics by host are available but not retrieved by this method.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



66
67
68
 
# File 'lib/icontrol/system/statistics.rb', line 66

def all_host_statistics
  super
end

- (PVAStatistics) all_pva_statistics

Gets all of the system's PVA statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



77
78
79
 
# File 'lib/icontrol/system/statistics.rb', line 77

def all_pva_statistics
  super
end

- (TMMStatistics) all_tmm_statistics

Gets all of the system's TMOS processing agent statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



88
89
90
 
# File 'lib/icontrol/system/statistics.rb', line 88

def all_tmm_statistics
  super
end

- (VirtualCompressionStatistics) all_virtual_compression_statistics

This method has been deprecated, as it represents internal, implementation-specific details. Gets the statistics for all the virtual compression devices.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::NotImplemented) —

    raised if the method is not supported or implemented.



99
100
101
 
# File 'lib/icontrol/system/statistics.rb', line 99

def all_virtual_compression_statistics
  super
end

- (SystemStatistics) authentication_statistics

Gets the system's global authentication statistics. These are the roll-ups of all the individual authentication profiles' statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



111
112
113
 
# File 'lib/icontrol/system/statistics.rb', line 111

def authentication_statistics
  super
end

- (SystemStatistics) client_ssl_statistics

Gets the system's global client SSL statistics. These are the roll-ups of all the individual client SSL profiles' statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



123
124
125
 
# File 'lib/icontrol/system/statistics.rb', line 123

def client_ssl_statistics
  super
end

- (SystemStatistics) diameter_statistics

Gets the system's global Diameter statistics. These are the roll-ups of all the individual Diameter profiles' statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



135
136
137
 
# File 'lib/icontrol/system/statistics.rb', line 135

def diameter_statistics
  super
end

- (SystemStatistics) dns_statistics

Gets the system's global DNS profile statistics. These are the roll-ups of all the individual DNS profiles' statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



147
148
149
 
# File 'lib/icontrol/system/statistics.rb', line 147

def dns_statistics
  super
end

- (SystemStatistics) fasthttp_statistics

Gets the system's global Fast HTTP statistics. These are the roll-ups of all the individual Fast HTTP profiles' statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



159
160
161
 
# File 'lib/icontrol/system/statistics.rb', line 159

def fasthttp_statistics
  super
end

- (SystemStatistics) fastl4_statistics

Gets the system's global FastL4 statistics. These are the roll-ups of all the individual FastL4 profiles' statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



171
172
173
 
# File 'lib/icontrol/system/statistics.rb', line 171

def fastl4_statistics
  super
end

- (SystemStatistics) ftp_statistics

Gets the system's global FTP statistics. These are the roll-ups of all the individual FTP profiles' statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



183
184
185
 
# File 'lib/icontrol/system/statistics.rb', line 183

def ftp_statistics
  super
end

- (GlobalHostStatistics) global_host_statistics

Gets the system's global host statistics. Note that global CPU usage statistics are available but not retrieved by this method. This gets one set of combined ("rolled up") statistics for all hosts. It is not to be confused with get_all_host_statistics, which gets all individual host statistics, one for each host.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



197
198
199
 
# File 'lib/icontrol/system/statistics.rb', line 197

def global_host_statistics
  super
end

- (SystemStatistics) global_statistics

Gets the system's global statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



208
209
210
 
# File 'lib/icontrol/system/statistics.rb', line 208

def global_statistics
  super
end

- (GlobalTMMStatistics) global_tmm_statistics

Gets the system's global TMOS processing agent statistics. This gets one set of combined ("rolled up") statistics for all TMOS processing agents. It is not to be confused with get_all_tmm_statistics, which gets all individual TMOS processing agent statistics, one for each TMOS processing agent.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



222
223
224
 
# File 'lib/icontrol/system/statistics.rb', line 222

def global_tmm_statistics
  super
end

- (SystemStatistics) gtm_global_statistics

Gets the GTM global statistics. These are the roll-ups of all the individual wide IPs' and iQueries statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



234
235
236
 
# File 'lib/icontrol/system/statistics.rb', line 234

def gtm_global_statistics
  super
end

- (GtmIQueryStatistics) gtm_iquery_statistics(opts)

Gets the statistics for this iQueries.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :addresses (String) —

    The iQueries to get the statistics from.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



247
248
249
250
 
# File 'lib/icontrol/system/statistics.rb', line 247

def gtm_iquery_statistics(opts)
  check_params(opts,[:addresses])
  super
end

- (GtmLdnsStatistics) gtm_ldns_statistics

Gets the statistics for this LDNSes.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



259
260
261
 
# File 'lib/icontrol/system/statistics.rb', line 259

def gtm_ldns_statistics
  super
end

- (SystemStatistics) gtm_memory_usage_statistics

Gets the memory usage statistics used by GTM.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



270
271
272
 
# File 'lib/icontrol/system/statistics.rb', line 270

def gtm_memory_usage_statistics
  super
end

- (GtmPathStatistics) gtm_path_statistics(opts)

Gets the statistics for this paths (LDNSes and links).

Parameters:

  • opts (Hash)

Options Hash (opts):

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



283
284
285
286
 
# File 'lib/icontrol/system/statistics.rb', line 283

def gtm_path_statistics(opts)
  check_params(opts,[:object_names])
  super
end

- (HostStatistics) host_statistics(opts)

Gets the system's host statistics (by host id). Note that CPU usage statistics by host are available but not retrieved by this method.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :host_ids (String) —

    The host ids for which to get statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



298
299
300
301
 
# File 'lib/icontrol/system/statistics.rb', line 298

def host_statistics(opts)
  check_params(opts,[:host_ids])
  super
end

- (SystemStatistics) http_statistics

Gets the system's global HTTP statistics. These are the roll-ups of all the individual HTTP profiles' statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



311
312
313
 
# File 'lib/icontrol/system/statistics.rb', line 311

def http_statistics
  super
end

- (SystemStatistics) icmp_statistics

Gets the system's ICMP statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



322
323
324
 
# File 'lib/icontrol/system/statistics.rb', line 322

def icmp_statistics
  super
end

- (SystemStatistics) icmpv6_statistics

Gets the system's ICMPv6 statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



333
334
335
 
# File 'lib/icontrol/system/statistics.rb', line 333

def icmpv6_statistics
  super
end

- (SystemStatistics) iiop_statistics

Gets the system's global IIOP statistics. These are the roll-ups of all the individual IIOP profiles' statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



345
346
347
 
# File 'lib/icontrol/system/statistics.rb', line 345

def iiop_statistics
  super
end

- (SystemStatistics) ip_statistics

Gets the system's IP statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



356
357
358
 
# File 'lib/icontrol/system/statistics.rb', line 356

def ip_statistics
  super
end

- (SystemStatistics) ipv6_statistics

Gets the system's IPv6 statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



367
368
369
 
# File 'lib/icontrol/system/statistics.rb', line 367

def ipv6_statistics
  super
end

- (String) list_of_hosts

Gets a list of all hosts.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



378
379
380
 
# File 'lib/icontrol/system/statistics.rb', line 378

def list_of_hosts
  super
end

- (String) list_of_pvas

Gets a list of all PVAs.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



389
390
391
 
# File 'lib/icontrol/system/statistics.rb', line 389

def list_of_pvas
  super
end

- (String) list_of_tmms

Gets a list of all TMOS processing agents.

Returns:

  • (String)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



400
401
402
 
# File 'lib/icontrol/system/statistics.rb', line 400

def list_of_tmms
  super
end

- (SystemStatistics) oneconnect_statistics

Gets the system's global OneConnect statistics. These are the roll-ups of all the individual OneConnect profiles' statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



412
413
414
 
# File 'lib/icontrol/system/statistics.rb', line 412

def oneconnect_statistics
  super
end

- (PerformanceGraphDataCSV) performance_graph_csv_statistics(opts)

Gets the statistical data in CSV format for this graphs/tables.

Parameters:

  • opts (Hash)

Options Hash (opts):

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



425
426
427
428
 
# File 'lib/icontrol/system/statistics.rb', line 425

def performance_graph_csv_statistics(opts)
  check_params(opts,[:objects])
  super
end

- (PerformanceGraph) performance_graph_list

Gets the list of available statistical graphs as seen in the GUI's Performance Graph.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



437
438
439
 
# File 'lib/icontrol/system/statistics.rb', line 437

def performance_graph_list
  super
end

- (PerformanceTable) performance_table_list

Gets the list of available statistical tables.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



448
449
450
 
# File 'lib/icontrol/system/statistics.rb', line 448

def performance_table_list
  super
end

- (PerformanceTableData) performance_table_statistics(opts)

Gets the statistical data tables.

Parameters:

  • opts (Hash)

Options Hash (opts):

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



461
462
463
464
 
# File 'lib/icontrol/system/statistics.rb', line 461

def performance_table_statistics(opts)
  check_params(opts,[:tables])
  super
end

- (PVAStatistics) pva_statistics(opts)

Gets the system's PVA statistics (by PVA id).

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :pva_ids (String) —

    The PVA ids for which to get statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



475
476
477
478
 
# File 'lib/icontrol/system/statistics.rb', line 475

def pva_statistics(opts)
  check_params(opts,[:pva_ids])
  super
end

- (SystemStatistics) radius_statistics

Gets the system's global RADIUS statistics. These are the roll-ups of all the individual RADIUS profiles' statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



488
489
490
 
# File 'lib/icontrol/system/statistics.rb', line 488

def radius_statistics
  super
end

- (Object) reset_all_statistics

Resets all statistics in the system, including all global statistics as well as all object-level statistics such as pool, virtual server statistics....

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



619
620
621
 
# File 'lib/icontrol/system/statistics.rb', line 619

def reset_all_statistics
  super
end

- (Object) reset_authentication_statistics

Resets the system's global authentication statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



629
630
631
 
# File 'lib/icontrol/system/statistics.rb', line 629

def reset_authentication_statistics
  super
end

- (Object) reset_client_ssl_statistics

Resets the system's global client SSL statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



639
640
641
 
# File 'lib/icontrol/system/statistics.rb', line 639

def reset_client_ssl_statistics
  super
end

- (Object) reset_diameter_statistics

Resets the system's global Diameter statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



649
650
651
 
# File 'lib/icontrol/system/statistics.rb', line 649

def reset_diameter_statistics
  super
end

- (Object) reset_dns_statistics

Resets the system's global DNS statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



659
660
661
 
# File 'lib/icontrol/system/statistics.rb', line 659

def reset_dns_statistics
  super
end

- (Object) reset_fasthttp_statistics

Resets the system's global Fast HTTP statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



669
670
671
 
# File 'lib/icontrol/system/statistics.rb', line 669

def reset_fasthttp_statistics
  super
end

- (Object) reset_fastl4_statistics

Resets the system's global FastL4 statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



679
680
681
 
# File 'lib/icontrol/system/statistics.rb', line 679

def reset_fastl4_statistics
  super
end

- (Object) reset_ftp_statistics

Resets the system's global FTP statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



689
690
691
 
# File 'lib/icontrol/system/statistics.rb', line 689

def reset_ftp_statistics
  super
end

- (Object) reset_global_statistics

Resets the system's global statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



699
700
701
 
# File 'lib/icontrol/system/statistics.rb', line 699

def reset_global_statistics
  super
end

- (Object) reset_gtm_global_statistics

Resets the GTM global statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



709
710
711
 
# File 'lib/icontrol/system/statistics.rb', line 709

def reset_gtm_global_statistics
  super
end

- (Object) reset_gtm_iquery_statistics(opts)

Resets the statistics for this iQueries.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :addresses (String) —

    The iQueries indicated by their addresses. If "addresses" list if empty, then all iQuery statistics regardless of address will be reset..

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



721
722
723
724
 
# File 'lib/icontrol/system/statistics.rb', line 721

def reset_gtm_iquery_statistics(opts)
  check_params(opts,[:addresses])
  super
end

- (Object) reset_gtm_ldns_statistics

Resets the statistics for this LDNSes.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



732
733
734
 
# File 'lib/icontrol/system/statistics.rb', line 732

def reset_gtm_ldns_statistics
  super
end

- (Object) reset_gtm_path_statistics(opts)

Resets the statistics for this paths.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :object_names (IControl::System::Statistics::GtmPathStatisticObjectID) —

    The link or DC names to reset the statistics. If "object_names" is empty, then statistics for all paths under "ldns_ips" will be reset. Note that if "ldns_ips" and "object_names" are both empty, then all path statistics will be reset.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



744
745
746
747
 
# File 'lib/icontrol/system/statistics.rb', line 744

def reset_gtm_path_statistics(opts)
  check_params(opts,[:object_names])
  super
end

- (Object) reset_http_statistics

Resets the system's global HTTP statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



755
756
757
 
# File 'lib/icontrol/system/statistics.rb', line 755

def reset_http_statistics
  super
end

- (Object) reset_icmp_statistics

Resets the system's ICMP statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



765
766
767
 
# File 'lib/icontrol/system/statistics.rb', line 765

def reset_icmp_statistics
  super
end

- (Object) reset_icmpv6_statistics

Resets the system's ICMPv6 statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



775
776
777
 
# File 'lib/icontrol/system/statistics.rb', line 775

def reset_icmpv6_statistics
  super
end

- (Object) reset_iiop_statistics

Resets the system's global IIOP statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



785
786
787
 
# File 'lib/icontrol/system/statistics.rb', line 785

def reset_iiop_statistics
  super
end

- (Object) reset_ip_statistics

Resets the system's IP statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



795
796
797
 
# File 'lib/icontrol/system/statistics.rb', line 795

def reset_ip_statistics
  super
end

- (Object) reset_ipv6_statistics

Resets the system's IPv6 statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



805
806
807
 
# File 'lib/icontrol/system/statistics.rb', line 805

def reset_ipv6_statistics
  super
end

- (Object) reset_oneconnect_statistics

Resets the system's global OneConnect statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



815
816
817
 
# File 'lib/icontrol/system/statistics.rb', line 815

def reset_oneconnect_statistics
  super
end

- (Object) reset_radius_statistics

Resets the system's global RADIUS statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



825
826
827
 
# File 'lib/icontrol/system/statistics.rb', line 825

def reset_radius_statistics
  super
end

- (Object) reset_rtsp_statistics

Resets the system's global RTSP statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



835
836
837
 
# File 'lib/icontrol/system/statistics.rb', line 835

def reset_rtsp_statistics
  super
end

- (Object) reset_sctp_statistics

Resets the system's global SCTP statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



845
846
847
 
# File 'lib/icontrol/system/statistics.rb', line 845

def reset_sctp_statistics
  super
end

- (Object) reset_server_ssl_statistics

Resets the system's global server SSL statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



855
856
857
 
# File 'lib/icontrol/system/statistics.rb', line 855

def reset_server_ssl_statistics
  super
end

- (Object) reset_stream_statistics

Resets the system's global stream statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



865
866
867
 
# File 'lib/icontrol/system/statistics.rb', line 865

def reset_stream_statistics
  super
end

- (Object) reset_tcp_statistics

Resets the system's global TCP statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



875
876
877
 
# File 'lib/icontrol/system/statistics.rb', line 875

def reset_tcp_statistics
  super
end

- (Object) reset_udp_statistics

Resets the system's global UDP statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



885
886
887
 
# File 'lib/icontrol/system/statistics.rb', line 885

def reset_udp_statistics
  super
end

- (Object) reset_virtual_compression_statistics(opts)

This method has been deprecated, as it represents internal, implementation-specific details. Resets the statistics for this virtual compression devices.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :device_names (String) —

    The names of the virtual compression devices. If devices_names list if empty, then all virtual compression statistics regardless of device will be reset.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::NotImplemented) —

    raised if the method is not supported or implemented.



897
898
899
900
 
# File 'lib/icontrol/system/statistics.rb', line 897

def reset_virtual_compression_statistics(opts)
  check_params(opts,[:device_names])
  super
end

- (Object) reset_xml_statistics

Resets the system's global XML statistics.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



908
909
910
 
# File 'lib/icontrol/system/statistics.rb', line 908

def reset_xml_statistics
  super
end

- (SystemStatistics) rtsp_statistics

Gets the system's global RTSP statistics. These are the roll-ups of all the individual RTSP profiles' statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



500
501
502
 
# File 'lib/icontrol/system/statistics.rb', line 500

def rtsp_statistics
  super
end

- (SystemStatistics) sctp_statistics

Gets the system's global SCTP statistics. These are the roll-ups of all the individual SCTP profiles' statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



512
513
514
 
# File 'lib/icontrol/system/statistics.rb', line 512

def sctp_statistics
  super
end

- (SystemStatistics) server_ssl_statistics

Gets the system's global server SSL statistics. These are the roll-ups of all the individual server SSL profiles' statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



524
525
526
 
# File 'lib/icontrol/system/statistics.rb', line 524

def server_ssl_statistics
  super
end

- (SystemStatistics) stream_statistics

Gets the system's global stream statistics. These are the roll-ups of all the individual stream profiles' statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



536
537
538
 
# File 'lib/icontrol/system/statistics.rb', line 536

def stream_statistics
  super
end

- (SystemStatistics) tcp_statistics

Gets the system's global TCP statistics. These are the roll-ups of all the individual TCP profiles' statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



548
549
550
 
# File 'lib/icontrol/system/statistics.rb', line 548

def tcp_statistics
  super
end

- (TMMStatistics) tmm_statistics(opts)

Gets the system's TMOS processing agent statistics (by TMOS processing agent id).

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :tmm_ids (String) —

    The TMOS processing agent ids for which to get statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



561
562
563
564
 
# File 'lib/icontrol/system/statistics.rb', line 561

def tmm_statistics(opts)
  check_params(opts,[:tmm_ids])
  super
end

- (SystemStatistics) udp_statistics

Gets the system's global UDP statistics. These are the roll-ups of all the individual UDP profiles' statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



574
575
576
 
# File 'lib/icontrol/system/statistics.rb', line 574

def udp_statistics
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String) 


582
583
584
 
# File 'lib/icontrol/system/statistics.rb', line 582

def version
  super
end

- (VirtualCompressionStatistics) virtual_compression_statistics(opts)

This method has been deprecated, as it represents internal, implementation-specific details. Gets the statistics for this virtual compression devices.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :device_names (String) —

    The virtual compression devices to get the statistics from.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::NotImplemented) —

    raised if the method is not supported or implemented.



595
596
597
598
 
# File 'lib/icontrol/system/statistics.rb', line 595

def virtual_compression_statistics(opts)
  check_params(opts,[:device_names])
  super
end

- (SystemStatistics) xml_statistics

Gets the system's global XML statistics. These are the roll-ups of all the individual XML profiles' statistics.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



608
609
610
 
# File 'lib/icontrol/system/statistics.rb', line 608

def xml_statistics
  super
end