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

Stop-VBRJob

Short Description

Stops existing jobs.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Stop-VBRJob [-Job] <CBackupJob[]> [-RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet stops the following types of jobs:

  • Backup jobs
  • Replication jobs
  • Copy jobs

Stop-VBRJob Note:

Run Stop-VSBJob to stop a SureBackup job.

The job is stopped once, the scheduled job will start the next scheduled time.

Stop-VBRJob Note:

The cmdlets stops the job immediately. You cannot stop the job gracefully with Veeam PowerShell.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Job

Specifies the array of jobs you want to stop.

True

1

True (ByValue,
ByProperty
Name)

False

RunAsync

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

False

Named

False

False

WhatIf

Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

False

Named

False

False

Confirm

Specifies whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.

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 example shows how to start a job.

You will need to perform the following steps:

  1. Run Get-VBRJob to get the job. Save the result to the $copyjob variable.
  2. Run Start-VBRJob with the $copyjob variable.

PS C:\PS> $copyjob = Get-VBRJob -Name "WebApplications Server Backup"

PS C:\PS> Start-VBRJob -Job $copyjob

Example 2

This example shows how to start a vCloud backup job right after the job is created.

You will need to perform the following steps:

  1. Run Find-VBRvCloudEntity to get the list of vCloud Director entities. Save the result to the $cloudserver variable.
  2. Run Add-VBRvCloudJob to create a vCloud backup job with the $cloudserver variable. Save the result to the $cloudjob variable.
  3. Run Start-VBRJob with the $cloudjob variables. Use the RunAsync parameter to run the process on the background.

PS C:\PS> $cloudserver = Find-VBRvCloudEntity -Name "vCloud Server"

PS C:\PS> $cloudjob = Add-VBRvCloudJob -Entity $vCloudServer -Name "vCloud Server Backpup"

PS C:\PS> Start-VBRJob -Job $cloudjob -RunAsync

Example 3

This example shows how to start a job.

You will need to perform the following steps:

  1. Run Get-VBRJob to get the job. Save the result to the $backupjob variable.
  2. Run Start-VBRJob with the $backupjob variable. Use the FullBackup parameter to create an active full backup.

PS C:\PS> $backupjob = Get-VBRJob -Name "WebApplications Server Backup"

PS C:\PS> Start-VBRJob -Job $backupjob -FullBackup

Example 4

This example shows how to restart a failed job.The process runs on the background and the command returns immediately without waiting for the task to complete.

You will need to perform the following steps:

  1. Run Get-VBRJob to get the failed job. Save the result to the $job variable.
  2. Run Start-VBRJob with the $job variable.Use the RunAsync parameter to run the process on the background.

PS C:\PS> $job = Get-VBRJob -Name "My Backup"

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

Related Commands

Get-VBRJob

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management 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 Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation