[SCOM 2007] Authoring Management Pack - Create a VBS discovery with a debugging functionnality - PART II

Now we have all needed function (see PART I of this article), we can create a new Management Pack by using the authoring console.

Create a new MP with the Authoring Console : MyNewMP.xml witha "Microsoft.Windows.Local Application" Class nammed MyNewMP.CLS1.

Add a new property to this class : DebugMod

Then create a new discovery MyNewMP.DSC1 that target Microsoft.Windows.Server.Computer and discover the class MyNewMP.CLS1 and all its attributes.

Choose the disovery type : Microsoft.Windows.TimedScript.DiscoveryProvider and schedule it once a day and call your script MyNewMP.DSC1.script.vbs. Click on Parameters and add 3 parameters like :

$MPElement$ $Target/Id$ $Target/Property[Type="Windows!Microsoft.Windows.Computer"]/PrincipalName$

In the Script field you will have to paste the discovery script below :

1. First part of the discovery script is to declare and set the variable
2. Option Explicit
3. SetLocale("en-us")
4. '-----------------------------------------------------------------------------------------------------
5. ' DEFAULT VARIABLES AND CONST - Used by the debuging functions and sub
6. '-----------------------------------------------------------------------------------------------------
7. Const REGKEYPATH = "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Microsoft Operations Manager\Debugging"
8. Const REGISTRYDEFVALUE = "FALSE"
9. Const MOMEVENTLOGERROR = "1"
10. Const MOMEVENTLOGWARNING = "2"
11. Const MOMEVENTLOGINFORMATION = "4"
12. Dim intIndex
13. Dim strRegValue
14. Dim strRegKeyName
15. Dim strMPScriptName
16. Dim strCurrentDebugModeValue
17. Dim oAPI
18. Dim oInst
19. Dim oArgs
20. Dim oDiscoveryData
21. '-----------------------------------------------------------------------------------------------------
22. ' SET THE FOLLOWING VALUES ACCORDING TO YOUR MANAGEMENT PACK
23. '----------------------------------------------------------------------------------------------------
24. strMPScriptName = "MyNewMP.DSC1.vbs"
25. strRegKeyName = "Verbose.MyNewMP"
26. '-----------------------------------------------------------------------------------------------------
27. ' Create the object that connect to MOM API
28. Set oAPI = CreateObject("MOM.ScriptAPI")

The second part of the discovery will be dedicated to all function seens in Part I of this article :

1. '-----------------------------------------------------------------------------------------------------
2. ' DEFAULT FUNCTIONS - Used for Management Pack debugging
3. '-----------------------------------------------------------------------------------------------------
4. Private Function fct_ReadRegistryKey(ByVal strKeyPath, ByVal strKeyName)
5. 'Read Registry key located on KeyPath\KeyName
6. 'Returns the value of a registry key and eventually a no-value to identify that the key does not exists.
7.            Dim oWshShell
8.             Dim strRegReadValue     'Contains the value of the Registry Key
10.             'Try to read the registry key located to strKeyPath\strKeyName
11.             On Error Resume Next
12.             Set oWshShell = CreateObject("Wscript.Shell")
13.             strRegReadValue = oWshShell.RegRead(strKeyPath &"\" & strKeyName)
15.             'If an error is raised Then we a no-value to identify that the Registry Key does not exist.
16.             If err.number <> 0 Then
17.                         strRegReadValue = ""
18.             End if
20.             On error goto 0
21.             fct_ReadRegistryKey = UCase(strRegReadValue)
23. End Function
24. '-----------------------------------------------------------------------------------------------------
26. Private Function fct_WriteRegistryKey(ByVal strKeyPath, ByVal strKeyName, ByVal strKeyValue)
27. ' Write a Registry value to strKeyPath\strKeyName with value strKeyValue
28. ' blnKeyEdit is set to True or false in case of error.
29.             Dim blnKeyEdit
30.             Dim oWshShell
31.             blnKeyEdit = false
33.             'Try to set strKeyValue to the registry key strKeyPath\strKeyName
34.             On Error Resume Next
35.             Set oWshShell = WScript.CreateObject("WScript.Shell")
36.             oWshShell.RegWrite strKeyPath & "\" & strKeyName , UCase(strKeyValue)
38.             'If setting the registry key strKeyValue is OK Then the function will return a string TRUE.
39.             If err.number = 0 Then
40.                         blnKeyEdit = true
41.             End if
42.             On error goto 0
44.             fct_WriteRegistryKey = blnKeyEdit
45. End Function
46. '-----------------------------------------------------------------------------------------------------
48. Private Sub sub_LogMPScriptEvent(ByVal intErrNumber, ByVal strEventLogMessage, ByRef objError, ByVal strDebugMod, ByVal strScriptName, ByVal strMomEventLevel)
49. ' Log an event in the OperationManager eventLog of the server if it is in debug mode
50. ' It will allow to trace the debugging process of the script of the Management Pack by logging errors and parameters values
52.             Dim strMessage
53.              strMessage=""
54.              'If the debug mode is ON, an event is logged in the Operation Manager eventLog.
55.             If ucase(strDebugMod) = "TRUE" Then
56.                         strMessage = strEventLogMessage & vbCrLf & " " & vbCrLf & _
57.                         "Error number:" & vbTab & CStr(objError.Number) & vbCrLf & _ 
58.                         "Error description:" & vbTab & objError.Description
59.             Call oAPI.LogScriptEvent(strScriptName, intErrNumber, strMomEventLevel, strMessage)
60.             End if
61. End Sub
62. '-----------------------------------------------------------------------------------------------------
64. Private function fct_LogRunningAccount(ByVal strDebugMode)
65. ' Log an event in the OperationManager eventLog of the server if it is in debug mode
66. ' It allows to know under which credentials the script is executed
68.             Dim owshNetwork
69.             Dim strRunningUserID
71.             On Error Resume Next
72.             Set owshNetwork = WScript.CreateObject("WScript.Network")
74.             'Assign user name returned to a variable
75.             strRunningUserID = owshNetwork.UserName
76.             
77.             call sub_LogMPScriptEvent (4005, "sub_LogMPScriptEvent. Script running as user: " & strRunningUserID , Err, strDebugMode,strMPScriptName,MOMEVENTLOGINFORMATION)
79.             On error goto 0
80.             fct_LogRunningAccount = strRunningUserID
81. End Function
82. '-----------------------------------------------------------------------------------------------------
84. private sub sub_LogScriptStartInfo(byRef oArgs, byVal strDebugModeValue, byval strMomLevelEvent, byVal strScriptName)
85. ' Log an event with the default informations. The event contains :
86. ' - The account used to run the script
87. ' - The number of script parameters
88. ' - The values of the parameters
89. ' - The value of the debug mode
91.             Dim owshNetwork
92.             Dim strLogMessage
93.             Dim strRunAsAccount
95.             On Error Resume Next
96.             Set owshNetwork = WScript.CreateObject("WScript.Network")
98.             'Assign user name returned to a variable
99.             strRunAsAccount = owshNetwork.UserName
100.              strLogMessage=""
102.             ' Create the start log Script with launch information data RunAs account, debugmode, arguments)
103.             strLogMessage = vbcrlf & "The script has been launched under following credentials : " &             strRunAsAccount & "." & vbcrlf & vbcrlf & oArgs.count & " arguments have been passed in parameter : "
105.             For intIndex = 0 To oArgs.Count-1
106.                         strLogMessage = strLogMessage & vbcrlf & " - " & oArgs(intIndex)
107.             Next
109.             strLogMessage = strLogMessage & vbcrlf & vbcrlf & "The debug mode value for the Management Pack is set to : " & strDebugModeValue
111.             Call oAPI.LogScriptEvent(strScriptName, 10212, strMomLevelEvent, strLogMessage)
112. End sub
113. '-----------------------------------------------------------------------------------------------------

 And the next part of the discovery will be the main part that will test the number of arguments and create / read the debugging registry key :

1. '-----------------------------------------------------------------------------------------------------
2. ' MAIN CODE START HERE
3. '-----------------------------------------------------------------------------------------------------
4. ' Gets the arguments passed in parameters of the script
5. Set oArgs = Wscript.Arguments
6. ' If the minimals arguments are not set then we exit the script
7. if oArgs.Count < 3 Then
8.    Wscript.Quit -1
9. End If
10. ' Check the value of the registry key on the server to know if the debug mode is ON or not

strRegValue = ""

11. 'By default the registry key is set to : DOES NOT EXIST. See fct_ReadRegistryKey for more information
12. strRegValue = fct_ReadRegistryKey(REGKEYPATH, strRegKeyName)
13. 'If the registry key is TRUE XOR FALSE then the debugmodevalue has a good value
14. If ((strRegValue = "TRUE") Xor (strRegValue = "FALSE")) Then
15.             strCurrentDebugModeValue = strRegValue
16. Else
17.             'If the registry key is empty or not correctly set then a attempt to set to default value is made.
18.             If fct_WriteRegistryKey(REGKEYPATH, strRegKeyName, REGISTRYDEFVALUE) Then
19.                         ' write event 10211 that says the registry key has been created
20.                         call sub_LogMPScriptEvent (10211, "Registry Key " & REGKEYPATH & "\" & strRegKeyName & " With Value = " & REGISTRYDEFVALUE & " has been created", Err, True,strMPScriptName,MOMEVENTLOGINFORMATION)
21.             Else
22.                         ' write event 10210 that says the registry key has not been created
23.                         call sub_LogMPScriptEvent (10210, "Error in creation of the Registry Key " & REGKEYPATH & "\" & strRegKeyName & " With Value = " & REGISTRYDEFVALUE , Err, True,strMPScriptName,MOMEVENTLOGERROR)
24.             End if
25.             strCurrentDebugModeValue = REGISTRYDEFVALUE
26. End if The discovery itself : 'Return Data to the Management PackCall oDiscoveryData.AddInstance(oInst)

Call oAPI.Return(oDiscoveryData)

29.  
30. Dim intSourceType
31. Dim strSourceId0
32. Dim strTargetComputer
33. Dim strManagedEntityId
34. intSourceType =
35. 'Set the arguments for creating the default Management Pack modules.strSourceId = oArgs(0)
36. strManagedEntityId = oArgs(1)
37. strTargetComputer = oArgs(2)
38. 'Create the default management pack classSet oDiscoveryData = oAPI.CreateDiscoveryData(intSourceType, strSourceId, strManagedEntityId)
39. Set oInst = oDiscoveryData.CreateClassInstance("$MPElement[Name='MyNewMP.CLS1']$")
40. call oInst.AddProperty("$MPElement[Name='Windows!Microsoft.Windows.Computer']/PrincipalName$", strTargetComputer)
41. call oInst.AddProperty("$MPElement[Name='System!System.Entity']/DisplayName$", "MyNewMP")
42. call oInst.AddProperty("$MPElement[Name='MyNewMP.CLS1']/DebugMod$", strCurrentDebugModeValue)
44.  
45. call sub_LogMPScriptEvent (10213, "Server "& strTargetComputer & " has been discovered. The debug mode value on this server is set to " & strCurrentDebugModeValue, Err, strCurrentDebugModeValue,strMPScriptName,MOMEVENTLOGINFORMATION)
46. '-----------------------------------------------------------------------------------------------------
47. ' PUT YOUR DISCOVERY CODE AFTER
48. '-----------------------------------------------------------------------------------------------------
49. 'Return Data to the Management PackCall oDiscoveryData.AddInstance(oInst)
51. Call oAPI.Return(oDiscoveryData)

'Log the Management Pack default informations with runas account, debugmode and parameters info call sub_LogScriptStartInfo(oArgs, strCurrentDebugModeValue, MOMEVENTLOGINFORMATION, strMPScriptName)

How to use the debugging functionnality will be explained in PART III

End of PART II

Back to Part I                                                                                         Go to Part III

This posting is provided "AS IS" with no warranties.