Stop-VBRUnstructuredBackupFLRSession

Short Description

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

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

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	`SwitchParameter`	False	Named	False
Session	Specifies a restore session. The cmdlet will stop this restore session. Accepts the `VBRUnstructuredBackupFLRSession` object. To get this object, run the `Get-VBRUnstructuredBackupFLRSession` cmdlet.	`VBRUnstructuredBackupFLRSession`	True	Named	True (ByPropertyName, ByValue)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Examples

Stopping Restore Session Running 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-VBRUnstructuredBackupFLRSession

Stop-VBRUnstructuredBackupFLRSession -Session $session

Perform the following steps:

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