Start-VBOJob

Short Description

Starts backup jobs.

Syntax

Start-VBOJob -Job <VBOJob> [-RunAsync] [-Full] [<CommonParameters>]

Detailed Description

This cmdlet allows you to start a created or stopped backup job.

Run the New-VBOJobSchedulePolicy cmdlet to set the schedule for the job.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Job	Specifies a backup job that you want to start.	Accepts the VBOJob object. To get this object, run the Get-VBOJob cmdlet.	True	Named	True (ByValue)
RunAsync	Defines that the command returns immediately without waiting for the task to complete. Default: False	SwitchParameter	False	Named	False
Full	Defines that the backup job session is considered a full run. Default: False	SwitchParameter	False	Named	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Job

Specifies a backup job that you want to start.

Accepts the VBOJob object.

To get this object, run the Get-VBOJob cmdlet.

True

Named

True (ByValue)

RunAsync

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

Default: False

SwitchParameter

False

Named

False

Full

Defines that the backup job session is considered a full run.

Default: False

SwitchParameter

False

Named

False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Examples

Example 1: Starting Backup Job

This example shows how to start the backup job.

$job = Get-VBOJob -Name "Backup Daily"

Start-VBOJob -Job $job

Perform the following steps:

Run the Get-VBOJob cmdlet to get the backup job that you want to start. Save the result to the $job variable.
Run the Start-VBOJob cmdlet with the $job variable.

Example 2: Starting Full Run

This example shows how to start a full run for the backup job.

$job = Get-VBOJob -Name "Full Backup"

Start-VBOJob -Job $job -Full:$true

Perform the following steps:

Run the Get-VBOJob cmdlet to get the backup job that you want to start. Save the result to the $job variable.
Run the Start-VBOJob cmdlet with the $job variable. Set the true value for the Full parameter.

Related Commands