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

Set-VBRDefaultGateway

Short Description

Modifies cloud default gateways.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRDefaultGateway -Gateway <VBRDefaultGateway> [-IpAddress <string>] [-NetworkMask <string>] [<CommonParameters>]

Detailed Description

This cmdlet modifies the default cloud gateway.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Gateway	Specifies the default cloud gateway you want to modify. Accepts VBRDefaultGateway type.	True	Named	True (ByValue, ByProperty Name)	False
IpAddress	Specifies the IP address you want to assign to the default gateway.	False	Named	False	False
NetworkMask	Specifies the network mask you want to assign to the default gateway.	False	Named	False	False
PassThru	Indicates that the command returns the output object to the Windows PowerShell console.	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

VBRDefaultGateway

Example

This example shows how to set the IP address and the network mask of a selected default gateway.

Run Get-VBRDefaultGatewayConfiguration to get all default gateway configurations. Save it to $c variable.
Get all default gateways by name. Save the array of gateways to $alldefaultgateways variable.
Run $alldefaultgateways to see all the names of all gateways available.
Select the first default gateway from the array. Save it to $defaultgateway variable.
Run Set-VBRDefaultGateway to set the IP address and network mask of the selected default gateway.

$c = Get-VBRDefaultGatewayConfiguration

$alldefaultgateways = $c.Defaultgateway.name

$alldefaultgateways

Hardware plan hv network 1

Hardware plan hv network 1 (internet)

$defaultgateway = $c.Defaultgateway[0]

Set-VBRDefaultGateway -Gateway $defaultgateway -IpAddress "172.16.2.232" -NetworkMask "255.255.0.0"

Related Commands

Set-VBRDefaultGatewayConfiguration