blob: 651c346f6536d4fef00cf7cd43942383e8a0037d [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 1.0 Transitional//EN">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../includes/main.css" type="text/css">
<link rel="shortcut icon" href="../favicon.ico" type="image/x-icon">
<title>Apache CloudStack | The Power Behind Your Cloud</title>
</head>
<body>
<div id="insidetopbg">
<div id="inside_wrapper">
<div class="uppermenu_panel">
<div class="uppermenu_box"></div>
</div>
<div id="main_master">
<div id="inside_header">
<div class="header_top">
<a class="cloud_logo" href="http://cloudstack.org"></a>
<div class="mainemenu_panel"></div>
</div>
</div>
<div id="main_content">
<div class="inside_apileftpanel">
<div class="inside_contentpanel" style="width:930px;">
<div class="api_titlebox">
<div class="api_titlebox_left">
<span>
Apache CloudStack 4.12.0.0 Root Admin API Reference
</span>
<p></p>
<h1>prepareHostForMaintenance</h1>
<p>Prepares a host for maintenance.</p>
</div>
<div class="api_titlebox_right">
<a class="api_backbutton" href="../index.html"></a>
</div>
</div>
<div class="api_tablepanel">
<h2>Request parameters</h2>
<table class="apitable">
<tr class="hed">
<td style="width:200px;"><strong>Parameter Name</strong></td><td style="width:500px;">Description</td><td style="width:180px;">Required</td>
</tr>
<tr>
<td style="width:200px;"><strong>id</strong></td><td style="width:500px;"><strong>the host ID</strong></td><td style="width:180px;"><strong>true</strong></td>
</tr>
</table>
</div>
<div class="api_tablepanel">
<h2>Response Tags</h2>
<table class="apitable">
<tr class="hed">
<td style="width:200px;"><strong>Response Name</strong></td><td style="width:500px;">Description</td>
</tr>
<tr>
<td style="width:200px;"><strong>id</strong></td><td style="width:500px;">the ID of the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>annotation</strong></td><td style="width:500px;">the last annotation set on this host by an admin</td>
</tr>
<tr>
<td style="width:200px;"><strong>averageload</strong></td><td style="width:500px;">the cpu average load on the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>capabilities</strong></td><td style="width:500px;">capabilities of the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>clusterid</strong></td><td style="width:500px;">the cluster ID of the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>clustername</strong></td><td style="width:500px;">the cluster name of the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>clustertype</strong></td><td style="width:500px;">the cluster type of the cluster that host belongs to</td>
</tr>
<tr>
<td style="width:200px;"><strong>cpuallocated</strong></td><td style="width:500px;">the amount of the host's CPU currently allocated</td>
</tr>
<tr>
<td style="width:200px;"><strong>cpunumber</strong></td><td style="width:500px;">the CPU number of the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>cpusockets</strong></td><td style="width:500px;">the number of CPU sockets on the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>cpuspeed</strong></td><td style="width:500px;">the CPU speed of the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>cpuused</strong></td><td style="width:500px;">the amount of the host's CPU currently used</td>
</tr>
<tr>
<td style="width:200px;"><strong>cpuwithoverprovisioning</strong></td><td style="width:500px;">the amount of the host's CPU after applying the cpu.overprovisioning.factor </td>
</tr>
<tr>
<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">the date and time the host was created</td>
</tr>
<tr>
<td style="width:200px;"><strong>details</strong></td><td style="width:500px;">Host details in key/value pairs.</td>
</tr>
<tr>
<td style="width:200px;"><strong>disconnected</strong></td><td style="width:500px;">true if the host is disconnected. False otherwise.</td>
</tr>
<tr>
<td style="width:200px;"><strong>disksizeallocated</strong></td><td style="width:500px;">the host's currently allocated disk size</td>
</tr>
<tr>
<td style="width:200px;"><strong>disksizetotal</strong></td><td style="width:500px;">the total disk size of the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>events</strong></td><td style="width:500px;">events available for the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>hahost</strong></td><td style="width:500px;">true if the host is Ha host (dedicated to vms started by HA process; false otherwise</td>
</tr>
<tr>
<td style="width:200px;"><strong>hasenoughcapacity</strong></td><td style="width:500px;">true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise</td>
</tr>
<tr>
<td style="width:200px;"><strong>hostha</strong></td><td style="width:500px;">the host HA information information</td>
</tr>
<tr>
<td style="width:200px;"><strong>hosttags</strong></td><td style="width:500px;">comma-separated list of tags for the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>hypervisor</strong></td><td style="width:500px;">the host hypervisor</td>
</tr>
<tr>
<td style="width:200px;"><strong>hypervisorversion</strong></td><td style="width:500px;">the hypervisor version</td>
</tr>
<tr>
<td style="width:200px;"><strong>ipaddress</strong></td><td style="width:500px;">the IP address of the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>islocalstorageactive</strong></td><td style="width:500px;">true if local storage is active, false otherwise</td>
</tr>
<tr>
<td style="width:200px;"><strong>lastannotated</strong></td><td style="width:500px;">the last time this host was annotated</td>
</tr>
<tr>
<td style="width:200px;"><strong>lastpinged</strong></td><td style="width:500px;">the date and time the host was last pinged</td>
</tr>
<tr>
<td style="width:200px;"><strong>managementserverid</strong></td><td style="width:500px;">the management server ID of the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>memoryallocated</strong></td><td style="width:500px;">the amount of the host's memory currently allocated</td>
</tr>
<tr>
<td style="width:200px;"><strong>memorytotal</strong></td><td style="width:500px;">the memory total of the host, this parameter is deprecated use memorywithoverprovisioning</td>
</tr>
<tr>
<td style="width:200px;"><strong>memoryused</strong></td><td style="width:500px;">the amount of the host's memory currently used</td>
</tr>
<tr>
<td style="width:200px;"><strong>memorywithoverprovisioning</strong></td><td style="width:500px;">the amount of the host's memory after applying the mem.overprovisioning.factor</td>
</tr>
<tr>
<td style="width:200px;"><strong>name</strong></td><td style="width:500px;">the name of the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>networkkbsread</strong></td><td style="width:500px;">the incoming network traffic on the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>networkkbswrite</strong></td><td style="width:500px;">the outgoing network traffic on the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>oscategoryid</strong></td><td style="width:500px;">the OS category ID of the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>oscategoryname</strong></td><td style="width:500px;">the OS category name of the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>outofbandmanagement</strong></td><td style="width:500px;">the host out-of-band management information</td>
</tr>
<tr>
<td style="width:200px;"><strong>podid</strong></td><td style="width:500px;">the Pod ID of the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>podname</strong></td><td style="width:500px;">the Pod name of the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>removed</strong></td><td style="width:500px;">the date and time the host was removed</td>
</tr>
<tr>
<td style="width:200px;"><strong>resourcestate</strong></td><td style="width:500px;">the resource state of the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>state</strong></td><td style="width:500px;">the state of the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>suitableformigration</strong></td><td style="width:500px;">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</td>
</tr>
<tr>
<td style="width:200px;"><strong>type</strong></td><td style="width:500px;">the host type</td>
</tr>
<tr>
<td style="width:200px;"><strong>username</strong></td><td style="width:500px;">the admin that annotated this host</td>
</tr>
<tr>
<td style="width:200px;"><strong>version</strong></td><td style="width:500px;">the host version</td>
</tr>
<tr>
<td style="width:200px;"><strong>zoneid</strong></td><td style="width:500px;">the Zone ID of the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>zonename</strong></td><td style="width:500px;">the Zone name of the host</td>
</tr>
<tr>
<td style="width:200px;"><strong>gpugroup(*)</strong></td><td style="width:500px;">GPU cards present in the host</td>
<tr>
<td style="width:180px; padding-left:25px;"><strong>gpugroupname</strong></td><td style="width:500px;">GPU cards present in the host</td>
</tr>
<tr>
<td style="width:180px; padding-left:25px;"><strong>vgpu(*)</strong></td><td style="width:500px;">the list of enabled vGPUs</td>
</tr>
<tr>
<td style="width:165px; padding-left:40px;">maxcapacity</td><td style="width:500px;">Maximum vgpu can be created with this vgpu type on the given gpu group</td>
</tr>
<tr>
<td style="width:165px; padding-left:40px;">maxheads</td><td style="width:500px;">Maximum displays per user</td>
</tr>
<tr>
<td style="width:165px; padding-left:40px;">maxresolutionx</td><td style="width:500px;">Maximum X resolution per display</td>
</tr>
<tr>
<td style="width:165px; padding-left:40px;">maxresolutiony</td><td style="width:500px;">Maximum Y resolution per display</td>
</tr>
<tr>
<td style="width:165px; padding-left:40px;">maxvgpuperpgpu</td><td style="width:500px;">Maximum no. of vgpu per gpu card (pgpu)</td>
</tr>
<tr>
<td style="width:165px; padding-left:40px;">remainingcapacity</td><td style="width:500px;">Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type</td>
</tr>
<tr>
<td style="width:165px; padding-left:40px;">vgputype</td><td style="width:500px;">Model Name of vGPU</td>
</tr>
<tr>
<td style="width:165px; padding-left:40px;">videoram</td><td style="width:500px;">Video RAM for this vGPU type</td>
</tr>
</tr>
<tr>
<td style="width:200px;"><strong>jobid</strong></td><td style="width:500px;">the ID of the latest async job acting on this object</td>
</tr>
<tr>
<td style="width:200px;"><strong>jobstatus</strong></td><td style="width:500px;">the current status of the latest async job acting on this object</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="comments_thread">
<script type="text/javascript" src="https://comments.apache.org/show_comments.lua?site=test" async="true"></script>
<noscript>
<iframe width="930" height="500" src="https://comments.apache.org/iframe.lua?site=test&amp;page=4.2.0/rootadmin"></iframe>
</noscript>
</div>
<div id="footer_mainmaster">
<p>Copyright &copy; 2015 The Apache Software Foundation, Licensed under the
<a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0.</a>
<br>
Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.</p>
</div>
</div>
</div>
</div>
</body>
</html>