cs_volume – Manages volumes on Apache CloudStack based clouds
New in version 2.1.
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.6.10
 
Parameters
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
|  account   string    |    Account the volume is related to.   |  |
|  api_http_method   string    |   
  |    HTTP method used to query the API endpoint.  If not given, the   CLOUDSTACK_METHOD env variable is considered.As the last option, the value is taken from the ini config file, also see the notes.  Fallback value is   get if not specified. |  
|  api_key   string    |    API key of the CloudStack API.  If not given, the   CLOUDSTACK_KEY env variable is considered.As the last option, the value is taken from the ini config file, also see the notes.   |  |
|  api_region   string    |   Default: "cloudstack"   |    Name of the ini section in the   cloustack.ini file.If not given, the   CLOUDSTACK_REGION env variable is considered. |  
|  api_secret   string    |    Secret key of the CloudStack API.  If not set, the   CLOUDSTACK_SECRET env variable is considered.As the last option, the value is taken from the ini config file, also see the notes.   |  |
|  api_timeout   integer    |    HTTP timeout in seconds.  If not given, the   CLOUDSTACK_TIMEOUT env variable is considered.As the last option, the value is taken from the ini config file, also see the notes.  Fallback value is 10 seconds if not specified.   |  |
|  api_url   string    |    URL of the CloudStack API e.g. https://cloud.example.com/client/api.  If not given, the   CLOUDSTACK_ENDPOINT env variable is considered.As the last option, the value is taken from the ini config file, also see the notes.   |  |
|  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    |   
  |    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    |   
  |    Force removal of volume even it is attached to a VM.  Considered on state=absent only.   |  
|  format   string   added in 2.8   |   
  |    The format for the volume.  Only considered if state=uploaded.   |  
|  max_iops   integer    |    Max iops   |  |
|  min_iops   integer    |    Min iops   |  |
|  mode   string   added in 2.8   |   
  |    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    |   
  |    Poll async jobs until job has finished.   |  
|  project   string    |    Name of the project the volume to be deployed in.   |  |
|  shrink_ok   boolean    |   
  |    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    |   
  |    State of the volume.  The choices   extracted and uploaded were added in version 2.8. |  
|  tags   list   added in 2.4   |    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   added in 2.8   |    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    |    Name of the zone in which the volume should be deployed.  If not set, default zone is used.   |  
Notes
Note
- Ansible uses the 
cslibrary’s configuration method if credentials are not provided by the argumentsapi_url,api_key,api_secret. Configuration is read from several locations, in the following order. TheCLOUDSTACK_ENDPOINT,CLOUDSTACK_KEY,CLOUDSTACK_SECRETandCLOUDSTACK_METHOD.CLOUDSTACK_TIMEOUTenvironment variables. ACLOUDSTACK_CONFIGenvironment variable pointing to an.inifile. Acloudstack.inifile in the current working directory. A.cloudstack.inifile in the users home directory. Optionally multiple credentials and endpoints can be specified using ini sections incloudstack.ini. Use the argumentapi_regionto select the section name, default section iscloudstack. See https://github.com/exoscale/cs for more information. - 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
  cs_volume:
    name: web-vm-1-volume
    project: Integration
    zone: ch-zrh-ix-01
    disk_offering: PerfPlus Storage
    size: 20
  delegate_to: localhost
- name: create/attach volume to instance
  cs_volume:
    name: web-vm-1-volume
    disk_offering: PerfPlus Storage
    size: 20
    vm: web-vm-1
    state: attached
  delegate_to: localhost
- name: detach volume
  cs_volume:
    name: web-vm-1-volume
    state: detached
  delegate_to: localhost
- name: remove volume
  cs_volume:
    name: web-vm-1-volume
    state: absent
  delegate_to: localhost
# New in version 2.8
- name: Extract DATA volume to make it downloadable
  cs_volume:
    state: extracted
    name: web-vm-1-volume
  register: data_vol_out
  delegate_to: localhost
- name: Create new volume by downloading source volume
  cs_volume:
    state: uploaded
    name: web-vm-1-volume-2
    format: VHD
    url: "{{ data_vol_out.url }}"
  delegate_to: localhost
   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  added in 2.8   |  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   |  
Status
- This module is guaranteed to have no backward incompatible interface changes going forward. [stableinterface]
 - This module is maintained by the Ansible Community. [community]
 
Authors
- Jefferson Girão (@jeffersongirao)
 - René Moser (@resmo)
 
Hint
If you notice any issues in this documentation you can edit this document to improve it.
    © 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
    https://docs.ansible.com/ansible/2.8/modules/cs_volume_module.html