Set-VBRCloudProviderNetworkAppliance

In this article

    Short Description

    Modifies network extension appliances on 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 modifying an appliance with default settings:

    Set-VBRCloudProviderNetworkAppliance -NetworkAppliance <VBRCloudProviderNetworkAppliance> [-Server <CHost>] [-Network <IVBRServerNetworkInfo>] [-IpAddress <string>] [-SubnetMask <string>] [-DefaultGateway <string>] [<CommonParameters>]

    • For modifying a VMware appliance with advanced settings:

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

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

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

    Detailed Description

    This cmdlet modifies a selected VMware or a Hyper-V network extension appliance on the user's cloud host. To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Network
    Appliance

    Specifies the network appliance that you want to modify.

    True

    Named

    False

    False

    Server

    The ESX or a Hyper-V host where you want to create the appliance.

    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 on common parameters, see the About CommonParameters section of Microsoft Docs.

    Return Type

    VBRViCloudProviderNetworkAppliance

    VBRHvCloudProviderNetworkAppliance

    Example 1

    This example shows how to change the resource pool for a VMware appliance created on the ”srv02.veeam.local” host.

    1. Run Get-VBRCloudProviderNetworkAppliance to get the network appliance you want to edit. Save it to the $viAppl variable.
    2. Get the ESX server where the appliance was created. Save the server to the $server variable.
    3. Run Find-VBRViResourcePool to specify the new resource pool where the appliance will be registered. Use the $server variable. Save the resource pool to the $newrespool variable.
    4. Run Set-VBRCloudProviderNetworkAppliance to modify the network appliance settings. Use the saved variables.

    $viAppl = Get-VBRCloudProvider –Name "104.45.95.227" | Get-VBRCloudProviderNetworkAppliance

    $server = $viAppl.Host

    $newResPool = Find-VBRViResourcePool -Name $newResPoolName -Server $server

    Set-VBRCloudProviderNetworkAppliance –NetworkAppliance $viAppl –ResourcePool $newResPool

    Example 2

    This example shows how to change the folder for a Hyper-V appliance created on the ”srv02.veeam.local” host.

    1. Run Get-VBRCloudProviderNetworkAppliance to get the network appliance you want to edit. Save it to the $hvAppl variable.
    2. Specify the new path to the folder where the appliance will be registered. Save the path to the $newfolder variable.
    3. Run Set-VBRCloudProviderNetworkAppliance to modify the network appliance settings. Use the saved variables.

    $hvAppl = Get-VBRCloudProvider –Name "104.45.95.227" | Get-VBRCloudProviderNetworkAppliance

    $newFolder = “C:\Users\admin”

    Set-VBRCloudProviderNetworkAppliance –NetworkAppliance $hvAppl –Folder $newFolder

    Related Commands

    Get-VBRCloudProviderNetworkAppliance

    Get-VBRServer

    Get-VBRHvServerNetworkInfo

    Get-VBRViServerNetworkInfo

    Find-VBRViResourcePool

    Find-VBRViDatastore