community.general.digital_ocean_domain_info (0.2.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.2.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.2.1

Description

This module can be used to gather information about DigitalOcean provided Domains.

This module was called C(digital_ocean_domain_facts) before Ansible 2.9. The usage did not change.

Requirements

• python >= 2.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Gather information about all domains
  digital_ocean_domain_info:
    oauth_token: "{{ oauth_token }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get ttl from domain
  digital_ocean_domain_info:
  register: resp_out

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- set_fact:
    domain_ttl: "{{ item.ttl }}"
  loop: "{{ resp_out.data|json_query(name) }}"
  vars:
    name: "[?name=='example.com']"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- debug: var=domain_ttl

Inputs

    
timeout:
    default: 30
    description:
    - The timeout in seconds used for polling DigitalOcean's API.
    type: int

domain_name:
    description:
    - Name of the domain to gather information for.
    required: false

oauth_token:
    aliases:
    - api_token
    description:
    - 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'
    type: str

validate_certs:
    default: true
    description:
    - If set to C(no), the SSL certificates will not be validated.
    - This should only set to C(no) used on personally controlled sites using self-signed
      certificates.
    type: bool

Outputs

data:
  description: DigitalOcean Domain information
  returned: success
  sample:
  - domain_records:
    - data: ns1.digitalocean.com
      flags: null
      id: 37826823
      name: '@'
      port: null
      priority: null
      tag: null
      ttl: 1800
      type: NS
      weight: null
    name: myexample123.com
    ttl: 1800
    zone_file: 'myexample123.com. IN SOA ns1.digitalocean.com. hostmaster.myexample123.com.
      1520702984 10800 3600 604800 1800 '
  type: list