f5networks.f5_modules.bigip_monitor_dns module – Manage DNS monitors on a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.32.1).
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_monitor_dns
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages DNS health monitors on a BIG-IP.
Parameters
Parameter |
Comments |
---|---|
Specifies the RCODE required in the response for an up status. When creating a new monitor, if this parameter is not specified, the default value is When When If this parameter is set to Choices:
|
|
Specifies whether adaptive response time monitoring is enabled for this monitor. When When Choices:
|
|
Specifies the absolute number of milliseconds that may not be exceeded by a monitor probe, regardless of This value applies regardless of the value of the While this value can be configured when |
|
When specifying a new monitor, if When When Choices:
|
|
When specifying a new monitor, if |
|
Specifies the type of DNS query the monitor sends. When creating a new monitor, if this value is not specified, the default value is When When When Choices:
|
|
The description of the monitor. |
|
The interval specifying how frequently the monitor instance of this template will run. This value must be less than the When creating a new monitor, if this parameter is not provided, the default |
|
IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be |
|
Specifies whether the system automatically changes the status of a resource to enabled at the next successful monitor check. If When creating a new monitor, if this parameter is not specified, the default value is When When Choices:
|
|
Specifies the name of the monitor. |
|
The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the Default: |
|
Device partition to manage resources on. Default: |
|
Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, the default value will be Note that if specifying an IP address, you must use a value between 1 and 65535. |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
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 |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
|
Specifies a query name for the monitor to use in a DNS query. |
|
Specifies the type of DNS query the monitor sends. When creating a new monitor, if this parameter is not specified, the default value is When When Choices:
|
|
Specifies the IP address the monitor uses from the resource record sections of the DNS response. The IP address should be specified in the dotted-decimal notation or IPv6 notation. |
|
Specifies whether the monitor operates in reverse mode. When the monitor is in reverse mode, a successful receive string match marks the monitored object down instead of up. You can use the this mode only if you configure the This parameter is not compatible with the Choices:
|
|
Specifies the length, in seconds, of the probe history window the system uses to calculate the mean latency and standard deviation of a monitor probe. While this value can be configured when |
|
When When Choices:
|
|
Specifies the amount of time in seconds after the first successful response before a node will be marked up. A value of 0 will cause 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 will be |
|
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 |
|
Specifies whether the monitor operates in transparent mode. Monitors in transparent mode can monitor pool members through firewalls. When creating a new monitor, if this parameter is not provided, the default value is Choices:
|
|
Specifies the interval for the system to use to perform the health check when a resource is up. When When any other number, enables you to specify a different interval to use when checking the health of a resource that is up. When creating a new monitor, if this parameter is not provided, the default |
Notes
Note
For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
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 f5networks.f5_modules.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 DNS monitor
bigip_monitor_dns:
name: DNS-UDP-V6
interval: 2
query_name: localhost
query_type: aaaa
up_interval: 5
adaptive: false
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
RCODE required in the response for an up status. Returned: changed Sample: |
|
Whether adaptive is enabled or not. Returned: changed Sample: |
|
Absolute number of milliseconds that may not be exceeded by a monitor probe. Returned: changed Sample: |
|
Type of divergence used for adaptive response time monitoring. Returned: changed Sample: |
|
Value of the type of divergence used for adaptive response time monitoring. May be Returned: changed Sample: |
|
Type of DNS query that the monitor sends. Returned: changed Sample: |
|
The description of the monitor. Returned: changed Sample: |
|
The new interval in which to run the monitor check. Returned: changed Sample: |
|
The new IP of IP/port definition. Returned: changed Sample: |
|
Whether the system automatically changes the status of a resource to enabled at the next successful monitor check. Returned: changed Sample: |
|
New parent template of the monitor. Returned: changed Sample: |
|
Alias port or service for the monitor to check, on behalf of the pools or pool members with which the monitor is associated. Returned: changed Sample: |
|
Query name for the monitor to use in a DNS query. Returned: changed Sample: |
|
Type of DNS query the monitor sends. Either Returned: changed Sample: |
|
IP address the monitor uses from the resource record sections of the DNS response. Returned: changed Sample: |
|
Whether the monitor operates in reverse mode. Returned: changed Sample: |
|
Absolute number of milliseconds that may not be exceeded by a monitor probe. Returned: changed Sample: |
|
The new time in which to mark a system as up after first successful response. Returned: changed Sample: |
|
The new timeout in which the remote system must respond to the monitor. Returned: changed Sample: |
|
Whether the monitor operates in transparent mode. Returned: changed Sample: |
|
Interval for the system to use to perform the health check when a resource is up. Returned: changed Sample: |