bigip_monitor_dns – Manage DNS monitors on a BIG-IP
bigip_monitor_dns – Manage DNS monitors on a BIG-IP
New in version 2.7.
Synopsis
- Manages DNS monitors on a BIG-IP.
Requirements
The below requirements are needed on the host that executes this module.
- f5-sdk >= 3.0.16
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
accept_rcode - |
|
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 | |
adaptive boolean |
|
Specifies whether adaptive response time monitoring is enabled for this monitor. When When | |
adaptive_limit - |
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 | ||
allowed_divergence_type - |
|
When specifying a new monitor, if When When | |
allowed_divergence_value - |
When specifying a new monitor, if | ||
answer_section_contains - |
|
Specifies the type of DNS query that the monitor sends. When creating a new monitor, if this value is not specified, the default value is When When When | |
description - |
The description of the monitor. | ||
interval - |
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 - |
IP address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be | ||
manual_resume boolean |
|
Specifies whether the system automatically changes the status of a resource to enabled at the next successful monitor check. If you set this option to When creating a new monitor, if this parameter is not specified, the default value is When When | |
name - / required |
Specifies the name of the monitor. | ||
parent - |
Default: "/Common/dns" |
The parent template of this monitor template. Once this value has been set, it cannot be changed. By default, this value is the | |
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
| ||
port - |
Port address part of the IP/port definition. If this parameter is not provided when creating a new monitor, then the default value will be Note that if specifying an IP address, a value between 1 and 65535 must be specified. | ||
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 | |
query_name - |
Specifies a query name for the monitor to use in a DNS query. | ||
query_type - |
|
Specifies the type of DNS query that the monitor sends. When creating a new monitor, if this parameter is not specified, the default value is When When | |
receive - |
Specifies the IP address that 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. | ||
reverse boolean |
|
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 | |
sampling_timespan - |
Specifies the length, in seconds, of the probe history window that the system uses to calculate the mean latency and standard deviation of a monitor probe. While this value can be configured when | ||
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 | |
time_until_up - |
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, then the default value will be | ||
timeout - |
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 number to any number you want, 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, then the default value will be | ||
transparent boolean |
|
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, then the default value will be | |
up_interval - |
Specifies the interval for the system to use to perform the health check when a resource is up. When When any other number, enables specification of 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 | ||
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 DNS monitor
bigip_monitor_dns:
name: DNS-UDP-V6
interval: 2
query_name: localhost
query_type: aaaa
up_interval: 5
adaptive: no
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
accept_rcode string |
changed |
RCODE required in the response for an up status.
Sample: no-error |
adaptive boolean |
changed |
Whether adaptive is enabled or not.
Sample: True |
adaptive_limit integer |
changed |
Absolute number of milliseconds that may not be exceeded by a monitor probe.
Sample: 200 |
allowed_divergence_type string |
changed |
Type of divergence used for adaptive response time monitoring.
Sample: absolute |
allowed_divergence_value integer |
changed |
Value of the type of divergence used for adaptive response time monitoring. May be
Sample: 25 |
answer_section_contains string |
changed |
Type of DNS query that the monitor sends.
Sample: query-type |
description string |
changed |
The description of the monitor.
Sample: Important Monitor |
interval integer |
changed |
The new interval in which to run the monitor check.
Sample: 2 |
ip string |
changed |
The new IP of IP/port definition.
Sample: 10.12.13.14 |
manual_resume string |
changed |
Whether the system automatically changes the status of a resource to enabled at the next successful monitor check.
Sample: query-type |
parent string |
changed |
New parent template of the monitor.
Sample: http |
port string |
changed |
Alias port or service for the monitor to check, on behalf of the pools or pool members with which the monitor is associated.
Sample: 80 |
query_name string |
changed |
Query name for the monitor to use in a DNS query.
Sample: foo |
query_type string |
changed |
Type of DNS query that the monitor sends. Either
Sample: aaaa |
receive string |
changed |
IP address that the monitor uses from the resource record sections of the DNS response.
Sample: 2.3.2.4 |
reverse boolean |
changed |
Whether the monitor operates in reverse mode.
Sample: True |
sampling_timespan integer |
changed |
Absolute number of milliseconds that may not be exceeded by a monitor probe.
Sample: 200 |
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 |
transparent boolean |
changed |
Whether the monitor operates in transparent mode.
|
up_interval integer |
changed |
Interval for the system to use to perform the health check when a resource is up.
|
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)
- Wojciech Wypior (@wojtek0806)
© 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_monitor_dns_module.html