# 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

Name | Data Type | Value
--- | --- | ---
Description | string | 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.
UMLPackagePath | string | CIM::Network::BGP
Version | string | 2.7.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
Action | uint16 |
Description | string | This defines whether the action should be to forward or deny traffic meeting the match condition specified in this RouteMap.
ValueMap | string | 1, 2
Values | string | Permit, Deny
CreationClassName | string |
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
Direction | uint16 |
Description | string | This defines whether this RouteMap is used for input, output, or both input and output filtering.
ValueMap | string | 1, 2, 3
Values | string | Input, Output, Both
MatchConditionType | uint16 |
Description | string | This 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.
ModelCorrespondence | string | CIM_BGPRouteMap.OtherMatchConditionType
ValueMap | string | 1, 2, 3, 4, 5, 6, 7, 8, 9
Values | string | Other, Source Address and Mask, Destination Address and Mask, Source Port, Source Port Range, Destination Port, Destination Port Range, Protocol Type, Protocol Type and Option
Name | string |
Description | string | This is the name of the RouteMap class.
Key | boolean | true
MaxLen | uint32 | 256
Override | string | Name
OtherMatchConditionType | string |
Description | string | If 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.
ModelCorrespondence | string | CIM_BGPRouteMap.MatchConditionType
SetMetricType | uint16 |
Description | string | This 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.
ModelCorrespondence | string | CIM_BGPRouteMap.SetMetricValue
ValueMap | string | 1, 2, 3, 4, 5, 6, 7, 8, 9
Values | string | Origin, AS_Path, NEXT_HOP, Multi_Exit_Disc, Local_Pref, Atomic_Aggregate, Aggregator, Community, Originator_ID
SetMetricValue | string |
Description | string | This is the value of the metric that is being set for the BGP attribute defined in the SetMetricType property.
SystemCreationClassName | string |
Description | string | The scoping AutonomousSystem's CreationClassName.
Key | boolean | true
MaxLen | uint32 | 256
Propagated | string | CIM_AutonomousSystem.CreationClassName
SystemName | string |
Description | string | The scoping AutonomousSystem's Name.
Key | boolean | true
MaxLen | uint32 | 256
Propagated | string | CIM_AutonomousSystem.Name

### 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
Generation | uint64 | CIM_ManagedElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
OperatingStatus | uint16 | CIM_ManagedSystemElement
PrimaryStatus | uint16 | CIM_ManagedSystemElement
Status | string | CIM_ManagedSystemElement
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods