Apache CloudStack 4.17.0.0 Root Admin API Reference
declareHostAsDegraded
Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no VMs running on the respective host otherwise this command might corrupted VMs that were running on the 'Degraded' host.
Request parameters
Parameter Name | Description | Required |
id | host ID | true |
Response Tags
Response Name | Description |
id | the ID of the host |
annotation | the last annotation set on this host by an admin |
capabilities | capabilities of the host |
clusterid | the cluster ID of the host |
clustername | the cluster name of the host |
clustertype | the cluster type of the cluster that host belongs to |
cpuallocated | the amount of the host's CPU currently allocated |
cpuallocatedpercentage | the amount of the host's CPU currently allocated in percentage |
cpuallocatedvalue | the amount of the host's CPU currently allocated in MHz |
cpuallocatedwithoverprovisioning | the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor |
cpuloadaverage | the cpu average load on the host |
cpunumber | the CPU number of the host |
cpusockets | the number of CPU sockets on the host |
cpuspeed | the CPU speed of the host |
cpuused | the amount of the host's CPU currently used |
cpuwithoverprovisioning | the amount of the host's CPU after applying the cpu.overprovisioning.factor |
created | the date and time the host was created |
details | Host details in key/value pairs. |
disconnected | true if the host is disconnected. False otherwise. |
disksizeallocated | the host's currently allocated disk size |
disksizetotal | the total disk size of the host |
events | events available for the host |
hahost | true if the host is Ha host (dedicated to vms started by HA process; false otherwise |
hasenoughcapacity | true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise |
hostha | the host HA information information |
hosttags | comma-separated list of tags for the host |
hypervisor | the host hypervisor |
hypervisorversion | the hypervisor version |
ipaddress | the IP address of the host |
islocalstorageactive | true if local storage is active, false otherwise |
lastannotated | the last time this host was annotated |
lastpinged | the date and time the host was last pinged |
managementserverid | the management server ID of the host |
memoryallocated | the amount of the host's memory currently allocated |
memoryallocatedbytes | the amount of the host's memory currently allocated in bytes |
memoryallocatedpercentage | the amount of the host's memory currently allocated in percentage |
memorytotal | the memory total of the host, this parameter is deprecated use memorywithoverprovisioning |
memoryused | the amount of the host's memory currently used |
memorywithoverprovisioning | the amount of the host's memory after applying the mem.overprovisioning.factor |
name | the name of the host |
networkkbsread | the incoming network traffic on the host |
networkkbswrite | the outgoing network traffic on the host |
oscategoryid | the OS category ID of the host |
oscategoryname | the OS category name of the host |
outofbandmanagement | the host out-of-band management information |
podid | the Pod ID of the host |
podname | the Pod name of the host |
removed | the date and time the host was removed |
resourcestate | the resource state of the host |
state | the state of the host |
suitableformigration | true 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 |
type | the host type |
ueficapability | true if the host has capability to support UEFI boot |
username | the admin that annotated this host |
version | the host version |
zoneid | the Zone ID of the host |
zonename | the Zone name of the host |
gpugroup(*) | GPU cards present in the host |
gpugroupname | GPU cards present in the host |
vgpu(*) | the list of enabled vGPUs |
maxcapacity | Maximum vgpu can be created with this vgpu type on the given gpu group |
maxheads | Maximum displays per user |
maxresolutionx | Maximum X resolution per display |
maxresolutiony | Maximum Y resolution per display |
maxvgpuperpgpu | Maximum no. of vgpu per gpu card (pgpu) |
remainingcapacity | Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type |
vgputype | Model Name of vGPU |
videoram | Video RAM for this vGPU type |
jobid | the ID of the latest async job acting on this object |
jobstatus | the current status of the latest async job acting on this object |