community.general.digital_ocean_snapshot_facts (0.1.4) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.4

Description

This module can be used to gather information about snapshot information based upon provided values such as droplet, volume and snapshot id.

This module was called C(digital_ocean_snapshot_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 snapshots
  digital_ocean_snapshot_info:
    snapshot_type: all
    oauth_token: "{{ oauth_token }}"

Scanned by Steampunk Spotter

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

- name: Gather information about droplet snapshots
  digital_ocean_snapshot_info:
    snapshot_type: droplet
    oauth_token: "{{ oauth_token }}"

Scanned by Steampunk Spotter

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

- name: Gather information about volume snapshots
  digital_ocean_snapshot_info:
    snapshot_type: volume
    oauth_token: "{{ oauth_token }}"

Scanned by Steampunk Spotter

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

- name: Gather information about snapshot by snapshot id
  digital_ocean_snapshot_info:
    snapshot_type: by_id
    snapshot_id: 123123123
    oauth_token: "{{ oauth_token }}"

Scanned by Steampunk Spotter

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

- name: Get information about snapshot named big-data-snapshot1
  digital_ocean_snapshot_info:
  register: resp_out

Scanned by Steampunk Spotter

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

- set_fact:
    snapshot_id: "{{ item.id }}"
  loop: "{{ resp_out.data|json_query(name) }}"
  vars:
    name: "[?name=='big-data-snapshot1']"

Scanned by Steampunk Spotter

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

- debug: var=snapshot_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

snapshot_id:
    description:
    - To retrieve information about a snapshot, please specify this as a snapshot id.
    - If set to actual snapshot id, then information are gathered related to that particular
      snapshot only.
    - This is required parameter, if C(snapshot_type) is set to C(by_id).
    required: false

snapshot_type:
    choices:
    - all
    - droplet
    - volume
    - by_id
    default: all
    description:
    - Specifies the type of snapshot information to be retrieved.
    - If set to C(droplet), then information are gathered related to snapshots based on
      Droplets only.
    - If set to C(volume), then information are gathered related to snapshots based on
      volumes only.
    - If set to C(by_id), then information are gathered related to snapshots based on
      snapshot id only.
    - If not set to any of the above, then information are gathered related to all snapshots.
    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 snapshot information
  returned: success
  sample:
  - created_at: '2016-09-28T23:14:30Z'
    id: 4f60fc64-85d1-11e6-a004-000f53315871
    min_disk_size: 10
    name: big-data-snapshot1
    regions:
    - nyc1
    resource_id: 89bcc42f-85cf-11e6-a004-000f53315871
    resource_type: volume
    size_gigabytes: 0
  type: list