PowerShell Logo Small


This is the built-in help made by Microsoft for the command 'Get-NetVirtualizationCustomerRoute', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.


Gets virtual network routes.


Get-NetVirtualizationCustomerRoute [-AsJob] [-CimSession <CimSession[]>] [-DestinationPrefix <String[]>] [-Metric <UInt32[]>] [-NextHop <String[]>] [-RoutingDomainID
<String[]>] [-ThrottleLimit <Int32>] [-VirtualSubnetID <UInt32[]>] [<CommonParameters>]

Search powershellhelp.space


The Get-NetVirtualizationCustomerRoute cmdlet gets virtual network routes in a Microsoft® Hyper-V® Server 2012 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 a virtual
network. This command gets Customer Routes that Network Virtualization use to manage traffic on a virtual network. For more information, see Network Virtualization technical
details (http://technet.microsoft.com/library/jj134174.aspx) on TechNet.

You can use any combination of the following values to specify which routes to get:

-- Destination prefix. A range of IP addresses as an IP prefix.
-- Next hop. A next hop gateway for the specified destionation addresses.
-- Routing domain ID. An ID for a virtual network that can include multiple virtual subnets.
-- Virtual subnet ID. An ID for a virtual subnet.
-- Route metric. A value that routing uses to select from possible routes.



Online Version: http://go.microsoft.com/fwlink/?LinkId=289174




Example 1: Get a Customer Route

PS C:\>Get-NetVirtualizationCustomerRoute -DestinationPrefix ""

This command gets a Customer Route that has the specified destination prefix.