Help Center
Choose product document...
Veeam Agent for Microsoft Windows 3.0
Configurator Reference

Server Scheduling Settings

This section describes server scheduling settings of the backup job.  

General Settings

Parent Tag

Parameter

Description

ScheduleInfo

Parent tag that encapsulates information about scheduling settings.

 

RunManually

Parameter specifies if the backup job must be run manually or started automatically by schedule. Possible values:

  • True — backup job schedule is disabled. The job must be started manually.
  • False — backup job schedule is enabled.

 

Type

Type of job schedule. Possible values:

 

UseBackupWindow

Parameter describes if the backup window is set for the backup job. Possible values:

  • True — backup window is enabled.
  • False — backup window is disabled.

If you set this parameter to True, you must specify backup window settings.

 

CompletionMode

Action that is performed when the backup job is complete. Possible values:

  • 0 — computer remains running.
  • 1 — machine is brought to the Hibernate mode. This option can be used if the Hibernate mode is enabled on the machine. If the Hibernate mode is disabled, Veeam Agent Configurator will set the CompletionMode value to 0 (Keep running).
  • 2 — machine is brought to the Standby mode.
  • 3 — machine is shut down.

 

AtStorageAttach

Parameter describes if the backup job must start when the backup target is connected to the computer — external target disk is attached, shared folder becomes accessible and so on. Possible values:

  • True — backup job is started at storage attach.
  • False — backup job is not started at storage attach.

 

ResumeMissedBackup

Parameter describes what actions Veeam Agent for Microsoft Windows must perform if the machine was powered off when backup was scheduled, and the backup was missed. Possible values:

  • True — Veeam Agent for Microsoft Windows must run the backup job when the computer is powered on.
  • False — Veeam Agent for Microsoft Windows must not run the backup job when the computer is powered on.

 

AtLock

Parameter describes if the backup job must start when the user locks the computer. Possible values:

  • True — backup job starts when the user locks the computer.
  • False — backup job does not start when the user locks the computer.

 

AtLogOff

Parameter describes if the backup job must start when the user performs the logoff operation. Possible values:

  • True — backup job starts when the user logs off the computer.
  • False — backup job does not start when the user logs off the computer.

 

EjectRemovableStorage
OnceBackupIsCompleted

Parameter describes if Veeam Agent for Microsoft Windows must eject the removable storage (backup target) when the backup job session completes. Possible values:

  • True — Veeam Agent for Microsoft Windows ejects the removable storage.
  • False — Veeam Agent for Microsoft Windows does not eject the removable storage.

Important! You must explicitly define a value in the EjectRemovableStorage
OnceBackupIsCompleted parameter. If you do not specify it explicitly, Veeam Agent Configurator will set the parameter value to False (even if the Eject removable storage once backup is completed option is enabled for the job in the UI).

 

LimitBackupsFrequency

Parameter limiting the frequency of backup job sessions in the specified interval. Possible values:

  • True — frequency of backup job sessions is limited.
  • False — frequency of backup job sessions is not limited.

 

MaxBackupsFrequency

This parameter is used only if you have selected to limit the frequency of backup job sessions.

Time interval (in minutes, hours or days) during which a new backup job session must not be started, for example, 30.

 

FrequencyTimeUnit

This parameter is used only if you have selected to limit the frequency of backup job sessions.

Units of time for the time interval limiting the frequency of backup job sessions.

Possible values:

  • 0 — minutes
  • 1 — hours
  • 2 — days

 

Daily Scheduling Settings

Parent Tag

Parameter

Description

DailyInfo

Parent tag that encapsulates information about daily scheduling settings.

 

Kind

Days of week on which the backup job must run. Possible values:

  • 0 — backup job runs every day.
  • 1 — backup job runs on week days (all days of the week except Saturday and Sunday).
  • 2 — backup job runs on specific days. If you set the Kind parameter value to 2, you must list days on which you want to run the backup job in the Days parameter.

 

Days

This parameter is used only if you set the Kind parameter value to 2.

List of days on which you want to run the backup job. Possible values:

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

Entries in the list are separated with a comma followed by a space (, ), for example: Days="Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday".

 

Time

Time at which the backup job must start. The time is specified in the following format: hh:mm.

 

Monthly Scheduling Settings

Parent Tag

Parameter

Description

MonthlyInfo

Parent tag that encapsulates information about monthly scheduling settings.

 

Months

List of months on which the backup job must run. Possible values:

  • January
  • February
  • March
  • April
  • May
  • June
  • July
  • August
  • September
  • October
  • November
  • December

Entries in the list are separated with a comma, for example: Months="January, February, March, April, May, June, July, August, September, October, November, December".

 

DayOfWeek

This parameter is used if you want to run the backup job on the Nth day of the Nth week in the month.

Day on which the backup job must run. Possible values:

  • 0 — Sunday
  • 1 — Monday
  • 2 — Tuesday
  • 3 — Wednesday
  • 4 — Thursday
  • 5 — Friday
  • 6 — Saturday

 

Week

This parameter is used if you want to run the backup job on the Nth day of the Nth week in the month.

Numerical order of the week on which you want to run the backup job. Possible values:

  • 1 — first week of month
  • 2 — second week of month
  • 3 — third week of month
  • 4 — fourth week of month
  • 5 — last week of month
  • 6 — backup job runs on a specific date within a month.

If you set the Week parameter value to 6, you must also specify the DayOfMonth parameter value.

 

DayOfMonth

This parameter is used if you want to run the backup job on a specific date.

Date in a month on which you want to run the backup job. Possible values: 1-30 (or 1-31, depending on the month length) and 32 — the last day of the month. For example, if you want to run the backup job on the 24th of every month, you must set the DayOfMonth parameter to 24; if you want to run the job on the last day of every month, you must set the DayOfMonth parameter to 32;

 

Time

Time at which the backup job must start. The time is specified in the following format: hh:mm.

 

Periodical Scheduling Settings

Parent Tag

Parameter

Description

PeriodicallyInfo

Parent tag that encapsulates information about periodical scheduling settings.

 

Time

Periodicity with which the backup job must start. The time interval for periodicity is specified in the following format: hh:mm.

For example, if you want to run the backup job every 30 minutes, you must set the Time parameter to 00:30. If you want to run the backup job every 2 hours, you must set the Time parameter to 02:00.

Schedule

Parent tag that encapsulates information about periodic job schedule.

 

Minutes

Exact time within an hour when the backup job must start.

For example, if you want to run the backup job every hour and start on the 30th minute of the hour, for example, at 1:30 AM, 2:30 AM, 3:30 AM, 4:30 AM and so on, you must set the Time parameter to 001:00 and Minutes parameter to 30.

 

Kind

This parameter is used if you specify permitted or prohibited hours for the backup job.

Method of setting permitted hours for the backup job. Possible values:

  • 0 —  permitted hours for the backup job are specified.
  • 1 — prohibited hours for the backup job are specified.

Days

This tag is used if you specify permitted or prohibited hours for the backup job.

Parent tag that encapsulates information about permitted or prohibited hours for the backup job.

 

<Weekday> Intervals

This tag is used if you specify permitted or prohibited hours for the backup job.

Intervals of permitted or prohibited hours for the backup job. Intervals of hours are specified for every week day in the following format:

<<Weekday> Intervals="10-12, 22-24"/>.

You can specify several intervals separated with a comma followed by a space (, ). For example:

<Days>

 <Monday Intervals="06-08, 18-20"/>

 <Tuesday Intervals="06-08, 18-20, 22-24"/>

</Days>

Note: If there are more prohibited hours intervals than permitted hours intervals, Veeam Agent Configurator will export information about prohibited hours when you run the SaveConfiguration command, and vice versa.

 

Continuous Scheduling Settings

Parent Tag

Parameter

Description

ContinuouslyInfo

Parent tag that encapsulates information about continuous scheduling settings.

 

Schedule

This tag is used if you specify permitted or prohibited hours for the backup job.

Parent tag that encapsulates information about permitted and prohibited hours set for the backup job.

 

Kind

This parameter is used if you specify permitted and prohibited hours set for the backup job.

Method of setting permitted hours for the backup job. Possible values:

  • 0 —  permitted hours for the backup job are specified.
  • 1 — prohibited hours for the backup job are specified.

Days

This tag is used if you specify permitted or prohibited hours for the backup job.

Parent tag that encapsulates information about permitted or prohibited hours for the backup job.

 

<Weekday> Intervals

This tag is used if you specify permitted or prohibited hours for the backup job.

Intervals of permitted or prohibited hours for the backup job. The interval of hours is specified for every week day in the following format:

<<Weekday> Intervals="10-12, 22-24"/>.

You can specify several intervals separated with a comma followed by a space (, ). For example:

<Days>

 <Monday Intervals="06-08, 18-20"/>

 <Tuesday Intervals="06-08, 18-20, 22-24"/>

</Days>

Note: If there are more prohibited hours intervals than permitted hours intervals, Veeam Agent Configurator will export information about prohibited hours when you run the SaveConfiguration command, and vice versa.

 

Synthetic Full Backup Settings

Parent Tag

Parameter

Description

SyntheticFull

Parent tag that encapsulates information about synthetic full backups created with the backup job.

 

Enabled

Parameter specifies if the backup job must periodically create synthetic full backups. Possible values:

  • True — backup job creates synthetic full backups.
  • False — backup job does not create synthetic full backups.

 

Days

List of days on which the backup job must create synthetic full backups. Possible values:

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

Entries in the list are separated with a comma followed by a space (, ), for example: Days="Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday".

 

Active Full Backup Settings

Parent Tag

Parameter

Description

ActiveFull

Parent tag that encapsulates information about active full backups created with the backup job.

 

Enabled

Parameter specifies if the backup job must periodically create active full backups. Possible values:

  • True — backup job creates active full backups.
  • False — backup job does not create active full backups.

 

Kind

Mode in which the backup job creates active full backups. Possible values:

  • 0 — backup job creates active full backups on specific days of week. If you set the Kind parameter to 0, you must specify the Days parameter.
  • 1 — backup job creates active full backups on a specific day every month. If you set the Kind parameter to 1, you must specify Months, DayofWeek and Week parameters.

DailyInfo

This parameter is used if you want to create active full backups on specific days of week.

Parent tag that encapsulates information about daily settings for active full backups.

 

Days

This parameter is used if you want to create active full backups on specific days of week.

List of days on which the backup job must create active full backups. Possible values:

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

Entries in the list are separated with a comma followed by a space (, ), for example: Days="Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday".

MonthlyInfo

This parameter is used if you want to create active full backups on a specific day every month.

Parent tag that encapsulates information about monthly settings for active full backups.

 

Months

This parameter is used if you want to create active full backups on a specific day every month.

List of months on which the backup job must create active full backups. Possible values:

  • January
  • February
  • March
  • April
  • May
  • June
  • July
  • August
  • September
  • October
  • November
  • December

Entries in the list are separated with a comma followed by a space (, ), for example: Months="January, February, March, April, May, June, July, August, September, October, November, December".

 

DayOfWeek

This parameter is used if you want to create active full backups on a specific day every month.

Day on which the backup job must create an active full backup. Possible values:

  • 0 — Sunday
  • 1 — Monday
  • 2 — Tuesday
  • 3 — Wednesday
  • 4 — Thursday
  • 5 — Friday
  • 6 — Saturday

 

Week

This parameter is used if you want to create active full backups on a specific day every month.

Numerical order of week on which the backup job must create an active full backup. Possible values:

  • 1 — first week of month
  • 2 — second week of month
  • 3 — third week of month
  • 4 — fourth week of month
  • 5 — last week of month

Health Check Settings

Parent Tag

Parameter

Description

HealthCheck

Parent tag that encapsulates information about health checks of the latest restore point in the backup chain.

 

Enabled

Parameter specifies if Veeam Agent for Microsoft Windows must perform heath checks of the latest restore point in the backup chain. Possible values:

  • True — Veeam Agent for Microsoft Windows performs heath checks.
  • False — Veeam Agent for Microsoft Windows does not perform heath checks.

DailyInfo

 

This parameter is used if you want to perform health checks on specific days of week.

Parent tag that encapsulates information about daily settings for health checks.

 

Days

This parameter is used if you want to health checks on specific days of week.

List of days on which Veeam Agent for Microsoft Windows must perform health checks of the latest restore point in the backup chain. Possible values:

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

Entries in the list are separated with a comma followed by a space (, ), for example: Days="Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday".

MonthlyInfo

 

This parameter is used if you want to perform health checks on a specific day every month.

Parent tag that encapsulates information about monthly settings for health checks.

 

Months

This parameter is used if you want to perform health checks on a specific day every month.

List of months on which Veeam Agent for Microsoft Windows must perform health checks of the latest restore point in the backup chain. Possible values:

  • January
  • February
  • March
  • April
  • May
  • June
  • July
  • August
  • September
  • October
  • November
  • December

Entries in the list are separated with a comma followed by a space (, ), for example: Months="January, February, March, April, May, June, July, August, September, October, November, December".

 

DayOfWeek

This parameter is used if you want to perform health checks on a specific day every month.

Day on which Veeam Agent for Microsoft Windows must perform health checks of the latest restore point in the backup chain. Possible values:

  • 0 — Sunday
  • 1 — Monday
  • 2 — Tuesday
  • 3 — Wednesday
  • 4 — Thursday
  • 5 — Friday
  • 6 — Saturday

 

Week

This parameter is used if you want to perform health checks on a specific day every month.

Numerical order of week on which Veeam Agent for Microsoft Windows must perform health checks of the latest restore point in the backup chain. Possible values:

  • 1 — first week of month
  • 2 — second week of month
  • 3 — third week of month
  • 4 — fourth week of month
  • 5 — last week of month

Backup File Compact Settings

Parent Tag

Parameter

Description

Compact

Parent tag that encapsulates information about defragment and compact operations of the full backup file.

 

Enabled

Parameter specifies if Veeam Agent for Microsoft Windows must perform defragment and compact operations of the full backup file. Possible values:

  • True — Veeam Agent for Microsoft Windows performs defragment and compact operations.
  • False — Veeam Agent for Microsoft Windows does not perform defragment and compact operations.

DailyInfo

 

This parameter is used if you want to perform defragment and compact operations on specific days of week.

Parent tag that encapsulates information about daily settings for defragment and compact operations.

 

Days

This parameter is used if you want to perform defragment and compact operations on specific days of week.

List of days on which Veeam Agent for Microsoft Windows must perform defragment and compact operations. Possible values:

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

Entries in the list are separated with a comma followed by a space (, ), for example: Days="Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday".

MonthlyInfo

 

This parameter is used if you want to perform defragment and compact operations on a specific day every month.

Parent tag that encapsulates information about monthly settings for defragment and compact operations.

 

Months

This parameter is used if you want to perform defragment and compact operations on a specific day every month.

List of months on which Veeam Agent for Microsoft Windows must perform defragment and compact operations. Possible values:

  • January
  • February
  • March
  • April
  • May
  • June
  • July
  • August
  • September
  • October
  • November
  • December

Entries in the list are separated with a comma followed by a space (, ), for example: Months="January, February, March, April, May, June, July, August, September, October, November, December".

 

DayOfWeek

This parameter is used if you want to perform defragment and compact operations on a specific day every month.

Day on which Veeam Agent for Microsoft Windows must perform defragment and compact operations. Possible values:

  • 0 — Sunday
  • 1 — Monday
  • 2 — Tuesday
  • 3 — Wednesday
  • 4 — Thursday
  • 5 — Friday
  • 6 — Saturday

 

Week

This parameter is used if you want to perform defragment and compact operations on a specific day every month.

Numerical order of week on which Veeam Agent for Microsoft Windows must perform defragment and compact operations. Possible values:

  • 1 — first week of month
  • 2 — second week of month
  • 3 — third week of month
  • 4 — fourth week of month
  • 5 — last week of month

Job Retry Settings

Parent Tag

Parameter

Description

RetryInfo

Parent tag that encapsulates information about job retry settings.

 

Enabled

Parameter specifies if Veeam Agent for Microsoft Windows must automatically retry the backup job if the job fails. Possible values:

  • True — Veeam Agent for Microsoft Windows retries the backup job. If you set the Enabled parameter to True, you must specify the number of times for which Veeam Agent for Microsoft Windows must retry the job, and time interval between job retries.
  • False — Veeam Agent for Microsoft Windows does not retry the backup job.

 

Times

Number of times for which Veeam Agent for Microsoft Windows must retry a backup job. By default, Veeam Agent for Microsoft Windows retries the backup job 3 times.

 

TimeoutMinutes

Time interval between job retries in minutes. By default, the time interval is 10 minutes.

Note: the TimeoutMinutes parameter is not applicable if the backup job runs continuously. In this case, Veeam Agent for Microsoft Windows will retry the job without any time intervals.

 

Backup Window Settings

Parent Tag

Parameter

Description

BackupWindow

Parent tag that encapsulates information about the backup window set for the job.

If the backup job exceeds the specified window, the job will be terminated.

 

Kind

Method of setting the backup window. Possible values:

  • 0 —  permitted hours for the backup window are specified.
  • 1 — prohibited hours for the backup window are specified.

Days

Parent tag that encapsulates information about the backup window for the backup job.

 

<Weekday> Intervals

Intervals of permitted or prohibited hours for the backup job. The interval of hours is specified for every week day in the following format:

<Monday Intervals="10-12, 22-24"/>.

You can specify several intervals separated with a comma followed by space (, ). For example:

<Days>

 <Monday Intervals="06-08, 18-20"/>

 <Tuesday Intervals="06-08, 18-20, 22-24"/>

</Days>

Note: If there are more prohibited hours intervals than permitted hours intervals, Veeam Agent Configurator will export information about prohibited hours when you run the SaveConfiguration command, and vice versa.

Example 1

You want to run the backup job continuously with the following schedule:

The input XML file will contain the following parameters:

<ExecutionResult>
<JobInfo ConfigId="f5bb9cd2-9b7d-4bb3-9c72-435cec24420c" JobName="Backup Job">
     <ScheduleInfo Type="4" RunManually="False">
       <ContinuouslyInfo>
         <Schedule Kind="1">
           <Days>
             <Monday Intervals="06-18"/>
             <Tuesday Intervals="06-18"/>
             <Wednesday Intervals="06-18"/>
             <Thursday Intervals="06-18"/>
             <Friday Intervals="06-18"/>
           </Days>
         </Schedule>
       </ContinuouslyInfo>
     </ScheduleInfo>
  </JobInfo>
</ExecutionResult>

Example 2

You want to run the backup job daily at 12:00 AM, and set up the following backup window for the job:

The input XML file will contain the following parameters:

<ExecutionResult>
<JobInfo ConfigId="f5bb9cd2-9b7d-4bb3-9c72-435cec24420c" JobName="Backup Job">
     <ScheduleInfo Type="1" UseBackupWindow="True" RunManually="False">
 <DailyInfo Kind="0" Days="Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday" Time="00:00:00"/>
       <BackupWindow Kind="1">
         <Days>
           <Monday Intervals="06-18"/>
           <Tuesday Intervals="06-18"/>
           <Wednesday Intervals="06-18"/>
           <Thursday Intervals="06-18"/>
           <Friday Intervals="06-16"/>
         </Days>
       </BackupWindow>
     </ScheduleInfo>
  </JobInfo>
</ExecutionResult>

 

Veeam Large Logo

User Guide

Configurator Reference

Veeam Agent Management Guide

Veeam Backup & Replication Documentation

Veeam ONE Documentation

Veeam Management Pack Documentation

Veeam Agent for Linux Documentation