Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_SoftwareElement --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_LogicalElement NAME CIM_SoftwareElement
Class CIM_SoftwareElement Qualifiers Name Type Value From Class Version string 2.7.0 CIM_SoftwareElement Description string The CIM_SoftwareElement class is used to decompose a CIM_SoftwareFeature object into a set of individually manageable or deployable parts, for a particular platform. A SoftwareElement ’ s platform is uniquely identified by its underlying hardware architecture and operating system (for example Sun Solaris on Sun Sparc or Windows NT on Intel platforms). As such, to understand the details of how the functionality of a particular SoftwareFeature is provided on a particular platform, the CIM_SoftwareElement objects referenced by CIM_SoftwareFeatureSoftwareElements associations are organized in disjoint sets based on the TargetOperatingSystem property. A CIM_SoftwareElement object captures the management details of a part or component in one of four states characterized by the SoftwareElementState property. CIM_SoftwareElement 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 Name Qualifiers Name Type Value From Class Key boolean true CIM_SoftwareElement Override string Name CIM_SoftwareElement Description string The name used to identify this SoftwareElement. CIM_SoftwareElement MaxLen uint32 256 CIM_SoftwareElement
Property Version Qualifiers Name Type Value From Class Key boolean true CIM_SoftwareElement Description string Software Version should be in the form < Major > . < Minor > . < Revision > or < Major > . < Minor > < letter > < revision > . CIM_SoftwareElement MaxLen uint32 64 CIM_SoftwareElement MappingStrings string MIF.DMTF|SubComponent Software |001.4 CIM_SoftwareElement
Property SoftwareElementState Qualifiers Name Type Value From Class Key boolean true CIM_SoftwareElement Description string The SoftwareElementState is defined in this model to identify various states of a SoftwareElement ’ s life cycle. - A SoftwareElement in the deployable state describes the details necessary to successfully distribute it and the details (Checks and Actions) required to move it to the installable state (i.e, the next state). - A SoftwareElement in the installable state describes the details necessary to successfully install it and the details (Checks and Actions) required to create an element in the executable state (i.e., the next state). - A SoftwareElement in the executable state describes the details necessary to successfully start it and the details (Checks and Actions) required to move it to the running state (i.e., the next state). - A SoftwareElement in the running state describes the details necessary to manage the started element. CIM_SoftwareElement ValueMap string [See below.] CIM_SoftwareElement Values string Deployable
Installable
Executable
RunningCIM_SoftwareElement
Name Value 0 Deployable 1 Installable 2 Executable 3 Running
Property SoftwareElementID Qualifiers Name Type Value From Class Key boolean true CIM_SoftwareElement Description string This is an identifier for the SoftwareElement and is designed to be used in conjunction with other keys to create a unique representation of the element. CIM_SoftwareElement MaxLen uint32 256 CIM_SoftwareElement
Property TargetOperatingSystem Qualifiers Name Type Value From Class Key boolean true CIM_SoftwareElement Description string The TargetOperatingSystem property specifies the element ’ s operating system environment. The value of this property does not ensure that it is binary executable. Two other pieces of information are needed. First, the version of the OS needs to be specified using the class, CIM_OSVersion Check. The second piece of information is the architecture that the OS runs on. This information is verified using CIM_ArchitectureCheck. The combination of these constructs clearly identifies the level of OS required for a particular SoftwareElement. CIM_SoftwareElement ValueMap string [See below.] CIM_SoftwareElement Values string Unknown
Other
MACOS
ATTUNIX
DGUX
DECNT
Tru64 UNIX
OpenVMS
HPUX
AIX
MVS
OS400
OS/2
JavaVM
MSDOS
WIN3x
WIN95
WIN98
WINNT
WINCE
NCR3000
NetWare
OSF
DC/OS
Reliant UNIX
SCO UnixWare
SCO OpenServer
Sequent
IRIX
Solaris
SunOS
U6000
ASERIES
HP NonStop OS
HP NonStop OSS
BS2000
LINUX
Lynx
XENIX
VM
Interactive UNIX
BSDUNIX
FreeBSD
NetBSD
GNU Hurd
OS9
MACH Kernel
Inferno
QNX
EPOC
IxWorks
VxWorks
MiNT
BeOS
HP MPE
NextStep
PalmPilot
Rhapsody
Windows 2000
Dedicated
OS/390
VSE
TPF
Windows (R) Me
Caldera Open UNIX
OpenBSD
Not Applicable
Windows XP
z/OS
Microsoft Windows Server 2003
Microsoft Windows Server 2003 64-BitCIM_SoftwareElement MappingStrings string MIF.DMTF|SubComponent Software|001.8 CIM_SoftwareElement ModelCorrespondence string CIM_OperatingSystem.OSType CIM_SoftwareElement
Name Value 0 Unknown 1 Other 2 MACOS 3 ATTUNIX 4 DGUX 5 DECNT 6 Tru64 UNIX 7 OpenVMS 8 HPUX 9 AIX 10 MVS 11 OS400 12 OS/2 13 JavaVM 14 MSDOS 15 WIN3x 16 WIN95 17 WIN98 18 WINNT 19 WINCE 20 NCR3000 21 NetWare 22 OSF 23 DC/OS 24 Reliant UNIX 25 SCO UnixWare 26 SCO OpenServer 27 Sequent 28 IRIX 29 Solaris 30 SunOS 31 U6000 32 ASERIES 33 HP NonStop OS 34 HP NonStop OSS 35 BS2000 36 LINUX 37 Lynx 38 XENIX 39 VM 40 Interactive UNIX 41 BSDUNIX 42 FreeBSD 43 NetBSD 44 GNU Hurd 45 OS9 46 MACH Kernel 47 Inferno 48 QNX 49 EPOC 50 IxWorks 51 VxWorks 52 MiNT 53 BeOS 54 HP MPE 55 NextStep 56 PalmPilot 57 Rhapsody 58 Windows 2000 59 Dedicated 60 OS/390 61 VSE 62 TPF 63 Windows (R) Me 64 Caldera Open UNIX 65 OpenBSD 66 Not Applicable 67 Windows XP 68 z/OS 69 Microsoft Windows Server 2003 70 Microsoft Windows Server 2003 64-Bit
Property OtherTargetOS Qualifiers Name Type Value From Class Description string The OtherTargetOS property records the manufacturer and operating system type for a SoftwareElement when the TargetOperatingSystem property has a value of 1 ( " Other " ). For all other values of TargetOperatingSystem, the OtherTargetOS property is NULL. CIM_SoftwareElement MaxLen uint32 64 CIM_SoftwareElement ModelCorrespondence string CIM_OperatingSystem.OtherTypeDescription CIM_SoftwareElement
Property Manufacturer Qualifiers Name Type Value From Class Description string Manufacturer of this SoftwareElement. CIM_SoftwareElement MaxLen uint32 256 CIM_SoftwareElement MappingStrings string MIF.DMTF|SubComponent Software|001.3 CIM_SoftwareElement
Property BuildNumber Qualifiers Name Type Value From Class Description string The internal identifier for this compilation of SoftwareElement. CIM_SoftwareElement MaxLen uint32 64 CIM_SoftwareElement MappingStrings string MIF.DMTF|Software Component Information|002.4 CIM_SoftwareElement
Property SerialNumber Qualifiers Name Type Value From Class Description string The assigned serial number of this SoftwareElement. CIM_SoftwareElement MaxLen uint32 64 CIM_SoftwareElement MappingStrings string MIF.DMTF|ComponentID|001.4 CIM_SoftwareElement
Property CodeSet Qualifiers Name Type Value From Class Description string The code set used by this SoftwareElement. It defines the bit patterns that a system uses to identify characters. ISO defines various code sets such as UTF-8 and ISO8859-1. CIM_SoftwareElement MaxLen uint32 64 CIM_SoftwareElement
Property IdentificationCode Qualifiers Name Type Value From Class Description string The manufacturer ’ s identifier for this SoftwareElement. Often this will be a stock keeping unit (SKU) or a part number. CIM_SoftwareElement MaxLen uint32 64 CIM_SoftwareElement MappingStrings string MIF.DMTF|SubComponent Software|001.6 CIM_SoftwareElement
Property LanguageEdition Qualifiers Name Type Value From Class Description string The value of this property identifies the language edition of this SoftwareElement. The language codes defined in ISO 639 should be used. Where the element represents a multi-lingual or international version, the string " Multilingual " should be used. CIM_SoftwareElement MaxLen uint32 32 CIM_SoftwareElement MappingStrings string MIF.DMTF|SubComponent Software|001.7 CIM_SoftwareElement
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