Apache CloudStack 4.23.0.0 Root Admin API Reference

createVMSchedule

Create Instance Schedule

Request parameters

Parameter NameDescriptionRequired
actionAction to take on the Instance (start/stop/reboot/force_stop/force_reboot).true
scheduleSchedule for action on Instance in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'true
timezoneSpecifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.true
virtualmachineidID of the Instance for which schedule is to be definedtrue
descriptionDescription of the schedulefalse
enabledEnable Instance schedule. Defaults to truefalse
enddateEnd date after which the schedule becomes inactive(Format "yyyy-MM-dd hh:mm:ss")false
startdateStart date from which the schedule becomes active. Defaults to current date plus 1 minute.(Format "yyyy-MM-dd hh:mm:ss")false

Response Tags

Response NameDescription
idThe ID of Instance schedule
actionAction
createdDate when the schedule was created
descriptionDescription of Instance schedule
enabledVM schedule is enabled
enddateDate after which the schedule becomes inactive
scheduleCron formatted Instance schedule
startdateDate from which the schedule is active
timezoneTimezone of the schedule
virtualmachineidID of Instance