LocalLB::ProfileFastL4

Introduced : BIG-IP_v9.0
The ProfileFastL4 interface enables you to manipulate a local load balancer&aposs L4 profile.

Methods

Method Description Introduced
create Creates the specified profiles. BIG-IP_v9.0
delete_all_profiles Deletes all profiles. BIG-IP_v9.0
delete_profile Deletes the specified profiles. BIG-IP_v9.0
get_all_statistics Gets the statistics for all the profiles. BIG-IP_v9.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_v9.0
get_description Gets the descriptions for a set of FastL4 profiles. BIG-IP_v11.0.0
get_hardware_acceleration_mode Gets the preferred hardware acceleration modes for the specified profiles. BIG-IP_v9.0
get_hardware_syn_cookie_state Gets the state to enable/disable support for hardware SYN cookie. BIG-IP_v9.4.0
get_idle_timeout Gets the idle timeout for the specified profiles. The number of seconds without traffic before a connection is eligible for deletion. BIG-IP_v9.0
get_ip_fragment_reassemble_state Gets the IP fragment reassembly states for the specified profiles. If true, reassemble the IP fragments. BIG-IP_v9.0
get_ip_tos_to_client Gets the IP type of service set in packets sent to the clients. BIG-IP_v9.0
get_ip_tos_to_server Gets the IP type of service set in packets sent to the servers. BIG-IP_v9.0
get_keep_alive_interval Gets the keep-alive probe interval for a set of FastL4 profiles. BIG-IP_v10.1.0
get_late_binding_client_timeout Gets the late binding client timeout for the specified profiles. BIG-IP_v11.6.0
get_late_binding_explicit_flow_migration_state Gets late binding explicit flow migration states for a set of FastL4 profiles. BIG-IP_v11.6.0
get_late_binding_state Gets late binding states for a set of FastL4 profiles. BIG-IP_v11.6.0
get_late_binding_timeout_recovery_mode Gets the late binding timeout recovery modes for the specified profiles. BIG-IP_v11.6.0
get_link_qos_to_client Gets the link quality of service set in packets sent to the clients. BIG-IP_v9.0
get_link_qos_to_server Gets the link quality of service set in packets sent to the servers. BIG-IP_v9.0
get_list Gets a list of all profiles. BIG-IP_v9.0
get_loose_close_state Gets the state to aggressively close out a connection by allowing TMM to switch the idle_timeout to tcp_close_timeout once the first FIN packet has been seen. BIG-IP_v9.0.3
get_loose_initiation_state Gets the state to allow any TCP packet to initiate a connection (rather than requiring a SYN). BIG-IP_v9.0.3
get_mss_override Gets the MSS override values for the specified profiles. If non-zero and less than the default value, this value overrides the maximum segment size. BIG-IP_v9.0
get_packet_df_mode Gets the IP header DF bit modes for the specified FastL4 profiles. BIG-IP_v13.0.0
get_packet_ttl_mode Gets the IP header TTL value modes for the specified FastL4 profiles. BIG-IP_v13.0.0
get_packet_ttl_v4 Gets the IPv4 header TTL value for the specified FastL4 profiles. BIG-IP_v13.0.0
get_packet_ttl_v6 Gets the IP header TTL value for the specified FastL4 profiles. BIG-IP_v13.0.0
get_pva_offload_state Gets the PVA offload states for a set of FastL4 profiles. BIG-IP_v11.2.0
get_reset_on_timeout_state Gets the reset on timeout states for the specified profiles. If true and a TCP connection exceeds its idle timeout, send a reset in addition to deleting the connection. BIG-IP_v9.0
get_rtt_from_client_state Gets the state to use TCP timestamp options to measure the round trip time to the client. BIG-IP_v9.0
get_rtt_from_server_state Gets the state to use TCP timestamp options to measure the round trip time to the server. BIG-IP_v9.0
get_software_syn_cookie_state Gets the state to enable/disable support for software SYN cookie. BIG-IP_v9.4.0
get_statistics Gets the statistics for the specified profiles. BIG-IP_v9.0
get_statistics_by_virtual Gets the statistics for the specified profiles, by virtual server. BIG-IP_v11.0.0
get_tcp_close_timeout Gets the TCP close timeout for the specified profiles. Only used when “loose_initiation” or “loose_close” is enabled. This is used to rapidly close out a loosely initiated connection after the first FIN packet has been seen (either client or server side). BIG-IP_v9.0.3
get_tcp_generate_isn_state Gets the options to generate our own sequence numbers on all SYNs. BIG-IP_v9.0
get_tcp_handshake_timeout Gets the TCP handshake timeout for the specified profiles. The number of seconds without traffic before a connection in the SYN received state is eligible for deletion. BIG-IP_v9.0
get_tcp_strip_sackok_state Gets the options to block TCP SackOK option from passing to server on an initiating SYN. BIG-IP_v9.0
get_tcp_timestamp_mode Gets the TCP timestamp options for the specified profiles. BIG-IP_v9.0
get_tcp_window_scale_mode Gets the TCP window scale options for the specified profiles. BIG-IP_v9.0
get_version Gets the version information for this interface. BIG-IP_v9.0
is_base_profile Determines whether the specified FastL4 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_v9.0
is_system_profile Determines whether the specified FastL4 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_v11.0.0
reset_statistics Resets the statistics for the specified profiles. BIG-IP_v9.0
reset_statistics_by_virtual Resets the statistics for the specified profiles, for specified virtual servers. BIG-IP_v11.0.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_v9.0
set_description Sets the description for a set of FastL4 profiles. This is an arbitrary field which can be used for any purpose. BIG-IP_v11.0.0
set_hardware_acceleration_mode Sets the preferred hardware acceleration modes for the specified profiles. BIG-IP_v9.0
set_hardware_syn_cookie_state Sets the state to enable/disable support for hardware SYN cookie. BIG-IP_v9.4.0
set_idle_timeout Sets the idle timeout for the specified profiles. The number of seconds without traffic before a connection is eligible for deletion. BIG-IP_v9.0
set_ip_fragment_reassemble_state Sets the IP fragment reassembly states for the specified profiles. If true, reassemble the IP fragments. BIG-IP_v9.0
set_ip_tos_to_client Sets the IP type of service set in packets sent to the clients. BIG-IP_v9.0
set_ip_tos_to_server Sets the IP type of service set in packets sent to the servers. BIG-IP_v9.0
set_keep_alive_interval Sets the keep-alive probe interval for a set of FastL4 profiles. This interval is the elapsed time between sending data over an idle TCP connection to keep the connection open and to determine whether the connection is still valid. If zero, the keep-alive probe is disabled. BIG-IP_v10.1.0
set_late_binding_client_timeout Sets the late binding client timeout for the specified profiles. The default is 30 seconds. The late binding client timeout is the number of seconds allowed for a client to transmit enough data to select a server when late binding is enabled. If this timeout expires, the timeout recovery mode will dictate whether to drop the connections or fallback to the normal FastL4 load-balancing method to pick a server. The default timeout recovery action is to disconnect. BIG-IP_v11.6.0
set_late_binding_explicit_flow_migration_state Enables or disables late binding explicit flow migration for a set of FastL4 profiles. It is disabled by default. The late binding explicit flow migration state indicates whether connections are automatically migrated into the hardware (disabled) or they must be explicitly migrated to hardware by the iRule command BIGTCP::release_flow (enabled). Having this enabled will allow specifying iRules that will analyze Layer 7 data, select a back-end server, and then push the client and server-side flows down to the ePVA for low latency processing at Layer 4. Notice that none of this is possible at Layer 4. BIG-IP_v11.6.0
set_late_binding_state Enables or disables late binding for a set of FastL4 profiles. It is disabled by default. Late binding allows flows to start in L7 performing pool member selection based on tags and FIX messages and then transition to FastL4 in the ePVA to manage all subsequent trading traffic. You need a FIX profile in the Performace FastL4 Virtual Server configuration. Layer 7 to Layer 4 flow migration permits, with constraints, hudfilters and iRules to analyze Layer 7 data, select a back-end server, and then push the client and server-side flows down to the ePVA for low latency processing at Layer 4. The client side connection is fully established, and application data is processed, before a server-side connection is established. An iRule uses the application data to select the back-end server to provide a late binding between the client connection and a server connection. This provides application layer intelligence during server load balancing followed by extremely low latency, hardware assisted, packet fowarding via the ePVA. BIG-IP_v11.6.0
set_late_binding_timeout_recovery_mode Sets the late binding timeout recovery modes for the specified profiles. The default is to disconnect the connection. The late binding timeout recovery mode indicates the action to take when late binding timeout occurs on a connection. This would be disconnect if only the L7 iRule actions are acceptable to pick a server or fallback if the normal FastL4 load-balancing methods are acceptable to pick a server. BIG-IP_v11.6.0
set_link_qos_to_client Sets the link quality of service set in packets sent to the clients. BIG-IP_v9.0
set_link_qos_to_server Sets the link quality of service set in packets sent to the servers. BIG-IP_v9.0
set_loose_close_state Sets the state to aggressively close out a connection by allowing TMM to switch the idle_timeout to tcp_close_timeout once the first FIN packet has been seen. BIG-IP_v9.0.3
set_loose_initiation_state Sets the state to allow any TCP packet to initiate a connection (rather than requiring a SYN). BIG-IP_v9.0.3
set_mss_override Sets the MSS override values for the specified profiles. If non-zero and less than the default value, this value overrides the maximum segment size. BIG-IP_v9.0
set_packet_df_mode Sets the IP header DF bit modes for the specified FastL4 profiles. The DF (Don&apost Fragment) bit in the IP header of a packet indicates the IP layer implementation to not fragment the outgoing IP packets even if the packet length exceeds the MTU (Maximum Tranfer Unit) of the outgoing interface. This method allows you to set various modes that control the value of DF bit in the IP header of outgoing packets. These modes are to always set, always clear, carry over from the incoming packet&aposs DF bit value or to set the DF bit only if Path MTU is enabled. BIG-IP_v13.0.0
set_packet_ttl_mode Sets the IP header TTL value modes for the specified FastL4 profiles. The TTL (Time To Live) field in an IPv4 header represents the number of remaining hops before the packet will be discarded by a receiving IP layer. The field &aposhop limit&apos in IPv6 implements the same functionality as TTL. This method works for both IPv4 and IPv6 traffic. The different modes for outgoing TTL field value are to set it to a constant value or to decrement/retain from the incoming TTL value. BIG-IP_v13.0.0
set_packet_ttl_v4 Sets the IPv4 header TTL value for the specified FastL4 profiles. The TTL (Time To Live) field in an IPv4 header represents the number of remaining hops before the packet will be discarded by a receiving IP layer. BIG-IP_v13.0.0
set_packet_ttl_v6 Sets the IPv6 header TTL value for the specified FastL4 profiles. The TTL (Time To Live) field in an IP header represents the number of remaining hops before the packet will be discarded by a receiving IP layer. The TTL field is known as &aposhop limit&apos in IPv6. BIG-IP_v13.0.0
set_pva_offload_state Sets the PVA offload states for a set of FastL4 profiles. The PVA offload state is the TCP state at with the ePVA performs hardware offload. BIG-IP_v11.2.0
set_reset_on_timeout_state Sets the reset on timeout states for the specified profiles. If true and a TCP connection exceeds its idle timeout, send a reset in addition to deleting the connection. BIG-IP_v9.0
set_rtt_from_client_state Sets the state to use TCP timestamp options to measure the round trip time to the client. BIG-IP_v9.0
set_rtt_from_server_state Sets the state to use TCP timestamp options to measure the round trip time to the server. BIG-IP_v9.0
set_software_syn_cookie_state Sets the state to enable/disable support for software SYN cookie. BIG-IP_v9.4.0
set_tcp_close_timeout Sets the TCP close timeout for the specified profiles. Only used when “loose_initiation” or “loose_close” is enabled. This is used to rapidly close out a loosely initiated connection after the first FIN packet has been seen (either client or server side). BIG-IP_v9.0.3
set_tcp_generate_isn_state Sets the options to generate our own sequence numbers on all SYNs. BIG-IP_v9.0
set_tcp_handshake_timeout Sets the TCP handshake timeout for the specified profiles. The number of seconds without traffic before a connection in the SYN received state is eligible for deletion. BIG-IP_v9.0
set_tcp_strip_sackok_state Sets the options to block TCP SackOK option from passing to server on an initiating SYN. BIG-IP_v9.0
set_tcp_timestamp_mode Sets the TCP timestamp options for the specified profiles. BIG-IP_v9.0
set_tcp_window_scale_mode Sets the TCP window scale options for the specified profiles. BIG-IP_v9.0

Structures

Structure

Description

ProfileFastL4StatisticEntry

A struct that describes statistics for a particular profile.

ProfileFastL4Statistics

A struct that describes profile statistics and timestamp.

ProfileLateBindingTimeoutRecoveryMode

A structure that specifies late binding timeout recovery modes used in profile attributes.

ProfilePVAOffloadState

A structure that specifies the PVA offload state.


Enumerations

Enumeration Description
LateBindingTimeoutRecoveryMode An enum that specifies the late binding timeout recovery modes.
PVAOffloadState An enum that specifies at which TCP state the ePVA performs hardware offload.

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
PVAOffloadStateSequence PVAOffloadState [] A sequence of PVAOffloadStates.
ProfileFastL4StatisticEntrySequence ProfileFastL4StatisticEntry [] A sequence of ProfileFastL4 statistics.
ProfileLateBindingTimeoutRecoveryModeSequence ProfileLateBindingTimeoutRecoveryMode [] A sequence of ProfileLateBindingTimeoutRecoveryMode.
ProfilePVAOffloadStateSequence ProfilePVAOffloadState [] A sequence of PVA offload state specifications.

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.