DnsClientNrptGlobal-DnsClientNrptRule: New resources

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- Added the following resources:
+  - **DnsClientNrptGlobal**: Configure DNS Client global Name Resolution Policy Table (NRPT) settings.
+  - **DnsClientNrptRule**: Sets a DNS Client NRPT rule on a node.
+
 - Updated CHANGELOG.md
   - Renamed NetworkingDSc to NetworkingDsc in CHANGELOG.md - fixes [Issue #513](https://github.com/dsccommunity/NetworkingDsc/issues/513).
 - CI Pipeline

README.md

@@ -32,6 +32,8 @@ The **NetworkingDsc** module contains the following resources:
 
 - **DefaultGatewayAddress**: Sets a node's default gateway address.
 - **DnsClientGlobalSetting**: Configure DNS client global settings.
+- **DnsClientNrptGlobal**: Configure DNS client global Name Resolution Policy Table (NRPT) settings.
+- **DnsClientNrptRule**: Sets a DNS client NRPT rule on a node.
 - **DnsConnectionSuffix**: Sets a node's network interface
     connection-specific DNS suffix.
 - **DnsServerAddress**: Sets a node's DNS server address(s).

source/DSCResources/DSC_DnsClientNrptGlobal/DSC_DnsClientNrptGlobal.data.psd1

@@ -0,0 +1,16 @@
+@{
+    ParameterList = @(
+        @{
+            Name = 'EnableDAForAllNetworks'
+            Type = 'String'
+        },
+        @{
+            Name = 'QueryPolicy'
+            Type = 'String'
+        },
+        @{
+            Name = 'SecureNameQueryFallback'
+            Type = 'String'
+        }
+    )
+}

source/DSCResources/DSC_DnsClientNrptGlobal/DSC_DnsClientNrptGlobal.psm1

@@ -0,0 +1,229 @@
+$modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules'
+
+# Import the Networking Common Modules
+Import-Module -Name (Join-Path -Path $modulePath `
+        -ChildPath (Join-Path -Path 'NetworkingDsc.Common' `
+            -ChildPath 'NetworkingDsc.Common.psm1'))
+
+Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common')
+
+# Import Localization Strings
+$script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'
+
+<#
+    This is an array of all the parameters used by this resource.
+#>
+$resourceData = Import-LocalizedData `
+    -BaseDirectory $PSScriptRoot `
+    -FileName 'DSC_DnsClientNrptGlobal.data.psd1'
+
+# This must be a script parameter so that it is accessible
+$script:parameterList = $resourceData.ParameterList
+
+<#
+    .SYNOPSIS
+        Returns the current DNS Client Nrpt Global Settings.
+
+    .PARAMETER IsSingleInstance
+        Specifies the resource is a single instance, the value must be 'Yes'.
+#>
+function Get-TargetResource
+{
+    [CmdletBinding()]
+    [OutputType([System.Collections.Hashtable])]
+    param
+    (
+        [Parameter(Mandatory = $true)]
+        [ValidateSet('Yes')]
+        [System.String]
+        $IsSingleInstance
+    )
+
+    Write-Verbose -Message ( @(
+            "$($MyInvocation.MyCommand): "
+            $($script:localizedData.GettingDnsClientNrptGlobalMessage)
+        ) -join '' )
+
+    # Get the current DNS Client Global Settings
+    $DnsClientNrptGlobal = Get-DnsClientNrptGlobal `
+        -ErrorAction Stop
+
+    # Generate the return object.
+    $returnValue = @{
+        IsSingleInstance = 'Yes'
+    }
+
+    foreach ($parameter in $script:parameterList)
+    {
+        $returnValue += @{
+            $parameter.Name = $DnsClientNrptGlobal.$($parameter.name)
+        }
+    } # foreach
+
+    return $returnValue
+} # Get-TargetResource
+
+<#
+    .SYNOPSIS
+        Sets the DNS Client NRPT Global Settings.
+
+    .PARAMETER IsSingleInstance
+        Specifies the resource is a single instance, the value must be 'Yes'.
+
+    .PARAMETER EnableDAForAllNetworks
+        Specifies DirectAccess (DA) settings.
+
+    .PARAMETER QueryPolicy.
+        Specifies the DNS client query policy.
+
+    .PARAMETER SecureNameQueryFallback
+        Specifies the DNS client name resolution fallback policy.
+#>
+function Set-TargetResource
+{
+    [CmdletBinding()]
+    param
+    (
+        [Parameter(Mandatory = $true)]
+        [ValidateSet('Yes')]
+        [System.String]
+        $IsSingleInstance,
+
+        [Parameter()]
+        [ValidateSet('EnableOnNetworkID', 'EnableAlways', 'Disable', 'DisableDA')]
+        [System.String]
+        $EnableDAForAllNetworks,
+
+        [Parameter()]
+        [System.String]
+        [ValidateSet('Disable', 'QueryIPv6Only', 'QueryBoth')]
+        $QueryPolicy,
+
+        [Parameter()]
+        [System.String]
+        [ValidateSet('Disable', 'FallbackSecure', 'FallbackUnsecure', 'FallbackPrivate')]
+        $SecureNameQueryFallback
+    )
+
+    Write-Verbose -Message ( @(
+            "$($MyInvocation.MyCommand): "
+            $($script:localizedData.SettingDnsClientNrptGlobalMessage)
+        ) -join '' )
+
+    # Get the current DNS Client Nrpt Global Settings
+    $DnsClientNrptGlobal = Get-DnsClientNrptGlobal `
+        -ErrorAction Stop
+
+    # Generate a list of parameters that will need to be changed.
+    $changeParameters = @{}
+
+    foreach ($parameter in $script:parameterList)
+    {
+        $parameterSourceValue = $DnsClientNrptGlobal.$($parameter.name)
+        $parameterNewValue = (Get-Variable -Name ($parameter.name)).Value
+
+        if ($PSBoundParameters.ContainsKey($parameter.Name) `
+                -and (Compare-Object -ReferenceObject $parameterSourceValue -DifferenceObject $parameterNewValue -SyncWindow 0))
+        {
+            $changeParameters += @{
+                $($parameter.name) = $parameterNewValue
+            }
+
+            Write-Verbose -Message ( @(
+                    "$($MyInvocation.MyCommand): "
+                    $($script:localizedData.DnsClientNrptGlobalUpdateParameterMessage) `
+                        -f $parameter.Name,($parameterNewValue -join ',')
+                ) -join '' )
+        } # if
+    } # foreach
+
+    if ($changeParameters.Count -gt 0)
+    {
+        # Update any parameters that were identified as different
+        $null = Set-DnsClientNrptGlobal `
+            @ChangeParameters `
+            -ErrorAction Stop
+
+        Write-Verbose -Message ( @(
+                "$($MyInvocation.MyCommand): "
+                $($script:localizedData.DnsClientNrptGlobalUpdatedMessage)
+            ) -join '' )
+    } # if
+} # Set-TargetResource
+
+<#
+    .SYNOPSIS
+        Tests the state of DNS Client Nrpt Global Settings.
+
+    .PARAMETER IsSingleInstance
+        Specifies the resource is a single instance, the value must be 'Yes'.
+
+    .PARAMETER EnableDAForAllNetworks
+        Specifies DirectAccess (DA) settings.
+
+    .PARAMETER QueryPolicy.
+        Specifies the DNS client query policy.
+
+    .PARAMETER SecureNameQueryFallback
+        Specifies the DNS client name resolution fallback policy.
+#>
+function Test-TargetResource
+{
+    [CmdletBinding()]
+    [OutputType([System.Boolean])]
+    param
+    (
+        [Parameter(Mandatory = $true)]
+        [ValidateSet('Yes')]
+        [System.String]
+        $IsSingleInstance,
+
+        [Parameter()]
+        [ValidateSet('EnableOnNetworkID', 'EnableAlways', 'Disable', 'DisableDA')]
+        [System.String]
+        $EnableDAForAllNetworks,
+
+        [Parameter()]
+        [System.String]
+        [ValidateSet('Disable', 'QueryIPv6Only', 'QueryBoth')]
+        $QueryPolicy,
+
+        [Parameter()]
+        [System.String]
+        [ValidateSet('Disable', 'FallbackSecure', 'FallbackUnsecure', 'FallbackPrivate')]
+        $SecureNameQueryFallback
+    )
+
+    Write-Verbose -Message ( @(
+            "$($MyInvocation.MyCommand): "
+            $($script:localizedData.TestingDnsClientNrptGlobalMessage)
+        ) -join '' )
+
+    # Flag to signal whether settings are correct
+    $desiredConfigurationMatch = $true
+
+    # Get the current DNS Client Nrpt Global Settings
+    $DnsClientNrptGlobal = Get-DnsClientNrptGlobal `
+        -ErrorAction Stop
+
+    # Check each parameter
+    foreach ($parameter in $script:parameterList)
+    {
+        $parameterSourceValue = $DnsClientNrptGlobal.$($parameter.name)
+        $parameterNewValue = (Get-Variable -Name ($parameter.name)).Value
+
+        if ($parameterNewValue -ne $parameterSourceValue)
+        {
+            Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): "
+                $($script:localizedData.DnsClientNrptGlobalParameterNeedsUpdateMessage) `
+                -f $parameter.Name, ($parameterSourceValue -join ','), ($parameterNewValue -join ',')
+            ) -join '')
+            $desiredConfigurationMatch = $false
+        }
+
+    } # foreach
+
+    return $desiredConfigurationMatch
+} # Test-TargetResource
+
+Export-ModuleMember -Function *-TargetResource

source/DSCResources/DSC_DnsClientNrptGlobal/DSC_DnsClientNrptGlobal.schema.mof

@@ -0,0 +1,8 @@
+[ClassVersion("1.0.0.0"), FriendlyName("DnsClientNrptGlobal")]
+class DSC_DnsClientNrptGlobal : OMI_BaseResource
+{
+    [Key, Description("Specifies the resource is a single instance, the value must be 'Yes'."), ValueMap{"Yes"}, Values{"Yes"}] String IsSingleInstance;
+    [Write, Description("Specifies DirectAccess (DA) settings."), ValueMap{"EnableOnNetworkID", "EnableAlways", "Disable", "DisableDA"},Values{"EnableOnNetworkID", "EnableAlways", "Disable", "DisableDA"}] string EnableDAForAllNetworks;
+    [Write, Description("Specifies the DNS client query policy."), ValueMap{"Disable", "QueryIPv6Only", "QueryBoth"},Values{"Disable", "QueryIPv6Only", "QueryBoth"}] string QueryPolicy;
+    [Write, Description("SecureNameQueryFallback."), ValueMap{"Disable", "FallbackSecure", "FallbackUnsecure", "FallbackPrivate"},Values{"Disable", "FallbackSecure", "FallbackUnsecure", "FallbackPrivate"}] string SecureNameQueryFallback;
+};

source/DSCResources/DSC_DnsClientNrptGlobal/README.MD

@@ -0,0 +1,3 @@
+# Description
+
+This resource is used to control DNS Client NRPT Global Settings for a node.

source/DSCResources/DSC_DnsClientNrptGlobal/en-US/DSC_DnsClientNrptGlobal.strings.psd1

@@ -0,0 +1,10 @@
+# Localized resources for DSC_DnsClientNrptGlobal
+
+ConvertFrom-StringData @'
+    GettingDnsClientNrptGlobalMessage = Getting DNS Client NRPT Global Settings.
+    SettingDnsClientNrptGlobalMessage = Setting DNS Client NRPT Global Settings.
+    DnsClientNrptGlobalUpdateParameterMessage = Setting DNS Client NRPT Global Settings parameter {0} to "{1}".
+    DnsClientNrptGlobalUpdatedMessage = Setting DNS Client NRPT Global Settings updated.
+    TestingDnsClientNrptGlobalMessage = Testing DNS Client NRPT Global Settings.
+    DnsClientNrptGlobalParameterNeedsUpdateMessage = DNS Client NRPT Global Setting "{0}" is "{1}" but should be "{2}". Change required.
+'@