Parameter |
Choices/Defaults |
Comments |
account
|
|
Account the volume is related to.
|
api_http_method
|
|
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
|
|
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
|
Default:
cloudstack
|
Name of the ini section in the cloustack.ini file.
If not given, the CLOUDSTACK_REGION env variable is considered.
|
api_secret
|
|
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
|
|
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
|
|
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
|
|
Custom id to the resource.
Allowed to Root Admins only.
|
disk_offering
|
|
Name of the disk offering to be used.
Required one of disk_offering , snapshot if volume is not already state=present .
|
display_volume
|
Default:
yes
|
Whether to display the volume to the end user or not.
Allowed to Root Admins only.
|
domain
|
|
Name of the domain the volume to be deployed in.
|
force
|
Default:
no
|
Force removal of volume even it is attached to a VM.
Considered on state=absnet only.
|
max_iops
|
|
Max iops
|
min_iops
|
|
Min iops
|
name
required |
|
Name of the volume.
name can only contain ASCII letters.
|
poll_async
|
Default:
yes
|
Poll async jobs until job has finished.
|
project
|
|
Name of the project the volume to be deployed in.
|
shrink_ok
|
Default:
no
|
Whether to allow to shrink the volume.
|
size
|
|
Size of disk in GB
|
snapshot
|
|
The snapshot name for the disk volume.
Required one of disk_offering , snapshot if volume is not already state=present .
|
state
|
Choices:
present ←
- absent
- attached
- detached
|
State of the volume.
|
tags
(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
|
vm
|
|
Name of the virtual machine to attach the volume to.
|
zone
|
|
Name of the zone in which the volume should be deployed.
If not set, default zone is used.
|