< Back
New-NetVirtualizationCustomerRoute
Post
NAME New-NetVirtualizationCustomerRoute
SYNOPSIS
Creates a virtual network route.
SYNTAX
New-NetVirtualizationCustomerRoute [-CimSession <CimSession[]>] [-Metric <UInt32>] [-ThrottleLimit <Int32>]
-DestinationPrefix <String> -NextHop <String> -RoutingDomainID <String> -VirtualSubnetID <UInt32>
[<CommonParameters>]
DESCRIPTION
The New-NetVirtualizationCustomerRoute cmdlet creates a virtual network route in 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 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 destination 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 select a preferred route from several
possible routes. You can use the Set-NetVirtualizationCustomerRoute cmdlet to set or change this value later.
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 a destination network. You can use 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
-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
-RoutingDomainID <String>
Specifies the ID for a routing domain. A routing domain allows for routing among its multiple virtual subnets.
Routing domains use a GUID style ID: {11111111-2222-3333-4444-000000000000}.
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
-VirtualSubnetID <UInt32>
Specifies the ID for a virtual subnet. The acceptable values for this parameter are: integers from 4096
through 16777214.
Required? true
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 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.
RELATED LINKS
Get-NetVirtualizationCustomerRoute
Remove-NetVirtualizationCustomerRoute
Set-NetVirtualizationCustomerRoute
SYNOPSIS
Creates a virtual network route.
SYNTAX
New-NetVirtualizationCustomerRoute [-CimSession <CimSession[]>] [-Metric <UInt32>] [-ThrottleLimit <Int32>]
-DestinationPrefix <String> -NextHop <String> -RoutingDomainID <String> -VirtualSubnetID <UInt32>
[<CommonParameters>]
DESCRIPTION
The New-NetVirtualizationCustomerRoute cmdlet creates a virtual network route in 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 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 destination 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 select a preferred route from several
possible routes. You can use the Set-NetVirtualizationCustomerRoute cmdlet to set or change this value later.
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 a destination network. You can use 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
-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
-RoutingDomainID <String>
Specifies the ID for a routing domain. A routing domain allows for routing among its multiple virtual subnets.
Routing domains use a GUID style ID: {11111111-2222-3333-4444-000000000000}.
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
-VirtualSubnetID <UInt32>
Specifies the ID for a virtual subnet. The acceptable values for this parameter are: integers from 4096
through 16777214.
Required? true
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 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.
RELATED LINKS
Get-NetVirtualizationCustomerRoute
Remove-NetVirtualizationCustomerRoute
Set-NetVirtualizationCustomerRoute