community.general.memset_zone_domain – Create and delete domains in Memset DNS zones.
Note
This plugin is part of the community.general collection (version 3.8.1).
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.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| api_key
string / required
|
The API key obtained from the Memset control panel.
|
|
| domain
string / required
|
The zone domain name. Ensure this value has at most 250 characters.
aliases: name |
|
| state
string
|
|
Indicates desired state of resource.
|
| zone
string / required
|
The zone to add the domain to (this must already exist).
|
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
with_items.
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 | Returned | Description | |
|---|---|---|---|
| memset_api
complex
|
when changed or state == present |
Domain info from the Memset API
|
|
| domain
string
|
always |
Domain name
Sample:
example.com
|
|
| id
string
|
always |
Domain ID
Sample:
b0bb1ce851aeea6feeb2dc32fe83bf9c
|
|
Authors
- Simon Weald (@glitchcrab)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/memset_zone_domain_module.html