Stop-VBRNASInstantRecovery

Short Description

Stops an instant restore of backups created by the file backup job.

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

Syntax

Stop-VBRNASInstantRecovery [-InstantRecovery] <VBRNASInstantRecovery> [-Force] [-RunAsync] [<CommonParameters>]

Detailed Description

The cmdlet stops an instant restore of backups created by the file backup job. The process comprises the following steps:

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Force	Defines that the cmdlet will immediately start the dismount procedure. If the parameter is not specified, the cmdlet will ask for the confirmation to start the dismount procedure for the instant restore session.	`SwitchParameter`	False	Named	False
InstantRecovery	Specifies an array of instant restore sessions. The cmdlet will stop the instant recovery for each of the specified restore points. Accepts the `VBRNASInstantRecovery` object. To get this object, run the `Get-VBRNASInstantRecovery` cmdlet.	`VBRNASInstantRecovery`	True	0	False
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 Instant Restore Session for File Backup

This example shows how to stop the instant restore session for file backup.

$nasInstantRecovery = Get-VBRNASInstantRecovery -NASBackupName "Daily SMB1 Backup" -NASServerName "ontap-2"

Stop-VBRNASInstantRecovery -InstantRecovery $nasInstantRecovery

Perform the following steps:

Run the Get-VBRNASInstantRecovery cmdlet. Specify the NASBackupName and NASServerName parameter values. Save the result to the $nasInstantRecovery variable.
Run the Stop-VBRNASInstantRecovery cmdlet. Set the $nasInstantRecovery variable as the InstantRecovery parameter value.