Win32_LogonSession - powershell.one

The Win32_LogonSession WMI class (see Retrieving a WMI class) describes the logon session or sessions associated with a user logged on to a computer system running Windows.

Methods

Win32_LogonSession has no methods.

Properties

Win32_LogonSession returns 9 properties:

'AuthenticationPackage','Caption','Description','InstallDate','LogonId','LogonType',
'Name','StartTime','Status'

Unless explicitly marked as writeable, all properties are read-only. Read all properties for all instances:

Get-CimInstance -ClassName Win32_LogonSession -Property *

Most WMI classes return one or more instances.

When Get-CimInstance returns no result, then apparently no instances of class Win32_LogonSession exist. This is normal behavior.

Either the class is not implemented on your system (may be deprecated or due to missing drivers, i.e. CIM_VideoControllerResolution), or there are simply no physical representations of this class currently available (i.e. Win32_TapeDrive).

AuthenticationPackage

STRING

Name of the subsystem used to authenticate the logon session.

Get-CimInstance -ClassName Win32_LogonSession | Select-Object -Property LogonId, AuthenticationPackage

Caption

STRING MAX 64 CHAR

A short textual description of the object.

Get-CimInstance -ClassName Win32_LogonSession | Select-Object -Property LogonId, Caption

Description

STRING

A textual description of the object.

Get-CimInstance -ClassName Win32_LogonSession | Select-Object -Property LogonId, Description

InstallDate

DATETIME

Indicates when the object was installed. Lack of a value does not indicate that the object is not installed.

Get-CimInstance -ClassName Win32_LogonSession | Select-Object -Property LogonId, InstallDate

LogonId

KEY PROPERTY STRING

ID assigned to the logon session.

Get-CimInstance -ClassName Win32_LogonSession | Select-Object -Property LogonId

LogonType

UINT32

Numeric value that indicates the type of logon session.

Used only by the System account.

LogonType returns a numeric value. To translate it into a meaningful text, use any of the following approaches:

Use a PowerShell Hashtable

$LogonType_map = @{
= 'Interactive'
= 'Network'
= 'Batch'
= 'Service'
= 'Proxy'
= 'Unlock'
= 'NetworkCleartext'
= 'NewCredentials'
= 'RemoteInteractive'
= 'CachedInteractive'
= 'CachedRemoteInteractive'
= 'CachedUnlock'
}

Use a switch statement

switch([int]$value)
{
        {'Interactive'}
        {'Network'}
        {'Batch'}
        {'Service'}
        {'Proxy'}
        {'Unlock'}
        {'NetworkCleartext'}
        {'NewCredentials'}
       {'RemoteInteractive'}
       {'CachedInteractive'}
       {'CachedRemoteInteractive'}
       {'CachedUnlock'}
  default    {"$value"}
}

Use Enum structure

Enum EnumLogonType
{
  Interactive               = 2
  Network                   = 3
  Batch                     = 4
  Service                   = 5
  Proxy                     = 6
  Unlock                    = 7
  NetworkCleartext          = 8
  NewCredentials            = 9
  RemoteInteractive         = 10
  CachedInteractive         = 11
  CachedRemoteInteractive   = 12
  CachedUnlock              = 13
}

Examples

Use $LogonType_map in a calculated property for Select-Object

<# 
  this example uses a hashtable to translate raw numeric values for 
  property "LogonType" to friendly text

  Note: to use other properties than "LogonType", look up the appropriate 
  translation hashtable for the property you would like to use instead.
#>

#region define hashtable to translate raw values to friendly text

# Please note: this hashtable is specific for property "LogonType" 
# to translate other properties, use their translation table instead
$LogonType_map = @{
      2 = 'Interactive'
      3 = 'Network'
      4 = 'Batch'
      5 = 'Service'
      6 = 'Proxy'
      7 = 'Unlock'
      8 = 'NetworkCleartext'
      9 = 'NewCredentials'
     10 = 'RemoteInteractive'
     11 = 'CachedInteractive'
     12 = 'CachedRemoteInteractive'
     13 = 'CachedUnlock'
}

#endregion define hashtable

#region define calculated property (to be used with Select-Object)

<#
  a calculated property is defined by a hashtable with keys "Name" and "Expression"
  "Name" defines the name of the property (in this example, it is "LogonType", but you can rename it to anything else)
  "Expression" defines a scriptblock that calculates the content of this property
  in this example, the scriptblock uses the hashtable defined earlier to translate each numeric
  value to its friendly text counterpart:
#>
 
$LogonType = @{
  Name = 'LogonType'
  Expression = {
    # property is an array, so process all values
    $value = $_.LogonType
    $LogonType_map[[int]$value]
  }  
}
#endregion define calculated property

# retrieve the instances, and output the properties "Caption" and "LogonType". The latter
# is defined by the hashtable in $LogonType: 
Get-CimInstance -Class Win32_LogonSession | Select-Object -Property Caption, $LogonType

# ...or dump content of property LogonType:
$friendlyValues = Get-CimInstance -Class Win32_LogonSession | 
    Select-Object -Property $LogonType |
    Select-Object -ExpandProperty LogonType

# output values
$friendlyValues

# output values as comma separated list
$friendlyValues -join ', '

# output values as bullet list
$friendlyValues | ForEach-Object { "- $_" }

Use $LogonType_map to directly translate raw values from an instance

<# 
  this example uses a hashtable to manually translate raw numeric values 
  for property "Win32_LogonSession" to friendly text. This approach is ideal when
  there is just one instance to work with.

  Note: to use other properties than "Win32_LogonSession", look up the appropriate 
  translation hashtable for the property you would like to use instead.
#>

#region define hashtable to translate raw values to friendly text

# Please note: this hashtable is specific for property "Win32_LogonSession" 
# to translate other properties, use their translation table instead
$LogonType_map = @{
      2 = 'Interactive'
      3 = 'Network'
      4 = 'Batch'
      5 = 'Service'
      6 = 'Proxy'
      7 = 'Unlock'
      8 = 'NetworkCleartext'
      9 = 'NewCredentials'
     10 = 'RemoteInteractive'
     11 = 'CachedInteractive'
     12 = 'CachedRemoteInteractive'
     13 = 'CachedUnlock'
}

#endregion define hashtable

# get one instance:
$instance = Get-CimInstance -Class Win32_LogonSession | Select-Object -First 1

<#
  IMPORTANT: this example processes only one instance to illustrate
  the number-to-text translation. To process all instances, replace
  "Select-Object -First 1" with a "Foreach-Object" loop, and use
  the iterator variable $_ instead of $instance
#>

# query the property
$rawValue = $instance.LogonType  

# translate raw value to friendly text:
$friendlyName = $LogonType_map[[int]$rawValue]

# output value
$friendlyName

Use a switch statement inside a calculated property for Select-Object

<# 
  this example uses a switch clause to translate raw numeric 
  values for property "LogonType" to friendly text. The switch
  clause is embedded into a calculated property so there is
  no need to refer to external variables for translation.

  Note: to use other properties than "LogonType", look up the appropriate 
  translation switch clause for the property you would like to use instead.
#>

#region define calculated property (to be used with Select-Object)

<#
  a calculated property is defined by a hashtable with keys "Name" and "Expression"
  "Name" defines the name of the property (in this example, it is "LogonType", but you can rename it to anything else)
  "Expression" defines a scriptblock that calculates the content of this property
  in this example, the scriptblock uses the hashtable defined earlier to translate each numeric
  value to its friendly text counterpart:
#>
 
$LogonType = @{
  Name = 'LogonType'
  Expression = {
    # property is an array, so process all values
    $value = $_.LogonType
    
    switch([int]$value)
      {
        2          {'Interactive'}
        3          {'Network'}
        4          {'Batch'}
        5          {'Service'}
        6          {'Proxy'}
        7          {'Unlock'}
        8          {'NetworkCleartext'}
        9          {'NewCredentials'}
        10         {'RemoteInteractive'}
        11         {'CachedInteractive'}
        12         {'CachedRemoteInteractive'}
        13         {'CachedUnlock'}
        default    {"$value"}
      }
      
  }  
}
#endregion define calculated property

# retrieve all instances...
Get-CimInstance -ClassName Win32_LogonSession | 
  # ...and output properties "Caption" and "LogonType". The latter is defined
  # by the hashtable in $LogonType:
  Select-Object -Property Caption, $LogonType

Use the Enum from above to auto-translate the code values

<# 
  this example translates raw values by means of type conversion
  the friendly names are defined as enumeration using the
  keyword "enum" (PowerShell 5 or better)
  
  The raw value(s) are translated to friendly text by 
  simply converting them into the enum type.
  
  Note: to use other properties than "Win32_LogonSession", look up the appropriate 
  enum definition for the property you would like to use instead.
#>


#region define enum with value-to-text translation:
Enum EnumLogonType
{
  Interactive               = 2
  Network                   = 3
  Batch                     = 4
  Service                   = 5
  Proxy                     = 6
  Unlock                    = 7
  NetworkCleartext          = 8
  NewCredentials            = 9
  RemoteInteractive         = 10
  CachedInteractive         = 11
  CachedRemoteInteractive   = 12
  CachedUnlock              = 13
}

#endregion define enum

# get one instance:
$instance = Get-CimInstance -Class Win32_LogonSession | Select-Object -First 1

<#
  IMPORTANT: this example processes only one instance to focus on
  the number-to-text type conversion. 
  
  To process all instances, replace   "Select-Object -First 1" 
  with a "Foreach-Object" loop, and use the iterator variable 
  $_ instead of $instance
#>

# query the property:
$rawValue = $instance.LogonType

#region using strict type conversion

<#
  Note: strict type conversion fails if the raw value is 
  not defined by the enum. So if the list of allowable values
  was extended and the enum does not match the value,
  an exception is thrown
#>

# convert the property to the enum **LogonType** 
[EnumLogonType]$rawValue 

# get a comma-separated string:
[EnumLogonType]$rawValue -join ',' 
#endregion

#region using operator "-as"

<#
  Note: the operator "-as" accepts values not defined
  by the enum and returns $null instead of throwing
  an exception
#>

$rawValue -as [EnumLogonType]
#endregion

Enums must cover all possible values. If LogonType returns a value that is not defined in the enum, an exception occurs. The exception reports the value that was missing in the enum. To fix, add the missing value to the enum.

Name

STRING

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

Get-CimInstance -ClassName Win32_LogonSession | Select-Object -Property LogonId, Name

StartTime

DATETIME

Time at which the session started.

Get-CimInstance -ClassName Win32_LogonSession | Select-Object -Property LogonId, StartTime

Status

STRING MAX 10 CHAR

Current status of an object. Various operational and nonoperational statuses can be defined. Available values:

$values = 'Degraded','Error','Lost Comm','No Contact','NonRecover','OK','Pred Fail','Service','Starting','Stopping','Stressed','Unknown'

Get-CimInstance -ClassName Win32_LogonSession | Select-Object -Property LogonId, Status

Examples

List all instances of Win32_LogonSession

Get-CimInstance -ClassName Win32_LogonSession

Learn more about Get-CimInstance and the deprecated Get-WmiObject.

View all properties

Get-CimInstance -ClassName Win32_LogonSession -Property *

View key properties only

Get-CimInstance -ClassName Win32_LogonSession -KeyOnly

Selecting Properties

To select only some properties, pipe the results to Select-Object -Property a,b,c with a comma-separated list of the properties you require. Wildcards are permitted.

Get-CimInstance always returns all properties but only retrieves the ones that you specify. All other properties are empty but still present. That’s why you need to pipe the results into Select-Object if you want to limit the visible properties, i.e. for reporting.

Selecting Properties

The code below lists all available properties. Remove the ones you do not need:

$properties = 'AuthenticationPackage',
              'Caption',
              'Description',
              'InstallDate',
              'LogonId',
              'LogonType',
              'Name',
              'StartTime',
              'Status'
Get-CimInstance -ClassName Win32_LogonSession | Select-Object -Property $properties

Limiting Network Bandwidth

If you work remotely, it makes sense to limit network bandwidth by filtering the properties on the server side, too:

Get-CimInstance -Class Win32_LogonSession -Property $property | 
Select-Object -Property $property

Selecting Instances

To select some instances, use Get-CimInstance and a WMI Query. The wildcard character in WMI Queries is % (and not “*”).

The parameter -Filter runs a simple query.

Listing all instances where the property Caption starts with “A”

Get-CimInstance -Class Win32_LogonSession -Filter 'Caption LIKE "a%"' 

Using a WQL Query

The parameter -Query uses a query similar to SQL and combines the parameters -Filter and -Property. This returns all instances where the property Caption starts with “A”, and returns the properties specified:

Get-CimInstance -Query "SELECT Caption, AuthenticationPackage, Name, Description FROM Win32_LogonSession WHERE Caption LIKE 'a%'"

Any property you did not specify is still present but empty. You might need to use Select-Object to remove all unwanted properties:
Get-CimInstance -Query "SELECT Caption, AuthenticationPackage, Name, Description FROM Win32_LogonSession WHERE Caption LIKE 'a%'" | Select-Object -Property Caption, AuthenticationPackage, Name, Description

Accessing Remote Computers

To access remote systems, you need to have proper permissions. User the parameter -ComputerName to access one or more remote systems.

Authenticating as Current User

# one or more computer names or IP addresses:
$list = 'server1', 'server2'

# authenticate with your current identity:
$result = Get-CimInstance -ClassName Win32_LogonSession -ComputerName $list 
$result

Authenticating as Different User

Use a CIMSession object to authenticate with a new identity:

# one or more computer names or IP addresses:
$list = 'server1', 'server2'

# authenticate with a different identity:
$cred = Get-Credential -Message 'Authenticate to retrieve WMI information:'
$session = New-CimSession -ComputerName $list -Credential $cred

$result = Get-CimInstance Win32_LogonSession -CimSession $session

# remove the session after use (if you do not plan to re-use it later)
Remove-CimSession -CimSession $session

$result

Learn more about accessing remote computers.

Requirements

To use Win32_LogonSession, the following requirements apply:

PowerShell

Get-CimInstance was introduced with PowerShell Version 3.0, which in turn was introduced on clients with Windows 8 and on servers with Windows Server 2012.

If necessary, update Windows PowerShell to Windows PowerShell 5.1, or install PowerShell 7 side-by-side.

Operating System

Win32_LogonSession was introduced on clients with Windows Vista and on servers with Windows Server 2008.

Namespace

Win32_LogonSession lives in the Namespace Root/CIMV2. This is the default namespace. There is no need to use the -Namespace parameter in Get-CimInstance.

Implementation

Win32_LogonSession is implemented in CIMWin32.dll and defined in CIMWin32.mof. Both files are located in the folder C:\Windows\system32\wbem:

explorer $env:windir\system32\wbem
notepad $env:windir\system32\wbem\CIMWin32.mof

PREVIOUSArchive