---
title: "Set-VBRWindowsWorkstationScheduleOptions"
description: "This cmdlet modifies schedule settings for the backup policy that Veeam Agent job applies to Windows workstations. Use the Set-VBRServerScheduleOptions cmdlet to modify the schedule settings for the following types of jobs: For the backup policy..."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/set-vbrwindowsworkstationscheduleoptions.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Veeam Agent Management > Working with Veeam Agent Backup Jobs and Policies > Veeam Agent Job Schedule > Set-VBRWindowsWorkstationScheduleOptions"
dateModified: "2026-08-19"
---

# Set-VBRWindowsWorkstationScheduleOptions

## Short Description
Modifies the schedule of the backup policy for Windows workstations.

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

## Syntax
```
Set-VBRWindowsWorkstationScheduleOptions -Options <VBRWindowsWorkstationScheduleOptions> [-EnableDailySchedule]
 [-DailyOptions <VBRDailyOptions>] [-PowerOffAction <VBRPowerOffAction>]
 [-PostBackupAction <VBRPostBackupAction>] [-BackupAtLock] [-BackupAtLogOff] [-BackupAtTargetConnection]
 [-EjectStorageAfterBackup] [-BackupTimeout <Int32>] [-BackupTimeoutType <VBRAgentBackupTimeoutType>] [<CommonParameters>]
```

## Detailed Description
This cmdlet modifies schedule settings for the backup policy that Veeam Agent job applies to Windows workstations.

::: important

Use the [`Set-VBRServerScheduleOptions`](set-vbrserverscheduleoptions.md) 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.

:::

::: note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

:::

## Parameters

<table style="width:100%;" class="Blue_Table">
      <tr style="vertical-align:top">
        <th style="width:20%;">
          <p>Parameter</p>
        </th>
        <th style="width:20%;">
          <p>Description</p>
        </th>
        <th style="width:20%;">
          <p>Type</p>
        </th>
        <th style="width:10%;">
          <p>Required</p>
        </th>
        <th style="width:10%;">
          <p>Position</p>
        </th>
        <th style="width:10%;">
          <p>Accept Pipeline Input</p>
        </th>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">BackupAtLock</span></p>
        </td>
        <td>
          <p>Defines that the Veeam Agent backup job will start when the user locks the protected computer.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">BackupAtLogOff</span></p>
        </td>
        <td>
          <p>Defines that the Veeam Agent backup job will start when the user working with the protected computer performs a logout operation.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">BackupAtTargetConnection</span></p>
        </td>
        <td>
          <p>Defines that the Veeam Agent backup job will start when the backup storage becomes available.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">BackupTimeout</span></p>
        </td>
        <td>
          <p>Specifies the number of Veeam Agent backup job sessions. Use this option to restrict the frequency of the backup job sessions.</p><p>Use the <code>BackupTimeoutType</code> parameter to set the job interval.</p><p><strong>Note</strong>: this option does not work for daily schedule.</p>
        </td>
        <td style="width:10%;">
          <p><code>Int32</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">BackupTimeoutType</span></p>
        </td>
        <td>
          <p>Specifies an interval between the backup job sessions.</p><ul><li><code>Minute</code>: use this option to set up a minute interval between the backup job sessions.</li><li><code>Hour</code>: use this option to set up an hourly interval between the backup job sessions.</li><li><code>Day</code>: use this option to set up a daily interval between the backup job sessions.</li></ul>
        </td>
        <td style="width:10%;">
          <p><code>VBRAgentBackupTimeoutType</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">DailyOptions</span></p>
        </td>
        <td>
          <p>For daily schedule.</p><p>Specifies daily schedule settings. The cmdlet will create the Veeam Agent backup job with these settings.</p><p>Accepts the <code>VBRDailyOptions</code> object. To get this object, run the<a href="new-vbrdailyoptions.md"><code> New-VBRDailyOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrdailyoptions.md"><code>VBRDailyOptions</code></a></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EjectStorageAfterBackup</span></p>
        </td>
        <td>
          <p>For the <code>BackupAtTargetConnection</code> parameter.</p><p>Defines that Veeam Agent for Microsoft Windows will unmount the storage device after the backup job completes successfully.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">EnableDailySchedule</span></p>
        </td>
        <td>
          <p>Enables daily schedule.</p><p>Veeam Agent backup job will start at the time specified in the <code>DailyOptions</code> parameter.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Options</span></p>
        </td>
        <td>
          <p>Specifies the daily schedule settings for Windows workstations. The cmdlet will modify the existing daily schedule settings.</p><p>Accepts the <code>VBRWindowsWorkstationScheduleOptions</code> object. To get this object, run the <a href="new-vbrwindowsworkstationscheduleoptions.md"><code>New-VBRWindowsWorkstationScheduleOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRWindowsWorkstationScheduleOptions</code></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">PostBackupAction</span></p>
        </td>
        <td>
          <p>Specifies the action that Veeam Agent for Microsoft Windows will perform after the backup job completes successfully.</p><ul><li><code>Sleep</code>: select this option if you want Veeam Agent for Microsoft Windows to bring the protected computer to the standby mode.</li><li><code>Hibernate</code>: select this option if you want Veeam Agent for Microsoft Windows to bring the protected computer to the hibernate mode. <strong>Note</strong>: This option is available if the hibernate mode is enabled on the protected computer.</li><li><code>Shutdown</code>: select this option if you want Veeam Agent for Microsoft Windows to shut down the protected computer.</li><li><code>KeepRunning</code>: select this option if the protected computer must keep on working.</li></ul>
        </td>
        <td style="width:10%;">
          <p><code>VBRPostBackupAction</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">PowerOffAction</span></p>
        </td>
        <td>
          <p>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.</p><ul><li><code>SkipBackup</code>: 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.</li><li><code>BackupAtPowerOn</code>: select this option if you want Veeam Agent for Microsoft Windows to start the scheduled backup job when the protected computer is powered on.</li></ul>
        </td>
        <td style="width:10%;">
          <p><code>VBRPowerOffAction</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
    </table>

`<CommonParameters>`

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see [ Microsoft Docs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7).

## Output Object
This cmdlet returns the `VBRWindowsWorkstationScheduleOptions` object that contains the schedule for the backup policy for Windows workstations.

## Examples

::: example
### Modifying Schedule for Veeam Agent Job for Windows Workstations

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

```
$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
```

Perform the following steps:

1. Run the [`Get-VBRComputerBackupJob`](get-vbrcomputerbackupjob.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$job` variable.
2. Run the [`New-VBRWindowsWorkstationScheduleOptions`](new-vbrwindowsworkstationscheduleoptions.md) cmdlet. Provide the `BackupAtLock` parameter. Specify the `BackupTimeout` and `BackupTimeoutType` parameter values. Save the result to the `$options` variable.
3. Run the [`New-VBRDailyOptions`](new-vbrdailyoptions.md) cmdlet. Specify the `DayOfWeek` and `Period` parameter values. Save the result to the `$daily` variable.
4. Run the `Set-VBRWindowsWorkstationScheduleOptions` cmdlet. Set the `$options` variable as the `Options` parameter value. Set the `$daily` variable as the `DailyOptions` parameter value.

:::

## Related Commands

- [`New-VBRDailyOptions`](new-vbrdailyoptions.md)
- [`New-VBRWindowsWorkstationScheduleOptions`](new-vbrwindowsworkstationscheduleoptions.md)
- [`Get-VBRComputerBackupJob`](get-vbrcomputerbackupjob.md)