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

Workstation Operation Mode

If the operationMode property has value Workstation the /BackupPolicies/{ID} resource can have the following workstation mode specific properties:

Property

Type

Description

workstationOperationModeScheduleSetting

WorkstationOperationModeScheduleSetting

Indicates the schedule for a backup job.

WorkstationOperationModeScheduleSetting

Property

Type

Description

backupAtLock

boolean

Indicates whether a backup job starts when a workstation is locked.

backupAtLogoff

boolean

Indicates whether a backup job starts when a workstation user logs off.

backupAtTargetConnection

boolean

Indicates whether a backup job starts when a remote backup target is attached to a workstation.

ejectTargetAfterwards

boolean

Indicates whether a remote backup target is ejected when a backup job completes.

Only present if the backupAtTargetConnection property has value true.

backupTimeout

integer

Indicates a timeout for a backup job start.

backupTimeoutUnit

string

Measurement units for backup timeout.

Possible values:

  • Minutes
  • Hours
  • Days

dailyScheduleEnabled

boolean

Indicates whether a daily schedule is enabled for a backup job.

dailySchedule

ScheduleTypeDaily

Indicates a daily schedule for a backup job.

Only present if the dailyScheduleEnabled property has value true.

shutdownAction

string

Indicates backup job behavior in case the workstation is off at the time a job is scheduled.

Possible values:

  • ResumeBackup
  • SkipBackup

Only present if the dailyScheduleEnabled property has value true.

postbackAction

string

Indicates action to perform after a backup job is complete.

Possible values:

  • RemainsRunning
  • BroughtToHibernate
  • BroughtToStandBy
  • ShutDown

Only present if the dailyScheduleEnabled property has value true.

 

Veeam Large Logo

Deployment Guide

Migration Guide

Administrator Guide for Service Providers

User Guide for Service Providers

Evaluator's Guide for Service Providers

Administrator Guide for Enterprises

User Guide for Enterprises

Evaluator's Guide for Enterprises

RESTful API Reference