Parameter |
Choices/Defaults |
Comments |
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.
|
cluster_type
|
Choices:
- CloudManaged
- ExternalManaged
|
Type of the cluster.
Required if state=present
|
guest_vswitch_name
|
|
Name of virtual switch used for guest traffic in the cluster.
This would override zone wide traffic label setting.
|
guest_vswitch_type
|
Choices:
- vmwaresvs
- vmwaredvs
|
Type of virtual switch used for guest traffic in the cluster.
Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)
|
hypervisor
|
Choices:
- KVM
- VMware
- BareMetal
- XenServer
- LXC
- HyperV
- UCS
- OVM
|
Name the hypervisor to be used.
Required if state=present .
|
name
required |
|
name of the cluster.
|
ovm3_cluster
|
|
Ovm3 native OCFS2 clustering enabled for cluster.
|
ovm3_pool
|
|
Ovm3 native pooling enabled for cluster.
|
ovm3_vip
|
|
Ovm3 vip to use for pool (and cluster).
|
password
|
|
Password for the cluster.
|
pod
|
|
Name of the pod in which the cluster belongs to.
|
public_vswitch_name
|
|
Name of virtual switch used for public traffic in the cluster.
This would override zone wide traffic label setting.
|
public_vswitch_type
|
Choices:
- vmwaresvs
- vmwaredvs
|
Type of virtual switch used for public traffic in the cluster.
Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)
|
state
|
Choices:
present ←
- absent
- disabled
- enabled
|
State of the cluster.
|
url
|
|
URL for the cluster
|
username
|
|
Username for the cluster.
|
vms_ip_address
|
|
IP address of the VSM associated with this cluster.
|
vms_password
|
|
Password for the VSM associated with this cluster.
|
vms_username
|
|
Username for the VSM associated with this cluster.
|
zone
|
|
Name of the zone in which the cluster belongs to.
If not set, default zone is used.
|