Set-VBRWindowsWorkstationScheduleOptions

In this article

    Short Description

    Modifies the schedule of the backup policy for Windows workstations.

    Applies to

    Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Set-VBRWindowsWorkstationScheduleOptions -Options <VBRWindowsWorkstationScheduleOptions> [-EnableDailySchedule][-DailyOptions <VBRDailyOptions>] [-PowerOffAction <VBRPowerOffAction> {SkipBackup | BackupAtPowerOn}][-PostBackupAction <VBRPostBackupAction> {Sleep | Hibernate | Shutdown | KeepRunning}] [-BackupAtLock][-BackupAtLogOff] [-BackupAtTargetConnection] [-EjectStorageAfterBackup] [-BackupTimeout <int>][-BackupTimeoutType <VBRAgentBackupTimeoutType> {Minute | Hour | Day}][<CommonParameters>]

    Detailed Description

    This cmdlet modifies schedule settings for the backup policy that Veeam Agent job applies to Windows workstations. To modify settings, enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

    Set-VBRWindowsWorkstationScheduleOptions Note:

    Use the Set-VBRServerScheduleOptions cmdlet to modify the schedule settings for the following types of jobs:

    • For the backup policy that Veeam Agent job applies to Windows servers.
    • For Veeam Agent jobs that back up Windows servers.
    • For Veeam Agent jobs that back up failover clusters.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Options

    Specifies the daily schedule settings for Windows workstations. The cmdlet will modify the existing daily schedule settings.

    Accepts the VBRWindowsWorkstationSchedule
    Options type.

    True

    Named

    True (ByValue)

     

    DailyOptions

    For daily schedule.

    Specifies daily schedule settings. The cmdlet will create the Veeam Agent backup job with these settings.

    Accepts the VBRDailyOptions type.

    False

    Named

    False

     

    PowerOffAction

    Specifies the action that Veeam Agent for Microsoft Windows must perform when the protected computer is powered off at a time when the scheduled backup job must start.

    • SkipBackup: select this option if you do not want Veeam Agent for Microsoft Windows to start the scheduled backup job when the computer is powered on. Veeam Agent for Microsoft Windows will perform backup at the next scheduled time.
    • BackupAtPowerOn: select this option if you want Veeam Agent for Microsoft Windows to start the scheduled backup job when the protected computer is powered on.

    False

    Named

    False

     

    PostBackupAction

    Specifies the action that Veeam Agent for Microsoft Windows will perform after the backup job completes successfully.

    • Sleep: select this option if you want Veeam Agent for Microsoft Windows to bring the protected computer to the standby mode.
    • Hibernate: select this option if you want Veeam Agent for Microsoft Windows to bring the protected computer to the hibernate mode.
      NOTE: This option is available if the hibernate mode is enabled on the protected computer.
    • Shutdown: select this option if you want Veeam Agent for Microsoft Windows to shut down the protected computer.
    • KeepRunning: select this option if the protected computer must keep on working.

    False

    Named

    False

     

    EnableDailySchedule

    Enables daily schedule.

    Veeam Agent backup job will start at the time specified in the DailyOptions parameter.

    False

    Named

    False

     

    BackupAtLock

    Indicates that the Veeam Agent backup job will start when the user locks the protected computer.

    False

    Named

    False

     

    BackupAtLogOff

    Indicates that the Veeam Agent backup job will start when the user working with the protected computer performs a logout operation.

    False

    Named

    False

     

    BackupTimeout

    Specifies the number of Veeam Agent backup job sessions. Use this option to restrict the frequency of the backup job sessions.

    Use the BackupTimeoutType parameter to set the job interval.

    NOTE: this option does not work for daily schedule.

    False

    Named

    False

     

    BackupTimeoutType

    Specifies an interval between the backup job sessions.

    • Minute: use this option to set up a minute interval between the backup job sessions.
    • Hour: use this option to set up an hourly interval between the backup job sessions.
    • Day: use this option to set up a daily interval between the backup job sessions.

    False

    Named

    False

     

    BackupAtTargetConnection

    Indicates that the Veeam Agent backup job will start when the backup storage becomes available.

    False

    Named

    False

     

    EjectStorageAfterBackup

    For the BackupAtTargetConnection parameter.

    Indicates that Veeam Agent for Microsoft Windows will unmount the storage device after the backup job completes successfully.

    False

    Named

    False

     

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

    Return Type

    Example

    This example shows how to modify a schedule for a Veeam Agent job that backs up Windows workstations.

    1. Run Get-VBRComputerBackupJob to get the backup job that you want to modify. Save the result to the $job variable.
    2. Run New-VBRWindowsWorkstationScheduleOptions to specify the schedule for a Veeam Agent job that backs up Windows workstations. Save the result to the $options variable.
    3. Run New-VBRDailyOptions to specify the daily schedule. Save the result to the $daily variable.
    4. Run Set-VBRWindowsWorkstationScheduleOptions with the $daily and $schedule variables.

    $job = Get-VBRComputerBackupJob -name "Windows_W_Job"

    $options = New-VBRWindowsWorkstationScheduleOptions -BackupAtLock -BackupTimeout 5 -BackupTimeoutType Hour

    $daily = New-VBRDailyOptions -DayOfWeek Wednesday -Period 20:00

    Set-VBRWindowsWorkstationScheduleOptions -Options $options -DailyOptions $daily

    Related Commands

    New-VBRDailyOptions

    New-VBRWindowsWorkstationScheduleOptions

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.