This setting matches functionality in the SilverWind portal's Web Monitor, including parameters, defaults and usages.
- Default
- Minutely
- Hourly
- Daily
- Weekly
Default
The schedule can be specified in a special "schedule" JSON parameter.
If it is not specified, the following default is applied - every day of the week at 23:00.
Important Notes:
- Minutely is available only for Files and Folders. Physical Imaging Standard does not support the Minutely type.
- Multiple daily and weekly schedules are added as needed with no restrictions.
- If a minutely or hourly schedule is added, additional schedules cannot be added for the same backup set.
Manual
This setting allows backup sets to be run manually, without specifying a time schedule.
Only one Manual schedule item is allowed, and no other schedule types can be chosen.
Example:
{"type":"Files","selection":["C:"], "schedule": [{"type": "manual"}]}'
Minutely
This command allows backups to run every N minutes.
Interval values are: 15, 30, 45, 60, 90 and 120.
Example
The following example code creates the backup set with a schedule to run every 15 hours:
{
"name": "Test backup set",
"type": "Files",
"selection": [
"c:"
],
"schedule": [
{
"type": "minutely",
"interval": 30
}
]
}
Hourly
This command allows backups to run every N hours.
Interval values are between 1 and 23.
Example
The following example code creates the backup set with a schedule to run every 2 hours.
{
"name": "Test backup set",
"type": "Files",
"selection": [
"c:"
],
"schedule": [
{
"type": "hourly",
"interval": 2
}
]
}
Daily
The daily command adds daily schedules and runs only during working days (Monday through Friday) via the WorkDaysOnly property. By default, if WorkDaysOnly is not specified, the schedule runs Monday through Sunday.
Allowed values:
- Hour: 0 - 23
- Minute: 0 - 59
- WorkDaysOnly: true or false
- CancelAt:
¾ Hour: 0 - 23
¾ Minute: 0 - 59
Example
The following example code creates the backup set with a schedule to run every day Monday through Sunday @14:10.
{
"name": "Test Backup set",
"type": "Files",
"selection": [
"C:"
],
"schedule": [
{
"type": "daily",
"hour": 14,
"minute": 10
"cancelAt": {
"hour": 17,
"minute": 10
}
}
]
}
Example 2
The following example code creates the backup set with a schedule to run Daily, every working day Monday through Friday @19:20.
{
"name": "Test Backup Set",
"type": "Files",
"selection": [
"C:"
],
"schedule": [
{
"type": "daily",
"workDaysOnly": true,
"hour": 19,
"minute": 20
}
]
}
Weekly
Allows specifying weekly schedules and specifying the days of the week when the backup should be running.
Allowed values:
- Day: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday or Sunday
- Hour: 0 - 23
- Minute: 0 – 59
- CancelAt:
¾ Hour: 0 - 23
¾ Minute: 0 - 59
Example
The following example code creates the backup set with a schedule to run Weekly, every Wed and Thu @18:19.
{
"name": "Test Backup Set",
"type": "Disk_Image",
"selection": [
"C:"
],
"schedule": [
{
"type": "weekly",
"day": "wednesday",
"hour": 18,
"minute": 19,
"cancelAt": {
"hour": 21,
"minute": 10
}
},
{
"type": "weekly",
"day": "thursday",
"hour": 18,
"minute": 19
}
]
}
Example Combined Schedules
{
"name": "Test BackupSet",
"type": "Disk_Image",
"selection": [
"c:"
],
"schedule": [
{
"type": "daily",
"workDaysOnly": true,
"hour": 14,
"minute": 15
},
{
"type": "weekly",
"day": "wednesday",
"hour": 18,
"minute": 19
},
{
"type": "weekly",
"day": "thursday",
"hour": 19,
"minute": 30,
}
]
}