opentelekomcloud.cloud.volume_snapshot_info module – Get information about volume snapshots

Note

This module is part of the opentelekomcloud.cloud collection (version 0.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install opentelekomcloud.cloud.

To use it in a playbook, specify: opentelekomcloud.cloud.volume_snapshot_info.

New in version 0.0.3: of opentelekomcloud.cloud

Synopsis

  • Get a generator of snapshots info from the OTC.

Requirements

The below requirements are needed on the host that executes this module.

  • openstacksdk

  • openstacksdk >= 0.36.0

  • otcextensions

  • python >= 3.6

Parameters

Parameter

Comments

api_timeout

integer

How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library.

auth

dictionary

Dictionary containing auth information as needed by the cloud’s auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, os_user_domain_name or os_project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present.

auth_type

string

Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly.

ca_cert

aliases: cacert

string

A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

client_cert

aliases: cert

string

A path to a client certificate to use as part of the SSL transaction.

client_key

aliases: key

string

A path to a client key to use as part of the SSL transaction.

cloud

raw

Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.

details

boolean

More detailed output

Choices:

  • no

  • yes ← (default)

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • admin

  • internal

  • public ← (default)

name

string

Name of the snapshot.

region_name

string

Name of the region.

status

string

Specifies the snapshot status.

Choices:

  • creating

  • available

  • error

  • deleting

  • error_deleting

  • rollbacking

  • backing-up

timeout

integer

How long should ansible wait for the requested resource.

Default: 180

validate_certs

aliases: verify

boolean

Whether or not SSL API requests should be verified.

Before Ansible 2.3 this defaulted to yes.

Choices:

  • no ← (default)

  • yes

volume

string

Name of the volume.

wait

boolean

Should ansible wait until the requested resource is complete.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.

  • Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/

Examples

# Get configs versions.
- volume_snapshot_info:
    name: my_snapshot
    status: available
  register: data

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

volume_snapshots

complex

List of dictionaries describing volume snapshots.

Returned: On Success.

created_at

string

Specifies the time when the snapshot was created.

Returned: success

Sample: “2016-02-16T16:54:14.981520”

description

string

Specifies the snapshot description.

Returned: success

Sample: “test description”

id

string

Specifies the snapshot ID.

Returned: success

Sample: “b836dc3d-4e10-4ea4-a34c-8f6b0460a583”

metadata

dictionary

Specifies the snapshot metadata.

Returned: success

name

string

Specifies the snapshot name.

Returned: success

Sample: “test01”

size

integer

Specifies the snapshot size, in GB.

Returned: success

Sample: 1

status

string

Specifies the snapshot status. For details.

Returned: success

Sample: “available”

volume_id

string

Specifies the ID of the snapshot’s source disk.

Returned: success

Sample: “ba5730ea-8621-4ae8-b702-ff0ffc12c209”

Authors

  • Anton Sidelnikov (@anton-sidelnikov)

Whats next

last updated: 2022-02-25 12:26