Set-VBRViVirtualLabProxyAppliance

Short Description

Modifies settings of proxy appliances.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides parameter sets that allow you to:

  • Modifying settings of a proxy appliance with the automatic IP and DNS setup.

Set-VBRViVirtualLabProxyAppliance -ProxyAppliance <VBRViVirtualLabProxyAppliance> -ObtainIPAutomatically -ObtainDNSAutomatically [-Network <VBRViNetworkInfo>] [-HTTPPort <int>] [-ProductionProxyIPAddress <ipaddress>][-EnableInternetProxy]  [<CommonParameters>]

  • Modifying settings of a proxy appliance with the manual IP and DNS setup.

Set-VBRViVirtualLabProxyAppliance -ProxyAppliance <VBRViVirtualLabProxyAppliance> [-Network <VBRViNetworkInfo>][-IPAddress <ipaddress>] [-SubnetMask <string>] [-DefaultGateway <ipaddress>] [-PreferredDNSServer <ipaddress>][-AlternateDNSServer <ipaddress>] [-HTTPPort <int>] [-ProductionProxyIPAddress <ipaddress>] [-EnableInternetProxy] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of proxy appliances.

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)

ObtainIPAutomatically

Defines that a proxy appliance will obtain an IP 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.

SwitchParamter

True

Named

False

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

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.

SwitchParamter

False

Named

False

IPAddress

Specifies an IP 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 IP address of a default gateway. The cmdlet will assign this IP address to a default gateway on a proxy appliance.

IPAddress

False

Named

False

PreferredDNSServer

Specifies an IP address of a preferred DNS server.

IPAddress

False

Named

False

AlternateDNSServer

Specifies an IP address of an alternate DNS server.

IPAddress

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 VBRViVirtualLabProxyAppliance object that defines settings of proxy appliances that are added to the virtual lab.

Examples

Set-VBRViVirtualLabProxyApplianceExample 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.

 

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

$network = Get-VBRViServerNetworkInfo -Server $esx

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

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

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

Perform the following steps:

  1. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $esx 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 Find-VBRViDatastore cmdlet. Set the $esx variable as the Server parameter value. Specify the Name parameter value. Save the result to the $datastore variable.
  4. Run the New-VBRViVirtualLabProxyAppliance cmdlet. Specify the necessary parameters. Save the result to the $proxyapp variable.
  5. 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 fifth production network in the array).

Set-VBRViVirtualLabProxyApplianceExample 2. Modifying IP Address of Production Network

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

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

$proxyapp = New-VBRViVirtualLabProxyAppliance -Server $esx -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:

  1. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $esx variable.
  2. Run the New-VBRViVirtualLabProxyAppliance cmdlet. Specify the necessary parameters. Save the result to the $proxyapp variable.
  3. Run the Set-VBRViVirtualLabProxyAppliance cmdlet. Set the $proxyapp as the ProxyAppliance parameter value. Specify the IPAddress 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.