community.general.digital_ocean_region_facts (0.1.4) — module

Gather information about DigitalOcean regions

Authors: Abhijeet Kasurde (@Akasurde)

Install collection

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


Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.4

Description

This module can be used to gather information about regions.

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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Gather information about all regions
  digital_ocean_region_info:
    oauth_token: "{{ oauth_token }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get Name of region where slug is known
  digital_ocean_region_info:
    oauth_token: "{{ oauth_token }}"
  register: resp_out
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- debug: var=resp_out
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- set_fact:
    region_slug: "{{ item.name }}"
  loop: "{{ resp_out.data|json_query(name) }}"
  vars:
    name: "[?slug==`nyc1`]"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- debug: var=region_slug

Inputs

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

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 regions information
  returned: success
  sample:
  - available: true
    features:
    - private_networking
    - backups
    - ipv6
    - metadata
    - install_agent
    - storage
    name: New York 1
    sizes:
    - 512mb
    - s-1vcpu-1gb
    - 1gb
    - s-3vcpu-1gb
    - s-1vcpu-2gb
    - s-2vcpu-2gb
    - 2gb
    - s-1vcpu-3gb
    - s-2vcpu-4gb
    - 4gb
    - c-2
    - m-1vcpu-8gb
    - 8gb
    - s-4vcpu-8gb
    - s-6vcpu-16gb
    - 16gb
    slug: nyc1
  type: list