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

Desktop Scheduling Settings

This section describes desktop scheduling settings of the backup job.

General Settings

Parent Tag

Parameter

Description

ScheduleInfo

Parent tag that encapsulates information about scheduling 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 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 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: mm/dd/yyyy hh:mm:ss.

Note: Veeam Agent Configurator ignores the date part and uses the time part only.

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

Example

You want to enable backup on the following events: user logout and computer lock. The input XML file will contain the following parameters:

<ExecutionResult>
<JobInfo ConfigId="f5bb9cd2-9b7d-4bb3-9c72-435cec24420c" JobName="Backup Job">
     <ScheduleInfo AtLock="True" AtLogOff="True"/>
  </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