Stop-VBRUnstructuredBackupFLRSession

Short Description

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

Note

This cmdlet is available starting from Veeam Backup & Replication 12.1 (build 12.1.0.2131).

Applies to

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

Syntax

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

Detailed Description

This cmdlet stops restore sessions started to recover backups created by file backup jobs or object storage 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 VBRUnstructuredBackupFLRSession object. To get this object, run the Get-VBRUnstructuredBackupFLRItemVersion 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 Session Runnug to Recover Unstructured Data

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

$session = Get-VBRUnstructuredBackupFLRItemVersion

Stop-VBRUnstructuredBackupFLRSession -Session $session

Perform the following steps:

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

Related Commands

Get-VBRUnstructuredBackupFLRItemVersion