infoblox.nios_modules.nios_a_record module – Configure Infoblox NIOS A records

Note

This module is part of the infoblox.nios_modules collection (version 1.7.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_a_record.

New in infoblox.nios_modules 1.0.0

Synopsis 

Adds and/or removes instances of A record objects from Infoblox NIOS servers. This module manages NIOS record:a 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.
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.
ipv4addr aliases: ipv4 string / required	Configures the IPv4 address for this A record. Users can dynamically allocate ipv4 address to A record by passing dictionary containing, nios_next_ip and CIDR network range. Also update ipv4 address statically to A record by passing dictionary containing, old_ipv4addr and new_ipv4addr. See example.
name string / required	Specifies the fully qualified hostname to add or remove from the system. Users can also update the name as it is possible to pass a dict containing new_name, old_name. See examples.
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"`
ttl integer	Configures the TTL to be associated with this A record.
view aliases: dns_view string	Sets the DNS view to associate this A record with. The DNS view must already be configured on the system. Default: `"default"`

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 an A record
  infoblox.nios_modules.nios_a_record:
    name: a.ansible.com
    ipv4: 192.168.10.1
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: Add a comment to an existing A record
  infoblox.nios_modules.nios_a_record:
    name: a.ansible.com
    ipv4: 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 an A record from the system
  infoblox.nios_modules.nios_a_record:
    name: a.ansible.com
    ipv4: 192.168.10.1
    state: absent
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: Update an A record in custom view with a dynamic IP using nios_next_ip
  infoblox.nios_modules.nios_a_record:
    name: test.parent.com
    view: default.custom
    ipv4: {'old_ipv4addr': '10.0.0.5', nios_next_ip: 80.0.0.0/24}
    comment: this is a test comment
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: Update an A record with static ip
  infoblox.nios_modules.nios_a_record:
    name: test.parent.com
    view: default.custom
    ipv4: {'old_ipv4addr': '10.0.0.5', new_ipv4addr: '17.0.0.5'}
    comment: this is a test comment
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: Update an A record name
  infoblox.nios_modules.nios_a_record:
    name: {new_name: a_new.ansible.com, old_name: a.ansible.com}
    ipv4: 192.168.10.1
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

- name: Dynamically add a record to next available ip
  infoblox.nios_modules.nios_a_record:
    name: a.ansible.com
    ipv4: {nios_next_ip: 192.168.10.0/24}
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Authors

Blair Rampling (@brampling)

infoblox.nios_modules.nios_a_record module – Configure Infoblox NIOS A records

Synopsis

Requirements

Parameters

Notes

Examples