ExchangeServerState Class

  • Article

ExchangeServerState 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.

The ExchangeServerState WMI class has properties that return information about the computer running Microsoft® Exchange 2000 Server.

Namespace

\\COMPUTERNAME\ROOT\cimv2\applications\exchange:ExchangeServerState

Provider

The ExchangeRoutingTableProvider supplies instances of the ExchangeServerState class.

Origin

The ExchangeServerState class does not extend any other class.

Qualifiers

dynamic

Properties

Property Description
DN Property 
[key] string DN;

The DN property specifies the Microsoft Active Directory® distinguished name (DN) of the Exchange server object.
ClusterState Property 
[Values{"Unknown", "OK", "Warning",
   "Error"},
 ValueMap{"0", "1", "2", "3"}] uint8 ClusterState;

When the ExchangeServerState instance represents a clustered Exchange server, the ClusterState property specifies the state of the clustered resources on that server.
ClusterStateString Property 
string ClusterStateString;

When the ExchangeServerState instance represents a clustered Exchange server, the ClusterStateString property specifies the state of the cluster resources on that server.
CPUState Property 
[Values{"Unknown", "OK", "Warning",
   "Error"},
 ValueMap{"0", "1", "2", "3"}] uint8 CPUState;

The CPUState property specifies the current state of the CPU on the Exchange server. This is the same state information shown on the Monitoring and Status Properties page of the Exchange System Manager.
CPUStateString Property 
string CPUStateString;

The CPUStateString property specifies the current state of the CPU on the Exchange server.
DisksState Property 
[Values{"Unknown", "OK", "Warning",
   "Error"},
 ValueMap{"0", "1", "2", "3"}] uint8 DisksState;

The DisksState property specifies the current state of the disk storage on the computer running Exchange 2000 Server.
DisksStateString Property 
string DisksStateString;

The DisksStateString property specifies the current state of the disk storage on the computer running Exchange 2000 Server.
GroupDN Property 
string GroupDN;

The GroupDN property specifies the DN of the Exchange 2000 Server routing group in Active Directory.
GroupGUID Property 
string GroupGUID;

The GroupGUID property specifies the globally unique identifier (GUID) of the Exchange 2000 Server routing group in Active Directory.
GUID Property 
string GUID;

The GUID property specifies the GUID of the Exchange 2000 Server server object in Active Directory.
MemoryState Property 
[Values{"Unknown", "OK", "Warning",
   "Error"},
 ValueMap{"0", "1", "2", "3"}] uint8 MemoryState;

The MemoryState property specifies the current state of the memory on the computer running Exchange 2000 Server.
MemoryStateString Property 
string MemoryStateString;

The MemoryStateString property specifies the current state of the memory on the computer running Exchange 2000 Server.
Name Property 
string Name;

The Name property specifies the name of the computer running Exchange 2000 Server.
QueuesState Property 
[Values{"Unknown", "OK", "Warning",
   "Error"},
 ValueMap{"0", "1", "2", "3"}] uint8 QueuesState;

The QueuesState property specifies the current state of the queues on the computer running Exchange 2000 Server.
QueuesStateString Property 
string QueuesStateString;

The QueuesStateString property specifies the current state of the queues on the computer running Exchange 2000 Server.
ServerMaintenance Property 
boolean ServerMaintenance;

The ServerMaintenance property, when True, specifies that the notifications set up in the Exchange 2000 Server System Manager Monitoring and Status page have been disabled.
ServerState Property 
[Values{"Unknown", "OK", "Warning",
   "Error"},
 ValueMap{"0", "1", "2", "3"}] uint8 ServerState;

The ServerState property specifies the current state of the computer running Exchange 2000 Server.
ServerStateString Property 
string ServerStateString;

The ServerStateString property specifies the current state of the computer running Exchange 2000 Server.
ServicesState Property 
[Values{"Unknown", "OK", "Warning",
   "Error"},
 ValueMap{"0", "1", "2", "3"}] uint8 ServicesState;

The ServicesState property specifies the current state of the monitoring services running on the Exchange 2000 Server computer.
ServicesStateString Property 
string ServicesStateString;

The ServicesStateString property specifies the current state of the monitoring services running on the Exchange 2000 Server computer.
Unreachable Property 
boolean Unreachable;

The Unreachable property, when True, specifies that the Exchange 2000 Server computer is currently unreachable.
Version Property 
uint32 Version;

The Version property indicates the version of the Exchange server.

Methods

This class has no methods.

Associations

This class has no associations.

VBScript Example

The following example shows how to retrieve a list of ExchangeServerState instances, and how to retrieve the associated properties.

'===============================================================
' Name:      ShowServerState_AllProperties
' Purpose:   Display each ExchangeServerState found for the
'            Exchange server specified, and the properties on
'            the ExchangeServerState instance
'            objects.
' Input:     strComputerName [string] the computer to access
' Output:    Displays the name of each ExchangeServerState and
'            properties.
'===============================================================
Public Sub ShowServerState_AllProperties ( strComputerName )

Const cWMINameSpace = "root/cimv2/applications/exchange"
Const cWMIInstance = "ExchangeServerState"

Dim strWinMgmts              ' Connection string for WMI
Dim objWMIExchange           ' Exchange Namespace WMI object
Dim listServerStates         ' ExchangeServerState collection
Dim objExchangeServerState   ' A single ExchangeServerState object

' Create the object string, indicating WMI (winmgmts), using the
' current user credentials (impersonationLevel=impersonate),
' on the computer passed to the function in strComputerName, and
' using the CIM namespace for the ExchangeServerState provider.
strWinMgmts = "winmgmts:{impersonationLevel=impersonate}!//" & _
   strComputerName & "/" & cWMINameSpace
'
' Get an object using the string you just created.
Set objWMIExchange =  GetObject(strWinMgmts)
'
' The current state of each Exchange server is represented
' by an ExchangeServerState instance within the Exchange
' namespace."
Set listServerStates = objWMIExchange.InstancesOf(cWMIInstance)
'
' Were any ExchangeServerState instances returned?
if (listServerStates.count > 0) then
  ' If yes, do the following:
  ' Iterate through the list of ExchangeServerState objects.
  For each objExchangeServerState in listServerStates
     '
     ' Display the value of the Name property.
     WScript.echo "Name                 = [" & _
       TypeName(objExchangeServerState.Name) & "] " & _
      objExchangeServerState.Name
     '
     ' Display the value of the LinkName property.
     WScript.echo "    DN                   = " & _
      "[" & TypeName(objExchangeServerState.DN) & "] " & _
       objExchangeServerState.DN
     '
     ' Display the value of the GroupDN property.
     WScript.echo "    GroupDN              = [" & _
       TypeName(objExchangeServerState.GroupDN) & "] " & _
      objExchangeServerState.GroupDN
     '
     ' Display the value of the GroupGUID property.
     WScript.echo "    GroupGUID            = [" & _
       TypeName(objExchangeServerState.GroupGUID) & "] " & _
      objExchangeServerState.GroupGUID
     '
     ' Display the value of the GUID property.
     WScript.echo "    GUID                 = [" & _
       TypeName(objExchangeServerState.GUID) & "] " & _
      objExchangeServerState.GUID
     '
     ' Display the value of the ServerMaintenance property.
     WScript.echo "    ServerMaintenance    = [" & _
       TypeName(objExchangeServerState.ServerMaintenance) & "] " & _
      objExchangeServerState.ServerMaintenance
     '
     ' Display the value of the Unreachable property.
     WScript.echo "    Unreachable          = [" & _
       TypeName(objExchangeServerState.Unreachable) & "] " & _
      objExchangeServerState.Unreachable
     '
     ' Display the value of the Version property.
     WScript.echo "    Version              = [" & _
       TypeName(objExchangeServerState.Version) & "] " & _
      objExchangeServerState.Version
     '
     ' Display the value of the ClusterState property.
     WScript.echo "    ClusterState         = [" & _
       TypeName(objExchangeServerState.ClusterState) & "] " & _
      objExchangeServerState.ClusterState
     '
     ' Display the value of the ClusterStateString property.
     WScript.echo "    ClusterStateString   = [" & _
       TypeName(objExchangeServerState.ClusterStateString) & "] " & _
      objExchangeServerState.ClusterStateString
     '
     ' Display the value of the CPUState property.
     WScript.echo "    CPUState             = [" & _
       TypeName(objExchangeServerState.CPUState) & "] " & _
      objExchangeServerState.CPUState
     '
     ' Display the value of the CPUStateString property.
     WScript.echo "    CPUStateString       = [" & _
       TypeName(objExchangeServerState.CPUStateString) & "] " & _
      objExchangeServerState.CPUStateString
     '
     ' Display the value of the DisksState property.
     WScript.echo "    DisksState           = [" & _
       TypeName(objExchangeServerState.DisksState) & "] " & _
      objExchangeServerState.DisksState
     '
     ' Display the value of the DisksStateString property.
     WScript.echo "    DisksStateString     = [" & _
       TypeName(objExchangeServerState.DisksStateString) & "] " & _
      objExchangeServerState.DisksStateString
     '
     ' Display the value of the MemoryState property.
     WScript.echo "    MemoryState          = [" & _
       TypeName(objExchangeServerState.MemoryState) & "] " & _
      objExchangeServerState.MemoryState
     '
     ' Display the value of the MemoryStateString property.
     WScript.echo "    MemoryStateString    = [" & _
       TypeName(objExchangeServerState.MemoryStateString) & "] " & _
      objExchangeServerState.MemoryStateString
     '
     ' Display the value of the QueuesState property.
     WScript.echo "    QueuesState          = [" & _
       TypeName(objExchangeServerState.QueuesState) & "] " & _
      objExchangeServerState.QueuesState
     '
     ' Display the value of the QueuesStateString property.
     WScript.echo "    QueuesStateString    = [" & _
       TypeName(objExchangeServerState.QueuesStateString) & "] " & _
      objExchangeServerState.QueuesStateString
     '
     ' Display the value of the ServerState property.
     WScript.echo "    ServerState          = [" & _
       TypeName(objExchangeServerState.ServerState) & "] " & _
      objExchangeServerState.ServerState
     '
     ' Display the value of the ServerStateString property.
     WScript.echo "    ServerStateString    = [" & _
       TypeName(objExchangeServerState.ServerStateString) & "] " & _
      objExchangeServerState.ServerStateString
     '
     ' Display the value of the ServicesState property.
     WScript.echo "    ServicesState        = [" & _
       TypeName(objExchangeServerState.ServicesState) & "] " & _
      objExchangeServerState.ServicesState
     '
     ' Display the value of the ServicesStateString property.
     WScript.echo "    ServicesStateString  = [" & _
       TypeName(objExchangeServerState.ServicesStateString) & "] " & _
      objExchangeServerState.ServicesStateString
     '
     ' Move to the next ExchangeServerState.
  Next
else
  ' If no ExchangeServerState instances were returned,
  ' display that.
  WScript.Echo "No ExchangeServerState instances were returned."
end if
end Sub

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.