LocalLB::ProfileTCPAnalytics

Introduced : BIG-IP_v12.1.0
The ProfileTCPAnalytics interface enables you to manipulate a local load balancer&aposs TCP Analytics profile. When this profile is attached to a virtual, it allows collection of TCP performance statistics on a virtual that has a FastL4 or TCP profile if AVR is enabled.

Methods

Method Description Introduced
create Creates the specified TCP Analytics profile. BIG-IP_v12.1.0
delete_all_profiles Deletes all TCP Analytics profiles. BIG-IP_v12.1.0
delete_profile Deletes the specified TCP Analytics profile. BIG-IP_v12.1.0
get_collect_by_city_state Gets the state indicating if AVR stores TCP stats by city. BIG-IP_v12.1.0
get_collect_by_continent_state Gets the state indicating if AVR stores TCP stats by continent. BIG-IP_v12.1.0
get_collect_by_country_state Gets the state indicating if AVR stores TCP stats by country. BIG-IP_v12.1.0
get_collect_by_nexthop_state Gets the state indicating if AVR stores TCP stats by nexthop ethernet address. BIG-IP_v12.1.0
get_collect_by_post_code_state Gets the state indicating if AVR stores TCP stats by postcode. BIG-IP_v12.1.0
get_collect_by_region_state Gets the state indicating if AVR stores TCP stats by region. BIG-IP_v12.1.0
get_collect_by_remote_host_ip_state Gets the state indicating if AVR stores TCP stats by remote host IP address. BIG-IP_v12.1.0
get_collect_by_remote_host_subnet_state Gets the state indicating if AVR stores TCP stats by remote host subnet. BIG-IP_v12.1.0
get_collected_by_client_side_state Gets the state indicating if client side TCP reports stats to AVR even if there is no TCP::analytics iRule. BIG-IP_v12.1.0
get_collected_by_server_side_state Gets the state indicating if server side TCP reports stats to AVR even if there is no TCP::analytics iRule. BIG-IP_v12.1.0
get_collected_stats_external_logging_state Gets the state indicating if AVR logs TCP stats on an external device defined by external_logging_publisher. BIG-IP_v12.1.0
get_collected_stats_internal_logging_state Gets the state indicating if AVR logs TCP stats on the local device. BIG-IP_v12.1.0
get_default_profile Gets the names of the default profiles from which the specified profiles will derive default values for its attributes. BIG-IP_v12.1.0
get_description Gets the descriptions for a set of TCP Analytics profiles. BIG-IP_v12.1.0
get_list Gets a list of all TCP Analytics profiles. BIG-IP_v12.1.0
get_log_publisher Gets the log publishers for a set of TCP Analytics profiles. BIG-IP_v12.1.0
get_version Gets the version information for this interface. BIG-IP_v12.1.0
is_base_profile Determines whether the specified TCP Analytics profiles are base profiles. A base profile sits at the base of the profile&aposs inheritance tree, supplying the defaults for every profile derived from it. (See also is_system_profile). BIG-IP_v12.1.0
is_system_profile Determines whether the specified TCP Analytics profiles are system profiles. A system profile is a profile pre-configured on the system, ready for use. Non-system profiles are profiles created or modified by a user. Note that if a system profile is modified, it is no longer considered a system profile. (See also is_base_profile). BIG-IP_v12.1.0
set_collect_by_city_state Sets the state indicating if AVR stores TCP stats by city. The default is disabled. BIG-IP_v12.1.0
set_collect_by_continent_state Sets the state indicating if AVR stores TCP stats by continent. The default is enabled. BIG-IP_v12.1.0
set_collect_by_country_state Sets the state indicating if AVR stores TCP stats by country. The default is enabled. BIG-IP_v12.1.0
set_collect_by_nexthop_state Sets the state indicating if AVR stores TCP stats by nexthop ethernet address. The default is disabled. BIG-IP_v12.1.0
set_collect_by_post_code_state Sets the state indicating if AVR stores TCP stats by postcode. The default is disabled. BIG-IP_v12.1.0
set_collect_by_region_state Sets the state indicating if AVR stores TCP stats by region. The default is disabled. BIG-IP_v12.1.0
set_collect_by_remote_host_ip_state Sets the state indicating if AVR stores TCP stats by remote host IP address. The default is disabled. BIG-IP_v12.1.0
set_collect_by_remote_host_subnet_state Sets the state indicating if AVR stores TCP stats by remote host subnet. The default is enabled. BIG-IP_v12.1.0
set_collected_by_client_side_state Sets the state indicating if client side TCP reports stats to AVR even if there is no TCP::analytics iRule. The default is enabled. BIG-IP_v12.1.0
set_collected_by_server_side_state Sets the state indicating if server side TCP reports stats to AVR even if there is no TCP::analytics iRule. The default is disabled. BIG-IP_v12.1.0
set_collected_stats_external_logging_state Sets the state indicating if AVR logs TCP stats on an external device defined by external_logging_publisher. The default is disabled. BIG-IP_v12.1.0
set_collected_stats_internal_logging_state Sets the state indicating if AVR logs TCP stats on the local device. The default is enabled. BIG-IP_v12.1.0
set_default_profile Sets the names of the default profiles from which the specified profiles will derive default values for its attributes. BIG-IP_v12.1.0
set_description Sets the description for a set of TCP Analytics profiles. This is an arbitrary field which can be used for any purpose. BIG-IP_v12.1.0
set_log_publisher Sets the log publishers for a set of TCP Analytics profiles. A log publisher is a set of log destinations for high-speed logging of formatted log messages. See Log::Publisher for more details. BIG-IP_v12.1.0

Structures

Structure Description

Enumerations

Enumeration Description

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description

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.