Sync-VBRBackupToTapeJob

Short Description

Starts an active full for a selected GFS backup to tape job.

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

Syntax

This cmdlet provides the following parameter sets:

Weekly

Sync-VBRBackupToTapeJob -Job <VBRBackupToTapeJob> [-Weekly] [-Wait] [<CommonParameters>]
Monthly

Sync-VBRBackupToTapeJob -Job <VBRBackupToTapeJob> [-Monthly] [-Wait] [<CommonParameters>]
Quarterly

Sync-VBRBackupToTapeJob -Job <VBRBackupToTapeJob> [-Quarterly] [-Wait] [<CommonParameters>]
Yearly

Sync-VBRBackupToTapeJob -Job <VBRBackupToTapeJob> [-Yearly] [-Wait] [<CommonParameters>]

Detailed Description

This cmdlet starts an active full for a selected backup period of a GFS backup to tape job. The job must be targeted to a GFS media pool.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Job	Specifies the backup to tape job for which you want to create an active full. Accepts the `VBRBackupToTapeJob` object. To get this object, run the `Get-VBRTapeJob` cmdlet.	`VBRBackupToTapeJob`	True	Named	True (ByValue)
Monthly	Defines that the job will create a monthly full.	`SwitchParameter`	True	Named	False
Quarterly	Defines that the job will create a quarterly full.	`SwitchParameter`	True	Named	False
Wait	Defines that the command waits for the process to complete before accepting more input.	`SwitchParameter`	False	Named	False
Weekly	Defines that the job will create a weekly full.	`SwitchParameter`	True	Named	False
Yearly	Defines that the job will create a yearly full.	`SwitchParameter`	True	Named	False

<CommonParameters>

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

Examples

Starting Weekly Active Full Backup for GFS Backup to Tape Job

This example shows how to start an active weekly full backup for the WebApp Backup GFS job.

$job = Get-VBRTapeJob -Name "WebApp Backup"

Sync-VBRBackupToTapeJob -Job $job -Weekly

Perform the following steps:

Run the Get-VBRTapeJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Run the Sync-VBRBackupToTapeJob cmdlet. Set the $job variable as the Job parameter value. Provide the Weekly parameter.