New-VBRConfigurationBackupScheduleOptions

In this article

    Short Description

    Creates a new VBRConfigurationBackupScheduleOptions object.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    New-VBRConfigurationBackupScheduleOptions [-Enable] [-Type <VBRConfigurationBackupScheduleType> {Daily | Monthly}] [-DailyOptions <VBRDailyOptions>] [-MonthlyOptions <VBRMonthlyOptions>]  [<CommonParameters>]

    Detailed Description

    This cmdlet creates a new VBRConfigurationBackupScheduleOptions object. This object contains schedule settings for configuration backup job. It is used then in Set-VBRConfigurationBackupJob.

    If you run this cmdlet without parameters, it will create an object with default settings.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Enable

    If set to True, the job will run automatically on schedule.

    If set to False, you will need to run the job manually.

    Default: TRUE.

    False

    Named

    False

    True or False

    Type

    Specifies the type of the schedule:

    • Daily
    • Monthly.

    Default: Daily.

    False

    Named

    False

    False

    DailyOptions

    For daily schedule.

    Specifies the daily schedule options.

    Accepts VBRDailyOptions type.

    Default: 10:00, everyday.

    False

    Named

    False

    False

    MonthlyOptions

    For monthly schedule.

    Specifies the monthly schedule options.

    Accepts VBRMonthlyOptions type.

    Default: 22:00, Forth Saturday, all months.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Return Type

    VBRConfigurationBackupScheduleOptions

    Example 1

    This command creates an object with default configuration job schedule settings. The object is saved to the '$defaultschedule' variable.

    $defaultschedule = New-VBRConfigurationBackupScheduleOptions

    Example 2

    This examples shows how to set daily schedule for the configuration backup job. The job will run on 5 AM on Saturdays.

    • Run New-VBRDailyOptions to create an object with settings for the Daily type. Save the result to the "$daily" variable.
    • Run New-VBRConfigurationBackupScheduleOptions with the saved variable. Save the result to the "$dailyschedule" variable.

    $daily = New-VBRDailyOptions -Period "05:00" -DayOfWeek Saturday

    $dailyschedule = New-VBRConfigurationBackupScheduleOptions -Type Daily -DailyOptions $daily

    Example 3

    This examples shows how to set monthly schedule for the configuration backup job. The job will run on 00:00 the first Friday of each month.

    • Run New-VBRDailyOptions to create an object with settings for the Monthly type. Save the result to the "$monthly" variable.
    • Run New-VBRConfigurationBackupScheduleOptions with the saved variable. Save the result to the "$monthlyschedule" variable.

    $monthly = New-VBRMonthlyOptions -Period "00:00" -DayOfWeek Friday -DayNumberInMonth First

    $monthlyschedule = New-VBRConfigurationBackupScheduleOptions -Type Monthly -MonthlyOptions $monthly

    Example 4

    This command disables the configuration job schedule. The object is saved to the '$disableschedule' variable.

    $disableschedule = New-VBRConfigurationBackupScheduleOptions -Enable:$false

    Related Commands

    New-VBRDailyOptions

    New-VBRMonthlyOptions