Class CIM_BGPRouteMap
extends CIM_LogicalElement

A route map is used to control and modify routing information as well as to define when a route is redistributed between routing domains. Route maps are placed in router configuration files, and several instances of the same route map may be used to implement different actions. RouteMaps MAY use FilterLists to identify the route. A BGPRouteMap is specific to a given AutonomousSystem that contains it. Hence, the keys of the AutonomousSystem are propagated to this class.

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

Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_BGPRouteMap

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringA route map is used to control and modify routing information as well as to define when a route is redistributed between routing domains. Route maps are placed in router configuration files, and several instances of the same route map may be used to implement different actions. RouteMaps MAY use FilterLists to identify the route. A BGPRouteMap is specific to a given AutonomousSystem that contains it. Hence, the keys of the AutonomousSystem are propagated to this class.
UMLPackagePathstringCIM::Network::BGP
Versionstring2.7.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
Actionuint16
DescriptionstringThis defines whether the action should be to forward or deny traffic meeting the match condition specified in this RouteMap.
ValueMapstring1, 2
ValuesstringPermit, Deny
CreationClassNamestring
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
Directionuint16
DescriptionstringThis defines whether this RouteMap is used for input, output, or both input and output filtering.
ValueMapstring1, 2, 3
ValuesstringInput, Output, Both
MatchConditionTypeuint16
DescriptionstringThis specifies the criteria that must be matched in order for the corresponding MatchAction to take effect. The matching of the criteria may be specified by using a FilterList. For example, the command 'match ip address foo' uses the FilterList named 'foo' to do the matching of IP addresses.
ModelCorrespondencestringCIM_BGPRouteMap.OtherMatchConditionType
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, 9
ValuesstringOther, Source Address and Mask, Destination Address and Mask, Source Port, Source Port Range, Destination Port, Destination Port Range, Protocol Type, Protocol Type and Option
Namestring
DescriptionstringThis is the name of the RouteMap class.
Keybooleantrue
MaxLenuint32256
OverridestringName
OtherMatchConditionTypestring
DescriptionstringIf the value of the MatchConditionType property in this class is 1 (i.e., "Other"), then the specific type of filtering is specified in this property.
ModelCorrespondencestringCIM_BGPRouteMap.MatchConditionType
SetMetricTypeuint16
DescriptionstringThis defines an additional action to take if the MatchCondition is satisfied. This definition is specifically limited to BGP filtering at this time. The actual value of the metric is specified in the SetMetricValue property.
ModelCorrespondencestringCIM_BGPRouteMap.SetMetricValue
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, 9
ValuesstringOrigin, AS_Path, NEXT_HOP, Multi_Exit_Disc, Local_Pref, Atomic_Aggregate, Aggregator, Community, Originator_ID
SetMetricValuestring
DescriptionstringThis is the value of the metric that is being set for the BGP attribute defined in the SetMetricType property.
SystemCreationClassNamestring
DescriptionstringThe scoping AutonomousSystem's CreationClassName.
Keybooleantrue
MaxLenuint32256
PropagatedstringCIM_AutonomousSystem.CreationClassName
SystemNamestring
DescriptionstringThe scoping AutonomousSystem's Name.
Keybooleantrue
MaxLenuint32256
PropagatedstringCIM_AutonomousSystem.Name

Inherited Properties

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

Class Methods