Try SpotterManage OneConnect profiles on a BIG-IP
| "added in version" 1.0.0 of f5networks.f5_modules"
Authors: Tim Rupp (@caphrim007)
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections:
- name: f5networks.f5_modules
version: 1.28.0Manage OneConnect profiles on a BIG-IP system.
- name: Create a OneConnect profile
bigip_profile_oneconnect:
name: foo
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
name:
description:
- Specifies the name of the OneConnect profile.
required: true
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(oneconnect) 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
limit_type:
choices:
- none
- idle
- strict
description:
- When C(none), simultaneous in-flight requests and responses over TCP connections
to a pool member are counted toward the limit. This is the historical behavior.
- When C(idle), idle connections will be dropped as the TCP connection limit is reached.
For short intervals, during the overlap of the idle connection being dropped and
the new connection being established, the TCP connection limit may be exceeded.
- When C(strict), the TCP connection limit is honored with no exceptions. This means
that idle connections will prevent new TCP connections from being made until they
expire, even if they could otherwise be reused.
- C(strict) is not a recommended configuration except in very special cases with short
expiration timeouts.
- When creating a new profile, if this parameter is not specified, the default is
provided by the parent profile.
type: str
description:
description:
- Description of the profile.
type: str
maximum_age:
description:
- Specifies the maximum number of seconds allowed for a connection in the connection
reuse pool.
- For any connection with an age higher than this value, the system removes that connection
from the re-use pool.
- When creating a new profile, if this parameter is not specified, the default is
provided by the parent profile.
type: int
share_pools:
description:
- Indicates connections may be shared not only within a virtual server, but also among
similar virtual servers.
- When C(true), all virtual servers that use the same OneConnect and other internal
network profiles can share connections.
- When creating a new profile, if this parameter is not specified, the default is
provided by the parent profile.
type: bool
source_mask:
description:
- Specifies a value the system applies to the source address to determine its eligibility
for reuse.
- When creating a new profile, if this parameter is not specified, the default is
provided by the parent profile.
- The system applies the value of this setting to the server-side source address to
determine its eligibility for reuse.
- A mask of C(0) causes the system to share reused connections across all source addresses.
A host mask of C(32) causes the system to share only those reused connections originating
from the same source address.
- When you are using a SNAT or SNAT pool, the server-side source address is translated
first and then the OneConnect mask is applied to the translated address.
type: str
maximum_size:
description:
- Specifies the maximum number of connections the system holds in the connection reuse
pool.
- If the pool is already full, a server-side connection closes after the response
is completed.
- When creating a new profile, if this parameter is not specified, the default is
provided by the parent profile.
type: int
maximum_reuse:
description:
- Specifies the maximum number of times that a server-side connection can be reused.
- When creating a new profile, if this parameter is not specified, the default is
provided by the parent profile.
type: int
idle_timeout_override:
description:
- Specifies the number of seconds a connection is idle before the connection flow
is eligible for deletion.
- When creating a new profile, if this parameter is not specified, the default is
provided by the parent profile.
- You may specify a number of seconds for the timeout override.
- When C(disabled), specifies there is no timeout override for the connection.
- When C(indefinite), specifies a connection may be idle with no timeout override.
type: str
description:
description: Description of the profile.
returned: changed
sample: My profile
type: str
idle_timeout_override:
description: The new idle timeout override.
returned: changed
sample: disabled
type: str
limit_type:
description: New limit type of the profile.
returned: changed
sample: idle
type: str
maximum_age:
description: Maximum number of seconds allowed for a connection in the connection
reuse pool.
returned: changed
sample: 2000
type: int
maximum_reuse:
description: Maximum number of times a server-side connection can be reused.
returned: changed
sample: 1000
type: int
maximum_size:
description: Maximum number of connections the system holds in the connection reuse
pool.
returned: changed
sample: 3000
type: int
share_pools:
description: Share connections among similar virtual servers.
returned: changed
sample: true
type: bool
source_mask:
description: Value the system applies to the source address to determine its eligibility
for reuse.
returned: changed
sample: 255.255.255.255
type: str