New-VBRBackupWindowOptions

Short Description

Defines backup window settings for a job.

Applies to

Platform: VMware, Hyper-V

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

Syntax

New-VBRBackupWindowOptions [-Enabled] [-FromDay <DayOfWeek>] [-FromHour <Int32>] [-ToDay <DayOfWeek>] [-ToHour <Int32>]  [<CommonParameters>]

Detailed Description

This cmdlet creates the VBRBackupWindowOptions object. This object contains backup window settings for a job. These settings define a time interval within which the job must be completed. You can apply these settings to a job.

For more information on the backup windows option, see the Backup Window section in the User Guide for VMware vSphere.

Run the Set-VBRJobSchedule cmdlet to apply backup window settings to the backup, replication or backup copy job.

Run the New-VBRBackupToTapeScheduleOptions cmdlet to apply backup window settings to a backup to tape job.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

FromDay

Specifies the day of week on which the backup window opens.

Default: Sunday.

DayOfWeek

False

Named

False

FromHour

Specifies an hour when the backup window opens.

Default: 0.

Int32

False

Named

False

ToDay

Specifies the day of week on which the backup window closes.

Default: Saturday.

DayOfWeek

False

Named

False

ToHour

Specifies an hour when the backup window closes.

Note: The backup windows closes at the end of an hour that you specify in the ToHour parameter.

For example, if you specify the 22 value for the ToHour parameter, the backup window will end at 22:59.

Default: 23.

Int32

False

Named

False

Enabled

Defines that the cmdlet will enable the backup window.

If you provide this parameter, the period that you set for a backup window will specify the time when the job is allowed to run.

Otherwise, the period that you set for a backup window will specify the time when the job is not allowed to run.

SwitchParameter

False

Named

True (ByProperty
Name, ByValue)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

None.

Examples

New-VBRBackupWindowOptionsExample 1. Defining Backup Window Settings

New-VBRBackupWindowOptionsExample 2. Defining Backup Window Settings for Specific Period of Time

New-VBRBackupWindowOptionsExample 3. Defining Period of Time When Job must not Run

New-VBRBackupWindowOptionsExample 4. Modifying Schedule Settings of Existing Job

Related Commands

Page updated 12/19/2024

Page content applies to build 12.3.1.1139