static/api/apidocs-4.19/apis/createVMSchedule.html (132 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.19.0.0 Root Admin API Reference
</span>
<p></p>
<h1>createVMSchedule</h1>
<p>Create VM Schedule</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>action</strong></td><td style="width:500px;"><strong>Action to take on the VM (start/stop/reboot/force_stop/force_reboot).</strong></td><td style="width:180px;"><strong>true</strong></td>
</tr>
<tr>
<td style="width:200px;"><strong>schedule</strong></td><td style="width:500px;"><strong>Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'</strong></td><td style="width:180px;"><strong>true</strong></td>
</tr>
<tr>
<td style="width:200px;"><strong>timezone</strong></td><td style="width:500px;"><strong>Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.</strong></td><td style="width:180px;"><strong>true</strong></td>
</tr>
<tr>
<td style="width:200px;"><strong>virtualmachineid</strong></td><td style="width:500px;"><strong>ID of the VM for which schedule is to be defined</strong></td><td style="width:180px;"><strong>true</strong></td>
</tr>
<tr>
<td style="width:200px;"><i>description</i></td><td style="width:500px;"><i>Description of the schedule</i></td><td style="width:180px;"><i>false</i></td>
</tr>
<tr>
<td style="width:200px;"><i>enabled</i></td><td style="width:500px;"><i>Enable VM schedule. Defaults to true</i></td><td style="width:180px;"><i>false</i></td>
</tr>
<tr>
<td style="width:200px;"><i>enddate</i></td><td style="width:500px;"><i>end date after which the schedule becomes inactiveUse format "yyyy-MM-dd hh:mm:ss")</i></td><td style="width:180px;"><i>false</i></td>
</tr>
<tr>
<td style="width:200px;"><i>startdate</i></td><td style="width:500px;"><i>start date from which the schedule becomes active. Defaults to current date plus 1 minute.Use format "yyyy-MM-dd hh:mm:ss")</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>id</strong></td><td style="width:500px;">the ID of VM schedule</td>
</tr>
<tr>
<td style="width:200px;"><strong>action</strong></td><td style="width:500px;">Action</td>
</tr>
<tr>
<td style="width:200px;"><strong>created</strong></td><td style="width:500px;">Date when the schedule was created</td>
</tr>
<tr>
<td style="width:200px;"><strong>description</strong></td><td style="width:500px;">Description of VM schedule</td>
</tr>
<tr>
<td style="width:200px;"><strong>enabled</strong></td><td style="width:500px;">VM schedule is enabled</td>
</tr>
<tr>
<td style="width:200px;"><strong>enddate</strong></td><td style="width:500px;">Date after which the schedule becomes inactive</td>
</tr>
<tr>
<td style="width:200px;"><strong>schedule</strong></td><td style="width:500px;">Cron formatted VM schedule</td>
</tr>
<tr>
<td style="width:200px;"><strong>startdate</strong></td><td style="width:500px;">Date from which the schedule is active</td>
</tr>
<tr>
<td style="width:200px;"><strong>timezone</strong></td><td style="width:500px;">Timezone of the schedule</td>
</tr>
<tr>
<td style="width:200px;"><strong>virtualmachineid</strong></td><td style="width:500px;">ID of virtual machine</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&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>