ClusterState Property

ClusterState Property

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.

When the ExchangeServerState instance represents a clustered Microsoft Exchange server, the ClusterState property specifies the state of the clustered resources on that server. The ClusterState property is read-only.

Applies To

The ClusterState property is a member of the ExchangeServerState Class.

Instance Path

The ClusterState property appears on instances of the \\COMPUTERNAME\ROOT\cimv2\applications\exchange:ExchangeServerState class.

MOF Syntax

[Values{"Unknown", "OK", "Warning", "Error"},
 ValueMap{"0", "1", "2", "3"}] uint8 ClusterState;

Qualifiers

This property has no qualifiers.

Remarks

This is the same state information shown on the Monitoring and Status Properties page of the Exchange System Manager. The ClusterState property is paired with the ClusterStateString Property.

Property Values Map

The following table lists the ClusterState allowed values.

Value Name	Value	Description
Unknown	0
OK	1
Warning	2
Error	3

VBScript Example

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

'===============================================================
' Name:      ShowServerState_ClusterState
' Purpose:   Display each ExchangeServerState found for the
'            Exchange server, and the ClusterState
'            property on the ExchangeServerState instances.
' Input:     strComputerName [string] the computer to access
' Output:    Displays the name of each ExchangeServerState and
'            ClusterState property.
'===============================================================
Public Sub ShowServerState_ClusterState ( 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 ClusterState property.
     WScript.echo "    ClusterState = " & _
      "[" & TypeName(objExchangeServerState.ClusterState) & "] " & _
       objExchangeServerState.ClusterState
     '
     '
     ' 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.