LDAP FSMO Bind Availability Script Data Source

Microsoft.Windows.Server.2012.R2.AD.Availability.FsmoBind.DataSource (DataSourceModuleType)

Data Source for the LDAP FSMO Bind Availability monitors.

Element properties:

Member Modules:

Overrideable Parameters:

Source Code:

<DataSourceModuleType ID="Microsoft.Windows.Server.2012.R2.AD.Availability.FsmoBind.DataSource" Accessibility="Internal" Batching="false">

  <Configuration>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="IntervalSeconds" type="xsd:int"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="TimeoutSeconds" type="xsd:int"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="FsmoHolder" type="xsd:string"/>

    <xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="BindIterations" type="xsd:int"/>

  </Configuration>

  <OverrideableParameters>

    <OverrideableParameter ID="IntervalSeconds" Selector="$Config/IntervalSeconds$" ParameterType="int"/>

    <OverrideableParameter ID="TimeoutSeconds" Selector="$Config/TimeoutSeconds$" ParameterType="int"/>

    <OverrideableParameter ID="FsmoHolder" Selector="$Config/FsmoHolder$" ParameterType="string"/>

    <OverrideableParameter ID="BindIterations" Selector="$Config/BindIterations$" ParameterType="int"/>

  </OverrideableParameters>

  <ModuleImplementation Isolation="Any">

    <Composite>

      <MemberModules>

        <DataSource ID="DS" TypeID="System!System.CommandExecuterPropertyBagSource">

          <IntervalSeconds>$Config/IntervalSeconds$</IntervalSeconds>

          <ApplicationName>%windir%\system32\cscript.exe</ApplicationName>

          <WorkingDirectory/>

          <CommandLine>//nologo $file/LDAP_Bind_FSMO_Availability.vbs$ $Config/FsmoHolder$ $Config/BindIterations$</CommandLine>

          <TimeoutSeconds>$Config/TimeoutSeconds$</TimeoutSeconds>

          <RequireOutput>true</RequireOutput>

          <Files>

            <File>

              <Name>LDAP_Bind_FSMO_Availability.vbs</Name>

              <Contents><Script>'*************************************************************************

' Script Name - LDAP Bind FSMO Availability 

'

' Purpose     - Monitors that binds to a particular FSMO work as expected

'               

' (c) Copyright 2014, Microsoft Corporation, All Rights Reserved

' Proprietary and confidential to Microsoft Corporation              

'*************************************************************************



Option Explicit



SetLocale("en-us")



Sub Main()



  Dim oAPI, oBag, oParams, sError, sFsmoName

  Dim oBind, iIteration, iMaxIterations



  Set oAPI = CreateObject("Mom.ScriptAPI")  

  Set oBag = oAPI.CreatePropertyBag()

  Set oParams = WScript.Arguments



  if oParams.Count &lt;&gt; 2 then

      sError = "The number of command line arguments is incorrect: " &amp; vbCrLf &amp; _

               "Expected: 2" &amp; vbCrLf &amp; _

               "Actual: " &amp; oParams.Count

        

        oBag.AddValue "State", "BAD" 

        oBag.AddValue "ErrorString", sError



        Call oAPI.Return(oBag)

        Exit Sub 

  End if



  sFsmoName = oParams(0)

  iMaxIterations = CInt(oParams(1))

  

  if iMaxIterations &lt; 1 then

    iMaxIterations = 3

  End if



  On Error Resume Next



  Set oBind = GetObjectWithRetry("LDAP://" &amp; sFsmoName &amp; "/rootDSE", iMaxIterations)



  If (Err.Number = 0) Then

    oBag.AddValue "State", "GOOD"

    oAPI.AddItem oBag    

        

    Call oAPI.Return(oBag)

    Exit Sub               

  End If



  oBag.AddValue "State", "BAD"

  oBag.AddValue "ErrorString", "Unable to bind to the FSMO holder " &amp; sFsmoName &amp; ".  Ensure that the domain controller is online and healthy." &amp; GetErrorString(Err)

  oAPI.AddItem oBag   



  oAPI.ReturnItems 

End Sub



'******************************************************************************

' Name:         GetObjectWithRetry

'

' Purpose:      Gets object instance, retrying attempt iRetryMax times if GetObject fails

'

' Parameters:    strObjectQuery, the string paramenter for GetObject

'		iRetryMax, the integer parameter for retry iterations max

'

' Return:       Object instance

'

Function GetObjectWithRetry(strObjectQuery, iRetryMax)

  dim ret, iRetry

  iRetry = 0



  On Error Resume Next 



  Do

    'Reset Err object

    Err.Clear



    'Attempt to get an object

    Set ret = GetObject(strObjectQuery)



    'If no errors then skip retry 

    If Err = 0 Then        

      Exit Do

    End If



    'Wait a sec before next attempt

    wscript.sleep(1000)



    iRetry = iRetry + 1

  Loop While (iRetry &lt; iRetryMax) 



  Set GetObjectWithRetry = ret

End Function



'******************************************************************************

' Name:         GetErrorString

'

' Purpose:      Attempts to find the description for an error if an error with 

'               no description is passed in.

' 

' Parameters:   oErr, the error object

'

' Return:       String, the description for the error.  (Includes the error code.)

'

Function GetErrorString(oErr)

  Dim lErr, strErr

  lErr = oErr

  strErr = oErr.Description



  On Error Resume Next

  If 0 &gt;= Len(strErr) Then

    ' If we don't have an error description, then check to see if the error

    ' is a 0x8007xxxx error.  If it is, then look it up.

    Const ErrorMask = &amp;HFFFF0000  

    Const HiWord8007 = &amp;H80070000

    Const LoWordMask = 65535          ' This is equivalent to 0x0000FFFF



    If (lErr And ErrorMask) = HiWord8007 Then

      ' Attempt to use 'net helpmsg' to get a description for the error.

      Dim oShell

      Set oShell = CreateObject("WScript.Shell")

      If Err = 0 Then

        Dim oExec 

        Set oExec = oShell.Exec("net helpmsg " &amp; (lErr And LoWordMask))



        Dim strMessage, i

        Do

          strMessage = oExec.stdout.ReadLine()

          i = i + 1

        Loop While (Len(strMessage) = 0) And (i &lt; 5)



        strErr = strMessage

      End If

    End If	

  End If



  GetErrorString = vbCrLf &amp; vbCrLf &amp; "The error returned was: '" &amp; strErr &amp; "' (0x" &amp; Hex(lErr) &amp; ")"

End Function



Call Main()

</Script></Contents>

              <Unicode>1</Unicode>

            </File>

          </Files>

        </DataSource>

      </MemberModules>

      <Composition>

        <Node ID="DS"/>

      </Composition>

    </Composite>

  </ModuleImplementation>

  <OutputType>System!System.PropertyBagData</OutputType>

</DataSourceModuleType>