Exchange_Logon Class
Exchange_Logon Class
This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.
Instances of Exchange_Logon represent the users currently logged on to Microsoft® Exchange.
Namespace
\\COMPUTERNAME\ROOT\MicrosoftExchangeV2:Exchange_Logon
Provider
The ExchangeMapiTableProvider supplies instances of the Exchange_Logon class.
Origin
The Exchange_Logon class extends the CIM_LogicalElement class.
Qualifiers
dynamic
Properties
| Property | Description |
|---|---|
| RowID Property | [key, read] uint32 RowID; The RowID property indicates that a random identifier is generated per query to ensure uniqueness. |
| ServerName Property | [key, read] string ServerName; The ServerName property indicates the name of the server where the mailbox resides. |
| StorageGroupName Property | [key, read] string StorageGroupName; The StorageGroupName property indicates the name of the storage group that contains the mailbox. |
| StoreName Property | [key, read] string StoreName; The StoreName property indicates the name of the message database (MDB) that contains the mailbox. |
| AdapterSpeed Property | [read] uint32 AdapterSpeed; The AdapterSpeed property indicates the speed of the client network interface card, in kilobits/second |
| ClientIP Property | [read] string ClientIP; The ClientIP property indicates the IP address of the client computer. |
| ClientMode Property | [read,
Values{"Classic Online", "Cached"},
ValueMap{"1", "2"}] uint32 ClientMode;
The ClientMode property indicates whether the client is using local data caching. |
| ClientName Property | [read] string ClientName; The ClientName property indicates the client computer name. |
| ClientVersion Property | [read] string ClientVersion; The ClientVersion property indicates the version of the client used to log on. |
| CodePageID Property | [read] uint32 CodePageID; The CodePageID property indicates the code page of the client. |
| FolderOperationRate Property | [read,
Units("per second")] uint32 FolderOperationRate;
The FolderOperationRate property indicates the folder operation rate (per second) performed by the store on behalf of the client. |
| HostAddress Property | [read] string HostAddress; The HostAddress property indicates the client-specific identification information. |
| LastOperationTime Property | [read] datetime LastOperationTime; The LastOperationTime property indicates the time when the last operation was performed. |
| Latency Property | [read] uint32 Latency; The Latency property indicates the server response latency time reported by the client, in milliseconds. |
| LocaleID Property | [read] uint32 LocaleID; The LocaleID property indicates the Windows locale of the client. |
| LoggedOnUserAccount Property | [read] string LoggedOnUserAccount; The LoggedOnUserAccount property indicates the name of the user account that logged on in the format DOMAIN\SAMAccountName. |
| LoggedOnUsersMailboxLegacyDN Property | [read] string LoggedOnUsersMailboxLegacyDN; The LoggedOnUsersMailboxLegacyDN property indicates the legacyDN of the user who is currently logged on. |
| LogonTime Property | [read] datetime LogonTime; The LogonTime property indicates the time that the user logged on. |
| MacAddress Property | [read] string MacAddress; The MacAddress property indicates the network interface card Media Access Connector address of the client computer. |
| MailboxDisplayName Property | [read] string MailboxDisplayName; The MailboxDisplayName property indicates the name of the mailbox. |
| MailboxLegacyDN Property | [read] string MailboxLegacyDN; The MailboxLegacyDN property indicates the legacyDN of the mailbox. |
| MessagingOperationRate Property | [read,
Units("per second")] uint32 MessagingOperationRate;
The MessagingOperationRate property indicates the rate of send/receive operations performed per second by the store on behalf of the client. |
| OpenAttachmentCount Property | [read] uint32 OpenAttachmentCount; The OpenAttachmentCount property indicates the number of attachments currently opened by the client. |
| OpenFolderCount Property | [read] uint32 OpenFolderCount; The OpenFolderCount property indicates the number of folders currently opened by the client. |
| OpenMessageCount Property | [read] uint32 OpenMessageCount; The OpenMessageCount property indicates the number of messages currently opened by the client. |
| OtherOperationRate Property | [read,
Units("per second")] uint32 OtherOperationRate;
The OtherOperationRate property indicates the rate of operations performed on the store, in response to client requests that are not within the other categories of operation-request properties. |
| ProgressOperationRate Property | [read,
Units("per second")] uint32 ProgressOperationRate;
The ProgressOperationRate property indicates the rate of progress operations performed per second by the store on behalf of the client. |
| RPCSucceeded Property | [read] sint32 RPCSucceeded; The RPCSucceeded property indicates the number of successful RPC requests made by the client. |
| StoreType Property | [read,
Values{"Mailbox Store", "Public Store"},
ValueMap{"1", "2"}] uint32 StoreType;
The StoreType property indicates whether the store contains mailboxes or public folders. |
| StreamOperationRate Property | [read,
Units("per second")] uint32 StreamOperationRate;
The StreamOperationRate property indicates the rate of stream operations performed per second by the store on behalf of the client. |
| TableOperationRate Property | [read,
Units("per second")] uint32 TableOperationRate;
The TableOperationRate property indicates the rate of table operations performed per second by the store on behalf of the client. |
| TotalOperationRate Property | [read,
Units("per second")] uint32 TotalOperationRate;
The TotalOperationRate property indicates the rate of all operations performed per second by the store on behalf of the client. |
| TransferOperationRate Property | [read,
Units("per second")] uint32 TransferOperationRate;
The TransferOperationRate property indicates the rate of transfer operations performed per second by the store on behalf of the client. |
Methods
This class has no methods.
Associations
This class has no associations.
VBScript Example
The following example shows how to retrieve a list of Exchange_Logon instances, and how to retrieve all the associated properties.
'===============================================================
' Purpose: Display each Exchange_Logon found for Exchange server,
' and show all properties on the Exchange_Logon
' objects
' Change: cComputerName [string] the computer to access
' Output: Displays the name of each Exchange_Logon and properties
'===============================================================
On Error Resume Next
Dim cComputerName
Const cWMINameSpace = "root/MicrosoftExchangeV2"
Const cWMIInstance = "Exchange_Logon"
cComputerName = "MyComputerNETBIOSName"
Dim strWinMgmts ' Connection string for WMI
Dim objWMIExchange ' Exchange Namespace WMI object
Dim listExchange_Logons ' ExchangeLogons collection
Dim objExchange_Logon ' A single ExchangeLogon WMI object
' Create the object string, indicating WMI (winmgmts), using the
' current user credentials (impersonationLevel=impersonate),
' on the computer specified in the constant cComputerName, and
' using the CIM namespace for the Exchange provider.
strWinMgmts = "winmgmts:{impersonationLevel=impersonate}!//"& _
cComputerName&"/"&cWMINameSpace
Set objWMIExchange = GetObject(strWinMgmts)
' Verify we were able to correctly set the object.
If Err.Number <> 0 Then
WScript.Echo "ERROR: Unable to connect to the WMI namespace."
Else
'
' The Resources that currently exist appear as a list of
' Exchange_Logon instances in the Exchange namespace.
Set listExchange_Logons = objWMIExchange.InstancesOf(cWMIInstance)
'
' Were any Exchange_Logon Instances returned?
If (listExchange_Logons.count > 0) Then
' If yes, do the following:
' Iterate through the list of Exchange_Logon objects.
For Each objExchange_Logon in listExchange_Logons
Wscript.Echo""
Wscript.Echo""
'
'
' Display the value of the AdapterSpeed property.
WScript.echo "AdapterSpeed = "& _
" ["&TypeName(objExchange_Logon.AdapterSpeed)&"] "& _
objExchange_Logon.AdapterSpeed
'
'
' Display the value of the ClientIP property.
WScript.echo "ClientIP = "& _
" ["&TypeName(objExchange_Logon.ClientIP)&"] "& _
objExchange_Logon.ClientIP
'
'
' Display the value of the ClientName property.
WScript.echo "ClientName = "& _
" ["&TypeName(objExchange_Logon.ClientName)&"] "& _
objExchange_Logon.ClientName
'
'
' Display the value of the ClientMode property.
WScript.echo "ClientMode = "& _
" ["&TypeName(objExchange_Logon.ClientMode)&"] "& _
objExchange_Logon.ClientMode
'
'
' Display the value of the ClientVersion property.
WScript.echo "ClientVersion = "& _
" ["&TypeName(objExchange_Logon.ClientVersion)&"] "& _
objExchange_Logon.ClientVersion
'
'
' Display the value of the CodePageID property.
WScript.echo "CodePageID = "& _
" ["&TypeName(objExchange_Logon.CodePageID)&"] "& _
objExchange_Logon.CodePageID
'
'
' Display the value of the FolderOperationRate property.
WScript.echo "FolderOperationRate = "& _
" ["&TypeName(objExchange_Logon.FolderOperationRate)&"] "& _
objExchange_Logon.FolderOperationRate
'
'
' Display the value of the HostAddress property.
WScript.echo "HostAddress = "& _
" ["&TypeName(objExchange_Logon.HostAddress)&"] "& _
objExchange_Logon.HostAddress
'
'
' Display the value of the LastOperationTime property.
WScript.echo "LastOperationTime = "& _
" ["&TypeName(objExchange_Logon.LastOperationTime)&"] "& _
objExchange_Logon.LastOperationTime
'
'
' Display the value of the Latency property.
WScript.echo "Latency = "& _
" ["&TypeName(objExchange_Logon.Latency)&"] "& _
objExchange_Logon.Latency
'
'
' Display the value of the LocaleID property.
WScript.echo "LocaleID = "& _
" ["&TypeName(objExchange_Logon.LocaleID)&"] "& _
objExchange_Logon.LocaleID
'
'
' Display the value of the LoggedOnUserAccount property.
WScript.echo "LoggedOnUserAccount = "& _
" ["&TypeName(objExchange_Logon.LoggedOnUserAccount)&"] "& _
objExchange_Logon.LoggedOnUserAccount
'
'
' Display the value of the LoggedOnUsersMailboxLegacyDN property.
WScript.echo "LoggedOnUsersMailboxLegacyDN= "& _
" ["&TypeName(objExchange_Logon.LoggedOnUsersMailboxLegacyDN)&"] "& _
objExchange_Logon.LoggedOnUsersMailboxLegacyDN
'
'
' Display the value of the LogonTime property.
WScript.echo "LogonTime = "& _
" ["&TypeName(objExchange_Logon.LogonTime)&"] "& _
objExchange_Logon.LogonTime
'
'
' Display the value of the MacAddress property.
WScript.echo "MacAddress = "& _
" ["&TypeName(objExchange_Logon.MacAddress)&"] "& _
objExchange_Logon.MacAddress
'
'
' Display the value of the MailboxDisplayName property.
WScript.echo "MailboxDisplayName = "& _
" ["&TypeName(objExchange_Logon.MailboxDisplayName)&"] "& _
objExchange_Logon.MailboxDisplayName
'
'
' Display the value of the MailboxLegacyDN property.
WScript.echo "MailboxLegacyDN = "& _
" ["&TypeName(objExchange_Logon.MailboxLegacyDN)&"] "& _
objExchange_Logon.MailboxLegacyDN
'
'
' Display the value of the MessagingOperationRate property.
WScript.echo "MessagingOperationRate = "& _
" ["&TypeName(objExchange_Logon.MessagingOperationRate)&"] "& _
objExchange_Logon.MessagingOperationRate
'
'
' Display the value of the OpenAttachmentCount property.
WScript.echo "OpenAttachmentCount = "& _
" ["&TypeName(objExchange_Logon.OpenAttachmentCount)&"] "& _
objExchange_Logon.OpenAttachmentCount
'
'
' Display the value of the OpenFolderCount property.
WScript.echo "OpenFolderCount = "& _
" ["&TypeName(objExchange_Logon.OpenFolderCount)&"] "& _
objExchange_Logon.OpenFolderCount
'
'
' Display the value of the OpenMessageCount property.
WScript.echo "OpenMessageCount = "& _
" ["&TypeName(objExchange_Logon.OpenMessageCount)&"] "& _
objExchange_Logon.OpenMessageCount
'
'
' Display the value of the OtherOperationRate property.
WScript.echo "OtherOperationRate = "& _
" ["&TypeName(objExchange_Logon.OtherOperationRate)&"] "& _
objExchange_Logon.OtherOperationRate
'
'
' Display the value of the ProgressOperationRate property.
WScript.echo "ProgressOperationRate = "& _
" ["&TypeName(objExchange_Logon.ProgressOperationRate)&"] "& _
objExchange_Logon.ProgressOperationRate
'
'
' Display the value of the RowID property.
WScript.echo "RowID = "& _
" ["&TypeName(objExchange_Logon.RowID)&"] "& _
objExchange_Logon.RowID
'
'
' Display the value of the RPCSucceeded property.
WScript.echo "RPCSucceeded = "& _
" ["&TypeName(objExchange_Logon.RPCSucceeded)&"] "& _
objExchange_Logon.RPCSucceeded
'
'
' Display the value of the ServerName property.
WScript.echo "ServerName = "& _
" ["&TypeName(objExchange_Logon.ServerName)&"] "& _
objExchange_Logon.ServerName
'
'
' Display the value of the StorageGroupName property.
WScript.echo "StorageGroupName = "& _
" ["&TypeName(objExchange_Logon.StorageGroupName)&"] "& _
objExchange_Logon.StorageGroupName
'
'
' Display the value of the StoreName property.
WScript.echo "StoreName = "& _
" ["&TypeName(objExchange_Logon.StoreName)&"] "& _
objExchange_Logon.StoreName
'
'
' Display the value of the StoreType property.
WScript.echo "StoreType = "& _
" ["&TypeName(objExchange_Logon.StoreType)&"] "& _
objExchange_Logon.StoreType
'
'
' Display the value of the StreamOperationRate property.
WScript.echo "StreamOperationRate = "& _
" ["&TypeName(objExchange_Logon.StreamOperationRate)&"] "& _
objExchange_Logon.StreamOperationRate
'
'
' Display the value of the TableOperationRate property.
WScript.echo "TableOperationRate = "& _
" ["&TypeName(objExchange_Logon.TableOperationRate)&"] "& _
objExchange_Logon.TableOperationRate
'
'
' Display the value of the TotalOperationRate property.
WScript.echo "TotalOperationRate = "& _
" ["&TypeName(objExchange_Logon.TotalOperationRate)&"] "& _
objExchange_Logon.TotalOperationRate
'
'
' Display the value of the TransferOperationRate property.
WScript.echo "TransferOperationRate = "& _
" ["&TypeName(objExchange_Logon.TransferOperationRate)&"] "& _
objExchange_Logon.TransferOperationRate
'
Next
Else
' If no Exchange_Logon instances were returned,
' display that.
WScript.Echo "WARNING: No Exchange_Logon instances were returned."
End If
End If
Send us your feedback about the Microsoft Exchange Server 2003 SDK.
Build: June 2007 (2007.618.1)
© 2003-2006 Microsoft Corporation. All rights reserved. Terms of use.