Start-VBRComputerBackupJob

Short Description

Starts Veeam Agent backup jobs and Veeam Agent backup policies.

Applies to

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

Syntax

Start-VBRComputerBackupJob -Job <VBRComputerBackupJob[]> [-FullBackup] [-RetryBackup] [-Object <VBRDiscoveredComputer[]>] [-StartChainedJobs] [-RunAsync] [<CommonParameters>]

Detailed Description

This cmdlet starts Veeam Agent backup jobs and Veeam Agent backup policies.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Job	Specifies a Veeam Agent backup job or a Veeam Agent backup policy that you want to start.	Accepts the VBRComputerBackupJob[] object. To get this object, run the Get-VBRComputerBackupJob cmdlet.	True	0	True (ByValue, ByPropertyName)
FullBackup	Defines that the Veeam Agent backup job will create an active full backup.	SwitchParameter	False	Named	False
RetryBackup	Defines that Veeam Backup & Replication will restart the failed job. The cmdlet will start the job from the moment when it has failed.	SwitchParameter	False	Named	False
Object	Specifies an array of protected machines.	Accepts the VBRDiscoveredComputer[] object. To get this object, run the Get-VBRDiscoveredComputer cmdlet.	False Named False
StartChainedJobs	Defines that Veeam Backup & Replication will start jobs that are scheduled to run after this the Veeam Agent backup job.	SwitchParameter	False	Named	False
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	SwitchParameter	False	Named	False

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

Output Object

This cmdlet returns the VBRSession[] object that contains settings of running Veeam Agent backup jobs and of Veeam Agent backup policies.

Examples

Example 1. Starting Veeam Agent Backup Job

This example shows how to start the Veeam Agent backup job.

$job = Get-VBRComputerBackupJob -Name "WinSrv2049"

Start-VBRComputerBackupJob -Job $job

Perform the following steps:

Run the Get-VBRComputerBackupJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Run the Start-VBRComputerBackupJob cmdlet. Set the $job variable as the Job parameter value.

Example 2. Creating Full Backup by Veeam Agent Backup Job

This example shows how to create an active full backup by the Veeam Agent backup job.

$job = Get-VBRComputerBackupJob -Name "WinSrv2049"

Start-VBRComputerBackupJob -Job $job -FullBackup

Perform the following steps:

Run the Get-VBRComputerBackupJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Run the Start-VBRComputerBackupJob cmdlet. Set the $job variable as the Job parameter value. Provide the FullBackup parameter.

Related Commands

Get-VBRComputerBackupJob