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.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

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

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
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.
UMLPackagePathstringCIM::System::OperatingSystem
Versionstring2.36.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
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.
Keybooleantrue
MaxLenuint32256
CSCreationClassNamestring
DescriptionstringThe scoping ComputerSystem's CreationClassName.
Keybooleantrue
MaxLenuint32256
PropagatedstringCIM_ComputerSystem.CreationClassName
CSNamestring
DescriptionstringThe scoping ComputerSystem's Name.
Keybooleantrue
MaxLenuint32256
PropagatedstringCIM_ComputerSystem.Name
CurrentTimeZonesint16
DescriptionstringCurrentTimeZone indicates the number of minutes the OperatingSystem is offset from Greenwich Mean Time. Either the number is positive, negative or zero.
PUnitstringminute
UnitsstringMinutes
Distributedboolean
DescriptionstringBoolean indicating whether the OperatingSystem is distributed across several ComputerSystem nodes. If so, these nodes should be grouped as a Cluster.
Familystring
DescriptionstringIdentifies the family that the OperatingSystem belongs to as a structured string. A family refers to a set of OperatingSystems that are similar but not identical from a hardware or software point of view (for example, Windows or Linux family of operating systems). The format for the family string values shall conform to the 'family' ABNF rule: family = org-id ":" family-id org-id = INDENTIFIER family-id = INST-INDENTIFIER Org-id shall include a copyright, trademarked, or otherwise unique name that is owned by the business entity that produces the OperatingSystem or that is a registered ID assigned to that business entity by a recognized global authority. In addition, to ensure uniqueness, org-id and family-id shall not contain a colon (:). Family string values defined by the DMTF shall have an org-id of 'DMTF'.
Experimentalbooleantrue
FreePhysicalMemoryuint64
DescriptionstringNumber of Kbytes of physical memory currently unused and available.
Gaugebooleantrue
MappingStringsstringMIF.DMTF|System Memory Settings|001.2, MIF.UNIX|Host Physical Memory|6.1
PUnitstringbyte * 2^10
UnitsstringKiloBytes
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.
Gaugebooleantrue
MappingStringsstringMIF.DMTF|System Memory Settings|001.4
PUnitstringbyte * 2^10
UnitsstringKiloBytes
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).
Gaugebooleantrue
MappingStringsstringMIF.DMTF|System Memory Settings|001.6
PUnitstringbyte * 2^10
UnitsstringKiloBytes
LastBootUpTimedatetime
DescriptionstringTime when the OperatingSystem was last booted.
MappingStringsstringMIF.DMTF|General Information|001.5
LocalDateTimedatetime
DescriptionstringOperatingSystem's notion of the local date and time of day.
MappingStringsstringMIB.IETF|HOST-RESOURCES-MIB.hrSystemDate, MIF.DMTF|General Information|001.6
Manufacturerstring
DescriptionstringThe name of the organization responsible for producing the OperatingSystem.
Experimentalbooleantrue
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.
MappingStringsstringMIF.DMTF|Host System|001.6, MIB.IETF|HOST-RESOURCES-MIB.hrSystemMaxProcesses
MaxProcessesPerUseruint32
DescriptionstringA value that indicates the maximum processes that a user can have associate with it.
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.
PUnitstringbyte * 2^10
UnitsstringKiloBytes
Namestring
DescriptionstringThe inherited Name serves as key of an OperatingSystem instance within a ComputerSystem.
Keybooleantrue
MappingStringsstringMIF.DMTF|Operating System|001.2
MaxLenuint32256
OverridestringName
NumberOfLicensedUsersuint32
DescriptionstringNumber of user licenses for the OperatingSystem. If unlimited, enter 0.
NumberOfProcessesuint32
DescriptionstringNumber of process contexts currently loaded or running on the OperatingSystem.
Gaugebooleantrue
MappingStringsstringMIF.DMTF|Host System|001.5, MIB.IETF|HOST-RESOURCES-MIB.hrSystemProcesses
NumberOfUsersuint32
DescriptionstringNumber of user sessions for which the OperatingSystem is currently storing state information.
Gaugebooleantrue
MappingStringsstringMIF.DMTF|Host System|001.4, MIB.IETF|HOST-RESOURCES-MIB.hrSystemNumUsers
OSClassificationstring
DescriptionstringIdentifies the classification of the OperatingSystem as a structured string. A classification refers to the intended purpose for the OperatingSystem. For example: Server vs Desktop. The format for the OSClassification string values shall conform to the 'classification' ABNF rule: classification = org-id ":" classification-id org-id = INDENTIFIER classification-id = INST-INDENTIFIER Org-id shall include a copyright, trademarked, or otherwise unique name that is owned by the business entity that produces the OperatingSystem or that is a registered ID assigned to that business entity by a recognized global authority. In addition, to ensure uniqueness, org-id and family-id shall not contain a colon (:). OSClassification string values defined by the DMTF shall have an org-id of 'DMTF'.
Experimentalbooleantrue
OSTypeuint16
DescriptionstringA integer indicating the type of OperatingSystem.
ModelCorrespondencestringCIM_OperatingSystem.OtherTypeDescription, CIM_SoftwareElement.TargetOperatingSystem
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, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77
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, 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
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.
MaxLenuint3264
ModelCorrespondencestringCIM_OperatingSystem.OSType
SizeStoredInPagingFilesuint64
DescriptionstringThe total number of KBytes that can be stored in the OperatingSystem's paging files. 0 indicates that there are no paging files.
MappingStringsstringMIF.DMTF|System Memory Settings|001.3
PUnitstringbyte * 2^10
UnitsstringKiloBytes
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.
PUnitstringbyte * 2^10
UnitsstringKiloBytes
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.
MappingStringsstringMIF.DMTF|System Memory Settings|001.5
PUnitstringbyte * 2^10
UnitsstringKiloBytes
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.
PUnitstringbyte * 2^10
UnitsstringKiloBytes
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>.
MappingStringsstringMIF.DMTF|Operating System|001.3

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StatusstringCIM_ManagedSystemElement
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

Reboot (uint32)

Method Qualifiers (Reboot)

NameData TypeValue
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.

Method Parameters (Reboot)

NameTypeQualifiers
NameData TypeValue

Shutdown (uint32)

Method Qualifiers (Shutdown)

NameData TypeValue
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.

Method Parameters (Shutdown)

NameTypeQualifiers
NameData TypeValue

Inherited Class Methods

NameReturn TypeClass Origin
RequestStateChangeuint32CIM_EnabledLogicalElement