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

Stop-VBRNASBackupFLRSession

Short Description

Stops restore sessions started to recover backups created by file backup jobs.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Stop-VBRNASBackupFLRSession -Session <VBRNASBackupFLRSession> [-RunAsync]  [<CommonParameters>]

Detailed Description

This cmdlet stops restore sessions started to recover backups created by file backup jobs.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Session

Specifies a restore session. The cmdlet will stop this restore session.

VBRNASBackupFLRSession

True

Named

True (ByValue, ByPropertyName)

 

RunAsync

Indicates that the command returns immediately without waiting for the task to complete.

SwitchParameter

False

Named

False

 

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Examples

Stopping Restore Sessions

This example shows how to stop a restore session that is started to recover backups created by file backup jobs.

$session = Get-VBRNASBackupFLRSession

Stop-VBRNASBackupFLRSession -Session $session

Perform the following steps:

  1. Run the Get-VBRNASBackupFLRSession cmdlet. Save the result to the $session variable.
  2. Run the Stop-VBRNASBackupFLRSession cmdlet. Set the $session variable as the Session parameter value.

Related Commands

Get-VBRNASBackupFLRSession