ansible.builtin.digital_ocean_image_facts (v2.8.13) — module

Install Ansible via pip

Install with pip install ansible==2.8.13

Description

This module can be used to gather facts about DigitalOcean provided images.

These images can be either of type C(distribution), C(application) and C(private).

Requirements

• python >= 2.6

Usage examples

Scanned by Steampunk Spotter

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

- name: Gather facts about all images
  digital_ocean_image_facts:
    image_type: all
    oauth_token: "{{ oauth_token }}"

Scanned by Steampunk Spotter

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

- name: Gather facts about application images
  digital_ocean_image_facts:
    image_type: application
    oauth_token: "{{ oauth_token }}"

Scanned by Steampunk Spotter

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

- name: Gather facts about distribution images
  digital_ocean_image_facts:
    image_type: distribution
    oauth_token: "{{ oauth_token }}"

Scanned by Steampunk Spotter

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

- name: Get distribution about image with slug coreos-beta
  digital_ocean_image_facts:
  register: resp_out

Scanned by Steampunk Spotter

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

- set_fact:
    distribution_name: "{{ item.distribution }}"
  loop: "{{ resp_out.data|json_query(name) }}"
  vars:
    name: "[?slug=='coreos-beta']"

Scanned by Steampunk Spotter

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

- debug: var=distribution_name

Inputs

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

image_type:
    choices:
    - all
    - application
    - distribution
    - private
    default: all
    description:
    - Specifies the type of image facts to be retrived.
    - If set to C(application), then facts are gathered related to all application images.
    - If set to C(distribution), then facts are gathered related to all distribution images.
    - If set to C(private), then facts are gathered related to all private images.
    - If not set to any of above, then facts are gathered related to all images.
    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 image facts
  returned: success
  sample:
  - created_at: '2018-02-02T07:11:43Z'
    distribution: CoreOS
    id: 31434061
    min_disk_size: 20
    name: 1662.1.0 (beta)
    public: true
    regions:
    - nyc1
    - sfo1
    - nyc2
    - ams2
    - sgp1
    - lon1
    - nyc3
    - ams3
    - fra1
    - tor1
    - sfo2
    - blr1
    size_gigabytes: 0.42
    slug: coreos-beta
    type: snapshot
  type: list