This is an archive version of the document. To get the most up-to-date information, see the current version.

Start-VBRJob

Short Description

Starts backup, replication or copy job.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Start-VBRJob [-Job] <CBackupJob[]> [-FullBackup] [-RetryBackup] [-RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Related Commands

Get-VBRJob

Detailed Description

This cmdlet allows you to start a created or stopped job. You can start a backup, replication or copy job.

This cmdlet allows you to start a job for an ordinary run, force a full backup, or set the job to restart in case it failed.

When you create a job, you need to run it manually unless you enable a job schedule. Run Set-VBRJobSchedule to schedule the job to run automatically.

Run Stop-VBRJob to stop a running job.

Run Enable-VBRJob to enable a disabled job.

Run Start-VSBJob to start a SureBackup job.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Job

Specifies the job you want to start.

You can assign multiple jobs to this object.

True

1

True (ByValue,
ByProperty
Name)

False

FullBackup

Specify this parameter if you want to perform an active full backup.

False

Named

False

False

RetryBackup

Specify this parameter if you want to restart the job if it failed.

False

Named

False

False

RunAsync

Indicates that the command returns immediately without waiting for the task to complete.

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 1

This command starts the jobs named "WebApplications Server Backup" and "Fileserver Copy Job". The job is obtained with Get-VBRJob and piped down.

PS C:\PS> Get-VBRJob -Name "WebApplications Server Backup", "Fileserver Copy Job" | Start-VBRJob

Example 2

This command starts a vCloud backup job right after it the job is created. The RunAsync parameter is set to bring the process to the background.

PS C:\PS> Add-VBRvCloudJob -Entity $"vCloud Server" -Name "vCloud Server Backpup" | Start-VBRJob -RunAsync

Example 3

This command performs a full backup for the job named "WebApplications Server Backup". The job is obtained with Get-VBRJob and piped down.

PS C:\PS> Get-VBRJob -Name "WebApplications Server Backup" | Start-VBRJob -FullBackup

Example 4

This command restarts a failed job represented by the $job variable. The job is obtained with Get-VBRJob and assigned to the variable beforehand. The RunAsync parameter is set to bring the process to the background.

PS C:\PS> Start-VBRJob -Job $job -RetryBackup -RunAsync