community.general.memset_zone_domain module – Create and delete domains in Memset DNS zones
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
.
To use it in a playbook, specify: community.general.memset_zone_domain
.
Synopsis
Manage DNS zone domains in a Memset account.
Aliases: cloud.memset.memset_zone_domain
Parameters
Parameter |
Comments |
---|---|
The API key obtained from the Memset control panel. |
|
The zone domain name. Ensure this value has at most 250 characters. |
|
Indicates desired state of resource. Choices:
|
|
The zone to add the domain to (this must already exist). |
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
Zone domains can be thought of as a collection 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_domain_create
,dns.zone_domain_delete
,dns.zone_domain_list
.Currently this module can only create one domain at a time. Multiple domains should be created using
loop
.
Examples
# Create the zone domain 'test.com'
- name: Create zone domain
community.general.memset_zone_domain:
domain: test.com
zone: testzone
state: present
api_key: 5eb86c9196ab03919abcf03857163741
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Domain info from the Memset API Returned: when changed or state == present |
|
Domain name Returned: always Sample: |
|
Domain ID Returned: always Sample: |