Set-VBRViVirtualLabIPMappingRule

In this article

    Short Description

    Modifies static IP address mapping rules.

    Applies to

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

    Syntax

    Set-VBRViVirtualLabIPMappingRule -Rule <VBRViVirtualLabIPMappingRule> -ProductionNetwork <VBRViNetworkInfo> [-IsolatedIPAddress <ipaddress>] [-AccessIPAddress <ipaddress>] [-Note <string>]  [<CommonParameters>]

    Detailed Description

    This cmdlet modifies static IP address mapping rules.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Rule

    Specifies a static IP mapping rule that you want to modify.

    Accepts the VBRViVirtualLabIPMappingRule object. To create this object, run the New-VBRViVirtualLabIPMappingRule cmdlet.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    ProductionNetwork

    Specifies a production network with original VMs. The cmdlet will set up static mapping of IP address from this network with IP addresses from the isolated network.

    Accepts the VBRViNetworkInfo object. To get this object, run the Get-VBRViServerNetworkInfo cmdlet.

    False

    Named

    False

    IsolatedIPAddress

    Specifies an IP address of an isolated network. The cmdlet will map this IP address with an IP address of a production network.

    IPAddress

    False

    Named

    False

    AccessIPAddress

    Specifies an IP address of a production network. The cmdlet will map this IP address with an IP address of an isolated network.

    IPAddress

    False

    Named

    False

    Note

    Specifies notes that you want to assign to the static mapping settings.

    String

    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 VBRViVirtualLabNetworkMappingRule object that defines static IP address mapping rules.

    Examples

    Set-VBRViVirtualLabIPMappingRuleExample 1. Modifying IP Address of Isolated Network

    This example shows how to modify an IP address of isolated network for a static IP address mapping rule. The 172.17.53.75 IP of the isolated network will be mapped with the 172.17.53.162 IP address of the production network..

    $server = Get-VBRServer -Name "srv01.veeam.local"

    $network = Get-VBRViServerNetworkInfo -Server $server

    $mapping = New-VBRViVirtualLabIPMappingRule -ProductionNetwork $network[2] -IsolatedIPAddress 172.17.53.15 -AccessIPAddress 172.17.53.162

    Set-VBRViVirtualLabIPMappingRule -Rule $mapping -IsolatedIPAddress 172.17.53.75

    Perform the following steps:

    1. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
    2. Run the Get-VBRViServerNetworkInfo cmdlet. Set the $server variable as the Server parameter value. Save the result to the $network variable.
    3. Run the New-VBRViVirtualLabIPMappingRule cmdlet. Specify ProductionNetwork, IsolatedIPAddress and AccessIPAddress parameters. Save the result to the $mapping variable.
    4. Run the Set-VBRViVirtualLabIPMappingRule cmdlet. Set the $mapping variable as the Rule parameter value. Specify the IsolatedIPAddress parameter value.

    Set-VBRViVirtualLabIPMappingRuleExample 2. Modifying IP Address of Production Network

    This example shows how to modify an IP address of a production network for a static IP address mapping rule. The 172.17.53.15 IP of the isolated network will be mapped with the 172.17.53.170 IP address of the production network.

    $server = Get-VBRServer -Name "srv01.veeam.local"

    $network = Get-VBRViServerNetworkInfo -Server $server

    $mapping = New-VBRViVirtualLabIPMappingRule -ProductionNetwork $network[2] -IsolatedIPAddress 172.17.53.15 -AccessIPAddress 172.17.53.162

    Set-VBRViVirtualLabIPMappingRule -Rule $mapping -AccessIPAddress 172.17.53.170

    Perform the following steps:

    1. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
    2. Run the Get-VBRViServerNetworkInfo cmdlet. Set the $server variable as the Server parameter value. Save the result to the $network variable.
    3. Run the New-VBRViVirtualLabIPMappingRule cmdlet. Specify ProductionNetwork, IsolatedIPAddress and AccessIPAddress parameters.
    4. Run the Set-VBRViVirtualLabIPMappingRule cmdlet. Set the $mapping variable as the Rule parameter value. Specify the AccessIPAddress 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.