Const EVENT_ID_SUCCESS = 1000 'Use IDs in the range 1 - 1000
Const EVENT_ID_SCRIPTERROR = 999 'Then you can use eventcreate.exe to test the MP
Dim mblnLogSuccessEvent 'As Boolean
Dim mstrIdentifier 'As String
Call Main
'*********************************************************************************************
' PROCEDURE: Main
' DESCRIPTION: Reads the script parameters, gets the cluster name and
' discovers the containment relationship between a cluster and
' the targeted cluster virtual server.
' PARAMETERS: void
'*********************************************************************************************
Private Sub Main()
' Targeted at Microsoft.Windows.Cluster.VirtualServer (based on Microsoft.Windows.Server.Computer)
Dim strSourceID 'As String '= oArgs(4). strSourceId is the GUID of the discovery object that runs the script (MPElement).
Dim strManagedEntityId 'As String '= oArgs(5) - strManagedEntityId is the GUID of the computer class that is targeted by the script (Target/Id).
Dim strTargetComputer 'As String '= oArgs(6)
Dim objMomScriptAPI 'As MOM.ScriptAPI
Dim objDiscoveryData 'As DiscoveryData
Dim blnSuccess 'As Boolean
Dim strErrorMessage
Dim bIsOsSupported
bIsOsSupported = False
On Error Resume Next
Err.Clear
Set objMomScriptAPI = CreateObject("MOM.ScriptAPI")
If Err.Number <> 0 Then
Exit Sub
End If
If Not GetScriptParameters(strSourceID, strManagedEntityId, strTargetComputer) Then
' If the script is called without the required arguments,
' create an information event and then quit.
strErrorMessage = "The script was called with fewer than five arguments or the arguments could not be parsed."
Call LogScriptEvent(0, EVENT_ID_SCRIPTERROR, EVENT_TYPE_WARNING, strErrorMessage,objMomScriptAPI)
WScript.Quit(-1)
End If
'Create new discovery data object
Set objDiscoveryData = objMomScriptAPI.CreateDiscoveryData(0, strSourceID, strManagedEntityId)
If Err.Number <> 0 Then
strErrorMessage = vbCrLf & "The script cannot create Discovery Data"
Call LogScriptEvent(0, EVENT_ID_SCRIPTERROR, EVENT_TYPE_WARNING, strErrorMessage,objMomScriptAPI)
WScript.Quit(-1)
End If
bIsOsSupported = CheckOSBuildNumber(WIN_SRV_2008_Version,WIN_SRV_2012R2_BUILD_NUMBER)
If (True = bIsOsSupported) Then
blnSuccess = DiscoverClusterName(strTargetComputer, objDiscoveryData)
Else
blnSuccess = True
End If
If blnSuccess Then
If mblnLogSuccessEvent Then
strErrorMessage = "Script executed successfully."
Call LogScriptEvent(0, EVENT_ID_SUCCESS, EVENT_TYPE_INFORMATION, strErrorMessage,objMomScriptAPI)
End If
Call objMomScriptAPI.Return(objDiscoveryData)
Else
strErrorMessage = "An error occurred while running script"
Call LogScriptEvent(0, EVENT_ID_SCRIPTERROR, EVENT_TYPE_WARNING, strErrorMessage,objMomScriptAPI)
End If
On Error Goto 0
End Sub
'****************************************************************************************************************
' FUNCTION: DiscoverClusterName
' DESCRIPTION: Discover instances of the relationship class
' 'Microsoft.Windows.Server.ClusterSharedVolumeMonitoring.Microsoft.Windows.Cluster.Contains.Microsoft.Windows.Cluster.VirtualServer'.
' PARAMETERS: IN String strTargetComputer: principal name of the targeted 'Microsoft.Windows.Cluster.VirtualServer' instance.
' OUT Object objDiscoveryData: initialised DiscoveryData instance
' RETURNS: Boolean: True if successful
'****************************************************************************************************************
Private Function DiscoverClusterName(ByRef strTargetComputer, ByRef objDiscoveryData) 'As Boolean
Dim strTargetComputerShortName 'As String
Dim strClusterName 'As String
Dim blnCreateDiscoveryData 'As Boolean
Dim objClusterNameInstance 'As ClassInstance
DiscoverClusterName = False
On Error Resume Next
Err.Clear
If Not GetClusterName(strClusterName) Then
Exit Function
End If
'Retrieve the cluster name from WMI and
'discover the relationship
Err.Clear
'Create the cluster name instance
Set objClusterNameInstance = objDiscoveryData.CreateClassInstance("$MPElement[Name='Microsoft.Windows.Server.ClusterSharedVolumeMonitoring.Cluster']$")
'Add key property (is hosted on Microsoft.Windows.Cluster.VirtualServer
If HasValue(objClusterNameInstance) Then
'Property ClusterName
Call objClusterNameInstance.AddProperty("$MPElement[Name='Microsoft.Windows.Server.ClusterSharedVolumeMonitoring.Cluster']/ClusterName$", strClusterName)
'Call objClusterNameInstance.AddProperty("$MPElement[Name='System!System.Entity']/DisplayName$", "Windows Cluster (disk monitoring)")
'add the instance to the discovery data
If ( 0 = Err.Number) Then
Call objDiscoveryData.AddInstance(objClusterNameInstance)
If ( 0 = Err.Number) Then
DiscoverClusterName = True
End If
End If
Set objClusterNameInstance = Nothing
End If
On Error Goto 0
End Function
'******************************************************************************
' FUNCTION: CheckOSBuildNumber
' DESCRIPTION: Returns True if the property BuildNumber from the Win32_OperatingSystem
' instance is greater or equal the given build number using the CIMv2 WMI namespace.
' PARAMETERS: IN Long lngBuildNumber: build number to check
' RETURNS: Boolean: True, if build is greater or equal than the given number
'******************************************************************************
Private Function CheckOSBuildNumber( lngVersion, lngHighBuildNumber) 'As Boolean
Dim strOSVersion
Dim strBuild
Dim dblVersion
Dim lngBuild
CheckOSBuildNumber = False
strOSVersion = GetRegistryKeyValue("HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\", "CurrentVersion")
If (0 = Len(strOSVersion)) Then
Exit Function
End If
' strBuild = GetRegistryKeyValue("HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\", "CurrentBuild")
'If (0 = Len(strBuild)) Then
' Exit Function
'End If
On Error Resume Next
Err.Clear
dblVersion = CDbl(strOSVersion)
'lngBuild = CLng(strBuild)
If (0 = Err.Number) Then
If (dblVersion >= lngVersion) Then
CheckOSBuildNumber = True
End If
End If
On Error Goto 0
End Function
'******************************************************************************
' FUNCTION: GetScriptParameters
' DESCRIPTION: Reads the script's parameters
' and sets the global variables.
'
' PARAMETERS: OUT String strSourceID: Id of MP element ($MPElement$)
' OUT String strManagedEntityId: Id of targeted entity ($Target/Id$)
' OUT String strTargetComputer: Principal name of executing computer
' ($Target/Property[Type="Windows!Microsoft.Windows.Computer"]/PrincipalName$)
' RETURNS: Boolean: True if successful
'******************************************************************************
Private Function GetScriptParameters(ByRef strSourceID, ByRef strManagedEntityId, ByRef strTargetComputer) 'As Boolean
Dim objArguments
On Error Resume Next
Err.Clear
GetScriptParameters = False
'cmdline: <script> True|False <path to debug log> True|False <script id> .MPElement. .Target/Id. .Target/Property[Name="Windows!Microsoft.Windows.Computer"]/PrincipalName.
Set objArguments = WScript.Arguments
If objArguments.Count < 5 Then Exit Function
'Get parameters and set global variables
mblnLogSuccessEvent = CBool(objArguments(0))
If (Err.Number <> 0 ) Then
mblnLogSuccessEvent = False
End If
If Len(strSourceID) > 0 And Len(strManagedEntityId) > 0 And Len(strTargetComputer) > 0 Then GetScriptParameters = True
On Error Goto 0
End Function
Private Function GetLogScriptName()
GetLogScriptName = "-- Cluster Name Discovery Script -- " & vbCrLf & vbCrLf & "Script name: " & WScript.ScriptName & vbCrLf & "Version: " & SCRIPT_VERSION & vbCrLf
End Function
'****************************************************************************************************************
' FUNCTION: GetClusterName
' DESCRIPTION: Returns the cluster name of the given cluster virtual name
' PARAMETERS: OUT String strClusterName: string to return the cluster name
' RETURNS: Boolean: True if successful
'****************************************************************************************************************
Private Function GetClusterName(ByRef strClusterName) 'As Boolean
Dim objMSClusterSWbemServices 'As SWbemServices
Dim strWQLQuery 'As String
Dim objClusters 'As SWbemObjectSet
Dim objCluster 'As SWbemObject
Dim bResult
If (True = bResult And Len(strClusterName) > 0 ) Then
GetClusterName = bResult
Exit Function
End If
On Error Resume Next
Err.Clear
'Connect to WMI NS \\.\root\MSCluster
If ConnectToWbemNS(".", WMI_MSCLUSTER_NAMESPACE, objMSClusterSWbemServices) Then
strWQLQuery = "select * from " & WMI_MSCLUSTER_CLUSTER_CLASS
Set objClusters = objMSClusterSWbemServices.ExecQuery(strWQLQuery)
If HasValue(objClusters) Then
For Each objCluster In objClusters
strClusterName = objCluster.Name
Next 'objCluster
If Len(strClusterName) > 0 Then GetClusterName = True
End If
Set objClusters = Nothing
End If
On Error Goto 0
End Function
'****************************************************************************************************************
' FUNCTION: GetClusterNameFromRegistry
' DESCRIPTION: Returns the cluster name of the given cluster virtual name
' PARAMETERS: OUT String strClusterName: string to return the cluster name
' RETURNS: Boolean: True if successful
'****************************************************************************************************************
Private Function GetClusterNameFromRegistry(ByRef strClusterName) 'As Boolean
Dim objReg 'Registry
Const ClusterNamePath = "HKLM\Cluster\"
'****************************************************************************************************************
' FUNCTION: GetComputerName ' DESCRIPTION: return short computername
' PARAMETERS: IN String strTargetComputer: principal name of the targeted 'Microsoft.Windows.Cluster.VirtualServer' instance.
' RETURNS: Integer: 0 if successful and 1 if fails
'****************************************************************************************************************
Private Function GetComputerName(strTargetComputer)
Dim strComputerName
Dim PointPos
PointPos = InStr(strTargetComputer, ".")
If PointPos > 0 Then
strComputerName = LCase(Left(strTargetComputer, PointPos - 1))
Else
strComputerName = LCase(strTargetComputer)
End If
GetComputerName = strComputerName
End Function
'******************************************************************************
' FUNCTION: ConnectToWbemNs
' DESCRIPTION: Connects to a WMI namespace
' PARAMETERS: IN String strServerName: name of the computer. If empty the local computer will be used.
' IN String strNameSpace: WMI namespace
' OUT Object objSWbemServices: WbemScripting.SWbemServices object connected to the given
' namespace on the given server
' RETURNS: Boolean: True if successful
'******************************************************************************
Private Function ConnectToWbemNS(ByRef strServerName, ByRef strNameSpace, ByRef objSWbemServices) 'As Boolean
ConnectToWbemNS = False
Dim objSWbemLocator 'as WbemScripting.SWbemLocator
Set objSWbemServices = Nothing
On Error Resume Next
'Create a new WMI Locator object
Set objSWbemLocator = CreateObject("WbemScripting.SWbemLocator")
IF HasValue(objSWbemLocator) Then
'Connect to WMI namespace on strServerName computer and create WMI Services object
Set objSWbemServices = objSWbemLocator.ConnectServer(strServerName, strNameSpace)
END IF
'If object is initialised function will be successful
ConnectToWbemNS = HasValue(objSWbemServices)
On Error Goto 0
End Function
Private Function HasValue(Value)
Dim bNothing
bNothing = false
IF ( IsObject(Value) ) THEN
IF (Nothing is Value) THEN
bNothing = true
END IF
END IF
HasValue = Not ( IsEmpty(Value) or bNothing or IsNull(Value) )
End Function
'****************************************************************************************************************
' FUNCTION: GetRegistryKeyValue
' DESCRIPTION: Get Registry Key value.
' PARAMETERS: IN String keyPath: Path to search in registry.
' IN String Key: key to return value from
' RETURNS: string: Value if successful
'****************************************************************************************************************
Function GetRegistryKeyValue(ByVal keyPath, ByVal key)
Dim oReg, strKeyValue
strKeyValue = ""
GetRegistryKeyValue = strKeyValue
On Error Resume Next
Err.Clear
Set oReg = CreateObject("WScript.Shell")
If Err.Number <> 0 Then
Err.Clear
Exit Function
End If
strKeyValue = oReg.RegRead(keyPath & key)
If Err.Number <> 0 Then
Err.Clear
Exit Function
End If
GetRegistryKeyValue = strKeyValue
' resume error
On Error Goto 0
End Function
'******************************************************************************
' Subroutine: LogScriptEvent
' DESCRIPTION: Logging events to EventSource
' PARAMETERS: IN Integer LogType: 0 - MomScriptApi; 1 - File, 2 - Screen .
' IN String Message: Event Description
' OUT Object objSWbemServices: WbemScripting.SWbemServices object connected to the given
' namespace on the given server
' RETURNS: Boolean: True if successful
'******************************************************************************
Sub LogScriptEvent(LogType,EventId,EventLevel,Message,objMomScriptAPI)
Dim strMessage
Dim sDate
Dim LogScriptName
On Error Resume Next
If (0 = LogType) Then
If (Not HasValue(objMomScriptAPI)) Then
Exit Sub
End If
LogScriptName = GetLogScriptName()
Call objMomScriptAPI.LogScriptEvent(LogScriptName,EventId,EventLevel,Message)
Else
sDate = Now()
strMessage = "" & sDate & Message
If (1 = LogType) Then
WScript.Echo strMessage
End If
End If
On Error Goto 0
End Sub
</cScriptBody>
<PsScriptName>Microsoft.Windows.Server.CSV.DiscoverClusterName.ps1</PsScriptName>
<PowerShellScriptParameters>'$Config/MPElementID$' '$Config/TargetID$'</PowerShellScriptParameters>
<PowerShellScriptParam>param($SourceId, $ManagedEntityId)</PowerShellScriptParam>
<PowerShellScriptBody>
#*********************************************************************************************
# PROCEDURE: Main
# DESCRIPTION: Return empty discovery data for removing objects discovered by previous MP version.
# PARAMETERS: void
#*********************************************************************************************
Function Main()
{
$ErrorActionPreference = "SilentlyContinue"
$Error.Clear()
$objMomScriptAPI = New-Object -comObject MOM.ScriptAPI -ErrorAction SilentlyContinue
Home
ENU 
Show References: