W3cubDocs

/Ansible

community.general.ipwcli_dns – Manage DNS Records for Ericsson IPWorks via ipwcli

Note

This plugin is part of the community.general collection (version 3.8.1).

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 community.general.

To use it in a playbook, specify: community.general.ipwcli_dns.

New in version 0.2.0: of community.general

Synopsis

  • Manage DNS records for the Ericsson IPWorks DNS server. The module will use the ipwcli to deploy the DNS records.

Requirements

The below requirements are needed on the host that executes this module.

  • ipwcli (installed on Ericsson IPWorks)

Parameters

Parameter Choices/Defaults Comments
address
string
The IP address for the A or AAAA record.
Required for type=A or type=AAAA
container
string / required
Sets the container zone for the record.
dnsname
string / required
Name of the record.
flags
string
    Choices:
  • S
  • A
  • U
  • P
Sets one of the possible flags of NAPTR record.
Required for type=NAPTR
order
integer
Sets the order of the NAPTR record.
Required for type=NAPTR
password
string / required
Password to login on ipwcli.
port
integer
Sets the port of the SRV record.
Required for type=SRV
preference
integer
Sets the preference of the NAPTR record.
Required for type=NAPTR
priority
integer
Default:
10
Sets the priority of the SRV record.
replacement
string
Sets the replacement of the NAPTR record.
Required for type=NAPTR
service
string
Sets the service of the NAPTR record.
Required for type=NAPTR
state
string
    Choices:
  • absent
  • present ←
Whether the record should exist or not.
target
string
Sets the target of the SRV record.
Required for type=SRV
ttl
integer
Default:
3600
Sets the TTL of the record.
type
string / required
    Choices:
  • NAPTR
  • SRV
  • A
  • AAAA
Type of the record.
username
string / required
Username to login on ipwcli.
weight
integer
Default:
10
Sets the weight of the SRV record.

Notes

Note

  • To make the DNS record changes effective, you need to run update dnsserver on the ipwcli.

Examples

- name: Create A record
  community.general.ipwcli_dns:
    dnsname: example.com
    type: A
    container: ZoneOne
    address: 127.0.0.1

- name: Remove SRV record if exists
  community.general.ipwcli_dns:
    dnsname: _sip._tcp.test.example.com
    type: SRV
    container: ZoneOne
    ttl: 100
    state: absent
    target: example.com
    port: 5060

- name: Create NAPTR record
  community.general.ipwcli_dns:
    dnsname: test.example.com
    type: NAPTR
    preference: 10
    container: ZoneOne
    ttl: 100
    order: 10
    service: 'SIP+D2T'
    replacement: '_sip._tcp.test.example.com.'
    flags: S

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
record
string
always
The created record from the input params


Authors

  • Christian Wollinger (@cwollinger)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/ipwcli_dns_module.html