Windows PowerShell command on Get-command Remove-NetRoute

NAME

Remove-NetRoute

SYNOPSIS

Removes IP routes from the IP routing table.

SYNTAX

Remove-NetRoute [[-DestinationPrefix] ] [-AddressFamily ] [-AssociatedIPInterface

] [-CimSession ] [-CompartmentId ] [-IncludeAllCompartments] [-InterfaceAlias

] [-InterfaceIndex ] [-InterfaceMetric ] [-NextHop ] [-PassThru]

[-PolicyStore ] [-PreferredLifetime ] [-Protocol ] [-Publish ]

[-RouteMetric ] [-State ] [-ThrottleLimit ] [-ValidLifetime ] [-Confirm]

[-WhatIf] []

Remove-NetRoute [-CimSession ] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf]

[]

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

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

Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-AssociatedIPInterface []

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.

Required? false Position? named Default value none Accept pipeline input? True (ByValue) 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. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-CompartmentId []

Specifies an array of identifiers for network compartments in the protocol stack. By default, the cmdlet only removes Net routes in the default compartment. If you specify a value, the cmdlet removes any matching Net routes in all compartments in this field. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-DestinationPrefix []

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. Required? false Position? 1 Default value none Accept pipeline input? false Accept wildcard characters? false

-IncludeAllCompartments []

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. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-InterfaceAlias []

Specifies an array of aliases of network interfaces. The cmdlet removes IP routes for the interfaces that have the aliases that you specify. Required? false Position? named Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-InterfaceIndex []

Specifies an array of indexes of network interfaces. The cmdlet removes IP routes for the interfaces located at the indexes that you specify. Required? false Position? named Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-InterfaceMetric []

Specifies an array of integer interface metrics for network interfaces. The cmdlet removes IP routes for the interfaces that have the metric that you specify. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-NextHop []

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. 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. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-PolicyStore []

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. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-PreferredLifetime []

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.

Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-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

Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

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

Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-RouteMetric []

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.

Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-State []

Specifies an array of state values for IP routes. The cmdlet gets entries that have the state values that you specify. The acceptable values for this parameter are:

-- Alive

-- Dead

-- Probe

Required? false 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 PowerShellr 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. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-ValidLifetime []

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.

Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-Confirm []

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. Required? false Position? named Default value false Accept pipeline input? false Accept wildcard characters? false

-WhatIf []

Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run. Required? false Position? named Default value false Accept pipeline input? false Accept wildcard characters? false This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

Microsoft.Management.Infrastructure.CimInstance#rootStandardCimv2MSFT_NetRoute The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

OUTPUTS

None

Example 1: Remove all routes

PS C:\>Remove-NetRoute

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

Example 2: Remove routes for a specified next hop

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

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