Remove-VBRBackupSession (obsolete)

Short Description

Removes a specified backup session.

Note

This cmdlet is obsolete and not supported.

Platform: VMware

Syntax

Remove-VBRBackupSession [-Session] <CBackupSession[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet removes specified backup session from Veeam Backup & Replication.

Parameters

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Session

Specifies the backup session you want to remove.

You can assign multiple sessions to this object.

Accepts the CBackupSession[] object. To get this object, run the Get-VBRBackupSessionReturns jobs sessions. cmdlet.

CBackupSession[]

True

0

True (ByPropertyName, ByValue)

Confirm

Defines that the cmdlet will display a prompt that asks if you want to continue running the command.

SwitchParameter

False

Named

False

WhatIf

Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.

SwitchParameter

False

Named

False

<CommonParameters>

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

Examples

Remove-VBRBackupSession (obsolete)Example 1. Removing Selected Backup Session [Using Pipeline]

This example shows how to remove the Fileserver Backup backup session.

Get-VBRBackupSession -Name "Fileserver Backup" | Remove-VBRBackupSession

Perform the following steps:

  1. Run the Get-VBRBackupSessionReturns jobs sessions. cmdlet. Specify the Name parameter value.
  2. Pipe the cmdlet output to the Remove-VBRBackupSession cmdlet.

Remove-VBRBackupSession (obsolete)Example 2. Removing Selected Backup Session [Using Variable]

This example shows how to remove the Fileserver Backup backup session.

$FileserverBackup = Get-VBRBackupSession -Name "Fileserver Backup"

Remove-VBRBackupSession -Session $FileserverBackup

Perform the following steps:

  1. Run the Get-VBRBackupSessionReturns jobs sessions. cmdlet. Specify the Name parameter value.
  2. Run the Remove-VBRBackupSession cmdlet. Set the $FileserverBackup as the Session parameter value.

Get-VBRBackupSessionReturns jobs sessions.

Page updated 2026-08-19

Page content applies to build 13.1.1.18