This is an archive version of the document. To get the most up-to-date information, see the current version.

Set-VBRCloudTenantNetworkAppliance

Short Description

Modifies network extension appliances.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Requires a VCP license.

Syntax

This cmdlet provides the following parameter sets:

To obtain an IP address automatically

Set-VBRCloudTenantNetworkAppliance -Appliance <VBRCloudTenantNetworkAppliance> [-Name <string>] [-ProductionNetwork <IVBRServerNetworkInfo>] [-ObtainIpAddressAutomatically] [<CommonParameters>]

To apply user-defined IP address

Set-VBRCloudTenantNetworkAppliance -Appliance <VBRCloudTenantNetworkAppliance> -IpAddress <ipaddress> -DefaultGateway <ipaddress> -SubnetMask <string> [-Name <string>] [-ProductionNetwork <IVBRServerNetworkInfo>] [<CommonParameters>]

Detailed Description

This cmdlet modifies a selected network extension appliance. You can modify the network extension appliance for the cloud tenants of the following types:

Simple cloud tenant accounts
vCD Cloud tenant accounts

A network extension appliance can be created by a service provider or by a tenant. Networks appliances created by service providers are created automatically if you use the EnableNetworkFailoverResources parameter in the New-VBRCloudTenantReplicationResources cmdlet. The cmdlets in this section operate only with the network appliances, created by service providers.

To modify settings, you need to enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Appliance	Specifies the network appliance you want to modify. Accepts the VBRCloudTenantNetworkAppliance type.	True	Named	True (ByValue, ByProperty Name)	False
Name	Specifies the name of the network appliance.	False	Named	False	False
Production Network	Specifies the network. The appliance will be connected to this network.	False	Named	False	False
Obtain IpAddress Automatically	Indicates that the IP address must be assigned to the appliance automatically.	False	Named	False	False
IpAddress	Specifies the IP address that you want to assign to the appliance.	True	Named	False	False
Default Gateway	Specifies the IP address of the default gateway. The appliance will use this IP address.	True	Named	False	False
Subnet Mask	Specifies the subnet mask. The appliance will use this subnet mask.	True	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

VBRCloudTenantNetworkAppliance

Example

This example shows how to edit a network appliance settings.

Run Get-VBRCloudTenantNetworkAppliance to get the appliance. Save the appliance to the $appliance variable.
Run Set-VBRCloudTenantNetworkAppliance to modify the appliance settings. Use the $appliance variable and enter the new settings.

$appliance = Get-VBRCloudTenantNetworkAppliance –Name “Cloud Appliance for ABC Company”

Set-VBRCloudTenantNetworkAppliance –Appliance $appliance –Name "New Cloud Appliance for ABC Company" –IpAddress 172.15.15.10 –SubnetMask 255.255.255.0 –DefaultGateway 172.15.15.1

Related Commands

Get-VBRCloudTenantNetworkAppliance

Get-VBRHvServerNetworkInfo

Get-VBRViServerNetworkInfo