Remove-VBRRestoreSession (obsolete)

Short Description

Removes restore sessions.

Note

This cmdlet is obsolete and not supported.

Platform: VMware, Hyper-V

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

Syntax

Remove-VBRRestoreSession [-Session] <CRestoreSession[]> [-WhatIf]

[-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet removes a selected restore session from Veeam Backup & Replication.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Session	Specifies the restore session you want to remove. Accepts the `CRestoreSession[]` object. To get this object, run the `Get-VBRRestoreSession` cmdlet.	`CRestoreSession[]`	True	0	True (ByPropertyName, ByValue)
Confirm	Defines whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.	`SwitchParameter`	False	Named	False
WhatIf	Defines whether the cmdlet writes 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-VBRRestoreSession (obsolete) Example 1. Removing Last Restore Session [Using Pipeline]

This example shows how to remove the last restore session of the Fileserver 03 VM.

Get-VBRRestoreSession -Name "Fileserver 03" | Select -Last 1 | Remove-VBRRestoreSession

Perform the following steps:

Run the Get-VBRRestoreSession cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Select cmdlet. Specify the Last parameter value.
Pipe the cmdlet output to the Remove-VBRRestoreSession cmdlet.

Remove-VBRRestoreSession (obsolete) Example 2. Removing Selected Restore Session [Using Variable]

This example shows how to remove the Fileserver 03 restore session.

$session = Get-VBRRestoreSession -Name "Fileserver 03"

Remove-VBRRestoreSession -Session $session

Perform the following steps:

Run the Get-VBRBackupSession cmdlet. Specify the Name parameter value. Save the result to the $session variable.
Run the Remove-VBRRestoreSession cmdlet. Set the $session as the Session parameter value.