community.general.netcup_dns – manage Netcup DNS records¶
Note
This plugin is part of the community.general collection (version 2.5.1).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.netcup_dns
.
Synopsis¶
Manages DNS records via the Netcup API, see the docs https://ccp.netcup.net/run/webservice/servers/endpoint.php
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
string
/ required
|
API key for authentication, must be obtained via the netcup CCP (https://ccp.netcup.net)
|
|
api_password
string
/ required
|
API password for authentication, must be obtained via the netcup CCP (https://ccp.netcup.net)
|
|
customer_id
integer
/ required
|
Netcup customer id
|
|
domain
string
/ required
|
Domainname the records should be added / removed
|
|
priority
integer
|
Record priority. Required for
type=MX |
|
record
string
|
Default: "@"
|
Record to add or delete, supports wildcard (*). Default is
@ (e.g. the zone name)aliases: name |
solo
boolean
|
|
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
string
|
|
Whether the record should exist or not
|
type
string
/ required
|
|
Record type
|
value
string
/ required
|
Record value
|
Examples¶
- name: Create a record of type A
community.general.netcup_dns:
api_key: "..."
api_password: "..."
customer_id: "..."
domain: "example.com"
name: "mail"
type: "A"
value: "127.0.0.1"
- name: Delete that record
community.general.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
community.general.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
community.general.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
community.general.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:
Authors¶
Nicolai Buchwitz (@nbuchwitz)