Try SpotterManage TCP profiles on a BIG-IP
| "added in version" 1.0.0 of f5networks.f5_modules"
Authors: Tim Rupp (@caphrim007), Wojciech Wypior (@wojtek0806)
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections:
- name: f5networks.f5_modules
version: 1.28.0Manage TCP profiles on a BIG-IP system. There are many TCP profiles, each with their own adjustments to the standard C(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.
- 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
name:
description:
- Specifies the name of the profile.
required: true
type: str
nagle:
choices:
- auto
- enabled
- disabled
description:
- When C(enabled) the system applies Nagle's algorithm to reduce the number of short
segments on the network.
- When C(auto), the use of Nagle's algorithm is decided based on network conditions.
- 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.
type: str
state:
choices:
- present
- absent
default: present
description:
- When C(present), ensures the profile exists.
- When C(absent), ensures the profile is removed.
type: str
parent:
description:
- 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 C(tcp) profile.
type: str
provider:
description:
- A dict object containing connection details.
suboptions:
auth_provider:
description:
- Configures the auth provider for to obtain authentication tokens from the remote
device.
- This option is really used when working with BIG-IQ devices.
type: str
no_f5_teem:
default: false
description:
- If C(yes), TEEM telemetry data is not sent to F5.
- You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
- Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
type: bool
password:
aliases:
- pass
- pwd
description:
- 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 C(F5_PASSWORD).
required: true
type: str
server:
description:
- The BIG-IP host or the BIG-IQ host.
- You may omit this option by setting the environment variable C(F5_SERVER).
required: true
type: str
server_port:
default: 443
description:
- The BIG-IP server port.
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
type: int
timeout:
description:
- 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.
type: int
transport:
choices:
- rest
default: rest
description:
- Configures the transport connection to use when connecting to the remote device.
type: str
user:
description:
- 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 C(F5_USER).
required: true
type: str
validate_certs:
default: true
description:
- If C(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 C(F5_VALIDATE_CERTS).
type: bool
type: dict
version_added: 1.0.0
version_added_collection: f5networks.f5_modules
partition:
default: Common
description:
- Device partition to manage resources on.
type: str
delayed_acks:
description:
- When C(true), the system sends fewer than one ACK segment per data segment received.
- When creating a new profile, if this parameter is not specified, the default is
provided by the parent profile.
type: bool
idle_timeout:
description:
- 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 C(parent)
profile.
- When a number is specified, indicates the number of seconds the TCP connection can
remain idle before the system deletes it.
- When C(0), or C(indefinite), specifies the system does not delete TCP connections
regardless of how long they remain idle.
type: str
syn_rto_base:
description:
- Specifies the initial RTO C(Retransmission TimeOut) base multiplier for SYN retransmission,
in C(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.
type: int
proxy_options:
description:
- When C(true), 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.
type: bool
early_retransmit:
description:
- When C(true), 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.
type: bool
ip_tos_to_client:
description:
- Specifies the L3 Type of Service level the system inserts in TCP packets destined
for clients.
- When C(pass-through), the IP ToS setting remains unchanged.
- When C(mimic), the system sets the ToS level of outgoing packets to the same ToS
level of the most-recently received incoming packet.
- 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.
type: str
time_wait_recycle:
description:
- Specifies connections in a TIME-WAIT state are reused if a SYN packet (indicating
a request for a new connection) is received.
- When C(false), 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.
type: bool
time_wait_timeout:
description:
- Specifies the number of milliseconds a connection is in the TIME-WAIT state before
closing.
- When C(immediate), the system closes the connection immediately after the connection
enters the TIME-WAIT state.
- When C(indefinite) or C(0), the system does not close TCP connections regardless
of how long they remain in the TIME-WAIT state.
- 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.
type: str
version_added: 1.3.0
version_added_collection: f5networks.f5_modules
keep_alive_interval:
description:
- 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 C(parent)
profile.
- When C(0), or C(indefinite), specifies that the system does not send keep-alive
communication.
type: str
version_added: 1.22.0
version_added_collection: f5networks.f5_modules
initial_receive_window_size:
description:
- 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 C(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.
type: int
initial_congestion_window_size:
description:
- 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 C(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.
type: int
delayed_acks:
description: Specifies if the system sends fewer than one ACK segment per data segment
received.
returned: changed
sample: true
type: bool
early_retransmit:
description: Specifies the use of early fast retransmits.
returned: changed
sample: true
type: bool
idle_timeout:
description: The new idle timeout of the resource.
returned: changed
sample: 100
type: int
initial_congestion_window_size:
description: Specifies the initial congestion window size for connections to this
destination.
returned: changed
sample: 5
type: int
initial_receive_window_size:
description: Specifies the initial receive window size for connections to this destination.
returned: changed
sample: 10
type: int
ip_tos_to_client:
description: Specifies the L3 Type of Service level that the system inserts in TCP
packets destined for clients.
returned: changed
sample: mimic
type: str
keep_alive_interval:
description: Specifies how frequently the system sends data over an idle TCP connection.
returned: changed
sample: indefinite
type: str
nagle:
description: Specifies the use of Nagle's algorithm.
returned: changed
sample: auto
type: str
parent:
description: The new parent of the resource.
returned: changed
sample: f5-tcp-optimized
type: str
proxy_options:
description: Specifies if the system advertises negotiated options to the server.
returned: changed
sample: false
type: bool
syn_rto_base:
description: Specifies the initial Retransmission TimeOut base multiplier for SYN
retransmission.
returned: changed
sample: 2000
type: int
time_wait_recycle:
description: Reuse connections in TIME-WAIT state.
returned: changed
sample: true
type: bool
time_wait_timeout:
description: Specifies the number of milliseconds that a connection is in the TIME-WAIT
state before closing.
returned: changed
sample: immediate
type: str