Remove-NetVirtualizationCustomerRoute

Remove-NetVirtualizationCustomerRoute

Removes virtual network routes.

Syntax

Parameter Set: ByName
Remove-NetVirtualizationCustomerRoute [-AsJob] [-CimSession <CimSession[]> ] [-DestinationPrefix <String[]> ] [-Metric <UInt32[]> ] [-NextHop <String[]> ] [-PassThru] [-RoutingDomainID <String[]> ] [-ThrottleLimit <Int32> ] [-VirtualSubnetID <UInt32[]> ] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Remove-NetVirtualizationCustomerRoute -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Remove-NetVirtualizationCustomerRoute cmdlet removes virtual network routes 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. This cmdlet deletes Customer Routes that Network Virtualization uses on a virtual network. For more information, see Network Virtualization technical details (https://technet.microsoft.com/library/jj134174.aspx) 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 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.
-- Route metric. A value that routing uses to select from possible routes.

To manage virtual network routes, you can use the Set-NetVirtualizationCustomerRoute 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.

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 array of IP prefixes, as strings, for destination networks. You can specify IPv4 and IPv6 addresses. Use prefix notation: 0.0.0.0/0.

-InputObject<CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

-Metric<UInt32[]>

Specifies an array of integer values for the metrics of routes.

-NextHop<String[]>

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

-PassThru

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

-RoutingDomainID<String[]>

Specifies an array of IDs for routing domains. 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 an array of IDs for virtual subnets. 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: Remove a Customer Route

This command removes a Customer Route that has the specified destination prefix.

PS C:\> Remove-NetVirtualizationCustomerRoute -DestinationPrefix "172.16.0.0/16" 

Example 2: Remove Customer Routes for a gateway

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 Remove-NetVirtualizationCustomerRoute cmdlet, which removes them.

PS C:\> Get-NetVirtualizationCustomerRoute -NextHop "172.16.0.1" | Remove-NetVirtualizationCustomerRoute  

Related topics

Get-NetVirtualizationCustomerRoute

New-NetVirtualizationCustomerRoute

Set-NetVirtualizationCustomerRoute