vultr_dns_domain – Manages DNS domains on Vultr

From Get docs
Ansible/docs/2.8/modules/vultr dns domain module


vultr_dns_domain – Manages DNS domains on Vultr

New in version 2.5.


Synopsis

  • Create and remove DNS domains.

Aliases: vr_dns_domain

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments

api_account

string

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

string

URL to API endpint (without trailing slash).

The ENV variable VULTR_API_ENDPOINT is used as default, when defined.

Fallback value is https://api.vultr.com if not specified.

api_key

string

API key of the Vultr API.

The ENV variable VULTR_API_KEY is used as default, when defined.

api_retries

integer

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

integer

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

-

  • present

  • absent

State of the DNS domain.

validate_certs

boolean

  • no
  • yes

Validate SSL certs of the Vultr API.



Notes

Note


Examples

- 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

Return Values

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_endpoint

string

success

Endpoint used for the API requests


Sample:

api_retries

integer

success

Amount of max retries for the API requests


Sample:

5

api_timeout

integer

success

Timeout used for the API requests


Sample:

60

vultr_dns_domain

complex

success

Response from Vultr API


date_created

string

success

Date the DNS domain was created.


Sample:

2017-08-26 12:47:48

name

string

success

Name of the DNS Domain.


Sample:

example.com




Status

Authors

  • René Moser (@resmo)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/vultr_dns_domain_module.html