Apache CloudStack 4.20.0.0 Root Admin API Reference

addCluster

Adds a new cluster

Request parameters

Parameter Name	Description	Required
clustername	the cluster name	true
clustertype	type of the cluster: CloudManaged, ExternalManaged	true
hypervisor	hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3	true
podid	the Pod ID for the host	true
zoneid	the Zone ID for the cluster	true
allocationstate	Allocation state of this cluster for allocation of new resources	false
arch	the CPU arch of the cluster. Valid options are: x86_64, aarch64	false
guestvswitchname	Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.	false
guestvswitchtype	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)	false
ovm3cluster	Ovm3 native OCFS2 clustering enabled for cluster	false
ovm3pool	Ovm3 native pooling enabled for cluster	false
ovm3vip	Ovm3 vip to use for pool (and cluster)	false
password	the password for the host	false
publicvswitchname	Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.	false
publicvswitchtype	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)	false
url	the URL	false
username	the username for the cluster	false
vsmipaddress	the ipaddress of the VSM associated with this cluster	false
vsmpassword	the password for the VSM associated with this cluster	false
vsmusername	the username for the VSM associated with this cluster	false

Response Tags

Response Name	Description
id	the cluster ID
allocationstate	the allocation state of the cluster
arch	CPU Arch of the hosts in the cluster
clustertype	the type of the cluster
cpuovercommitratio	The cpu overcommit ratio of the cluster
hypervisortype	the hypervisor type of the cluster
managedstate	whether this cluster is managed by cloudstack
memoryovercommitratio	The memory overcommit ratio of the cluster
name	the cluster name
ovm3vip	Ovm3 VIP to use for pooling and/or clustering
podid	the Pod ID of the cluster
podname	the Pod name of the cluster
resourcedetails	Meta data associated with the zone (key/value pairs)
zoneid	the Zone ID of the cluster
zonename	the Zone name of the cluster
*capacity()**	the capacity of the Cluster
capacityallocated	the capacity currently in allocated
capacitytotal	the total capacity available
capacityused	the capacity currently in use
clusterid	the Cluster ID
clustername	the Cluster name
name	the capacity name
percentused	the percentage of capacity currently in use
podid	the Pod ID
podname	the Pod name
tag	The tag for the capacity type
type	the capacity type
zoneid	the Zone ID
zonename	the Zone name

Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.