---
title: "New-VBRWindowsWorkstationScheduleOptions"
description: "Creates the schedule for the backup policy for Windows workstations. Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License This cmdlet provides the following parameter sets: Daily Default The cmdlet creates the VB"
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/new-vbrwindowsworkstationscheduleoptions.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Veeam Agent Management > Working with Veeam Agent Backup Jobs and Policies > Veeam Agent Job Schedule > New-VBRWindowsWorkstationScheduleOptions"
dateModified: "2026-08-19"
---

# New-VBRWindowsWorkstationScheduleOptions

## Short Description
Creates the schedule for the backup policy for Windows workstations.

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

## Syntax

This cmdlet provides the following parameter sets:

<ul class="syntax-sets">
  <li>
    <p><code>Daily</code></p>

```
New-VBRWindowsWorkstationScheduleOptions [-EnableDailySchedule] -DailyOptions <VBRDailyOptions>
 -PowerOffAction <VBRPowerOffAction> -PostBackupAction <VBRPostBackupAction> [-BackupAtLock] [-BackupAtLogOff]
 [-BackupAtTargetConnection] [-EjectStorageAfterBackup] [-BackupTimeout <Int32>]
 [-BackupTimeoutType <VBRAgentBackupTimeoutType>] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>Default</code></p>

```
New-VBRWindowsWorkstationScheduleOptions [-BackupAtLock] [-BackupAtLogOff] [-BackupAtTargetConnection]
 [-EjectStorageAfterBackup] [-BackupTimeout <Int32>] [-BackupTimeoutType <VBRAgentBackupTimeoutType>] [<CommonParameters>]
```
  </li>
</ul>

## Detailed Description
The cmdlet creates the `VBRWindowsWorkstationScheduleOptions` object. This object contains schedule settings for the backup policy that Veeam Agent job applies to Windows workstations.

::: note

Use the [`New-VBRServerScheduleOptions`](new-vbrserverscheduleoptions.md) cmdlet to create the schedule settings for the following types of jobs:

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

:::

## 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>For backups at a particular event.</p><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>For backups at a particular event.</p><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>For backups at a particular event.</p><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>For backups at a particular event.</p><p>Specifies an interval between 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>For the <code>BackupTimeout</code> parameter.</p><p>Specifies an interval between the Veeam Agent backup job. Use the following types of time interval:</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 periodical backups.</p><p>Specifies daily schedule settings. The cmdlet will create the server schedule with these settings.</p><p>Accepts the <a href="vbrdailyoptions.md"><code>VBRDailyOptions</code></a> 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>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">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>For periodical backups.</p><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">PostBackupAction</span></p>
        </td>
        <td>
          <p>For periodical backups.</p><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>True</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>For periodical backups.</p><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>True</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
### Example 1. Creating Daily Schedule for Veeam Agent Job for Windows Workstations

This example shows how to create a schedule for a Veeam Agent job that backs up Windows workstations. The job will run with the following settings:

- The job will run every day at 7:00 AM.
- In case the protected computer is powered off when the backup job starts, Veeam Agent for Microsoft Windows will start the scheduled backup job when the protected computer is powered on.
- Veeam Agent for Microsoft Windows will bring the computer to the hibernate mode after the backup job completes successfully.
- Veeam Agent for Microsoft Windows will back up the protected computer when the user logs off.

```
$daily = New-VBRDailyOptions -Type Everyday -Period 7:00
New-VBRWindowsWorkstationScheduleOptions -DailyOptions $daily -EnableDailySchedule -PowerOffAction BackupAtPowerOn -PostBackupAction Hibernate -BackupAtLogOff
```

Perform the following steps:

1. Run the [`New-VBRDailyOptions`](new-vbrdailyoptions.md) cmdlet. Specify the `Type` and `Period` parameter values. Save the result to the `$daily` variable.
2. Run the `New-VBRWindowsWorkstationScheduleOptions` cmdlet. Specify the following settings:

   - Set the `$daily` variable as the `DailyOptions` parameter value.
   - Provide the `EnableDailySchedule` parameter.
   - Set the `BackupAtPowerOn` option for the `PowerOffAction` parameter.
   - Set the `Hibernate` option for the `PostBackupAction` parameter.
   - Provide the `BackupAtLogOff` parameter.

:::

::: example
### Example 2. Creating Schedule for Veeam Agent Job for Windows Workstations

This command creates a schedule for Windows workstation. Per this schedule, Veeam Backup & Replication will start a backup session when the user locks the machine. Provide the `BackupTimeout` parameter to set the interval between Veeam Agent backup jobs to 5 hours.

```
New-VBRWindowsWorkstationScheduleOptions -BackupAtLock -BackupTimeout 5 -BackupTimeoutType Hour
```

:::

## Related Commands

[`New-VBRDailyOptions`](new-vbrdailyoptions.md)