Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Find-NetRoute

Find-NetRoute

msft_netroute.cdxml

Synopsis

Finds the best local IP address and the best route to reach a remote address.

Syntax

Find-NetRoute [-AsJob] [-CimSession] [-InterfaceIndex] [-LocalIPAddress] [-ThrottleLimit] [-RemoteIPAddress] [<CommonParameters>]

Detailed Description

The Find-NetRoute cmdlet finds the best local IP address and the best route to reach a remote address. Specify the remote address to reach. You can also specify an interface and a local address to use to reach the remote address.

For more information about routing, see Chapter 5 - IP Routing (http://technet.microsoft.com/library/bb727001.aspx) in the TechNet library.

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

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.

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InterfaceIndex <UInt32>

Specifies an index of a network interface. The cmdlet finds a route for this interface.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-LocalIPAddress <String>

Specifies a local IP address from which to find a route. You can specify a host address or a subnet address. You can also use a wildcard address, such as 0.0.0.0/0 for all IPv4 addresses, ::/0 for all IPv6 addresses, or ANY for all addresses.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-RemoteIPAddress <String>

Specifies a remote IP address to which to find a route. You can specify a host address or a subnet address. You can also use a wildcard address, such as 0.0.0.0/0 for all IPv4 addresses, ::/0 for all IPv6 addresses, or ANY for all addresses

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

None

Return Type

NetIPAddress, NetRoute

Notes

None

Examples

Example 1: Find a local address and route

This command finds a NetIPAddress object and NetRoute object to use to access the IP address 10.79.197.200. The command returns two objects. The first object is the local IP address. The second object is the local route that includes the selected connectivity path and next hop.

PS C:\>Find-NetRoute -RemoteIPAddress "10.79.197.200"
IPAddress         : 172.31.234.140
InterfaceIndex    : 3
InterfaceAlias    : Ethernet
AddressFamily     : IPv4
Type              : Unicast
PrefixLength      : 21
PrefixOrigin      : Dhcp
SuffixOrigin      : Dhcp
AddressState      : Preferred
ValidLifetime     : 6.00:10:40
PreferredLifetime : 6.00:10:40
SkipAsSource      : False
PolicyStore       : ActiveStore


Caption            : 
Description        : 
ElementName        : 
InstanceID         : :8:8:8:9:55=55;A<8=;8<=<8;55; 
AdminDistance      : 
DestinationAddress :
IsStatic           : 
RouteMetric        : 0
TypeOfRoute        : 3
AddressFamily      : IPv4
DestinationPrefix  : 0.0.0.0/0
InterfaceAlias     : Ethernet
InterfaceIndex     : 3
NextHop            : 172.31.232.1
PreferredLifetime  : 8.00:00:00
Protocol           : NetMgmt
Publish            : No
Store              : ActiveStore
ValidLifetime      : 8.00:00:00
PSComputerName     : 
ifIndex            : 3

Online Version
Get-NetRoute
New-NetRoute
Remove-NetRoute
Set-NetRoute