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

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

<CommonParameters>

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

Output Object

VBRConfigurationBackupScheduleOptions

Examples

New-VBRConfigurationBackupScheduleOptionsExample 1. Creating Object with Default Configuration Job Schedule Settings

New-VBRConfigurationBackupScheduleOptionsExample 2. Setting Daily Schedule for Configuration Backup Job

New-VBRConfigurationBackupScheduleOptionsExample 3. Setting Monthly Schedule for Configuration Backup Job

New-VBRConfigurationBackupScheduleOptionsExample 4. Disabling Configuration Job Schedule

Related Commands

Page updated 5/17/2024

Page content applies to build 12.3.1.1139