digital_ocean_domain_facts - Gather facts about DigitalOcean Domains

New in version 2.6.

Synopsis

Requirements

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

  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
domain_name
Name of the domain to gather facts for.
oauth_token
DigitalOcean OAuth token.
There are several other environment variables which can be used to provide this value.
i.e., - 'DO_API_TOKEN', 'DO_API_KEY', 'DO_OAUTH_TOKEN' and 'OAUTH_TOKEN'

aliases: api_token
timeout Default:
30
The timeout in seconds used for polling DigitalOcean's API.
validate_certs
bool
    Choices:
  • no
  • yes ←
If set to no, the SSL certificates will not be validated.
This should only set to no used on personally controlled sites using self-signed certificates.

Examples

- name: Gather facts about all domains
  digital_ocean_domain_facts:
    oauth_token: "{{ oauth_token }}"

- name: Gather facts about domain with given name
  digital_ocean_domain_facts:
    oauth_token: "{{ oauth_token }}"
    domain_name: "example.com"

- name: Get ttl from domain
  digital_ocean_domain_facts:
  register: resp_out
- set_fact:
    domain_ttl: "{{ item.ttl }}"
  with_items: "{{ resp_out.data|json_query(name) }}"
  vars:
    name: "[?name=='example.com']"
- debug: var=domain_ttl

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
data
list
success
DigitalOcean Domain facts

Sample:
[{'name': 'myexample123.com', 'domain_records': [{'name': '@', 'weight': None, 'data': 'ns1.digitalocean.com', 'port': None, 'priority': None, 'tag': None, 'flags': None, 'ttl': 1800, 'type': 'NS', 'id': 37826823}], 'zone_file': 'myexample123.com. IN SOA ns1.digitalocean.com. hostmaster.myexample123.com. 1520702984 10800 3600 604800 1800 ', 'ttl': 1800}]


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

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.

Author

  • Abhijeet Kasurde (@Akasurde)

Hint

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