Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_SpareGroup --> CIM_RedundancyGroup --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_RedundancyGroup NAME CIM_SpareGroup
Class CIM_SpareGroup Qualifiers Name Type Value From Class Version string 2.6.0 CIM_SpareGroup Description string A class derived from RedundancyGroup indicating that one or more of the aggregated elements can be spared. (The actual Spares are defined using the ActsAsSpare association.) An example is the use of redundant NICs in a ComputerSystem - where one NIC is primary and the other is Spare. The ’ primary ’ NIC would be a member of the SpareGroup (associated using the RedundancyComponent class) and the ’ other ’ NIC would be associated using the ActsAsSpare relationship. CIM_SpareGroup Description string A class derived from LogicalElement that is a special collection of ManagedSystemElements. This collection indicates that the aggregated components together provide redundancy. All elements aggregated in a RedundancyGroup should be instantiations of the same object class. CIM_RedundancyGroup 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
Properties Name Type Value Qualifiers ClassOrigin CreationClassName string Key
Description
MaxLenCIM_RedundancyGroup Name string Key
Override
Description
MaxLenCIM_RedundancyGroup RedundancyStatus uint16 Description
ValueMap
ValuesCIM_RedundancyGroup InstallDate datetime Description
MappingStringsCIM_ManagedSystemElement OperationalStatus uint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondenceCIM_ManagedSystemElement StatusDescriptions string[] Description
ArrayType
ModelCorrespondenceCIM_ManagedSystemElement Status string Deprecated
Description
ValueMap
MaxLenCIM_ManagedSystemElement Caption string Description
MaxLenCIM_ManagedElement Description string Description CIM_ManagedElement ElementName string Description CIM_ManagedElement Property Qualifiers
Property CreationClassName Qualifiers Name Type Value From Class Key boolean true CIM_RedundancyGroup 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_RedundancyGroup MaxLen uint32 256 CIM_RedundancyGroup
Property Name Qualifiers Name Type Value From Class Key boolean true CIM_RedundancyGroup Override string Name CIM_RedundancyGroup Description string The RedundancyGroup Name serves as the key for the Group ’ s instance in an enterprise environment. CIM_RedundancyGroup MaxLen uint32 256 CIM_RedundancyGroup
Property RedundancyStatus Qualifiers Name Type Value From Class Description string RedundancyStatus provides information on the state of the RedundancyGroup. " Fully Redundant " (value=2) means that all of the configured redundancy is still available; " Degraded Redundancy " (3) means that some failures have been experienced but some reduced amount of redundancy is still available; " Redundancy Lost " (4) means that a sufficient number of failures have been experienced such that no redundancy is available and the next failure experienced will cause overall failure. Also, the values, " Other " (1) and " Unknown " (0), are defined. CIM_RedundancyGroup ValueMap string [See below.] CIM_RedundancyGroup Values string Unknown
Other
Fully Redundant
Degraded Redundancy
Redundancy LostCIM_RedundancyGroup
Name Value 0 Unknown 1 Other 2 Fully Redundant 3 Degraded Redundancy 4 Redundancy Lost
Property InstallDate Qualifiers Name Type Value From Class Description string A datetime value indicating when the object was installed. A 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 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. 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 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. 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 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 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. CIM_ManagedElement
Name Type Value Qualifiers Parameters ClassOrigin Failover uint32 Description CIM_SpareGroup Method Qualifiers
Method Failover Qualifiers Name Type Value From Class Description string This method is forces a failover from one ManagedSystem Element to another. There are two parameters to the Failover method, FailoverFrom and FailoverTo. The FailoverFrom parameter is a reference to the primary ManagedSystemElement that will become inactive after the method. This Element should be associated with the SpareGroup through the RedundancyComponent relationship. The FailoverTo parameter is a reference to the ManagedSystemElement that will take over for the primary. This Element should be associated with the SpareGroup through the ActsAsSpare association. Once the failover has occurred, the SpareGroup and the Redundancy Component and ActsAsSpare associations will be updated with current status. For example, the ActsAsSpare association that contained the FailoverTo Element will be deleted and a new RedundancyComponent association instantiated in its place. The method should return 0 if successful, 1 if the request is not supported, and some other value if any other error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ may also be specified in the subclass as a Values array qualifier. CIM_SpareGroup Parameters
Parameter Qualifiers