W3cubDocs

/Ansible

ngine_io.cloudstack.cs_volume – Manages volumes on Apache CloudStack based clouds.

Note

This plugin is part of the ngine_io.cloudstack collection (version 2.2.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 ngine_io.cloudstack.

To use it in a playbook, specify: ngine_io.cloudstack.cs_volume.

New in version 0.1.0: of ngine_io.cloudstack

Synopsis

  • Create, destroy, attach, detach, extract or upload volumes.

Requirements

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

  • python >= 2.6
  • cs >= 0.9.0

Parameters

Parameter Choices/Defaults Comments
account
string
Account the volume is related to.
api_http_method
string
    Choices:
  • get
  • post
HTTP method used to query the API endpoint.
If not given, the CLOUDSTACK_METHOD env variable is considered.
api_key
string / required
API key of the CloudStack API.
If not given, the CLOUDSTACK_KEY env variable is considered.
api_secret
string / required
Secret key of the CloudStack API.
If not set, the CLOUDSTACK_SECRET env variable is considered.
api_timeout
integer
Default:
10
HTTP timeout in seconds.
If not given, the CLOUDSTACK_TIMEOUT env variable is considered.
api_url
string / required
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
If not given, the CLOUDSTACK_ENDPOINT env variable is considered.
api_verify_ssl_cert
string
Verify CA authority cert file.
If not given, the CLOUDSTACK_VERIFY env variable is considered.
custom_id
string
Custom id to the resource.
Allowed to Root Admins only.
device_id
integer
ID of the device on a VM the volume is attached to.
Only considered if state is attached.
disk_offering
string
Name of the disk offering to be used.
Required one of disk_offering, snapshot if volume is not already state=present.
display_volume
boolean
    Choices:
  • no
  • yes
Whether to display the volume to the end user or not.
Allowed to Root Admins only.
domain
string
Name of the domain the volume to be deployed in.
force
boolean
    Choices:
  • no
  • yes
Force removal of volume even it is attached to a VM.
Considered on state=absent only.
format
string
    Choices:
  • QCOW2
  • RAW
  • VHD
  • VHDX
  • OVA
The format for the volume.
Only considered if state=uploaded.
max_iops
integer
Max iops
min_iops
integer
Min iops
mode
string
    Choices:
  • http_download
  • ftp_upload
Mode for the volume extraction.
Only considered if state=extracted.
name
string / required
Name of the volume.
name can only contain ASCII letters.
poll_async
boolean
    Choices:
  • no
  • yes
Poll async jobs until job has finished.
project
string
Name of the project the volume to be deployed in.
shrink_ok
boolean
    Choices:
  • no
  • yes
Whether to allow to shrink the volume.
size
integer
Size of disk in GB
snapshot
string
The snapshot name for the disk volume.
Required one of disk_offering, snapshot if volume is not already state=present.
state
string
    Choices:
  • present
  • absent
  • attached
  • detached
  • extracted
  • uploaded
State of the volume.
tags
list / elements=dictionary
List of tags. Tags are a list of dictionaries having keys key and value.
To delete all tags, set a empty list e.g. tags: [].

aliases: tag
url
string
URL to which the volume would be extracted on state=extracted
or the URL where to download the volume on state=uploaded.
Only considered if state is extracted or uploaded.
vm
string
Name of the virtual machine to attach the volume to.
zone
string / required
Name of the zone in which the volume should be deployed.

Notes

Note

  • A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
  • This module supports check mode.

Examples

- name: create volume within project and zone with specified storage options
  ngine_io.cloudstack.cs_volume:
    name: web-vm-1-volume
    project: Integration
    zone: ch-zrh-ix-01
    disk_offering: PerfPlus Storage
    size: 20

- name: create/attach volume to instance
  ngine_io.cloudstack.cs_volume:
    name: web-vm-1-volume
    zone: zone01
    disk_offering: PerfPlus Storage
    size: 20
    vm: web-vm-1
    state: attached

- name: detach volume
  ngine_io.cloudstack.cs_volume:
    name: web-vm-1-volume
    zone: zone01
    state: detached

- name: remove volume
  ngine_io.cloudstack.cs_volume:
    name: web-vm-1-volume
    zone: zone01
    state: absent

- name: Extract DATA volume to make it downloadable
  ngine_io.cloudstack.cs_volume:
    state: extracted
    name: web-vm-1-volume
    zone: zone01
  register: data_vol_out

- name: Create new volume by downloading source volume
  ngine_io.cloudstack.cs_volume:
    state: uploaded
    name: web-vm-1-volume-2
    zone: zone01
    format: VHD
    url: "{{ data_vol_out.url }}"

Return Values

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

Key Returned Description
attached
string
success
Date of the volume was attached.

Sample:
2014-12-01T14:57:57+0100
created
string
success
Date of the volume was created.

Sample:
2014-12-01T14:57:57+0100
device_id
integer
success
Id of the device on user vm the volume is attached to (not returned when detached)

Sample:
1
display_name
string
success
Display name of the volume.

Sample:
web-volume-01
domain
string
success
Domain the volume belongs to

Sample:
example domain
group
string
success
Group the volume belongs to

Sample:
web
id
string
success
ID of the volume.

name
string
success
Name of the volume.

Sample:
web-volume-01
project
string
success
Project the volume belongs to

Sample:
Production
size
integer
success
Size of disk volume.

Sample:
20
state
string
success
State of the volume

Sample:
Attached
type
string
success
Disk volume type.

Sample:
DATADISK
url
string
success when state=extracted
The url of the uploaded volume or the download url depending extraction mode.

Sample:
http://1.12.3.4/userdata/387e2c7c-7c42-4ecc-b4ed-84e8367a1965.vhd
vm
string
success
Name of the vm the volume is attached to (not returned when detached)

Sample:
web-01
zone
string
success
Name of zone the volume is in.

Sample:
ch-gva-2


Authors

  • Jefferson Girão (@jeffersongirao)
  • René Moser (@resmo)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ngine_io/cloudstack/cs_volume_module.html