vultr_dns_domain - Manages DNS domains on Vultr.
- Create and remove DNS domains.
Aliases: vr_dns_domain
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
api_account
|
Default:
default
|
Name of the ini section in the vultr.ini file.
The ENV variable VULTR_API_ACCOUNT is used as default, when defined.
|
api_endpoint
|
|
URL to API endpint (without trailing slash).
The ENV variable VULTR_API_ENDPOINT is used as default, when defined.
|
api_key
|
|
API key of the Vultr API.
The ENV variable VULTR_API_KEY is used as default, when defined.
|
api_retries
|
|
Amount of retries in case of the Vultr API retuns an HTTP 503 code.
The ENV variable VULTR_API_RETRIES is used as default, when defined.
Fallback value is 5 retries if not specified.
|
api_timeout
|
|
HTTP timeout to Vultr API.
The ENV variable VULTR_API_TIMEOUT is used as default, when defined.
Fallback value is 60 seconds if not specified.
|
name
required |
|
The domain name.
aliases: domain
|
server_ip
|
|
The default server IP.
Use vultr_dns_record to change it once the domain is created.
Required if state=present .
|
state
|
Choices:
present ←
- absent
|
State of the DNS domain.
|
validate_certs
bool |
|
Validate SSL certs of the Vultr API.
|
- name: Ensure a domain exists
local_action:
module: vultr_dns_domain
name: example.com
server_ip: 10.10.10.10
- name: Ensure a domain is absent
local_action:
module: vultr_dns_domain
name: example.com
state: absent
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
vultr_api
complex
|
success |
Response from Vultr API with a few additions/modification
|
|
api_account
string
|
success |
Account used in the ini file to select the key
Sample:
default
|
|
api_timeout
int
|
success |
Timeout used for the API requests
Sample:
60
|
|
api_retries
int
|
success |
Amount of max retries for the API requests
Sample:
5
|
|
api_endpoint
string
|
success |
Endpoint used for the API requests
Sample:
https://api.vultr.com
|
vultr_dns_domain
complex
|
success |
Response from Vultr API
|
|
name
string
|
success |
Name of the DNS Domain.
Sample:
example.com
|
|
date_created
string
|
success |
Date the DNS domain was created.
Sample:
2017-08-26 12:47:48
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.