Skip to content
PowerShell Commands

Add-VpnConnectionRoute

Add-VpnConnectionRoute [-ConnectionName*] <String> [-DestinationPrefix*] <String> [[-RouteMetric] <UInt32>][[-AllUserConnection]] [-CimSession <CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf][<CommonParameters>]

The Add-VpnConnectionRoute cmdlet adds an IPv4 or IPv6 route to a specified VPN connection.

Parameters

-AllUserConnection [<SwitchParameter>]

  • Accepts pipeline input ByPropertyName

Indicates that the VPN connection being modified is in the global phone book.

-CimSession [<CimSession[]>]

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

-ConnectionName <String>

  • This value is required
  • Accepts pipeline input ByPropertyName

Specifies the name of a VPN connection profile. To view existing VPN connection profiles, use the Get-VpnConnection cmdlet.

-DestinationPrefix <String>

  • This value is required
  • Accepts pipeline input ByPropertyName

Specifies the destination prefix of the route to add.

-PassThru [<SwitchParameter>]

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output. If you specify this parameter, the cmdlet returns the MSFT_NetRoute object.

-RouteMetric [<UInt32>]

  • Accepts pipeline input ByPropertyName

Specifies the metric of the route being added to the VPN connection.

-ThrottleLimit [<Int32>]

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShellr calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

-Confirm [<SwitchParameter>]

  • Default value is false

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

-WhatIf [<SwitchParameter>]

  • Default value is false

Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Outputs
Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetRoute
Examples
  1. Add a VPN connection route for an IPv4 address: 
    PS C:\>  Add-VpnConnectionRoute -ConnectionName "Contoso" -DestinationPrefix "176.16.0.0/16" -PassThru
DestinationPrefix : 176.16.0.0/16

   InterfaceIndex    :
   InterfaceAlias    : Contoso
   AddressFamily     : IPv4
   NextHop           : 0.0.0.0
   Publish           : 0
   RouteMetric       : 1
   PolicyStore       :

    This command uses the Add-VpnConnectionRoute cmdlet to add a connection route for the connection named Contoso. The command specifies an IPv4 address for the DestinationPrefix parameter.

  2. Add a VPN connection for an IPv6 address: 
    PS C:\>  Add-VpnConnectionRoute -ConnectionName "Contoso" -DestinationPrefix "2001:4898:7020:3020::/64" -RouteMetric 23 -PassThru
DestinationPrefix : 2001:4898:7020:3020::/64

   InterfaceIndex    :
   InterfaceAlias    : Contoso
   AddressFamily     : IPv6
   NextHop           : ::
   Publish           : 0
   RouteMetric       : 23
   PolicyStore       :

    This command uses the Add-VpnConnectionRoute cmdlet to add a connection route for the connection named Contoso. The command specifies an IPv6 address for the DestinationPrefix parameter.

This work is licensed under a Creative Commons Attribution 4.0 International. It is attributed to Microsoft Corporation and can be found here.

PowerShell Commands