This is an archive version of the document. To get the most up-to-date information, see the current version.

Remove-VBRRestoreSession

In this article

    Short Description

    Removes a restore session.

    Applies to

    Platform: VMware, Hyper-V

    Product Edition: Standard, Enterprise, Enterprise Plus

    Syntax

    Remove-VBRRestoreSession [-Session] <CRestoreSession[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

    Related Commands

    Get-VBRRestoreSession

    Detailed Description

    This cmdlet removes the specified restore session from Veeam Backup & Replication.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Session

    Specifies the restore session you want to remove.

    True

    1

    True (ByValue,
    ByProperty
    Name)

    False

    WhatIf

    Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

    False

    Named

    False

    False

    Confirm

    Specifies whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.

    False

    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 1

    This command removes the last restore session of the VM named "Fileserver". The restore session is obtained with Get-VBRRestoreSession and piped down.

    PS C:\PS> Get-VBRRestoreSession -Name "Fileserver 03" | Select -Last 1 | Remove-VBRRestoreSession

    Example 2

    This command removes the restore session represented by the $session variable. The restore session object is obtained with Get-VBRRestoreSession and assigned to the variable beforehand.

    PS C:\PS> Remove-VBRRestoreSession -Session $session