Export (0) Print
Expand All

ClusterStateString Property

Exchange Server 2003

ClusterStateString 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 ClusterStateString property specifies the state of the cluster resources on that server. The ClusterStateString property is read-only.

Applies To

The ClusterStateString property is a member of the ExchangeServerState Class.

Instance Path

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

MOF Syntax

string ClusterStateString;

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 ClusterStateString property is paired with the ClusterState Property.

VBScript Example

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

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

Show:
© 2014 Microsoft