New-NetVirtualizationProviderRoute

New-NetVirtualizationProviderRoute

Creates a Provider Route in a virtual network.

Syntax

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

Detailed Description

The New-NetVirtualizationProviderRoute cmdlet creates a network route 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.

To create a Provider Route, specify the subnet as an IP prefix, the interface, and the address for the 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 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.

-InterfaceIndex<UInt32>

Specifies an index for the network interface that has Network Virtualization enabled.

-Metric<UInt32>

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

-NextHop<String>

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

-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: Create a Provider Route

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.

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

Example 2: Create a Provider Route for a subnet

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.

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

Related topics

Get-NetVirtualizationProviderRoute

Remove-NetVirtualizationProviderRoute

Set-NetVirtualizationProviderRoute