CIM_SoftwareElement class
Represents an individually manageable or deployable part of a CIM_SoftwareFeature.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[Abstract, Version("2.23.0"), UMLPackagePath("CIM::Application::DeploymentModel")]
class CIM_SoftwareElement : CIM_LogicalElement
{
string InstanceID;
string Caption;
string Description;
string ElementName;
datetime InstallDate;
uint16 OperationalStatus[];
string StatusDescriptions[];
string Status;
uint16 HealthState;
uint16 CommunicationStatus;
uint16 DetailedStatus;
uint16 OperatingStatus;
uint16 PrimaryStatus;
string Name;
string Version;
uint16 SoftwareElementState;
string SoftwareElementID;
uint16 TargetOperatingSystem;
string OtherTargetOS;
string Manufacturer;
string BuildNumber;
string SerialNumber;
string CodeSet;
string IdentificationCode;
string LanguageEdition;
};
Members
The CIM_SoftwareElement class has these types of members:
Properties
The CIM_SoftwareElement class has these properties.
-
BuildNumber
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64), MappingStrings ("MIF.DMTF|Software Component Information|002.4")
The internal identifier for the compilation of the software element.
-
-
Caption
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
A short textual description of the object.
This property is inherited from CIM_ManagedElement.
-
-
CodeSet
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
The character encoding used by the software element, such as UTF-8 and ISO8859-1.
-
-
CommunicationStatus
-
-
Data type: uint16
-
Access type: Read-only
Indicates the ability of the instrumentation to communicate with this element. A NULL value indicates that instrumentation does not support this property.
The possible values are.
-
-
Unknown (0)
-
Indicates that the instrumentation cannot report on the CommunicationStatus property at this time.
-
Not Available (1)
-
Indicates that the instrumentation is capable of reporting this property, but intentionally does not for this element.
-
Communication OK (2)
-
Indicates only that communication is established with the element.
-
Lost Communication (3)
-
Indicates that the element has been contacted in the past, but is currently unreachable.
-
No Contact (4)
-
Indicates that the instrumentation has contact information for this element, but has never been able to communicate with it.
-
DMTF Reserved
-
Reserved.
-
Vendor Reserved
-
Reserved.
This property is inherited from CIM_ManagedSystemElement.
Description
-
Data type: string
-
Access type: Read-only
A textual description of the object.
This property is inherited from CIM_ManagedElement.
DetailedStatus
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.PrimaryStatus", "CIM_ManagedSystemElement.HealthState")
Indicates additional status details that complement the PrimaryStatus property. A NULL value indicates that the instrumentation does not support this property.
The possible values are.
Not Available (0)
Indicates that the instrumentation is capable of reporting this property, but intentionally does not report it for this element.
No Additional Information (1)
Indicates that no details have to be added to the PrimaryStatus property, for example when the PrimaryStatus is set to OK.
Stressed (2)
Indicates that the element functions, but requires attention. Overload and overheated are examples of Stressed states.
Predictive Failure (3)
Indicates that an element functions nominally, but predicts a failure in the near future.
Non-Recoverable Error (4)
Indicates that this element is in an error condition that requires human intervention.
Supporting Entity in Error (5)
Indicates that an element on which this element depends is in error. This element might be OK but cannot function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
This property is inherited from CIM_ManagedSystemElement.
ElementName
-
Data type: string
-
Access type: Read-only
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.
This property is inherited from CIM_ManagedElement.
HealthState
-
Data type: uint16
-
Access type: Read-only
Indicates the current health of the element. This attribute expresses the health of this element, but not necessarily the health of its subcomponents.
The possible values are.
Unknown (0)
The implementation cannot report on HealthState at this time.
OK (5)
The element is fully functional and operates within normal operational parameters and without error.
Degraded/Warning (10)
The element is in working order, and all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.
Minor failure (15)
All functionality is available, but some functionality might be degraded.
Major failure (20)
The element is failing. It is possible that some or all of the functionality of this component is degraded or does not work.
Critical failure (25)
The element is nonfunctional, and recovery might not be possible.
Non-recoverable error (30)
The element has completely failed, and recovery is not possible. All functionality that this element provides has been lost.
DMTF Reserved
Reserved.
This property is inherited from CIM_ManagedSystemElement.
IdentificationCode
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64), MappingStrings ("MIF.DMTF|SubComponent Software|001.6")
The manufacturer identifier for the software element. This is often a stock keeping unit (SKU) or a part number.
InstallDate
-
Data type: datetime
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")
Indicates when the object was installed. The lack of a value does not indicate that the object is not installed.
This property is inherited from CIM_ManagedSystemElement.
InstanceID
-
Data type: string
-
Access type: Read-only
Uniquely and opaquely identifies an instance of this class within the scope of the containing namespace.
[!Important]
In order to ensure uniqueness within the namespace, the value of the InstanceID property should be constructed in the following pattern: OrgID:LocalID
OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity that defines the InstanceID, or be a registered ID that is assigned by a recognized global authority. This pattern is similar to the structure of schema class names. In addition, to ensure uniqueness, the first colon in InstanceID must be between the OrgID andLocalID. Therefore the OrgID must not contain a colon (':').
LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.
If the above pattern is not used, the defining entity must assure that the resultant InstanceID value is not re-used across any InstanceID properties that are produced by this provider or other providers for this namespace.
For Distributed Management Task Force (DMTF) defined instances, the pattern must be used with the OrgID set to CIM.
This property is inherited from CIM_ManagedElement.
LanguageEdition
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (32), MappingStrings ("MIF.DMTF|SubComponent Software|001.7")
The language edition of the software element. The language codes defined in the ISO 639 standard should be used. If the element represents a multi-lingual or international version, the string "Multilingual" should be used.
Manufacturer
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (256), MappingStrings ("MIF.DMTF|SubComponent Software|001.3")
The manufacturer of the software element.
Name
The name used to identify the software element.
OperatingStatus
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")
Indicates the current operational condition of the element. This property can be used to provide more detail about the value of the EnabledState property. A NULL value indicates that the instrumentation does not support this property.
The possible values are.
Unknown (0)
Indicates that the instrumentation cannot report on the OperatingStatus property at this time.
Not Available (1)
Indicates that the instrumentation is capable of reporting this property, but intentionally does not report it for this element.
Servicing (2)
Indicates that the element is in process to be configured, maintained, cleaned, or otherwise administered.
Starting (3)
Indicates that the element is being initialized.
Stopping (4)
Indicates that the element is being brought to an orderly stop.
Stopped (5)
Indicates that the element is intentionally stopped.
Aborted (6)
Indicates that the element stopped in an unexpected way.
Dormant (7)
Indicates that the element is inactive.
Completed (8)
Indicates that the element completed its operation. We recommend using a PrimaryStatus property value of OK, Error, or Degraded to indicate success or failure of the operation.
Migrating (9)
Indicates that the element is being moved between host elements.
Emigrating (10)
Indicates that the element is being moved away from the host element.
Immigrating (11)
Indicates that the element is being moved to a new host element.
Snapshotting (12)
Indicates that a snapshot copy of the element is being created.
Shutting Down (13)
Indicates that the element is being brought to an abrupt stop.
In Test (14)
Indicates that the element is performing test functions.
Transitioning (15)
Indicates that the element is between states and is not fully available in either state. Use another value that indicates a more specific transition if one is available.
In Service (16)
Indicates that the element is in service and operational.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
This property is inherited from CIM_ManagedSystemElement.
OperationalStatus
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")
Contains indicators of the current status of the element. The first value of the OperationalStatus property should contain the primary status for the element.
Note
The OperationalStatus property replaces the deprecated Status property. Due to the widespread use of the existing Status property in management applications, we strongly recommend that providers or instrumentation provide both the Status and OperationalStatus properties. When instrumented, Status, because it is a single-valued property, should also provide the primary status of the element.
The possible values are.
Unknown (0)
Indicates that the implementation cannot report on the OperationalStatus property at this time.
Other (1)
Indicates an undefined state.
OK (2)
Indicates full functionality without errors.
Degraded (3)
Indicates that the element is in working order and that all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.
Stressed (4)
Indicates that the element functions, but requires attention. Overload and overheated are examples of Stressed states.
Predictive Failure (5)
Indicates that an element functions nominally, but predicts a failure in the near future.
Error (6)
Indicates that an error has occurred.
Non-Recoverable Error (7)
Indicates that a nonrecoverable error has occurred.
Starting (8)
Indicates that the job is starting.
Stopping (9)
Indicates that the job is stopping.
Stopped (10)
Indicates that the element has been intentionally stopped.
In Service (11)
Indicates that the element is in process to be configured, maintained, cleaned, or otherwise administered.
No Contact (12)
Indicates that the monitoring system has information about this element, but has never been able to establish communications with it.
Lost Communication (13)
Indicates that the monitoring system has successfully contacted this element in the past, but it is currently unavailable.
Aborted (14)
Indicates that the job stopped in an unexpected way. The state and configuration of the job might require an update.
Dormant (15)
Indicates that the job is inactive.
Supporting Entity in Error (16)
Indicates that an element on which this job depends is in error. This element might be OK but cannot function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.
Completed (17)
Indicates that the job has completed its operation. This value should be combined with either OK, Error, or Degraded to indicate to a client whether the complete operation Completed with OK and passed, or completed with Error and failed, or completed with Degraded and finished the operation, but did not complete OK or did not report an error.
Power Mode (18)
Indicates that the element has additional power model information that is contained in the associated power management service.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
This property is inherited from CIM_ManagedSystemElement.
OtherTargetOS
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64), ModelCorrespondence ("CIM_OperatingSystem.OtherTypeDescription")
The manufacturer and operating system type when the TargetOperatingSystem property is set to Other ("1").
PrimaryStatus
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ManagedSystemElement.DetailedStatus", "CIM_ManagedSystemElement.HealthState")
Indicates a high-level status value.
The possible values are.
Unknown (0)
OK (1)
Degraded (2)
Error (3)
DMTF Reserved
Vendor Reserved
This property is inherited from CIM_ManagedSystemElement.
SerialNumber
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64), MappingStrings ("MIF.DMTF|ComponentID|001.4")
The assigned serial number of the software element.
SoftwareElementID
An identifier for the software element to use in conjunction with other keys to create a uniquely identify the element.
SoftwareElementState
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: Key
The life cycle state of the software element.
The possible values are.
Deployable (0)
Installable (1)
Executable (2)
Running (3)
Status
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)
Indicates the primary status of the object.
Note
This property is deprecated. It is replaced by the OperationalStatus property. If you choose to use the Status property for backward compatibility, it should be secondary to the OperationalStatus property.
The possible values are.
"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
"Stressed"
"NonRecover"
"No Contact"
"Lost Comm"
"Stopped"
This property is inherited from CIM_ManagedSystemElement.
StatusDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")
Indicates descriptions of the corresponding values in the OperationalStatus array. For example, if an element in the OperationalStatus property contains the value Stopping, then the element at the same array index in this property might contain an explanation as to why an object is being stopped.
This property is inherited from CIM_ManagedSystemElement.
TargetOperatingSystem
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: Key, MappingStrings ("MIF.DMTF|SubComponent Software|001.8"), ModelCorrespondence ("CIM_OperatingSystem.OSType")
The operating system of the software element. The value of this property does not ensure that it is binary executable.
The possible values are.
Unknown (0)
Other (1)
MACOS (2)
ATTUNIX (3)
DGUX (4)
DECNT (5)
Tru64 UNIX (6)
OpenVMS (7)
HPUX (8)
AIX (9)
MVS (10)
OS400 (11)
OS/2 (12)
JavaVM (13)
MSDOS (14)
WIN3x (15)
WIN95 (16)
WIN98 (17)
WINNT (18)
WINCE (19)
NCR3000 (20)
NetWare (21)
OSF (22)
DC/OS (23)
Reliant UNIX (24)
SCO UnixWare (25)
SCO OpenServer (26)
Sequent (27)
IRIX (28)
Solaris (29)
SunOS (30)
U6000 (31)
ASERIES (32)
HP NonStop OS (33)
HP NonStop OSS (34)
BS2000 (35)
LINUX (36)
Lynx (37)
XENIX (38)
VM (39)
Interactive UNIX (40)
BSDUNIX (41)
FreeBSD (42)
NetBSD (43)
GNU Hurd (44)
OS9 (45)
MACH Kernel (46)
Inferno (47)
QNX (48)
EPOC (49)
IxWorks (50)
VxWorks (51)
MiNT (52)
BeOS (53)
HP MPE (54)
NextStep (55)
PalmPilot (56)
Rhapsody (57)
Windows 2000 (58)
Dedicated (59)
OS/390 (60)
VSE (61)
TPF (62)
Windows (R) Me (63)
Caldera Open UNIX (64)
OpenBSD (65)
Not Applicable (66)
Windows XP (67)
z/OS (68)
Microsoft Windows Server 2003 (69)
Microsoft Windows Server 2003 64-Bit (70)
Windows XP 64-Bit (71)
Windows XP Embedded (72)
Windows Vista (73)
Windows Vista 64-Bit (74)
Windows Embedded for Point of Service (75)
Microsoft Windows Server 2008 (76)
Microsoft Windows Server 2008 64-Bit (77)
FreeBSD 64-Bit (78)
RedHat Enterprise Linux (79)
RedHat Enterprise Linux 64-Bit (80)
Solaris 64-Bit (81)
SUSE (82)
SUSE 64-Bit (83)
SLES (84)
SLES 64-Bit (85)
Novell OES (86)
Novell Linux Desktop (87)
Sun Java Desktop System (88)
Mandriva (89)
Mandriva 64-Bit (90)
TurboLinux (91)
TurboLinux 64-Bit (92)
Ubuntu (93)
Ubuntu 64-Bit (94)
Debian (95)
Debian 64-Bit (96)
Linux 2.4.x (97)
Linux 2.4.x 64-Bit (98)
Linux 2.6.x (99)
Linux 2.6.x 64-Bit (100)
Linux 64-Bit (101)
Other 64-Bit (102)
Microsoft Windows Server 2008 R2 (103)
VMware ESXi (104)
Microsoft Windows 7 (105)
CentOS 32-bit (106)
CentOS 64-bit (107)
Oracle Enterprise Linux 32-bit (108)
Oracle Enterprise Linux 64-bit (109)
eComStation 32-bitx (110)
Version
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key, MaxLen (64), MappingStrings ("MIF.DMTF|SubComponent Software |001.4")
The software version in the format <Major>.<Minor>.<Revision> or <Major>.<Minor><letter><revision>.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2016 |
| Namespace |
Root\HyperVCluster\v2 |
| MOF |
|
| DLL |
|