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

Stop-VBRJob

Short Description

Stops a running backup, replication or copy job.

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 a running backup, replication or copy 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.

Run Start-VBRJob to start the job manually.

Run Disable-VBRJob to temporarily disable a job.

Run Stop-VSBJob to stop a SureBackup job.

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 command stops the copy job named "SharePoint File Copy Job". The needed job object is obtained with Get-VBRJob and piped down.

PS C:\PS> Get-VBRJob -Name "SharePoint File Copy Job" | Stop-VBRJob

Example 2

This command stops the copy job represented by the $"SharePoint File Copy Job" variable. The needed session object is obtained with Get-VBRJob and assigned to the variable beforehand.

PS C:\PS> Stop-VBRJob -Job $"SharePoint File Copy Job"

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 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 Endpoint Backup Documentation

Veeam Management Pack Documentation