This is the built-in help made by Microsoft for the command 'New-NetVirtualizationCustomerRoute', in PowerShell version 3 - as retrieved from
Windows version 'Microsoft Windows Server 2012 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.
Creates a virtual network route.
New-NetVirtualizationCustomerRoute [-AsJob [<SwitchParameter>]] [-CimSession <CimSession[]>] [-Metric <UInt32>] [-ThrottleLimit <Int32>]
-DestinationPrefix <String> -NextHop <String> -RoutingDomainID <String> -VirtualSubnetID <UInt32> [<CommonParameters>]
The New-NetVirtualizationCustomerRoute cmdlet creates a virtual network route 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 the virtual network. Network Virtualization uses Customer Routes to manage network
traffic on a virtual network. For more information, see Network Virtualization technical details
(http://technet.microsoft.com/library/jj134174.aspx) on TechNet.
To create a virtual network route, specify the following values:
-- 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.
You can also specify a metric rank. Network Virtualization uses this rank to choose a preferred route from several possible routes. You can
use the Set-NetVirtualizationCustomerRoute cmdlet to set or change this value later.
<
Get-NetVirtualizationCustomerRoute
Remove-NetVirtualizationCustomerRoute
Set-NetVirtualizationCustomerRoute
<
Example 1: Create a Customer Route
PS C:\>New-NetVirtualizationCustomerRoute -DestinationPrefix "172.16.0.0/16" -NextHop "172.16.0.1" -RoutingDomainID
"{11111111-2222-3333-4444-000000000000}" -VirtualSubnetID 8392
This command creates a Customer Route. The command specifies a destination prefix, a next hop gateway, a routing domain ID, and a virtual
subnet ID.