Apache CloudStack 4.19.0.0 Root Admin API Reference

createVMSchedule

Create VM Schedule

Request parameters

Parameter NameDescriptionRequired
actionAction to take on the VM (start/stop/reboot/force_stop/force_reboot).true
scheduleSchedule for action on VM 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 VM for which schedule is to be definedtrue
descriptionDescription of the schedulefalse
enabledEnable VM schedule. Defaults to truefalse
enddateend date after which the schedule becomes inactiveUse format "yyyy-MM-dd hh:mm:ss")false
startdatestart date from which the schedule becomes active. Defaults to current date plus 1 minute.Use format "yyyy-MM-dd hh:mm:ss")false

Response Tags

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