Request parameters
Parameter Name | Description | Required |
clusterid | lists hosts existing in particular cluster | false |
details | comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats] | false |
hahost | if true, list only hosts dedicated to HA | false |
hypervisor | hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator | false |
id | the id of the host | false |
keyword | List by keyword | false |
name | the name of the host | false |
outofbandmanagementenabled | list hosts for which out-of-band management is enabled | false |
outofbandmanagementpowerstate | list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown] | false |
page | false | |
pagesize | false | |
podid | the Pod ID for the host | false |
resourcestate | list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error] | false |
state | the state of the host | false |
type | the host type | false |
virtualmachineid | lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM | false |
zoneid | the Zone ID for the host | false |
Response Tags
Response Name | Description |
cpuallocateddisablethreshold | cpu allocated disable threshold exceeded |
cpuallocatedghz | the total cpu allocated in Ghz |
cpuallocatedthreshold | cpu allocated notification threshold exceeded |
cpudisablethreshold | cpu usage disable threshold exceeded |
cpuloadaverage | the average cpu load the last minute |
cputhreshold | cpu usage notification threshold exceeded |
cputotalghz | the total cpu capacity in Ghz |
cpuusedghz | the total cpu used in Ghz |
instances | instances on the host |
memoryallocateddisablethreshold | memory allocated disable threshold exceeded |
memoryallocatedgb | the total memory allocated in GiB |
memoryallocatedthreshold | memory allocated notification threshold exceeded |
memorydisablethreshold | memory usage disable threshold exceeded |
memorythreshold | memory usage notification threshold exceeded |
memorytotalgb | the total memory capacity in GiB |
memoryusedgb | the total memory used in GiB |
networkread | network read in GiB |
networkwrite | network write in GiB |
powerstate | out-of-band management power state |
systeminstances | system vm instances on the host |