New-NetVirtualizationCustomerRoute
Creates a virtual network route.
Syntax
New-NetVirtualizationCustomerRoute
-RoutingDomainID <String>
-VirtualSubnetID <UInt32>
-DestinationPrefix <String>
-NextHop <String>
[-Metric <UInt32>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<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 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.
Examples
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 8392This command creates a Customer Route. The command specifies a destination prefix, a next hop gateway, a routing domain ID, and a virtual subnet ID.
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 |
| Required: | False |
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DestinationPrefix
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 |
| Required: | False |
| 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 |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RoutingDomainID
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}.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VirtualSubnetID
Specifies the ID for a virtual subnet. The acceptable values for this parameter are: integers from 4096 through 16777214.
| Type: | UInt32 |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |