Networking / Security · Risk: High · Documentation Verified
Last verified: 2026-10-26
Microsoft NetTCPIP reference: Creates a route in the IP routing table. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.
Use an account with the target resource permissions documented for New-NetRoute. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.
Supported environments
Windows / NetTCPIP · Windows Server 2025 documentation; feature/module prerequisites apply
Parameters
-AddressFamily
Specifies the IP address family. The cmdlet uses the family that you specify for the IP route. The acceptable values for this parameter are: - IPv4 - IPv6 If you do not specify this parameter, the cmdlet selects a value based on the other input that you provide.
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
-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.
-Confirm
Prompts you for confirmation before running the cmdlet.
-DestinationPrefix (required)
Specifies a destination prefix of an IP route. A destination prefix consists of 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. The prefix length of the local host must match the prefix specified in this parameter, with all remaining address fields set to zero.
-InterfaceAlias (required)
Specifies the alias of a network interface. The cmdlet adds a route for the interface that has the alias that you specify.
-InterfaceIndex (required)
Specifies the index of a network interface. The cmdlet adds a route for the interface located at the index that you specify.
-NextHop
Specifies the next hop for the IP route. The cmdlet assigns the next hop that you specify to the IP route. A value of 0.0.0.0 for IPv4 or :: for IPv6 indicates that the route is on the local subnet.
-PolicyStore
Specifies the PolicyStore value. The cmdlet assigns the PolicyStore value that you specify to the IP route. The acceptable values for this parameter are: - ActiveStore. Current routing information, used by the OS. When a computer reboots, information in this store is lost. - PersistentStore. Cannot be used. Routing information in this store preserved across reboots. When a computer starts, it copies the saved settings from this store to the ActiveStore. By default, a route is saved in both stores. Use this parameter only when you need to create a route in just the ActiveStore.
-PreferredLifetime
Specifies a preferred lifetime, as a TimeSpan object, of an IP route. The cmdlet assigns the lifetime that you specify to the IP route. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. For more information, type Get-Help New-TimeSpan. The default value for a lifetime is infinite.
-Protocol
Specifies the type of routing protocol. The cmdlet assigns the protocol that you specify to the IP route. 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 The default value is NetMgmt.
-Publish
Specifies the publish setting of an IP route. The cmdlet assigns the publish setting that you specify to the IP route. 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 with an infinite valid lifetime in router advertisements. - Age. Publish and advertise IP route information with a finite valid lifetime in router advertisements. Specify a valid lifetime by using the *ValidLifetime* parameter. The default value is No.
-RouteMetric
Specifies an integer route metric for an IP route. The cmdlet assigns the metric that you specify to the IP route. The default value is 256. To choose among multiple routes, the computer adds this value. The computer selects the route with the lowest combined value. To modify the interface metric, use the Set-NetIPInterface cmdlet.
-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.
-ValidLifetime
Specifies a valid lifetime, as a TimeSpan object, for an IP route. The cmdlet assigns the lifetime setting that you specify to the IP route. To obtain a TimeSpan object, use the New-TimeSpan cmdlet. The default value is infinite.
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Prerequisites
Windows with the NetTCPIP module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.
Security considerations
This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.
This example adds a routing table entry, and then displays the properties of all the entries in the routing table. The first command creates a route for the destination prefix 10.0.0.0/24 for the interface that has the index of 12. The command specifies 192.168.0.1 as the next hop. The second command uses the Get-NetRoute cmdlet to get all the routes for the computer, and then passes them to the Format-List cmdlet by using the pipeline operator. The Format-List cmdlet can display all the properties of an object. For more information, type Get-Help Format-List. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.