openstack.cloud.volume_snapshot module – Create/Delete Cinder Volume Snapshots

Note

This module is part of the openstack.cloud collection (version 2.3.2).

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 openstack.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: openstack.cloud.volume_snapshot.

Synopsis

  • Create or Delete cinder block storage volume snapshots

Requirements

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

  • python >= 3.6

  • openstacksdk >= 1.0.0

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, user_domain_name or 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

any

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.

description

aliases: display_description

string

String describing the snapshot

force

boolean

Allows or disallows snapshot of a volume to be created, when the volume is attached to an instance.

Choices:

  • false ← (default)

  • true

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • "admin"

  • "internal"

  • "public" ← (default)

name

aliases: display_name

string / required

Name of the snapshot

region_name

string

Name of the region.

sdk_log_level

string

Log level of the OpenStackSDK

Choices:

  • "INFO" ← (default)

  • "DEBUG"

sdk_log_path

string

Path to the logfile of the OpenStackSDK. If empty no log is written

state

string

Should the snapshot be present or absent.

Choices:

  • "present" ← (default)

  • "absent"

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 true.

Choices:

  • false

  • true

volume

string

Volume name or ID to create the snapshot from.

Required when state is present.

wait

boolean

Should ansible wait until the requested resource is complete.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Updating existing volume snapshots has not been implemented yet.

  • 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

- name: create snapshot
  openstack.cloud.volume_snapshot:
    state: present
    cloud: mordred
    name: test_snapshot
    volume: test_volume
- name: delete snapshot
  openstack.cloud.volume_snapshot:
    state: absent
    cloud: mordred
    name: test_snapshot
    volume: test_volume

Return Values

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

Key

Description

snapshot

dictionary

Same as volume_snapshot, kept for backward compatibility.

Returned: On success when state=present

volume_snapshot

dictionary

The snapshot instance

Returned: success

created_at

string

Snapshot creation time.

Returned: success

description

string

Snapshot desciption.

Returned: success

id

string

Unique UUID.

Returned: success

Sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69"

is_forced

boolean

Indicate whether to create snapshot, even if the volume is attached.

Returned: success

metadata

dictionary

Snapshot metadata.

Returned: success

name

string

Snapshot Name.

Returned: success

progress

string

The percentage of completeness the snapshot is currently at.

Returned: success

project_id

string

The project ID this snapshot is associated with.

Returned: success

size

integer

The size of the volume, in GBs.

Returned: success

status

string

Snapshot status.

Returned: success

updated_at

string

Snapshot update time.

Returned: success

volume_id

string

Volume ID.

Returned: success

Authors

  • OpenStack Ansible SIG