f5networks.f5_modules.bigip_profile_fastl4 – Manages Fast L4 profiles
f5networks.f5_modules.bigip_profile_fastl4 – Manages Fast L4 profiles
Note
This plugin is part of the f5networks.f5_modules collection (version 1.6.0).
To install it use: ansible-galaxy collection install f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_profile_fastl4
.
New in version 1.0.0: of f5networks.f5_modules
Synopsis
- Manages Fast L4 profiles. Using the FastL4 profile can increase virtual server performance and throughput for supported platforms by using the embedded Packet Velocity Acceleration (ePVA) chip to accelerate traffic.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
client_timeout string |
Specifies a timeout for Late Binding. This is the time limit for the client to provide the application data required to select a back-end server, meaning the maximum time the BIG-IP system waits for information about the sender and the target. This information typically arrives at the beginning of the FIX logon packet. When When | ||
description string |
Description of the profile. | ||
explicit_flow_migration boolean |
|
Specifies whether a qualified late-binding connection requires an explicit iRule command to migrate down to ePVA hardware. When When | |
hardware_syn_cookie boolean |
|
Enables or disables hardware SYN cookie support when PVA10 is present on the system. | |
idle_timeout string |
Specifies the length of time a connection is idle (has no traffic) before the connection is eligible for deletion. When creating a new profile, if this parameter is not specified, the remote device will choose a default value appropriate for the profile, based on its When a number is specified, indicates the number of seconds the TCP connection can remain idle before the system deletes it. When When | ||
ip_df_mode string |
|
Specifies the Don't Fragment (DF) bit setting in the IP Header of the outgoing TCP packet. When When When When | |
ip_tos_to_client string |
For IP traffic passing through the system to clients, specifies whether the system modifies the IP type-of-service (ToS) setting in an IP packet header. May be a number between 0 and 255 (inclusive). When a number, specifies the IP ToS setting that the system inserts in the IP packet header. When When | ||
ip_tos_to_server string |
For IP traffic passing through the system to back-end servers, specifies whether the system modifies the IP type-of-service (ToS) setting in an IP packet header. May be a number between 0 and 255 (inclusive). When a number, specifies the IP ToS setting that the system inserts in the IP packet header. When When | ||
ip_ttl_mode string |
|
Specifies the outgoing TCP packet's IP Header TTL mode. When When When When | |
ip_ttl_v4 integer |
Specifies the outgoing packet's IP Header TTL value for IPv4 traffic. The maximum TTL value is 255. | ||
ip_ttl_v6 integer |
Specifies the outgoing packet's IP Header TTL value for IPv6 traffic. The maximum TTL value is 255. | ||
keep_alive_interval integer |
Specifies the keep-alive probe interval, in seconds. | ||
late_binding boolean |
|
Enables intelligent selection of a back-end server or pool, using an iRule to make the selection. Enabling | |
link_qos_to_client string |
For IP traffic passing through the system to clients, specifies whether the system modifies the link quality-of-service (QoS) setting in an IP packet header. The link QoS value prioritizes the IP packet relative to other Layer 2 traffic. You can specify a number between 0 (lowest priority) and 7 (highest priority). When a number, specifies the link QoS setting that the system inserts in the IP packet header. When | ||
link_qos_to_server string |
For IP traffic passing through the system to back-end servers, specifies whether the system modifies the link quality-of-service (QoS) setting in an IP packet header. The link QoS value prioritizes the IP packet relative to other Layer 2 traffic. You can specify a number between 0 (lowest priority) and 7 (highest priority). When a number, specifies the link QoS setting that the system inserts in the IP packet header. When | ||
loose_close boolean |
|
When | |
loose_initialization boolean |
|
When | |
mss_override integer |
Specifies a maximum segment size (MSS) override for server-side connections. Valid range is 256 to 9162 or 0 to disable. | ||
name string / required |
Specifies the name of the profile. | ||
parent string |
Specifies the profile from which this profile inherits settings. When creating a new profile, if this parameter is not specified, the default is the system-supplied | ||
partition string |
Default: "Common" |
Device partition to manage resources on. | |
provider dictionary added in 1.0.0 of f5networks.f5_modules |
A dict object containing connection details. | ||
auth_provider string |
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. | ||
no_f5_teem boolean |
|
If You may omit this option by setting the environment variable | |
password string / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| ||
server string / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port integer |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
timeout integer |
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. | ||
transport string |
|
Configures the transport connection to use when connecting to the remote device. | |
user string / required |
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | |
pva_acceleration string added in 1.3.0 of f5networks.f5_modules |
|
Specifies the Packet Velocity ASIC acceleration policy. | |
reassemble_fragments boolean |
|
When | |
receive_window_size integer |
Specifies the amount of data the BIG-IP system can accept without acknowledging the server. | ||
reset_on_timeout boolean |
|
When | |
rtt_from_client boolean |
|
When | |
rtt_from_server boolean |
|
When | |
server_sack boolean |
|
Specifies whether the BIG-IP system processes Selective ACK (Sack) packets in cookie responses from the server. | |
server_timestamp boolean |
|
Specifies whether the BIG-IP system processes timestamp request packets in cookie responses from the server. | |
state string |
|
When When | |
syn_cookie_mss integer |
Specifies a value that overrides the SYN cookie maximum segment size (MSS) value in the SYN-ACK packet that is returned to the client. Valid values are 0, and values from 256 through 9162. Parameter only available on TMOS 13.0.0 and higher. | ||
tcp_close_timeout string |
Specifies the length of time a connection can remain idle before deletion. | ||
tcp_generate_isn boolean |
|
When | |
tcp_handshake_timeout string |
Specifies the acceptable duration for a TCP handshake (the maximum idle time between a client synchronization (SYN) and a client acknowledgment (ACK)). If the TCP handshake takes longer than the timeout, the system automatically closes the connection. When a number, specifies how long the system can try to establish a TCP handshake before timing out. When When | ||
tcp_strip_sack boolean |
|
When | |
tcp_time_wait_timeout integer |
Specifies the number of milliseconds a connection is in the TIME-WAIT state before closing. This parameter is only available on TMOS 13.0.0 and later. | ||
tcp_timestamp_mode string |
|
Specifies the action the system should take on TCP timestamps. | |
tcp_wscale_mode string |
|
Specifies the action the system should take on TCP windows. | |
timeout_recovery string |
|
Specifies how to handle client-timeout errors for Late Binding. Timeout errors may be caused by a DoS attack or a lossy connection. When When |
Notes
Note
- For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
- Requires BIG-IP software version >= 12.
- The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.
Examples
- name: Create a fastL4 profile
bigip_profile_fastl4:
name: foo
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
client_timeout string |
changed |
The new client timeout value of the resource.
Sample: True |
description string |
changed |
The new description.
Sample: My description |
explicit_flow_migration boolean |
changed |
The new flow migration setting.
Sample: True |
hardware_syn_cookie boolean |
changed |
Enables or disables hardware SYN cookie support when PVA10 is present on the system.
|
idle_timeout string |
changed |
The new idle timeout setting.
Sample: 123 |
ip_df_mode string |
changed |
The new Don't Fragment Flag (DF) setting.
Sample: clear |
ip_tos_to_client string |
changed |
The new IP ToS to Client setting.
Sample: 100 |
ip_tos_to_server string |
changed |
The new IP ToS to Server setting.
Sample: 100 |
ip_ttl_mode string |
changed |
The new Time To Live (TTL) setting.
Sample: proxy |
ip_ttl_v4 integer |
changed |
The new Time To Live (TTL) v4 setting.
Sample: 200 |
ip_ttl_v6 integer |
changed |
The new Time To Live (TTL) v6 setting.
Sample: 200 |
keep_alive_interval integer |
changed |
The new TCP Keep Alive Interval setting.
Sample: 100 |
late_binding boolean |
changed |
The new Late Binding setting.
Sample: True |
link_qos_to_client string |
changed |
The new Link QoS to Client setting.
Sample: pass-through |
link_qos_to_server string |
changed |
The new Link QoS to Server setting.
Sample: 123 |
loose_close boolean |
changed |
The new Loose Close setting.
|
loose_initialization boolean |
changed |
The new Loose Initiation setting.
|
mss_override integer |
changed |
The new Maximum Segment Size Override setting.
Sample: 300 |
pva_acceleration string |
changed |
Specifies the Packet Velocity ASIC acceleration policy.
Sample: full |
reassemble_fragments boolean |
changed |
The new Reassemble IP Fragments setting.
Sample: True |
receive_window_size integer |
changed |
The new Receive Window setting.
Sample: 1024 |
reset_on_timeout boolean |
changed |
The new Reset on Timeout setting.
|
rtt_from_client boolean |
changed |
The new RTT from Client setting.
|
rtt_from_server boolean |
changed |
The new RTT from Server setting.
|
server_sack boolean |
changed |
The new Server Sack setting.
Sample: True |
server_timestamp boolean |
changed |
The new Server Timestamp setting.
Sample: True |
syn_cookie_mss integer |
changed |
The new SYN Cookie MSS setting.
Sample: 1024 |
tcp_close_timeout string |
changed |
The new TCP Close Timeout setting.
Sample: 100 |
tcp_generate_isn boolean |
changed |
The new Generate Initial Sequence Number setting.
|
tcp_handshake_timeout integer |
changed |
The new TCP Handshake Timeout setting.
Sample: 5 |
tcp_strip_sack boolean |
changed |
The new Strip Sack OK setting.
|
tcp_time_wait_timeout integer |
changed |
The new TCP Time Wait Timeout setting.
Sample: 100 |
tcp_timestamp_mode string |
changed |
The new TCP Timestamp Mode setting.
Sample: rewrite |
tcp_wscale_mode string |
changed |
The new TCP Window Scale Mode setting.
Sample: strip |
timeout_recovery string |
changed |
The new Timeout Recovery setting.
Sample: fallback |
Authors
- Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_profile_fastl4_module.html