< Back
New-NetVirtualizationProviderRoute
Post
NAME New-NetVirtualizationProviderRoute
SYNOPSIS
Creates a Provider Route in a virtual network.
SYNTAX
New-NetVirtualizationProviderRoute [-CimSession <CimSession[]>] [-Metric <UInt32>] [-ThrottleLimit <Int32>]
-DestinationPrefix <String> -InterfaceIndex <UInt32> -NextHop <String> [<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 (http://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
-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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-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.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-InterfaceIndex <UInt32>
Specifies an index for the network interface that has Hyper-V Server 2016 Network Virtualization enabled.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Metric [<UInt32>]
Specifies an integer value for the route. Network Virtualization selects the route that has the lowest metric
value from a group of usable routes.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-NextHop <String>
Specifies an IP address for the next hop gateway for this route.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
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.
RELATED LINKS
Get-NetVirtualizationProviderRoute
Remove-NetVirtualizationProviderRoute
Set-NetVirtualizationProviderRoute
SYNOPSIS
Creates a Provider Route in a virtual network.
SYNTAX
New-NetVirtualizationProviderRoute [-CimSession <CimSession[]>] [-Metric <UInt32>] [-ThrottleLimit <Int32>]
-DestinationPrefix <String> -InterfaceIndex <UInt32> -NextHop <String> [<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 (http://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
-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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-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.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-InterfaceIndex <UInt32>
Specifies an index for the network interface that has Hyper-V Server 2016 Network Virtualization enabled.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Metric [<UInt32>]
Specifies an integer value for the route. Network Virtualization selects the route that has the lowest metric
value from a group of usable routes.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-NextHop <String>
Specifies an IP address for the next hop gateway for this route.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
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.
RELATED LINKS
Get-NetVirtualizationProviderRoute
Remove-NetVirtualizationProviderRoute
Set-NetVirtualizationProviderRoute