Remove-NetVirtualizationProviderRoute
Remove-NetVirtualizationProviderRoute
Removes physical network routes for a virtualized network.
Syntax
Parameter Set: ByName
Remove-NetVirtualizationProviderRoute [-AsJob] [-CimSession <CimSession[]> ] [-DestinationPrefix <String[]> ] [-InterfaceIndex <UInt32[]> ] [-Metric <UInt32[]> ] [-NextHop <String[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: InputObject (cdxml)
Remove-NetVirtualizationProviderRoute -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Detailed Description
The Remove-NetVirtualizationProviderRoute cmdlet removes physical network routes for 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. 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 (https://technet.microsoft.com/library/jj134174.aspx) 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.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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.
Aliases |
Session |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-DestinationPrefix<String[]>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<CimInstance[]>
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-InterfaceIndex<UInt32[]>
Specifies an array of indexes for network interfaces that have Network Virtualization enabled.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Metric<UInt32[]>
Specifies an array of integer values. Network Virtualization selects the route with the lowest metric value from a group of usable routes.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-NextHop<String[]>
Specifies an array of IP addresses for next hop gateways.
Aliases |
none |
Required? |
false |
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.
Aliases |
none |
Required? |
false |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<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: Remove all Provider Routes
This command removes all the Provider Routes for a host.
PS C:\> Remove-NetVirtualizationProviderRoute
Example 2: Remove Provider Routes for a specified interface
This command removes Provider Routes for an interface that has an index of 12.
PS C:\> Remove-NetVirtualizationProviderRoute -InterfaceIndex 12
Example 3: Remove Provider Routes
This command removes a Provider Route for the specified interface, for all network addresses that has the specified next hop value.
PS C:\> Remove-NetVirtualizationProviderRoute -DestinationPrefix "0.0.0.0/0" -NextHop "10.1.1.1" -InterfaceIndex 22
Related topics
Get-NetVirtualizationProviderRoute