Remove-NetVirtualizationCustomerRoute
Removes virtual network routes.
Syntax
Remove-NetVirtualizationCustomerRoute
[-RoutingDomainID <String[]>]
[-VirtualSubnetID <UInt32[]>]
[-DestinationPrefix <String[]>]
[-NextHop <String[]>]
[-Metric <UInt32[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[<CommonParameters>] Remove-NetVirtualizationCustomerRoute
-InputObject <CimInstance[]>
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[<CommonParameters>] Description
The Remove-NetVirtualizationCustomerRoute cmdlet removes virtual network 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 the virtual network. This cmdlet deletes Customer Routes that Network Virtualization uses on a virtual network. For more information, see Network Virtualization technical details on TechNet.
You can use the Get-NetVirtualizationCustomerRoute cmdlet to get routes to remove, or you can use any combination of the following values to specify which routes to remove:
- 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.
- Route metric. A value that routing uses to select from possible routes.
To manage virtual network routes, you can use the Set-NetVirtualizationCustomerRoute cmdlet to modify the metric value, but you cannot change any of the other values in a route. You can remove routes, and then use the New-NetVirtualizationCustomerRoute cmdlet to replace them.
Examples
Example 1: Remove a Customer Route
PS C:\>Remove-NetVirtualizationCustomerRoute -DestinationPrefix "172.16.0.0/16"This command removes a Customer Route that has the specified destination prefix.
Example 2: Remove Customer Routes for a gateway
PS C:\>Get-NetVirtualizationCustomerRoute -NextHop "172.16.0.1" | Remove-NetVirtualizationCustomerRouteThis 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 pipeline operator to the Remove-NetVirtualizationCustomerRoute cmdlet, which removes them.
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 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specifies the input object that is used in a pipeline command.
| Type: | CimInstance[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Metric
Specifies an array of integer values for the metrics of routes.
| Type: | UInt32[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
| Required: | False |
| 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 |
| Required: | False |
| 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 |
| Required: | False |
| 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 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |