f5networks.f5_modules.bigip_profile_persistence_cookie module – Manage cookie persistence profiles on 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_persistence_cookie
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage cookie persistence profiles on BIG-IP system.
Parameters
Parameter |
Comments |
---|---|
Sends the cookie persistence entry on every reply, even if the entry has previously been supplied to the client. Choices:
|
|
Specifies the way in which the cookie encryption format is used. When When When Choices:
|
|
Specifies the type of cookie processing the system uses. When When When When Choices:
|
|
Specifies a unique name for the cookie. |
|
Description of the profile. |
|
Specifies whether the pool-name in the inserted BIG-IP default cookie should be encrypted. Choices:
|
|
Specifies a passphrase to be used for cookie encryption. |
|
Specifies the expiration time of the cookie. By default the system generates and uses a session cookie. This cookie expires when the user session expires (when the browser is closed). |
|
Cookie expiration time in days. The value must be in range from |
|
Cookie expiration time in hours. The value must be in the range from |
|
Cookie expiration time in minutes. The value must be in the range from |
|
Cookie expiration time in seconds. The value must be in the range from Default: |
|
Specifies whether the httponly attribute should be enabled or disabled for the inserted cookies. Choices:
|
|
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:
|
|
When 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. |
|
When Per-virtual connection limits remain hard limits and are not overridden. Choices:
|
|
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 Default: |
|
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:
|
|
Specifies whether the secure attribute should be enabled or disabled for the inserted cookies. Choices:
|
|
When When Choices:
|
|
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 persistence cookie profile
bigip_profile_persistence_cookie:
name: foo
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Create a persistence cookie profile with expiration time
bigip_profile_persistence_cookie:
name: foo
expiration:
days: 7
hours: 12
minutes: 30
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The new Always Send value. Returned: changed Sample: |
|
The new Cookie Encryption type. Returned: changed Sample: |
|
The new Cookie Method. Returned: changed Sample: |
|
The new Cookie Name value. Returned: changed Sample: |
|
The new description. Returned: changed Sample: |
|
The new Encrypt Cookie Pool Name value. Returned: changed Sample: |
|
The expiration time of the cookie. Returned: changed Sample: |
|
Cookie expiration time in days. Returned: changed Sample: |
|
Cookie expiration time in hours. Returned: changed Sample: |
|
Cookie expiration time in minutes. Returned: changed Sample: |
|
Cookie expiration time in seconds. Returned: changed Sample: |
|
The new HTTP Only value. Returned: changed Sample: |
|
The new Match Across Pools value. Returned: changed Sample: |
|
The new Match Across Services value. Returned: changed Sample: |
|
The new Match Across Virtuals value. Returned: changed Sample: |
|
The new Override Connection Limit value. Returned: changed Sample: |
|
The parent profile. Returned: changed Sample: |
|
The new Secure Cookie value. Returned: changed Sample: |
Authors
Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)