f5networks.f5_modules.bigip_profile_persistence_universal – Manage universal persistence profiles
f5networks.f5_modules.bigip_profile_persistence_universal – Manage universal persistence profiles
Note
This plugin is part of the f5networks.f5_modules collection (version 1.7.1).
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 version 1.1.0: of f5networks.f5_modules
Synopsis
- Manages universal persistence profiles on the BIG-IP system.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
app_service string |
The iApp service to be associated with this profile. When no service is specified, the default is None. | ||
match_across_pools boolean |
|
When When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. | |
match_across_services boolean |
|
When When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. | |
match_across_virtuals boolean |
|
When When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. | |
mirror boolean |
|
When When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. | |
name string / required |
Specifies the name of the profile. | ||
override_connection_limit boolean |
|
When Per-virtual connection limits remain hard limits and are not overridden. | |
parent string |
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 | ||
partition string |
Default: "Common" |
Device partition to manage resources on. | |
provider dictionary added in 1.0.0 of f5networks.f5_modules |
A dict object containing connection details. | ||
auth_provider string |
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. | ||
no_f5_teem boolean |
|
If You may omit this option by setting the environment variable | |
password string / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| ||
server string / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port integer |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
timeout integer |
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. | ||
transport string |
|
Configures the transport connection to use when connecting to the remote device. | |
user string / required |
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | |
rule string |
Specifies the iRule used to select a persistence entry. When creating a new profile, if this parameter is not specified, the default is | ||
state string |
|
When When | |
timeout string |
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: yes
match_across_virtuals: yes
mirror: yes
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 | Returned | Description |
---|---|---|
app_service string |
changed |
The iApp service associated with this profile
Sample: /Common/good_service.app/good_service |
match_across_pools boolean |
changed |
The new Match Across Pools value.
Sample: True |
match_across_services boolean |
changed |
The new Match Across Services value.
|
match_across_virtuals boolean |
changed |
The new Match Across Virtuals value.
Sample: True |
mirror boolean |
changed |
The new Mirror value.
Sample: True |
override_connection_limit boolean |
changed |
The new Override Connection Limit value.
|
parent string |
changed |
The parent profile.
Sample: /Common/cookie |
rule string |
changed |
The iRule used to select persistence entry.
Sample: /Common/_sys_https_redirect |
timeout string |
changed |
The duration of the persistence entries.
Sample: 180 |
Authors
- Nitin Khanna (@nitinthewiz)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_profile_persistence_universal_module.html