Represents one of a series of 'hops' to reach a network destination. A route is administratively defined, or calculated/learned by a particular routing process. A ConcreteDependency association may be instantiated between a route and its routing service to indicate this. (In this scenario, the route is dependent on the service.)
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[UMLPackagePath("CIM::Network::Routes"), Version("2.19.0"), AMENDMENT]
class CIM_NextHopRoute : CIM_ManagedElement
{
string Caption;
string Description;
string ElementName;
string InstanceID;
string DestinationAddress;
uint16 AdminDistance;
uint16 RouteMetric;
boolean IsStatic;
uint16 TypeOfRoute = 3;
};
Members
The CIM_NextHopRoute class has these types of members:
Properties
The CIM_NextHopRoute class has these properties.
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.
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.
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, Override ("InstanceID")
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. Therefore 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.
IsStatic
Data type: boolean
Access type: Read-only
TRUE indicates that this is a static route, and FALSE indicates a dynamically-learned route.
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.
TypeOfRoute
Data type: uint16
Access type: Read-only
Indicates the type of route.
Administrator Defined Route (2)
Computed Route (3)
Actual Route (4)
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 8 |
| Minimum supported server | Windows Server 2012 |
| Namespace | Root\standardcimv2 |
| MOF | NetTCPIP.mof |
| DLL | NetTCPIP.dll |
See also
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors (upstream author metadata: windowssdkdev). Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
