New in version 2.6.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| 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 | |
| region_name | Name of region to restrict results to volumes available in a specific region. Please use digital_ocean_region_facts for getting valid values related regions. | |
| timeout | Default: 30 | The timeout in seconds used for polling DigitalOcean's API. |
| validate_certs bool |
| 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. |
- name: Gather facts about all volume
digital_ocean_volume_facts:
oauth_token: "{{ oauth_token }}"
- name: Gather facts about volume in given region
digital_ocean_volume_facts:
region_name: nyc1
oauth_token: "{{ oauth_token }}"
- name: Get facts about volume named nyc3-test-volume
digital_ocean_volume_facts:
register: resp_out
- set_fact:
volume_id: "{{ item.id }}"
with_items: "{{ resp_out.data|json_query(name) }}"
vars:
name: "[?name=='nyc3-test-volume']"
- debug: var=volume_id
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| data list | success | DigitalOcean volume facts Sample: [{'droplet_ids': [], 'size_gigabytes': 10, 'id': '506f78a4-e098-11e5-ad9f-000f53306ae1', 'created_at': '2016-03-02T17:00:49Z', 'description': 'Block store for examples', 'region': {'available': True, 'slug': 'nyc1', 'features': ['private_networking', 'backups', 'ipv6', 'metadata'], 'name': 'New York 1', 'sizes': ['s-1vcpu-1gb', 's-1vcpu-2gb', 's-1vcpu-3gb', 's-2vcpu-2gb', 's-3vcpu-1gb', 's-2vcpu-4gb', 's-4vcpu-8gb', 's-6vcpu-16gb', 's-8vcpu-32gb', 's-12vcpu-48gb', 's-16vcpu-64gb', 's-20vcpu-96gb', 's-24vcpu-128gb', 's-32vcpu-192gb']}, 'name': 'example'}] |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
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.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/digital_ocean_volume_facts_module.html