bigip_profile_tcp – Manage TCP profiles on a BIG-IP — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# bigip_profile_tcp – Manage TCP profiles on a BIG-IP

New in version 2.6.

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Manage TCP profiles on a BIG-IP. Many TCP profiles; each with their own adjustments to the standard `tcp` profile. Users of this module should be aware that many of the adjustable knobs have no module default. Instead, the default is assigned by the BIG-IP system itself which, in most cases, is acceptable.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
early_retransmit boolean added in 2.9 | Choices: no yes | When `yes` the system uses early fast retransmits to reduce the recovery time for connections that are receive-buffer or user-data limited. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
idle_timeout string |  | Specifies the length of time that 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 `parent` profile. When a number is specified, indicates the number of seconds that the TCP connection can remain idle before the system deletes it. When `0`, or `indefinite`, specifies that the system does not delete TCP connections regardless of how long they remain idle.
initial_congestion_window_size integer added in 2.9 |  | 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 `0` the system uses the values specified in RFC2414. 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.
initial_receive_window_size integer added in 2.9 |  | 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 `0` the system uses the Slow Start value. 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.
nagle string added in 2.9 | Choices: auto enabled disabled | When `enabled` the system applies Nagle's algorithm to reduce the number of short segments on the network. When `auto`, the use of Nagle's algorithm is decided based on network conditions. Note that 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.
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 `tcp` profile.
partition string | Default: "Common" | Device partition to manage resources on.
provider dictionary added in 2.5 |  | 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.
| 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 `F5_PASSWORD`. aliases: pass, pwd
| server string / required |  | The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`.
| server_port integer | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`.
| ssh_keyfile path |  | Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable `ANSIBLE_NET_SSH_KEYFILE`.
| 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 | Choices: cli rest ← | 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 `F5_USER`.
| validate_certs boolean | Choices: no yes ← | If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`.
proxy_options boolean added in 2.9 | Choices: no yes | When `yes` the system advertises an option, such as a time-stamp to the server only if it was negotiated with the client. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
state string | Choices: present ← absent | When `present`, ensures that the profile exists. When `absent`, ensures the profile is removed.
syn_rto_base integer added in 2.9 |  | 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. 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.
time_wait_recycle boolean added in 2.7 | Choices: no yes | Specifies that connections in a TIME-WAIT state are reused, if a SYN packet, indicating a request for a new connection, is received. When `no`, connections in a TIME-WAIT state remain unused for a specified length of time. 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 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: no
        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 | Returned | Description
--- | --- | ---
early_retransmit boolean | changed | Specifies the use of early fast retransmits. Sample: True
idle_timeout integer | changed | The new idle timeout of the resource. Sample: 100
initial_congestion_window_size integer | changed | Specifies the initial congestion window size for connections to this destination. Sample: 5
initial_receive_window_size integer | changed | Specifies the initial receive window size for connections to this destination. Sample: 10
nagle string | changed | Specifies the use of Nagle's algorithm. Sample: auto
parent string | changed | The new parent of the resource. Sample: f5-tcp-optimized
proxy_options boolean | changed | Specifies if that the system advertises negotiated options to the server.
syn_rto_base integer | changed | Specifies the initial Retransmission TimeOut base multiplier for SYN retransmission. Sample: 2000
time_wait_recycle boolean | changed | Reuse connections in TIME-WAIT state. Sample: True

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]

### Authors

- Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.