/ home / community / community.general / 3.8.10 / module / nios_zone

Deprecated

Removed in 5.0.0

community.general.nios_zone (3.8.10) — module

Configure Infoblox NIOS DNS zones

Authors: Peter Sprygada (@privateip)

Install collection

Install with ansible-galaxy collection install community.general:==3.8.10

Add to requirements.yml

  collections:
    - name: community.general
      version: 3.8.10

Description

Adds and/or removes instances of DNS zone objects from Infoblox NIOS servers. This module manages NIOS C(zone_auth) objects using the Infoblox WAPI interface over REST.

Requirements

infoblox-client

Usage examples

Scanned by Steampunk Spotter

- name: Configure a zone on the system using grid primary and secondaries
  community.general.nios_zone:
    name: ansible.com
    grid_primary:
      - name: gridprimary.grid.com
    grid_secondaries:
      - name: gridsecondary1.grid.com
      - name: gridsecondary2.grid.com
    restart_if_needed: true
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Scanned by Steampunk Spotter

- name: Configure a zone on the system using a name server group
  community.general.nios_zone:
    name: ansible.com
    ns_group: examplensg
    restart_if_needed: true
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Scanned by Steampunk Spotter

- name: Configure a reverse mapping zone on the system using IPV4 zone format
  community.general.nios_zone:
    name: 10.10.10.0/24
    zone_format: IPV4
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Scanned by Steampunk Spotter

- name: Configure a reverse mapping zone on the system using IPV6 zone format
  community.general.nios_zone:
    name: 100::1/128
    zone_format: IPV6
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Scanned by Steampunk Spotter

- name: Update the comment and ext attributes for an existing zone
  community.general.nios_zone:
    name: ansible.com
    comment: this is an example comment
    extattrs:
      Site: west-dc
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Scanned by Steampunk Spotter

- name: Remove the dns zone
  community.general.nios_zone:
    name: ansible.com
    state: absent
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Scanned by Steampunk Spotter

- name: Remove the reverse mapping dns zone from the system with IPV4 zone format
  community.general.nios_zone:
    name: 10.10.10.0/24
    zone_format: IPV4
    state: absent
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Inputs

fqdn:
aliases:
- name
description:
- Specifies the qualified domain name to either add or remove from the NIOS instance
based on the configured C(state) value.
required: true
type: str

view:
aliases:
- dns_view
default: default
description:
- Configures the DNS view name for the configured resource. The specified DNS zone
must already exist on the running NIOS instance prior to configuring zones.
type: str

state:
choices:
- present
- absent
default: present
description:
- Configures the intended state of the instance of the object on the NIOS server. When
this value is set to C(present), the object is configured on the device and when
this value is set to C(absent) the value is removed (if necessary) from the device.
type: str

comment:
description:
- 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.
type: str

extattrs:
description:
- Allows for the configuration of Extensible Attributes on the instance of the object. This
argument accepts a set of key / value pairs for configuration.
type: dict

ns_group:
description:
- Configures the name server group for this zone. Name server group is mutually exclusive
with grid primary and grid secondaries.
type: str

provider:
description:
- A dict object containing connection details.
suboptions:
host:
description:
- Specifies the DNS host name or address for connecting to the remote instance
of NIOS WAPI over REST
- Value can also be specified using C(INFOBLOX_HOST) environment variable.
type: str
http_pool_connections:
default: 10
description:
- Number of pools to be used by the C(infoblox_client.Connector) object.
- This is passed as-is to the underlying C(requests.adapters.HTTPAdapter) class.
type: int
http_pool_maxsize:
default: 10
description:
- Maximum number of connections per pool to be used by the C(infoblox_client.Connector)
object.
- This is passed as-is to the underlying C(requests.adapters.HTTPAdapter) class.
type: int
http_request_timeout:
default: 10
description:
- The amount of time before to wait before receiving a response
- Value can also be specified using C(INFOBLOX_HTTP_REQUEST_TIMEOUT) environment
variable.
type: int
max_results:
default: 1000
description:
- 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 C(INFOBLOX_MAX_RESULTS) environment variable.
type: int
max_retries:
default: 3
description:
- Configures the number of attempted retries before the connection is declared
usable
- Value can also be specified using C(INFOBLOX_MAX_RETRIES) environment variable.
type: int
password:
description:
- Specifies the password to use to authenticate the connection to the remote instance
of NIOS.
- Value can also be specified using C(INFOBLOX_PASSWORD) environment variable.
type: str
silent_ssl_warnings:
default: true
description:
- Disable C(urllib3) SSL warnings in the C(infoblox_client.Connector) object.
- This is passed as-is to the underlying C(requests.adapters.HTTPAdapter) class.
type: bool
username:
description:
- Configures the username to use to authenticate the connection to the remote
instance of NIOS.
- Value can also be specified using C(INFOBLOX_USERNAME) environment variable.
type: str
validate_certs:
aliases:
- ssl_verify
default: false
description:
- Boolean value to enable or disable verifying SSL certificates
- Value can also be specified using C(INFOBLOX_SSL_VERIFY) environment variable.
type: bool
wapi_version:
default: '2.1'
description:
- Specifies the version of WAPI to use
- Value can also be specified using C(INFOBLOX_WAP_VERSION) environment variable.
- Until ansible 2.8 the default WAPI was 1.4
type: str
type: dict

zone_format:
default: FORWARD
description:
- Create an authorative Reverse-Mapping Zone which is an area of network space for
which one or more name servers-primary and secondary-have the responsibility to
respond to address-to-name queries. It supports reverse-mapping zones for both IPv4
and IPv6 addresses.
type: str

grid_primary:
description:
- Configures the grid primary servers for this zone.
elements: dict
suboptions:
name:
description:
- The name of the grid primary server
required: true
type: str
type: list

grid_secondaries:
description:
- Configures the grid secondary servers for this zone.
elements: dict
suboptions:
name:
description:
- The name of the grid secondary server
required: true
type: str
type: list

restart_if_needed:
description:
- If set to true, causes the NIOS DNS service to restart and load the new zone configuration
type: bool