Remove-VSBSession (obsolete)

Short Description

Removes a specified SureBackup job session from Veeam Backup & Replication.

Note

This cmdlet is obsolete and not supported.

Applies to

Platform: VMware, Hyper-V

Syntax

Remove-VSBSession -Sessions <CSbSession[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm]  [<CommonParameters>]

Detailed Description

This cmdlet removes a specified SureBackup job session from Veeam Backup & Replication.

Parameters

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Sessions

Specifies the SureBackup job session you want to remove.

You can assign multiple sessions to this object.

Accepts the CSbSession[] object. To get this object, run the Get-VSBSession cmdlet.

True

1

True (ByValue,
ByProperty
Name)

<CommonParameters>

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

Examples

Example 1. Removing Selected SureBackup Sessions [Using Pipeline]

This example shows how to remove the Winserver SureJob and Mailserver SureJob SureBackup sessions.

Get-VSBSession -Name "Winserver SureJob", "Mailserver SureJob" | Remove-VSBSession

Perform the following steps:

  1. Run the Get-VSBSession cmdlet. Specify the Name parameter value.
  2. Pipe the cmdlet output to the Remove-VSBSession cmdlet.

Example 2. Removing Selected SureBackup Sessions [Using Variable]

This example shows how to remove the Winserver SureJob and Mailserver SureJob SureBackup sessions.

$suresession = Get-VSBSession -Name "Winserver SureJob", "Mailserver SureJob"

Remove-VSBSession -Sessions $suresession

Perform the following steps:

  1. Run the Get-VSBSession cmdlet. Specify the Name parameter value. Save the result to the $suresession variable.
  2. Run the Remove-VSBSession cmdlet. Set the $suresession as the Sessions parameter value.

Related Commands

Get-VSBSession

Page updated 3/11/2024

Page content applies to build 13.0.1.1071