New-VBRViVirtualLabProxyAppliance

Short Description

Defines settings of proxy appliances.

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

Syntax

New-VBRViVirtualLabProxyAppliance -Server <CHost> [-Name <String>] [-Datastore <VBRViDatastoreBase>]

[-Network <VBRViNetworkInfo>] [-EnableIPv4Interface] [-ObtainIPAutomatically] [-IPAddress <IPAddress>]

[-SubnetMask <String>] [-DefaultGateway <IPAddress>] [-ObtainDNSAutomatically]

[-PreferredDNSServer <IPAddress>] [-AlternateDNSServer <IPAddress>] [-EnableIPv6Interface]

[-ObtainIPv6AddressAutomatically] [-IPv6Address <IPAddress>] [-IPv6PrefixLength <Int32>]

[-IPv6DefaultGateway <IPAddress>] [-ObtainIPv6DNSAutomatically] [-IPv6PreferredDNSServer <IPAddress>]

[-IPv6AlternateDNSServer <IPAddress>] [-HTTPPort <Int32>] [-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

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
AlternateDNSServer	Specifies an IPv4 address of an alternate DNS server.	`IPAddress`	False	Named	False
Datastore	Specifies the datastore. The cmdlet will deploy a proxy appliance on this datastore. Accepts the `VBRViDatastore` object. To get this object, run the Find-VBRViDatastore cmdlet.	`VBRViDatastoreBase`	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
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
EnableIPv4Interface	Defines that IPv4 interface will be enabled.	`SwitchParameter`	False	Named	False
EnableIPv6Interface	Defines that IPv6 interface will be enabled.	`SwitchParameter`	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
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
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
IPv6AlternateDNSServer	Specifies an IPv6 address of an alternate DNS server.	`IPAddress`	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
IPv6PreferredDNSServer	Specifies an IPv6 address of a preferred DNS server.	`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.	`Int32`	False	Named	False
Name	Specifies a name of a proxy appliance. The cmdlet will deploy the proxy appliance with this name.	`String`	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.	`VBRViNetworkInfo`	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
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
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
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
PreferredDNSServer	Specifies an IPv4 address of a preferred DNS server.	`IPAddress`	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
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: `Add-VBRViAdvancedVirtualLab` `Add-VBRViSimpleVirtualLab` `Set-VBRViVirtualLab` Accepts the `CHost` object. To get this object, run the `Get-VBRServer` cmdlet.	`CHost`	True	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

<CommonParameters>

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

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

This example shows how to define settings of the Proxy_appliance_05 proxy 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.

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

$network = Get-VBRViServerNetworkInfo -Server $ESXi

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

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

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 following settings:
- Set the $ESXi variable as the Server parameter value.
- Provide the ObtainIPAutomatically parameter.
- Provide 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-VBRViVirtualLabProxyAppliance Example 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.

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

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

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

New-VBRViVirtualLabProxyAppliance Example 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.

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

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

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 following settings:
- Set the $ESXi 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.