Set-VBRViVirtualLabNetworkOptions

Short Description

Modifies network settings of isolated networks.

Applies to

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

Syntax

Set-VBRViVirtualLabNetworkOptions -Options <VBRViVirtualLabNetworkOptions> [-NetworkMappingRule <VBRViVirtualLabNetworkMappingRule>] [-IPAddress <ipaddress>] [-SubnetMask <string>] [-MasqueradeIPAddress <ipaddress>] [-DNSServer <ipaddress[]>] [-EnableDHCP] [-IPv6Address <ipaddress>] [-IPv6PrefixLength <int>] [-MasqueradeIPv6Address <ipaddress>] [-IPv6DNSServer <ipaddress[]>] [-EnableDHCPv6] [<CommonParameters>]

Detailed Description

This cmdlet modifies network settings of isolated networks and how to map it to production networks.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Options	Specifies network settings that you want to modify.	Accepts the VBRViVirtualLabNetworkOptions object. To create this object, run the New-VBRViVirtualLabNetworkOptions cmdlet.	True	Named	True (ByValue, ByProperty Name)
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 the New-VBRViNetworkMappingRule cmdlet.	False	Named	False
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	False	Named	False
IPv6Address	Specifies an IPv6 address of the proxy appliance. Veeam Backup & Replication will use this IP address to connect an isolated network with the production network.	IPAddress	False	Named	False
SubnetMask	Specifies a subnet mask of an isolated network.	String	False	Named	False
IPv6PrefixLength	Specifies a prefix length of an isolated network.	<int>	False	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	False	Named	False
MasqueradeIPv6Address	Specifies a masquerade IPv6 address. Veeam Backup & Replication will use this IP address to access VMs in the isolated network from the production network.	IPAddress	False	Named	False
DNSServer	Specifies an array of IP addresses of virtualized DNS servers.	IPAddress[]	False	Named	False
IPv6DNSServer	Specifies an array of IPv6 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
EnableDHCPv6	Defines that the cmdlet will enable the DHCPv6 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

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see 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

Example 1. Modifying Subnet Mask

This example shows how to modify a subnet mask of an isolated network that connects to the to production network.

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

$network = Get-VBRViServerNetworkInfo -Server $server

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

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

Set-VBRViVirtualLabNetworkOptions -Options $isolated -SubnetMask 255.255.255.0

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Get-VBRViServerNetworkInfo cmdlet. Set the $server variable as the Server parameter value. Save the result to the $network variable.
Run the New-VBRViNetworkMappingRule cmdlet. Specify the ProductionNetwork, IsolatedNetworkName and VLANID parameter values. Save the result to the $maprule variable.
Run the New-VBRViVirtualLabNetworkOptions cmdlet. Specify the NetworkMappingRule, IPAddress, SubnetMask and MasqueradeIPAddress parameter values. Save the result to the $isolated variable.
Run the Set-VBRViVirtualLabNetworkOptions cmdlet. Set the $isolated variable as the Options parameter value. Specify the SubnetMask parameter value.

Example 2. Modifying Prefix Length

This example shows how to modify a prefix length of an isolated network that connects to the to production network.

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

$network = Get-VBRViServerNetworkInfo -Server $server

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

$isolated = New-VBRViVirtualLabNetworkOptions -NetworkMappingRule $maprule -IPv6Address fdd1:aa80:bb80:cc80:dd80:ee80:fe80:10 -IPv6PrefixLength 64 -MasqueradeIPv6Address fdd1:ab80:bb80:cc88::

Set-VBRViVirtualLabNetworkOptions -Options $isolated -IPv6PrefixLength 64

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Get-VBRViServerNetworkInfo cmdlet. Set the $server variable as the Server parameter value. Save the result to the $network variable.
Run the New-VBRViNetworkMappingRule cmdlet. Specify the ProductionNetwork, IsolatedNetworkName and VLANID parameter values. Save the result to the $maprule variable.
Run the New-VBRViVirtualLabNetworkOptions cmdlet. Specify the NetworkMappingRule, IPv6Address, IPv6PrefixLength and MasqueradeIPv6Address parameter values. Save the result to the $isolated variable.
Run the Set-VBRViVirtualLabNetworkOptions cmdlet. Set the $isolated variable as the Options parameter value. Specify the new IPv6PrefixLength parameter value.

Example 3. Modifying IP of Proxy Appliance

This example shows how to modify an IP address of a proxy appliance to which an isolated network is connected. The isolated network will connect to the proxy appliance that has the 172.17.1.7 IP address.

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

$network = Get-VBRViServerNetworkInfo -Server $server

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

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

Set-VBRViVirtualLabNetworkOptions -Options $isolated -IPAddress 172.17.1.7

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Get-VBRViServerNetworkInfo cmdlet. Set the $server variable as the Server parameter value. Save the result to the $network variable.
Run the New-VBRViNetworkMappingRule cmdlet. Specify the ProductionNetwork, IsolatedNetworkName and VLANID parameter values. Save the result to the $maprule variable.
Run the New-VBRViVirtualLabNetworkOptions cmdlet. Specify the NetworkMappingRule, IPAddress, SubnetMask and MasqueradeIPAddress parameter values. Save the result to the $isolated variable.
Run the Set-VBRViVirtualLabNetworkOptions cmdlet. Set the $isolated variable as the Options parameter value. Specify the IPAddress parameter value.

Example 4. Modifying Masquerade IP Address

This example shows how to modify a masquerade IP address of an isolated network that connect to the production network.

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

$network = Get-VBRViServerNetworkInfo -Server $server

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

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

Set-VBRViVirtualLabNetworkOptions -Options $isolated -MasqueradeIPAddress 172.22.22.24

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Get-VBRViServerNetworkInfo cmdlet. Set the $server variable as the Server parameter value. Save the result to the $network variable.
Run the New-VBRViNetworkMappingRule cmdlet. Specify the ProductionNetwork, IsolatedNetworkName and VLANID parameter values. Save the result to the $maprule variable.
Run the New-VBRViVirtualLabNetworkOptions cmdlet. Specify the NetworkMappingRule, IPAddress, SubnetMask and MasqueradeIPAddress parameter values. Save the result to the $isolated variable.
Run the Set-VBRViVirtualLabNetworkOptions cmdlet. Set the $isolated variable as the Options parameter value. Specify the MasqueradeIPAddress parameter value.

Related Commands