f5networks.f5_modules.bigip_profile_oneconnect module – Manage OneConnect 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_oneconnect
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage OneConnect profiles on a BIG-IP system.
Parameters
Parameter |
Comments |
---|---|
Description of the profile. |
|
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 When |
|
When When When
When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
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. |
|
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. |
|
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. |
|
Specifies the name of the OneConnect 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:
|
|
Indicates connections may be shared not only within a virtual server, but also among similar virtual servers. When When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices:
|
|
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 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. |
|
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 OneConnect profile
bigip_profile_oneconnect:
name: foo
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 |
---|---|
Description of the profile. Returned: changed Sample: |
|
The new idle timeout override. Returned: changed Sample: |
|
New limit type of the profile. Returned: changed Sample: |
|
Maximum number of seconds allowed for a connection in the connection reuse pool. Returned: changed Sample: |
|
Maximum number of times a server-side connection can be reused. Returned: changed Sample: |
|
Maximum number of connections the system holds in the connection reuse pool. Returned: changed Sample: |
|
Share connections among similar virtual servers. Returned: changed Sample: |
|
Value the system applies to the source address to determine its eligibility for reuse. Returned: changed Sample: |