Start-VBRNASInstantRecoveryMigration

Short Description

Starts migration to production for the running instant file share recovery session.

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

Syntax

This cmdlet provides the following parameter sets:

NasInstantRecoveryMigrationToOriginal (Default)

Start-VBRNASInstantRecoveryMigration [-InstantRecovery] <VBRNASInstantRecovery> [-ReplaceAll]

-SwitchOverOptions <VBRNASInstantRecoveryMigrationSwitchOverOptions> [-RunAsync] [<CommonParameters>]

NasInstantRecoveryMigrationToDifferent

Start-VBRNASInstantRecoveryMigration [-InstantRecovery] <VBRNASInstantRecovery>

[-NASServer] <VBRUnstructuredServer> [-Path] <String> [-ReplaceAll]

-SwitchOverOptions <VBRNASInstantRecoveryMigrationSwitchOverOptions> [-RunAsync] [<CommonParameters>]

Detailed Description

This cmdlet starts migration to production for the running instant file share recovery session. It supports migration to the original or different location.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
InstantRecovery	Specifies an instant recovery session. The cmdlet will start migration to production for this session. Accepts the `VBRNASInstantRecovery` object. To get this object, run the `Get-VBRNASInstantRecovery` cmdlet.	`VBRNASInstantRecovery`	True	0	True (ByPropertyName, ByValue)
NASServer	Specifies a server where the mounted file share will be migrated to production. This parameter is specified for the migration to a different location type. Accepts the `VBRUnstructuredServer` object. To get this object, run the `Get-VBRUnstructuredServer` cmdlet.	`VBRUnstructuredServer`	True	1	False
Path	Specifies a path at the `NASServer` where the mounted file share will be migrated to production. This parameter is specified for the migration to a different location type.	`String`	True	2	False
ReplaceAll	Enables the `Replace All` option. If you provide this parameter, the cmdlet will restore the whole file share and overwrite the existing files with the restored files. Otherwise, the cmdlet will overwrite the existing files only if they are older than the restored files.	`SwitchParameter`	False	Named	False
RunAsync	Defines that the command returns immediately without waiting for the task to complete. Note: If the switchover is started with option Manual or Scheduled, the cmdlet will wait endlessly or for a long time. Before starting waiting, the cmdlet will display a warning.	`SwitchParameter`	False	Named	False
SwitchOverOptions	Specifies switchover options for the specified instant recovery session. The cmdlet will start migration to production for the session with the specified switchover options. Accepts the `VBRNASInstantRecoveryMigrationSwitchOverOptions` object. To create this object, run the `New-VBRNASInstantRecoveryMigrationSwitchOverOptions` cmdlet.	`VBRNASInstantRecoveryMigrationSwitchOverOptions`	True	Named	True (ByValue)

<CommonParameters>

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

Output Object

The cmdlet returns the VBRNASInstantRecoveryMigration object that defines settings of the migration to production session.

Examples

Start-VBRNASInstantRecoveryMigration Example 1. Starting File Share Migration to Original Location

This command starts the file share migration to the original location.

$nasInstantRecovery = Get-VBRNASInstantRecovery -Id "49664A5F-9C55-4A1F-8E6A-1CD5705A684B"

$switchover = New-VBRNASInstantRecoveryMigrationSwitchOverOptions -Auto

Write-Output "Start File Share Migration."

Write-Output $nasInstantRecovery

Start-VBRNASInstantRecoveryMigration -InstantRecovery $nasInstantRecovery -SwitchOverOptions $switchover

Perform the following steps:

Run the Get-VBRNASInstantRecovery cmdlet. Specify the Id parameter value. Save the result to the $nasInstantRecovery variable.
Run the New-VBRNASInstantRecoveryMigrationSwitchOverOptions cmdlet. Provide the Auto parameter. Save the result to the $switchover variable.
Run the Write-Output cmdlet. Specify the output wording.
Run the Write-Output cmdlet. Provide the $nasInstantRecovery variable.
Run the Start-VBRNASInstantRecoveryMigration cmdlet. Set the $nasInstantRecovery variable as the InstantRecovery parameter value. Set the $switchover variable as the SwitchOverOptions parameter value.

Start-VBRNASInstantRecoveryMigration Example 2. Starting File Share Migration to Different Location

This command starts the file share migration to a location different from the original one.

$nasInstantRecovery = Get-VBRNASInstantRecovery -Id "49664A5F-9C55-4A1F-8E6A-1CD5705A684B"

$nasServer = Get-VBRUnstructuredServer -Name "\\server\original_folder"

$switchover = New-VBRNASInstantRecoveryMigrationSwitchOverOptions -Auto

Write-Output "Start File Share Migration."

Write-Output $nasInstantRecovery

Start-VBRNASInstantRecoveryMigration -InstantRecovery $nasInstantRecovery -NASServer $nasServer -Path "\\server\original_folder\new_folder" -SwitchOverOptions $switchover

Perform the following steps:

Run the Get-VBRNASInstantRecovery cmdlet. Specify the Id parameter value. Save the result to the $nasInstantRecovery variable.
Run the Get-VBRUnstructuredServer cmdlet. Specify the Name parameter. Save the result to the $nasServer variable.
Run the New-VBRNASInstantRecoveryMigrationSwitchOverOptions cmdlet. Provide the Auto parameter. Save the result to the $switchover variable.
Run the Write-Output cmdlet. Specify the output wording.
Run the Write-Output cmdlet. Provide the $nasInstantRecovery variable.
Run the Start-VBRNASInstantRecoveryMigration cmdlet. Specify the following settings:
- Set the $nasInstantRecovery variable as the InstantRecovery parameter value.
- Set the $nasServer variable as the NASServer parameter value.
- Specify the Path parameter value.
- Set the $switchover variable as the SwitchOverOptions parameter value.