You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

f5networks.f5_modules.bigip_profile_persistence_src_addr module – Manage source address persistence profiles

Note

This module is part of the f5networks.f5_modules collection (version 1.17.0).

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_src_addr.

New in version 1.0.0: of f5networks.f5_modules

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis 

Manages source address persistence profiles on a BIG-IP.

Parameters 

Parameter	Comments
entry_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 `indefinite`. If specifying a numeric timeout, the value must be between `1` and `4294967295`.
hash_algorithm string	Specifies the algorithm the system uses for hash persistence load balancing. The hash result is the input for the algorithm. When `default`, specifies the system uses the index of pool members to obtain the hash result for the input to the algorithm. When `carp`, specifies the system uses the Cache Array Routing Protocol (CARP) to obtain the hash result for the input to the algorithm. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices: default carp
mask string	Specifies a value the system applies as the prefix length. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile.
match_across_pools boolean	When `yes`, specifies the system can use any pool that contains this persistence record. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices: no yes
match_across_services boolean	When `yes`, specifies all persistent connections from a client IP address that go to the same virtual IP address also go to the same node. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices: no yes
match_across_virtuals boolean	When `yes`, specifies all persistent connections from the same client IP address go to the same node. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices: no yes
mirror boolean	When `yes`, specifies that if the active unit goes into the standby mode, the system mirrors any persistence records to its peer. When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. Choices: no yes
name string / required	Specifies the name of the profile.
override_connection_limit boolean	When `yes`, specifies the system allows you to specify that pool member connection limits will be overridden for persisted clients. Per-virtual connection limits remain hard limits and are not overridden. Choices: no yes
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 `source_addr` profile.
partition string	Device partition to manage resources on. Default: “Common”
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 `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TELEMETRY_OFF`. Previously used variable `F5_TEEM` is deprecated as its name was confusing. Choices: no ← (default) yes
password aliases: pass, pwd 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 `F5_PASSWORD`.
server string / required	The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`.
server_port integer	The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`. Default: 443
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. Choices: rest ← (default)
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 `F5_USER`.
validate_certs boolean	If `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 `F5_VALIDATE_CERTS`. Choices: no yes ← (default)
state string	When `present`, ensures the profile exists. When `absent`, ensures the profile is removed. Choices: present ← (default) absent

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_src_addr:
    name: foo
    state: present
    hash_algorithm: carp
    match_across_services: yes
    match_across_virtuals: yes
    mirror: yes
    mask: 255.255.255.255
    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
entry_timeout string	The duration of the persistence entries. Returned: changed Sample: 180
hash_algorithm string	The algorithm used for hash persistence. Returned: changed Sample: “default”
mask string	The persist mask value. Returned: changed Sample: “255.255.255.255”
match_across_pools boolean	The new Match Across Pools value. Returned: changed Sample: true
match_across_services boolean	The new Match Across Services value. Returned: changed Sample: false
match_across_virtuals boolean	The new Match Across Virtuals value. Returned: changed Sample: true
mirror boolean	The new Mirror value. Returned: changed Sample: true
override_connection_limit boolean	The new Override Connection Limit value. Returned: changed Sample: false
parent string	The parent profile. Returned: changed Sample: “/Common/cookie”

Authors

Tim Rupp (@caphrim007)

Collection links

Issue Tracker Homepage Repository (Sources)

f5networks.f5_modules.bigip_profile_persistence_src_addr module – Manage source address persistence profiles

Synopsis

Parameters

Notes

Examples

Return Values