Documentation

digital_ocean_image_facts - Gather facts about DigitalOcean images

New in version 2.6.

Synopsis

  • This module can be used to gather facts about DigitalOcean provided images.
  • These images can be either of type distribution, application and private.

Requirements

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

  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
image_type
    Choices:
  • all ←
  • application
  • distribution
  • private
Specifies the type of image facts to be retrived.
If set to application, then facts are gathered related to all application images.
If set to distribution, then facts are gathered related to all distribution images.
If set to 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.
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 images
  digital_ocean_image_facts:
    image_type: all
    oauth_token: "{{ oauth_token }}"

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

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

- name: Get distribution about image with slug coreos-beta
  digital_ocean_image_facts:
  register: resp_out
- set_fact:
    distribution_name: "{{ item.distribution }}"
  with_items: "{{ resp_out.data|json_query(name) }}"
  vars:
    name: "[?slug=='coreos-beta']"
- debug: var=distribution_name

Return Values

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

Key Returned Description
data
list
success
DigitalOcean image facts

Sample:
[{'min_disk_size': 20, 'name': '1662.1.0 (beta)', 'created_at': '2018-02-02T07:11:43Z', 'id': 31434061, 'regions': ['nyc1', 'sfo1', 'nyc2', 'ams2', 'sgp1', 'lon1', 'nyc3', 'ams3', 'fra1', 'tor1', 'sfo2', 'blr1'], 'public': True, 'distribution': 'CoreOS', 'type': 'snapshot', 'slug': 'coreos-beta', 'size_gigabytes': 0.42}]


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.