community.general.digital_ocean_volume_info (0.2.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.2.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.2.1

Description

This module can be used to gather information about DigitalOcean provided volumes.

This module was called C(digital_ocean_volume_facts) before Ansible 2.9. The usage did not change.

Requirements

• python >= 2.6

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Gather information about all volume
  digital_ocean_volume_info:
    oauth_token: "{{ oauth_token }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Gather information about volume in given region
  digital_ocean_volume_info:
    region_name: nyc1
    oauth_token: "{{ oauth_token }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get information about volume named nyc3-test-volume
  digital_ocean_volume_info:
  register: resp_out

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- set_fact:
    volume_id: "{{ item.id }}"
  loop: "{{ resp_out.data|json_query(name) }}"
  vars:
    name: "[?name=='nyc3-test-volume']"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- debug: var=volume_id

Inputs

    
timeout:
    default: 30
    description:
    - The timeout in seconds used for polling DigitalOcean's API.
    type: int

oauth_token:
    aliases:
    - api_token
    description:
    - 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'
    type: str

region_name:
    description:
    - Name of region to restrict results to volumes available in a specific region.
    - Please use M(digital_ocean_region_info) for getting valid values related regions.
    required: false

validate_certs:
    default: true
    description:
    - If set to C(no), the SSL certificates will not be validated.
    - This should only set to C(no) used on personally controlled sites using self-signed
      certificates.
    type: bool

Outputs

data:
  description: DigitalOcean volume information
  returned: success
  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
  type: list