Apache CloudStack 4.17.0.0 Root Admin API Reference

addCluster

Adds a new cluster

Request parameters

Parameter NameDescriptionRequired
clusternamethe cluster nametrue
clustertypetype of the cluster: CloudManaged, ExternalManagedtrue
hypervisorhypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3true
podidthe Pod ID for the hosttrue
zoneidthe Zone ID for the clustertrue
allocationstateAllocation state of this cluster for allocation of new resourcesfalse
guestvswitchnameName of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.false
guestvswitchtypeType 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
ovm3clusterOvm3 native OCFS2 clustering enabled for clusterfalse
ovm3poolOvm3 native pooling enabled for clusterfalse
ovm3vipOvm3 vip to use for pool (and cluster)false
passwordthe password for the hostfalse
publicvswitchnameName of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.false
publicvswitchtypeType 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
urlthe URLfalse
usernamethe username for the clusterfalse
vsmipaddressthe ipaddress of the VSM associated with this clusterfalse
vsmpasswordthe password for the VSM associated with this clusterfalse
vsmusernamethe username for the VSM associated with this clusterfalse

Response Tags

Response NameDescription
idthe cluster ID
allocationstatethe allocation state of the cluster
clustertypethe type of the cluster
cpuovercommitratioThe cpu overcommit ratio of the cluster
hypervisortypethe hypervisor type of the cluster
managedstatewhether this cluster is managed by cloudstack
memoryovercommitratioThe memory overcommit ratio of the cluster
namethe cluster name
ovm3vipOvm3 VIP to use for pooling and/or clustering
podidthe Pod ID of the cluster
podnamethe Pod name of the cluster
resourcedetailsMeta data associated with the zone (key/value pairs)
zoneidthe Zone ID of the cluster
zonenamethe Zone name of the cluster
capacity(*)the capacity of the Cluster
capacityallocatedthe capacity currently in allocated
capacitytotalthe total capacity available
capacityusedthe capacity currently in use
clusteridthe Cluster ID
clusternamethe Cluster name
namethe capacity name
percentusedthe percentage of capacity currently in use
podidthe Pod ID
podnamethe Pod name
typethe capacity type
zoneidthe Zone ID
zonenamethe Zone name