bigip_profile_persistence_src_addr – Manage source address persistence profiles
bigip_profile_persistence_src_addr – Manage source address persistence profiles
New in version 2.7.
Synopsis
- Manages source address persistence profiles.
Requirements
The below requirements are needed on the host that executes this module.
- f5-sdk >= 3.0.16
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
entry_timeout - |
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 | ||
hash_algorithm - |
|
Specifies the algorithm the system uses for hash persistence load balancing. The hash result is the input for the algorithm. When When When creating a new profile, if this parameter is not specified, the default is provided by the parent profile. | |
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. | |
name - / required |
Specifies the name of the profile. | ||
override_connection_limit boolean |
|
When Per-virtual connection limits remain hard limits and are not overridden. | |
parent - |
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 - |
Default: "Common" |
Device partition to manage resources on. | |
password - / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| ||
provider - added in 2.5 |
Default: null |
A dict object containing connection details. | |
password - / 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 - / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port - |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
ssh_keyfile - |
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable | ||
timeout - |
Default: 10 |
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 - / required |
|
Configures the transport connection to use when connecting to the remote device. | |
user - / 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 | |
server - / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port - added in 2.2 |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
state - |
|
When When | |
user - / 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 added in 2.0 |
|
If You may omit this option by setting the environment variable |
Notes
Note
- For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
- Requires the f5-sdk Python package on the host. This is as easy as
pip install f5-sdk
. - 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 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
password: secret
server: lb.mydomain.com
state: present
user: admin
hash_algorithm: carp
match_across_services: yes
match_across_virtuals: yes
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
param1 boolean |
changed |
The new param1 value of the resource.
Sample: True |
param2 string |
changed |
The new param2 value of the resource.
Sample: Foo is bar |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors
- Tim Rupp (@caphrim007)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_profile_persistence_src_addr_module.html