CIM2.14 Class Declaration
CIM_SoftwareIdentity

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_SoftwareIdentity --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_LogicalElement
NAMECIM_SoftwareIdentity

Class Qualifiers

Class CIM_SoftwareIdentity Qualifiers
NameTypeValueFrom Class
Versionstring2.14.0CIM_SoftwareIdentity
UMLPackagePathstringCIM::Core::SoftwareCIM_SoftwareIdentity
DescriptionstringSoftwareIdentity provides descriptive information about a software component for asset tracking and/or installation dependency management. When the IsEntity property has the value TRUE, the instance of SoftwareIdentity represents an individually identifiable entity similar to Physical Element. SoftwareIdentity does NOT indicate whether the software is installed, executing, etc. This extra information may be provided through specialized associations to Software Identity. For instance, both InstalledSoftwareIdentity and ElementSoftwareIdentity may be used to indicate that the software identified by this class is installed. SoftwareIdentity is used when managing the software components of a ManagedElement that is the management focus. Since software may be acquired, SoftwareIdentity can be associated with a Product using the ProductSoftwareComponent relationship. The Application Model manages the deployment and installation of software via the classes, SoftwareFeatures and SoftwareElements. SoftwareFeature and SoftwareElement are used when the software component is the management focus. 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
UMLPackagePathstringCIM::Core::CoreElementsCIM_LogicalElement
DescriptionstringCIM_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
UMLPackagePathstringCIM::Core::CoreElementsCIM_ManagedSystemElement
DescriptionstringCIM_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
UMLPackagePathstringCIM::Core::CoreElementsCIM_ManagedElement
DescriptionstringManagedElement 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

Properties
NameTypeValueQualifiersClassOrigin
InstanceIDstring Key
Description
CIM_SoftwareIdentity
MajorVersionuint16 Description CIM_SoftwareIdentity
MinorVersionuint16 Description CIM_SoftwareIdentity
RevisionNumberuint16 Description CIM_SoftwareIdentity
BuildNumberuint16 Description CIM_SoftwareIdentity
VersionStringstring Description CIM_SoftwareIdentity
TargetOperatingSystemsstring[] Description CIM_SoftwareIdentity
Manufacturerstring Description CIM_SoftwareIdentity
Languagesstring[] Description CIM_SoftwareIdentity
Classificationsuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_SoftwareIdentity
ClassificationDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_SoftwareIdentity
SerialNumberstring Description CIM_SoftwareIdentity
TargetTypesstring[] Experimental
Description
ModelCorrespondence
CIM_SoftwareIdentity
IdentityInfoValuestring[] Experimental
Description
ArrayType
MaxLen
ModelCorrespondence
CIM_SoftwareIdentity
IdentityInfoTypestring[] Experimental
Description
ArrayType
MaxLen
ModelCorrespondence
CIM_SoftwareIdentity
ReleaseDatedatetime Description CIM_SoftwareIdentity
IsEntitybooleanfalseExperimental
Description
CIM_SoftwareIdentity
ExtendedResourceTypeuint16 Experimental
Description
ValueMap
Values
ModelCorrespondence
CIM_SoftwareIdentity
OtherExtendedResourceTypeDescriptionstring Experimental
Description
ModelCorrespondence
CIM_SoftwareIdentity
MinExtendedResourceTypeMajorVersionuint16 Experimental
Description
ModelCorrespondence
CIM_SoftwareIdentity
MinExtendedResourceTypeMinorVersionuint16 Experimental
Description
ModelCorrespondence
CIM_SoftwareIdentity
MinExtendedResourceTypeRevisionNumberuint16 Experimental
Description
ModelCorrespondence
CIM_SoftwareIdentity
MinExtendedResourceTypeBuildNumberuint16 Experimental
Description
ModelCorrespondence
CIM_SoftwareIdentity
TargetOSTypesuint16[] Experimental
Description
ValueMap
Values
ModelCorrespondence
CIM_SoftwareIdentity
InstallDatedatetime Description
MappingStrings
CIM_ManagedSystemElement
Namestring Description
MaxLen
CIM_ManagedSystemElement
OperationalStatusuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
StatusDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
Statusstring Deprecated
Description
ValueMap
MaxLen
CIM_ManagedSystemElement
HealthStateuint16 Description
ValueMap
Values
CIM_ManagedSystemElement
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement
ElementNamestring Description CIM_ManagedElement

Property Qualifiers

Property InstanceID Qualifiers
NameTypeValueFrom Class
KeybooleantrueCIM_SoftwareIdentity
DescriptionstringWithin 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
NameTypeValueFrom Class
DescriptionstringThe 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
NameTypeValueFrom Class
DescriptionstringThe 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
NameTypeValueFrom Class
DescriptionstringThe 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
NameTypeValueFrom Class
DescriptionstringThe build number of the software.CIM_SoftwareIdentity

Property VersionString Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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
NameTypeValueFrom Class
DescriptionstringSpecifies the target operating systems of the software. This property should be used when a target operating system is not listed in the TargetOSTypes array values.CIM_SoftwareIdentity

Property Manufacturer Qualifiers
NameTypeValueFrom Class
DescriptionstringManufacturer of this software.CIM_SoftwareIdentity

Property Languages Qualifiers
NameTypeValueFrom Class
DescriptionstringThe language editions supported by the software. The language codes defined in ISO 639 should be used.CIM_SoftwareIdentity

Property Classifications Qualifiers
NameTypeValueFrom Class
DescriptionstringAn 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. The value 13, Software Bundle, identifies a software package consisting of multiple discrete software instances that can be installed individually or together. Each contained software instance is represented by an instance of SoftwareIdentity that is associated to this instance of SoftwareIdentity instance via a Component association.CIM_SoftwareIdentity
ValueMapstring
[See below.]
CIM_SoftwareIdentity
ValuesstringUnknown
Other
Driver
Configuration Software
Application Software
Instrumentation
Firmware/BIOS
Diagnostic Software
Operating System
Middleware
Firmware
BIOS/FCode
Support/Service Pack
Software Bundle
DMTF Reserved
Vendor Reserved
CIM_SoftwareIdentity
ArrayTypestringIndexedCIM_SoftwareIdentity
ModelCorrespondencestringCIM_SoftwareIdentity.ClassificationDescriptionsCIM_SoftwareIdentity

NameValue
0Unknown
1Other
2Driver
3Configuration Software
4Application Software
5Instrumentation
6Firmware/BIOS
7Diagnostic Software
8Operating System
9Middleware
10Firmware
11BIOS/FCode
12Support/Service Pack
13Software Bundle
..DMTF Reserved
0x8000..0xFFFFVendor Reserved
Property ClassificationDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringAn 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
ArrayTypestringIndexedCIM_SoftwareIdentity
ModelCorrespondencestringCIM_SoftwareIdentity.ClassificationsCIM_SoftwareIdentity

Property SerialNumber Qualifiers
NameTypeValueFrom Class
DescriptionstringA manufacturer-allocated number used to identify the software.CIM_SoftwareIdentity

Property TargetTypes Qualifiers
NameTypeValueFrom Class
DescriptionstringAn array of strings that describes the compatible installer(s). The purpose of the array elements is to establish compatibility between a SoftwareIdentity and a SoftwareInstallationService that can install the SoftwareIdentity by comparing the values of the array elements of this property to the values of SoftwareInstallationServiceCapabilities.SupportedTargetTypes[] property's array elements.CIM_SoftwareIdentity
ModelCorrespondencestringCIM_SoftwareInstallationServiceCapabilities.SupportedTargetTypesCIM_SoftwareIdentity

Property IdentityInfoValue Qualifiers
NameTypeValueFrom Class
DescriptionstringIdentityInfoValue captures additional information that MAY be used by an organization to describe or identify a software instance within the context of the organization. For example, large organizations may have several ways to address or identify a particular instance of software depending on where it is stored; a catalog, a web site, or for whom it is intended; development, customer service, etc. The indexed array property IdentityInfoValue contains 0 or more strings that contain a specific identity info string value. IdentityInfoValue is mapped and indexed to IdentityInfoType. When the IdentityInfoValue property is implemented, the IdentityInfoType property MUST be implemented and shall be formatted using the algorithm provided in the IdentityInfoType property Description.CIM_SoftwareIdentity
ArrayTypestringIndexedCIM_SoftwareIdentity
MaxLenuint32256CIM_SoftwareIdentity
ModelCorrespondencestringCIM_SoftwareIdentity.IdentityInfoTypeCIM_SoftwareIdentity

Property IdentityInfoType Qualifiers
NameTypeValueFrom Class
DescriptionstringAn indexed array of fixed-form strings that provide the description of the type of information that is stored in the corresponding component of the IdentityInfoValue array. The elements of this property array describe the type of the value in the corresponding elements of the IndetityInfoValue array. When the IdentityInfoValue property is implemented, the IdentityInfoType property MUST be implemented. To insure uniqueness the IdentityInfoType property SHOULD be formatted using the following 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 that is creating or defining the IdentityInfoType or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement 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 IdentityInfoType MUST appear between < OrgID > and < LocalID > . < LocalID > is chosen by the business entity and SHOULD NOT be reused to identify different underlying software elements.CIM_SoftwareIdentity
ArrayTypestringIndexedCIM_SoftwareIdentity
MaxLenuint32256CIM_SoftwareIdentity
ModelCorrespondencestringCIM_SoftwareIdentity.IdentityInfoValueCIM_SoftwareIdentity

Property ReleaseDate Qualifiers
NameTypeValueFrom Class
DescriptionstringThe date the software was released.CIM_SoftwareIdentity

Property IsEntity Qualifiers
NameTypeValueFrom Class
DescriptionstringThe IsEntity property is used to indicate whether the SoftwareIdentity corresponds to a discrete copy of the software component or is being used to convey descriptive and identifying information about software that is not present in the management domain. A value of TRUE shall indicate that the SoftwareIdentity instance corresponds to a discrete copy of the software component. A value of FALSE shall indicate that the SoftwareIdentity instance does not correspond to a discrete copy of the Software.CIM_SoftwareIdentity

Property ExtendedResourceType Qualifiers
NameTypeValueFrom Class
DescriptionstringThe binary format type of the installation package of the software. This property can be used to locate a SoftwareInstallationService capable of installing this software.CIM_SoftwareIdentity
ValueMapstring
[See below.]
CIM_SoftwareIdentity
ValuesstringUnknown
Other
Not Applicable
Linux RPM
HP-UX Depot
Windows MSI
Solaris Package
Macintosh Disk Image
Debian linux Package
DMTF Reserved
Vendor Reserved
CIM_SoftwareIdentity
ModelCorrespondencestringCIM_SoftwareIdentity.OtherExtendedResource
CIM_SoftwareIdentity.MinExtendedResourceTypeMajorVersion
CIM_SoftwareIdentity.MinExtendedResourceTypeMinorVersion
CIM_SoftwareIdentity.MinExtendedResourceTypeRevisionNumber
CIM_SoftwareIdentity.MinExtendedResourceTypeBuildNumber
CIM_SoftwareInstallationServiceCapabilities.SupportedExtendedResourceTypes[]
CIM_SoftwareIdentity

NameValue
0Unknown
1Other
2Not Applicable
3Linux RPM
4HP-UX Depot
5Windows MSI
6Solaris Package
7Macintosh Disk Image
8Debian linux Package
9..0x7FFFDMTF Reserved
0x8000..Vendor Reserved
Property OtherExtendedResourceTypeDescription Qualifiers
NameTypeValueFrom Class
DescriptionstringA string describing the binary format type of the installation package of the software when the ExtendedResourceType property has a value of 1 (Other).CIM_SoftwareIdentity
ModelCorrespondencestringCIM_SoftwareIdentity.ExtendedResourceType
CIM_SoftwareIdentity.MinExtendedResourceTypeMajorVersion
CIM_SoftwareIdentity.MinExtendedResourceTypeMinorVersion
CIM_SoftwareIdentity.MinExtendedResourceTypeRevisionNumber
CIM_SoftwareIdentity.MinExtendedResourceTypeBuildNumber
CIM_SoftwareInstallationServiceCapabilities.SupportedExtendedResourceTypes[]
CIM_SoftwareIdentity

Property MinExtendedResourceTypeMajorVersion Qualifiers
NameTypeValueFrom Class
DescriptionstringThis property represents the major number component of the minimum version of the installer, represented by the ExtendedResourceType property, that is required to install this softwareCIM_SoftwareIdentity
ModelCorrespondencestringCIM_SoftwareIdentity.ExtendedResourceType
CIM_SoftwareIdentity.OtherExtendedResourceTypeDescription
CIM_SoftwareInstallationServiceCapabilities.SupportedExtendedResourceTypes[]
CIM_SoftwareInstallationServiceCapabilities.SupportedExtendedResourceTypesMajorVersions[]
CIM_SoftwareIdentity

Property MinExtendedResourceTypeMinorVersion Qualifiers
NameTypeValueFrom Class
DescriptionstringThis property represents the minor number component of the minimum version of the installer, represented by the ExtendedResourceType property, that is required to install this softwareCIM_SoftwareIdentity
ModelCorrespondencestringCIM_SoftwareIdentity.ExtendedResourceType
CIM_SoftwareIdentity.OtherExtendedResourceTypeDescription
CIM_SoftwareInstallationServiceCapabilities.SupportedExtendedResourceTypes[]
CIM_SoftwareInstallationServiceCapabilities.SupportedExtendedResourceTypesMinorVersions[]
CIM_SoftwareIdentity

Property MinExtendedResourceTypeRevisionNumber Qualifiers
NameTypeValueFrom Class
DescriptionstringThis property represents the Revision number component of the minimum version of the installer, represented by the ExtendedResourceType property, that is required to install this softwareCIM_SoftwareIdentity
ModelCorrespondencestringCIM_SoftwareIdentity.ExtendedResourceType
CIM_SoftwareIdentity.OtherExtendedResourceTypeDescription
CIM_SoftwareInstallationServiceCapabilities.SupportedExtendedResourceTypes[]
CIM_SoftwareInstallationServiceCapabilities.SupportedExtendedResourceTypesRevisionNumbers[]
CIM_SoftwareIdentity

Property MinExtendedResourceTypeBuildNumber Qualifiers
NameTypeValueFrom Class
DescriptionstringThis property represents the Build number component of the minimum version of the installer, represented by the ExtendedResourceType property, that is required to install this softwareCIM_SoftwareIdentity
ModelCorrespondencestringCIM_SoftwareIdentity.ExtendedResourceType
CIM_SoftwareIdentity.OtherExtendedResourceTypeDescription
CIM_SoftwareInstallationServiceCapabilities.SupportedExtendedResourceTypes[]
CIM_SoftwareInstallationServiceCapabilities.SupportedExtendedResourceTypesBuildNumbers[]
CIM_SoftwareIdentity

Property TargetOSTypes Qualifiers
NameTypeValueFrom Class
DescriptionstringThe TargetOSTypes property specifies the target operating systems supported by the software. When the target operating system of the software is not listed in the enumeration values, TargetOperatingSystems[] property should be used to specify the target operating system.CIM_SoftwareIdentity
ValueMapstring
[See below.]
CIM_SoftwareIdentity
ValuesstringUnknown
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-Bit
CIM_SoftwareIdentity
ModelCorrespondencestringCIM_OperatingSystem.OSTypeCIM_SoftwareIdentity

NameValue
0Unknown
1Other
2MACOS
3ATTUNIX
4DGUX
5DECNT
6Tru64 UNIX
7OpenVMS
8HPUX
9AIX
10MVS
11OS400
12OS/2
13JavaVM
14MSDOS
15WIN3x
16WIN95
17WIN98
18WINNT
19WINCE
20NCR3000
21NetWare
22OSF
23DC/OS
24Reliant UNIX
25SCO UnixWare
26SCO OpenServer
27Sequent
28IRIX
29Solaris
30SunOS
31U6000
32ASERIES
33HP NonStop OS
34HP NonStop OSS
35BS2000
36LINUX
37Lynx
38XENIX
39VM
40Interactive UNIX
41BSDUNIX
42FreeBSD
43NetBSD
44GNU Hurd
45OS9
46MACH Kernel
47Inferno
48QNX
49EPOC
50IxWorks
51VxWorks
52MiNT
53BeOS
54HP MPE
55NextStep
56PalmPilot
57Rhapsody
58Windows 2000
59Dedicated
60OS/390
61VSE
62TPF
63Windows (R) Me
64Caldera Open UNIX
65OpenBSD
66Not Applicable
67Windows XP
68z/OS
69Microsoft Windows Server 2003
70Microsoft Windows Server 2003 64-Bit
Property InstallDate Qualifiers
NameTypeValueFrom Class
DescriptionstringA datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed.CIM_ManagedSystemElement
MappingStringsstringMIF.DMTF|ComponentID|001.5CIM_ManagedSystemElement

Property Name Qualifiers
NameTypeValueFrom Class
DescriptionstringThe 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
MaxLenuint321024CIM_ManagedSystemElement

Property OperationalStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates 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
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
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 Reserved
CIM_ManagedSystemElement
ArrayTypestringIndexedCIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptionsCIM_ManagedSystemElement

NameValue
0Unknown
1Other
2OK
3Degraded
4Stressed
5Predictive Failure
6Error
7Non-Recoverable Error
8Starting
9Stopping
10Stopped
11In Service
12No Contact
13Lost Communication
14Aborted
15Dormant
16Supporting Entity in Error
17Completed
18Power Mode
..DMTF Reserved
0x8000..Vendor Reserved
Property StatusDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringStrings 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
ArrayTypestringIndexedCIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatusCIM_ManagedSystemElement

Property Status Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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
ValueMapstring
[See below.]
CIM_ManagedSystemElement
MaxLenuint3210CIM_ManagedSystemElement

NameValue
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
NameTypeValueFrom Class
DescriptionstringIndicates 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
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
OK
Degraded/Warning
Minor failure
Major failure
Critical failure
Non-recoverable error
DMTF Reserved
CIM_ManagedSystemElement

NameValue
0Unknown
5OK
10Degraded/Warning
15Minor failure
20Major failure
25Critical failure
30Non-recoverable error
..DMTF Reserved
Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.CIM_ManagedElement
MaxLenuint3264CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object.CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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

Methods

Method Qualifiers

Parameters

Parameter Qualifiers

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_SoftwareIdentityComponentCIM_SoftwareIdentityGroupComponent
CIM_SoftwareIdentityComponentCIM_SoftwareIdentityPartComponent
CIM_ProductSoftwareComponentCIM_SoftwareIdentityPartComponent
CIM_ElementSoftwareIdentityCIM_SoftwareIdentityAntecedent
CIM_InstalledSoftwareIdentityCIM_SoftwareIdentityInstalledSoftware
CIM_LogicalElementPerformsUoWCIM_LogicalElementAntecedent
CIM_ImportedShareRootCIM_LogicalElementAntecedent
CIM_ImportedShareRootCIM_LogicalElementDependent
CIM_LogicalElementUnitOfWorkDefCIM_LogicalElementAntecedent
CIM_SharedElementRootCIM_LogicalElementAntecedent
CIM_OperationLogCIM_LogicalElementDependent
CIM_AllocatedFromStoragePoolCIM_LogicalElementDependent
CIM_ResidesOnExtentCIM_LogicalElementDependent
CIM_AssociatedMemoryCIM_LogicalElementDependent
CIM_AttachedElementCIM_LogicalElementSystemElement
CIM_AttachedElementCIM_LogicalElementSameElement
CIM_MountedElementCIM_LogicalElementSystemElement
CIM_MountedElementCIM_LogicalElementSameElement
CIM_ImportedShareCIM_LogicalElementSystemElement
CIM_ImportedShareCIM_LogicalElementSameElement
CIM_SharedElementCIM_LogicalElementSystemElement
CIM_RedundancyComponentCIM_ManagedSystemElementPartComponent
CIM_SystemComponentCIM_ManagedSystemElementPartComponent
CIM_SuppliesPowerCIM_ManagedSystemElementDependent
CIM_UseOfLogCIM_ManagedSystemElementDependent
CIM_AssociatedSensorCIM_ManagedSystemElementDependent
CIM_DiagnosticTestForMSECIM_ManagedSystemElementDependent
CIM_AssociatedBatteryCIM_ManagedSystemElementDependent
CIM_AssociatedCoolingCIM_ManagedSystemElementDependent
CIM_CollectedMSEsCIM_ManagedSystemElementMember
CIM_DiagnosticResultForMSECIM_ManagedSystemElementSystemElement
CIM_ElementConfigurationCIM_ManagedSystemElementElement
CIM_ElementSettingCIM_ManagedSystemElementElement
CIM_ActsAsSpareCIM_ManagedSystemElementSpare
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement