Class CIM_OperatingSystem
extends CIM_EnabledLogicalElement

An 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.

Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_OperatingSystem

Direct Known Subclasses

None.

Class Qualifiers

NameData TypeValueScopeFlavors
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.None TRANSLATABLE= true
Versionstring2.7.0TOSUBCLASS= falseTRANSLATABLE= true

Local Class Properties

NameData TypeQualifiers
NameData TypeValueScopeFlavors
Captionstring
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.None TRANSLATABLE= true
MaxLenuint3264None None
CreationClassNamestring
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.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
CSCreationClassNamestring
DescriptionstringThe scoping ComputerSystem's CreationClassName.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_ComputerSystem.CreationClassNameNone OVERRIDABLE= false
CSNamestring
DescriptionstringThe scoping ComputerSystem's Name.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_ComputerSystem.NameNone OVERRIDABLE= false
CurrentTimeZonesint16
DescriptionstringCurrentTimeZone indicates the number of minutes the OperatingSystem is offset from Greenwich Mean Time. Either the number is positive, negative or zero.None TRANSLATABLE= true
UnitsstringMinutesNone TRANSLATABLE= true
Descriptionstring
DescriptionstringThe Description property provides a textual description of the object.None TRANSLATABLE= true
Distributedboolean
DescriptionstringBoolean indicating whether the OperatingSystem is distributed across several ComputerSystem nodes. If so, these nodes should be grouped as a Cluster.None TRANSLATABLE= true
ElementNamestring
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 ManagedSystemElement's Name property 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 MAY be present in both the Name and ElementName properties.None TRANSLATABLE= true
EnabledDefaultuint16
DescriptionstringAn enumerated value indicating an administrator's default/startup configuration for an element's Enabled State. By default, the element is "Enabled" (value=2).None TRANSLATABLE= true
ValueMapstring2, 3, 5, 6, 7, 8..32767, 32768..65535None None
ValuesstringEnabled, Disabled, Not Applicable, Enabled but Offline, No Default, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
WritebooleantrueNone None
EnabledStateuint16
DescriptionstringEnabledState is an integer enumeration that indicates the enabled/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/disabled states: Enabled (2) indicates that the element is/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 doesn't support being enabled/disabled. Enabled but Offline (6) indicates that the element may 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 may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element's behavior is similar to the Enabled state, but it only processes 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.None TRANSLATABLE= true
ModelCorrespondencestringCIM_EnabledLogicalElement.OtherEnabledStateNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11..32767, 32768..65535None None
ValuesstringUnknown, Other, Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
FreePhysicalMemoryuint64
DescriptionstringNumber of Kbytes of physical memory currently unused and available.None TRANSLATABLE= true
GaugebooleantrueNone None
MappingStringsstringMIF.DMTF|System Memory Settings|001.2, MIF.UNIX|Host Physical Memory|6.1None None
UnitsstringKiloBytesNone TRANSLATABLE= true
FreeSpaceInPagingFilesuint64
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.None TRANSLATABLE= true
GaugebooleantrueNone None
MappingStringsstringMIF.DMTF|System Memory Settings|001.4None None
UnitsstringKiloBytesNone TRANSLATABLE= true
FreeVirtualMemoryuint64
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).None TRANSLATABLE= true
GaugebooleantrueNone None
MappingStringsstringMIF.DMTF|System Memory Settings|001.6None None
UnitsstringKiloBytesNone TRANSLATABLE= true
InstallDatedatetime
DescriptionstringA datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.None TRANSLATABLE= true
MappingStringsstringMIF.DMTF|ComponentID|001.5None None
LastBootUpTimedatetime
DescriptionstringTime when the OperatingSystem was last booted.None TRANSLATABLE= true
MappingStringsstringMIF.DMTF|General Information|001.5None None
LocalDateTimedatetime
DescriptionstringOperatingSystem's notion of the local date and time of day.None TRANSLATABLE= true
MappingStringsstringMIB.IETF|HOST-RESOURCES-MIB.hrSystemDate, MIF.DMTF|General Information|001.6None None
MaxNumberOfProcessesuint32
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.None TRANSLATABLE= true
MappingStringsstringMIF.DMTF|Host System|001.6, MIB.IETF|HOST-RESOURCES-MIB.hrSystemMaxProcessesNone None
MaxProcessesPerUseruint32
DescriptionstringA value that indicates the maximum processes that a user can have associate with it.None TRANSLATABLE= true
MaxProcessMemorySizeuint64
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.None TRANSLATABLE= true
UnitsstringKiloBytesNone TRANSLATABLE= true
Namestring
DescriptionstringThe inherited Name serves as key of an OperatingSystem instance within a ComputerSystem.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MappingStringsstringMIF.DMTF|Operating System|001.2None None
MaxLenuint32256None None
OverridestringNameNone OVERRIDABLE= false
NumberOfLicensedUsersuint32
DescriptionstringNumber of user licenses for the OperatingSystem. If unlimited, enter 0.None TRANSLATABLE= true
NumberOfProcessesuint32
DescriptionstringNumber of process contexts currently loaded or running on the OperatingSystem.None TRANSLATABLE= true
GaugebooleantrueNone None
MappingStringsstringMIF.DMTF|Host System|001.5, MIB.IETF|HOST-RESOURCES-MIB.hrSystemProcessesNone None
NumberOfUsersuint32
DescriptionstringNumber of user sessions for which the OperatingSystem is currently storing state information.None TRANSLATABLE= true
GaugebooleantrueNone None
MappingStringsstringMIF.DMTF|Host System|001.4, MIB.IETF|HOST-RESOURCES-MIB.hrSystemNumUsersNone None
OSTypeuint16
DescriptionstringA integer indicating the type of OperatingSystem.None TRANSLATABLE= true
ModelCorrespondencestringCIM_OperatingSystem.OtherTypeDescription, CIM_SoftwareElement.TargetOperatingSystemNone None
ValueMapstring0, 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, 68None None
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, TandemNSK, TandemNT, 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/OSNone TRANSLATABLE= true
OtherEnabledStatestring
DescriptionstringA string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1.None TRANSLATABLE= true
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledStateNone None
OtherTypeDescriptionstring
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.None TRANSLATABLE= true
MaxLenuint3264None None
ModelCorrespondencestringCIM_OperatingSystem.OSTypeNone None
RequestedStateuint16
DescriptionstringRequestedState is an integer enumeration indicating 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/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's 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). The former, Reboot, refers to doing a "Shut Down" and then moving to an "Enabled" state. The latter, Reset, indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. The former, Shut Down, requests an orderly transition to the Disabled state, and MAY involve removing power, to completely erase any existing state. The latter, 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 may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code.None TRANSLATABLE= true
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledStateNone None
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, 10, 11, .., 32768..65535None None
ValuesstringEnabled, Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot, Reset, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
SizeStoredInPagingFilesuint64
DescriptionstringThe total number of KBytes that can be stored in the OperatingSystem's paging files. 0 indicates that there are no paging files.None TRANSLATABLE= true
MappingStringsstringMIF.DMTF|System Memory Settings|001.3None None
UnitsstringKiloBytesNone TRANSLATABLE= true
Statusstring
DeprecatedstringCIM_ManagedSystemElement.OperationalStatusTOSUBCLASS= falseNone
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 overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 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.None TRANSLATABLE= true
MaxLenuint3210None None
ValueMapstringOK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, NonRecover, No Contact, Lost Comm, StoppedNone None
TimeOfLastStateChangedatetime
DescriptionstringThe date/time when the element's EnabledState 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.None TRANSLATABLE= true
TotalSwapSpaceSizeuint64
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.None TRANSLATABLE= true
UnitsstringKiloBytesNone TRANSLATABLE= true
TotalVirtualMemorySizeuint64
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.None TRANSLATABLE= true
MappingStringsstringMIF.DMTF|System Memory Settings|001.5None None
UnitsstringKiloBytesNone TRANSLATABLE= true
TotalVisibleMemorySizeuint64
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.None TRANSLATABLE= true
UnitsstringKiloBytesNone TRANSLATABLE= true
Versionstring
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>.None TRANSLATABLE= true
MappingStringsstringMIF.DMTF|Operating System|001.3None None
OperationalStatusuint16[]
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringIndicates the current status(es) of the element. Various health and operational statuses are defined. Many of the enumeration's values are self- explanatory. However, a few are not and are described in more detail. "Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, etc. "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 element's state and configuration may need to be updated. "Dormant" indicates that the element is inactive or quiesced. "Supporting Entity in Error" describes that this element may 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 the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error. "Power Mode" indicates 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 since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/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 (since it is single-valued) SHOULD also provide the primary status of the element.None TRANSLATABLE= true
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptionsNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, .., 0x8000..None None
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 ReservedNone TRANSLATABLE= true
StatusDescriptionsstring[]
ArrayTypestringIndexedNone OVERRIDABLE= false
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.None TRANSLATABLE= true
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatusNone None