AD Lost and Found Object Data Source

Microsoft.Windows.Server.2012.R2.AD.LostObjectCount.DataSource (DataSourceModuleType)

Data Source for the AD Lost and Found Object monitors.

Element properties:

TypeDataSourceModuleType
IsolationAny
AccessibilityInternal
RunAsDefault
OutputTypeSystem.PropertyBagData

Member Modules:

ID Module Type TypeId RunAs 
DS DataSource System.CommandExecuterPropertyBagSource Default

Overrideable Parameters:

IDParameterTypeSelectorDisplay NameDescription
Frequencyint$Config/Frequency$FrequencyHow often the monitor is run
TimeoutSecondsint$Config/TimeoutSeconds$Timeout Seconds
Thresholdint$Config/Threshold$Number of

Source Code:

<DataSourceModuleType ID="Microsoft.Windows.Server.2012.R2.AD.LostObjectCount.DataSource" Accessibility="Internal" Batching="false">
<Configuration>
<xsd:element xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="Frequency" 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="Threshold" type="xsd:int"/>
</Configuration>
<OverrideableParameters>
<OverrideableParameter ID="Frequency" Selector="$Config/Frequency$" ParameterType="int"/>
<OverrideableParameter ID="TimeoutSeconds" Selector="$Config/TimeoutSeconds$" ParameterType="int"/>
<OverrideableParameter ID="Threshold" Selector="$Config/Threshold$" ParameterType="int"/>
</OverrideableParameters>
<ModuleImplementation Isolation="Any">
<Composite>
<MemberModules>
<DataSource ID="DS" TypeID="System!System.CommandExecuterPropertyBagSource">
<IntervalSeconds>$Config/Frequency$</IntervalSeconds>
<ApplicationName>%windir%\system32\cscript.exe</ApplicationName>
<WorkingDirectory/>
<CommandLine>//nologo $file/AD_Lost_And_Found_Object_Count.vbs$ $Config/Threshold$</CommandLine>
<TimeoutSeconds>$Config/TimeoutSeconds$</TimeoutSeconds>
<RequireOutput>true</RequireOutput>
<Files>
<File>
<Name>AD_Lost_And_Found_Object_Count.vbs</Name>
<Contents><Script>'*************************************************************************
' Script Name - AD Lost And Found Object Count
'
' Purpose - Monitors the number of objects in lost and found container
'
' (c) Copyright 2014, Microsoft Corporation, All Rights Reserved
' Proprietary and confidential to Microsoft Corporation
'*************************************************************************

Option Explicit

SetLocale("en-us")

Sub Main()

Dim oParams, oAPI, oBag, sError, iThreshold, oADO, oCmd, oRoot, strDNSDomain, oRecords
Set oParams = WScript.Arguments

Set oAPI = CreateObject("Mom.ScriptAPI")
Set oBag = oAPI.CreatePropertyBag()

if oParams.Count &lt;&gt; 1 then
sError = "The number of command line arguments is incorrect: " &amp; vbCrLf &amp; _
"Expected: 1" &amp; vbCrLf &amp; _
"Actual: " &amp; oParams.Count

oBag.AddValue "State", "BAD"
oBag.AddValue "ErrorString", sError

Call oAPI.Return(oBag)
Exit Sub
End if

iThreshold = CInt(oParams(0))
Err.Clear

On Error Resume Next

Set oADO = CreateObject("ADODB.Connection")
If Err Then
oBag.AddValue "State", "BAD"
oBag.AddValue "ErrorString", "Unable to create ADODB Connection." &amp; GetErrorString(Err)

Call oAPI.Return(oBag)
Exit Sub
End IF

Set oCmd = CreateObject("ADODB.Command")
If Err Then
oBag.AddValue "State", "BAD"
oBag.AddValue "ErrorString", "Unable to create ADODB Command." &amp; GetErrorString(Err)

Call oAPI.Return(oBag)
Exit Sub
End IF

oADO.Provider = "ADsDSOObject"
oADO.Open "Active Directory Provider"
Set oCmd.ActiveConnection = oADO

oCmd.Properties("Page Size") = 100
oCmd.Properties("Searchscope") = 2

set oRoot = GetObject("LDAP://RootDSE")
If Err Then
oBag.AddValue "State", "BAD"
oBag.AddValue "ErrorString", "Unable to contact Root DSE." &amp; GetErrorString(Err)

Call oAPI.Return(oBag)
Exit Sub
End If

strDNSDomain = oRoot.Get("defaultNamingContext")

If Err Then
oBag.AddValue "State", "BAD"
oBag.AddValue "ErrorString", "Unable to connect to the default naming context." &amp; GetErrorString(Err)

Call oAPI.Return(oBag)
Exit Sub
End If

oCmd.CommandText = "Select Name From 'LDAP://CN=LostAndFound," &amp; strDNSDomain &amp; "'"
set oRecords = oCmd.Execute

If Err Then
oBag.AddValue "State", "BAD"
oBag.AddValue "ErrorString", "Unable to query the LostAndFound container to obtain object count." &amp; vbCrLf &amp; _
"Query: " &amp; oCmd.CommandText &amp; GetErrorString(Err)

Call oAPI.Return(oBag)
Exit Sub
End If

if (iThreshold &gt; (oRecords.RecordCount - 1)) Then
oBag.AddValue "State", "GOOD"
Else
sError = "The number of objects in the Lost and Found container is above the configured threshold:" &amp; vbCrLf &amp; _
"Threshold: " &amp; iThreshold &amp; vbCrLf &amp; _
"Objects: " &amp; (oRecords.RecordCount - 1)

oBag.AddValue "State", "BAD"
oBag.AddValue "ErrorString", sError
End If

Call oAPI.Return(oBag)

End Sub

'******************************************************************************
' 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>
</File>
</Files>
</DataSource>
</MemberModules>
<Composition>
<Node ID="DS"/>
</Composition>
</Composite>
</ModuleImplementation>
<OutputType>System!System.PropertyBagData</OutputType>
</DataSourceModuleType>