ClusterInformation

[This documentation is preliminary and is subject to change.]

The ClusterInformation object contains read-only AD RMS configuration information. You can retrieve the object by calling the ClusterInformation property on the ConfigurationManager object.

Methods

The ClusterInformation object does not define any methods.

Properties

The ClusterInformation object has the following properties.

Property Description
AdminContactEmail Retrieves the e-mail address of the AD RMS administrator.
ClusterType Retrieves an integer value that identifies whether the AD RMS cluster supports the RMS Licensing Web service or the RMS Account Certification Web service.
IsDecommissioned Retrieves a Boolean value that specifies whether the AD RMS Licensing service and the AD RMS Account Certification service have been decommissioned.
Servers Retrieves a collection that contains the names of the servers in the AD RMS cluster.
Urls Retrieves an Urls object that contains enterprise service URLs.

Example Code [VBScript]

DIM config_manager
DIM admin_role

' *******************************************************************
' Create and initialize a ConfigurationManager object.

SUB InitObject()

  CALL WScript.Echo( "Create ConfigurationManager object...")
  SET config_manager = CreateObject _
    ("Microsoft.RightsManagementServices.Admin.ConfigurationManager")      
  CheckError()
    
  CALL WScript.Echo( "Initialize...")
  admin_role=config_manager.Initialize(false,"localhost",80,"","","")
  CheckError()

END SUB

' *******************************************************************
' Retrieve a ClusterInformation object. Determine whether the
' referenced site has been decommissioned.

SUB ChkClusterInfo()

  DIM cluster_info

  SET cluster_info = config_manager.ClusterInformation
  CheckError()

  IF cluster_info.IsDecommissioned THEN
    CALL WScript.Echo( "   ***The site is decommissioned***" )
    EXIT SUB
  END IF

END SUB


' *******************************************************************
' Error checking function.

FUNCTION CheckError()
  CheckError = Err.number
  IF Err.number <> 0 THEN
    CALL WScript.Echo( vbTab & "*****Error Number: " _
                       & Err.number _
                       & " Desc:" _
                       & Err.Description _
                       & "*****")
    WScript.StdErr.Write(Err.Description)
    WScript.Quit( Err.number )
  END IF
END FUNCTION

' *******************************************************************
' Generate a runtime error.

SUB RaiseError(errId, desc)
  CALL Err.Raise( errId, "", desc )
  CheckError()
END SUB

Requirements

Product Requires Windows ServerĀ "Longhorn".
Library

Use Microsoft.RightsManagementServices.Admin.dll registered as a custom type library.

See Also

Active Directory Rights Management Services Scripting API