Cosmic Admin API Reference

findHostsForMigration

Find hosts suitable for migrating a virtual machine.

Request parameters

Parameter NameDescriptionRequired
virtualmachineidfind hosts to which this VM can be migrated and flag the hosts with enough CPU/RAM to host the VMtrue
keywordList by keywordfalse
pagefalse
pagesizefalse

Response Tags

Response NameDescription
idthe ID of the host
accountidAccount ID to which the host is dedicated
accountnameAccount name to which the host is dedicated
affinitygroupidAffinity group ID to which the host is dedicated
affinitygroupnameAffinity group name to which the host is dedicated
averageloadthe cpu average load on the host
capabilitiescapabilities of the host
clusteridthe cluster ID of the host
clusternamethe cluster name of the host
clustertypethe cluster type of the cluster that host belongs to
cpuallocatedthe amount of the host's CPU currently allocated
cpunumberthe CPU number of the host
cpuusedthe amount of the host's CPU currently used
cpuwithoverprovisioningthe amount of the host's CPU after applying the cpu.overprovisioning.factor
createdthe date and time the host was created
dedicatedIs the host dedicated?
disconnectedtrue if the host is disconnected. False otherwise.
disksizeallocatedthe host's currently allocated disk size
disksizetotalthe total disk size of the host
domainidDomain ID to which the host is dedicated
domainnameDomain name to which the host is dedicated
eventsevents available for the host
hahosttrue if the host is Ha host (dedicated to vms started by HA process; false otherwise
hasenoughcapacitytrue if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise
hosttagscomma-separated list of tags for the host
hypervisorthe host hypervisor
hypervisorversionthe hypervisor version
ipaddressthe IP address of the host
islocalstorageactivetrue if local storage is active, false otherwise
lastpingedthe date and time the host was last pinged
managementserveridthe management server ID of the host
memoryallocatedthe amount of the host's memory currently allocated
memorytotalthe memory total of the host
memoryusedthe amount of the host's memory currently used
namethe name of the host
networkkbsreadthe incoming network traffic on the host
networkkbswritethe outgoing network traffic on the host
oscategoryidthe OS category ID of the host
oscategorynamethe OS category name of the host
podidthe Pod ID of the host
podnamethe Pod name of the host
removedthe date and time the host was removed
requiresStorageMotiontrue if migrating a vm to this host requires storage motion, false otherwise
resourcestatethe resource state of the host
statethe state of the host
suitableformigrationtrue if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise
typethe host type
versionthe host version
zoneidthe Zone ID of the host
zonenamethe Zone name of the host