ansible / ansible.builtin / v2.9.13 / module / _digital_ocean_snapshot_facts Gather information about DigitalOcean Snapshot | "added in version" 2.6 of ansible.builtin" Authors: Abhijeet Kasurde (@Akasurde) preview | supported by communityansible.builtin._digital_ocean_snapshot_facts (v2.9.13) — module
pip
Install with pip install ansible==2.9.13
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.
- name: Gather information about all snapshots digital_ocean_snapshot_info: snapshot_type: all oauth_token: "{{ oauth_token }}"
- name: Gather information about droplet snapshots digital_ocean_snapshot_info: snapshot_type: droplet oauth_token: "{{ oauth_token }}"
- name: Gather information about volume snapshots digital_ocean_snapshot_info: snapshot_type: volume oauth_token: "{{ oauth_token }}"
- name: Gather information about snapshot by snapshot id digital_ocean_snapshot_info: snapshot_type: by_id snapshot_id: 123123123 oauth_token: "{{ oauth_token }}"
- name: Get information about snapshot named big-data-snapshot1 digital_ocean_snapshot_info: register: resp_out
- set_fact: snapshot_id: "{{ item.id }}" loop: "{{ resp_out.data|json_query(name) }}" vars: name: "[?name=='big-data-snapshot1']"
- debug: var=snapshot_id
baseurl: default: https://api.digitalocean.com/v2 description: - DigitalOcean API base url. type: str 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 retrived. - 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
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