Parameter |
Choices/Defaults |
Comments |
account
|
|
Account the instance 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.
|
domain
|
|
Domain the instance is related to.
|
network
|
|
Name of the network.
Required to find the NIC if instance has multiple networks assigned.
|
poll_async
|
Default:
yes
|
Poll async jobs until job has finished.
|
project
|
|
Name of the project the instance is deployed in.
|
state
|
Choices:
present ←
- absent
|
State of the ipaddress.
|
vm
required |
|
Name of instance.
aliases: name
|
vm_guest_ip
|
|
Secondary IP address to be added to the instance nic.
If not set, the API always returns a new IP address and idempotency is not given.
aliases: secondary_ip
|
vpc
|
|
Name of the VPC the vm is related to.
|
zone
|
|
Name of the zone in which the instance is deployed in.
If not set, default zone is used.
|