Set-VBRDefaultGatewayConfiguration

Short Description

Modifies default gateway configuration.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Set-VBRDefaultGatewayConfiguration -Configuration <VBRDefaultGatewayConfiguration> [-EnableRouting] [-PassThru]  [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of the default gateway.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Configuration

Specifies the default gateway configuration that you want to modify.

Accepts the VBRDefaultGatewayConfiguration object. To get this object, run the Get-VBRDefaultGatewayConfiguration cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

EnableRouting

Enables routing option for the gateway.

SwitchParameter

False

Named

False

PassThru

Defines that the command returns the output object to the Windows PowerShell console.

SwitchParameter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

VBRDefaultGatewayConfiguration[]

Examples

Enabling Routing for Selected Default Gateway Configuration

This example shows how to enable routing for a selected default gateway configuration.

$c = Get-VBRDefaultGatewayConfiguration

Set-VBRDefaultGatewayConfiguration -Configuration $c -EnableRouting

Perform the following steps:

  1. Run the Get-VBRDefaultGatewayConfiguration cmdlet. Save the result to $c variable.
  2. Run the Set-VBRDefaultGatewayConfiguration cmdlet. Set the $c variable as the Configuration parameter value. Provide the EnableRouting parameter.

Related Commands

Get-VBRDefaultGatewayConfiguration

Page updated 4/24/2024

Page content applies to build 12.1.1.56