Note
This plugin is part of the f5networks.f5_modules collection (version 1.12.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_udp
.
New in version 1.0.0: of f5networks.f5_modules
udp
profile. Users of this module should be aware that many of the available options have no module default. Instead, the default is assigned by the BIG-IP system itself which, in most cases, is acceptable.Parameter | Choices/Defaults | Comments | |
---|---|---|---|
datagram_load_balancing boolean |
| When yes , specifies the system load balances UDP traffic packet-by-packet. | |
idle_timeout string | Specifies the length of time a connection is idle (has no traffic) before the connection is eligible for deletion. When creating a new profile, if this parameter is not specified, the remote device will choose a default value appropriate for the profile, based on its parent profile.When a number is specified, indicates the number of seconds the UDP connection can remain idle before the system deletes it. When indefinite , specifies UDP connections can remain idle indefinitely.When 0 or immediate , specifies you do not want the UDP connection to remain idle, and it is therefore immediately eligible for deletion. | ||
name string / required | Specifies the name of the profile. | ||
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 udp profile. | ||
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 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. | |
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 F5_PASSWORD .aliases: pass, pwd | ||
server string / required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER . | ||
server_port integer | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT . | |
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 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 . | |
state string |
| When present , ensures the profile exists.When absent , ensures the profile is removed. |
Note
- name: Create a TCP profile bigip_profile_tcp: name: foo parent: udp idle_timeout: 300 datagram_load_balancing: no state: present provider: user: admin password: secret server: lb.mydomain.com delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
datagram_load_balancing boolean | changed | The new datagram load balancing setting of the resource. Sample: True |
idle_timeout integer | changed | The new idle timeout of the resource. Sample: 100 |
parent string | changed | The new parent of the resource. Sample: udp |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_profile_udp_module.html