New-VBRViVirtualDeviceMappingRule
Defines backed-up virtual disk mapping settings.
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
New-VBRViVirtualDeviceMappingRule -SourceVirtualDevice <VBRViVirtualDevice> [-Datastore <CViDatastoreItem>] [<CommonParameters>] |
This cmdlet defines mapping settings of a backed-up virtual disk.
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|
SourceVirtualDevice | Specifies a backed-up virtual disk. The cmdlet will map this disk to the datastore. | Accepts the VBRViVirtualDevice object. To create this object, run the Get-VBRViVirtualDevice cmdlet. | True | Named | True (ByValue, ByPropertyName) |
Datastore | Specifies a datastore. The cmdlet will map backed-up virtual disks to this datastore. Note: If you do not specify this parameter, the cmdlet will will attach backed-up virtual disks to the default datastore. | Accepts the CViDatastoreItem object. To create this object, run the Find-VBRViDatastore cmdlet. | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
The cmdlet returns the VBRViVirtualDeviceMappingRule object that contains backed-up virtual disks mapping settings.
This example shows how to map the backed-up virtual disk to the default datastore. The cmdlet will attach the virtual disk 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-VBRViVirtualDeviceMappingRule -SourceVirtualDevice $disks[0] |
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. Specify the Backup parameter value. Save the result to the $restorepoint variable.
The Get-VBRRestorePoint cmdlet will return an array of restore points. Consider that the array numbering starts with 0. In our example, the fourth restore point will be used. - Run the Get-VBRViVirtualDevice cmdlet. Specify the RestorePoint parameter value. Save the result to the $disks variable.
The Get-VBRViVirtualDevice cmdlet will return an array of disks. Consider that the array numbering starts with 0. In our example, the first disk will be used. - Run the New-VBRViVirtualDeviceMappingRule cmdlet. Set the $disks[0] variable as the SourceVirtualDevice parameter value.
|
This example shows how to map the backed-up virtual disk to the LocalStore_0 datastore. This datastore is connected to the WinSrv2073 server. The cmdlet will map the virtual disk 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-VBRViVirtualDeviceMappingRule -SourceVirtualDevice $disks[0] -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. Specify the Backup parameter value. Save the result to the $restorepoint variable.
The Get-VBRRestorePoint cmdlet will return an array of restore points. Consider that the array numbering starts with 0. In our example, the fourth restore point will be used. - Run the Get-VBRViVirtualDevice cmdlet. Specify the RestorePoint parameter value. Save the result to the $disks variable.
The Get-VBRViVirtualDevice cmdlet will return an array of disks. Consider that the array numbering starts with 0. In our example, the first disk will be used. - 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. Specify the Name and Server parameter values. Save the result to the $datastore variable.
- Run the New-VBRViVirtualDeviceMappingRule cmdlet. Set the $disks[0] variable as the SourceVirtualDevice parameter value. Set the $datastore variable as the Datastore parameter value.
|
Related Commands
Example 1. Mapping Backed-Up Virtual Disks to Default Datastore