MSFT_NetRoute class

Article
05/08/2024

Represents an IP route for the TCP/IP (Internet Protocol Suite) WMIv2 provider.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[UMLPackagePath("CIM::Network::Routes"), ClassVersion("1.0.0"), dynamic, provider("nettcpip"), AMENDMENT]
class MSFT_NetRoute : CIM_NextHopRoute
{
  string   Caption;
  string   Description;
  string   ElementName;
  string   InstanceID;
  string   DestinationAddress;
  uint16   AdminDistance;
  uint16   RouteMetric;
  boolean  IsStatic;
  uint16   TypeOfRoute = 3;
  string   DestinationPrefix;
  uint32   InterfaceIndex;
  string   InterfaceAlias;
  string   NextHop;
  uint8    Publish;
  datetime ValidLifetime;
  datetime PreferredLifetime;
  uint8    Store;
  uint16   AddressFamily;
  uint16   Protocol;
};

Members

The MSFT_NetRoute class has these types of members:

Methods
Properties

Methods

The MSFT_NetRoute class has these methods.

Method	Description
Create	Create an IP route.
Find	Retrieves an IP route to the specified remote address.

Properties

The MSFT_NetRoute class has these properties.

AddressFamily

Data type: uint16
Access type: Read-only

Gets a value that indicates whether the route uses the IPv4 or IPv6 address family. This property gets one of the following values.

IPv4 (2)
IPv6 (23)

AdminDistance

Data type: uint16
Access type: Read-only

The specific administrative distance of this route, overriding any default distances specified by the system or routing service.

This property is inherited from CIM_NextHopRoute.

Caption

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

Contains a short textual description of the object.

This property is inherited from CIM_ManagedElement.

Description

Data type: string
Access type: Read-only

Provides a textual description of the object.

This property is inherited from CIM_ManagedElement.

DestinationAddress

Data type: string
Access type: Read-only

The address which serves as the destination to be reached.

This property is inherited from CIM_NextHopRoute.

DestinationPrefix

Data type: string
Access type: Read-only

Gets the destination prefix of the route.

ElementName

Data type: string
Access type: Read-only

Contains a user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information.

This property is inherited from CIM_ManagedElement.

InstanceID

Data type: string
Access type: Read-only
Qualifiers: key

Uniquely and opaquely identifies an instance of this class within the scope of the containing Namespace.

[!Important]In order to ensure uniqueness within the Namespace, the value of InstanceID should be constructed in the following pattern:

OrgID:LocalID

OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity defining the InstanceID, or be a registered ID that is assigned by a recognized global authority. This is similar to the structure of Schema class names. In addition, to ensure uniqueness the first colon in InstanceID must be between the OrgID andLocalID. Therefor the OrgID must not contain a colon (':').

LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.

If the preceding pattern is not used, the defining entity must assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this Namespace.

For Distributed Management Task Force (DMTF) defined instances, the pattern must be used with the OrgID set to CIM.

This property is inherited from CIM_NextHopRoute.

InterfaceAlias

Data type: string
Access type: Read-only

Gets the interface alias of the route.

InterfaceIndex

Data type: uint32
Access type: Read-only

Gets the interface index of the route.

IsStatic

Data type: boolean
Access type: Read-only

TRUE indicates that this is a static route, and FALSE indicates a dynamically-learned route.

This property is inherited from CIM_NextHopRoute.

NextHop

Data type: string
Access type: Read-only

Gets the address of the next hop for the route.

PreferredLifetime

Data type: datetime
Access type: Read/write

Gets and sets the preferred end time of the lifetime of the route. The default value for this property is infinite.

Protocol

Data type: uint16
Access type: Read-only

The protocol from which the route was learned.

Value	Meaning
Other 1	other protocol
Local 2	local routing
NetMgmt 3	Network Management static routing protocol (NETMGMT)
Icmp 4	Internet Control Message Protocol (ICMP)
Egp 5	Exterior Gateway Protocol (EGP)
Ggp 6	Gateway-to-Gateway Protocol (GGP)
Hello 7	Hellospeak protocol (HELLO)
Rip 8	Routing Information Protocol (RIP)
IsIs 9	Intermediate System to Intermediate System (IS-IS)
EsIs 10	End System to Intermediate System (ES-IS)
Igrp 11	Interior Gateway Routing Protocol (IGRP)
Bbn 12	BBN protocol
Ospf 13	Open Shortest Path First (OSPF)
Bgp 14	Border Gateway Protocol (BGP)
Idpr 15	Interdomain Routing Protocol (IDPR)
Eigrp 16	Enhanced Interior Gateway Routing Protocol (EIGRP)
Dvmrp 17	Distance Vector Multicast Routing Protocol (DVMRP)
Rpl 18	Routing Protocol for Low-Power and Lossy Networks (RPL)
Dhcp 19	Dynamic Host Configuration Protocol (DHCP)

Publish

Data type: uint8
Access type: Read/write

Gets and sets a value that indicates how to advertise the route. The default value for this property is 0.

Value	Meaning
No 0	Do not advertise the route.
Age 1	Advertise the route for a specific interval.
Yes 2	Advertise the route indefinitely.

RouteMetric

Data type: uint16
Access type: Read-only

Provides a numeric indication as to the preference of this route, compared to other routes that reach the same destination.

This property is inherited from CIM_NextHopRoute.

Store

Data type: uint8
Access type: Read-only

Gets a value that indicates whether the state of the route persists after a reboot. This property can contain one of the following values.

Value	Meaning
Persistent 0	The state of the route persists after a reboot.
Active 1	The state of the route does not persist after a reboot.

TypeOfRoute

Data type: uint16
Access type: Read-only

Indicates the type of route.

This property is inherited from CIM_NextHopRoute.

Administrator Defined Route (2)
Computed Route (3)
Actual Route (4)

ValidLifetime

Data type: datetime
Access type: Read/write

Gets and sets the valid end time of the lifetime of the route. The default value for this property is infinite.

Requirements


Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Namespace	Root\StandardCimv2
MOF	NetTCPIP.mof
DLL	NetTCPIP.dll

Share via

MSFT_NetRoute class

Syntax

Members

Methods

Properties

Requirements

See also

Feedback

Additional resources