openstack.cloud.volume_retype module – Retype (change the volume type of) a Cinder block storage volume

Note

This module is part of the openstack.cloud collection (version 2.6.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 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_retype.

New in openstack.cloud 2.6.0

Synopsis

  • Change the volume type of an existing OpenStack Block Storage (Cinder) volume.

  • This operation may trigger a data migration between storage backends, depending on the chosen migration_policy.

  • The volume must be in available or in-use status to be retyped.

  • Retyping an in-use volume from a multiattach-capable type to a non-multiattach-capable type (or vice-versa) is not supported by Cinder.

  • Retyping an encrypted volume to an unencrypted volume (or vice-versa) is not supported by Cinder.

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.

interface

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • "admin"

  • "internal"

  • "public" ← (default)

migration_policy

string

Migration policy to apply when changing the volume type.

never changes the volume type metadata only, without migrating data. This only works when the source and target types share the same storage backend. This is the Cinder default.

on-demand triggers a full data migration to the backend associated with the new volume type. This allows moving between different backends but may take a significant amount of time depending on volume size.

Choices:

  • "never" ← (default)

  • "on-demand"

new_type

string / required

Name or ID of the target volume type.

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

timeout

integer

How long (in seconds) to wait for the retype operation to complete.

Ignored when wait=false.

Default: 600

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

aliases: name

string / required

Name or ID of the volume to retype.

wait

boolean

Whether to wait for the retype operation to complete before returning.

When wait=true and migration_policy=on-demand the module will poll until the volume migration_status is success or error.

When wait=true and migration_policy=never the module waits until the volume returns to available status.

Choices:

  • false

  • true ← (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

- name: Retype a volume using the default "never" migration policy
  openstack.cloud.volume_retype:
    cloud: mycloud
    volume: my-volume
    new_type: ssd-standard

- name: Retype a volume with on-demand migration (moves data to the new backend)
  openstack.cloud.volume_retype:
    cloud: mycloud
    volume: my-volume
    new_type: high-iops
    migration_policy: on-demand
    timeout: 1800

- name: Retype a volume without waiting for completion
  openstack.cloud.volume_retype:
    cloud: mycloud
    volume: my-volume
    new_type: cold-storage
    migration_policy: on-demand
    wait: false

- name: Retype volume identified by UUID
  openstack.cloud.volume_retype:
    cloud: mycloud
    volume: a1b2c3d4-1234-5678-abcd-ef0123456789
    new_type: replicated-ssd
    migration_policy: on-demand

Return Values

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

Key

Description

volume

dictionary

Dictionary describing the volume after the retype operation.

Returned: On success.

attachments

list / elements=dictionary

Instance attachments for the volume.

Returned: success

availability_zone

string

The availability zone of the volume.

Returned: success

bootable

boolean

Whether the volume is bootable.

Returned: success

consistencygroup_id

string

The ID of the consistency group that the volume belongs to.

Returned: success

created_at

string

Timestamp of when the volume was created.

Returned: success

description

string

Human-readable description of the volume.

Returned: success

encrypted

boolean

Whether the volume is encrypted.

Returned: success

id

string

Unique ID of the volume.

Returned: success

metadata

dictionary

Metadata associated with the volume.

Returned: success

migration_status

string

Status of the most recent migration operation.

Will be success after a successful on-demand retype.

Returned: success

name

string

Name of the volume.

Returned: success

replication_status

string

Replication status of the volume.

Returned: success

size

integer

Volume size in GiB.

Returned: success

snapshot_id

string

Snapshot ID from which the volume was created.

Returned: success

source_volid

string

ID of the source volume, if the volume was cloned from another.

Returned: success

status

string

Volume status. Will be available after a successful retype.

Returned: success

updated_at

string

Timestamp of the most recent volume update.

Returned: success

volume_type

string

The volume type of the volume after the retype.

Returned: success

volume_type_id

string

The ID of the volume type after the retype.

Returned: success

Authors

  • Simon Dodsley (@simondodsley)