Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

New-VBRJobOptions

Short Description

Creates new job options.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides 3 parameter sets.

  • For editing all job options:

New-VBRJobOptions  [<CommonParameters>]

  • For editing backup jobs options:

New-VBRJobOptions [-ForBackupJob]  [<CommonParameters>]

  • For editing replication jobs options:

New-VBRJobOptions [-ForReplicaJob]  [<CommonParameters>]

Detailed Description

This cmdlet returns default job settings. You can edit any setting that you want to apply to a job.

Run Set-VBRJobOptions to apply the modified options to a job.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

ForBackupJob

Indicates that the cmdlet will return default settings for backup job.

False

Named

False

False

ForReplicaJob

Indicates that the cmdlet will return default settings for replication job.

False

Named

False

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 schedules the job named "Backup Job 1" to running every 2 hours.

  • The object with scheduling settings is assigned to the $NewScheduleOption variable. The "OptionsPeriodically" parameter is set toand its value is set to 120 (minutes).
  • The job to apply the schedule is obtained with Get-VBRJob and assigned to the $job variable.
  • The object is then applied to the job by running Set-VBRJobScheduleOptions with these two variables.

PS C:\PS> $NewScheduleOption = New-VBRJobScheduleOptions

PS C:\PS> $NewScheduleOption.OptionsPeriodically.Enabled = $True

PS C:\PS> $NewScheduleOption.OptionsPeriodically.FullPeriod = 120

PS C:\PS> $Job = Get-VBRJob -Name "Backup Job 1"

PS C:\PS> Set-VBRJobScheduleOptions -Job $Job -Options $NewScheduleOption

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Endpoint Backup Documentation

Veeam Management Pack Documentation