Try SpotterManage source address persistence profiles
| "added in version" 1.0.0 of f5networks.f5_modules"
Authors: Tim Rupp (@caphrim007)
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections:
- name: f5networks.f5_modules
version: 1.28.0Manages source address persistence profiles on a BIG-IP.
- name: Create a profile
bigip_profile_persistence_src_addr:
name: foo
state: present
hash_algorithm: carp
match_across_services: true
match_across_virtuals: true
mirror: true
mask: 255.255.255.255
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
mask:
description:
- 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.
type: str
name:
description:
- Specifies the name of the profile.
required: true
type: str
state:
choices:
- present
- absent
default: present
description:
- When C(present), ensures the profile exists.
- When C(absent), ensures the profile is removed.
type: str
mirror:
description:
- When C(true), 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.
type: bool
parent:
description:
- 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 C(source_addr) profile.
type: str
provider:
description:
- A dict object containing connection details.
suboptions:
auth_provider:
description:
- Configures the auth provider for to obtain authentication tokens from the remote
device.
- This option is really used when working with BIG-IQ devices.
type: str
no_f5_teem:
default: false
description:
- If C(yes), TEEM telemetry data is not sent to F5.
- You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
- Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
type: bool
password:
aliases:
- pass
- pwd
description:
- 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 C(F5_PASSWORD).
required: true
type: str
server:
description:
- The BIG-IP host or the BIG-IQ host.
- You may omit this option by setting the environment variable C(F5_SERVER).
required: true
type: str
server_port:
default: 443
description:
- The BIG-IP server port.
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
type: int
timeout:
description:
- 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.
type: int
transport:
choices:
- rest
default: rest
description:
- Configures the transport connection to use when connecting to the remote device.
type: str
user:
description:
- 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 C(F5_USER).
required: true
type: str
validate_certs:
default: true
description:
- If C(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 C(F5_VALIDATE_CERTS).
type: bool
type: dict
version_added: 1.0.0
version_added_collection: f5networks.f5_modules
partition:
default: Common
description:
- Device partition to manage resources on.
type: str
entry_timeout:
description:
- 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 C(indefinite).
- If specifying a numeric timeout, the value must be between C(1) and C(4294967295).
type: str
hash_algorithm:
choices:
- default
- carp
description:
- Specifies the algorithm the system uses for hash persistence load balancing. The
hash result is the input for the algorithm.
- When C(default), specifies the system uses the index of pool members to obtain the
hash result for the input to the algorithm.
- When C(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.
type: str
match_across_pools:
description:
- When C(true), 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.
type: bool
match_across_services:
description:
- When C(true), 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.
type: bool
match_across_virtuals:
description:
- When C(true), 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.
type: bool
override_connection_limit:
description:
- When C(true), 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.
type: bool
entry_timeout: description: The duration of the persistence entries. returned: changed sample: 180 type: str hash_algorithm: description: The algorithm used for hash persistence. returned: changed sample: default type: str mask: description: The persist mask value. returned: changed sample: 255.255.255.255 type: str match_across_pools: description: The new Match Across Pools value. returned: changed sample: true type: bool match_across_services: description: The new Match Across Services value. returned: changed sample: false type: bool match_across_virtuals: description: The new Match Across Virtuals value. returned: changed sample: true type: bool mirror: description: The new Mirror value. returned: changed sample: true type: bool override_connection_limit: description: The new Override Connection Limit value. returned: changed sample: false type: bool parent: description: The parent profile. returned: changed sample: /Common/cookie type: str