Get-NetVirtualizationProviderRoute

Get-NetVirtualizationProviderRoute

Gets physical network routes for a virtualized network.

Syntax

Parameter Set: ByName
Get-NetVirtualizationProviderRoute [-AsJob] [-CimSession <CimSession[]> ] [-DestinationPrefix <String[]> ] [-InterfaceIndex <UInt32[]> ] [-Metric <UInt32[]> ] [-NextHop <String[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-NetVirtualizationProviderRoute cmdlet gets physical network routes for a virtual network. Network Virtualization allows more than one virtual network to exist on the same physical network. Computers can exchange network traffic with a virtual machine (VM) by using a Customer Address within the virtual network. Network Virtualization uses Provider Routes to direct network traffic on the physical network. For more information, see Network Virtualization technical details (https://technet.microsoft.com/library/jj134174.aspx) on TechNet.

You can specify Provider Routes by using any combination of the following:

-- Destination.
-- Interface.
-- Metric.
-- Next hop gateway.

Parameters

-AsJob

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

-DestinationPrefix<String[]>

Specifies an array of IP prefixes, as strings, for destination networks. You can specify IPv4 and IPv6 addresses. Use prefix notation: 0.0.0.0/0.

-InterfaceIndex<UInt32[]>

Specifies an array of indexes for network interfaces that have Network Virtualization enabled.

-Metric<UInt32[]>

Specifies an array of integer values. Network Virtualization selects the route with the lowest metric value from a group of usable routes.

-NextHop<String[]>

Specifies an array of IP addresses for next hop gateways.

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

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Get provider routes for a specified interface

This command gets the provider routes for the interface that has the interface index 21.

PS C:\> Get-NetVirtualizationProviderRoute -InterfaceIndex 21

Example 2: Get provider routes for destination prefix

This command gets the provider routes that have the specified destination prefix.

PS C:\> Get-NetVirtualizationProviderRoute -DestinationPrefix "172.16.0.0/16"

Related topics

New-NetVirtualizationProviderRoute

Remove-NetVirtualizationProviderRoute

Set-NetVirtualizationProviderRoute