System::Statistics

Introduced : BIG-IP_v9.0
The Statistics interface enables you to get information on various system statistics. This interface does not support transactions.

Methods

Method Description Introduced
get_all_gtm_iquery_statistics This method is deprecated; please use get_all_gtm_iquery_statistics_v2 in the future. Gets the statistics for all the iQueries. BIG-IP_v9.2.0
get_all_gtm_iquery_statistics_v2 Gets the statistics for all the iQueries. BIG-IP_v11.0.0
get_all_host_statistics Gets all of the system&aposs host statistics. Note that CPU usage statistics by host are available but not retrieved by this method. BIG-IP_v9.4.0
get_all_pva_statistics Gets all of the system&aposs PVA statistics. Note: The pva_id field in each PVAStatisticEntry of the PVAStatistics returned will be &apos0.0&apos. BIG-IP_v9.4.0
get_all_tmm_statistics Gets all of the system&aposs TMOS processing agent statistics. BIG-IP_v9.4.0
get_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. BIG-IP_v9.2.0
get_authentication_statistics Gets the system&aposs global authentication statistics. These are the roll-ups of all the individual authentication profiles&apos statistics. BIG-IP_v9.0
get_client_ldap_statistics Gets the system&aposs global client LDAP statistics. These are the roll-ups of all the individual client LDAP profiles&apos statistics. BIG-IP_v12.0.0
get_client_ssl_statistics Gets the system&aposs global client SSL statistics. These are the roll-ups of all the individual client SSL profiles&apos statistics. BIG-IP_v9.0
get_diameter_statistics Gets the system&aposs global Diameter statistics. These are the roll-ups of all the individual Diameter profiles&apos statistics. BIG-IP_v10.1.0
get_dns_server_statistics Gets the system&aposs global DNS server statistics. These are the roll-ups of all the individual DNS servers&apos statistics. BIG-IP_v11.5.0
get_dns_statistics Gets the system&aposs global DNS profile statistics. These are the roll-ups of all the individual DNS profiles&apos statistics. BIG-IP_v9.2.0
get_dnssec_statistics Gets the system&aposs global DNSSEC zone statistics. These are the roll-ups of all the individual DNSSEC zones&apos statistics. BIG-IP_v11.5.0
get_fasthttp_statistics Gets the system&aposs global Fast HTTP statistics. These are the roll-ups of all the individual Fast HTTP profiles&apos statistics. BIG-IP_v9.0.3
get_fastl4_statistics Gets the system&aposs global FastL4 statistics. These are the roll-ups of all the individual FastL4 profiles&apos statistics. BIG-IP_v9.0
get_fix_statistics Gets the system&aposs global FIX profile statistics. These are the roll-ups of all the individual FIX profiles&apos statistics. BIG-IP_v11.5.0
get_ftp_statistics Gets the system&aposs global FTP statistics. These are the roll-ups of all the individual FTP profiles&apos statistics. BIG-IP_v9.0
get_global_host_statistics Gets the system&aposs 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. BIG-IP_v10.0.0
get_global_pva_statistics Gets the system&aposs global PVA statistics. This gets one set of combined (“rolled up”) statistics for all PVAs. It is not to be confused with get_all_pva_statistics, which gets all individual PVA statistics, one for each PVA. BIG-IP_v11.0.0
get_global_statistics Gets the system&aposs global statistics. BIG-IP_v9.0
get_global_tmm_statistics Gets the system&aposs 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. BIG-IP_v10.0.0
get_gtm_global_statistics Gets the GTM global statistics. These are the roll-ups of all the individual wide IPs&apos and iQueries statistics. BIG-IP_v9.2.0
get_gtm_iquery_statistics This method is deprecated; please use get_gtm_iquery_statistics_v2 in the future. Gets the statistics for the specified iQueries. BIG-IP_v9.2.0
get_gtm_iquery_statistics_v2 Gets the statistics for the specified iQueries. BIG-IP_v11.0.0
get_gtm_ldns_statistics Gets the statistics for the specified LDNSes. BIG-IP_v9.2.0
get_gtm_memory_usage_statistics Gets the memory usage statistics used by GTM. BIG-IP_v9.2.0
get_gtm_path_statistics Gets the statistics for the specified paths (LDNSes and links). BIG-IP_v9.2.0
get_host_statistics Gets the system&aposs host statistics (by host id). Note that CPU usage statistics by host are available but not retrieved by this method. BIG-IP_v9.4.0
get_http_statistics Gets the system&aposs global HTTP statistics. These are the roll-ups of all the individual HTTP profiles&apos statistics. BIG-IP_v9.0
get_httpcompression_statistics Gets the system&aposs global HTTP Compression statistics. These are the roll-ups of all the individual HTTP Compression profiles&apos statistics. BIG-IP_v11.0.0
get_icmp_statistics Gets the system&aposs ICMP statistics. BIG-IP_v9.0
get_icmpv6_statistics Gets the system&aposs ICMPv6 statistics. BIG-IP_v9.0
get_iiop_statistics *IMPORTANT* This method has been deprecated immediately. Gets the system&aposs global IIOP statistics. These are the roll-ups of all the individual IIOP profiles&apos statistics. BIG-IP_v9.2.0
get_ip_intelligence_statistics *IMPORTANT* This method has been deprecated immediately. As of v11.5.0, attempting to perform this method will return a not-implemented exception. Gets the system&aposs global IP Intelligence statistics. These are the roll-ups of all the individual IP Intelligence profiles&apos statistics. BIG-IP_v11.4.0
get_ip_statistics Gets the system&aposs IP statistics. BIG-IP_v9.0
get_ipsecalg_statistics Gets the system&aposs global IPsecALG statistics. These are the roll-ups of all the individual IPsecALG profiles&apos statistics. BIG-IP_v9.0
get_ipv6_statistics Gets the system&aposs IPv6 statistics. BIG-IP_v9.0
get_list_of_hosts Gets a list of all hosts. BIG-IP_v9.4.0
get_list_of_pvas This method is deprecated. The PVA ID is no longer populated for PVA statistics. Calling this method will return a list of strings containing &apos0.0&apos. Gets a list of all PVAs. BIG-IP_v9.4.0
get_list_of_tmms Gets a list of all TMOS processing agents. BIG-IP_v9.4.0
get_lsn_pool_statistics Gets the system&aposs global LSN Pool statistics. These are the roll-ups of all the individual LSN Pools&apos statistics. BIG-IP_v11.4.0
get_oneconnect_statistics Gets the system&aposs global OneConnect statistics. These are the roll-ups of all the individual OneConnect profiles&apos statistics. BIG-IP_v9.0
get_pem_action_statistics Gets the system&aposs Policy Enforcement Magager (PEM) action statistics. Action means the steps to take for the policy, e.g. drop flows, clone flows etc. BIG-IP_v11.4.0
get_pem_gx_statistics Gets the system&aposs Policy Enforcement Magager (PEM) Gx statistics. The Gx protocol is used for provisioning and removal of Policy and Charging Control (PCC) rules from the Policy Control and Charging Rules Function (PCRF) to the Policy Control and Enforcement Function (PCEF) and the transmission of traffic plane events from the PCEF to PCRF. In this case, the system will be acting as PCEF. BIG-IP_v11.4.0
get_pem_gy_statistics Gets the system&aposs Policy Enforcement Manager (PEM) Gy statistics. This table contains counters and peak values for state of Gy sessions and per different types of Gy messages. BIG-IP_v11.5.0
get_pem_hsl_statistics Gets the system&aposs Policy Enforcement Manager (PEM) High Speed Logging statistics. This table includes conters related to sending different types of PEM reporting records sent using HSL infrastructure. BIG-IP_v11.5.0
get_pem_radius_statistics Gets the system&aposs Policy Enforcement Manager (PEM) Radius statistics. This table includes counters related to different type of Radius messages intercepted by the system. BIG-IP_v11.5.0
get_pem_session_statistics This method has been deprecated; please use get_pem_subscriber_statistics in the future. Gets the system&aposs run-time Subscriber Policy Manager (SPM) session statistics. A subscriber session is the period of time from when a subscriber logs into the network (authenticated) and logs out, or when the session is terminated by other means. The session is identified by subscriber IP address. BIG-IP_v11.4.0
get_pem_subscriber_statistics Gets the system&aposs Policy Enforcement Manager (PEM) Subscriber statistics. This table shows various metrics related to the subscribers configured in PEM including peak values of counters measured from the resetting the statistics. BIG-IP_v11.5.0
get_performance_graph_csv_statistics Gets the statistical data in CSV format for the specified graphs/tables. BIG-IP_v9.2.0
get_performance_graph_list Gets the list of available statistical graphs as seen in the GUI&aposs Performance Graph. BIG-IP_v9.2.0
get_performance_table_list Gets the list of available statistical tables. BIG-IP_v9.2.0
get_performance_table_statistics Gets the statistical data tables. BIG-IP_v9.2.0
get_pptp_statistics Gets the system&aposs global PPTP profile statistics. These are the roll-ups of all the individual PPTP profiles&apos statistics. BIG-IP_v11.5.0
get_pva_statistics *IMPORTANT* This method is deprecated immediately. Attempting to perform this operation will return a not-implemented exception. Gets the system&aposs PVA statistics (by PVA id). BIG-IP_v9.4.0
get_radius_statistics Gets the system&aposs global RADIUS statistics. These are the roll-ups of all the individual RADIUS profiles&apos statistics. BIG-IP_v10.1.0
get_rtsp_statistics Gets the system&aposs global RTSP statistics. These are the roll-ups of all the individual RTSP profiles&apos statistics. BIG-IP_v9.2.0
get_sctp_statistics Gets the system&aposs global SCTP statistics. These are the roll-ups of all the individual SCTP profiles&apos statistics. BIG-IP_v9.2.1
get_server_ldap_statistics Gets the system&aposs global server LDAP statistics. These are the roll-ups of all the individual server LDAP profiles&apos statistics. BIG-IP_v12.0.0
get_server_ssl_statistics Gets the system&aposs global server SSL statistics. These are the roll-ups of all the individual server SSL profiles&apos statistics. BIG-IP_v9.0
get_sip_statistics Gets the system&aposs global SIP profile statistics. These are the roll-ups of all the individual SIP profiles&apos statistics. BIG-IP_v11.5.0
get_siprouter_statistics Gets the system&aposs global SIP router profile statistics. These are the roll-ups of all the individual SIP router profiles&apos statistics. BIG-IP_v11.6.0
get_sipsession_statistics Gets the system&aposs global SIP session profile statistics. These are the roll-ups of all the individual SIP session profiles&apos statistics. BIG-IP_v11.6.0
get_spdy_statistics *IMPORTANT* Function &aposget_spdy_statistics&apos has been deprecated immediately. As of BIG-IP_v13.0.0, attempting to perform the function will return a not-implemented exception. Gets the system&aposs global SPDY statistics. These are the roll-ups of all the individual SPDY profiles&apos statistics. BIG-IP_v11.4.0
get_stream_statistics Gets the system&aposs global stream statistics. These are the roll-ups of all the individual stream profiles&apos statistics. BIG-IP_v9.0
get_tcp_statistics Gets the system&aposs global TCP statistics. These are the roll-ups of all the individual TCP profiles&apos statistics. BIG-IP_v9.0
get_tftp_statistics Gets the system&aposs global TFTP statistics. These are the roll-ups of all the individual TFTP profiles&apos statistics. BIG-IP_v9.0
get_tmm_statistics Gets the system&aposs TMOS processing agent statistics (by TMOS processing agent id). BIG-IP_v9.4.0
get_udp_statistics Gets the system&aposs global UDP statistics. These are the roll-ups of all the individual UDP profiles&apos statistics. BIG-IP_v9.0
get_version Gets the version information for this interface. BIG-IP_v9.0
get_virtual_compression_statistics This method has been deprecated, as it represents internal, implementation-specific details. Gets the statistics for the specified virtual compression devices. BIG-IP_v9.2.0
get_webacceleration_statistics Gets the system&aposs global Web Acceleration statistics. These are the roll-ups of all the individual Web Acceleration profiles&apos statistics. BIG-IP_v11.0.0
get_xml_statistics Gets the system&aposs global XML statistics. These are the roll-ups of all the individual XML profiles&apos statistics. BIG-IP_v9.0.3
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…. BIG-IP_v9.0
reset_authentication_statistics Resets the system&aposs global authentication statistics. BIG-IP_v9.0
reset_client_ldap_statistics Resets the system&aposs global client LDAP statistics. BIG-IP_v12.0.0
reset_client_ssl_statistics Resets the system&aposs global client SSL statistics. BIG-IP_v9.0
reset_diameter_statistics Resets the system&aposs global Diameter statistics. BIG-IP_v10.1.0
reset_dns_server_statistics Resets the system&aposs global DNS server statistics. BIG-IP_v11.5.0
reset_dns_statistics Resets the system&aposs global DNS statistics. BIG-IP_v9.2.0
reset_dnssec_statistics Resets the system&aposs global DNSSEC zone statistics. BIG-IP_v11.5.0
reset_fasthttp_statistics Resets the system&aposs global Fast HTTP statistics. BIG-IP_v9.0.3
reset_fastl4_statistics Resets the system&aposs global FastL4 statistics. BIG-IP_v9.0
reset_fix_statistics Resets the system&aposs global FIX profile statistics. BIG-IP_v11.5.0
reset_ftp_statistics Resets the system&aposs global FTP statistics. BIG-IP_v9.0
reset_global_statistics Resets the system&aposs global statistics. BIG-IP_v9.0
reset_gtm_global_statistics Resets the GTM global statistics. BIG-IP_v9.2.0
reset_gtm_iquery_statistics Resets the statistics for the specified iQueries. BIG-IP_v9.2.0
reset_gtm_ldns_statistics Resets the statistics for the specified LDNSes. BIG-IP_v9.2.0
reset_gtm_path_statistics Resets the statistics for the specified paths. BIG-IP_v9.2.0
reset_http_statistics Resets the system&aposs global HTTP statistics. BIG-IP_v9.0
reset_httpcompression_statistics Resets the system&aposs global HTTP Compression statistics. BIG-IP_v11.0.0
reset_icmp_statistics Resets the system&aposs ICMP statistics. BIG-IP_v9.0
reset_icmpv6_statistics Resets the system&aposs ICMPv6 statistics. BIG-IP_v9.0
reset_iiop_statistics *IMPORTANT* This method has been deprecated immediately. Resets the system&aposs global IIOP statistics. BIG-IP_v9.2.0
reset_ip_intelligence_statistics *IMPORTANT* This method has been deprecated immediately. As of v11.5.0, attempting to perform this method will return a not-implemented exception. Resets the system&aposs global IP Intelligence statistics. BIG-IP_v11.4.0
reset_ip_statistics Resets the system&aposs IP statistics. BIG-IP_v9.0
reset_ipsecalg_statistics Resets the system&aposs global IPsecALG statistics. BIG-IP_v9.0
reset_ipv6_statistics Resets the system&aposs IPv6 statistics. BIG-IP_v9.0
reset_lsn_pool_statistics Resets the system&aposs global LSN Pool statistics. BIG-IP_v11.4.0
reset_oneconnect_statistics Resets the system&aposs global OneConnect statistics. BIG-IP_v9.0
reset_pem_action_statistics Resets the system&aposs Policy Enforcement Magager (PEM) action statistics. BIG-IP_v11.4.0
reset_pem_gx_statistics Resets the system&aposs Policy Enforcement Magager (PEM) Gx statistics. BIG-IP_v11.4.0
reset_pem_gy_statistics Resets the system&aposs PEM Gy statistics. BIG-IP_v11.5.0
reset_pem_hsl_statistics Resets the system&aposs PEM High Speed Logging statistics. BIG-IP_v11.5.0
reset_pem_radius_statistics Resets the system&aposs PEM Radius statistics. BIG-IP_v11.5.0
reset_pem_session_statistics This method has been deprecated; please use reset_pem_subscriber_statistics in the future. Resets the system&aposs run-time Subscriber Policy Manager (SPM) session statistics. BIG-IP_v11.4.0
reset_pem_subscriber_statistics Resets the system&aposs PEM Subscriber statistics. BIG-IP_v11.5.0
reset_pptp_statistics Resets the system&aposs global PPTP profile statistics. BIG-IP_v11.5.0
reset_radius_statistics Resets the system&aposs global RADIUS statistics. BIG-IP_v10.1.0
reset_rtsp_statistics Resets the system&aposs global RTSP statistics. BIG-IP_v9.2.0
reset_sctp_statistics Resets the system&aposs global SCTP statistics. BIG-IP_v9.2.1
reset_server_ldap_statistics Resets the system&aposs global server LDAP statistics. BIG-IP_v12.0.0
reset_server_ssl_statistics Resets the system&aposs global server SSL statistics. BIG-IP_v9.0
reset_sip_statistics Resets the system&aposs global SIP profile statistics. BIG-IP_v11.5.0
reset_siprouter_statistics Resets the system&aposs global SIP router profile statistics. BIG-IP_v11.6.0
reset_sipsession_statistics Resets the system&aposs global SIP session profile statistics. BIG-IP_v11.6.0
reset_spdy_statistics *IMPORTANT* Function &aposreset_spdy_statistics&apos has been deprecated immediately. As of BIG-IP_v13.0.0, attempting to perform the function will return a not-implemented exception. Resets the system&aposs global SPDY statistics. BIG-IP_v11.4.0
reset_stream_statistics Resets the system&aposs global stream statistics. BIG-IP_v9.0
reset_tcp_statistics Resets the system&aposs global TCP statistics. BIG-IP_v9.0
reset_tftp_statistics Resets the system&aposs global TFTP statistics. BIG-IP_v9.0
reset_udp_statistics Resets the system&aposs global UDP statistics. BIG-IP_v9.0
reset_virtual_compression_statistics This method has been deprecated, as it represents internal, implementation-specific details. Resets the statistics for the specified virtual compression devices. BIG-IP_v9.2.0
reset_webacceleration_statistics Resets the system&aposs global Web Acceleration statistics. BIG-IP_v11.0.0
reset_xml_statistics Resets the system&aposs global XML statistics. BIG-IP_v9.0.3

Structures

Structure

Description

GlobalHostStatistics

A struct that describes global host statistics. This is one set of combined (“rolled up”) statistics for all hosts.

GlobalPVAStatistics

A struct that describes global PVA statistics. This is one set of combined (“rolled up”) statistics for all PVAs.

GlobalTMMStatistics

A struct that describes global TMOS processing agent statistics. This is one set of combined (“rolled up”) statistics for all TMOS processing agents.

GtmIQueryStatisticEntry

This data type is deprecated; please use GtmIQueryStatisticEntry_v2 for future designs. A struct that describes statistics for a particular iQuery.

GtmIQueryStatisticEntry_v2

A struct that describes statistics for a particular iQuery.

GtmIQueryStatistics

This data type is deprecated; please use GtmIQueryStatistics for future designs. A struct that describes iQuery statistics and timestamp.

GtmIQueryStatistics_v2

A struct that describes iQuery statistics and timestamp.

GtmLdnsStatisticEntry

A struct that describes statistics for a particular LDNS.

GtmLdnsStatistics

A struct that describes LDNS statistics and timestamp.

GtmPathStatisticEntry

A struct that describes statistics for a particular path.

GtmPathStatisticObjectID

A struct that describes statistics for a particular path.

GtmPathStatistics

A struct that describes path statistics and timestamp.

HostStatisticEntry

A struct that describes statistics for a particular host.

HostStatistics

A struct that describes host statistics and timestamp.

PVAStatisticEntry

A struct that describes statistics for a particular PVA.

PVAStatistics

A struct that describes PVA statistics and timestamp.

PerformanceGraph

A struct that describes the contents of a performance graph as seen in the Performance Graph in the GUI.

PerformanceGraphDataCSV

A struct that describes details of a statistical graph or table in a file, currently in CSV format. During queries, if the user specifies a start_time, end_time, and interval that does not exactly match the corresponding value used within the database, the database will attempt to use to closest time or interval as requested. The actual values used will be returned to the user in this structure.

PerformanceStatisticQuery

A struct that describes a query for details of a statistical graph or table. If the user specifies a start_time, end_time, and interval that does not exactly match the corresponding value used within the database, the database will attempt to use to closest time or interval as requested. The actual values used will be returned to the user on output. For querying purposes, the start_time can be specified as: 0: in which case by default, it means 24 hours ago. N: where N represents the number of seconds since Jan 1, 1970. -N: where -N represents the number of seconds before now, for example: -3600 means 3600 seconds ago, or now - 3600 seconds For querying purposes, the end_time can be specified as: 0: in which case by default, it means now. N: where N represents the number of seconds since Jan 1, 1970. -N: where -N represents the number of seconds before now, for example: -3600 means 3600 seconds ago, or now - 3600 seconds

PerformanceTable

A struct that describes the contents of a performance statistic table.

PerformanceTableData

A struct that describes details of a statistical table. During queries, if the user specifies a start_time, end_time, and interval that does not exactly match the corresponding value used within the database, the database will attempt to use to closest time or interval as requested. The actual values used will be returned to the user in this structure.

SystemStatistics

A struct that describes some types of system statistics and timestamp.

TMMStatisticEntry

A struct that describes statistics for a particular TMOS processing agent.

TMMStatistics

A struct that describes TMOS processing agent statistics and timestamp.

VirtualCompressionStatisticEntry

This structure has been deprecated, as it represents internal, implementation-specific details. A struct that describes statistics for a particular virtual compression device.

VirtualCompressionStatistics

This structure has been deprecated, as it represents internal, implementation-specific details. A struct that describes virtual compression statistics and timestamp.


Enumerations

Enumeration Description
GtmIQueryState An enumeration of compression methods.
GtmPathStatisticObjectType An enumeration of path statistic&aposs object types.

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
GtmIQueryStatisticEntrySequence GtmIQueryStatisticEntry [] This data type is deprecated; please use GtmIQueryStatisticEntrySequence_v2 for future designs. A sequence of iQuery statistics.
GtmIQueryStatisticEntrySequence_v2 GtmIQueryStatisticEntry_v2 [] A sequence of iQuery statistics.
GtmLdnsStatisticEntrySequence GtmLdnsStatisticEntry [] A sequence of LDNS statistics.
GtmPathStatisticEntrySequence GtmPathStatisticEntry [] A sequence of path statistics.
GtmPathStatisticObjectIDSequence GtmPathStatisticObjectID [] A sequence of path statistics.
HostStatisticEntrySequence HostStatisticEntry [] A sequence of host statistics.
PVAStatisticEntrySequence PVAStatisticEntry [] A sequence of PVA statistics.
PerformanceGraphDataCSVSequence PerformanceGraphDataCSV [] A sequence of statistical data output.
PerformanceGraphSequence PerformanceGraph [] A sequence of statistical graphs.
PerformanceStatisticQuerySequence PerformanceStatisticQuery [] A sequence of statistical queries.
PerformanceTableDataSequence PerformanceTableData [] A sequence of statistical data output.
PerformanceTableSequence PerformanceTable [] A sequence of statistical tables.
TMMStatisticEntrySequence TMMStatisticEntry [] A sequence of TMOS processing agent statistics.
VirtualCompressionStatisticEntrySequence VirtualCompressionStatisticEntry [] This type has been deprecated, as it represents internal, implementation-specific details. A sequence of virtual compression statistics.

See Also

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code


The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.