Win32_IP4RouteTable class

Article
05/31/2018

The Win32_IP4RouteTable WMI class represents information that governs the routing of network data packets. For example, Internet packets are usually sent to a gateway and local packets are routed directly by the client computer. 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 only represents the information shown as a result of typing the route print command from the command prompt.

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.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

[dynamic, provider("RouteProvider"), SupportsCreate, CreateBy("PutInstance"), SupportsDelete, DeleteBy("DeleteInstance"), SupportsUpdate, UUID("{ABEE8C61-A43F-4088-0081-9D00B3FF6545}"), AMENDMENT]
class Win32_IP4RouteTable : CIM_LogicalElement
{
  sint32   Age;
  string   Caption;
  string   Description;
  string   Destination;
  string   Information;
  datetime InstallDate;
  sint32   InterfaceIndex;
  string   Mask;
  sint32   Metric1;
  sint32   Metric2;
  sint32   Metric3;
  sint32   Metric4;
  sint32   Metric5;
  string   Name;
  string   NextHop;
  uint32   Protocol;
  string   Status;
  uint32   Type;
};

Members

The Win32_IP4RouteTable class has these types of members:

Properties

Properties

The Win32_IP4RouteTable class has these properties.

Age

Data type: sint32
Access type: Read-only

Number of seconds since this route was last updated or otherwise determined to be correct. Whether the routing information is outdated can only be determined by knowing the routing protocol by which the route was learned.

Caption

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

Short description of the object. This property is inherited from CIM_ManagedSystemElement.

Description

Data type: string
Access type: Read-only

Description of the object. This property is inherited from CIM_ManagedSystemElement.

Destination

Data type: string
Access type: Read/write
Qualifiers: key

Destination IP address for this route.

Information

Data type: string
Access type: Read-only

Reference to Management Information Base (MIB) definitions specific to the particular routing protocol that handles this route, as determined by the value specified in the route 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 conforming implementation of ASN.1 and BER must be able to generate and recognize this value.

InstallDate

Data type: datetime
Access type: Read-only

Object was installed. This property does not need a value to indicate that the object is installed. This property is inherited from CIM_ManagedSystemElement.

InterfaceIndex

Data type: sint32
Access type: Read/write
Qualifiers: Key

IP address of the next hop of this route. The value in this property is the same as the value in the InterfaceIndex property in the instances of Win32_NetworkAdapter and Win32_NetworkAdapterConfiguration that represent the network interface of the next hop of the route.

In the case of a route bound to an interface that is realized using a broadcast medium, the value of this field is the agent IP address on that interface.

Mask

Data type: string
Access type: Read/write
Qualifiers: key

Mask used in this entry. Masks should be joined with a logical AND to the destination address before being compared to the value in the ipRouteDest field.

Metric1

Data type: sint32
Access type: Read/write

Primary routing metric for this route. The routing protocol specified in the ipRouteProto value for the route determines the interpretation of this property. Set the value of this property to -1 if it is not used.

Metric2

Data type: sint32
Access type: Read/write

Alternate routing metric for this route. The routing protocol specified in the ipRouteProto value for the route determines the interpretation of this property. Set the value of this property to -1 if it is not used.

Metric3

Data type: sint32
Access type: Read/write

Metric4

Data type: sint32
Access type: Read/write

Metric5

Data type: sint32
Access type: Read/write

Name

Data type: string
Access type: Read-only

Label by which the object is known. When subclassed, this property can be overridden to be a key property. This property is inherited from CIM_ManagedSystemElement.

NextHop

Data type: string
Access type: Read/write
Qualifiers: Key

IP address of the next hop of this route. For a route that is bound to an interface realized via a broadcast medium, the value of this field is the agent IP address on that interface.

Protocol

Data type: uint32
Access type: Read-only

Routing mechanism through which this route was learned. Inclusion of values for gateway routing protocols does not imply that hosts must support those protocols.

other (1)

local (2)

netmgmt (3)

icmp (4)

egp (5)

ggp (6)

hello (7)

rip (8)

is-is (9)

es-is (10)

ciscoIgrp (11)

bbnSpfIgp (12)

ospf (13)

bgp (14)

Status

Data type: string
Access type: Read-only
Qualifiers: MaxLen (10)

Current status of the object. Various operational and nonoperational statuses can be defined. Operational statuses include: "OK", "Degraded", and "Pred Fail" (an element, such as a SMART-enabled hard disk disk drive, may be functioning properly but predicting a failure in the near future). Nonoperational statuses include: "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 online, yet the managed element is neither "OK" nor in one of the other states. This property is inherited from the CIM_ManagedSystemElement class.

The values are:

"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"

Type

Data type: uint32
Access type: Read/write

Type of route. The following list lists the values.

other (1)

invalid (2)

direct (3)

indirect (4)

Values 3 (Direct) and 4 (Indirect) refer to direct and indirect routing in the IP architecture. Setting this object to the value 2 (Invalid) invalidates the corresponding entry in the RouteTable object by disassociating the entry's destination from the entry's route. An agent may leave an invalid entry in the table. Therefore, management stations can receive information from agents that applies to entries not currently in use. To interpret such entries, examine the relevant ipRouteType object.

Remarks

The Win32_IP4RouteTable class is derived from CIM_LogicalElement.

Requirements


Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Namespace	Root\CIMV2
MOF	Wmipiprt.mof
DLL	Wmipiprt.dll

Partager via