Add-VpnConnectionRoute

NAME Add-VpnConnectionRoute



SYNOPSIS

Adds a route to a VPN connection.





SYNTAX

Add-VpnConnectionRoute [-ConnectionName] <String> [-DestinationPrefix] <String> [[-RouteMetric] <UInt32>] [[-AllUserConnection]] [-CimSession

<CimSession[]>] [-PassThru] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-AllUserConnection [<SwitchParameter>]

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



Required? false

Position? 5

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-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.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-ConnectionName <String>

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



Required? true

Position? 2

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DestinationPrefix <String>

Specifies the destination prefix of the route to add.



Required? true

Position? 3

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-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.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-RouteMetric [<UInt32>]

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



Required? false

Position? 4

Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-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 PowerShell???? 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.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

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



Required? false

Position? named

Default value false

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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.



Required? false

Position? named

Default value false

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS









OUTPUTS

Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetRoute







Example 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.





Example 2: Add a VPN connection for an IPv6 address



PS C:\\> Add-VpnConnectionRoute -ConnectionName "Contoso" -DestinationPrefix "2001:4898:7020:/64" -RouteMetric 23 -PassThru

DestinationPrefix : 2001:4898:7020:/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.







RELATED LINKS

Remove-VpnConnectionRoute