Win32_ServerSession class

Article
05/31/2018

The Win32_ServerSession WMI class represents the sessions that have been established with the local computer by users on a remote computer.

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

Syntax

[Dynamic, Provider("SessionProvider"), AMENDMENT]
class Win32_ServerSession : CIM_LogicalElement
{
  string       Caption;
  string       Description;
  datetime REF InstallDate;
  string       Name;
  string       Status;
  uint32       ActiveTime;
  string       ClientType;
  string       ComputerName;
  uint32       IdleTime;
  uint32       ResourcesOpened;
  uint32       SessionType;
  string       TransportName;
  string       UserName;
};

Members

The Win32_ServerSession class has these types of members:

Properties

Properties

The Win32_ServerSession class has these properties.

ActiveTime

Data type: uint32
Access type: Read-only
Qualifiers: Units ("seconds")

Number of seconds since this session was established.

Caption

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

A short textual description of the object. This property is inherited from CIM_ManagedSystemElement.

ClientType

Data type: string
Access type: Read-only

Type of the connected client.

ComputerName

Data type: string
Access type: Read-only
Qualifiers: key

Name of the computer from which the session is established.

Description

Data type: string
Access type: Read-only

A textual description of the object. This property is inherited from CIM_ManagedSystemElement.

IdleTime

Data type: uint32
Access type: Read-only
Qualifiers: Units ("seconds")

Number of seconds that the session has been idle.

InstallDate

Data type: datetime
Access type: Read-only

Indicates when the object was installed. Lack of a value does not indicate that the object is not installed. This property is inherited from CIM_ManagedSystemElement.

Name

Data type: string
Access type: Read-only

Label by which the object is known. When subclassed, this property can be overridden to be a key property. This property is inherited from CIM_ManagedSystemElement.

ResourcesOpened

Data type: uint32
Access type: Read-only

Number of files, devices, and pipes opened during this session.

SessionType

Data type: uint32
Access type: Read-only

Method of opening the session.

Possible values:

Guest (0)

NoEncryption (1)

Other (2)

Status

Data type: string
Access type: Read-only

String that indicates the current status of the object. Operational and non-operational status can be defined. Operational status can include "OK", "Degraded", and "Pred Fail". "Pred Fail" indicates that an element is functioning properly, but is predicting a failure (for example, a SMART-enabled hard disk drive).

Non-operational status can include "Error", "Starting", "Stopping", and "Service". "Service" can apply during disk mirror-resilvering, reloading a user permissions list, or other administrative work. Not all such work is online, but the managed element is neither "OK" nor in one of the other states. 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")

TransportName

Data type: string
Access type: Read-only

Name of the transport that the client is using to communicate with the server.

UserName

Data type: string
Access type: Read-only
Qualifiers: key

Name of the user that established the session.

Remarks

The Win32_ServerSession class is derived from CIM_LogicalElement.

Requirements


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

Share via