New-VBRViVirtualLabProxyAppliance

Short Description

Defines settings of proxy appliances.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides parameter sets that allow you to:

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

New-VBRViVirtualLabProxyAppliance -Server <CHost> -ObtainIPAutomatically -ObtainDNSAutomatically [-Name <string>] [-Datastore <VBRViDatastore>] [-Network <VBRViNetworkInfo>] [-HTTPPort <int>] [-ProductionProxyIPAddress <ipaddress>] [-EnableInternetProxy]  [<CommonParameters>]

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

New-VBRViVirtualLabProxyAppliance -Server <CHost> [-Name <string>] [-Datastore <VBRViDatastore>] [-Network <VBRViNetworkInfo>] [-IPAddress <ipaddress>] [-SubnetMask <string>] [-DefaultGateway <ipaddress>][-PreferredDNSServer <ipaddress>] [-AlternateDNSServer <ipaddress>] [-HTTPPort <int>] [-ProductionProxyIPAddress <ipaddress>] [-EnableInternetProxy]  [<CommonParameters>]

Detailed Description

This cmdlet creates the VBRViVirtualLabProxyAppliance object that defines settings of proxy appliances that are added to the virtual lab.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Server

Specifies an ESXi host. The cmdlet will deploy a proxy appliance on this host.

Note: The ESXi host must be the same as the ESXi host where the virtual lab is created.

This parameter must be the same as the Server parameter in the objects that are created by the following cmdlets:

Accepts the CHost object. To get this object, run the Get-VBRServer cmdlet.

True

Named

False

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

ObtainDNSAutomatically

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

SwitchParamter

True

Named

False

Name

Specifies a name of a proxy appliance. The cmdlet will deploy the proxy appliance with this name.

String

False

Named

False

Datastore

Specifies the datastore. The cmdlet will deploy a proxy appliance on this datastore.

VBRViDatastore

False

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

New-VBRViVirtualLabProxyApplianceExample 1. Defining Settings of Proxy Appliance with Automatic IP and DNS Setup

This example shows how to define settings of the Proxy_appliance_05proxy appliance that is deployed with the automatic IP and DNS setup. The proxy appliance will be deployed with the following settings:

  • 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.
  • The proxy appliance will connect to the production network on the esx09.tech.local ESXi host.

 

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

$network = Get-VBRViServerNetworkInfo -Server $esx

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

New-VBRViVirtualLabProxyAppliance -Server $esx -ObtainIPAutomatically -ObtainDNSAutomatically -Name "Proxy_appliance_05" -Datastore $datastore -Network $network[3]

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 following settings:
  • Set the $esx variable as the Server parameter value.
  • Specify the ObtainIPAutomatically parameter.
  • Specify the ObtainDNSAutomatically parameter.
  • Specify the Name parameter value.
  • Set the $datastore variable as the Datastore parameter value.
  • Set the $network[3] 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 fourth production network in the array).

New-VBRViVirtualLabProxyApplianceExample 2. Defining Settings of Proxy Appliance as Proxy

This example shows how to define settings of a proxy appliance that is deployed with the automatic IP and DNS and acts as an Internet proxy server. The proxy appliance will be deployed with the following settings:

  • The proxy appliance will be deployed on the esx07.tech.local ESXi host.
  • Veeam Backup & Replication will keep redo logs for verified VMs on the vPower NFS server.
  • VMs from the isolated network will use the 172.17.1.2 IP address to access the Internet.
  • VMs from isolated network will use this the 8085 port number to access the Internet.

 

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

New-VBRViVirtualLabProxyAppliance -Server $esx -ObtainIPAutomatically -ObtainDNSAutomatically -HTTPPort 8085 -ProductionProxyIPAddress 172.17.1.2 -EnableInternetProxy

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 following settings:
  • Set the $esx variable as the Server parameter value.
  • Specify the ObtainIPAutomatically parameter.
  • Specify the ObtainDNSAutomatically parameter.
  • Specify the HTTPPort parameter value.
  • Specify the ProductionProxyIPAddress parameter value.
  • Specify the EnableInternetProxy parameter.

New-VBRViVirtualLabProxyApplianceExample 3. Defining Settings of Proxy Appliance with Manual IP and DNS Setup

This example shows how to define settings of the Proxy_appliance_07 proxy appliance that is deployed with manual IP and DNS setup. The proxy appliance will be deployed with the following settings:

  • The proxy appliance will be deployed on the esx07.tech.local ESXi host.
  • The proxy appliance will use the 172.17.53.162 IP to connect to the production network.
  • The proxy appliance is assigned the 255.255.0.0 subnet mask.
  • The default gateway is assigned the 172.17.53.168 IP.
  • The IP of the preferred DNS server is set to 172.17.53.175.
  • The IP of the alternate DNS server is set to 172.17.53.176.

 

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

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

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 following settings:
  • Set the $esx variable as the Server parameter value.
  • Specify the Name parameter value.
  • Specify the IPAddress parameter value.
  • Specify the SubnetMask parameter value.
  • Specify the DefaultGateway parameter value.
  • Specify the PreferredDNSServer parameter value.
  • Specify the AlternateDNSServer 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.