community.digitalocean.digital_ocean_volume_info module – Gather information about DigitalOcean volumes
Note
This module is part of the community.digitalocean collection (version 1.22.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.digitalocean
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.digitalocean.digital_ocean_volume_info
.
Synopsis
This module can be used to gather information about DigitalOcean provided volumes.
This module was called
digital_ocean_volume_facts
before Ansible 2.9. The usage did not change.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
Parameters
Parameter |
Comments |
---|---|
DigitalOcean API base url. Default: |
|
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’ |
|
Name of region to restrict results to volumes available in a specific region. Please use community.digitalocean.digital_ocean_region_info for getting valid values related regions. |
|
The timeout in seconds used for polling DigitalOcean’s API. Default: |
|
If set to This should only set to Choices:
|
Examples
- name: Gather information about all volume
community.digitalocean.digital_ocean_volume_info:
oauth_token: "{{ oauth_token }}"
- name: Gather information about volume in given region
community.digitalocean.digital_ocean_volume_info:
region_name: nyc1
oauth_token: "{{ oauth_token }}"
- name: Get information about volume named nyc3-test-volume
community.digitalocean.digital_ocean_volume_info:
register: resp_out
- set_fact:
volume_id: "{{ item.id }}"
loop: "{{ resp_out.data | community.general.json_query(name) }}"
vars:
name: "[?name=='nyc3-test-volume']"
- debug: var=volume_id
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
DigitalOcean volume information Returned: success Sample: |