gcore / gcore.cloud / 1.0.1 / module / volume_snapshot_info Gather infos about all GCore snapshots. Authors: GCore (@GCore)gcore.cloud.volume_snapshot_info (1.0.1) — module
Install with ansible-galaxy collection install gcore.cloud:==1.0.1
collections: - name: gcore.cloud version: 1.0.1
Gather infos about all GCore snapshots.
- name: Gather gcore snapshots info gcore.cloud.volume_snapshot_info: api_key: "{{ api_key }}" region_id: "{{ region_id }}" project_id: "{{ project_id }}"
- name: Gather gcore snapshots info for specific volume gcore.cloud.volume_snapshot_info: api_key: "{{ api_key }}" region_id: "{{ region_id }}" project_id: "{{ project_id }}" volume_id: "{{ volume_id }}"
limit: description: - Limit the number of returned snapshots required: false type: int offset: description: - Offset value is used to exclude the first set of records from the result required: false type: int api_key: description: - GCore API auth key - Can be passed as I(CLOUD_API_KEY) environment variable. type: str api_host: default: https://api.gcore.com/cloud description: - GCore API base host - Can be passed as I(CLOUD_API_HOST) environment variable. type: str region_id: description: - GCore API region ID - Required if I(region_name) is not passed - Can be passed as I(CLOUD_REGION_ID) environment variable. type: int volume_id: description: - Can be used to list snapshots of a single volume required: false type: str project_id: description: - GCore API project ID - Required if I(project_name) is not passed - Can be passed as I(CLOUD_PROJECT_ID) environment variable. type: int api_timeout: default: 30 description: - Timeout in seconds to polling GCore API type: int instance_id: description: - Can be used to list snapshots of any volume in a specific server instance required: false type: str region_name: description: - GCore API region name - Required if I(region_id) is not passed - Can be passed as I(CLOUD_REGION_NAME) environment variable. type: str schedule_id: description: - Can be used to list snapshots by schedule id required: false type: str snapshot_id: description: - The ID of the snapshot you want to get. - The module will fail if the provided ID is invalid. required: false type: str project_name: description: - GCore API project name - Required if I(project_id) is not passed - Can be passed as I(CLOUD_PROJECT_NAME) environment variable. type: str lifecycle_policy_id: description: - Can be used to list snapshots by lifecycle policy id required: false type: str
volume_snapshot_info: contains: created_at: description: Datetime when the volume was created returned: always sample: 2019-05-29T05:32:41+0000 type: str creator_task_id: description: Task that created this entity returned: if available sample: 2358e3b1-5c42-4705-8950-6ddcfc19c3bd type: str description: description: Snapshot description returned: if available sample: test type: str id: description: Snapshot ID returned: always sample: 726ecfcc-7fd0-4e30-a86e-7892524aa483 type: str metadata: description: Metadata returned: if available sample: bootable: 'False' task_id: a4d72afa-1c67-44af-9f91-0b893cd204da volume_name: namevolume volume_type: standard type: dict name: description: Snapshot name returned: always sample: test type: str project_id: description: Project ID returned: always sample: 1 type: int region: description: Region name returned: always sample: Luxembourg 1 type: str region_id: description: Region ID returned: always sample: 1 type: int size: description: Snapshot size, GiB returned: always sample: 2 type: int status: description: Snapshot status returned: always sample: available type: str task_id: description: Active task. If None, action has been performed immediately in the request itself returned: if available sample: 907a87b0-7b63-4fd5-beb3-5ab4ba445c93 type: str updated_at: description: Datetime when the volume was last updated returned: if available sample: 2019-05-29T05:39:20+0000 type: str volume_id: description: ID of the volume this snapshot was made from returned: always sample: 67baa7d1-08ea-4fc5-bef2-6b2465b7d227 type: str description: - List of dictionaries. returned: always type: complex