Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_RoutingPolicy --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_LogicalElement NAME CIM_RoutingPolicy
Class CIM_RoutingPolicy Qualifiers Name Type Value From Class Version string 2.7.0 CIM_RoutingPolicy Description string This class is used to implement routing policies. It aggregates a set of FilterLists, along with other appropriate constructs, into a unit. One of the most important uses of this class is to change the routing policy by changing values of various attributes in a consistent manner. A RoutingPolicy is weak to the network device (i.e., the ComputerSystem) that contains it. Hence, the ComputerSystem keys are propagated to this class. Note that this class was defined before the Policy Model and hence is not positioned in that hierarchy. The class will be repositioned in a later release of the Network Model. CIM_RoutingPolicy 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 SystemCreationClassName Qualifiers Name Type Value From Class Key boolean true CIM_RoutingPolicy Propagated string CIM_ComputerSystem.CreationClassName CIM_RoutingPolicy Description string The scoping ComputerSystem ’ s CreationClassName. CIM_RoutingPolicy MaxLen uint32 256 CIM_RoutingPolicy
Property SystemName Qualifiers Name Type Value From Class Key boolean true CIM_RoutingPolicy Propagated string CIM_ComputerSystem.Name CIM_RoutingPolicy Description string The scoping ComputerSystem ’ s Name. CIM_RoutingPolicy MaxLen uint32 256 CIM_RoutingPolicy
Property CreationClassName Qualifiers Name Type Value From Class Key boolean true CIM_RoutingPolicy 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. CIM_RoutingPolicy MaxLen uint32 256 CIM_RoutingPolicy
Property Name Qualifiers Name Type Value From Class Key boolean true CIM_RoutingPolicy Override string Name CIM_RoutingPolicy Description string This is the name of the Routing Policy. CIM_RoutingPolicy MaxLen uint32 256 CIM_RoutingPolicy
Property Action Qualifiers Name Type Value From Class Description string This defines the type of action that will be performed if the match conditions of the policy are met. The match conditions are defined by the associated ListsIn RoutingPolicy. There are essentially three choices: forward the traffic unmodified, forward the traffic but modify either the attributes describing the route and/or other attributes that define how to condition the traffic (e.g., its ToS byte settings), or prevent the traffic from being forwarded. CIM_RoutingPolicy ValueMap string [See below.] CIM_RoutingPolicy Values string Accept As Is
Accept With Protocol Attribute Changes
Accept and Remark Packet
Accept With Protocol Attribute Changes and Remark
Accept With Other Action
Accept With Protocol Attribute Changes and Other Action
Accept with Remark and Other Action
Accept with Protocol Attribute Changes, Remark and Other Action
DenyCIM_RoutingPolicy
Name Value 1 Accept As Is 2 Accept With Protocol Attribute Changes 3 Accept and Remark Packet 4 Accept With Protocol Attribute Changes and Remark 5 Accept With Other Action 6 Accept With Protocol Attribute Changes and Other Action 7 Accept with Remark and Other Action 8 Accept with Protocol Attribute Changes, Remark and Other Action 9 Deny
Property AttributeAction Qualifiers Name Type Value From Class Description string This controls whether protocol-specific attributes replace, get prepended, or get appended to their existing values. CIM_RoutingPolicy ValueMap string [See below.] CIM_RoutingPolicy Values string Replace
Prepend
AppendCIM_RoutingPolicy ModelCorrespondence string CIM_RoutingPolicy.BGPAction CIM_RoutingPolicy
Name Value 1 Replace 2 Prepend 3 Append
Property BGPAction Qualifiers Name Type Value From Class Description string This defines one or more BGP-specific attributes that should be used to modify this routing update. CIM_RoutingPolicy ValueMap string [See below.] CIM_RoutingPolicy Values string Origin
AS_Path
NEXT_HOP
Multi_Exit_Disc
Local_Pref
Atomic_Aggregate
Aggregator
Community
Originator_ID
Cluster_ListCIM_RoutingPolicy ModelCorrespondence string CIM_RoutingPolicy.BGPValue CIM_RoutingPolicy
Name Value 1 Origin 2 AS_Path 3 NEXT_HOP 4 Multi_Exit_Disc 5 Local_Pref 6 Atomic_Aggregate 7 Aggregator 8 Community 9 Originator_ID 10 Cluster_List
Property BGPValue Qualifiers Name Type Value From Class Description string The value for the corresponding BGPAction. CIM_RoutingPolicy ModelCorrespondence string CIM_RoutingPolicy.BGPAction CIM_RoutingPolicy
Property RemarkAction Qualifiers Name Type Value From Class Description string This defines a remarking action for this traffic. CIM_RoutingPolicy ValueMap string [See below.] CIM_RoutingPolicy Values string Change DSCP
Change ToS
Change 802.1Q Value
Change CIR
Change CBR
Change ABR
Change VBRCIM_RoutingPolicy ModelCorrespondence string CIM_RoutingPolicy.RemarkValue CIM_RoutingPolicy
Name Value 1 Change DSCP 2 Change ToS 3 Change 802.1Q Value 4 Change CIR 5 Change CBR 6 Change ABR 7 Change VBR
Property RemarkValue Qualifiers Name Type Value From Class Description string The value for the corresponding RemarkAction. CIM_RoutingPolicy ModelCorrespondence string CIM_RoutingPolicy.RemarkAction CIM_RoutingPolicy
Property ConditioningAction Qualifiers Name Type Value From Class Description string This defines another action to be taken for this traffic. CIM_RoutingPolicy ValueMap string [See below.] CIM_RoutingPolicy Values string Other
Input Flow Policing
Output Flow Policing
Input Aggregate Policing
Output Aggregate Policing
Police By Marking Down
Police By Dropping DownCIM_RoutingPolicy ModelCorrespondence string CIM_RoutingPolicy.ConditioningValue
CIM_RoutingPolicy.OtherConditioningActionCIM_RoutingPolicy
Name Value 1 Other 2 Input Flow Policing 3 Output Flow Policing 4 Input Aggregate Policing 5 Output Aggregate Policing 6 Police By Marking Down 7 Police By Dropping Down
Property OtherConditioningAction Qualifiers Name Type Value From Class Description string If the value of the ConditioningAction property of this class is 1, this contains an application-specific type of conditioning that is to be performed. Otherwise, if the ConditioningAction property is any other value, the value of this property should be NULL. CIM_RoutingPolicy ModelCorrespondence string CIM_RoutingPolicy.ConditioningAction CIM_RoutingPolicy
Property ConditioningValue Qualifiers Name Type Value From Class Description string The value for the corresponding ConditioningAction, if appropriate. CIM_RoutingPolicy ModelCorrespondence string CIM_RoutingPolicy.ConditioningAction CIM_RoutingPolicy
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