LocalLB::FlowEvictionPolicy¶
Introduced : BIG-IP_v11.6.0
The FlowEvictionPolicy interface enables you to define flow eviction
policy. It provides a user-controlled way to adjust how and when flows
are swept, based on virtual server, route domain, and global
constraints. In this context, a flow refers to a TCP connection. These
policies define how the connections are evicted from the connection
flow table in TMM. Multiple bias algorithms can be enabled at the same
time.
Methods¶
| Method | Description | Introduced |
| add_eviction_strategy_port | Adds the port/protocol to the low priority port/protocol strategy for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| add_low_priority_geography | Adds the specified countries as low priority geographies for the low priority geographies flow eviction policies. | BIG-IP_v11.6.0 |
| add_low_priority_route_domain | Adds the specified route domains as low priority route domains for the low priority route domain flow eviction policies. | BIG-IP_v11.6.0 |
| add_low_priority_virtual_server | Adds the specified Virtual Servers as low priority virtual servers for the low priority virtual server flow eviction policies. | BIG-IP_v11.6.0 |
| create | Creates the set of flow eviction policies. | BIG-IP_v11.6.0 |
| delete_all_eviction_policies | Deletes all flow eviction policies. | BIG-IP_v11.6.0 |
| delete_eviction_policy | Deletes the set of flow eviction policies. | BIG-IP_v11.6.0 |
| get_all_statistics | Gets the statistics for all the eviction strategy policies. | BIG-IP_v11.6.0 |
| get_description | Gets the descriptions for a set of eviction policies. | BIG-IP_v11.6.0 |
| get_eviction_strategy_bias_bytes_delay | Get the delay in seconds for the set of bias bytes flow eviction policies. | BIG-IP_v11.6.0 |
| get_eviction_strategy_bias_fast_delay | Get the delay in seconds for the set of bias fast flow eviction policies. | BIG-IP_v12.0.0 |
| get_eviction_strategy_bias_slow_delay | Get the delay in seconds for the set of bias slow flow eviction policies. | BIG-IP_v12.0.0 |
| get_eviction_strategy_bytes_state | Get the state which enables or disables using the bias bytes eviction strategy for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| get_eviction_strategy_fast_state | Get the state which enables or disables using the bias fast eviction strategy for the set of flow eviction policies. | BIG-IP_v12.0.0 |
| get_eviction_strategy_geography_state | Get the state for low priority geography eviction strategy for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| get_eviction_strategy_idle_state | Get the state of the bias idle eviction strategy for the set of flow eviction poicies. | BIG-IP_v11.6.0 |
| get_eviction_strategy_oldest_state | Get the state which enables or disables using the bias oldest eviction strategy for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| get_eviction_strategy_port | Get the Port/Protocol Flow Eviction Strategy for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| get_eviction_strategy_port_description | Gets the descriptions for a set of port-protocol eviction strategy pairs. | BIG-IP_v11.6.0 |
| get_eviction_strategy_port_state | Get the state for low priority ports/protocols eviction strategy for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| get_eviction_strategy_route_domain_state | Get the state for low priority route domain eviction strategy for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| get_eviction_strategy_slow_state | Get the state which enables or disables using the bias slow eviction strategy for the set of flow eviction policies. | BIG-IP_v12.0.0 |
| get_eviction_strategy_virtual_server_state | Get the state for low priority virtual server eviction strategy for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| get_high_water | Get the high-water values for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| get_list | Gets the names of all the flow eviction policies. | BIG-IP_v11.6.0 |
| get_low_priority_geography | Get the countries for the low priority geographies flow eviction policies. | BIG-IP_v11.6.0 |
| get_low_priority_route_domain | Get the route domains specified as low priority route domains for the low priority route domain flow eviction policies. | BIG-IP_v11.6.0 |
| get_low_priority_virtual_server | Get the list of specified low-priority virtual servers. | BIG-IP_v11.6.0 |
| get_low_water | Get the low-water threshold values for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| get_slow_flow_maximum | Get the maximum number of slow flow for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| get_slow_flow_monitoring_state | Get the slow flow monitoring states for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| get_slow_flow_threshold | Get the slow flow threshold values in bits per second for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| get_slow_flow_throttle_type | Get the slow flow throttling type for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| get_slow_flow_throttling_state | Get the slow flow throttling states for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| get_statistics | Gets the statistics for the specified eviction strategy policies. | BIG-IP_v11.6.0 |
| get_version | Get the version information for this interface. | BIG-IP_v11.6.0 |
| remove_all_eviction_strategy_ports | Removes all of the port/protocol from the low priority port/protocol strategy for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| remove_all_low_priority_geographies | Removes all of the specified countries as low priority geographies for the low priority geographies flow eviction policies. | BIG-IP_v11.6.0 |
| remove_all_low_priority_route_domains | Removes all route domains from the list of low priority route domains for the specified flow eviction policies. | BIG-IP_v11.6.0 |
| remove_all_low_priority_virtual_servers | Removes all virtual servers from the list of low priority virtual servers for the specified flow eviction policies. | BIG-IP_v11.6.0 |
| remove_eviction_strategy_port | Removes the port/protocol from the low priority port/protocol strategy for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| remove_low_priority_geography | Removes the specified countries as low priority geographies for the low priority geographies flow eviction policies. | BIG-IP_v11.6.0 |
| remove_low_priority_route_domain | Removes route domains from the list of low priority route domains for the specified flow eviction policies. | BIG-IP_v11.6.0 |
| remove_low_priority_virtual_server | Removes virtual servers from the list of low priority virtual servers for the specified flow eviction policies. | BIG-IP_v11.6.0 |
| reset_statistics | Resets the statistics for the specified eviction policies. | BIG-IP_v11.6.0 |
| set_description | Sets the description for a set of eviction policies. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.6.0 |
| set_eviction_strategy_bias_bytes_delay | Set the delay in seconds for the set of bias bytes flow eviction policies. Flows alive for shorter than the delay are not pruned by the bias bytes algorithm. | BIG-IP_v11.6.0 |
| set_eviction_strategy_bias_fast_delay | Set the delay in seconds for the set of bias fast flow eviction policies. Flows alive for shorter than the delay are not pruned by the bias fast algorithm. | BIG-IP_v12.0.0 |
| set_eviction_strategy_bias_slow_delay | Set the delay in seconds for the set of bias slow flow eviction policies. Flows alive for shorter than the delay are not pruned by the bias slow algorithm. | BIG-IP_v12.0.0 |
| set_eviction_strategy_bytes_state | Set the state which enables or disables using the bias bytes eviction strategy for the set of flow eviction policies. The bias bytes eviction strategy selects flows for removal that have sent the fewest bytes since the connection was established. | BIG-IP_v11.6.0 |
| set_eviction_strategy_fast_state | Set the state which enables or disables using the bias fast eviction strategy for the set of flow eviction policies. The bias fast eviction strategy selects flows for removal that have the fastest rate of transfer since the connection was established. | BIG-IP_v12.0.0 |
| set_eviction_strategy_geography_state | Set the state for low priority geography eviction strategy for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| set_eviction_strategy_idle_state | Set the state of the bias idle eviction strategy for the set of flow eviction policies. This enables or disables the bias idle eviction strategy. The bias idle eviction strategy removes flows with higher idle timers and preserves flows which have not been idle. | BIG-IP_v11.6.0 |
| set_eviction_strategy_oldest_state | Set the state of the bias oldest eviction strategy for the set of flow eviction policies. This enables or disables the bias oldest eviction strategy. The bias oldest eviction strategy selects flows for removal that are the oldest flows. | BIG-IP_v11.6.0 |
| set_eviction_strategy_port_description | Sets the description for a set of port-protocol eviction strategy pairs. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.6.0 |
| set_eviction_strategy_port_state | Set the state for low priority ports/protocols eviction strategy for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| set_eviction_strategy_route_domain_state | Set the state for low priority route domain eviction strategy for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| set_eviction_strategy_slow_state | Set the state which enables or disables using the bias slow eviction strategy for the set of flow eviction policies. The bias slow eviction strategy selects flows for removal that have the slowest rate of transfer since the connection was established. | BIG-IP_v12.0.0 |
| set_eviction_strategy_virtual_server_state | Set the state for low priority virtual server eviction strategy for the set of flow eviction policies. | BIG-IP_v11.6.0 |
| set_high_water | Set the high-water values for the set of flow eviction policies. This values sets the desired portion of maximum load, controlling how aggressively the tmm attempts to purge traffic under load. The percentage applies to connection flow limits when used on a user defined policy and memory limits on the global policy. | BIG-IP_v11.6.0 |
| set_low_water | Set the low-water values for the set of flow eviction policies. This is a trigger value and flows will be evicted when above this value. The percentage applies to connection flow limits when used on a user defined policy and memory limits on the global policy. | BIG-IP_v11.6.0 |
| set_slow_flow_maximum | Set the max number of slow flow bps for the set of flow eviction policies. Its unit depends on the slow flow throttle type. Please see slow_flow_throttle_type for more details. | BIG-IP_v11.6.0 |
| set_slow_flow_monitoring_state | Set the slow flow monitoring for the set of flow eviction policies. It enables or disables the slow flow monitoring. Slow flows are basically connections where the rate of data transfer is lower than a certain value. That value is determined by threshold_bps attribute. | BIG-IP_v11.6.0 |
| set_slow_flow_threshold | Set the slow flow threshold values in bits per second for the set of flow eviction policies. Slow flows are basically connections where the rate of data transfer is lower than a certain value. It tells what the threshold for that slow flow is. | BIG-IP_v11.6.0 |
| set_slow_flow_throttle_type | Set the slow flow threshold throttling type for the set of flow eviction policies. It can either be expressed in percentage or in count. | BIG-IP_v11.6.0 |
| set_slow_flow_throttling_state | Sets the slow flow throttling state for the set of flow eviction policies. This enables or disables throttling of the slow flows for the set of flow eviction policies. | BIG-IP_v11.6.0 |
Structures¶
Structure
Description
FlowEvictionPolicyStatisticEntry
A struct that describes an eviction policy and its statistics.
A struct that describes eviction policy statistics and timestamp.
Structure to hold the port protocol pair.
Enumerations¶
| Enumeration | Description |
| EvictionSlowFlowThrottleType | Determines how the slow flow throttle values are stored. It can either be a percent value or count value. |
| IPProtocolType | List of valid protocol types. |
Aliases¶
| Alias | Type | Description |
| EvictionSlowFlowThrottleTypeSequence | EvictionSlowFlowThrottleType [] | A Sequence of slow flow throttle types. |
| FlowEvictionPolicyStatisticEntrySequence | FlowEvictionPolicyStatisticEntry [] | A sequence of FlowEvictionPolicy statistics. |
| FlowEvictionPolicyStatisticsSequence | FlowEvictionPolicyStatistics [] | A sequence of FlowEvictionPolicy statistics. |
| PortProtocolPairSequence | PortProtocolPair [] | A sequence of PortProtocolPair. |
| PortProtocolPairSequenceSequence | PortProtocolPair [] [] | A sequence of PortProtocolPairSequence. |
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.