Steampunk Ansible Documentation - infoblox.nios_modules.nios_cname_record (1.6.1) - module

Install collection

Install with ansible-galaxy collection install infoblox.nios_modules:==1.6.1

Add to requirements.yml

  collections:
    - name: infoblox.nios_modules
      version: 1.6.1

Description

Adds and/or removes instances of CNAME record objects from Infoblox NIOS servers. This module manages NIOS C(record:cname) objects using the Infoblox WAPI interface over REST.

Requirements

infoblox-client

Usage examples

Scanned by Steampunk Spotter

- name: Configure a CNAME record
  infoblox.nios_modules.nios_cname_record:
    name: cname.ansible.com
    canonical: realhost.ansible.com
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Scanned by Steampunk Spotter

- name: Add a comment to an existing CNAME record
  infoblox.nios_modules.nios_cname_record:
    name: cname.ansible.com
    canonical: realhost.ansible.com
    comment: this is a test comment
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Scanned by Steampunk Spotter

- name: Update name of CNAME record
  infoblox.nios_modules.nios_cname_record:
    name: {old_name: cname.ansibletestzone.com, new_name: demo.ansibletestzone.com}
    canonical: realhost.ansible.com
    state: present
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Scanned by Steampunk Spotter

- name: Remove a CNAME record from the system
  infoblox.nios_modules.nios_cname_record:
    name: cname.ansible.com
    canonical: realhost.ansible.com
    state: absent
    provider:
      host: "{{ inventory_hostname_short }}"
      username: admin
      password: admin
  connection: local

Inputs

ttl:
description:
- Configures the TTL to be associated with this CNAME record.
type: int

name:
description:
- Specifies the fully qualified hostname to add or remove from the system. User can
also update the name as it is possible to pass a dict containing I(new_name), I(old_name).
See examples
required: true
type: str

view:
aliases:
- dns_view
default: default
description:
- Sets the DNS view to associate this CNAME record with. The DNS view must already
be configured on the system.
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

provider:
description:
- A dict object containing connection details.
suboptions:
cert:
description:
- 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 C(INFOBLOX_CERT) environment variable.
type: str
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:
- Insert decription here
type: int
http_pool_maxsize:
default: 10
description:
- Insert description here
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
key:
description:
- Specifies private key file for encryption with the certificate in order to connect
with remote instance of NIOS.
- Value can also be specified using C(INFOBLOX_KEY) environment variable.
type: str
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:
- Insert description here
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.9'
description:
- Specifies the version of WAPI to use
- Value can also be specified using C(INFOBLOX_WAPI_VERSION) environment variable.
- Until ansible 2.8 the default WAPI was 1.4
type: str
type: dict

canonical:
aliases:
- cname
description:
- Configures the canonical name for this CNAME record.
required: true
type: str