New-VBRCloudProviderNetworkAppliance

Short Description

Creates a network extension appliance on the user side.

Applies to

Platform: VMware, Hyper-V

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

Syntax

This cmdlet provides three parameter sets.

For creating an appliance with default settings:

New-VBRCloudProviderNetworkAppliance -Server <CHost> [-Network <IVBRServerNetworkInfo>] [-IpAddress <String>] [-SubnetMask <String>] [-DefaultGateway <String>] [-Ipv6Address <String>] [-Ipv6PrefixLength <Int32>] [-Ipv6DefaultGateway <String>] [-EnableIpv4Interface <Boolean>] [-EnableIpv6Interface <Boolean>] [-ObtainIpAddressAutomatically] [-ObtainIpv6AddressAutomatically] [<CommonParameters>]

For creating a VMware appliance with advanced settings:

New-VBRCloudProviderNetworkAppliance -Server <CHost> [-ResourcePool <CViResourcePoolItem>] [-Network <IVBRServerNetworkInfo>] [-IpAddress <String>] [-SubnetMask <String>] [-DefaultGateway <String>] [-Ipv6Address <String>] [-Ipv6PrefixLength <Int32>] [-Ipv6DefaultGateway <String>] [-EnableIpv4Interface <Boolean>] [-EnableIpv6Interface <Boolean>] [-ObtainIpAddressAutomatically] [-ObtainIpv6AddressAutomatically] [-Datastore <VBRViDatastore>] [<CommonParameters>]

For creating a Hyper-V appliance with advanced settings:

Detailed Description

This cmdlet creates a VMware or a Hyper-V network extension appliance on the user's host. This appliance is applied in the cloud provider settings (see Managing Service Provider).

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Server	The ESXi or a Hyper-V host where the VMs you want to replicate locate. The network appliance will be created on this host.	True	Named	False	False
Network	Specifies the service provider network. The appliance will use this network to communicate between the user's production VMs and VM replicas on the cloud host.	False	Named	False	False
IpAddress	Specifies the IP address. This address will be assigned to the appliance.	False	Named	False	False
SubnetMask	Specifies the subnet mask. This subnet mask will be used by the appliance.	False	Named	False	False
DefaultGateway	Specifies the default gateway. This gateway will be used by the appliance.	False	Named	False	False
Ipv6Address	Specifies the IPv6 address that you want to assign to the appliance.	False	Named	False	False
Ipv6PrefixLength	Specifies the length of an IPv6 prefix.	False	Named	False	False
Ipv6DefaultGateway	Specifies the IPv6 address of the default gateway. The appliance will use this IP address.	False	Named	False	False
EnableIpv4Interface	Enables the IPv4 settings. If you provide this parameter, you will be able to specify the following settings. IPv4 address Subnet mask Default gateway Note Mind the following: To disable the IPv4 settings, set the parameter to EnableIpv4Interface $False, value. In this case, you will not be able to specify the network settings manually. To enable IPv4 settings, set this parameter to EnableIpv4Interface $True.	False	Named	False	False
EnableIpv6Interface	Enables the IPv6 settings. If you provide this parameter, you will be able to specify the following settings. IPv6 address The length of an IPv6 prefix Default gateway Note Mind the following: To disable the IPv6 settings, set the parameter to EnableIpv4Interface $False, value. In this case, you will not be able to specify the network settings manually. To enable IPv6 settings, set this parameter to EnableIpv4Interface $True.	False	Named	False	False
ObtainIpAddressAutomatically	Defines that the cmdlet will assign the IPv4 address automatically.	False	Named	False	False
ObtainIpv6AddressAutomatically	Defines that the cmdlet will assign the IPv6 address automatically.	False	Named	False	False
ResourcePool	Specifies the resource pool where you want to create the VMware appliance.	False	Named	False	False
Datastore	Specifies the datastore where you want to create the VMware appliance.	False	Named	False	False
Folder	Specifies the folder where you want to create the Hyper-V appliance.	False	Named	False	False
VLanId	Specifies the VLAN network provided to the user by the hardware plan. The appliance will use this VLAN to connect to the service provider network.	False	Named	False	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

VBRViCloudProviderNetworkAppliance

VBRHvCloudProviderNetworkAppliance

Example 1

This example shows how to create a VMware appliance with advanced settings on the “srv01.veeam.local” host.

Run Get-VBRServer to get the server where you want to create the appliance. Save the server to the $server variable.
Run Get-VBRViServerNetworkInfo to get the virtual network that will be used to communicate with VM replicas. Pass the result to the Where-Object cmdlet to select the networks with the NetworkName property that equals "VM Network". Save the network to the $network variable.
Run Find-VBRViResourcePool to specify the resource pool where the appliance will be created. Use the $server variable. Save the resource pool to the $respool variable.
Run Find-VBRViDatastore to specify the datastore where the appliance will be created. Use the $server variable. Save the datastore to the $datastore variable.
Run New-VBRCloudProviderNetworkAppliance to create the appliance. Use the saved variables.

$server = Get-VBRServer –Type ESXi -Name "srv01.veeam.local"

$network = Get-VBRViServerNetworkInfo -Server $server | Where { $_.NetworkName -eq "VM Network" }

$respool = Find-VBRViResourcePool -Server $server -Name "ResourcePool_01"

$datastore = Find-VBRViDatastore -Server $server –Name "NOPDatastore"

$viAppl = New-VBRCloudProviderNetworkAppliance -Server $server -Network $network -ResourcePool $respool -Datastore $datastore

Example 2

This example shows how to create a Hyper-V appliance with advanced settings on the “srv02.veeam.local” host.

Run Get-VBRServer to get the server where you want to create the appliance. Save the server to the $server variable.
Specify the path to the folder where the appliance will be created. Save the path to the $folder variable.
Run Get-VBRHvServerNetworkInfo to get the virtual network that will be used to communicate with VM replicas. Use the $server variable and the Where-Object statement to filter the networks by the .NetworkName property. Save the network to the $network variable.
Run New-VBRCloudProviderNetworkAppliance to create the appliance. Use the saved variables.

$server = Get-VBRServer –Type HvServer -Name "srv02.veeam.local"

$folder = "C:\Datastore"

$network = Get-VBRHvServerNetworkInfo -Server $server | Where { $_.NetworkName -eq "VM Network" }

$hvAppl = New-VBRCloudProviderNetworkAppliance -Server $server -Network $network –Folder $folder

Related Commands

Get-VBRServer

Get-VBRHvServerNetworkInfo

Get-VBRViServerNetworkInfo

Find-VBRViResourcePool

Find-VBRViDatastore