Win32_IP4PersistedRouteTable

The Win32_IP4PersistedRouteTable WMI class represents persisted IP routes. By default, the routes added to the routing table are not permanent. Rebooting the computer clears the routes from the tab...

The Win32_IP4PersistedRouteTable WMI class represents persisted IP routes. By default, the routes added to the routing table are not permanent. Rebooting the computer clears the routes from the table. However, the following command makes the route persist after the computer is restarted: route -p add. Persistent entries are automatically inserted again in the route table each time the route table is rebuilt. The operating system stores persistent routes in the registry. An entry can be removed through the method call SWbemServices.Delete for scripting or IWbemServices::DeleteInstance for C++ programming. This class is only applicable to IPv4 and does not return IPX or IPv6 data. For more information, see IPv6 and IPv4 Support in WMI.

Methods

Win32_IP4PersistedRouteTable has no methods.

Properties

Win32_IP4PersistedRouteTable returns 9 properties:

'Caption','Description','Destination','InstallDate','Mask','Metric1','Name','NextHop',
'Status'

Unless explicitly marked as writeable, all properties are read-only. Read all properties for all instances:

Get-CimInstance -ClassName Win32_IP4PersistedRouteTable -Property *

Most WMI classes return one or more instances.

When Get-CimInstance returns no result, then apparently no instances of class Win32_IP4PersistedRouteTable exist. This is normal behavior.

Either the class is not implemented on your system (may be deprecated or due to missing drivers, i.e. CIM_VideoControllerResolution), or there are simply no physical representations of this class currently available (i.e. Win32_TapeDrive).

Caption

STRING MAX 64 CHAR

Get-CimInstance -ClassName Win32_IP4PersistedRouteTable | Select-Object -Property Destination, Mask, Metric1, NextHop, Caption

Description

STRING

Get-CimInstance -ClassName Win32_IP4PersistedRouteTable | Select-Object -Property Destination, Mask, Metric1, NextHop, Description

Destination

KEY PROPERTY WRITEABLE STRING

Destination IP address for this persisted route.

Get-CimInstance -ClassName Win32_IP4PersistedRouteTable | Select-Object -Property Destination, Mask, Metric1, NextHop

InstallDate

DATETIME

Get-CimInstance -ClassName Win32_IP4PersistedRouteTable | Select-Object -Property Destination, Mask, Metric1, NextHop, InstallDate

Mask

KEY PROPERTY WRITEABLE STRING

Mask used in this persisted entry. Use the logical AND operation to combine the mask with the destination address. Compare the result to the value in the ipRouteDest field.

Get-CimInstance -ClassName Win32_IP4PersistedRouteTable | Select-Object -Property Destination, Mask, Metric1, NextHop

Metric1

KEY PROPERTY WRITEABLE SINT32

Primary routing metric for this persisted route. The semantics of this metric are determined by the routing protocol specified in the route’s ipRouteProto value. If this property is not used, its value should be set to -1.

Get-CimInstance -ClassName Win32_IP4PersistedRouteTable | Select-Object -Property Destination, Mask, Metric1, NextHop

Name

STRING

Get-CimInstance -ClassName Win32_IP4PersistedRouteTable | Select-Object -Property Destination, Mask, Metric1, NextHop, Name

NextHop

KEY PROPERTY WRITEABLE STRING

IP address of the next hop of this persisted route. If the route is bound to an interface that is realized via a broadcast medium, this field contains the agent’s IP address on that interface.

Get-CimInstance -ClassName Win32_IP4PersistedRouteTable | Select-Object -Property Destination, Mask, Metric1, NextHop

Status

STRING MAX 10 CHAR

Current status of an object. Various operational and nonoperational statuses can be defined. Available values:

$values = 'Degraded','Error','Lost Comm','No Contact','NonRecover','OK','Pred Fail','Service','Starting','Stopping','Stressed','Unknown'
Get-CimInstance -ClassName Win32_IP4PersistedRouteTable | Select-Object -Property Destination, Mask, Metric1, NextHop, Status

Examples

List all instances of Win32_IP4PersistedRouteTable
Get-CimInstance -ClassName Win32_IP4PersistedRouteTable

Learn more about Get-CimInstance and the deprecated Get-WmiObject.

View all properties
Get-CimInstance -ClassName Win32_IP4PersistedRouteTable -Property *
View key properties only
Get-CimInstance -ClassName Win32_IP4PersistedRouteTable -KeyOnly

Selecting Properties

To select only some properties, pipe the results to Select-Object -Property a,b,c with a comma-separated list of the properties you require. Wildcards are permitted.

Get-CimInstance always returns all properties but only retrieves the ones that you specify. All other properties are empty but still present. That’s why you need to pipe the results into Select-Object if you want to limit the visible properties, i.e. for reporting.

Selecting Properties

The code below lists all available properties. Remove the ones you do not need:

$properties = 'Caption',
              'Description',
              'Destination',
              'InstallDate',
              'Mask',
              'Metric1',
              'Name',
              'NextHop',
              'Status'
Get-CimInstance -ClassName Win32_IP4PersistedRouteTable | Select-Object -Property $properties
Limiting Network Bandwidth

If you work remotely, it makes sense to limit network bandwidth by filtering the properties on the server side, too:

Get-CimInstance -Class Win32_IP4PersistedRouteTable -Property $property | 
Select-Object -Property $property

Selecting Instances

To select some instances, use Get-CimInstance and a WMI Query. The wildcard character in WMI Queries is % (and not “*”).

The parameter -Filter runs a simple query.

Listing all instances where the property Caption starts with “A”
Get-CimInstance -Class Win32_IP4PersistedRouteTable -Filter 'Caption LIKE "a%"' 
Using a WQL Query

The parameter -Query uses a query similar to SQL and combines the parameters -Filter and -Property. This returns all instances where the property Caption starts with “A”, and returns the properties specified:

Get-CimInstance -Query "SELECT InstallDate, Mask, Status, NextHop FROM Win32_IP4PersistedRouteTable WHERE Caption LIKE 'a%'"

Any property you did not specify is still present but empty. You might need to use Select-Object to remove all unwanted properties:

Get-CimInstance -Query "SELECT InstallDate, Mask, Status, NextHop FROM Win32_IP4PersistedRouteTable WHERE Caption LIKE 'a%'" | Select-Object -Property InstallDate, Mask, Status, NextHop

Accessing Remote Computers

To access remote systems, you need to have proper permissions. User the parameter -ComputerName to access one or more remote systems.

Authenticating as Current User
# one or more computer names or IP addresses:
$list = 'server1', 'server2'

# authenticate with your current identity:
$result = Get-CimInstance -ClassName Win32_IP4PersistedRouteTable -ComputerName $list 
$result
Authenticating as Different User

Use a CIMSession object to authenticate with a new identity:

# one or more computer names or IP addresses:
$list = 'server1', 'server2'

# authenticate with a different identity:
$cred = Get-Credential -Message 'Authenticate to retrieve WMI information:'
$session = New-CimSession -ComputerName $list -Credential $cred

$result = Get-CimInstance Win32_IP4PersistedRouteTable -CimSession $session

# remove the session after use (if you do not plan to re-use it later)
Remove-CimSession -CimSession $session

$result

Learn more about accessing remote computers.

Requirements

To use Win32_IP4PersistedRouteTable, the following requirements apply:

PowerShell

Get-CimInstance was introduced with PowerShell Version 3.0, which in turn was introduced on clients with Windows 8 and on servers with Windows Server 2012.

If necessary, update Windows PowerShell to Windows PowerShell 5.1, or install PowerShell 7 side-by-side.

Operating System

Win32_IP4PersistedRouteTable was introduced on clients with Windows Vista and on servers with Windows Server 2008.

Namespace

Win32_IP4PersistedRouteTable lives in the Namespace Root/CIMV2. This is the default namespace. There is no need to use the -Namespace parameter in Get-CimInstance.

Implementation

Win32_IP4PersistedRouteTable is implemented in Wmipiprt.dll and defined in Wmipiprt.mof. Both files are located in the folder C:\Windows\system32\wbem:

explorer $env:windir\system32\wbem
notepad $env:windir\system32\wbem\Wmipiprt.mof