New in version 2.7.
The below requirements are needed on the host that executes this module.
| 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 indefinite.If specifying a numeric timeout, the value must be between 1 and 4294967295. | ||
| hash_algorithm |
| Specifies the algorithm the system uses for hash persistence load balancing. The hash result is the input for the algorithm. When default, specifies that the system uses the index of pool members to obtain the hash result for the input to the algorithm.When carp, specifies that 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. | |
| match_across_pools bool |
| When yes, specifies that 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. | |
| match_across_services bool |
| When yes, specifies that 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. | |
| match_across_virtuals bool |
| When yes, specifies that 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. | |
| name required | Specifies the name of the profile. | ||
| override_connection_limit bool |
| When yes, specifies that 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. | |
| 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 source_addr profile. | ||
| 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 F5_PASSWORD.aliases: pass, pwd | ||
| provider (added in 2.5) | Default: None | A dict object containing connection details. | |
| 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 ANSIBLE_NET_SSH_KEYFILE. | ||
| 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. | |
| server required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER. | ||
| 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 F5_USER. | ||
| server_port | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT. | |
| 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 F5_PASSWORD.aliases: pass, pwd | ||
| validate_certs bool |
| 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. | |
| transport required |
| Configures the transport connection to use when connecting to the remote device. | |
| server required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER. | ||
| server_port (added in 2.2) | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT. | |
| state |
| When present, ensures that the profile exists.When absent, ensures the profile is removed. | |
| 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 F5_USER. | ||
| validate_certs bool (added in 2.0) |
| 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. | |
Note
pip install f5-sdk.- 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
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| param1 bool | changed | The new param1 value of the resource. Sample: True |
| param2 string | changed | The new param2 value of the resource. Sample: Foo is bar |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 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