Set-VBRDefaultGatewayConfiguration

In this article

    Short Description

    Modifies default gateways 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. 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

    Configuration

    Specifies the default gateway configuration that you want to modify.

    Accepts VBRDefaultGatewayConfiguration type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    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.

    1. Run Get-VBRDefaultGatewayConfiguration to get all default gateway configurations. Save them to $c variable.
    2. Run Set-VBRDefaultGatewayConfiguration to enable routing.

    $c = Get-VBRDefaultGatewayConfiguration

    Set-VBRDefaultGatewayConfiguration -Configuration $c -EnableRouting

    Related Commands

    Get-VBRDefaultGatewayConfiguration