New-NetVirtualizationProviderRoute

Creates a Provider Route in a virtual network.

Syntax

New-NetVirtualizationProviderRoute
   [-AsJob]
   [-CimSession <CimSession[]>]
   -DestinationPrefix <String>
   -InterfaceIndex <UInt32>
   [-Metric <UInt32>]
   -NextHop <String>
   [-ThrottleLimit <Int32>]
   [<CommonParameters>]

Description

The New-NetVirtualizationProviderRoute cmdlet creates a network route for a Microsoft® Hyper-V® Server 2016 virtual network. Network Virtualization allows for more than one virtual network to exist on the same physical network. Computers can exchange network traffic with a virtual machine by using a Customer Address in the virtual network. Network Virtualization uses Provider Routes to direct network traffic on the physical network. For more information, see Network Virtualization technical details on TechNet.

To create a Provider Route, specify the subnet as an IP prefix, the interface, and the address for the next hop gateway.

Examples

Example 1: Create a Provider Route

PS C:\> New-NetVirtualizationProviderRoute -DestinationPrefix "0.0.0.0/0" -InterfaceIndex 23 -NextHop "192.168.1.1" -Metric 5

This command creates a Provider Route for all network addresses, as specified by the destination prefix 0.0.0.0/0, with a next hop gateway as specified. The command defines the interface as by using the index 23 and specifies a metric value of 5.

Example 2: Create a Provider Route for a subnet

PS C:\>New-NetVirtualizationProviderRoute -DestinationPrefix "10.1.2.0/24" -InterfaceIndex 13 -NextHop "10.1.2.23"

This command specifies a Provider Route for an interface with the index 13 for the subnet specified by using the destination prefix. This prefix specifies the subnet of addresses from 10.1.2.0 to 10.1.2.254. The command specifies the next hop gateway as 10.1.2.23.

Required Parameters

-DestinationPrefix

Specifies an IP prefix, as a string, for the destination network. You can specify an IPv4 or IPv6 address. Use prefix notation: 0.0.0.0/0.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InterfaceIndex

Specifies an index for the network interface that has Hyper-V Server 2016 Network Virtualization enabled.

Type:UInt32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-NextHop

Specifies an IP address for the next hop gateway for this route.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-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.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Metric

Specifies an integer value for the route. Network Virtualization selects the route that has the lowest metric value from a group of usable routes.

Type:UInt32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ThrottleLimit

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.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False