Edit

Share via

CIM_OperatingSystem class

  • Article

The CIM_OperatingSystem class represents a computer operating system, which is made up of software and firmware that make a computer system's hardware usable.

Important

The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

[Abstract, UUID("{8502C565-5FBB-11D2-AAC1-006008C78BC7}"), AMENDMENT]
class CIM_OperatingSystem : CIM_LogicalElement
{
  string   Caption;
  string   CreationClassName;
  string   CSCreationClassName;
  string   CSName;
  sint16   CurrentTimeZone;
  string   Description;
  boolean  Distributed;
  uint64   FreePhysicalMemory;
  uint64   FreeSpaceInPagingFiles;
  uint64   FreeVirtualMemory;
  datetime InstallDate;
  datetime LastBootUpTime;
  datetime LocalDateTime;
  uint32   MaxNumberOfProcesses;
  uint64   MaxProcessMemorySize;
  string   Name;
  uint32   NumberOfLicensedUsers;
  uint32   NumberOfProcesses;
  uint32   NumberOfUsers;
  uint16   OSType;
  string   OtherTypeDescription;
  uint64   SizeStoredInPagingFiles;
  string   Status;
  uint64   TotalSwapSpaceSize;
  uint64   TotalVirtualMemorySize;
  uint64   TotalVisibleMemorySize;
  string   Version;
};

Members

The CIM_OperatingSystem class has these types of members:

Methods

The CIM_OperatingSystem class has these methods.

Method Description
Reboot Class method that shuts down the computer system, then restarts it. Not implemented by WMI.
Shutdown Class method that unloads programs and DLLs to the point where it is safe to turn off the computer. Not implemented by WMI.

Properties

The CIM_OperatingSystem class has these properties.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64), DisplayName ("Caption")

Short textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: CIM_Key, MaxLen (256)

Name of the class or subclass used in the creation of an instance. When used with other key properties of the class, this property allows all instances of the class and its subclasses to be uniquely identified.

CSCreationClassName

Data type: string

Access type: Read-only

Qualifiers: Propagated ("CIM_ComputerSystem.CreationClassName"), CIM_Key, MaxLen (256)

Scoping computer system's creation class name.

CSName

Data type: string

Access type: Read-only

Qualifiers: Propagated ("CIM_ComputerSystem.Name"), CIM_Key, MaxLen (256)

Scoping computer system's name.

CurrentTimeZone

Data type: sint16

Access type: Read-only

Qualifiers: Units ("minutes")

Number of minutes the operating system is offset from Greenwich Mean Time (GMT). The number is positive, negative, or zero.

Description

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Description")

Textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

Distributed

Data type: boolean

Access type: Read-only

If TRUE, the operating system is distributed across several computer system nodes, which should be grouped as a cluster.

FreePhysicalMemory

Data type: uint64

Access type: Read-only

Qualifiers: Units ("kilobytes")

Number of kilobytes of physical memory currently unused and available.

For more information about using uint64 values in scripts, see Scripting in WMI.

FreeSpaceInPagingFiles

Data type: uint64

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|System Memory Settings|001.4"), Units ("kilobytes")

Number of kilobytes that can be mapped into the operating system's paging files without causing other pages to be swapped out. A value of 0 indicates that there are no paging files.

For more information about using uint64 values in scripts, see Scripting in WMI.

FreeVirtualMemory

Data type: uint64

Access type: Read-only

Qualifiers: Units ("kilobytes")

Number of kilobytes of virtual memory currently unused and available. For example, this can be calculated by adding the amount of free RAM to the amount of free paging space (that is, adding the FreePhysicalMemory and FreeSpaceInPagingFiles properties).

For more information about using uint64 values in scripts, see Scripting in WMI.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5"), DisplayName ("Install Date")

Date and time the object was installed. This property does not require a value to indicate that the object is installed.

This property is inherited from CIM_ManagedSystemElement.

LastBootUpTime

Data type: datetime

Access type: Read-only

Time when the operating system was last booted.

LocalDateTime

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIB.IETF|HOST-RESOURCES-MIB.hrSystemDate", "MIF.DMTF|General Information|001.6")

Operating system's notion of the local date and time of day.

MaxNumberOfProcesses

Data type: uint32

Access type: Read-only

Qualifiers: MappingStrings ("MIB.IETF|HOST-RESOURCES-MIB.hrSystemMaxProcesses")

Maximum number of process contexts the operating system can support. If there is no fixed maximum, the value should be 0 (zero). On systems that have a fixed maximum, this object can help diagnose failures that occur when the maximum is reached. If unknown, enter -1.

MaxProcessMemorySize

Data type: uint64

Access type: Read-only

Qualifiers: Units ("kilobytes")

Maximum number of kilobytes 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 the operating system. For some operating systems, this value can be infinity, in which case 0 should be entered. In other cases, this value can be a constant, for example, 2 GB or 4 GB.

For more information about using uint64 values in scripts, see Scripting in WMI.

Name

Data type: string

Access type: Read-only

Qualifiers: Override ("Name")

Key of an operating system instance within a computer system.

This property is inherited from CIM_ManagedSystemElement.

NumberOfLicensedUsers

Data type: uint32

Access type: Read-only

Number of user licenses for the operating system. If unlimited, enter 0, if unknown, enter -1.

NumberOfProcesses

Data type: uint32

Access type: Read-only

Qualifiers: MappingStrings ("MIB.IETF|HOST-RESOURCES-MIB.hrSystemProcesses")

Number of process contexts currently loaded or running on the operating system.

NumberOfUsers

Data type: uint32

Access type: Read-only

Qualifiers: MappingStrings ("MIB.IETF|HOST-RESOURCES-MIB.hrSystemNumUsers")

Number of user sessions for which the operating system is currently storing state information.

OSType

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_OperatingSystem.OtherTypeDescription")

Type of operating system.

Unknown (0)

Other (1)

MACOS (2)

Mac OS

ATTUNIX (3)

ATT UNIX

DGUX (4)

DECNT (5)

Digital Unix (6)

OpenVMS (7)

Open VMS

HPUX (8)

HP-UX

AIX (9)

MVS (10)

OS400 (11)

OS/2 (12)

JavaVM (13)

Microsoft Virtual Machine (VM) for Java

MSDOS (14)

WIN3x (15)

Windows 3.x

WIN95 (16)

Windows 95

WIN98 (17)

Windows 98

WINNT (18)

Windows NT

WINCE (19)

Windows CE

NCR3000 (20)

NCR 3000

NetWare (21)

OSF (22)

DC/OS (23)

Reliant UNIX (24)

SCO UnixWare (25)

SCO OpenServer (26)

Sequent (27)

IRIX (28)

Solaris (29)

SunOS (30)

U6000 (31)

ASERIES (32)

A Series

TandemNSK (33)

Tandem NSK

TandemNT (34)

Tandem NT

BS2000 (35)

BS2000/OSD

LINUX (36)

Lynx (37)

XENIX (38)

VM/ESA (39)

Interactive UNIX (40)

BSDUNIX (41)

BSD UNIX

FreeBSD (42)

NetBSD (43)

GNU Hurd (44)

OS9 (45)

Mac OS 9

MACH Kernel (46)

Inferno (47)

QNX (48)

EPOC (49)

IxWorks (50)

VxWorks (51)

MiNT (52)

BeOS (53)

HP MPE (54)

NextStep (55)

PalmPilot (56)

Palm OS

Rhapsody (57)

Windows 2000 (58)

Dedicated (59)

OS/390 (60)

VSE (61)

TPF (62)

OtherTypeDescription

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64), ModelCorrespondence ("CIM_OperatingSystem.OSType")

Describes the manufacturer and operating system type when the OSType property is set to 1 ("Other"). The format of the string inserted in OtherTypeDescription should be similar to the Values strings defined for OSType. This property should be set to null when OSType is a value other than 1 (one).

SizeStoredInPagingFiles

Data type: uint64

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|System Memory Settings|001.3"), Units ("kilobytes")

Number of kilobytes that can be stored in the operating system's paging files. This number does not represent the actual physical size of the paging file on disk. A value of 0 (zero)indicates that there are no paging files.

For more information about using uint64 values in scripts, see Scripting in WMI.

Status

Data type: string

Access type: Read-only

Qualifiers: MaxLen (10), DisplayName ("Status")

Current status of the object.

This property is inherited from CIM_ManagedSystemElement.

Values include the following:

OK ("OK")

Error ("Error")

Degraded ("Degraded")

Unknown ("Unknown")

Pred Fail ("Pred Fail")

Starting ("Starting")

Stopping ("Stopping")

Service ("Service")

Stressed ("Stressed")

NonRecover ("NonRecover")

No Contact ("No Contact")

Lost Comm ("Lost Comm")

TotalSwapSpaceSize

Data type: uint64

Access type: Read-only

Qualifiers: Units ("kilobytes")

Total swap space, in kilobytes. This value can be null (unspecified) if swap space is not distinguished from page files. However, some operating systems distinguish these concepts. For example, entire processes can be "swapped out" in UNIX when the free page list falls and remains below a specified amount.

For more information about using uint64 values in scripts, see Scripting in WMI.

TotalVirtualMemorySize

Data type: uint64

Access type: Read-only

Qualifiers: Units ("kilobytes")

Number of kilobytes of virtual memory. For example, calculate this by adding the amount of total RAM to the amount of paging space (that is, add the amount of memory in or aggregated by the computer system to the SizeStoredInPagingFiles property.

For more information about using uint64 values in scripts, see Scripting in WMI.

TotalVisibleMemorySize

Data type: uint64

Access type: Read-only

Qualifiers: Units ("kilobytes")

Total amount of physical memory, in kilobytes, available to the operating system. This value does not necessarily indicate the true amount of physical memory, but what is reported to the operating system as available to it.

For more information about using uint64 values in scripts, see Scripting in WMI.

Version

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Operating System|001.3")

Version of the operation.

The version of the operation should be in one of the following forms:

  • <major>.<minor>.<revision>
  • <major>.<minor><letter><revision>

Remarks

The CIM_OperatingSystem class is derived from CIM_LogicalElement.

WMI does not implement this class. For WMI classes that are derived from CIM_OperatingSystem, see Win32 Classes.

This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.

Requirements

Requirement Value
Minimum supported client
 Windows Vista
Minimum supported server
 Windows Server 2008
Namespace
 Root\CIMV2
MOF
CIMWin32.mof
DLL
CIMWin32.dll

See also

CIM_LogicalElement