Class CIM_BGPAttributes
extends CIM_LogicalElement

This class defines the BGP Attributes, that can be used to affect routing decisions. BGPAttributes are specific to a given AutonomousSystem that contains it. Hence, the keys of the AutonomousSystem are propagated to this class.

Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_BGPAttributes

Direct Known Subclasses

None.

Class Qualifiers

NameData TypeValueScopeFlavors
DescriptionstringThis class defines the BGP Attributes, that can be used to affect routing decisions. BGPAttributes are specific to a given AutonomousSystem that contains it. Hence, the keys of the AutonomousSystem are propagated to this class.None TRANSLATABLE= true
Versionstring2.7.0TOSUBCLASS= falseTRANSLATABLE= true

Local Class Properties

NameData TypeQualifiers
NameData TypeValueScopeFlavors
Aggregatorstring
DescriptionstringThis specifies the AS and IP address of the router that has generated an aggregate.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgp4PathAttrAggregatorASNone None
ASPathstring
DescriptionstringThis attribute is a sequences of the AS numbers through which routing information carried in this UPDATE message has passed. The components of this list can be AS_SETs or AS_SEQUENCEs.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgp4PathAttrASPathNone None
AsSetstring
DescriptionstringThis is the set of all elements contained in all specific paths that are being summarized, so that those attributes will remain available to the routing decision process.None TRANSLATABLE= true
AtomicAggregateboolean
DescriptionstringThis property is set to TRUE if there are overlapping routes, and a less-specific route is selected instead of a more specific one (e.g., a system propagates an aggregate that causes loss of information). The value is set to FALSE if a less-specific route is NOT selected.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgp4PathAttrAtomicAggregateNone None
BGPCommunityValueuint32
DescriptionstringThis defines a group of destinations that share a similar property. Communities are not restricted to a single AS, and can span multiple ASs. This attribute is used to simplify routing policies by basing policies on a logical value, as opposed to an IP address or an AS number.None TRANSLATABLE= true
Captionstring
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.None TRANSLATABLE= true
MaxLenuint3264None None
Descriptionstring
DescriptionstringThe Description property provides a textual description of the object.None TRANSLATABLE= true
ElementNamestring
DescriptionstringA 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. Note that ManagedSystemElement's Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties.None TRANSLATABLE= true
InstallDatedatetime
DescriptionstringA datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.None TRANSLATABLE= true
MappingStringsstringMIF.DMTF|ComponentID|001.5None None
LocalPreferenceuint16
DescriptionstringThis defines the priority, or preference, of a route, in order to better compare it with other routes for the same destination. Higher values indicate a higher preference for a route.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgp4PathAttrLocalPrefNone None
MEDuint32
DescriptionstringThis is used on external (e.g., inter-AS) links to indicate which is the preferred entry point into an AS, when that AS has multiple entry points. Lower MED values have preference.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgp4PathAttrMultiExitDiscNone None
Namestring
DescriptionstringThe Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.None TRANSLATABLE= true
MaxLenuint321024None None
NextHopstring
DescriptionstringThis attribute defines the IP address of the border router that should be used as the next hop to the destinations listed in the UPDATE message.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgp4PathAttrNextHopNone None
NextHopSelfstring
DescriptionstringThis defines the next hop to be the IP address of the border IBGP neighbor.None TRANSLATABLE= true
Originuint16
DescriptionstringThis is generated by the AS that originates the routing information. There are three types of origins - IGP, EGP, and INCOMPLETE. These correspond to whether the information was learned internally in the AS, externally via an EGP, or by some other means.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgp4PathAttrOriginNone None
ValueMapstring1, 2, 3None None
ValuesstringIGP, EGP, INCOMPLETENone TRANSLATABLE= true
OriginatorIDstring
DescriptionstringThis is the router ID for the ORIGIN attribute.None TRANSLATABLE= true
Statusstring
DeprecatedstringCIM_ManagedSystemElement.OperationalStatusTOSUBCLASS= falseNone
DescriptionstringA string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the Deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus.None TRANSLATABLE= true
MaxLenuint3210None None
ValueMapstringOK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, NonRecover, No Contact, Lost Comm, StoppedNone None
SystemCreationClassNamestring
DescriptionstringThe scoping AutonomousSystem's CreationClassName.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_AutonomousSystem.CreationClassNameNone OVERRIDABLE= false
SystemNamestring
DescriptionstringThe scoping AutonomousSystem's Name.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_AutonomousSystem.NameNone OVERRIDABLE= false
Versionstring
DescriptionstringThis defines the version of the BGP protocol.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
OperationalStatusuint16[]
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringIndicates the current status(es) of the element. Various health and operational statuses are defined. Many of the enumeration's values are self- explanatory. However, a few are not and are described in more detail. "Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, etc. "Predictive Failure" indicates that an element is functioning nominally but predicting a failure in the near future. "In Service" describes an element being configured, maintained, cleaned, or otherwise administered. "No Contact" indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. "Lost Communication" indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. "Stopped" and "Aborted" are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the element's state and configuration may need to be updated. "Dormant" indicates that the element is inactive or quiesced. "Supporting Entity in Error" describes that this element may be "OK" but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower layer networking problems. "Completed" indicates the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error. "Power Mode" indicates the element has additional power model information contained in the Associated PowerManagementService association. OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today's environment to the future. This change was not made earlier since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/instrumentation provide BOTH the Status and OperationalStatus properties. Further, the first value of OperationalStatus SHOULD contain the primary status for the element. When instrumented, Status (since it is single-valued) SHOULD also provide the primary status of the element.None TRANSLATABLE= true
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptionsNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, .., 0x8000..None None
ValuesstringUnknown, Other, OK, Degraded, Stressed, Predictive Failure, Error, Non-Recoverable Error, Starting, Stopping, Stopped, In Service, No Contact, Lost Communication, Aborted, Dormant, Supporting Entity in Error, Completed, Power Mode, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
StatusDescriptionsstring[]
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringStrings describing the various OperationalStatus array values. For example, if "Stopping" is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus.None TRANSLATABLE= true
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatusNone None