Note
This plugin is part of the f5networks.f5_modules collection.
To install it use: ansible-galaxy collection install f5networks.f5_modules.
To use it in a playbook, specify: f5networks.f5_modules.bigip_monitor_udp.
New in version 1.0.0: of f5networks.f5_modules
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| description string | The description of the monitor. | ||
| interval integer | The interval specifying how frequently the monitor instance of this template will run. If this parameter is not provided when creating a new monitor, the default value is 5. This value must be less than the timeout value. | ||
| ip string | IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '*'. | ||
| name string / required | Monitor name. | ||
| parent string | Default: "/Common/udp" | The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the udp parent on the Common partition. | |
| partition string | Default: "Common" | Device partition to manage resources on. | |
| port string | Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value is '*'. If specifying an IP address, you must specify a value between 1 and 65535. | ||
| 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_TEEM. | |
| 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. | |
| receive string | The Receive string for the monitor call. | ||
| receive_disable string | This setting works like receive, except the system marks the node or pool member disabled when its response matches the receive_disable string but not receive. To use this setting, you must specify both receive_disable and receive. | ||
| send string | The Send string for the monitor call. When creating a new monitor, if this value is not provided, the default default send string is used. | ||
| state string |
| When present, ensures the monitor exists.When absent, ensures the monitor is removed. | |
| time_until_up integer | Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of 0 causes a node to be marked up immediately after a valid response is received from the node. If this parameter is not provided when creating a new monitor, the default value is 0. | ||
| timeout integer | The number of seconds in which the node or service must respond to the monitor request. If the target responds within the set time period, it is considered 'up'. If the target does not respond within the set time period, it is considered 'down'. You can change this to any number, however it should be 3 times the interval number of seconds plus 1 second. If this parameter is not provided when creating a new monitor, the default value is 16. | ||
Note
- name: Create UDP Monitor
bigip_monitor_udp:
state: present
ip: 10.10.10.10
name: my_udp_monitor
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Remove UDP Monitor
bigip_monitor_udp:
state: absent
name: my_udp_monitor
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| description string | changed | The description of the monitor. Sample: Important Monitor |
| interval integer | changed | The new interval at which to run the monitor check. Sample: 2 |
| ip string | changed | The new IP of IP/port definition. Sample: 10.12.13.14 |
| parent string | changed | New parent template of the monitor. Sample: http |
| time_until_up integer | changed | The new time in which to mark a system as up after first successful response. Sample: 2 |
| timeout integer | changed | The new timeout in which the remote system must respond to the monitor. Sample: 10 |
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_monitor_udp_module.html