New-VBRConfigurationBackupScheduleOptions

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 the Set-VBRConfigurationBackupJob cmdlet.

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

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Enable	Defines that the job will run automatically on schedule. If set to False, you will need to run the job manually. Default: True. Note: To disable the configuration job schedule, specify the $false value for the Enable parameter.	SwitchParameter	False	Named	False
Type	Specifies the type of the schedule: Daily Monthly Default: Daily.	VBRConfigurationBackupScheduleType	False	Named	False
DailyOptions	For daily schedule. Specifies the daily schedule options. Default: 10:00, everyday.	Accepts the VBRDailyOptions object. To get this object, run the New-VBRDailyOptions cmdlet.	False	Named	False
MonthlyOptions	For monthly schedule. Specifies the monthly schedule options. Default: 22:00, Fourth Saturday, all months.	Accepts the VBRMonthlyOptions object. To get this object, run the New-VBRMonthlyOptions cmdlet.	False	Named	False

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

Output Object

VBRConfigurationBackupScheduleOptions

Examples

Example 1. Creating Object with Default Configuration Job Schedule Settings

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

$defaultschedule = New-VBRConfigurationBackupScheduleOptions

Example 2. Setting Daily Schedule for Configuration Backup Job

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

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

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

Perform the following steps:

Run the New-VBRDailyOptions cmdlet. Specify the DayOfWeek and the Period parameter values. Save the result to the $daily variable.
Run the New-VBRConfigurationBackupScheduleOptions cmdlet. Set the Daily option for the Type parameter. Set the $daily variable as the DailyOptions parameter value. Save the result to the $dailyschedule variable.

Example 3. Setting Monthly Schedule for Configuration Backup Job

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

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

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

Perform the following steps:

Run the New-VBRMonthlyOptions cmdlet. Specify the Period, the DayOfWeek and the DayNumberInMonth parameter values. Save the result to the $monthly variable.
Run the New-VBRConfigurationBackupScheduleOptions cmdlet. Set the Monthly option for the Type parameter. Set the $monthly variable as the MonthlyOptions parameter value. Save the result to the $monthlyschedule variable.

Example 4. Disabling Configuration Job Schedule

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

$disableschedule = New-VBRConfigurationBackupScheduleOptions -Enable:$false

Related Commands