Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_BGPPathAttributes --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_LogicalElement NAME CIM_BGPPathAttributes
Class CIM_BGPPathAttributes Qualifiers Name Type Value From Class Version string 2.7.0 CIM_BGPPathAttributes Description string This class defines the per-path information used to process specific BGP attribute information, as defined in the bgp4PathAttrTable of RFC 1657. CIM_BGPPathAttributes Description string CIM_LogicalElement is a base class for all the components of a System that represent abstract system components, such as Files, Processes, or LogicalDevices. CIM_LogicalElement Description string CIM_ManagedSystemElement is the base class for the System Element hierarchy. Any distinguishable component of a System is a candidate for inclusion in this class. Examples of system components include: - software components such as application servers, databases, and applications - operating system components such as files, processes, and threads - device components such as disk drives, controllers, processors, and printers - physical components such as chips and cards. CIM_ManagedSystemElement Description string ManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement
Property Qualifiers
Property ASNumbers Qualifiers Name Type Value From Class Key boolean true CIM_BGPPathAttributes Description string A 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. CIM_BGPPathAttributes MaxLen uint32 512 CIM_BGPPathAttributes
Property PathAttrNextHop Qualifiers Name Type Value From Class Key boolean true CIM_BGPPathAttributes Description string This is the address of the border router that should be used for the destination network. CIM_BGPPathAttributes MaxLen uint32 32 CIM_BGPPathAttributes MappingStrings string MIB.IETF|BGP4-MIB.bgp4PathAttrNextHop CIM_BGPPathAttributes
Property PathAttrASPathSegment Qualifiers Name Type Value From Class Description string This 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. CIM_BGPPathAttributes OctetString boolean true CIM_BGPPathAttributes MappingStrings string MIB.IETF|BGP4-MIB.bgp4PathAttrASPathSegment CIM_BGPPathAttributes
Property PathAttrOrigin Qualifiers Name Type Value From Class Description string This 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. CIM_BGPPathAttributes ValueMap string [See below.] CIM_BGPPathAttributes Values string IGP
EGP
IncompleteCIM_BGPPathAttributes MappingStrings string MIB.IETF|BGP4-MIB.bgp4PathAttrOrigin CIM_BGPPathAttributes
Name Value 1 IGP 2 EGP 3 Incomplete
Property PathAttrMultiExitDisc Qualifiers Name Type Value From Class Description string This 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. CIM_BGPPathAttributes MappingStrings string MIB.IETF|BGP4-MIB.bgp4PathAttrMultiExitDisc CIM_BGPPathAttributes
Property PathAttrLocalPref Qualifiers Name Type Value From Class Description string This 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. CIM_BGPPathAttributes MappingStrings string MIB.IETF|BGP4-MIB.bgp4PathAttrLocalPref CIM_BGPPathAttributes
Property PathAttrAtomicAggregate Qualifiers Name Type Value From Class Description string This 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. CIM_BGPPathAttributes ValueMap string [See below.] CIM_BGPPathAttributes Values string Unknown
Less Specific Not Selected
Less Specific SelectedCIM_BGPPathAttributes MappingStrings string MIB.IETF|BGP4-MIB.bgp4PathAttrAtomicAggregate CIM_BGPPathAttributes
Name Value 0 Unknown 1 Less Specific Not Selected 2 Less Specific Selected
Property PathAttrAggregatorAS Qualifiers Name Type Value From Class Description string This 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. CIM_BGPPathAttributes MappingStrings string MIB.IETF|BGP4-MIB.bgp4PathAttrAggregatorAS CIM_BGPPathAttributes
Property PathAttrAggregatorAddr Qualifiers Name Type Value From Class Description string This 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. CIM_BGPPathAttributes MappingStrings string MIB.IETF|BGP4-MIB.bgp4PathAttrAggregatorAddr CIM_BGPPathAttributes
Property PathAttrCalcLocalPref Qualifiers Name Type Value From Class Description string This 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. CIM_BGPPathAttributes MappingStrings string MIB.IETF|BGP4-MIB.bgp4PathAttrCalcLocalPref CIM_BGPPathAttributes
Property PathAttrBest Qualifiers Name Type Value From Class Description string This 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). CIM_BGPPathAttributes ValueMap string [See below.] CIM_BGPPathAttributes Values string Unknown
False
TrueCIM_BGPPathAttributes MappingStrings string MIB.IETF|BGP4-MIB.bgp4PathAttrBest CIM_BGPPathAttributes
Name Value 0 Unknown 1 False 2 True
Property PathAttrUnknown Qualifiers Name Type Value From Class Description string This 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. CIM_BGPPathAttributes OctetString boolean true CIM_BGPPathAttributes MappingStrings string MIB.IETF|BGP4-MIB.bgp4PathAttrUnknown CIM_BGPPathAttributes ModelCorrespondence string CIM_BGPPathAttributes.PathAttrUnknownNumber CIM_BGPPathAttributes
Property PathAttrUnknownNumber Qualifiers Name Type Value From Class Description string The number of unknown attributes in the array, PathAttrUnknown. CIM_BGPPathAttributes MappingStrings string MIB.IETF|BGP4-MIB.bgp4PathAttrUnknown CIM_BGPPathAttributes ModelCorrespondence string CIM_BGPPathAttributes.PathAttrUnknown CIM_BGPPathAttributes
Property InstallDate Qualifiers Name Type Value From Class Description string A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed. CIM_ManagedSystemElement MappingStrings string MIF.DMTF|ComponentID|001.5 CIM_ManagedSystemElement
Property Name Qualifiers Name Type Value From Class Description string The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property. CIM_ManagedSystemElement MaxLen uint32 1024 CIM_ManagedSystemElement
Property OperationalStatus Qualifiers Name Type Value From Class Description string Indicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration ’ s values are self-explanatory. However, a few are not and are described here in more detail. " Stressed " indicates that the element is functioning, but needs attention. Examples of " Stressed " states are overload, overheated, and so on. " 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 state and configuration of the element might need to be updated. " Dormant " indicates that the element is inactive or quiesced. " Supporting Entity in Error " indicates that this element might 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 that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error). " Power Mode " indicates that 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 because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or 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 (because it is single-valued) should also provide the primary status of the element. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement Values string Unknown
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 ReservedCIM_ManagedSystemElement ArrayType string Indexed CIM_ManagedSystemElement ModelCorrespondence string CIM_ManagedSystemElement.StatusDescriptions CIM_ManagedSystemElement
Name Value 0 Unknown 1 Other 2 OK 3 Degraded 4 Stressed 5 Predictive Failure 6 Error 7 Non-Recoverable Error 8 Starting 9 Stopping 10 Stopped 11 In Service 12 No Contact 13 Lost Communication 14 Aborted 15 Dormant 16 Supporting Entity in Error 17 Completed 18 Power Mode .. DMTF Reserved 0x8000.. Vendor Reserved
Property StatusDescriptions Qualifiers Name Type Value From Class Description string Strings 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. CIM_ManagedSystemElement ArrayType string Indexed CIM_ManagedSystemElement ModelCorrespondence string CIM_ManagedSystemElement.OperationalStatus CIM_ManagedSystemElement
Property Status Qualifiers Name Type Value From Class Description string A 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 definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. 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. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement MaxLen uint32 10 CIM_ManagedSystemElement
Name Value OK [none] Error [none] Degraded [none] Unknown [none] Pred Fail [none] Starting [none] Stopping [none] Service [none] Stressed [none] NonRecover [none] No Contact [none] Lost Comm [none] Stopped [none]
Property HealthState Qualifiers Name Type Value From Class Description string Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. The following continuum is defined: " Non-recoverable Error " (30) - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost. " Critical Failure " (25) - The element is non-functional and recovery might not be possible. " Major Failure " (20) - The element is failing. It is possible that some or all of the functionality of this component is degraded or not working. " Minor Failure " (15) - All functionality is available but some might be degraded. " Degraded/Warning " (10) - The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors. " OK " (5) - The element is fully functional and is operating within normal operational parameters and without error. " Unknown " (0) - The implementation cannot report on HealthState at this time. DMTF has reserved the unused portion of the continuum for additional HealthStates in the future. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement Values string Unknown
OK
Degraded/Warning
Minor failure
Major failure
Critical failure
Non-recoverable error
DMTF ReservedCIM_ManagedSystemElement
Name Value 0 Unknown 5 OK 10 Degraded/Warning 15 Minor failure 20 Major failure 25 Critical failure 30 Non-recoverable error .. DMTF Reserved
Property Caption Qualifiers Name Type Value From Class Description string The Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement MaxLen uint32 64 CIM_ManagedElement
Property Description Qualifiers Name Type Value From Class Description string The Description property provides a textual description of the object. CIM_ManagedElement
Property ElementName Qualifiers Name Type Value From Class Description string A 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 the Name property of ManagedSystemElement 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 can be present in both the Name and ElementName properties. CIM_ManagedElement
Method Qualifiers
Parameters
Parameter Qualifiers