New-NetVirtualizationCustomerRoute

New-NetVirtualizationCustomerRoute

Creates a virtual network route.

Syntax

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

Detailed Description

The New-NetVirtualizationCustomerRoute cmdlet creates a virtual network route in 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 Customer Routes to manage network traffic on a virtual network. For more information, see Network Virtualization technical details (https://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 destionation 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 choose a preferred route from several possible routes. You can use the Set-NetVirtualizationCustomerRoute cmdlet to set or change this value later.

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 a destination network. You can use a IPv4 or IPv6 address. Use prefix notation: 0.0.0.0/0.

-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.

-RoutingDomainID<String>

Specifies the ID for a routing domain. A routing domain allows routing among its multiple virtual subnets. Routing domains use a GUID style ID: {11111111-2222-3333-4444-000000000000}.

-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.

-VirtualSubnetID<UInt32>

Specifies the ID for a virtual subnet. The acceptable values for this parameter are:integers from 4096 through 16777214.

<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 Customer Route

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.

PS C:\> New-NetVirtualizationCustomerRoute -DestinationPrefix "172.16.0.0/16" -NextHop "172.16.0.1" -RoutingDomainID "{11111111-2222-3333-4444-000000000000}" -VirtualSubnetID 8392

Related topics

Get-NetVirtualizationCustomerRoute

Remove-NetVirtualizationCustomerRoute

Set-NetVirtualizationCustomerRoute