Apache CloudStack 4.21.0.0 Root Admin API Reference
updateBackupSchedule
Updates a user-defined VM backup schedule
Request parameters
| Parameter Name | Description | Required |
| intervaltype | valid values are HOURLY, DAILY, WEEKLY, and MONTHLY | true |
| schedule | custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28) | true |
| timezone | Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format. | true |
| virtualmachineid | ID of the VM for which schedule is to be defined | true |
| maxbackups | The maximum number of backups to keep for a VM. If "0", no retention policy will be applied and, thus, no backups from the schedule will be automatically deleted. This parameter is only supported for the Dummy, NAS and EMC Networker backup provider. | false |
| quiescevm | Quiesce the instance before checkpointing the disks for backup. Applicable only to NAS backup provider. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running. | false |
Response Tags
| Response Name | Description |
| id | ID of the VM backup |
| account | account name |
| accountid | account id |
| backupofferingid | backup offering id |
| backupofferingname | backup offering name |
| created | backup date |
| description | description for the backup |
| domain | domain name |
| domainid | domain id |
| externalid | external backup id |
| intervaltype | Interval type of the backup |
| name | name of the backup |
| size | backup size in bytes |
| status | backup status |
| type | backup type |
| virtualmachineid | ID of the VM |
| virtualmachinename | name of the VM |
| virtualsize | backup protected (virtual) size in bytes |
| vmbackupofferingremoved | The backup offering corresponding to this backup was removed from the VM |
| vmdetails | Lists the vm specific details for the backup |
| volumes | backed up volumes |
| zone | zone name |
| zoneid | zone id |