You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

infoblox.nios_modules.nios_dtc_server module – Configure Infoblox NIOS DTC Server

Note

This module is part of the infoblox.nios_modules collection (version 1.2.2).

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.

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

New in version 1.1.0: of infoblox.nios_modules

Synopsis
Requirements
Parameters
Notes
Examples

Synopsis 

Adds and/or removes instances of DTC Server objects from Infoblox NIOS servers. This module manages NIOS dtc:server 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
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.
disable boolean	Determines whether the DTC Server is disabled or not. When this is set to False, the fixed address is enabled. Choices: no ← (default) yes
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.
host string / required	Configures the IP address (A response) or FQDN (CNAME response) of the server
name string / required	Specifies the DTC Server display name
provider dictionary	A dict object containing connection details.
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
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: no yes ← (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: no ← (default) yes
wapi_version string	Specifies the version of WAPI to use Value can also be specified using `INFOBLOX_WAP_VERSION` environment variable. Until ansible 2.8 the default WAPI was 1.4 Default: “2.1”
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

Notes 

Note

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

Examples 

- name: Configure a DTC Server
  infoblox.nios_modules.nios_dtc_server:
    name: a.example.com
    host: 192.168.10.1
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: Add a comment to a DTC server
  infoblox.nios_modules.nios_dtc_server:
    name: a.example.com
    host: 192.168.10.1
    comment: this is a test comment
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: Remove a DTC Server from the system
  infoblox.nios_modules.nios_dtc_server:
    name: a.example.com
    host: 192.168.10.1
    state: absent
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Authors

Mauricio Teixeira (@badnetmask)

Collection links

Issue Tracker Homepage Repository (Sources)

infoblox.nios_modules.nios_dtc_server module – Configure Infoblox NIOS DTC Server

Synopsis

Requirements

Parameters

Notes

Examples