Name: VirtualMachineSnapshotSchedule

Encapsulates the definition of a snapshot schedule. Moments in time are represented in the cron format. There are five types of the schedules which represent the frequency that the snapshot is taken at the specified moments in time. The five types are: hourly, daily, weekly, monthly, and quarterly. Only one snapshot schedule per snapshot schedule type can be set. If there are no schedules set, then the default datastore snapshot schedule is used.

Data Structure
{
   "typeId": "com.tintri.api.rest.v310.dto.domain.beans.vm.VirtualMachineSnapshotSchedule",
   "consistency": 'CRASH_CONSISTENT' | 'VM_CONSISTENT' | 'APP_CONSISTENT',
   "cronExpressions": <String>,
   "initialDefaultCronExpression": <String>,
   "initialDefaultRetentionMinutes": <Number>,
   "isSystemDefaultSchedule": <Boolean>,
   "name": <String>,
   "retentionDestinationMinutes": <Number>,
   "retentionSourceMinutes": <Number>,
   "type": 'HOURLY' | 'DAILY' | 'WEEKLY' | 'MONTHLY' | 'QUARTERLY',
   "version": <String>,
   "tgcServiceGroupDefault": <Boolean>,
}

Elements
NameTypeDescription
tgcServiceGroupDefaultxsd:booleanBoolean value indicates if the requested Snapshot Schedule is Service Group default from TGC. This helps distinguish between per VM level Snapshot Schedule changes and Service Group level default Snapshot Schedule changes.

Attributes
NameTypeDescription
consistencyCRASH_CONSISTENT | VM_CONSISTENT | APP_CONSISTENTThe snapshot consistency type. Crash consistency is a VMstore snapshot that can be used to recover from a VM crash. VM consistency is a hypervisor snapshot that is hypervisor consistent and can be used to recover from a VM crash. App consistency is not used at this time.
CRASH_CONSISTENTDisk activity quiesed snapshot
VM_CONSISTENTVM activity quiesed snapshot
APP_CONSISTENTApplication activity quiesed snapshot (currently not used)
cronExpressionsxsd:list[xsd:string]A list of quartz cron expressions. The format is:
Field Name Mandatory Allowed Values Allowed Special Characters
Seconds YES 0-59 , - * /
Minutes YES 0-59 , - * /
Hours YES 0-23 , - * /
Day of month YES 1-31 , - * ? / L W
Month YES 1-12 or JAN-DEC , - * /
Day of week YES 1-7 or SUN-SAT , - * ? / L #
Year NO empty, 1970-2099 , - * /
Examples:
  • 0 0 5 ? * sun-sat - every day at 5:00:00 am
  • 0 42 3 ? * sat - every Saturday at 3:42:00 am
initialDefaultCronExpressionxsd:stringDefault cron expressions:
time recurrence retention
Hourly xx:05 every hour Keep 3 hours
Daily 2:30am everyday Keep 2 days
Weekly 7:30am Saturdays Keep 8 days
Monthly 4:30am first day Keep 32 days
Quarterly 6:30am first day Keep 100 days
initialDefaultRetentionMinutesxsd:intThe intial defautlt retention time in minutes.
isSystemDefaultSchedulexsd:booleanReturns true if the schedule name matches any of the default schedule names.
namexsd:stringUser assigned name which by default schedule type. If there is already a schedule of that name, an auto-increment like 'Daily(2)' is performed. The user can overwrite the name by using the virtual machine snapshotSchedule API. The name is unique for a given VM.
retentionDestinationMinutesxsd:intThe length of time in minutes the snapshot replica on the replication destination is to be retained. This number is used to calculate replica snapshot expiration value when the snapshot is sent from source to the destination. On destination side, the snapshot stays until the expiration value.
retentionSourceMinutesxsd:intHow long, in minutes, a snapshot generated as per this schedule is to be retained.
typeHOURLY | DAILY | WEEKLY | MONTHLY | QUARTERLYSchedule type to indicate whether it is hourly, daily, weekly, monthly or quarterly.
HOURLYTime points when snapshot is taken span over a period of one hour.
DAILYTime points when snapshot is taken span over a period of one day i.e. 24 hours.
WEEKLYTime points when snapshot is taken span over a period of one week.
MONTHLYTime points when snapshot is taken span over a period of one month.
QUARTERLYTime points when snapshot is taken span over a period of one quarter of a year.
versionxsd:stringSnapshot schedule version