community.general.netcup_dns module – Manage Netcup DNS records
Note
This module is part of the community.general collection (version 8.6.4).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
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.
Aliases: net_tools.netcup_dns
Requirements
The below requirements are needed on the host that executes this module.
nc-dnsapi >= 0.1.3
Parameters
Parameter |
Comments |
---|---|
API key for authentication, must be obtained via the netcup CCP (https://ccp.netcup.net). |
|
API password for authentication, must be obtained via the netcup CCP (https://ccp.netcup.net). |
|
Netcup customer id. |
|
Domainname the records should be added / removed. |
|
Record priority. Required for |
|
Record to add or delete, supports wildcard ( Default: |
|
Whether the record should be the only one for that record type and record name. Only use with This will delete all other records with the same record name and type. Choices:
|
|
Whether the record should exist or not. Choices:
|
|
HTTP(S) connection timeout in seconds. Default: |
|
Record type. Support for Record types Record type Choices:
|
|
Record value. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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
- name: Increase the connection timeout to avoid problems with an unstable connection
community.general.netcup_dns:
api_key: "..."
api_password: "..."
customer_id: "..."
domain: "example.com"
name: "mail"
type: "A"
value: "127.0.0.1"
timeout: 30
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
list containing all records Returned: success |
|
internal id of the record Returned: success Sample: |
|
the record name Returned: success Sample: |
|
the record priority (only relevant if type=MX) Returned: success Sample: |
|
the record type Returned: success Sample: |
|
the record destination Returned: success Sample: |