/
DTC Pool
Document toolboxDocument toolbox

DTC Pool

Owned by Jyothi KP
Last updated: Dec 21, 2023
2 min read

Use the nios_dtc_pool module to create, update, or remove instances of the DTC pool object from a NIOS Grid. A DTC pool is a collection of local DNS resources (virtual servers).

The following table describes the parameters you can define in the nios_dtc_pool module:

Parameter

Required/Optional

Description

Parameter

Required/Optional

Description

name

Required

Specifies the name of the DTC pool that is displayed.

lb_preferred_method

Required

Specifies the preferred load balancing method that is used to select a method type from the pool.
Choose one of the following methods:

  • ALL_AVAILABLE

  • DYNAMIC_RATIO

  • GLOBAL_AVAILABILITY

  • RATIO

  • ROUND_ROBIN

  • TOPOLOGY

lb_preferred_topology

Optional

Specifies the topology ruleset for the TOPOLOGY load balancing method.
This field is required only when you set lb_preferred_method to TOPOLOGY.

servers

Optional

Specifies the DTC servers related to the DTC pool.
It is a dictionary object that contains server details. Define the following subparameters:

  • server (required): Specify the name of the DTC server.

  • ratio: Provide the weight of the server. The default value is 1.

monitors

Optional

Specifies the health monitors related to the DTC pool.
This is a dictionary object that contains the details about health monitoring.

For this option to work, you must set the wapi_version variable in the provider parameter to a value greater than 2.6.

Define the following subparameters:

  • name (required): Specify the name of the health monitor.

  • type (required): Specify the type of the health monitor:

    • http

    • icmp

    • tcp

    • pdp

    • sip

    • snmp

extattrs

Optional

Specifies extensible attributes for the DTC pool object.

state

Optional

Specifies the state of the DTC pool instance in NIOS.
Set one of the following values:

  • present (default): Configures the object.

  • absent: Removes the object.

comment

Optional

Describes the DTC pool object.

provider

Required

Defines the details of the connection:

  • host: The DNS host name or IP address to connect to the remote instance of NIOS.

  • username: The user name to use for authenticating the connection to the remote instance.

  • password: The Password to use for authenticating the connection to the remote instance.

For information on additional fields you can define, see the list of subparameters in the NIOS Modules for Ansible Collections topic.

connection

Required

The nios_dtc_pool module must be run locally.

Examples

name: Configure a DTC Pool
infoblox.nios_modules.nios_dtc_pool:
  name: web_pool
  lb_preferred_method: ROUND_ROBIN
  servers:
    - server: a.ansible.com
    - server: b.ansible.com
  state: present
  provider:
    host: <nios_hostname_or_hostip>
    username: <nios_username>
    password: <nios_password>
connection: local

 

name: Add a comment to a DTC Pool
infoblox.nios_modules.nios_dtc_pool:
  name: web.ansibletest.com
  lb_preferred_method: ROUND_ROBIN
  comment: this is a test comment
  state: present
  provider:
    host: <nios_hostname_or_hostip>
    username: <nios_username>
    password: <nios_password>
connection: local

 

name: Remove a DTC Pool from the system
infoblox.nios_modules.nios_dtc_pool:
name: web_pool
lb_preferred_method: ROUND_ROBIN
state: absent
provider:
host: "{{ inventory_hostname_short }}"
username: admin
password: admin
connection: local

Related content