community.general.memset_zone – Creates and deletes Memset DNS zones.¶
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.memset_zone
.
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
api_key
string
/ required
|
The API key obtained from the Memset control panel.
|
|
force
boolean
|
|
Forces deletion of a zone and all zone domains/zone records it contains.
|
name
string
/ required
|
The zone nickname; usually the same as the main domain. Ensure this value has at most 250 characters.
aliases: nickname |
|
state
string
/ required
|
|
Indicates desired state of resource.
|
ttl
integer
|
|
The default TTL for all records created in the zone. This must be a valid int from https://www.memset.com/apidocs/methods_dns.html#dns.zone_create.
|
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.
Examples¶
# Create the zone 'test'
- name: Create zone
community.general.memset_zone:
name: test
state: present
api_key: 5eb86c9196ab03919abcf03857163741
ttl: 300
delegate_to: localhost
# Force zone deletion
- name: Force delete zone
community.general.memset_zone:
name: test
state: absent
api_key: 5eb86c9196ab03919abcf03857163741
force: true
delegate_to: localhost
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Simon Weald (@glitchcrab)