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

Stop-VBRSession

Short Description

Stops tape jobs sessions.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

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

Detailed Description

This cmdlet stops running tape jobs sessions.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

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 about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example

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

  1. Run the Get-VBRJob cmdlet to get the backup job. Save the result to the $job variable.
  2. Run the Get-VBRSession cmdlet. Set the $job variable as the Job parameter value.
  3. 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

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation