f5networks.f5_modules.bigip_profile_tcp module – Manage TCP profiles on a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.32.1).
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_tcp
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage TCP profiles on a BIG-IP system. There are many TCP profiles, each with their own adjustments to the standard
tcp
profile. Users of this module should be aware that many of the available options have no module default. Instead, the default is assigned by the BIG-IP system itself which, in most cases, is acceptable.
Parameters
Parameter |
Comments |
---|---|
When When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
When When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. 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 |
|
Specifies the initial congestion window size for connections to this destination. The actual window size is this value multiplied by the MSS for the same connection. When set to The valid value range is 0 - 16 inclusive. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
Specifies the initial receive window size for connections to this destination. The actual window size is this value multiplied by the MSS for the same connection. When set to The valid value range is 0 - 16 inclusive. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
Specifies the L3 Type of Service level the system inserts in TCP packets destined for clients. When When When set as a number, the number indicates the IP ToS setting the system inserts in the IP packet header. Valid number range is 0 - 255 inclusive. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
Specifies how frequently the system sends data over an idle TCP connection, to determine whether the connection is still valid. 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 |
|
When When For interactive protocols such as Telnet, rlogin, or SSH, F5 recommends disabling this setting on high-latency networks, to improve application responsiveness. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
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:
|
|
When When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
When When Choices:
|
|
Specifies the initial RTO This value is modified by the exponential backoff table to select the interval for subsequent retransmissions. The valid value range is 0 - 5000 inclusive. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
|
Specifies connections in a TIME-WAIT state are reused if a SYN packet (indicating a request for a new connection) is received. When When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
Specifies the number of milliseconds a connection is in the TIME-WAIT state before closing. When When The valid number range is from 0 to 600000 milliseconds. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. |
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 TCP profile
bigip_profile_tcp:
name: foo
parent: f5-tcp-progressive
time_wait_recycle: false
idle_timeout: 300
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Specifies if the system sends fewer than one ACK segment per data segment received. Returned: changed Sample: |
|
Specifies the use of early fast retransmits. Returned: changed Sample: |
|
The new idle timeout of the resource. Returned: changed Sample: |
|
Specifies the initial congestion window size for connections to this destination. Returned: changed Sample: |
|
Specifies the initial receive window size for connections to this destination. Returned: changed Sample: |
|
Specifies the L3 Type of Service level that the system inserts in TCP packets destined for clients. Returned: changed Sample: |
|
Specifies how frequently the system sends data over an idle TCP connection. Returned: changed Sample: |
|
Specifies the use of Nagle’s algorithm. Returned: changed Sample: |
|
The new parent of the resource. Returned: changed Sample: |
|
Specifies if the system advertises negotiated options to the server. Returned: changed Sample: |
|
Specifies the initial Retransmission TimeOut base multiplier for SYN retransmission. Returned: changed Sample: |
|
Reuse connections in TIME-WAIT state. Returned: changed Sample: |
|
Specifies the number of milliseconds that a connection is in the TIME-WAIT state before closing. Returned: changed Sample: |