This is an archive version of the document. To get the most up-to-date information, see the current version.Stop-VBRSession
Short Description
Stops tape jobs sessions.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Detailed Description
This cmdlet stops running tape jobs sessions.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
|---|---|---|---|---|---|
Session | Specifies a running tape job session. The cmdlet will stop this session. Accepts the VBRSession type. | True | Named | True (ByValue, ByPropertyName) | False |
Wait | Indicates that the command waits for the process to complete before accepting more input. | True | Named | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Example
This example shows how to stop the session for the specified tape job.
- Run the Get-VBRJob cmdlet to get the backup job. Save the result to the $job variable.
- Run the Get-VBRSession cmdlet. Set the $job variable as the Job parameter value.
- Run the Stop-VBRSession cmdlet. Set the $session variable as the Session parameter value.
$job = Get-VBRJob -Name "Backup Copy Job" $session = Get-VBRSession -Job $job Stop-VBRSession -Session $session |
Related Commands
