Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

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

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>] [<CommonParameters>]

  • For creating a VMware appliance with advanced settings:

New-VBRCloudProviderNetworkAppliance -Server <CHost> [-ResourcePool <CViResourcePoolItem>] [-Network <IVBRServerNetworkInfo>] [-IpAddress <string>] [-SubnetMask <string>] [-DefaultGateway <string>] [-Datastore <VBRViDatastore>] [<CommonParameters>]

  • For creating a Hyper-V appliance with advanced settings:

New-VBRCloudProviderNetworkAppliance -Server <CHost> [-Network <IVBRServerNetworkInfo>] [-IpAddress <string>] [-SubnetMask <string>] [-DefaultGateway <string>] [-Folder <string>] [-VLanId <int>] [<CommonParameters>]

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 ESX 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

Subnet
Mask

Specifies the subnet mask. This subnet mask will be used by the appliance.

False

Named

False

False

Default
Gateway

Specifies the default gateway. This gateway will be used by the appliance.

False

Named

False

False

Resource
Pool

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

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

VBRViCloudProviderNetworkAppliance

VBRHvCloudProviderNetworkAppliance

Example 1

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

  1. Run Get-VBRServer to get the server where you want to create the appliance. Save the server to the $server variable.
  2. 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.
  3. 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.
  4. Run Find-VBRViDatastore to specify the datastore where the appliance will be created. Use the $server variable. Save the datastore to the $datastore variable.
  5. Run New-VBRCloudProviderNetworkAppliance to create the appliance. Use the saved variables.

PS C:\PS> $server = Get-VBRServer –Type ESX -Name "srv01.veeam.local"

PS C:\PS> $network = Get-VBRViServerNetworkInfo -Server $server | Where { $_.NetworkName -eq "VM Network" }

PS C:\PS> $respool = Find-VBRViResourcePool -Server $server -Name "ResourcePool_01"

PS C:\PS> $datastore = Find-VBRViDatastore -Server $server –Name "NOPDatastore"

PS C:\PS> $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.

  1. Run Get-VBRServer to get the server where you want to create the appliance. Save the server to the $server variable.
  2. Specify the path to the folder where the appliance will be created. Save the path to the $folder variable.
  3. 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.
  4. Run New-VBRCloudProviderNetworkAppliance to create the appliance. Use the saved variables.

PS C:\PS> $server = Get-VBRServer –Type HvServer -Name "srv02.veeam.local"

PS C:\PS> $folder = "C:\Datastore"

PS C:\PS> $network = Get-VBRHvServerNetworkInfo -Server $server  | Where { $_.NetworkName -eq "VM Network" }

PS C:\PS> $hvAppl = New-VBRCloudProviderNetworkAppliance -Server $server -Network $network –Folder $folder

Related Commands

Get-VBRServer

Get-VBRHvServerNetworkInfo

Get-VBRViServerNetworkInfo

Find-VBRViResourcePool

Find-VBRViDatastore

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Endpoint Backup Documentation

Veeam Management Pack Documentation