CIM211 Class Declaration
CIM_OperatingSystem

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

Class Hierarchy

CIM_OperatingSystem --> CIM_EnabledLogicalElement --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_EnabledLogicalElement
NAMECIM_OperatingSystem

Class Qualifiers

Class CIM_OperatingSystem Qualifiers
NameTypeValueFrom Class
Versionstring2.7.0 CIM_OperatingSystem
DescriptionstringAn OperatingSystem is software/firmware that makes a ComputerSystem ’ s hardware usable, and implements and/or manages the resources, file systems, processes, user interfaces, services, ... available on the ComputerSystem. CIM_OperatingSystem
DescriptionstringThis class extends LogicalElement to abstract the concept of an element that is enabled and disabled, such as a LogicalDevice or a ServiceAccessPoint. CIM_EnabledLogicalElement
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
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
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
CSCreationClassNamestring Key
Propagated
Description
MaxLen
CIM_OperatingSystem
CSNamestring Key
Propagated
Description
MaxLen
CIM_OperatingSystem
CreationClassNamestring Key
Description
MaxLen
CIM_OperatingSystem
Namestring Key
Override
Description
MaxLen
MappingStrings
CIM_OperatingSystem
OSTypeuint16 Description
ValueMap
Values
ModelCorrespondence
CIM_OperatingSystem
OtherTypeDescriptionstring Description
MaxLen
ModelCorrespondence
CIM_OperatingSystem
Versionstring Description
MappingStrings
CIM_OperatingSystem
LastBootUpTimedatetime Description
MappingStrings
CIM_OperatingSystem
LocalDateTimedatetime Description
MappingStrings
CIM_OperatingSystem
CurrentTimeZonesint16 Description
Units
CIM_OperatingSystem
NumberOfLicensedUsersuint32 Description CIM_OperatingSystem
NumberOfUsersuint32 Description
Gauge
MappingStrings
CIM_OperatingSystem
NumberOfProcessesuint32 Description
Gauge
MappingStrings
CIM_OperatingSystem
MaxNumberOfProcessesuint32 Description
MappingStrings
CIM_OperatingSystem
TotalSwapSpaceSizeuint64 Description
Units
CIM_OperatingSystem
TotalVirtualMemorySizeuint64 Description
Units
MappingStrings
CIM_OperatingSystem
FreeVirtualMemoryuint64 Description
Units
Gauge
MappingStrings
CIM_OperatingSystem
FreePhysicalMemoryuint64 Description
Units
Gauge
MappingStrings
CIM_OperatingSystem
TotalVisibleMemorySizeuint64 Description
Units
CIM_OperatingSystem
SizeStoredInPagingFilesuint64 Description
Units
MappingStrings
CIM_OperatingSystem
FreeSpaceInPagingFilesuint64 Description
Units
Gauge
MappingStrings
CIM_OperatingSystem
MaxProcessMemorySizeuint64 Description
Units
CIM_OperatingSystem
Distributedboolean Description CIM_OperatingSystem
MaxProcessesPerUseruint32 Description CIM_OperatingSystem
EnabledStateuint165 Description
ValueMap
Values
ModelCorrespondence
CIM_EnabledLogicalElement
OtherEnabledStatestring Description
ModelCorrespondence
CIM_EnabledLogicalElement
RequestedStateuint1612 Description
ValueMap
Values
ModelCorrespondence
CIM_EnabledLogicalElement
EnabledDefaultuint162 Write
Description
ValueMap
Values
CIM_EnabledLogicalElement
TimeOfLastStateChangedatetime Description CIM_EnabledLogicalElement
InstallDatedatetime Description
MappingStrings
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 CSCreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_OperatingSystem
PropagatedstringCIM_ComputerSystem.CreationClassName CIM_OperatingSystem
DescriptionstringThe scoping ComputerSystem ’ s CreationClassName. CIM_OperatingSystem
MaxLenuint32256 CIM_OperatingSystem

Property CSName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_OperatingSystem
PropagatedstringCIM_ComputerSystem.Name CIM_OperatingSystem
DescriptionstringThe scoping ComputerSystem ’ s Name. CIM_OperatingSystem
MaxLenuint32256 CIM_OperatingSystem

Property CreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_OperatingSystem
DescriptionstringCreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified. CIM_OperatingSystem
MaxLenuint32256 CIM_OperatingSystem

Property Name Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_OperatingSystem
OverridestringName CIM_OperatingSystem
DescriptionstringThe inherited Name serves as key of an OperatingSystem instance within a ComputerSystem. CIM_OperatingSystem
MaxLenuint32256 CIM_OperatingSystem
MappingStringsstringMIF.DMTF|Operating System|001.2 CIM_OperatingSystem

Property OSType Qualifiers
NameTypeValueFrom Class
DescriptionstringA integer indicating the type of OperatingSystem. CIM_OperatingSystem
ValueMapstring
[See below.]
CIM_OperatingSystem
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_OperatingSystem
ModelCorrespondencestringCIM_OperatingSystem.OtherTypeDescription
CIM_SoftwareElement.TargetOperatingSystem
CIM_OperatingSystem

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 OtherTypeDescription Qualifiers
NameTypeValueFrom Class
DescriptionstringA string describing the manufacturer and OperatingSystem type - used when the OperatingSystem property, OSType, is set to 1 or 59 ( " Other " or " Dedicated " ). The format of the string inserted in OtherTypeDescription should be similar in format to the Values strings defined for OSType. OtherTypeDescription should be set to NULL when OSType is any value other than 1 or 59. CIM_OperatingSystem
MaxLenuint3264 CIM_OperatingSystem
ModelCorrespondencestringCIM_OperatingSystem.OSType CIM_OperatingSystem

Property Version Qualifiers
NameTypeValueFrom Class
DescriptionstringA string describing the Operating System ’ s version number. The format of the version information is as follows: < Major Number > . < Minor Number > . < Revision > or < Major Number > . < Minor Number > . < Revision Letter > . CIM_OperatingSystem
MappingStringsstringMIF.DMTF|Operating System|001.3 CIM_OperatingSystem

Property LastBootUpTime Qualifiers
NameTypeValueFrom Class
DescriptionstringTime when the OperatingSystem was last booted. CIM_OperatingSystem
MappingStringsstringMIF.DMTF|General Information|001.5 CIM_OperatingSystem

Property LocalDateTime Qualifiers
NameTypeValueFrom Class
DescriptionstringOperatingSystem ’ s notion of the local date and time of day. CIM_OperatingSystem
MappingStringsstringMIB.IETF|HOST-RESOURCES-MIB.hrSystemDate
MIF.DMTF|General Information|001.6
CIM_OperatingSystem

Property CurrentTimeZone Qualifiers
NameTypeValueFrom Class
DescriptionstringCurrentTimeZone indicates the number of minutes the OperatingSystem is offset from Greenwich Mean Time. Either the number is positive, negative or zero. CIM_OperatingSystem
UnitsstringMinutes CIM_OperatingSystem

Property NumberOfLicensedUsers Qualifiers
NameTypeValueFrom Class
DescriptionstringNumber of user licenses for the OperatingSystem. If unlimited, enter 0. CIM_OperatingSystem

Property NumberOfUsers Qualifiers
NameTypeValueFrom Class
DescriptionstringNumber of user sessions for which the OperatingSystem is currently storing state information. CIM_OperatingSystem
Gaugebooleantrue CIM_OperatingSystem
MappingStringsstringMIF.DMTF|Host System|001.4
MIB.IETF|HOST-RESOURCES-MIB.hrSystemNumUsers
CIM_OperatingSystem

Property NumberOfProcesses Qualifiers
NameTypeValueFrom Class
DescriptionstringNumber of process contexts currently loaded or running on the OperatingSystem. CIM_OperatingSystem
Gaugebooleantrue CIM_OperatingSystem
MappingStringsstringMIF.DMTF|Host System|001.5
MIB.IETF|HOST-RESOURCES-MIB.hrSystemProcesses
CIM_OperatingSystem

Property MaxNumberOfProcesses Qualifiers
NameTypeValueFrom Class
DescriptionstringMaximum number of process contexts the OperatingSystem can support. If there is no fixed maximum, the value should be 0. On systems that have a fixed maximum, this object can help diagnose failures that occur when the maximum is reached. CIM_OperatingSystem
MappingStringsstringMIF.DMTF|Host System|001.6
MIB.IETF|HOST-RESOURCES-MIB.hrSystemMaxProcesses
CIM_OperatingSystem

Property TotalSwapSpaceSize Qualifiers
NameTypeValueFrom Class
DescriptionstringTotal swap space in Kbytes. This value may be NULL (unspecified) if swap space is not distinguished from page files. However, some Operating Systems distinguish these concepts. For example, in UNIX, whole processes can be ’ swapped out ’ when the free page list falls and remains below a specified amount. CIM_OperatingSystem
UnitsstringKiloBytes CIM_OperatingSystem

Property TotalVirtualMemorySize Qualifiers
NameTypeValueFrom Class
DescriptionstringNumber of Kbytes of virtual memory. For example, this may be calculated by adding the amount of total RAM to the amount of paging space (ie, adding the amount of memory in/aggregated by the ComputerSystem to the property, SizeStoredInPagingFiles. CIM_OperatingSystem
UnitsstringKiloBytes CIM_OperatingSystem
MappingStringsstringMIF.DMTF|System Memory Settings|001.5 CIM_OperatingSystem

Property FreeVirtualMemory Qualifiers
NameTypeValueFrom Class
DescriptionstringNumber of Kbytes of virtual memory currently unused and available. For example, this may be calculated by adding the amount of free RAM to the amount of free paging space (ie, adding the properties, FreePhysicalMemory and FreeSpace InPagingFiles). CIM_OperatingSystem
UnitsstringKiloBytes CIM_OperatingSystem
Gaugebooleantrue CIM_OperatingSystem
MappingStringsstringMIF.DMTF|System Memory Settings|001.6 CIM_OperatingSystem

Property FreePhysicalMemory Qualifiers
NameTypeValueFrom Class
DescriptionstringNumber of Kbytes of physical memory currently unused and available. CIM_OperatingSystem
UnitsstringKiloBytes CIM_OperatingSystem
Gaugebooleantrue CIM_OperatingSystem
MappingStringsstringMIF.DMTF|System Memory Settings|001.2
MIF.UNIX|Host Physical Memory|6.1
CIM_OperatingSystem

Property TotalVisibleMemorySize Qualifiers
NameTypeValueFrom Class
DescriptionstringThe total amount of physical memory (in Kbytes) available to the OperatingSystem. This value does not necessarily indicate the true amount of physical memory, but what is reported to the OperatingSystem as available to it. CIM_OperatingSystem
UnitsstringKiloBytes CIM_OperatingSystem

Property SizeStoredInPagingFiles Qualifiers
NameTypeValueFrom Class
DescriptionstringThe total number of KBytes that can be stored in the OperatingSystem ’ s paging files. 0 indicates that there are no paging files. CIM_OperatingSystem
UnitsstringKiloBytes CIM_OperatingSystem
MappingStringsstringMIF.DMTF|System Memory Settings|001.3 CIM_OperatingSystem

Property FreeSpaceInPagingFiles Qualifiers
NameTypeValueFrom Class
DescriptionstringThe total number of KBytes that can be mapped into the OperatingSystem ’ s paging files without causing any other pages to be swapped out. 0 indicates that there are no paging files. CIM_OperatingSystem
UnitsstringKiloBytes CIM_OperatingSystem
Gaugebooleantrue CIM_OperatingSystem
MappingStringsstringMIF.DMTF|System Memory Settings|001.4 CIM_OperatingSystem

Property MaxProcessMemorySize Qualifiers
NameTypeValueFrom Class
DescriptionstringMaximum number of Kbytes of memory that can be allocated to a Process. For Operating Systems with no virtual memory, this value is typically equal to the total amount of physical Memory minus memory used by the BIOS and OS. For some Operating Systems, this value may be infinity - in which case, 0 should be entered. In other cases, this value could be a constant - for example, 2G or 4G. CIM_OperatingSystem
UnitsstringKiloBytes CIM_OperatingSystem

Property Distributed Qualifiers
NameTypeValueFrom Class
DescriptionstringBoolean indicating whether the OperatingSystem is distributed across several ComputerSystem nodes. If so, these nodes should be grouped as a Cluster. CIM_OperatingSystem

Property MaxProcessesPerUser Qualifiers
NameTypeValueFrom Class
DescriptionstringA value that indicates the maximum processes that a user can have associate with it. CIM_OperatingSystem

Property EnabledState Qualifiers
NameTypeValueFrom Class
DescriptionstringEnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled and disabled states: Enabled (2) indicates that the element is or could be executing commands, will process any queued commands, and queues new requests. Disabled (3) indicates that the element will not execute commands and will drop any new requests. Shutting Down (4) indicates that the element is in the process of going to a Disabled state. Not Applicable (5) indicates the element does not support being enabled or disabled. Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests. Test (7) indicates that the element is in a test state. Deferred (8) indicates that the element might be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The behavior of the element is similar to the Enabled state, but it processes only a restricted set of commands. All other requests are queued. Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringUnknown
Other
Enabled
Disabled
Shutting Down
Not Applicable
Enabled but Offline
In Test
Deferred
Quiesce
Starting
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.OtherEnabledState CIM_EnabledLogicalElement

NameValue
0Unknown
1Other
2Enabled
3Disabled
4Shutting Down
5Not Applicable
6Enabled but Offline
7In Test
8Deferred
9Quiesce
10Starting
11..32767DMTF Reserved
32768..65535Vendor Reserved
Property OtherEnabledState Qualifiers
NameTypeValueFrom Class
DescriptionstringA string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ( " Other " ). This property must be set to null when EnabledState is any value other than 1. CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement

Property RequestedState Qualifiers
NameTypeValueFrom Class
DescriptionstringRequestedState is an integer enumeration that indicates the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. Note that when EnabledState is set to 5 ( " Not Applicable " ), then this property has no meaning. By default, the RequestedState of the element is 5 ( " No Change " ). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration. It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are " Reboot " (10) and " Reset " (11). Reboot refers to doing a " Shut Down " and then moving to an " Enabled " state. Reset indicates that the element is first " Disabled " and then " Enabled " . The distinction between requesting " Shut Down " and " Disabled " should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code. A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ( " Not Applicable " ) is used. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Shut Down
No Change
Offline
Test
Deferred
Quiesce
Reboot
Reset
Not Applicable
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement

NameValue
2Enabled
3Disabled
4Shut Down
5No Change
6Offline
7Test
8Deferred
9Quiesce
10Reboot
11Reset
12Not Applicable
..DMTF Reserved
32768..65535Vendor Reserved
Property EnabledDefault Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_EnabledLogicalElement
DescriptionstringAn enumerated value indicating an administrator ’ s default or startup configuration for the Enabled State of an element. By default, the element is " Enabled " (value=2). CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Not Applicable
Enabled but Offline
No Default
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement

NameValue
2Enabled
3Disabled
5Not Applicable
6Enabled but Offline
7No Default
8..32767DMTF Reserved
32768..65535Vendor Reserved
Property TimeOfLastStateChange Qualifiers
NameTypeValueFrom Class
DescriptionstringThe date or time when the EnabledState of the element last changed. If the state of the element has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated. CIM_EnabledLogicalElement

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.5 CIM_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
MaxLenuint321024 CIM_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
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptions CIM_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
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatus CIM_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
MaxLenuint3210 CIM_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
MaxLenuint3264 CIM_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

NameTypeValueQualifiersParametersClassOrigin
Rebootuint32 Description  CIM_OperatingSystem
Shutdownuint32 Description  CIM_OperatingSystem
RequestStateChangeuint32 Description
ValueMap
Values
ModelCorrespondence
RequestedState
TimeoutPeriod
CIM_EnabledLogicalElement

Method Qualifiers

Method Reboot Qualifiers
NameTypeValueFrom Class
DescriptionstringRequests a reboot of the OperatingSystem. The return value should be 0 if the request was successfully executed, 1 if the request is not supported and some other value if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ may also be specified in the subclass as a Values array qualifier. CIM_OperatingSystem

Method Shutdown Qualifiers
NameTypeValueFrom Class
DescriptionstringRequests a shutdown of the OperatingSystem. The return value should be 0 if the request was successfully executed, 1 if the request is not supported and some other value if an error occurred. It is up to the implementation or subclass of OperatingSystem to establish dependencies between the Shutdown and Reboot methods, and for example, to provide more sophisticated capabilities such as scheduled shutdown/ reboot, etc. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ may also be specified in the subclass as a Values array qualifier. CIM_OperatingSystem

Method RequestStateChange Qualifiers
NameTypeValueFrom Class
DescriptionstringRequests that the state of the element be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the EnabledState and RequestedState of the element will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or lost. If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringCompleted with No Error
Not Supported
Unknown or Unspecified Error
Cannot complete within Timeout Period
Failed
Invalid Parameter
In Use
DMTF Reserved
Method Parameters Checked - Job Started
Invalid State Transition
Use of Timeout Parameter Not Supported
Busy
Method Reserved
Vendor Specific
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement

Parameters

Method RequestStateChange Parameters
NameTypeQualifiers
RequestedStateuint16IN
Description
ValueMap
Values
ModelCorrespondence
TimeoutPerioddatetimeIN
Description

Parameter Qualifiers

Parameter RequestedState Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_EnabledLogicalElement
DescriptionstringThe state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ( ’ Completed with No Error ’ ), 3 ( ’ Timeout ’ ), or 4096 (0x1000) ( ’ Job Started ’ ). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Shut Down
Offline
Test
Defer
Quiesce
Reboot
Reset
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement

Parameter TimeoutPeriod Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_EnabledLogicalElement
DescriptionstringA timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of ’ Use Of Timeout Parameter Not Supported ’ must be returned. CIM_EnabledLogicalElement

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_OperatingSystemSoftwareFeatureCIM_OperatingSystemGroupComponent
CIM_InstalledOSCIM_OperatingSystemPartComponent
CIM_OSProcessCIM_OperatingSystemGroupComponent
CIM_BootOSFromFSCIM_OperatingSystemDependent
CIM_RunningOSCIM_OperatingSystemAntecedent
CIM_ReplicaPoolForStorageCIM_EnabledLogicalElementAntecedent
CIM_RemoteAccessAvailableToElementCIM_EnabledLogicalElementDependent
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_UseOfLogCIM_ManagedSystemElementDependent
CIM_DiagnosticTestForMSECIM_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