This is an archive version of the document. To get the most up-to-date information, see the current version.

New-VBRBackupWindowOptions

In this article

    Short Description

    Creates a new VBRBackupWindowOptions object.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Standard, Enterprise, Enterprise Plus

    Syntax

    New-VBRBackupWindowOptions [-FromDay <DayOfWeek>] [-FromHour <Int32>] [-ToDay <DayOfWeek>] [-ToHour <Int32>] [-Enabled] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Related Commands

    None

    Return Type

    VBRBackupWindowOptions

    Detailed Description

    This cmdlet creates the VBRBackupWindowOptions object. This object contains the backup window settings. The backup window sets a time period within which the job is allowed to run. The VBRBackupWindowOptions object is used further to apply these settings to existing jobs.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    FromDay

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

    Accepts DayOfWeek enumeration.

    Default: Sunday.

    False

    Named

    False

    False

    FromHour

    Specifies the hour on which the backup window opens.

    Accepts int32 type.

    Default: 0.

    False

    Named

    False

    False

    ToDay

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

    Accepts DayOfWeek enumeration.

    Default: Saturday.

    False

    Named

    False

    False

    ToHour

    Specifies the hour on which the backup window ends.

    Accepts int32 type.

    Default: 23.

    False

    Named

    False

    False

    Enabled

    Indicates if this backup window is enabled or disabled:

    • TRUE: jobs are allowed to run within the specified interval.
    • FALSE: jobs are prohibited to run within the specified interval.

    Default: False.

    False

    Named

    True (by Value
    FromPipeline, ValueFromPipeline
    ByPropertyName)

    False

    <CommonParameters>

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

    Example

    This command creates a backup window object that will allow a job to run from 22 PM on Friday to 22 PM on Sunday. The result is saved to the $windowoptions variable.

    PS C:\PS> PS C:\PS> $windowoptions = New-VBRBackupWindowOptions -FromDay Friday -FromHour 22 -ToDay Sunday -ToHour 22 -Enabled