New in version 2.6.
Parameter | Choices/Defaults | Comments |
---|---|---|
api_key
required |
The API key obtained from the Memset control panel.
|
|
force
bool |
|
Forces deletion of a zone and all zone domains/zone records it contains.
|
name
required |
The zone nickname; usually the same as the main domain. Ensure this value has at most 250 characters.
aliases: nickname |
|
state
required |
|
Indicates desired state of resource.
|
ttl |
|
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.
|
Note
# Create the zone 'test'
- name: create zone
memset_zone:
name: test
state: present
api_key: 5eb86c9196ab03919abcf03857163741
ttl: 300
delegate_to: localhost
# Force zone deletion
- name: force delete zone
memset_zone:
name: test
state: absent
api_key: 5eb86c9196ab03919abcf03857163741
force: true
delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
memset_api
complex
|
when state == present |
Zone info from the Memset API
|
|
domains
list
|
always |
List of domains in this zone
|
|
records
list
|
always |
List of DNS records for domains in this zone
|
|
nickname
string
|
always |
Zone name
Sample:
example.com
|
|
id
string
|
always |
Zone id
Sample:
b0bb1ce851aeea6feeb2dc32fe83bf9c
|
|
ttl
int
|
always |
Default TTL for domains in this zone
Sample:
300
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.