# 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

Name | Data Type | Value
--- | --- | ---
Abstract | boolean | true
Deprecated | string | CIM_NextHopIPRoute

Description

string

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.

UMLPackagePath | string | CIM::Network::Routes
Version | string | 2.7.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
AddressType | uint16 |
Deprecated | string | CIM_NextHopIPRoute.AddressType
Description | string | An 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.
Key | boolean | true
ValueMap | string | 0, 1, 2
Values | string | Unknown, IPv4, IPv6
CreationClassName | string |
Deprecated | string | No value
Description | string | CreationClassName 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.
Key | boolean | true
MaxLen | uint32 | 256
DestinationAddress | string |
Deprecated | string | No value
Description | string | The address which serves as the destination to be reached.
ModelCorrespondence | string | CIM_IPRoute.IPDestinationAddress
Override | string | DestinationAddress
DestinationMask | string |
Deprecated | string | No value
Description | string | The mask for the DestinationAddress.
ModelCorrespondence | string | CIM_IPRoute.IPDestinationMask
Override | string | DestinationMask
IPDestinationAddress | string |
Deprecated | string | CIM_NextHopIPRoute.DestinationAddress

Description

string

The 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.

Key | boolean | true
ModelCorrespondence | string | CIM_IPRoute.DestinationAddress
IPDestinationMask | string |
Deprecated | string | CIM_NextHopIPRoute.DestinationMask

Description

string

The 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.

Key | boolean | true
ModelCorrespondence | string | CIM_IPRoute.DestinationMask
ServiceCreationClassName | string |
Deprecated | string | No value
Description | string | The scoping ForwardingService's CreationClassName.
Key | boolean | true
MaxLen | uint32 | 256
Propagated | string | CIM_ForwardingService.CreationClassName
ServiceName | string |
Deprecated | string | No value
Description | string | The scoping ForwardingService's Name.
Key | boolean | true
MaxLen | uint32 | 256
Propagated | string | CIM_ForwardingService.Name
SystemCreationClassName | string |
Deprecated | string | No value
Description | string | The scoping ForwardingService's SystemCreationClassName.
Key | boolean | true
MaxLen | uint32 | 256
Propagated | string | CIM_ForwardingService.SystemCreationClassName
SystemName | string |
Deprecated | string | No value
Description | string | The scoping ForwardingService's SystemName.
Key | boolean | true
MaxLen | uint32 | 256
Propagated | string | CIM_ForwardingService.SystemName

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
IsStatic | boolean | CIM_NextHopRouting
Name | string | CIM_ManagedSystemElement
NextHop | string | CIM_NextHopRouting
OperatingStatus | uint16 | CIM_ManagedSystemElement
PrimaryStatus | uint16 | CIM_ManagedSystemElement
Status | string | CIM_ManagedSystemElement
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods