community.digitalocean.digital_ocean_volume_info – Gather information about DigitalOcean volumes

Note

This plugin is part of the community.digitalocean collection (version 1.0.0).

To install it use: ansible-galaxy collection install community.digitalocean.

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 Choices/Defaults Comments
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'

aliases: api_token
region_name
string
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.
timeout
integer
Default:
30
The timeout in seconds used for polling DigitalOcean's API.
validate_certs
boolean
    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 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 Returned Description
data
list / elements=string
success
DigitalOcean volume information

Sample:
[{'created_at': '2016-03-02T17:00:49Z', 'description': 'Block store for examples', 'droplet_ids': [], 'id': '506f78a4-e098-11e5-ad9f-000f53306ae1', 'name': 'example', 'region': {'available': True, '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'], 'slug': 'nyc1'}, 'size_gigabytes': 10}]


Authors

  • Abhijeet Kasurde (@Akasurde)