f5networks.f5_modules.bigip_profile_persistence_universal module – Manage universal persistence profiles
Note
This module is part of the f5networks.f5_modules collection (version 1.30.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_universal
.
New in f5networks.f5_modules 1.1.0
Synopsis
Manages universal persistence profiles on the BIG-IP system.
Parameters
Parameter |
Comments |
---|---|
The iApp service to be associated with this profile. When no service is specified, the default is None. |
|
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:
|
|
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 |
|
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 the iRule used to select a persistence entry. When creating a new profile, if this parameter is not specified, the default is |
|
When When Choices:
|
|
Specifies the duration of the persistence entries. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. To specify an indefinite timeout, use the value If specifying a numeric timeout, the value must be between |
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 profile
bigip_profile_persistence_universal:
name: foo
state: present
match_across_services: true
match_across_virtuals: true
mirror: true
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 iApp service associated with this profile 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 Mirror value. Returned: changed Sample: |
|
The new Override Connection Limit value. Returned: changed Sample: |
|
The parent profile. Returned: changed Sample: |
|
The iRule used to select persistence entry. Returned: changed Sample: |
|
The duration of the persistence entries. Returned: changed Sample: |