Set-Net Virtualization Customer Route

Module:
netwnv
Changes the metric value for virtual routes.

Syntax 

Set-NetVirtualizationCustomerRoute
   [-RoutingDomainID <String[]>]
   [-VirtualSubnetID <UInt32[]>]
   [-DestinationPrefix <String[]>]
   [-NextHop <String[]>]
   [-Metric <UInt32>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [<CommonParameters>]
Set-NetVirtualizationCustomerRoute
   -InputObject <CimInstance[]>
   [-Metric <UInt32>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [<CommonParameters>]

Description

The Set-NetVirtualizationCustomerRoute cmdlet changes the metric value for virtual routes 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 a virtual network. Network Virtualization uses the metric to select a preferred route from several possible routes. For more information, see Network Virtualization technical details on TechNet.

You can use the Get-NetVirtualizationCustomerRoute cmdlet to get routes to modify, or you can use any combination of the following values to specify which routes to modify:

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

Examples

Example 1: Change a metric value 

PS C:\>Set-NetVirtualizationCustomerRoute -DestinationPrefix "172.16.0.0/16" -Metric 3

This command changes the metric value to 3 for a Customer Route that has the specified destination prefix.

Example 2: Change a metric value for mulitple Customer Routes 

PS C:\>Get-NetVirtualizationCustomerRoute -NextHop "172.16.0.1" | Set-NetVirtualizationCustomerRoute -Metric 3

This command uses the Get-NetVirtualizationCustomerRoute to get all the Customer Routes that have a next hop gateway of 172.16.0.1. The command passes them by using the pipe operator to the Set-NetVirtualizationCustomerRoute cmdlet, which changes the metric value to 3 for those Customer Routes.

Required Parameters

-InputObject

Specifies the input object that is used in a pipeline command.

Type: CimInstance[]
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

Optional 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
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
Accept pipeline input: False
Accept wildcard characters: False
-DestinationPrefix

Specifies an array of IP prefixes, as strings, for destination networks. You can specify IPv4 and IPv6 addresses. Use prefix notation: 0.0.0.0/0 .

Type: String[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Metric

Specifies a new value for the metric of a route.

Type: UInt32
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-NextHop

Specifies an array of IP addresses for next hop gateways for routes.

Type: String[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-RoutingDomainID

Specifies an array of IDs for routing domains. Routing domains use a GUID style ID: {11111111-2222-3333-4444-000000000000} .

Type: String[]
Position: Named
Default value: None
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
Accept pipeline input: False
Accept wildcard characters: False
-VirtualSubnetID

Specifies an array of IDs for virtual subnets. The acceptable values for this parameter are: integers from 4096 through 16777214.

Type: UInt32[]
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False