Help Center
Choose product document...
Veeam Availability Console 2.0 Update 1
RESTful API Reference

Schedule Settings

If the schedulingEnabled property has value true the resource can have the following scheduling properties:

Property

Type

Description

retryEnabled

boolean

Indicates whether automatic retry is enabled for a backup job.

retryNumber

integer

Number of automatic retries for the backup job.

Only present if the retryEnabled property has value true.

retryTimeout

integer

Time interval before each retry attempt for the backup job.

Only present if the retryEnabled property has value true.

retryTimeoutUnits

string

Measurement units for time interval before each retry attempt for the backup job. Has the constant value mins.

Only present if the retryEnabled property has value true.

terminationEnabled

boolean

Indicates whether termination is enabled for a backup job in case it exceeds the allowed backup window.

Only present if the retryEnabled property has value true.

terminationWindow

ScheduleDay

Indicates the backup window for a job.

Only present if the retryEnabled property has value true.

scheduleType

string

Schedule type for a backup job.

Possible values:

  • NotScheduled
  • Unknown
  • Daily
  • Monthly
  • Periodically
  • Continuously

scheduleTypeDaily

ScheduleTypeDaily

Indicates the daily schedule for a backup job.

Only present if the scheduleType property has value Daily.

scheduleTypeMonthly

ScheduleTypeMonthly

Indicates the monthly schedule for a backup job.

Only present if the scheduleType property has value Monthly.

scheduleTypePeriodically

ScheduleTypePeriodically

Indicates the periodical schedule for a backup job.

Only present if the scheduleType property has value Periodically.

ScheduleTypeDaily

If the scheduleType property has value Daily the resource can have the following properties:

Property

Type

Description

dailyTime

string

Time at which a job starts.

Time string is formatted in accordance with ISO 8601.

dailyType

string

Type of daily schedule for a backup job.

Possible values:

  • EveryDay
  • WeekDays
  • SelectedDays

dailyDays

Array[string]

Days of the week for which a backup job is scheduled.

ScheduleTypeMonthly

If the scheduleType property has value Monthly the resource can have the following properties:

Property

Type

Description

monthlyTime

string

Time at which a job starts.

Time string is formatted in accordance with ISO 8601.

monthlyDayNumber

integer

Indicates the ordinal number of the day of the month for which a job is scheduled.

The minimum value is 1. The maximum value is 31.

monthlyWeek

string

Indicates the ordinal number of the week for which a job is scheduled. If the property has value Day it indicates that the job is scheduled for a specific day of the month.

Possible values:

  • Unspecified
  • First
  • Second
  • Third
  • Fourth
  • Last
  • Day

monthlyDay

string

Indicates the day of the week for which a job is scheduled.

Possible values:

  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday

monthlyMonths

Array[string]

Indicates the months for which a job is scheduled.

ScheduleTypePeriodically

If the scheduleType property has value Periodically the resource can have the following properties:

Property

Type

Description

periodicInterval

integer

Interval for periodic job start.

periodicType

string

Measurement units for a periodic interval.

Possible values:

  • Minutes
  • Hours

periodicStartTime

integer

Start time in minutes within an hour.

The minimum value is 1. The maximum value is 59.

scheduleWindow

ScheduleDay

Indicates time periods for a job start.

ScheduleDay

Property

Type

Description

day

string

Day of the week.

Possible values:

  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday

hours

Array[integer]

Schedule hours.

The maximum value is 23.

 

Veeam Large Logo

Deployment Guide

Administrator Guide for Service Providers

User Guide for Service Providers

Quick Start Guide for Service Providers

Administrator Guide for Enterprises

User Guide for Enterprises

Quick Start Guide for Enterprises

RESTful API Reference