Set-VBRViVirtualDeviceMappingRule

In this article

    Short Description

    Modifies backed-up virtual disk mapping settings.

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

    Syntax

    Set-VBRViVirtualDeviceMappingRule -MappingRule <VBRViVirtualDeviceMappingRule> [-SourceVirtualDevice <VBRViVirtualDevice>] [-Datastore <CViDatastoreItem>] [<CommonParameters>]

    Detailed Description

    This cmdlet modifies mapping settings of backed-up virtual disks.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    MappingRule

    Specifies the mapping settings that you want to modify.

    Accepts the VBRViVirtualDeviceMappingRule object. To define this object, run the New-VBRViVirtualDeviceMappingRule cmdlet.

    True

    Named

    True (ByValue, ByPropertyName)

    SourceVirtualDevice

    Specifies backed-up virtual disks. The cmdlet will map these disks to the datastore.

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

    False

    Named

    False

    Datastore

    Specifies a datastore. The cmdelt will map backed-up virtual disks to this 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 the About CommonParameters section of Microsoft Docs.

    Output Object

    The cmdlet returns the VBRViVirtualDeviceMappingRule object that defines backed-up virtual disks mapping settings.

    Examples

    Modifying Mapping Settings of Backed-Up Virtual Disks

    This example shows how to modify an existing mapping rule. The cmdlet will set this rule to map backed-up virtual disks to the LocalStore_0 datastore.

    $backup = Get-VBRBackup -Name "Winsrv4515"

    $restorepoint = Get-VBRRestorePoint -Backup $backup

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

    $mappingrule = New-VBRViVirtualDeviceMappingRule -SourceVirtualDevice $disks

    $server = Get-VBRServer -Name "WinSrv2073"

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

    Set-VBRViVirtualDeviceMappingRule -MappingRule $mappingrule -Datastore $datastore

    Perform the following steps:

    1. Get the backed-up VM virtual disks:
    1. Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
    2. Run the Get-VBRRestorePoint cmdlet. Specify the Backup parameter value. Save the result to the $restorepoint variable.
    3. Run the Get-VBRViVirtualDevice cmdlet. Specify 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).

    1. Run the New-VBRViVirtualDeviceMappingRule cmdlet. Specify the SourceVirtualDevice parameter value. Save the result to the $mappingrule variable.
    2. Get the datastore:
    1. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable
    2. Run the Find-VBRViDatastore cmdlet. Specify the Name and Server parameter values. Save the result to the $datastore variable.
    1. Run the Set-VBRViVirtualDeviceMappingRule cmdlet. Set the $mappingrule variable as the MappingRule parameter value. Set the $datastore variable as the Datastore parameter value.

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.