This is an archive version of the document. To get the most up-to-date information, see the current version.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>] |
Related Commands
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.
|
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 | Accept |
Job | Specifies the job you want to stop. You can assign multiple jobs to this object. | True | 1 | True (ByValue, | 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.
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.
