New-VBRViVirtualLabNetworkOptions

Short Description

Defines network settings of isolated networks.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

New-VBRViVirtualLabNetworkOptions -NetworkMappingRule <VBRViVirtualLabNetworkMappingRule> -IPAddress <ipaddress> -SubnetMask <string> -MasqueradeIPAddress <ipaddress> [-DNSServer <ipaddress[]>] [-EnableDHCP][<CommonParameters>]

Detailed Description

This cmdlet creates the VBRViVirtualLabNetworkOption object that defines network settings of isolated networks and how to map it to production networks.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

NetworkMappingRule

Specifies a network mapping rule of an isolated network. The cmdlet will map the isolated network to the production network that is specified in this rule.

Accepts the VBRViVirtualLabNetworkMappingRule object. To create this object, run theNew-VBRViNetworkMappingRule cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

IPAddress

Specifies an IP address of the proxy appliance. Veeam Backup & Replication will use this IP address to connect an isolated network with the production network.

IPAddress

True

Named

False

SubnetMask

Specifies a subnet mask of an isolated network.

String

True

Named

False

MasqueradeIPAddress

Specifies a masquerade IP address. Veeam Backup & Replication will use this IP address to access VMs in the isolated network from the production network.

IPAddress

True

Named

False

DNSServer

Specifies an array of IP addresses of virtualized DNS servers.

IPAddress[]

False

Named

False

EnableDHCP

Defines that the cmdlet will enable the DHCP service.

If you provide this parameter, Veeam Backup & Replication will dynamically assign IP addresses for isolated VMs. Otherwise, you must assign the IP addresses manually.

SwitchParamter

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 VBRViVirtualLabNetworkOption object that defines network settings of isolated networks and how to map it to production networks.

Examples

New-VBRViVirtualLabNetworkOptionsExample 1. Defining Network Settings of Isolated Network

This example shows how to define network settings of the Sandbox01 Private VM Network isolated network to map to the production network. The isolated network will be set up with the following settings:

  • The IP address of the proxy appliance is assigned the 172.17.1.2 IP.
  • The subnet mask is set to 255.255.0.0.
  • The masquerade IP address is set to 172.22.22.22.
  • The cmdlet output will contain the details on the network settings of the isolated network.

 

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

$network = Get-VBRViServerNetworkInfo -Server $server

$maprule = New-VBRViNetworkMappingRule -ProductionNetwork $network[3] -IsolatedNetworkName "Sandbox01 Private VM Network" -VLANID 5

New-VBRViVirtualLabNetworkOptions -NetworkMappingRule $maprule -IPAddress 172.17.1.2 -SubnetMask 255.255.0.0 -MasqueradeIPAddress 172.22.22.22

NetworkMappingRule  : Veeam.Backup.PowerShell.Infos.VBRViVirtualLabNetworkMappingRule

IPAddress           : 172.17.1.2

SubnetMask          : 255.255.0.0

MasqueradeIPAddress : 172.22.22.22

DNSServer           : {}

DHCPEnabled         : False

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-VBRViNetworkMappingRule cmdlet. Specify the ProductionNetwork, IsolatedNetworkName and VLANID parameters. Save the result to the $maprule variable.
  4. Run the New-VBRViVirtualLabNetworkOptions cmdlet. Specify the following settings:
  • Set the $maprule as the NetworkMappingRule parameter value.
  • Specify the IPAddress parameter value.
  • Specify the SubnetMask parameter value.
  • Specify the MasqueradeIPAddress parameter value.

New-VBRViVirtualLabNetworkOptionsExample 2. Defining Network Settings of Isolated Network with DHCP Service and DNS Server

This example shows how to define network settings of the Sandbox01 Private VM Network isolated network to connect to map to the production network using the DHCP Service and DNS Server.

The cmdlet output will contain the details on the network settings of the isolated network.

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

$network = Get-VBRViServerNetworkInfo -Server $server

$maprule = New-VBRViNetworkMappingRule -ProductionNetwork $network[3] -IsolatedNetworkName "Sandbox01 Private VM Network" -VLANID 5

New-VBRViVirtualLabNetworkOptions -NetworkMappingRule $maprule -IPAddress 172.17.1.2 -SubnetMask 255.255.0.0 -MasqueradeIPAddress 172.22.22.22 -DNSServer 192.168.1.99 -EnableDHCP

NetworkMappingRule  : Veeam.Backup.PowerShell.Infos.VBRViVirtualLabNetworkMappingRule

IPAddress           : 172.17.1.2

SubnetMask          : 255.255.0.0

MasqueradeIPAddress : 172.22.22.22

DNSServer           : 192.168.1.99

DHCPEnabled         : True

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-VBRViNetworkMappingRule cmdlet. Specify the ProductionNetwork, IsolatedNetworkName and VLANID parameters. Save the result to the $maprule variable.
  4. Run the New-VBRViVirtualLabNetworkOptions cmdlet. Specify the following settings:
  • Set the $maprule as the NetworkMappingRule parameter value.
  • Specify the IPAddress parameter value.
  • Specify the SubnetMask parameter value.
  • Specify the MasqueradeIPAddress parameter value.
  • Specify the DNSServer parameter value.
  • Specify the EnableDHCP parameter.

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.