infoblox.nios_modules.nios_dtc_lbdn module – Configure Infoblox NIOS DTC LBDN

Note

This module is part of the infoblox.nios_modules collection (version 1.9.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 infoblox.nios_modules. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: infoblox.nios_modules.nios_dtc_lbdn.

New in infoblox.nios_modules 1.1.0

Synopsis
Requirements
Parameters
Notes
Examples

Synopsis

Adds and/or removes instances of DTC Load Balanced Domain Name (LBDN) objects from Infoblox NIOS servers. This module manages NIOS dtc:lbdn objects using the Infoblox WAPI interface over REST.

Requirements

The below requirements are needed on the host that executes this module.

infoblox-client

Parameters

Parameter	Comments
auth_zones list / elements=any	List of linked authoritative zones. When using auth_zones, you must specify at least one patterns. Each zone can be specified as a string (FQDN) or as a dict with ‘fqdn’ and optional ‘view’ keys. When provided as a string, the first matching zone in any view will be used. When zones with the same name exist in different views, use the dict format to specify which view to use. Example [‘example.com’] or [{‘fqdn’: ‘example.com’, ‘view’: ‘custom’}]
comment string	Configures a text string comment to be associated with the instance of this object. The provided text string will be configured on the object instance.
extattrs dictionary	Allows for the configuration of Extensible Attributes on the instance of the object. This argument accepts a set of key / value pairs for configuration.
lb_method string / required	Configures the load balancing method. Used to select pool. Choices: `"GLOBAL_AVAILABILITY"` `"RATIO"` `"ROUND_ROBIN"` `"TOPOLOGY"`
name string / required	Specifies the display name of the DTC LBDN, not DNS related.
patterns list / elements=string	Specify LBDN wildcards for pattern match.
pools list / elements=dictionary	The pools used for load balancing.
pool string / required	Provide the name of the pool to link with
ratio integer	Provide the weight of the pool Default: `1`
provider dictionary	A dict object containing connection details.
cert string	Specifies the client certificate file with digest of x509 config for extra layer secure connection the remote instance of NIOS. Value can also be specified using `INFOBLOX_CERT` environment variable.
host string	Specifies the DNS host name or address for connecting to the remote instance of NIOS WAPI over REST Value can also be specified using `INFOBLOX_HOST` environment variable.
http_pool_connections integer	Insert decription here Default: `10`
http_pool_maxsize integer	Insert description here Default: `10`
http_request_timeout integer	The amount of time before to wait before receiving a response Value can also be specified using `INFOBLOX_HTTP_REQUEST_TIMEOUT` environment variable. Default: `10`
key string	Specifies private key file for encryption with the certificate in order to connect with remote instance of NIOS. Value can also be specified using `INFOBLOX_KEY` environment variable.
max_results integer	Specifies the maximum number of objects to be returned, if set to a negative number the appliance will return an error when the number of returned objects would exceed the setting. Value can also be specified using `INFOBLOX_MAX_RESULTS` environment variable. Default: `1000`
max_retries integer	Configures the number of attempted retries before the connection is declared usable Value can also be specified using `INFOBLOX_MAX_RETRIES` environment variable. Default: `3`
password string	Specifies the password to use to authenticate the connection to the remote instance of NIOS. Value can also be specified using `INFOBLOX_PASSWORD` environment variable.
silent_ssl_warnings boolean	Insert description here Choices: `false` `true` ← (default)
username string	Configures the username to use to authenticate the connection to the remote instance of NIOS. Value can also be specified using `INFOBLOX_USERNAME` environment variable.
validate_certs aliases: ssl_verify boolean	Boolean value to enable or disable verifying SSL certificates Value can also be specified using `INFOBLOX_SSL_VERIFY` environment variable. Choices: `false` ← (default) `true`
wapi_version string	Specifies the version of WAPI to use Value can also be specified using `INFOBLOX_WAPI_VERSION` environment variable. Until ansible 2.8 the default WAPI was 1.4 Default: `"2.12.3"`
state string	Configures the intended state of the instance of the object on the NIOS server. When this value is set to `present`, the object is configured on the device and when this value is set to `absent` the value is removed (if necessary) from the device. Choices: `"present"` ← (default) `"absent"`
topology string	Configures the topology rules for the `TOPOLOGY` load balancing method. Required only when lb_method is set to `TOPOLOGY`.
ttl integer	The Time To Live (TTL) value for the DTC LBDN. A 32-bit unsigned integer that represents the duration, in seconds, for which the record is valid (cached). Zero indicates that the record should not be cached.
types list / elements=string	Specifies the list of resource record types supported by LBDN. This option will work properly only if you set the `wapi_version` variable on your `provider` variable to a number higher than “2.6”. Choices: `"A"` `"AAAA"` `"CNAME"` `"NAPTR"` `"SRV"`

Notes

Note

This module supports check_mode.
This module must be run locally, which can be achieved by specifying connection: local.
Please read the :ref:`nios_guide` for more detailed information on how to use Infoblox with Ansible.

Examples

- name: Configure a DTC LBDN
  infoblox.nios_modules.nios_dtc_lbdn:
    name: web.ansible.com
    lb_method: ROUND_ROBIN
    pools:
      - pool: web_pool
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: Configure a DTC LBDN with zones from different views
  infoblox.nios_modules.nios_dtc_lbdn:
    name: web.ansible.com
    lb_method: ROUND_ROBIN
    auth_zones:
      - example.com                        # First matching zone in any view
      - {"fqdn": "test.com", "view": "default"}  # Explicitly from default view
      - {"fqdn": "demo.com", "view": "custom"}   # From custom view
    patterns:
      - "*.example.com"
      - "*.test.com"
      - "*.demo.com"
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: Add a comment to a DTC LBDN
  infoblox.nios_modules.nios_dtc_lbdn:
    name: web.ansible.com
    lb_method: ROUND_ROBIN
    comment: this is a test comment
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: Remove a DTC LBDN from the system
  infoblox.nios_modules.nios_dtc_lbdn:
    name: web.ansible.com
    lb_method: ROUND_ROBIN
    state: absent
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Authors

Mauricio Teixeira (@badnetmask)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/infoblox/nios_modules/nios_dtc_lbdn_module.html