Home Reference WMI Reference root CIMV2 Win32_IP4RouteTable
 

Win32_IP4RouteTable

The IP4RouteTable class information governs where network data packets are routed to (e.g. usually internet packets are sent to a gateway, and local packets may be routed directly by the client’s machine). Administrators can use this information to trace problems associated with misrouted packets, and also direct a computer to a new gateway as necessary. This class deals specifically with IP4 and does not address IPX or IP6. It is only intended to model the information revealed when typing the ‘Route Print’ command from the command prompt.

Please Note: though updating instances of this class is supported, supplying property values which are invalid or unrecognized by the network protocol stack will not update successfully and the original values will persist. An error is not guaranteed to be generated when this happens, but if one does, nothing is updated.

Quick Start

Properties

Most WMI properties are read-only. You can only read values but not change them. Few properties are also writeable. You can assign new values to those properties.

Writeable properties are marked with this icon:   

Age

Data type UInt32

The Age property contains the number of seconds since this route was last updated or otherwise determined to be correct. No semantics of ‘too old’ can be implied except through knowledge of the routing protocol by which the route was learned.

Caption

Data type String

The Caption property is a short textual description (one-line string) of the object.

Description

Data type String

The Description property provides a textual description of the object.

  Destination

Data type String

The Destination property contains the destination IP address for this route.

Information

Data type String

The Information property contains a reference to MIB definitions specific to the particular routing protocol that is responsible for this route, as determined by the value specified in the route’s ipRouteProto value. If this information is not present, its value should be set to the OBJECT IDENTIFIER {0 0}, which is a syntactically valid object identifier, and any conformant implementation of ASN.1 and BER must be able to generate and recognize this value.

InstallDate

Data type DateTime

The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

  InterfaceIndex

Data type SInt32

The InterfaceIndex property contains the index value that uniquely identifies the local interface through which the next hop of this route should be reached.

  Mask

Data type String

The Mask property contains the mask used in this entry. Masks should be logical-ANDed with the destination address before being compared to the value in the ipRouteDest field.

  Metric1

Data type SInt32

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

  Metric2

Data type SInt32

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

  Metric3

Data type SInt32

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

  Metric4

Data type SInt32

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

  Metric5

Data type SInt32

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

Name

Data type String

The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.

  NextHop

Data type String

The NextHop property contains the IP address of the next hop of this route. (In the case of a route bound to an interface that is realized via a broadcast media, the value of this field is the agent’s IP address on that interface.).

Protocol

Data type UInt32

The Protocol property reveals the routing mechanism via which this route was learned. Inclusion of values for gateway routing protocols is not intended to imply that hosts must support those protocols.

$Protocol_ReturnValue = 
@{
    1='other'
    2='local'
    3='netmgmt'
    4='icmp'
    5='egp'
    6='ggp'
    7='hello'
    8='rip'
    9='is-is'
   10='es-is'
   11='ciscoIgrp'
   12='bbnSpfIgp'
   13='ospf'
   14='bgp'
}

Recursive

Data type Boolean

StartFileName

Data type String

Status

Data type String

The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are “OK”, “Degraded” and “Pred Fail”. “Pred Fail” indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are “Error”, “Starting”, “Stopping” and “Service”. The latter, “Service”, could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither “OK” nor in one of the other states.

'OK','Error','Degraded','Unknown','Pred Fail','Starting','Stopping','Service','Stressed','NonRecover','No Contact','Lost Comm'

  Type

Data type UInt32

The Type property reveals the type of route. The values direct(3) and indirect(4) refer to the notion of direct and indirect routing in the IP architecture. Setting this object to the value invalid(2) has the effect of invalidating the corresponding entry in the RouteTable object. That is, it effectively disassociates the destination identified with said entry from the route identified with said entry. It is an implementation-specific matter as to whether the agent removes an invalidated entry from the table. Accordingly, management stations must be prepared to receive tabular information from agents that corresponds to entries not currently in use. Proper interpretation of such entries requires examination of the relevant ipRouteType object.

$Type_ReturnValue = 
@{
    1='other'
    2='invalid'
    3='direct'
    4='indirect'
}

Methods

Examples

See Also

Help and Questions

  Community Content

You are cordially invited to add knowledge to this page. If you have sample code or additional information related to this WMI class, please share it. Use the comment form to send your information. We will edit and incorparate it into the reference library. Thank you!

Please do not use the comment form to submit questions. If you have questions or need assistance, visit our free forum: Help me with WMI.

Content last updated: 2013-12-27 12:22:19 (UTC).

Facebooktwittergoogle_pluspinterestlinkedinFacebooktwittergoogle_pluspinterestlinkedin