ngine_io.exoscale.exo_dns_domain – Manages domain records on Exoscale DNS API.
Note
This plugin is part of the ngine_io.exoscale collection (version 1.0.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 ngine_io.exoscale
.
To use it in a playbook, specify: ngine_io.exoscale.exo_dns_domain
.
New in version 0.1.0: of ngine_io.exoscale
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
Parameters
Parameter |
Comments |
---|---|
API key of the Exoscale DNS API. The ENV variable |
|
Name of the ini section in the The ENV variable Default: “cloudstack” |
|
Secret key of the Exoscale DNS API. The ENV variable |
|
HTTP timeout to Exoscale DNS API. The ENV variable Default: 10 |
|
Name of the record. |
|
State of the resource. Choices:
|
|
Validate SSL certs of the Exoscale DNS API. Choices:
|
Notes
Note
As Exoscale DNS uses the same API key and secret for all services, we reuse the config used for Exscale Compute based on CloudStack. The config is read from several locations, in the following order. The
CLOUDSTACK_KEY
,CLOUDSTACK_SECRET
environment variables. ACLOUDSTACK_CONFIG
environment variable pointing to an.ini
file, Acloudstack.ini
file in the current working directory. A.cloudstack.ini
file in the users home directory. Optionally multiple credentials and endpoints can be specified using ini sections incloudstack.ini
. Use the argumentapi_region
to select the section name, default section iscloudstack
.This module does not support multiple A records and will complain properly if you try.
More information Exoscale DNS can be found on https://community.exoscale.ch/documentation/dns/.
This module supports check mode and diff.
Examples
- name: Create a domain
exo_dns_domain:
name: example.com
- name: Remove a domain
exo_dns_domain:
name: example.com
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
API domain results Returned: success |
|
Your account ID Returned: success Sample: 34569 |
|
Whether domain is auto renewed or not Returned: success Sample: false |
|
When the domain was created Returned: success Sample: “2016-08-12T15:24:23.989Z” |
|
When the domain expires Returned: success Sample: “2016-08-12T15:24:23.989Z” |
|
ID of the domain Returned: success Sample: “2016-08-12T15:24:23.989Z” |
|
Whether the domain is lockable or not Returned: success Sample: true |
|
Domain name Returned: success Sample: “example.com” |
|
Number of records related to this domain Returned: success Sample: 5 |
|
ID of the registrant Returned: success |
|
Number of services Returned: success Sample: 0 |
|
State of the domain Returned: success Sample: “hosted” |
|
Token Returned: success Sample: “r4NzTRp6opIeFKfaFYvOd6MlhGyD07jl” |
|
Domain name as unicode Returned: success Sample: “example.com” |
|
When the domain was updated last. Returned: success Sample: “2016-08-12T15:24:23.989Z” |
|
ID of the user Returned: success |
|
Whether the whois is protected or not Returned: success Sample: false |
Authors
René Moser (@resmo)