Class CIM_IPRoute
extends CIM_NextHopRouting

An IPRoute relates a destination address to the address or interface through which the remote address may be reached. The destination address may be a specific IP endpoint or a subnet, dependent on the mask. An instance of this class represents either static or dynamic routing. Static routes are distinguished by setting the IsStatic boolean property to TRUE. Since many routes between endpoints can be defined (using different route calculation algorithms), the CIM_IPRoute class is defined as Abstract. This forces subclassing (for example, see CIM_BGPIPRoute) and allows the instances of its subclasses to be distinguished based on their CreationClassName key property. IPRoute is deprecated in lieu of the more general, concrete NextHopIPRoute class. NextHopIPRoute allows the definition of BOTH a next hop address and an interface for transmission of the traffic. Also, it does not mandate the instantiation of a ForwardingService class.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_NextHopRouting
   |
   +--CIM_IPRoute

Direct Known Subclasses

CIM_BGPIPRoute

Class Qualifiers

NameData TypeValue
Abstractbooleantrue
DeprecatedstringCIM_NextHopIPRoute
DescriptionstringAn IPRoute relates a destination address to the address or interface through which the remote address may be reached. The destination address may be a specific IP endpoint or a subnet, dependent on the mask. An instance of this class represents either static or dynamic routing. Static routes are distinguished by setting the IsStatic boolean property to TRUE. Since many routes between endpoints can be defined (using different route calculation algorithms), the CIM_IPRoute class is defined as Abstract. This forces subclassing (for example, see CIM_BGPIPRoute) and allows the instances of its subclasses to be distinguished based on their CreationClassName key property. IPRoute is deprecated in lieu of the more general, concrete NextHopIPRoute class. NextHopIPRoute allows the definition of BOTH a next hop address and an interface for transmission of the traffic. Also, it does not mandate the instantiation of a ForwardingService class.
UMLPackagePathstringCIM::Network::Routes
Versionstring2.7.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
AddressTypeuint16
DeprecatedstringCIM_NextHopIPRoute.AddressType
DescriptionstringAn enumeration that describes the format of the address property. Addresses that can be formatted in IPv4 format, must be formatted that way to ensure mixed IPv4/IPv6 support. AddressType is part of the key so that an IPv4 and an IPv6 route to IP subnets with the same network number but different IP versions (v4/v6) can coexist.
Keybooleantrue
ValueMapstring0, 1, 2
ValuesstringUnknown, IPv4, IPv6
CreationClassNamestring
DeprecatedstringNo value
DescriptionstringCreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.
Keybooleantrue
MaxLenuint32256
DestinationAddressstring
DeprecatedstringNo Value
DescriptionstringThe address which serves as the destination to be reached.
ModelCorrespondencestringCIM_IPRoute.IPDestinationAddress
OverridestringDestinationAddress
DestinationMaskstring
DeprecatedstringNo Value
DescriptionstringThe mask for the DestinationAddress.
ModelCorrespondencestringCIM_IPRoute.IPDestinationMask
OverridestringDestinationMask
IPDestinationAddressstring
DeprecatedstringCIM_NextHopIPRoute.DestinationAddress
DescriptionstringThe IP address which serves as the destination of the traffic, formatted according to the appropriate convention as defined in the AddressType property of this class. This property has the same semantics as DestinationAddress inherited from the NextHopRouting superclass, but a different property name. This is because this property and class were defined before NextHopRouting and are Key properties. They cannot be removed. ModelCorrespondence indicates that they should be set to equivalent values for consistency and ease of query.
Keybooleantrue
ModelCorrespondencestringCIM_IPRoute.DestinationAddress
IPDestinationMaskstring
DeprecatedstringCIM_NextHopIPRoute.DestinationMask
DescriptionstringThe mask for the destination IP address, formatted according to the appropriate convention as defined in the AddressType property of this class. This property has the same semantics as DestinationMask inherited from the NextHopRouting superclass, but a different property name. This is because this property and class were defined before NextHopRouting and are Key properties. They cannot be removed. ModelCorrespondence indicates that they should be set to equivalent values for consistency and ease of query.
Keybooleantrue
ModelCorrespondencestringCIM_IPRoute.DestinationMask
ServiceCreationClassNamestring
DeprecatedstringNo value
DescriptionstringThe scoping ForwardingService's CreationClassName.
Keybooleantrue
MaxLenuint32256
PropagatedstringCIM_ForwardingService.CreationClassName
ServiceNamestring
DeprecatedstringNo value
DescriptionstringThe scoping ForwardingService's Name.
Keybooleantrue
MaxLenuint32256
PropagatedstringCIM_ForwardingService.Name
SystemCreationClassNamestring
DeprecatedstringNo value
DescriptionstringThe scoping ForwardingService's SystemCreationClassName.
Keybooleantrue
MaxLenuint32256
PropagatedstringCIM_ForwardingService.SystemCreationClassName
SystemNamestring
DeprecatedstringNo value
DescriptionstringThe scoping ForwardingService's SystemName.
Keybooleantrue
MaxLenuint32256
PropagatedstringCIM_ForwardingService.SystemName

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
IsStaticbooleanCIM_NextHopRouting
NamestringCIM_ManagedSystemElement
NextHopstringCIM_NextHopRouting
OperatingStatusuint16CIM_ManagedSystemElement
PrimaryStatusuint16CIM_ManagedSystemElement
StatusstringCIM_ManagedSystemElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods