community.general.memset_zone_record module – Create and delete records in Memset DNS zones
Note
This module is part of the community.general collection (version 9.5.0).
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.memset_zone_record
.
Synopsis
Manage DNS records in a Memset account.
Parameters
Parameter |
Comments |
---|---|
The address for this record (can be IP or text string depending on record type). |
|
The API key obtained from the Memset control panel. |
|
Default: |
|
The subdomain to create. Default: |
|
If set then the current domain is added onto the address field for Choices:
|
|
Indicates desired state of resource. Choices:
|
|
The record’s TTL in seconds (will inherit zone’s TTL if not explicitly set). This must be a valid int from https://www.memset.com/apidocs/methods_dns.html#dns.zone_record_create. Choices:
|
|
The type of DNS record to create. Choices:
|
|
The name of the zone to which to add the record to. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
Zones can be thought of as a logical group of domains, all of which share the same DNS records (i.e. they point to the same IP). An API key generated via the Memset customer control panel is needed with the following minimum scope -
dns.zone_create
,dns.zone_delete
,dns.zone_list
.Currently this module can only create one DNS record at a time. Multiple records should be created using
loop
.
Examples
# Create DNS record for www.domain.com
- name: Create DNS record
community.general.memset_zone_record:
api_key: dcf089a2896940da9ffefb307ef49ccd
state: present
zone: domain.com
type: A
record: www
address: 1.2.3.4
ttl: 300
relative: false
delegate_to: localhost
# create an SPF record for domain.com
- name: Create SPF record for domain.com
community.general.memset_zone_record:
api_key: dcf089a2896940da9ffefb307ef49ccd
state: present
zone: domain.com
type: TXT
address: "v=spf1 +a +mx +ip4:a1.2.3.4 ?all"
delegate_to: localhost
# create multiple DNS records
- name: Create multiple DNS records
community.general.memset_zone_record:
api_key: dcf089a2896940da9ffefb307ef49ccd
zone: "{{ item.zone }}"
type: "{{ item.type }}"
record: "{{ item.record }}"
address: "{{ item.address }}"
delegate_to: localhost
with_items:
- { 'zone': 'domain1.com', 'type': 'A', 'record': 'www', 'address': '1.2.3.4' }
- { 'zone': 'domain2.com', 'type': 'A', 'record': 'mail', 'address': '4.3.2.1' }
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Record info from the Memset API. Returned: when state == present |
|
Record content (may be an IP, string or blank depending on record type). Returned: always Sample: |
|
Record ID. Returned: always Sample: |
|
Priority for Returned: always Sample: |
|
Name of record. Returned: always Sample: |
|
Adds the current domain onto the address field for Returned: always Sample: |
|
Record TTL. Returned: always Sample: |
|
Record type. Returned: always Sample: |
|
Zone ID. Returned: always Sample: |