Set-VBRViVirtualLabProxyAppliance

Short Description

Modifies settings of proxy appliances.

Applies to

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

Syntax

Set-VBRViVirtualLabProxyAppliance -ProxyAppliance <VBRViVirtualLabProxyAppliance> [-Network <VBRViNetworkInfo>] [-EnableIPv4Interface] [-ObtainIPAutomatically] [-IPAddress <ipaddress>] [-SubnetMask <string>] [-DefaultGateway <ipaddress>] [-ObtainDNSAutomatically] [-PreferredDNSServer <ipaddress>] [-AlternateDNSServer <ipaddress>] [-EnableIPv6Interface] [-ObtainIPv6AddressAutomatically] [-IPv6Address <ipaddress>] [-IPv6PrefixLength <int>] [-IPv6DefaultGateway <ipaddress>] [-ObtainIPv6DNSAutomatically] [-IPv6PreferredDNSServer <ipaddress>] [-IPv6AlternateDNSServer <ipaddress>] [-HTTPPort <int>] [-ProductionProxyIPAddress <ipaddress>] [-EnableInternetProxy] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of proxy appliances.

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

Parameter	Description	Type	Required	Position	Accept Pipeline Input
ProxyAppliance	Specifies a proxy appliance that you want to modify.	Accepts the VBRViVirtualLabProxyAppliance object. To create this object, run the New-VBRViVirtualLabProxyAppliance cmdlet.	True	Named	True (ByValue, ByProperty Name)
Network	Specifies the production network. The cmdlet will connect a proxy appliance to the specified network.	Accepts the VBRViNetworkInfo object. To get this object, run the Get-VBRViServerNetworkInfo cmdlet.	False	Named	False
EnableIPv4Interface	Defines that IPv4 interface will be enabled.	SwitchParameter	False	Named	False
ObtainIPAutomatically	Defines that a proxy appliance will obtain an IPv4 address automatically. If you provide this parameter, Veeam Backup & Replication will obtain an IP address for the proxy appliance automatically. Otherwise, you will need to set the IP address manually.	SwitchParameter	False	Named	False
IPAddress	Specifies an IPv4 address for a proxy appliance in the production network. The cmdlet will assign this IP address to a proxy appliance.	IPAddress	False	Named	False
SubnetMask	Specifies a subnet mask for a proxy appliance in the production network. The cmdlet will set up network settings of a proxy appliance with this subnet mask.	String	False	Named	False
DefaultGateway	Specifies an IPv4 address of a default gateway. The cmdlet will assign this IP address to a default gateway on a proxy appliance.	IPAddress	False	Named	False
ObtainDNSAutomatically	Defines that a proxy appliance will obtain DNS server settings automatically. If you provide this parameter, Veeam Backup & Replication will obtain IPv4 DNS server settings for the proxy appliance automatically. Otherwise, you will need to set the DNS server settings manually.	SwitchParameter	False	Named	False
PreferredDNSServer	Specifies an IPv4 address of a preferred DNS server.	IPAddress	False	Named	False
AlternateDNSServer	Specifies an IPv4 address of an alternate DNS server.	IPAddress	False	Named	False
EnableIPv6Interface	Defines that IPv6 interface will be enabled.	SwitchParameter	False	Named	False
ObtainIPv6AddressAutomatically	Defines that a proxy appliance will obtain an IPv6 address automatically. If you provide this parameter, Veeam Backup & Replication will obtain an IP address for the proxy appliance automatically. Otherwise, you will need to set the IP address manually.	SwitchParameter	False	Named	False
IPv6Address	Specifies an IPv6 address for a proxy appliance in the production network. The cmdlet will assign this IP address to a proxy appliance.	IPAddress	False	Named	False
IPv6PrefixLength	Specifies a prefix length for a proxy appliance in the production network. The cmdlet will set up network settings of a proxy appliance with this prefix length.	String	False	Named	False
IPv6DefaultGateway	Specifies an IPv6 address of a default gateway. The cmdlet will assign this IP address to a default gateway on a proxy appliance.	IPAddress	False	Named	False
ObtainIPv6DNSAutomatically	Defines that a proxy appliance will obtain IPv6 DNS server settings automatically. If you provide this parameter, Veeam Backup & Replication will obtain DNS server settings for the proxy appliance automatically. Otherwise, you will need to set the DNS server settings manually.	SwitchParameter	False	Named	False
IPv6PreferredDNSServer	Specifies an IPv6 address of a preferred DNS server.	IPAddress	False	Named	False
IPv6AlternateDNSServer	Specifies an IPv6 address of an alternate DNS server.	IPAddress	False	Named	False
HTTPPort	Specifies the port number. VMs from the isolated network will use this port number to access the Internet. Default: 8080.	Int32	False	Named	False
ProductionProxyIPAddress	Specifies an IP address or a fully qualified domain name of an Internet-facing proxy server that VMs from the isolated network must use to access the Internet.	IPAddress	False	Named	False
EnableInternetProxy	Defines that a proxy appliance will act as an internet proxy for VMs in the isolated network. If you provide this parameter, a proxy appliance will act as an internet proxy for VMs in the isolated network. Otherwise, VMs from the isolated network will not have access to the Internet.	SwitchParameter	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 VBRViVirtualLabProxyAppliance object that defines settings of proxy appliances that are added to the virtual lab.

Examples

Set-VBRViVirtualLabProxyAppliance Example 1. Specifying Production Network and Datastore for Proxy Appliance

This example shows how to specify a production network and a datastore for a proxy appliance.

The proxy appliance will be deployed on the esx09.tech.local ESXi host.
Veeam Backup & Replication will keep redo logs for verified VMs on the esx09-das6 datastore.

$ESXi = Get-VBRServer -Name "esx09.tech.local"

$network = Get-VBRViServerNetworkInfo -Server $ESXi

$datastore = Find-VBRViDatastore -Server $ESXi -Name "esx09-das6"

$proxyapp = New-VBRViVirtualLabProxyAppliance -Server $ESXi -ObtainIPAutomatically -ObtainDNSAutomatically -Name "Proxy_appliance_05"

Set-VBRViVirtualLabProxyAppliance -ProxyAppliance $proxyapp -Datastore $datastore -Network $network[6]

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $ESXi variable.
Run the Get-VBRViServerNetworkInfo cmdlet. Set the $ESXi variable as the Server parameter value. Save the result to the $network variable.
Run the Find-VBRViDatastore cmdlet. Set the $ESXi variable as the Server parameter value. Specify the Name parameter value. Save the result to the $datastore variable.
Run the New-VBRViVirtualLabProxyAppliance cmdlet. Specify the Server, ObtainIPAutomatically, ObtainDNSAutomatically and Name parameter values. Save the result to the $proxyapp variable.
Run the Set-VBRViVirtualLabProxyAppliance cmdlet. Specify the following settings:

Set the $proxyapp variable as the ProxyAppliance parameter value.
Set the $datastore variable as the Datastore parameter value.
Set the $network[6] variable as the Network parameter value.

The Get-VBRViServerNetworkInfo cmdlet will return an array of production networks. Mind the ordinal number of the necessary production network (An array starts with 0. In our example, it is the seventh production network in the array).

Set-VBRViVirtualLabProxyAppliance Example 2. Modifying IP Address of Production Network

This example shows how to modify an IP address of a production network.

$ESXi = Get-VBRServer -Name "esx07.tech.local"

$proxyapp = New-VBRViVirtualLabProxyAppliance -Server $ESXi -Name "Proxy_appliance_07" -IPAddress 172.17.53.162 -SubnetMask 255.255.0.0 -DefaultGateway 172.17.53.168 -PreferredDNSServer 172.17.53.175 -AlternateDNSServer 172.17.53.176

Set-VBRViVirtualLabProxyAppliance -ProxyAppliance $proxyapp -IPAddress 172.17.53.167

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $ESXi variable.
Run the New-VBRViVirtualLabProxyAppliance cmdlet. Specify the Server, Name, IPAddress, SubnetMask, DefaultGateway, PreferredDNSServer and AlternateDNSServer parameter values. Save the result to the $proxyapp variable.
Run the Set-VBRViVirtualLabProxyAppliance cmdlet. Set the $proxyapp variable as the ProxyAppliance parameter value. Specify the IPAddress parameter value.

Related Commands