f5networks.f5_modules.bigip_profile_fastl4 module – Manages Fast L4 profiles
Note
This module is part of the f5networks.f5_modules collection (version 1.31.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
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 f5networks.f5_modules 1.0.0
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 |
Comments |
---|---|
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 of the profile. |
|
Specifies whether a qualified late-binding connection requires an explicit iRule command to migrate down to ePVA hardware. When When Choices:
|
|
Enables or disables hardware SYN cookie support when PVA10 is present on the system. Choices:
|
|
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 |
|
Specifies the Don’t Fragment (DF) bit setting in the IP Header of the outgoing TCP packet. When When When When Choices:
|
|
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 |
|
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 |
|
Specifies the outgoing TCP packet’s IP Header TTL mode. When When When When Choices:
|
|
Specifies the outgoing packet’s IP Header TTL value for IPv4 traffic. The maximum TTL value is 255. |
|
Specifies the outgoing packet’s IP Header TTL value for IPv6 traffic. The maximum TTL value is 255. |
|
Specifies the keep-alive probe interval, in seconds. |
|
Enables intelligent selection of a back-end server or pool, using an iRule to make the selection. Enabling Choices:
|
|
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 |
|
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 |
|
When Choices:
|
|
When Choices:
|
|
Specifies a maximum segment size (MSS) override for server-side connections. Valid range is 256 to 9162 or 0 to disable. |
|
Specifies the name of the profile. |
|
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 |
|
Device partition to manage resources on. Default: |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
The password for the user account used to connect to the BIG-IP or the BIG-IQ. You may omit this option by setting the environment variable |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative privileges on the device. You may omit this option by setting the environment variable |
|
If You may omit this option by setting the environment variable Choices:
|
|
Specifies the Packet Velocity ASIC acceleration policy. Choices:
|
|
When Choices:
|
|
Specifies the amount of data the BIG-IP system can accept without acknowledging the server. |
|
When Choices:
|
|
When Choices:
|
|
When Choices:
|
|
Specifies whether the BIG-IP system processes Selective ACK (Sack) packets in cookie responses from the server. Choices:
|
|
Specifies whether the BIG-IP system processes timestamp request packets in cookie responses from the server. Choices:
|
|
When When Choices:
|
|
Specifies whether or not to use SYN Cookie. Choices:
|
|
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. |
|
Specifies the length of time a connection can remain idle before deletion. |
|
When Choices:
|
|
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 |
|
When Choices:
|
|
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. |
|
Specifies the action the system should take on TCP timestamps. Choices:
|
|
Specifies the action the system should take on TCP windows. Choices:
|
|
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 Choices:
|
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 |
Description |
---|---|
The new client timeout value of the resource. Returned: changed Sample: |
|
The new description. Returned: changed Sample: |
|
The new flow migration setting. Returned: changed Sample: |
|
Enables or disables hardware SYN cookie support when PVA10 is present on the system. Returned: changed Sample: |
|
The new idle timeout setting. Returned: changed Sample: |
|
The new Don’t Fragment Flag (DF) setting. Returned: changed Sample: |
|
The new IP ToS to Client setting. Returned: changed Sample: |
|
The new IP ToS to Server setting. Returned: changed Sample: |
|
The new Time To Live (TTL) setting. Returned: changed Sample: |
|
The new Time To Live (TTL) v4 setting. Returned: changed Sample: |
|
The new Time To Live (TTL) v6 setting. Returned: changed Sample: |
|
The new TCP Keep Alive Interval setting. Returned: changed Sample: |
|
The new Late Binding setting. Returned: changed Sample: |
|
The new Link QoS to Client setting. Returned: changed Sample: |
|
The new Link QoS to Server setting. Returned: changed Sample: |
|
The new Loose Close setting. Returned: changed Sample: |
|
The new Loose Initiation setting. Returned: changed Sample: |
|
The new Maximum Segment Size Override setting. Returned: changed Sample: |
|
Specifies the Packet Velocity ASIC acceleration policy. Returned: changed Sample: |
|
The new Reassemble IP Fragments setting. Returned: changed Sample: |
|
The new Receive Window setting. Returned: changed Sample: |
|
The new Reset on Timeout setting. Returned: changed Sample: |
|
The new RTT from Client setting. Returned: changed Sample: |
|
The new RTT from Server setting. Returned: changed Sample: |
|
The new Server Sack setting. Returned: changed Sample: |
|
The new Server Timestamp setting. Returned: changed Sample: |
|
Specifies whether or not to use SYN Cookie. Returned: changed Sample: |
|
The new SYN Cookie MSS setting. Returned: changed Sample: |
|
The new TCP Close Timeout setting. Returned: changed Sample: |
|
The new Generate Initial Sequence Number setting. Returned: changed Sample: |
|
The new TCP Handshake Timeout setting. Returned: changed Sample: |
|
The new Strip Sack OK setting. Returned: changed Sample: |
|
The new TCP Time Wait Timeout setting. Returned: changed Sample: |
|
The new TCP Timestamp Mode setting. Returned: changed Sample: |
|
The new TCP Window Scale Mode setting. Returned: changed Sample: |
|
The new Timeout Recovery setting. Returned: changed Sample: |