New-VBRViDiskMigrationMappingRule

Short Description

Defines mapping settings of recovered VM virtual disks and target datastores.

Applies to

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

Syntax

New-VBRViDiskMigrationMappingRule -TargetVirtualDevice <VBRViVirtualDevice> [-DiskType {AsSource | Thin | LazyZeroed | EagerZeroed}] [-Datastore <VBRViDatastoreBase>] [<CommonParameters>]

Detailed Description

This cmdlet defines mapping settings of recovered VM virtual disks and target datastores. You can run this cmdlet to specify a particular target datastore for every disk that you want to publish.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
TargetVirtualDevice	Specifies recovered VM virtual disks. The cmdlet will map these disks to the datastore.	Accepts the VBRViVirtualDevice object. To create this object, run the Get-VBRViVirtualDevice cmdlet.	True	Named	False
DiskType	Specifies the virtual disk type settings. The cmdlet will set the virtual disks types to the specified type during the restore. You can specify one of the following disk types: AsSource Thin LazyZeroed EagerZeroed Default: AsSource	VBRViDiskType	False	Named	False
Datastore	Specifies a datastore or a datastore cluster. The cmdlet will map recovered VM virtual disks to the specified datastore or the datastore cluster. Note: If you do not specify this parameter, the cmdlet will will map recovered VM virtual disks to the default datastore.	Accepts the following types of objects: The CViDatastoreItem object. To get this object, run the Find-VBRViDatastore cmdlet. The CViDatastoreCluster object. To create this object, run the Find-VBRViDatastoreCluster cmdlet.	False	Named	False

Parameter

Description

Type

Required

Position

Accept Pipeline Input

TargetVirtualDevice

Specifies recovered VM virtual disks. The cmdlet will map these disks to the datastore.

Accepts the VBRViVirtualDevice object. To create this object, run the Get-VBRViVirtualDevice cmdlet.

True

Named

False

DiskType

Specifies the virtual disk type settings. The cmdlet will set the virtual disks types to the specified type during the restore. You can specify one of the following disk types:

AsSource
Thin
LazyZeroed
EagerZeroed

Default: AsSource

VBRViDiskType

False

Named

False

Datastore

Specifies a datastore or a datastore cluster. The cmdlet will map recovered VM virtual disks to the specified datastore or the datastore cluster.

Note: If you do not specify this parameter, the cmdlet will will map recovered VM virtual disks to the default datastore.

Accepts the following types of objects:

The CViDatastoreItem object. To get this object, run the Find-VBRViDatastore cmdlet.
The CViDatastoreCluster object. To create this object, run the Find-VBRViDatastoreCluster cmdlet.

False

Named

False

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

Output Object

The cmdlet returns the VBRViDiskMigrationMappingRule object that defines mapping settings of recovered VM virtual disks with target datastores. .

Examples

New-VBRViDiskMigrationMappingRule Example 1. Mapping Recovered Virtual Disks to Default Datastore

This example shows how to map the recovered virtual disks to the default datastore. The cmdlet will map virtual disks of the VM that is backed up by the Winsrv4515 job.

$backup = Get-VBRBackup -Name "Winsrv4515"

$restorepoint = Get-VBRRestorePoint -Backup $backup

$disks = Get-VBRViVirtualDevice -RestorePoint $restorepoint[3]

New-VBRViDiskMigrationMappingRule -TargetVirtualDevice $disks

Perform the following steps:

Get the backed-up VM virtual disks:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Get-VBRRestorePoint cmdlet. Set the $backup variable as the Backup parameter value. Save the result to the $restorepoint variable.
Run the Get-VBRViVirtualDevice cmdlet. Set the $restorepoint variable as the RestorePoint parameter value. Save the result to the $disks variable.

The Get-VBRRestorePoint cmdlet will return an array of restore points. Mind the ordinal number of the necessary restore point (in our example, it is the fourth restore session in the array).

Run the New-VBRViDiskMigrationMappingRule cmdlet. Set the $disks variable as the TargetVirtualDevice parameter value.

New-VBRViDiskMigrationMappingRule Example 2. Mapping Recovered Virtual Disks to Specific Datastore

This example shows how to map the recovered virtual disks to the LocalStore_0 datastore. This datastore is connected to the WinSrv2073 server. The cmdlet will map virtual disks of the VM that is backed up by the Winsrv4515 job.

$backup = Get-VBRBackup -Name "Winsrv4515"

$restorepoint = Get-VBRRestorePoint -Backup $backup

$disks = Get-VBRViVirtualDevice -RestorePoint $restorepoint[3]

$server = Get-VBRServer -Name "WinSrv2073"

$datastore = Find-VBRViDatastore -Server $server -Name "LocalStore_0"

New-VBRViDiskMigrationMappingRule -TargetVirtualDevice $disks -Datastore $datastore

Perform the following steps:

Get the backed-up VM virtual disks:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Get-VBRRestorePoint cmdlet. Set the $backup variable as the Backup parameter value. Save the result to the $restorepoint variable.
Run the Get-VBRViVirtualDevice cmdlet. Set the $restorepoint variable as the RestorePoint parameter value. Save the result to the $disks variable.

The Get-VBRRestorePoint cmdlet will return an array of restore points. Mind the ordinal number of the necessary restore point (in our example, it is the fourth restore session in the array).

Get the datastore:

Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Find-VBRViDatastore cmdlet. Set the $server variable as the Server parameter value. Specify the Name parameter value. Save the result to the $datastore variable.

Run the New-VBRViDiskMigrationMappingRule cmdlet. Set the $disks variable as the TargetVirtualDevice parameter value. Set the $datastore variable as the Datastore parameter value.

New-VBRViDiskMigrationMappingRule Example 3. Mapping Recovered Virtual Disks to Datastore Cluster

This example shows how to map the recovered virtual disks to the Cluster_5 datastore cluster. This datastore cluster is connected to the WinSrv2077 server. The cmdlet will map virtual disks of the VM that is backed up by the Winsrv4515 job.

$backup = Get-VBRBackup -Name "Winsrv4515"

$restorepoint = Get-VBRRestorePoint -Backup $backup

$disks = Get-VBRViVirtualDevice -RestorePoint $restorepoint[3]

$server = Get-VBRServer -Name "WinSrv2077"

$datastorecluster = Find-VBRViDatastoreCluster -Server $server -Name "Cluster_5"

New-VBRViDiskMigrationMappingRule -TargetVirtualDevice $disks -Datastore $datastorecluster

Perform the following steps:

Get the backed-up VM virtual disks:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Get-VBRRestorePoint cmdlet. Set the $backup variable as the Backup parameter value. Save the result to the $restorepoint variable.
Run the Get-VBRViVirtualDevice cmdlet. Set the $restorepoint variable as the RestorePoint parameter value. Save the result to the $disks variable.

The Get-VBRRestorePoint cmdlet will return an array of restore points. Mind the ordinal number of the necessary restore point (in our example, it is the fourth restore session in the array).

Get the datastore:

Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Find-VBRViDatastoreCluster cmdlet. Set the $server variable as the Server parameter value. Specify the Name parameter value. Save the result to the $datastorecluster variable.

Run the New-VBRViDiskMigrationMappingRule cmdlet. Set the $disks variable as the TargetVirtualDevice parameter value. Set the $datastorecluster variable as the Datastore parameter value.

Related Commands