Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Remove-NetRoute

Remove-NetRoute

msft_netroute.cdxml

Synopsis

Removes IP routes from the IP routing table.

Syntax

Remove-NetRoute [-DestinationPrefix] [-AddressFamily] [-AsJob] [-AssociatedIPInterface] [-CimSession] [-IncludeAllCompartments] [-InterfaceAlias] [-InterfaceIndex] [-NextHop] [-PassThru] [-PolicyStore] [-PreferredLifetime] [-Protocol] [-Publish] [-RouteMetric] [-ThrottleLimit] [-ValidLifetime] [-Confirm] [-WhatIf] [<CommonParameters>]

Remove-NetRoute [-AsJob] [-CimSession] [-PassThru] [-ThrottleLimit] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Remove-NetRoute cmdlet removes IP routes from the IP routing table. Run this cmdlet without any parameters to remove all IP routes from the routing table, including default routes. You can also specify routes to remove by specifying parameters, or by using the Get-NetRoute cmdlet.

For more information about routing, see Chapter 5 - IP Routing (http://technet.microsoft.com/library/bb727001.aspx) in the TechNet library.

Parameters

-AddressFamily <AddressFamily[]>

Specifies an array of IP address families of IP routes. The cmdlet removes IP routes that belong to the families that you specify. The acceptable values for this parameter are:  -- IPv4 -- IPv6

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-AssociatedIPInterface <CimInstance>

Specifies an IP interface as a CIM object. The cmdlet removes IP routes that belong to the interfaces that you specify. To obtain an IP interface, use the Get-NetIPInterface cmdlet.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByValue)

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 destination prefixes of IP routes. The cmdlet removes IP routes that use the prefixes that you specify. A destination prefix contains an IP address prefix and a prefix length, separated by a slash (/). A value of 0.0.0.0/0 for IPv4 or ::/0 for IPv6 indicates that the value of the NextHop parameter is a default gateway.

Aliases

None

Required?

false

Position

1

Default value

dhcp

Accept pipeline input?

false

Accept wildcard characters?

false

-IncludeAllCompartments <SwitchParameter>

Indicates that the cmdlet includes routes from all configured network compartments. If you do not specify this parameter, the cmdlet removes only routes in the default network compartment.

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

-InterfaceAlias <String[]>

Specifies an array of aliases of network interfaces. The cmdlet removes IP routes for the interfaces that have the aliases that you specify.

Aliases

ifAlias

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-InterfaceIndex <UInt32[]>

Specifies an array of indexes of network interfaces. The cmdlet removes IP routes for the interfaces located at the indexes that you specify.

Aliases

ifIndex

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-NextHop <String[]>

Specifies an array of next hop values. The cmdlet removes routes that have the next hop values that you specify. A value of 0.0.0.0 for IPv4 or :: for IPv6 indicates that the route is on the local subnet.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

-PolicyStore <String>

Specifies a PolicyStore value. The cmdlet removes IP routes that have the PolicyStore value that you specify. The acceptable values for this parameter are:  -- ActiveStore. The IP address information is valid. -- PersistentStore. The computer saves IP address information across restarts. When the computer restarts, it copies the saved settings to the ActiveStore.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PreferredLifetime <TimeSpan[]>

Specifies an array of values for preferred lifetime, as TimeSpan objects, of IP routes. The cmdlet removes IP routes that have the lifetimes that you specify. To obtain a TimeSpan object, use the New-Timespan cmdlet. For more information, type Get-Help New-TimeSpan.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Protocol <Protocol[]>

Specifies an array of types of routing protocols. The cmdlet removes IP routes that use the protocols that you specify. The acceptable values for this parameter are:  -- Bbn -- Bgp -- Dhcp -- Dvmrp -- Egp -- Eigrp -- EsIs -- Ggp -- Hello -- Icmp -- Idpr -- Igrp -- IsIs -- Local -- NetMgmt -- Ospf -- Rip -- Rpl -- Other

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Publish <Publish[]>

Specifies an array of publish settings of IP routes. The cmdlet removes IP routes that have the publish settings that you specify. The acceptable values for this parameter are:  -- No. Do not publish or advertise IP route information in router advertisements. -- Yes. Publish and advertise IP route information that includes an infinite valid lifetime in router advertisements -- Age. Publish and advertise IP route information with a finite valid lifetime in router advertisements.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-RouteMetric <UInt16[]>

Specifies an array of integer route metrics for IP routes. The cmdlet removes IP routes that have the metrics that you specify. To choose among multiple routes, the computer adds this value to the interface metric value. The computer selects the route with the lowest combined value. To modify the interface metric, use the Set-NetIPInterface cmdlet.

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

-ValidLifetime <TimeSpan[]>

Specifies an array of values for valid lifetime, as a TimeSpan object, for IP routes. The cmdlet removes IP routes that have the lifetime that you specify. To obtain a TimeSpan object, use the New-Timespan cmdlet.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.Management.Infrastructure.CimInstance#rootStandardCimv2MSFT_NetRoute

Return Type

None

Notes

None

Examples

Example 1: Remove all routes

This command removes all of the IP routes on the computer, including default routes.

PS C:\>Remove-NetRoute

Example 2: Remove routes for a specified next hop

This command removes all of the IP routes that have a next hop of 192.168.0.1.

PS C:\>Remove-NetRoute –NextHop "192.168.0.1"

Online Version
Find-NetRoute
Get-NetRoute
New-NetRoute
Set-NetRoute
Get-NetIPInterface