Stop-VBRSession

Short Description

Stops tape jobs sessions.

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Stop-VBRSession -Session <VBRSession> [-Wait] [<CommonParameters>]

Detailed Description

This cmdlet stops running tape jobs sessions.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Session	Specifies a running tape job session. The cmdlet will stop this session. Accepts the `VBRSession` object. To get this object, run the `Get-VBRSession` cmdlet.	`VBRSession`	True	Named	True (ByPropertyName, ByValue)
Wait	Defines that the command waits for the process to complete before accepting more input.	`SwitchParameter`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Examples

Stopping Session for Tape Job

This example shows how to stop the session for the specified tape job.

$job = Get-VBRTapeJob -Name "Backup Copy Job"

$session = Get-VBRSession -Job $job

Stop-VBRSession -Session $session

Perform the following steps:

Run the Get-VBRTapeJob cmdlet. Specify the Name parameter value. Save the result to the $job variable.
Run the Get-VBRSession cmdlet. Set the $job variable as the Job parameter value. Save the result to the $session variable.
Run the Stop-VBRSession cmdlet. Set the $session variable as the Session parameter value.