Microsoft Windows Server DNS Server Property Discovery

Microsoft.Windows.DNSServer.2016.Server.Property.Discovery (Discovery)

Discovers additional properties of the DNS server

Knowledge Base article:

Summary

Uses WMI to discover additional properties of the DNS server not exposed to the earlier, registry-based discovery.

Element properties:

TargetMicrosoft.Windows.DNSServer.2016.Server
EnabledTrue
Frequency14580
RemotableFalse

Object Discovery Details:

Discovered Classes and their attribuets:

Member Modules:

ID Module Type TypeId RunAs 
DS DataSource Microsoft.Windows.TimedPowerShell.DiscoveryProvider Microsoft.Windows.DNSServer.2016.ActionAccount

Source Code:

<Discovery ID="Microsoft.Windows.DNSServer.2016.Server.Property.Discovery" Enabled="true" Target="Microsoft.Windows.DNSServer.2016.Server" ConfirmDelivery="false" Remotable="true" Priority="Normal">
<Category>Discovery</Category>
<DiscoveryTypes>
<DiscoveryClass TypeID="Microsoft.Windows.DNSServer.2016.Server">
<Property TypeID="Microsoft.Windows.DNSServer.2016.Server" PropertyID="EventLoggingLevel"/>
<Property TypeID="Microsoft.Windows.DNSServer.2016.Server" PropertyID="ScavengingInterval"/>
</DiscoveryClass>
<DiscoveryClass TypeID="Microsoft.Windows.DNSServer.2016.Server.IPAddress">
<Property TypeID="Microsoft.Windows.DNSServer.2016.Server.IPAddress" PropertyID="IPAddress"/>
<Property TypeID="System!System.Entity" PropertyID="DisplayName"/>
</DiscoveryClass>
<DiscoveryClass TypeID="Microsoft.Windows.DNSServer.2016.Healthcheck.TaskTarget"/>
</DiscoveryTypes>
<DataSource ID="DS" RunAs="Microsoft.Windows.DNSServer.2016.ActionAccount" TypeID="Windows!Microsoft.Windows.TimedPowerShell.DiscoveryProvider">
<IntervalSeconds>14580</IntervalSeconds>
<SyncTime/>
<ScriptName>Microsoft.Windows.Server.DNS.Server.Property.Discovery.ps1</ScriptName>
<ScriptBody><Script>#Copyright (c) Microsoft Corporation. All rights reserved.

#*************************************************************************
# ScriptName: Microsoft.Windows.Server.DNS.Server.Property.Discovery
#
# Purpose: DNS Server Property Discovery
#
# File: Microsoft.Windows.Server.DNS.Server.Property.Discovery.ps1
#*************************************************************************

param (
[parameter(Mandatory=$false)]
[String] $ElementID = "$MPElement$",
[parameter(Mandatory=$false)]
[String] $TargetID="$Target/Id$",
[parameter(Mandatory=$false)]
[String] $ServerName = "$Target/Host/Property[Type='Windows!Microsoft.Windows.Computer']/PrincipalName$"

)

Function Start-Initialization
{
Set-Variable momApi -value $null -Scope Script

Set-Variable EVENT_TYPE_LOG -value 0 -Scope Script -Option Constant
Set-Variable EVENT_TYPE_ERROR -value 1 -Scope Script -Option Constant
Set-Variable EVENT_TYPE_WARNING -value 2 -Scope Script -Option Constant
Set-Variable EVENT_TYPE_INFORMATION -value 4 -Scope Script -Option Constant

Set-Variable EventSuccess -value 5700 -Scope Script -Option Constant
Set-Variable EventError -value 5701 -Scope Script -Option Constant
Set-Variable EventWarn -value 5702 -Scope Script -Option Constant
Set-Variable EventInfo -value 5704 -Scope Script -Option Constant


Set-Variable discoveryData -value $null -Scope Script

Set-Variable DnsServerTypeName -value "$MPElement[Name='Microsoft.Windows.DNSServer.2016.Server']$" -Scope Script
Set-Variable HealthTaskTargetTypeName -value "$MPElement[Name='Microsoft.Windows.DNSServer.2016.Healthcheck.TaskTarget']$" -Scope Script
Set-Variable DnsIpTypeName -value "$MPElement[Name='Microsoft.Windows.DNSServer.2016.Server.IPAddress']$" -Scope Script
Set-Variable DnsIpProp -value "$MPElement[Name='Microsoft.Windows.DNSServer.2016.Server.IPAddress']/IPAddress$" -Scope Script
Set-Variable SysDisplayNameProp -value "$MPElement[Name='System!System.Entity']/DisplayName$" -Scope Script
Set-Variable DNSNameProp -value "$MPElement[Name='Microsoft.Windows.DNSServer.2016.Server']/Name$" -Scope Script
Set-Variable CompNameProp -value "$MPElement[Name='Windows!Microsoft.Windows.Computer']/PrincipalName$" -Scope Script
Set-Variable ScavengingIntervalProp -value "$MPElement[Name='Microsoft.Windows.DNSServer.2016.Server']/ScavengingInterval$" -Scope Script
Set-Variable EventLogLevelProp -value "$MPElement[Name='Microsoft.Windows.DNSServer.2016.Server']/EventLoggingLevel$" -Scope Script
Set-Variable HealthTaskDispName -value "Target for remote tasks on" -Scope Script -Option Constant
Set-Variable SCRIPT_NAME -value "Microsoft.Windows.Server.DNS.Server.Property.Discovery.ps1" -Scope Script -Option Constant

}

Function Set-EmptyDiscoveryData
{
$Script:discoveryData = $Script:momApi.CreateDiscoveryData(0, $Script:ElementID, $Script:TargetID )
$Script:discoveryData.IsSnapshot = $false
$Script:discoveryData
}

Function Start-SCOMobjectsInitialization
{
try
{
$Script:momApi = New-Object -ComObject Mom.ScriptAPI -ErrorAction Stop
$Script:discoveryData = $Script:momApi.CreateDiscoveryData(0, $Script:ElementID, $Script:TargetID )
$Script:discoveryData.IsSnapshot = $true
}
catch
{
if ($null -eq $Script:momApi)
{
exit -1
}
else
{
$ErrorMessage = Get-ErrorMessage -Exception $_.Exception
Set-Error -ScriptName $Script:SCRIPT_NAME -EventLevel $Script:EventError -EventType $Script:EVENT_TYPE_ERROR -ErrorMessage $ErrorMessage
exit
}

}

}

Function Get-ErrorMessage($Exception)
{
$Error = $Exception.Message
$ErrorMessage = @"
Module: $Script:SCRIPT_NAME

Error(s) was(were) occurred:
State:
The configuration properties are :
ServerName = $Script:ServerName
DiscoverySourceObjectId = $Script:ElementID
DiscoverySourceManagedEntityId = $Script:TargetID
Error(s):
$Error

"@

return $ErrorMessage
}


Function IsNanoServer
{
$IsNanoServer = $false
$ServerKey = Get-Item "HKLM:\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Server\ServerLevels" -ErrorAction SilentlyContinue
if ($null -ne $ServerKey)
{
$IsNano = $ServerKey.GetValue("NanoServer")

if (1 -eq $IsNano)
{
$IsNanoServer = $true
}
}

return $IsNanoServer

}

Function Start-Discovery
{
$IsNanoServer = IsNanoServer

try
{
$EventLogLevel = (Get-DnsServerDiagnostics).EventLogLevel
$ScavengingInterval = (Get-DnsServerScavenging).ScavengingInterval.TotalHours
$DnsListeningAddress = (Get-DnsServerSetting).ListeningIPAddress

$DnsServerInstance = $Script:discoveryData.CreateClassInstance($Script:DnsServerTypeName)
$DnsServerInstance.AddProperty($Script:CompNameProp,$Script:ServerName)
$DnsServerInstance.AddProperty($Script:DNSNameProp, $Script:ServerName)
$DnsServerInstance.AddProperty($Script:EventLogLevelProp,"$EventLogLevel")
$DnsServerInstance.AddProperty($Script:ScavengingIntervalProp,"$ScavengingInterval")

$Script:discoveryData.AddInstance($DnsServerInstance)

if ($false -eq $IsNanoServer)
{
$HealthTaskTargetInstance = $Script:discoveryData.CreateClassInstance($Script:HealthTaskTargetTypeName)
$HealthTaskTargetInstance.AddProperty($Script:CompNameProp,$Script:ServerName)
$HealthTaskTargetInstance.AddProperty($Script:DNSNameProp, $Script:ServerName)
$HealthTaskTargetInstance.AddProperty($Script:SysDisplayNameProp,"$Script:HealthTaskDispName $Script:ServerName")
$Script:discoveryData.AddInstance($HealthTaskTargetInstance)
}

foreach ($address in $DnsListeningAddress)
{
if ([String]::IsNullOrEmpty($address.IPAddressToString) )
{
continue
}

$Ip = $address.IPAddressToString
$DnsIpInstance = $Script:discoveryData.CreateClassInstance($Script:DnsIpTypeName)
$DnsIpInstance.AddProperty($Script:CompNameProp,$Script:ServerName )
$DnsIpInstance.AddProperty($Script:DNSNameProp, $Script:ServerName)
$DnsIpInstance.AddProperty($Script:DnsIpProp,$Ip)
$Script:discoveryData.AddInstance($DnsIpInstance)

}

$Script:discoveryData
}
catch
{
$ErrorMessage = Get-ErrorMessage -Exception $_.Exception
Set-Error -ScriptName $Script:SCRIPT_NAME -EventLevel $Script:EventError -EventType $Script:EVENT_TYPE_ERROR -ErrorMessage $ErrorMessage

Set-EmptyDiscoveryData
}
}

Function Set-Error([String]$ErrorMessage,$EventLevel,$EventType,[String]$ScriptName)
{
if ($null -eq $Script:momApi)
{
return
}

try
{
$Script:momApi.LogScriptEvent($ScriptName,$EventLevel,$EventType,$ErrorMessage)

}
catch
{
}

}

Function Import-CmdLets ()
{
try
{
$dnsmodule = Get-Module -Name "DnsServer"
if ($null -eq $dnsmodule)
{
Import-Module DnsServer
}
}
catch [System.IO.FileNotFoundException]
{
$ErrorMessage = "Dns cmdlets doesn't exist."
Set-Error -ScriptName $Script:SCRIPT_NAME -EventLevel $Script:EventError -EventType $Script:EVENT_TYPE_ERROR -ErrorMessage $ErrorMessage
exit
}
catch
{
$ErrorMessage = Get-ErrorMessage -Exception $_.Exception
Set-Error -ScriptName $Script:SCRIPT_NAME -EventLevel $Script:EventError -EventType $Script:EVENT_TYPE_ERROR -ErrorMessage $ErrorMessage
exit
}
}

$ErrorActionPreference = "Stop"

$Script:ElementID = $ElementID
$Script:TargetID = $TargetID
$Script:ServerName = $ServerName

Start-Initialization
Start-SCOMobjectsInitialization
Import-CmdLets
Start-Discovery


</Script></ScriptBody>
<Parameters>
<Parameter>
<Name>ElementID</Name>
<Value>$MPElement$</Value>
</Parameter>
<Parameter>
<Name>TargetID</Name>
<Value>$Target/Id$</Value>
</Parameter>
<Parameter>
<Name>ServerName</Name>
<Value>$Target/Host/Property[Type='Windows!Microsoft.Windows.Computer']/PrincipalName$</Value>
</Parameter>
</Parameters>
<TimeoutSeconds>300</TimeoutSeconds>
</DataSource>
</Discovery>