This is an archive version of the document. To get the most up-to-date information, see the current version.Stop-VSBJob
Short Description
Stops running SureBackup job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Stop-VSBJob [-Job] <CSbJob[]> [-RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
Related Commands
Detailed Description
This cmdlet stops a running SureBackup job. The job is stopped once, the scheduled SureBackup job will start the next scheduled time.
Run Start-VSBJob to start the job manually.
Run Stop-VBRJob to stop a backup, replication or copy job.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Job | Specifies the SureBackup 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 SureBackup job named "AD SureJob". The needed job object is obtained with Get-VSBJob and piped down.
Example 2
This command stops the SureBackup job represented by the $"AD SureJob" variable. The needed job object is obtained with Get-VSBJob and assigned to the variable beforehand.
