SUMMARY: NESTED | FIELD | | METHOD
DETAIL: FIELD | METHOD

Class CIM_SoftwareElement

CIM_ManagedElement
   extended by CIM_ManagedSystemElement
      extended by CIM_LogicalElement
         extended by CIM_SoftwareElement
Known Subclasses:
CIM_BIOSElement 
class CIM_SoftwareElement
 extends CIM_LogicalElement


General Information:
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.

Qualifiers:
-------------
Version=2.23.0
UMLPackagePath=CIM::Application::DeploymentModel









  
  

    Supported Fields 
      Summary

  

     string 
      
    ElementName 
A 
      user-friendly name for the object . . .

  

     string 
      
    Description 
The 
      Description property provides a textual description of the object.

  

     string 
      
    Caption 
The Caption 
      property is a short textual description (one- line string) of the 
      object.

  

     datetime 
      
    InstallDate 
A 
      datetime value that indicates when the object was installed . . .

  

     uint16[] 
      
    OperationalStatus 
      
Indicates the current statuses of the element . . .

  

     string[] 
      
    StatusDescriptions 
      
Strings describing the various OperationalStatus array values . 
      . .

  

     string 
      
    Status 
A string 
      indicating the current status of the object . . .

  

     uint16 
      
    HealthState 
      
Indicates the current health of the element . . .

  

     string 
      
    Name Key  
The name used to identify this 
      SoftwareElement.

  

     string 
      
    Version Key  
Software Version should be in the form 
      .. or ..

  

     uint16 
      
    SoftwareElementState 
      Key  
The SoftwareElementState is 
      defined in this model to identify various states of a SoftwareElement's 
      life cycle . . .

  

     string 
      
    SoftwareElementID Key  
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.

  

     uint16 
      
    TargetOperatingSystem Key  
The TargetOperatingSystem property 
      specifies the element's operating system environment . . .

  

     string 
      
    OtherTargetOS 
The 
      OtherTargetOS property records the manufacturer and operating system type 
      for a SoftwareElement when the TargetOperatingSystem property has a value 
      of 1 ("Other") . . .

  

     string 
      
    Manufacturer 
      
Manufacturer of this SoftwareElement.

  

     string 
      
    BuildNumber 
The 
      internal identifier for this compilation of SoftwareElement.

  

     string 
      
    SerialNumber 
The 
      assigned serial number of this SoftwareElement.

  

     string 
      
    CodeSet 
The code set 
      used by this SoftwareElement . . .

  

     string 
      
    IdentificationCode 
      
The manufacturer's identifier for this SoftwareElement . . 
    .

  

     string 
      
    LanguageEdition 
      
The value of this property identifies the language edition of 
      this SoftwareElement . . .




  
  

    Methods Summary

  

     
    Create(Instance, 
      ResourceCreated) 
Creates a new instance of this class

  

     
    Put(Instance) 
Changes 
      properties of the selected instance

  

     
    Get(Instance) 
Gets the 
      representation of the instance

  

     
    Delete() 
Deletes an 
      instance

  

     
    Pull(EnumerationContext, 
      MaxElements) 
Pulls instances of this class, following an 
      Enumerate operation

  

     
    Enumerate() 
      
Enumerates the instances of this class

  

     
    Release(EnumerationContext) 
      
Releases an enumeration context

  

     
    Subscribe() 
      
Subscribes to this resource (WS-Eventing)

  

     
    Unsubscribe() 
      
Remove subscription to this resource 
  (WS-Eventing)




  
  

    Field 
Detail


ElementName 
public string ElementName



  
General Information:
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. Note that if there is an associated instance of 
  CIM_EnabledLogicalElementCapabilities, restrictions on this properties may 
  exist as defined in ElementNameMask and MaxElementNameLen properties defined 
  in that 
class.

Qualifiers:
-------------
MaxLen=256


  

  





Description 
public string Description



  
General Information:
The Description property provides a textual 
  description of the 
  object.

Qualifiers:
-------------
MaxLen=256


  

  





Caption 
public string Caption



  
General Information:
The Caption property is a short textual 
  description (one- line string) of the 
  object.

Qualifiers:
-------------
MaxLen=64


  

  





InstallDate 
public datetime InstallDate



  
General Information:
A datetime value that indicates when the 
  object was installed. Lack of a value does not indicate that the object is not 
  installed.

Qualifiers:
-------------
MappingStrings={MIF.DMTF|ComponentID|001.5}


  

  





OperationalStatus 
public uint16[] OperationalStatus



  
General Information:
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. 
  
"Relocating" indicates the element is being 
  relocated.
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.

Qualifiers:
-------------
ValueMap={0, 1, 2, 3, 
  4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, .., 
  0x8000..}
Values={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, Relocating, DMTF Reserved, Vendor 
  Reserved}
ArrayType=Indexed
ModelCorrespondence={CIM_ManagedSystemElement.StatusDescriptions}


  

  





StatusDescriptions 
public string[] StatusDescriptions



  
General Information:
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.

Qualifiers:
-------------
ArrayType=Indexed
ModelCorrespondence={CIM_ManagedSystemElement.OperationalStatus}
MaxLen=256


  

  





Status 
public string Status



  
General Information:
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.

Qualifiers:
-------------
Deprecated={CIM_ManagedSystemElement.OperationalStatus}
ValueMap={OK, 
  Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, 
  NonRecover, No Contact, Lost Comm, Stopped}
MaxLen=10


  

  





HealthState 
public uint16 HealthState



  
General Information:
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.

Qualifiers:
-------------
ValueMap={0, 5, 10, 
  15, 20, 25, 30, .., 32768..65535}
Values={Unknown, OK, Degraded/Warning, 
  Minor failure, Major failure, Critical failure, Non-recoverable error, DMTF 
  Reserved, Vendor Specific}


  

  





Name Key 
public string Name



  
General Information:
The name used to identify this 
  SoftwareElement.

Qualifiers:
-------------
Key
Override=Name
MaxLen=256


  

  





Version Key 
public string Version



  
General Information:
Software Version should be in the form 
  <Major>.<Minor>.<Revision> or 
  <Major>.<Minor><letter><revision>.

Qualifiers:
-------------
Key
MaxLen=64
MappingStrings={MIF.DMTF|SubComponent 
  Software |001.4}


  

  





SoftwareElementState Key 
public uint16 SoftwareElementState



  
General Information:
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.

Qualifiers:
-------------
Key
ValueMap={0, 1, 
  2, 3}
Values={Deployable, Installable, Executable, Running}


  

  





SoftwareElementID Key 
public string SoftwareElementID



  
General Information:
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.

Qualifiers:
-------------
Key
MaxLen=256


  

  





TargetOperatingSystem Key 
public uint16 TargetOperatingSystem



  
General Information:
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.

Qualifiers:
-------------
Key
ValueMap={0, 
  1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 
  23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 
  42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 
  61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 
  80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 
  99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 
  113}
Values={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-Bit, Windows XP 64-Bit, Windows XP Embedded, Windows Vista, 
  Windows Vista 64-Bit, Windows Embedded for Point of Service, Microsoft Windows 
  Server 2008, Microsoft Windows Server 2008 64-Bit, FreeBSD 64-Bit, RedHat 
  Enterprise Linux, RedHat Enterprise Linux 64-Bit, Solaris 64-Bit, SUSE, SUSE 
  64-Bit, SLES, SLES 64-Bit, Novell OES, Novell Linux Desktop, Sun Java Desktop 
  System, Mandriva, Mandriva 64-Bit, TurboLinux, TurboLinux 64-Bit, Ubuntu, 
  Ubuntu 64-Bit, Debian, Debian 64-Bit, Linux 2.4.x, Linux 2.4.x 64-Bit, Linux 
  2.6.x, Linux 2.6.x 64-Bit, Linux 64-Bit, Other 64-Bit, Microsoft Windows 
  Server 2008 R2, VMware ESXi, Microsoft Windows 7, CentOS 32-bit, CentOS 
  64-bit, Oracle Enterprise Linux 32-bit, Oracle Enterprise Linux 64-bit, 
  eComStation 32-bitx, Microsoft Windows Server 2011, Microsoft Windows Server 
  2011 64-Bit, Microsoft Windows Server 
  8}
MappingStrings={MIF.DMTF|SubComponent 
  Software|001.8}
ModelCorrespondence={CIM_OperatingSystem.OSType}


  

  





OtherTargetOS 
public string OtherTargetOS



  
General Information:
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.

Qualifiers:
-------------
MaxLen=64
ModelCorrespondence={CIM_OperatingSystem.OtherTypeDescription}


  

  





Manufacturer 
public string Manufacturer



  
General Information:
Manufacturer of this 
  SoftwareElement.

Qualifiers:
-------------
MaxLen=256
MappingStrings={MIF.DMTF|SubComponent 
  Software|001.3}


  

  





BuildNumber 
public string BuildNumber



  
General Information:
The internal identifier for this 
  compilation of 
  SoftwareElement.

Qualifiers:
-------------
MaxLen=64
MappingStrings={MIF.DMTF|Software 
  Component Information|002.4}


  

  





SerialNumber 
public string SerialNumber



  
General Information:
The assigned serial number of this 
  SoftwareElement.

Qualifiers:
-------------
MaxLen=64
MappingStrings={MIF.DMTF|ComponentID|001.4}


  

  





CodeSet 
public string CodeSet



  
General Information:
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.

Qualifiers:
-------------
MaxLen=64


  

  





IdentificationCode 
public string IdentificationCode



  
General Information:
The manufacturer's identifier for this 
  SoftwareElement. Often this will be a stock keeping unit (SKU) or a part 
  number.

Qualifiers:
-------------
MaxLen=64
MappingStrings={MIF.DMTF|SubComponent 
  Software|001.6}


  

  





LanguageEdition 
public string LanguageEdition



  
General Information:
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.

Qualifiers:
-------------
MaxLen=32
MappingStrings={MIF.DMTF|SubComponent 
  Software|001.7}


  

  






  
  

    Method 
Detail


Create
public  Create([IN]CIM_SoftwareElement Instance, [OUT] REF CIM_SoftwareElement ResourceCreated)



  
Permission Information:
No permissions defined

General 
  Information:
Creates a new instance of this class

Product 
  Specific Usage:
The following properties must be included in any 
  representation of CIM_SoftwareElement: 

Name 
Version 
  
SoftwareElementState 
SoftwareElementID 
TargetOperatingSystem 
  






Put
public  Put([IN]CIM_SoftwareElement Instance)



  
Permission Information:
No permissions defined

General 
  Information:
Changes properties of the selected 
  instance

Product Specific Usage:
The following properties 
  must be included in any representation of CIM_SoftwareElement: 

Name 
  
Version 
SoftwareElementState 
SoftwareElementID 
  
TargetOperatingSystem 






Get
public  Get([OUT]CIM_SoftwareElement Instance)



  
Permission Information:
No permissions defined

General 
  Information:
Gets the representation of the instance





Delete
public  Delete()



  
Permission Information:
No permissions defined

General 
  Information:
Deletes an instance





Pull
public  Pull([IN]String EnumerationContext, [IN]String MaxElements)



  
Permission Information:
All users permitted to use method, only 
  instances to whom the user has permissions will be returned

General 
  Information:
Pulls instances of this class, following an Enumerate 
  operation





Enumerate
public  Enumerate()



  
Permission Information:
All users permitted to use 
  method

General Information:
Enumerates the instances of this 
  class





Release
public  Release([IN]String EnumerationContext)



  
Permission Information:
All users permitted to use 
  method

General Information:
Releases an enumeration 
  context





Subscribe
public  Subscribe()



  
Permission Information:
No permissions defined

General 
  Information:
Subscribes to this resource (WS-Eventing)





Unsubscribe
public  Unsubscribe()



  
Permission Information:
No permissions defined

General 
  Information:
Remove subscription to this resource 
(WS-Eventing)






  
  

    SUMMARY: NESTED | FIELD | METHOD
  

  

    DETAIL: FIELD | METHOD



  
  

    
      
Copyright © 2006-2022, Intel 
      Corporation. All rights 
reserved.