digital_ocean_image_facts – Gather facts about DigitalOcean images
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
andprivate
.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
image_type - |
|
Specifies the type of image facts to be retrived. If set to If set to If set to If not set to any of above, then facts are gathered related to all images. |
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'
| |
timeout integer |
Default: 30 |
The timeout in seconds used for polling DigitalOcean's API. |
validate_certs boolean |
|
If set to This should only set to |
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 }}"
loop: "{{ 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: [{'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'}] |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Abhijeet Kasurde (@Akasurde)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/digital_ocean_image_facts_module.html