bigip_gtm_dns_listener – Configures the BIG-IP DNS system to answer TCP or UDP DNS requests

New in version 1.4.0.

Synopsis

  • Defines one or more Listener objects to control which protocols are available for the BIG-IP DNS system to process DNS requests.
  • BIG-IP DNS Listeners allow TCP and UDP protocols.

Parameters

Parameter Choices/Defaults Configuration Comments
address
string / required
Specifies the IP address on which the system listens.
advertise
boolean
    Choices:
  • no
  • yes
Specifies whether this Listener's address is advertised to surrounding routers.
auto_lasthop
string
Specifies whether to automatically map the last hop for pools or not.
description
string
Provides a brief description for DNS Listener.
disabled_vlans
list / elements=string
List of VLANs to be disabled. If the partition is not specified in the VLAN, then the partition option of this module will be used.
This parameter is mutually exclusive with the enabled_vlans parameters.
enabled_vlans
list / elements=string
List of VLANs to be enabled. When a VLAN named all is used, all VLANs will be allowed. VLANs can be specified with or without the leading partition. If the partition is not specified in the VLAN, then the partition option of this module will be used.
This parameter is mutually exclusive with the disabled_vlans parameter.
fallback_persistence
string
Specifies a fallback persistence profile for the Listener to use when the default persistence profile is not available.
ip_protocol
string
Specifies the protocol on which this Listener receives network traffic.
irules
list / elements=string
Specifies list of iRules to run on the Listener.
iRules help automate the intercepting, processing, and routing of application traffic.
If you want to remove existing iRules, provide an empty list value; []. See the documentation for an example.
last_hop_pool
string
Specifies the name of the last hop pool that you want the Listener to use to direct reply traffic to the last hop router.
mask
string
Specifies the netmask for a network Listener only.
Netmask clarifies whether the host bit is an actual zero or a wildcard representation.
name
string / required
Specifies the name of the DNS Listener.
partition
string
Default:
"Common"
Device partition to manage resources on.
pool
string
Specifies a default pool to which the Listener automatically directs traffic.
port
integer
Specifies the port on which the Listener listens for connections.
Valid range of values is between 0 and 65535 inclusive.
provider
dictionary
added in 1.0.0
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
    Choices:
  • no
  • yes
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
    Choices:
  • rest ←
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
    Choices:
  • no
  • yes ←
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.
source_port
string
Specifies whether the system preserves the source port of the connection.
state
string
    Choices:
  • present ←
  • absent
  • enabled
  • disabled
DNS Listener state.
When present, ensures the pool is created and enabled.
When absent, ensures the pool is removed from the system.
When enabled or disabled, ensures the pool is enabled or disabled respectively) on the remote device.
translate_address
boolean
    Choices:
  • no
  • yes
Enables or disables address translation for the Listener.
translate_port
boolean
    Choices:
  • no
  • yes
Enables or disables port translation.

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 DNS Listener'
  bigip_gtm_dns_listener:
    address: '192.0.1.0'
    advertise: false
    auto_lasthop: default
    description: 'this is a test DNS listener'
    enabled_vlans:
      - /Common/external
    ip_protocol: tcp
    irules:
      - /Common/irule1
    mask: '255.255.255.0'
    pool: /Common/webpool
    name: test-dns-listener
    port: 30025
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
    source_port: preserve
    state: present
    translate_address: yes
    translate_port: yes
  delegate_to: localhost

- name: 'Disable a DNS Listener'
  bigip_gtm_dns_listener:
    address: '192.0.1.0'
    state: disabled
    name: test-dns-listener
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Return Values

The following are the fields unique to this module:

Key Returned Description
address
string
changed
IP address on which the system listens.

Sample:
10.0.0.2
advertise
boolean
changed
Specifies if the Listener advertises to surrounding routers.

Sample:
True
auto_lasthop
string
changed
Shows whether the system automatically maps the last hop for pools.

Sample:
default
disabled_vlans
list
changed
List of VLANs the virtual is disabled for.

Sample:
['/Common/vlan1', '/Common/vlan2']
enabled
boolean
changed
Provides DNS Listener state.

Sample:
True
enabled_vlans
list
changed
List of VLANs the virtual is enabled for.

Sample:
['/Common/vlan5', '/Common/vlan6']
fallback_persistence
string
changed
Fallback persistence profile for the Listener to use when the default persistence profile is not available.

Sample:
/Common/fallback-profile
ip_protocol
string
changed
IP protocol used by the DNS Listener.

Sample:
tcp
irules
list
changed
List of rules run by the DNS Listener.

Sample:
['/Common/rule1', '/Common/rule2']
mask
string
changed
Subnet mask used by the Listener to identify address range.

Sample:
255.255.0.0
name
string
changed
DNS Listener name.

Sample:
test-dns-listener
port
integer
changed
Port on which the system listens.

Sample:
53
source_port
string
changed
Specifies if system preserves the source port of the connection.

Sample:
preserve
translate_address
string
changed
Specifies if address translation is enabled.

Sample:
enabled
translate_port
string
changed
Specifies if port translation is enabled.

Sample:
enabled


Status

Authors

  • Andrey Kashcheev (@andreykashcheev)