Class CIM_BGPPathAttributes
extends CIM_LogicalElement

This class defines the per-path information used to process specific BGP attribute information, as defined in the bgp4PathAttrTable of RFC 1657.

Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_BGPPathAttributes

Direct Known Subclasses

None.

Class Qualifiers

NameData TypeValueScopeFlavors
DescriptionstringThis class defines the per-path information used to process specific BGP attribute information, as defined in the bgp4PathAttrTable of RFC 1657.None TRANSLATABLE= true
Versionstring2.7.0TOSUBCLASS= falseTRANSLATABLE= true

Local Class Properties

NameData TypeQualifiers
NameData TypeValueScopeFlavors
ASNumbersstring
DescriptionstringA comma-separated list of AS numbers, as would be stored in the value portion of the path segment in the PathAttrASPathSegment property. This list can be ordered or unordered.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32512None None
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
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
PathAttrAggregatorAddrstring
DescriptionstringThis is the IP address of the last BGP speaker that performed route aggregation. A value of 0.0.0.0 indicates the absence of this attribute.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgp4PathAttrAggregatorAddrNone None
PathAttrAggregatorASuint16
DescriptionstringThis is the AS number of the last BGP speaker that performed route aggregation. A value of 0 indicates the absence of this attribute. The range of this attribute is defined to be 0 to 65535.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgp4PathAttrAggregatorASNone None
PathAttrAtomicAggregateuint32
DescriptionstringThis is an enumeration that defines whether or not the local system has selected a less specific route without selecting a more specific route. There are two values, 1 and 2, indicating that a less specific route has not and has been selected, respectively. This is a 32-bit integer to correspond to the IETF MIB.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgp4PathAttrAtomicAggregateNone None
ValueMapstring0, 1, 2None None
ValuesstringUnknown, Less Specific Not Selected, Less Specific SelectedNone TRANSLATABLE= true
PathAttrBestuint16
DescriptionstringThis is an indication of whether or not this route was chosen as the best BGP route. There are three possible values, 0 (Unknown), 1 (FALSE) and 2 (TRUE).None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgp4PathAttrBestNone None
ValueMapstring0, 1, 2None None
ValuesstringUnknown, False, TrueNone TRANSLATABLE= true
PathAttrCalcLocalPrefsint16
DescriptionstringThis is the degree of preference calculated by the receiving BGP speaker for an advertised route. A value of -1 indicates the absence of this attribute. The range of this attribute is defined to be -1 to 2147483647.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgp4PathAttrCalcLocalPrefNone None
PathAttrLocalPrefsint32
DescriptionstringThis is the originating BGP4 speaker's degree of preference for an advertised route. A value of -1 indicates the absence of this attribute. The range of this attribute is defined to be -1 to 2147483647.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgp4PathAttrLocalPrefNone None
PathAttrMultiExitDiscsint32
DescriptionstringThis metric is used to discriminate between multiple adjacent autonomous systems. A value of -1 indicates the absence of this attribute. The range of this attribute is defined to be -1 to 2147483647.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgp4PathAttrMultiExitDiscNone None
PathAttrNextHopstring
DescriptionstringThis is the address of the border router that should be used for the destination network.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MappingStringsstringMIB.IETF|BGP4-MIB.bgp4PathAttrNextHopNone None
MaxLenuint3232None None
PathAttrOriginuint16
DescriptionstringThis is an enumeration that defines the ultimate origin of the path information. The value 'IGP' means that the origin is interior; the value 'EGP' means that it was learned via an EGP; the value 'INCOMPLETE' means that the origin is undetermined.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgp4PathAttrOriginNone None
ValueMapstring1, 2, 3None None
ValuesstringIGP, EGP, IncompleteNone TRANSLATABLE= true
PathAttrUnknownNumberuint16
DescriptionstringThe number of unknown attributes in the array, PathAttrUnknown.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgp4PathAttrUnknownNone None
ModelCorrespondencestringCIM_BGPPathAttributes.PathAttrUnknownNone None
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
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
PathAttrASPathSegmentuint8[]
DescriptionstringThis property and its description are taken directly from RFC 1657. The property represents a sequence of AS path segments. Each AS path segment is represented by the tuple: <type, length, value> The type is a 1-octet field which has two possible values: 1 = AS_SET 2 = AS_SEQUENCE An AS_SET is an unordered set of ASs representing the path that an UPDATE message has traversed, and an AS_SEQUENCE is an ordered set of ASs representing the path that an UPDATE message has traversed. The length is a 1-octet field containing the number of ASs in the value field. The value field contains one or more AS numbers, each AS is represented in the octet string as a pair of octets according to the following algorithm: first-byte-of-pair = ASNumber / 256; second-byte-of-pair = ASNumber & 255; This property is mapped from the bgp4PathAttrASPathSegment MIB variable, which is an OctetString. Its length is defined as a minimum of 2 and a maximum of 255 octets.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgp4PathAttrASPathSegmentNone None
OctetStringbooleantrueNone OVERRIDABLE= false
PathAttrUnknownstring[]
DescriptionstringThis contains one or more path atributes not understood by this BGP speaker. It is a array of path attributes that are not understood. The number of attributes is placed in a separate property of this class, PathAttrUnknownNumber.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|BGP4-MIB.bgp4PathAttrUnknownNone None
ModelCorrespondencestringCIM_BGPPathAttributes.PathAttrUnknownNumberNone None
OctetStringbooleantrueNone OVERRIDABLE= false
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