LocalLB::ProfileTCP¶
Introduced : BIG-IP_v9.0
The ProfileTCP interface enables you to manipulate a local load
balancer&aposs TCP profile.
Methods¶
| Method | Description | Introduced |
| create | Creates the specified TCP profiles. | BIG-IP_v9.0 |
| delete_all_profiles | Deletes all TCP profiles. | BIG-IP_v9.0 |
| delete_profile | Deletes the specified TCP profiles. | BIG-IP_v9.0 |
| get_ack_on_push_state | Gets the states that if true, data-bearing in-order TCP segments will elicit immediate ACKs from us if they have the PUSH flag set, regardless of the setting of the delayed-ack profile option. | BIG-IP_v9.2.0 |
| get_all_statistics | Gets the statistics for all the profiles. | BIG-IP_v9.0 |
| get_appropriate_byte_counting_state | Gets the states that if true, count the number of bytes acked rather than the number of returning ACKs from the peer when in the linear congestion-window expansion phase of a TCP connection. This algorithm and its benefits are described in RFC3465 (Appropriate Byte Counting). | BIG-IP_v9.4 |
| get_auto_proxy_buffer_size_state | Gets the state that, if enabled, activates support for proxy buffer auto-tuning. | BIG-IP_v13.0.0 |
| get_auto_receive_window_size_state | Gets the state that, if enabled, activates support for receive window auto-tuning. | BIG-IP_v13.0.0 |
| get_auto_send_buffer_size_state | Gets the state that, if enabled, activates support for send buffer auto-tuning. | BIG-IP_v13.0.0 |
| get_bandwidth_delay_state | Gets the states that if true, attempt to calculate the optimal bandwidth to use to the peer based on throughput and round-trip time, and don’t exceed it. This feature was never fully implemented. It is now deprecated. | BIG-IP_v9.0.5 |
| get_close_wait_timeout | Gets the time (in seconds) to remain LAST-ACK state before giving up. Zero is forever (or until max retransmission of FIN). | BIG-IP_v9.0 |
| get_cmetrics_cache_state | Gets the states that if true, use the route-metrics cache in order to jump-start congestion-control parameters. When this parameter is disabled, the system slow-starts to the peer every time (assuming, of course, that slow-start is enabled), resulting in a much more conservative ramp-up in bandwidth utilization. This may be required in cases where an intermediate device is NATing multiple distinct clients to the same IP address, yet each of these hosts has distinctly different bandwidth and jitter parameters. It may also be required when the link is heavily oversubscribed and dropping packets due to overdriving. | BIG-IP_v9.4.0 |
| get_cmetrics_cache_timeout | Gets the expiration for route metrics cache entries for the specified TCP profiles. | BIG-IP_v12.0.0 |
| get_congestion_control_mode | Gets the TCP congestion control modes for the specified TCP profiles. | BIG-IP_v9.4 |
| 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_deferred_accept_state | Gets the states that if true, defer allocation of connection chain context until payload from the client has been seen. | BIG-IP_v9.0.2 |
| get_delay_window_control_state | Gets the states that if true, enable delay window control for the specified profiles. | BIG-IP_v11.1.0 |
| get_delayed_ack_state | Gets the states that if true, enabled delayed ACK to allow coalescing of multiple ACK responses. | BIG-IP_v9.0 |
| get_description | Gets the descriptions for a set of TCP profiles. | BIG-IP_v11.0.0 |
| get_duplicate_selective_ack_state | Gets the states that if true, enable support for RFC2883 Duplicate Selective Acknowledgement. | BIG-IP_v9.4.0 |
| get_early_retransmit_state | Gets the state that, if enabled, activates support for RFC5827 Early Retransmit. | BIG-IP_v11.6.0 |
| get_ecn_state | Gets the states that if true, enable support for RFC3168 Extended Congestion Notification (ECN). | BIG-IP_v9.0.3 |
| get_fast_open_cookie_expiration | Gets the fast open cookie expiration for the specified TCP profiles. | BIG-IP_v12.0.0 |
| get_fast_open_state | Gets the state that, if enabled, activates support for TCP Fast Open. | BIG-IP_v12.0.0 |
| get_fin_wait_2_timeout | Gets the time (in seconds) to remain FIN-WAIT-2 state before giving up. Zero is forever (or until max retransmission of FIN). | BIG-IP_v9.0 |
| get_fin_wait_timeout | Gets the time (in seconds) to remain FIN-WAIT-1 or CLOSING state before giving up. Zero is forever (or until max retransmission of FIN). | BIG-IP_v9.0 |
| get_hardware_syn_cookie_state | Gets the state that if true, enables hardware SYN cookie support. This protects against the SYN flood type of Denial Of Service (DoS) attack. | BIG-IP_v12.0.0 |
| get_high_performance_tcp_extension_state | This method has been deprecated due to the change in TCP rfc1323 option. Window scaling option is now determined automatically based on the send buffer/receive window used for the connection. Please use get_rfc1323_timestamps_state. Gets the states that if true, enable support for RFC1323 timestamps and window scaling (high performance TCP extensions). | BIG-IP_v9.0.5 |
| get_idle_timeout | Gets the idle timeout for the specified TCP profiles. This timeout specifies the number of seconds without traffic before a connection is eligible for deletion. | BIG-IP_v9.0 |
| get_initial_congestion_window_size | Gets the initial congestion window sizes for the specified profiles. | BIG-IP_v11.1.0 |
| get_initial_receive_window_size | Gets the initial receive window sizes for the specified profiles. | BIG-IP_v11.1.0 |
| get_initial_syn_rto_base_multiplier | Gets the initial SYN RTO base multipliers for the specified profiles. | BIG-IP_v11.1.0 |
| get_ip_tos_to_client | Gets the client-side IP TOS values for the specified TCP profiles. | BIG-IP_v9.0 |
| get_keep_alive_interval | Gets the keep-alive intervals (in seconds) for the specified profiles. | BIG-IP_v9.0 |
| get_limited_transmit_recovery_state | Gets the states that if true, enable support for RFC3042 Limited Transmit Recovery. | BIG-IP_v9.0.5 |
| get_link_qos_to_client | Gets the client-side link QoS values for the specified TCP profiles. | BIG-IP_v9.0 |
| get_list | Gets a list of all TCP profiles. | BIG-IP_v9.0 |
| get_maximum_data_retransmission | Gets the maximum number of retransmission of data segments for the specified profiles. | BIG-IP_v9.0 |
| get_maximum_syn_retransmission | Gets the maximum number of retransmission of SYN segments for the specified profiles. | BIG-IP_v9.0 |
| get_md5_signature_passphrase | Gets the plaintext passphrase which may be between 1 and 80 characters in length, and is used in a shared-secret scheme to implement the spoof-prevention parts of RFC2385. | BIG-IP_v9.2.0 |
| get_md5_signature_state | Gets the states that if true, use RFC2385 TCP-MD5 signatures to protect tcp traffic against intermediate tampering. | BIG-IP_v9.2.0 |
| get_minimum_rto | Gets the minimum TCP retransmission timeout in milliseconds. The default value is 0 milliseconds, which means using the TCP stack default. | BIG-IP_v11.6.0 |
| get_mptcp_state | Gets the states that if true, enable support for RFC6824 TCP Extensions for Multipath Operation with Multiple Addresses. | BIG-IP_v11.5.0 |
| get_nagle_algorithm_mode | Gets the mode for the Nagle algorithm. | BIG-IP_v12.0.0 |
| get_packet_df_mode | Gets the IP header DF bit modes for the specified TCP profiles. | BIG-IP_v13.0.0 |
| get_packet_loss_ignore_burst | Gets values indicating the likelihood of performing congestion control when multiple packets in a row are lost even if the loss threshold has not been exceeded. Valid values from 0 to 32. Higher values decrease the likelihood of performing congestion control. | BIG-IP_v10.0.0 |
| get_packet_loss_ignore_rate | Gets the threshold of packets lost per million at which the system should perform congestion control. Measured in packets per million. Valid values are from 0 to 1000000. | BIG-IP_v10.0.0 |
| get_packet_ttl_mode | Gets the IP header TTL value modes for the specified TCP profiles. | BIG-IP_v13.0.0 |
| get_packet_ttl_v4 | Gets the IPv4 header TTL value for the specified TCP profiles. | BIG-IP_v13.0.0 |
| get_packet_ttl_v6 | Gets the IPv6 header TTL value for the specified TCP profiles. | BIG-IP_v13.0.0 |
| get_proxy_buffer_high | Gets the proxy buffer level at which the receive window is closed, i.e. not advanced. | BIG-IP_v9.0 |
| get_proxy_buffer_low | Gets the proxy buffer level at which the receive window is opened. | BIG-IP_v9.0 |
| get_proxy_mss_state | Gets the states that if true, enable proxying of maximum segment size. | BIG-IP_v9.0 |
| get_proxy_option_state | Gets the states that if true, enable proxying of an option (e.g. time-stamps) to the server only if it was negotiated with the client. | BIG-IP_v9.0 |
| get_push_flag_mode | Gets the states of the PUSH flag mode (default, none, one, auto) | BIG-IP_v13.1 |
| get_rate_pace_maximum_rate | Gets the maximum rate, in bytes per second, that a flow that has rate pacing enabled may transmit data. The default value of 0 indicates no maximum. | BIG-IP_v12.0.0 |
| get_rate_pace_state | Gets the states that if true, enables rate pacing. This feature causes the system to pace the egress packets to avoid dropping packets, allowing for optimum goodput. | BIG-IP_v12.0.0 |
| get_receive_window_size | Gets the maximum advertised receive window sizes (in bytes) for the specified profiles. | BIG-IP_v9.0 |
| get_reset_on_timeout_state | Gets the reset on timeout states for the specified TCP 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_retransmit_threshold | Gets the value for the number of duplicate ACKs (retransmit threshold) to start fast recovery. | BIG-IP_v12.1.0 |
| get_rfc1323_timestamps_state | Gets the states that if true, enable support for RFC1323 timestamps (high performance TCP extension). | BIG-IP_v11.4.0 |
| get_selective_ack_state | Gets the states that if true, enable support for RFC2018 Selective Acknowledgement. | BIG-IP_v9.0.3 |
| get_selective_nack_state | Gets the states that if true, enable support for Selective Negative Acknowledgement. | BIG-IP_v11.1.0 |
| get_send_buffer_size | Gets the send buffer sizes (in bytes) for the specified profiles. | BIG-IP_v9.0 |
| get_slow_start_state | Gets the states that if true, enable support for RFC3390 TCP slow-start. BIG-IP uses RFC3390 TCP slow-start rather than traditional congestion avoidance mechanisms. | BIG-IP_v9.0.5 |
| 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_tail_loss_probe_state | Gets the state that, if enabled, activates support for Tail Loss Probe. | BIG-IP_v11.6.0 |
| get_tcp_options | Gets the strings indicating which tcp options the system remembers for connection flows using the specified TCP profiles. As the method returns a string format, if handling the value programatically please ignore parts of the string that do not follow the format shown in set_tcp_options, to accomodate system changes. | BIG-IP_v11.1.0 |
| get_time_wait_recycle_state | Gets the states that if true, recycle the connection when SYN is received in TIME-WAIT state. | BIG-IP_v9.0 |
| get_time_wait_timeout | Gets the time (in milliseconds) in TIME-WAIT state before entering CLOSED state. | BIG-IP_v9.0 |
| get_use_nagle_algorithm_state | This method is deprecated and new applications should use the get_nagle_algorithm_mode mode instead. Gets the states that if true, delay sending data that is less than MSS in size unless all prior data has been ACKed. This leads to less in-flight small-data, and less chance for drops, but can have poor effects for interactive protocols such as telnet over high latency links. | BIG-IP_v9.0.5 |
| get_verified_accept_state | Gets the states that if true, the system must not respond to the client’s SYN with a SYN-ACK until it receives a SYN-ACK from the server, indicating that the port is open. | BIG-IP_v10.0.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v9.0 |
| get_zero_window_timeout | Gets the zero window timeout for the specified TCP profiles. | BIG-IP_v11.1.0 |
| is_base_profile | Determines whether the specified TCP profiles are base profiles. A base profile sits at the base of the profile’s 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 TCP 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_ack_on_push_state | Sets the states that if true, data-bearing in-order TCP segments will elicit immediate ACKs from us if they have the PUSH flag set, regardless of the setting of the delayed-ack profile option. | BIG-IP_v9.2.0 |
| set_appropriate_byte_counting_state | Sets the states that if true, count the number of bytes acked rather than the number of returning ACKs from the peer when in the linear congestion-window expansion phase of a TCP connection. This algorithm and its benefits are described in RFC3465 (Appropriate Byte Counting). | BIG-IP_v9.4 |
| set_auto_proxy_buffer_size_state | Sets the state that, if enabled, activates the support for proxy buffer auto-tuning. When proxy buffer is auto-tuned, the proxy buffer size is determined by network measurements. | BIG-IP_v13.0.0 |
| set_auto_receive_window_size_state | Sets the state that, if enabled, activates the support for receive window auto-tuning. When receive window is auto-tuned, the receive window size is determined by network measurements. | BIG-IP_v13.0.0 |
| set_auto_send_buffer_size_state | Sets the state that, if enabled, activates the support for send buffer auto-tuning. When send buffer is auto-tuned, the send buffer size is determined by network measurements. | BIG-IP_v13.0.0 |
| set_bandwidth_delay_state | Sets the states that if true, attempt to calculate the optimal bandwidth to use to the peer based on throughput and round-trip time, and don’t exceed it. This feature was never fully implemented. It is now deprecated. | BIG-IP_v9.0.5 |
| set_close_wait_timeout | Sets the time (in seconds) to remain LAST-ACK state before giving up. Zero is forever (or until max retransmission of FIN). | BIG-IP_v9.0 |
| set_cmetrics_cache_state | Sets the states that if true, use the route-metrics cache in order to jump-start congestion-control parameters. When this parameter is disabled, the system slow-starts to the peer every time (assuming, of course, that slow-start is enabled), resulting in a much more conservative ramp-up in bandwidth utilization. This may be required in cases where an intermediate device is NATing multiple distinct clients to the same IP address, yet each of these hosts has distinctly different bandwidth and jitter parameters. It may also be required when the link is heavily oversubscribed and dropping packets due to overdriving. | BIG-IP_v9.4.0 |
| set_cmetrics_cache_timeout | Sets the timeout for route metrics cache entries for the specified TCP profiles. TCP stores congestion parameters on a per-client basis at the end of connections. These parameters are loaded into new connections to that client for the specified duration. | BIG-IP_v12.0.0 |
| set_congestion_control_mode | Sets the TCP congestion control modes for the specified TCP profiles. | BIG-IP_v9.4 |
| 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_deferred_accept_state | Sets the states that if true, defer allocation of connection chain context until payload from the client has been seen. | BIG-IP_v9.0.2 |
| set_delay_window_control_state | Sets the states that if true, enable delay window control for the specified profiles. Specifies whether the system uses an estimate of queueing delay as a measure of congestion, in addition to the normal loss-based control, to control the amount of data sent. | BIG-IP_v11.1.0 |
| set_delayed_ack_state | Sets the states that if true, enabled delayed ACK to allow coalescing of multiple ACK responses. | BIG-IP_v9.0 |
| set_description | Sets the description for a set of TCP profiles. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_duplicate_selective_ack_state | Sets the states that if true, enable support for RFC2883 Duplicate Selective Acknowledgement. | BIG-IP_v9.4.0 |
| set_early_retransmit_state | Sets the state that, if enabled, activates support for RFC5827 Early Retransmit. TCP early retransmit avoids timeouts when single packets are lost from small bursts of data that would not trigger Fast Recovery. | BIG-IP_v11.6.0 |
| set_ecn_state | Sets the states that if true, enable support for RFC3168 Extended Congestion Notification (ECN). | BIG-IP_v9.0.3 |
| set_fast_open_cookie_expiration | Sets the fast open cookie expiration for the specified TCP profiles. This timeout specifies the time, in seconds, for which a TCP Fast Open Cookie granted by the BIG-IP remains valid to accept data delivered with the SYN packet. The origination time is encrypted in the cookie and checked during cookie validation. | BIG-IP_v12.0.0 |
| set_fast_open_state | Sets the state that, if enabled, activates support for TCP Fast Open, which allows validated clients to deliver data with SYN packets. | BIG-IP_v12.0.0 |
| set_fin_wait_2_timeout | Sets the time (in seconds) to remain FIN-WAIT-2 state before giving up. Zero is forever (or until max retransmission of FIN). | BIG-IP_v9.0 |
| set_fin_wait_timeout | Sets the time (in seconds) to remain FIN-WAIT-1 or CLOSING state before giving up. Zero is forever (or until max retransmission of FIN). | BIG-IP_v9.0 |
| set_hardware_syn_cookie_state | Sets the state that if true, enables hardware SYN cookie support. This protects against the SYN flood type of Denial Of Service (DoS) attack. This is available on most hardware platforms, specifically, those on which PVA10 is present. By default, this setting is enabled. | BIG-IP_v12.0.0 |
| set_high_performance_tcp_extension_state | This method has been deprecated due to the change in TCP rfc1323 option. Window scaling option is now determined automatically based on the send buffer/receive window used for the connection. Please use set_rfc1323_timestamps_state. Sets the states that if true, enable support for RFC1323 timestamps and window scaling (high performance TCP extensions). | BIG-IP_v9.0.5 |
| set_idle_timeout | Sets the idle timeout for the specified TCP profiles. This timeout specifies the number of seconds without traffic before a connection is eligible for deletion. | BIG-IP_v9.0 |
| set_initial_congestion_window_size | Sets the initial congestion window sizes for the specified profiles. The actual window size is this value multiplied by the MSS (Maximum Segment Size) for the connection. The default value is 0, which means to use the values specified in RFC2414. | BIG-IP_v11.1.0 |
| set_initial_receive_window_size | Sets the initial receive window sizes for the specified profiles. The actual window size is this value multiplied by the MSS (Maximum Segment Size) for the same connection. The default value is 0, which means to use the Slow Start value. | BIG-IP_v11.1.0 |
| set_initial_syn_rto_base_multiplier | Sets the initial SYN RTO base multipliers for the specified profiles. Specifies the initial RTO (Retransmission TimeOut) base multiplier for SYN retransmission, in milliseconds. This value is modified by the exponential backoff table to select the interval for subsequent retransmissions. | BIG-IP_v11.1.0 |
| set_ip_tos_to_client | Sets the client-side IP TOS values for the specified TCP profiles. | BIG-IP_v9.0 |
| set_keep_alive_interval | Sets the keep-alive intervals (in seconds) for the specified profiles. | BIG-IP_v9.0 |
| set_limited_transmit_recovery_state | Sets the states that if true, enable support for RFC3042 Limited Transmit Recovery. | BIG-IP_v9.0.5 |
| set_link_qos_to_client | Sets the client-side link QoS values for the specified TCP profiles. | BIG-IP_v9.0 |
| set_maximum_data_retransmission | Sets the maximum number of retransmission of data segments for the specified profiles. | BIG-IP_v9.0 |
| set_maximum_syn_retransmission | Sets the maximum number of retransmission of SYN segments for the specified profiles. | BIG-IP_v9.0 |
| set_md5_signature_passphrase | Sets the plaintext passphrase which may be between 1 and 80 characters in length, and is used in a shared-secret scheme to implement the spoof-prevention parts of RFC2385. | BIG-IP_v9.2.0 |
| set_md5_signature_state | Sets the states that if true, use RFC2385 TCP-MD5 signatures to protect tcp traffic against intermediate tampering. | BIG-IP_v9.2.0 |
| set_minimum_rto | Sets the minimum TCP retransmission timeout in milliseconds. Zero means using the TCP stack default. This is the minimum amount of time TCP must wait before assuming a packet is lost. | BIG-IP_v11.6.0 |
| set_mptcp_state | Sets the states that if true, enable support for RFC6824 TCP Extensions for Multipath Operation with Multiple Addresses. | BIG-IP_v11.5.0 |
| set_nagle_algorithm_mode | Sets the mode for the Nagle algorithm. If the mode is set to TCP_MODE_ENABLED, sending data is delayed if it is less than MSS in size unless all prior data has been ACKed. This leads to fewer small packets sent and a smaller chance of dropped packets. However, this can have poor effects for interactive protocols such as telnet over high latency links. If the mode is set to TCP_MODE_DISABLED, sending data that is less than MSS in size is not delayed. If mode is set to TCP_MODE_AUTO, the use of Nagle’s algorithm is decided based on the network characteristics such as the use of delayed ACKs. | BIG-IP_v12.0.0 |
| set_packet_df_mode | Sets the IP header DF bit modes for the specified TCP profiles. The DF (Don’t 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’s DF bit value or to set the DF bit only if Path MTU is enabled. | BIG-IP_v13.0.0 |
| set_packet_loss_ignore_burst | Sets values indicating the likelihood of performing congestion control when multiple packets in a row are lost even if the loss threshold has not been exceeded. Valid values from 0 to 32. Higher values decrease the likelihood of performing congestion control. | BIG-IP_v10.0.0 |
| set_packet_loss_ignore_rate | Sets the threshold of packets lost per million at which the system should perform congestion control. Measured in packets per million. Valid values are from 0 to 1000000. | BIG-IP_v10.0.0 |
| set_packet_ttl_mode | Sets the IP header TTL value modes for the specified TCP 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 ‘hop limit’ 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 TCP 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 TCP 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 ‘hop limit’ in IPv6. | BIG-IP_v13.0.0 |
| set_proxy_buffer_high | Sets the proxy buffer level at which the receive window is closed, i.e. not advanced. | BIG-IP_v9.0 |
| set_proxy_buffer_low | Sets the proxy buffer level at which the receive window is opened. | BIG-IP_v9.0 |
| set_proxy_mss_state | Sets the states that if true, enable proxying of maximum segment size. | BIG-IP_v9.0 |
| set_proxy_option_state | Sets the states that if true, enable proxying of an option (e.g. time-stamps) to the server only if it was negotiated with the client. | BIG-IP_v9.0 |
| set_rate_pace_maximum_rate | Sets the maximum rate, in bytes per second, that a flow that has rate pacing enabled may transmit data. The default value of 0 indicates no maximum. | BIG-IP_v12.0.0 |
| set_rate_pace_state | Sets the states that if true, enables rate pacing. This feature causes the system to pace the egress packets to avoid dropping packets, allowing for optimum goodput. | BIG-IP_v12.0.0 |
| set_receive_window_size | Sets the maximum advertised receive window sizes (in bytes) for the specified profiles. This value represents the maximum number of bytes to which the receive window can scale. The default is 32768 bytes. | BIG-IP_v9.0 |
| set_reset_on_timeout_state | Sets the reset on timeout states for the specified TCP 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_retransmit_threshold | Sets the value for the number of duplicate ACKs (retransmit threshold) to start fast recovery. Valid values are from 3 to 255. Higher values decrease the likelihood of performing fast recovery in a network with high packet reordering. The default value is 3. | BIG-IP_v12.1.0 |
| set_rfc1323_timestamps_state | Sets the states that if true, enable support for RFC1323 timestamps (high performance TCP extension). | BIG-IP_v11.4.0 |
| set_selective_ack_state | Sets the states that if true, enable support for RFC2018 Selective Acknowledgement. | BIG-IP_v9.0.3 |
| set_selective_nack_state | Sets the states that if true, enable support for Selective Negative Acknowledgement. | BIG-IP_v11.1.0 |
| set_send_buffer_size | Sets the send buffer sizes (in bytes) for the specified profiles. | BIG-IP_v9.0 |
| set_slow_start_state | Sets the states that if true, enable support for RFC3390 TCP slow-start. BIG-IP uses RFC3390 TCP slow-start rather than traditional congestion avoidance mechanisms. | BIG-IP_v9.0.5 |
| set_tail_loss_probe_state | Sets the state that, if enabled, activates support for Tail Loss Probe. Tail Loss Probe reduces the number of retransmission timeouts when the TCP segments are lost from the tail of a transaction or a window of data/ACKs are lost. | BIG-IP_v11.6.0 |
| set_tcp_options | Sets the strings indicating which tcp options the system remembers for connection flows using the specified TCP profiles. The options of interest may then be manipulated using iRules; see TCP::option. The format of each string should be: “{ } { }”, one string like this for each profile. The keyword “first” means the system records the option the first time it is seen, while “last” means the system updates the available value every time it is seen. | BIG-IP_v11.1.0 |
| set_time_wait_recycle_state | Sets the states that if true, recycle the connection when SYN is received in TIME-WAIT state. | BIG-IP_v9.0 |
| set_time_wait_timeout | Sets the time (in milliseconds) in TIME-WAIT state before entering CLOSED state. | BIG-IP_v9.0 |
| set_use_nagle_algorithm_state | This method is deprecated and new applications should use the set_nagle_algorithm_mode method instead. Sets the states that if true, delay sending data that is less than MSS in size unless all prior data has been ACKed. This leads to less in-flight small-data, and less chance for drops, but can have poor effects for interactive protocols such as telnet over high latency links. | BIG-IP_v9.0.5 |
| set_verified_accept_state | Sets the states that if true, the system must not respond to the client’s SYN with a SYN-ACK until it receives a SYN-ACK from the server, indicating that the port is open. | BIG-IP_v10.0.0 |
| set_zero_window_timeout | Sets the zero window timeout for the specified TCP profiles. This timeout specifies the timeout in milliseconds for terminating a connection with an effective zero length TCP transmit window. The timeout starts when the peer advertises a zero length TCP window or when enough data has been sent to fill the previously advertised window. The timer is canceled when a non-zero length window is received. | BIG-IP_v11.1.0 |
Structures¶
Structure
Description
A structure that specifies a TCPMode enum used in profile attributes.
A struct that describes statistics for a particular profile.
A struct that describes profile statistics and timestamp.
Enumerations¶
| Enumeration | Description |
| TCPMode | A tri-state enumeration indicating whether a TCP feature or option is disabled, enabled or determined automatically. |
Aliases¶
| Alias | Type | Description |
| ProfileTCPModeSequence | ProfileTCPMode [] | A sequence of ProfileTCPModes. |
| ProfileTCPStatisticEntrySequence | ProfileTCPStatisticEntry [] | A sequence of ProfileTCP statistics. |
See Also¶
iControl ::
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.