static/api/apidocs-4.16/apis/startRollingMaintenance.html (135 lines of code) (raw):
<!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_controller">
<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.16.0.0 Root Admin API Reference
</span>
<p></p>
<h1>startRollingMaintenance</h1>
<p>Start rolling 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;"><i>clusterids</i></td><td style="width:500px;"><i>the IDs of the clusters to start maintenance on</i></td><td style="width:180px;"><i>false</i></td>
</tr>
<tr>
<td style="width:200px;"><i>forced</i></td><td style="width:500px;"><i>if rolling mechanism should continue in case of an error</i></td><td style="width:180px;"><i>false</i></td>
</tr>
<tr>
<td style="width:200px;"><i>hostids</i></td><td style="width:500px;"><i>the IDs of the hosts to start maintenance on</i></td><td style="width:180px;"><i>false</i></td>
</tr>
<tr>
<td style="width:200px;"><i>payload</i></td><td style="width:500px;"><i>the command to execute while hosts are on maintenance</i></td><td style="width:180px;"><i>false</i></td>
</tr>
<tr>
<td style="width:200px;"><i>podids</i></td><td style="width:500px;"><i>the IDs of the pods to start maintenance on</i></td><td style="width:180px;"><i>false</i></td>
</tr>
<tr>
<td style="width:200px;"><i>timeout</i></td><td style="width:500px;"><i>optional operation timeout (in seconds) that overrides the global timeout setting</i></td><td style="width:180px;"><i>false</i></td>
</tr>
<tr>
<td style="width:200px;"><i>zoneids</i></td><td style="width:500px;"><i>the IDs of the zones to start maintenance on</i></td><td style="width:180px;"><i>false</i></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>details</strong></td><td style="width:500px;">in case of failure, details are displayed</td>
</tr>
<tr>
<td style="width:200px;"><strong>success</strong></td><td style="width:500px;">indicates if the rolling maintenance operation was successful</td>
</tr>
<tr>
<td style="width:200px;"><strong>hostsskipped(*)</strong></td><td style="width:500px;">the hosts skipped</td>
<tr>
<td style="width:180px; padding-left:25px;"><strong>hostid</strong></td><td style="width:500px;">the ID of the skipped host</td>
</tr>
<tr>
<td style="width:180px; padding-left:25px;"><strong>hostname</strong></td><td style="width:500px;">the name of the skipped host</td>
</tr>
<tr>
<td style="width:180px; padding-left:25px;"><strong>reason</strong></td><td style="width:500px;">the reason to skip the host</td>
</tr>
</tr>
<tr>
<td style="width:200px;"><strong>hostsupdated(*)</strong></td><td style="width:500px;">the hosts updated</td>
<tr>
<td style="width:180px; padding-left:25px;"><strong>enddate</strong></td><td style="width:500px;">end date of the update on the host</td>
</tr>
<tr>
<td style="width:180px; padding-left:25px;"><strong>hostid</strong></td><td style="width:500px;">the ID of the updated host</td>
</tr>
<tr>
<td style="width:180px; padding-left:25px;"><strong>hostname</strong></td><td style="width:500px;">the name of the updated host</td>
</tr>
<tr>
<td style="width:180px; padding-left:25px;"><strong>output</strong></td><td style="width:500px;">output of the maintenance script on the host</td>
</tr>
<tr>
<td style="width:180px; padding-left:25px;"><strong>startdate</strong></td><td style="width:500px;">start date of the update on the host</td>
</tr>
</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&page=4.2.0/rootadmin"></iframe>
</noscript>
</div>
<div id="footer_maincontroller">
<p>
Copyright © 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>