community.digitalocean.digital_ocean_domain_info – Gather information about DigitalOcean Domains
Note
This plugin is part of the community.digitalocean collection (version 1.11.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 community.digitalocean
.
To use it in a playbook, specify: community.digitalocean.digital_ocean_domain_info
.
Synopsis
- This module can be used to gather information about DigitalOcean provided Domains.
- This module was called
digital_ocean_domain_facts
before Ansible 2.9. The usage did not change.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
domain_name string | Name of the domain to gather information for. | |
oauth_token string | 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 integer | Default: 30 | The timeout in seconds used for polling DigitalOcean's API. |
validate_certs boolean |
| 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 information about all domains community.digitalocean.digital_ocean_domain_info: oauth_token: "{{ oauth_token }}" - name: Gather information about domain with given name community.digitalocean.digital_ocean_domain_info: oauth_token: "{{ oauth_token }}" domain_name: "example.com" - name: Get ttl from domain community.digitalocean.digital_ocean_domain_info: register: resp_out - set_fact: domain_ttl: "{{ item.ttl }}" loop: "{{ resp_out.data | community.general.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 / elements=dictionary | success | DigitalOcean Domain information Sample: [{'domain_records': [{'data': 'ns1.digitalocean.com', 'flags': None, 'id': 37826823, 'name': '@', 'port': None, 'priority': None, 'tag': None, 'ttl': 1800, 'type': 'NS', 'weight': None}], 'name': 'myexample123.com', 'ttl': 1800, 'zone_file': 'myexample123.com. IN SOA ns1.digitalocean.com. hostmaster.myexample123.com. 1520702984 10800 3600 604800 1800\n'}] |
Authors
- Abhijeet Kasurde (@Akasurde)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/digitalocean/digital_ocean_domain_info_module.html