netcup_dns – manage Netcup DNS records

From Get docs
Ansible/docs/2.8/modules/netcup dns module


netcup_dns – manage Netcup DNS records

New in version 2.7.0.


Synopsis

Requirements

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

  • nc-dnsapi >= 0.1.3

Parameters

Parameter Choices/Defaults Comments

api_key

- / required

API key for authentification, must be obtained via the netcup CCP (https://ccp.netcup.net)

api_password

- / required

API password for authentification, must be obtained via the netcup CCP (https://ccp.netcup.net)

customer_id

- / required

Netcup customer id

domain

- / required

Domainname the records should be added / removed

priority

-

Record priority. Required for type=MX

record

-

Default:

"@"

Record to add or delete, supports wildcard (*). Default is @ (e.g. the zone name)


aliases: name

solo

boolean

  • no

  • yes

Whether the record should be the only one for that record type and record name. Only use with state=present

This will delete all other records with the same record name and type.

state

-

  • present

  • absent

Whether the record should exist or not

type

- / required

  • A
  • AAAA
  • MX
  • CNAME
  • CAA
  • SRV
  • TXT
  • TLSA
  • NS
  • DS

Record type

value

- / required

Record value



Examples

- name: Create a record of type A
  netcup_dns:
    api_key: "..."
    api_password: "..."
    customer_id: "..."
    domain: "example.com"
    name: "mail"
    type: "A"
    value: "127.0.0.1"

- name: Delete that record
  netcup_dns:
    api_key: "..."
    api_password: "..."
    customer_id: "..."
    domain: "example.com"
    name: "mail"
    type: "A"
    value: "127.0.0.1"
    state: absent

- name: Create a wildcard record
  netcup_dns:
    api_key: "..."
    api_password: "..."
    customer_id: "..."
    domain: "example.com"
    name: "*"
    type: "A"
    value: "127.0.1.1"

- name: Set the MX record for example.com
  netcup_dns:
    api_key: "..."
    api_password: "..."
    customer_id: "..."
    domain: "example.com"
    type: "MX"
    value: "mail.example.com"

- name: Set a record and ensure that this is the only one
  netcup_dns:
    api_key: "..."
    api_password: "..."
    customer_id: "..."
    name: "demo"
    domain: "example.com"
    type: "AAAA"
    value: "::1"
    solo: true

Return Values

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

Key Returned Description

records

complex

success

list containing all records


id

integer

success

internal id of the record


Sample:

12345

name

string

success

the record name


Sample:

fancy-hostname

priority

integer

success

the record priority (only relevant if type=MX)


type

string

succcess

the record type


Sample:

A

value

string

success

the record destination


Sample:

127.0.0.1




Status

Authors

  • Nicolai Buchwitz (@nbuchwitz)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/netcup_dns_module.html