Stop-VBRNASBackupFLRSession

Short Description

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

Applies to

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

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

Session

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

Accepts the VBRNASBackupFLRSession object. To get this object, run the Get-VBRNASBackupFLRSession cmdlet.

True

Named

True (ByValue, ByPropertyName)

RunAsync

Defines 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 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