Parameter |
Choices/Defaults |
Comments |
account
|
|
Account the instance is related to.
|
affinity_groups
|
|
Affinity groups names to be applied to the new instance.
aliases: affinity_group
|
allow_root_disk_shrink
bool
(added in 2.7) |
|
Enables a volume shrinkage when the new size is smaller than the old one.
|
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.
|
cpu
|
|
The number of CPUs to allocate to the instance, used with custom service offerings
|
cpu_speed
|
|
The clock speed/shares allocated to the instance, used with custom service offerings
|
details
(added in 2.6) |
|
Map to specify custom parameters.
|
disk_offering
|
|
Name of the disk offering to be used.
|
disk_size
|
|
Disk size in GByte required if deploying instance from ISO.
|
display_name
|
|
Custom display name of the instances.
Display name will be set to name if not specified.
Either name or display_name is required.
|
domain
|
|
Domain the instance is related to.
|
force
bool |
|
Force stop/start the instance if required to apply changes, otherwise a running instance will not be changed.
|
group
|
|
Group in where the new instance should be in.
|
host
(added in 2.6) |
|
Host on which an instance should be deployed or started on.
Only considered when state=started or instance is running.
Requires root admin privileges.
|
hypervisor
|
Choices:
- KVM
- kvm
- VMware
- vmware
- BareMetal
- baremetal
- XenServer
- xenserver
- LXC
- lxc
- HyperV
- hyperv
- UCS
- ucs
- OVM
- ovm
- Simulator
- simulator
|
Name the hypervisor to be used for creating the new instance.
Relevant when using state=present, but only considered if not set on ISO/template.
If not set or found on ISO/template, first found hypervisor will be used.
|
ip6_address
|
|
IPv6 address for default instance's network.
|
ip_address
|
|
IPv4 address for default instance's network during creation.
|
ip_to_networks
|
|
List of mappings in the form {'network': NetworkName, 'ip': 1.2.3.4}
Mutually exclusive with networks option.
aliases: ip_to_network
|
iso
|
|
Name or id of the ISO to be used for creating the new instance.
Required when using state=present.
Mutually exclusive with template option.
|
keyboard
|
Choices:
- de
- de-ch
- es
- fi
- fr
- fr-be
- fr-ch
- is
- it
- jp
- nl-be
- no
- pt
- uk
- us
|
Keyboard device type for the instance.
|
memory
|
|
The memory allocated to the instance, used with custom service offerings
|
name
|
|
Host name of the instance. name can only contain ASCII letters.
Name will be generated (UUID) by CloudStack if not specified and can not be changed afterwards.
Either name or display_name is required.
|
networks
|
|
List of networks to use for the new instance.
aliases: network
|
poll_async
bool |
|
Poll async jobs until job has finished.
|
project
|
|
Name of the project the instance to be deployed in.
|
root_disk_size
|
|
Root disk size in GByte required if deploying instance with KVM hypervisor and want resize the root disk size at startup (need CloudStack >= 4.4, cloud-initramfs-growroot installed and enabled in the template)
|
security_groups
|
|
List of security groups the instance to be applied to.
aliases: security_group
|
service_offering
|
|
Name or id of the service offering of the new instance.
If not set, first found service offering is used.
|
ssh_key
|
|
Name of the SSH key to be deployed on the new instance.
|
state
|
Choices:
- deployed
- started
- stopped
- restarted
- restored
- destroyed
- expunged
present ←
- absent
|
State of the instance.
|
tags
|
|
List of tags. Tags are a list of dictionaries having keys key and value .
If you want to delete all tags, set a empty list e.g. tags: [].
aliases: tag
|
template
|
|
Name, display text or id of the template to be used for creating the new instance.
Required when using state=present.
Mutually exclusive with ISO option.
|
template_filter
(added in 2.1) |
Choices:
- all
- featured
- self
- selfexecutable
- sharedexecutable
executable ←
- community
|
Name of the filter used to search for the template or iso.
Used for params iso or template on state=present.
The filter all was added in 2.6.
aliases: iso_filter
|
user_data
|
|
Optional data (ASCII) that can be sent to the instance upon a successful deployment.
The data will be automatically base64 encoded.
Consider switching to HTTP_POST by using CLOUDSTACK_METHOD=post to increase the HTTP_GET size limit of 2KB to 32 KB.
|
zone
|
|
Name of the zone in which the instance should be deployed.
If not set, default zone is used.
|