Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_SoftwareIdentity --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_LogicalElement NAME CIM_SoftwareIdentity
Class CIM_SoftwareIdentity Qualifiers Name Type Value From Class Version string 2.10.0 CIM_SoftwareIdentity Description string SoftwareIdentity represents software, viewed as an asset and/or individually identifiable entity (similar to Physical Element). It does NOT indicate whether the software is installed, executing, etc. (The latter is the role of the SoftwareFeature/ SoftwareElement classes and the Application Model.) Since software may be acquired, SoftwareIdentity can be associated with a Product using the ProductSoftwareComponent relationship. Note that the Application Model manages the deployment and installation of software via the classes, SoftwareFeatures and SoftwareElements. The deployment/installation concepts are related to the asset/identity one. In fact, a SoftwareIdentity may correspond to a Product, or to one or more SoftwareFeatures or SoftwareElements - depending on the granularity of these classes and the deployment model. The correspondence of Software Identity to Product, SoftwareFeature or SoftwareElement is indicated using the ConcreteIdentity association. Note that there may not be sufficient detail or instrumentation to instantiate ConcreteIdentity. And, if the association is instantiated, some duplication of information may result. For example, the Vendor described in the instances of Product and SoftwareIdentity MAY be the same. However, this is not necessarily true, and it is why vendor and similar information are duplicated in this class. Note that ConcreteIdentity can also be used to describe the relationship of the software to any LogicalFiles that result from installing it. As above, there may not be sufficient detail or instrumentation to instantiate this association. CIM_SoftwareIdentity 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 InstanceID Qualifiers Name Type Value From Class Key boolean true CIM_SoftwareIdentity Description string Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following ’ preferred ’ algorithm: < OrgID > : < LocalID > Where < OrgID > and < LocalID > are separated by a colon ’ : ’ , and where < OrgID > MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This is similar to the < Schema Name > _ < Class Name > structure of Schema class names.) In addition, to ensure uniqueness < OrgID > MUST NOT contain a colon ( ’ : ’ ). When using this algorithm, the first colon to appear in InstanceID MUST appear between < OrgID > and < LocalID > . < LocalID > is chosen by the business entity and SHOULD not be re-used to identify different underlying (real-world) elements. If the above ’ preferred ’ algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance ’ s NameSpace. For DMTF defined instances, the ’ preferred ’ algorithm MUST be used with the < OrgID > set to ’ CIM ’ . CIM_SoftwareIdentity
Property MajorVersion Qualifiers Name Type Value From Class Description string The major number component of the software ’ s version information - for example, ’ 12 ’ from version 12.1(3)T. This property is defined as a numeric value to allow the determination of ’ newer ’ vs. ’ older ’ releases. A ’ newer ’ major release is indicated by a larger numeric value. CIM_SoftwareIdentity
Property MinorVersion Qualifiers Name Type Value From Class Description string The minor number component of the software ’ s version information - for example, ’ 1 ’ from version 12.1(3)T. This property is defined as a numeric value to allow the determination of ’ newer ’ vs. ’ older ’ releases. A ’ newer ’ minor release is indicated by a larger numeric value. CIM_SoftwareIdentity
Property RevisionNumber Qualifiers Name Type Value From Class Description string The revision or maintenance release component of the software ’ s version information - for example, ’ 3 ’ from version 12.1(3)T. This property is defined as a numeric value to allow the determination of ’ newer ’ vs. ’ older ’ releases. A ’ newer ’ revision is indicated by a larger numeric value. CIM_SoftwareIdentity
Property BuildNumber Qualifiers Name Type Value From Class Description string The build number of the software. CIM_SoftwareIdentity
Property VersionString Qualifiers Name Type Value From Class Description string A string representing the complete software version information - for example, ’ 12.1(3)T ’ . This string and the numeric major/minor/revision/build properties are complementary. Since vastly different representations and semantics exist for versions, it is not assumed that one representation is sufficient to permit a client to perform computations (i.e., the values are numeric) and a user to recognize the software ’ s version (i.e., the values are understandable and readable). Hence, both numeric and string representations of version are provided. CIM_SoftwareIdentity
Property TargetOperatingSystems Qualifiers Name Type Value From Class Description string Specifies the target operating systems of the software. Due to the extreme variability in operating systems, this property is defined as a string array. CIM_SoftwareIdentity
Property Manufacturer Qualifiers Name Type Value From Class Description string Manufacturer of this software. CIM_SoftwareIdentity
Property Languages Qualifiers Name Type Value From Class Description string The language editions supported by the software. The language codes defined in ISO 639 should be used. CIM_SoftwareIdentity
Property Classifications Qualifiers Name Type Value From Class Description string An array of enumerated integers that classify this software. For example, the software MAY be instrumentation (value=5) or firmware and diagnostic software (10 and 7). The use of value 6, Firmware/BIOS, is being deprecated. Instead, either the value 10 (Firmware) and/or 11 (BIOS/FCode) SHOULD be used. CIM_SoftwareIdentity ValueMap string [See below.] CIM_SoftwareIdentity Values string Unknown
Other
Driver
Configuration Software
Application Software
Instrumentation
Firmware/BIOS
Diagnostic Software
Operating System
Middleware
Firmware
BIOS/FCode
Support/Service Pack
DMTF Reserved
Vendor ReservedCIM_SoftwareIdentity ArrayType string Indexed CIM_SoftwareIdentity ModelCorrespondence string CIM_SoftwareIdentity.ClassificationDescriptions CIM_SoftwareIdentity
Name Value 0 Unknown 1 Other 2 Driver 3 Configuration Software 4 Application Software 5 Instrumentation 6 Firmware/BIOS 7 Diagnostic Software 8 Operating System 9 Middleware 10 Firmware 11 BIOS/FCode 12 Support/Service Pack .. DMTF Reserved 0x8000..0xFFFF Vendor Reserved
Property ClassificationDescriptions Qualifiers Name Type Value From Class Description string An array of free-form strings providing more detailed explanations for any of the entries in the Classifications array. Note that each entry is related to one in the Classifications array located at the same index. CIM_SoftwareIdentity ArrayType string Indexed CIM_SoftwareIdentity ModelCorrespondence string CIM_SoftwareIdentity.Classifications CIM_SoftwareIdentity
Property SerialNumber Qualifiers Name Type Value From Class Description string A manufacturer-allocated number used to identify the software. CIM_SoftwareIdentity
Property TargetType Qualifiers Name Type Value From Class Description string An application specific invariant identifier that will be consistent between versions of a SoftwareIdentity. It will also be consistent across more major changes to the Software Identity naming structure. The purpose of the property is to allow available, uninstalled Software Identities to be matched against an installed Software Identity by a client for version management, or to locate a SoftwareInstallationService that can install the SoftwareIdentity. CIM_SoftwareIdentity ModelCorrespondence string CIM_SoftwareInstallationServiceCapabilities.SupportedTargetTypes CIM_SoftwareIdentity
Property ReleaseDate Qualifiers Name Type Value From Class Description string The date the software was released. CIM_SoftwareIdentity
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