Remove-Net Virtualization Provider Route

Module:
netwnv
Removes physical network routes for a virtualized network.

Syntax 

Remove-NetVirtualizationProviderRoute
      [-InterfaceIndex <UInt32[]>]
      [-DestinationPrefix <String[]>]
      [-NextHop <String[]>]
      [-Metric <UInt32[]>]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-PassThru]
      [<CommonParameters>]
Remove-NetVirtualizationProviderRoute
      -InputObject <CimInstance[]>
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-PassThru]
      [<CommonParameters>]

Description

The Remove-NetVirtualizationProviderRoute cmdlet removes physical network routes 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. This cmdlet removes Provider Routes that Network Virtualization uses to direct network traffic on the physical network. For more information, see Network Virtualization technical details on TechNet.

You can use the Get-NetVirtualizationProviderRoute cmdlet to get routes to delete, or you can specify Provider Routes by using any combination of the following:

  • Destination
  • Interface
  • Metric
  • Next hop gateway

Examples

Example 1: Remove all Provider Routes 

PS C:\> Remove-NetVirtualizationProviderRoute

This command removes all the Provider Routes for a Hyper-V Server 2016 host.

Example 2: Remove Provider Routes for a specified interface 

PS C:\>Remove-NetVirtualizationProviderRoute -InterfaceIndex 12

This command removes Provider Routes for an interface that has an index of 12.

Example 3: Remove Provider Routes 

PS C:\>Remove-NetVirtualizationProviderRoute -DestinationPrefix "0.0.0.0/0" -NextHop "10.1.1.1" -InterfaceIndex 22

This command removes a Provider Route for the specified interface for all network addresses that has the specified next hop value.

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

Specifies an array of indexes for network interfaces that have Hyper-V Server 2016 Network Virtualization enabled.

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

Specifies an array of integer values. Network Virtualization selects the route that has the lowest metric value from a group of usable routes.

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.

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