This is an archive version of the document. To get the most up-to-date information, see the current version.Set-VBRDefaultGatewayConfiguration
Short Description
Modifies default gateways configuration.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRDefaultGatewayConfiguration -Configuration <VBRDefaultGatewayConfiguration> [-EnableRouting] [-PassThru] [<CommonParameters>] |
Detailed Description
This cmdlet modifies settings of the default gateway. 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 | Accept |
Configuration | Specifies the default gateway configuration that you want to modify. Accepts VBRDefaultGatewayConfiguration type. | True | Named | True (ByValue, | False |
EnableRouting | If indicated, the gateway will provide routing. | False | Named | False | False |
PassThru | Indicates that the command returns the output object to the Windows PowerShell console. | 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
VBRDefaultGatewayConfiguration[]
Example
This example shows how to enable routing for a selected default gateway configuration.
- Run Get-VBRDefaultGatewayConfiguration to get all default gateway configurations. Save them to $c variable.
- Run Set-VBRDefaultGatewayConfiguration to enable routing.
$c = Get-VBRDefaultGatewayConfiguration Set-VBRDefaultGatewayConfiguration -Configuration $c -EnableRouting |
Related Commands
