ansible.builtin.nios_zone (v2.9.25) — module

Configure Infoblox NIOS DNS zones

| "added in version" 2.5 of ansible.builtin"

Authors: Peter Sprygada (@privateip)

preview | supported by certified

Install Ansible via pip

Install with pip install ansible==2.9.25

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: configure a zone on the system using grid primary and secondaries
  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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: configure a zone on the system using a name server group
  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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: configure a reverse mapping zone on the system using IPV4 zone format
  nios_zone:
    name: 10.10.10.0/24
    zone_format: IPV4
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: configure a reverse mapping zone on the system using IPV6 zone format
  nios_zone:
    name: 100::1/128
    zone_format: IPV6
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: update the comment and ext attributes for an existing zone
  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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: remove the dns zone
  nios_zone:
    name: ansible.com
    state: absent
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: remove the reverse mapping dns zone from the system with IPV4 zone format
  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

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.
    required: true

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.

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.

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.

ns_group:
    description:
    - Configures the name server group for this zone. Name server group is mutually exclusive
      with grid primary and grid secondaries.
    version_added: '2.6'
    version_added_collection: ansible.builtin

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_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
      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.
    version_added: '2.7'
    version_added_collection: ansible.builtin

grid_primary:
    description:
    - Configures the grid primary servers for this zone.
    suboptions:
      name:
        description:
        - The name of the grid primary server

grid_secondaries:
    description:
    - Configures the grid secondary servers for this zone.
    suboptions:
      name:
        description:
        - The name of the grid secondary server

restart_if_needed:
    description:
    - If set to true, causes the NIOS DNS service to restart and load the new zone configuration
    type: bool
    version_added: '2.6'
    version_added_collection: ansible.builtin