DSCResources/DSC_DnsClientGlobalSetting/DSC_DnsClientGlobalSetting.psm1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
$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_DnsClientGlobalSetting.data.psd1' # This must be a script parameter so that it is accessible $script:parameterList = $resourceData.ParameterList <# .SYNOPSIS Returns the current DNS Client 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.GettingDnsClientGlobalSettingMessage) ) -join '' ) # Get the current Dns Client Global Settings $dnsClientGlobalSetting = Get-DnsClientGlobalSetting ` -ErrorAction Stop # Generate the return object. $returnValue = @{ IsSingleInstance = 'Yes' } foreach ($parameter in $script:parameterList) { $returnValue += @{ $parameter.Name = $dnsClientGlobalSetting.$($parameter.name) } } # foreach return $returnValue } # Get-TargetResource <# .SYNOPSIS Sets the DNS Client Global Settings. .PARAMETER IsSingleInstance Specifies the resource is a single instance, the value must be 'Yes'. .PARAMETER SuffixSearchList Specifies a list of global suffixes that can be used in the specified order by the DNS client for resolving the IP address of the computer name. .PARAMETER UseDevolution. Specifies that devolution is activated. .PARAMETER DevolutionLevel Specifies the number of labels up to which devolution should occur. #> function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateSet('Yes')] [System.String] $IsSingleInstance, [Parameter()] [System.String[]] $SuffixSearchList, [Parameter()] [System.Boolean] $UseDevolution, [Parameter()] [System.Uint32] $DevolutionLevel ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.SettingDnsClientGlobalSettingMessage) ) -join '' ) # Get the current Dns Client Global Settings $dnsClientGlobalSetting = Get-DnsClientGlobalSetting ` -ErrorAction Stop # Generate a list of parameters that will need to be changed. $changeParameters = @{} foreach ($parameter in $script:parameterList) { $parameterSourceValue = $dnsClientGlobalSetting.$($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.DnsClientGlobalSettingUpdateParameterMessage) ` -f $parameter.Name,($parameterNewValue -join ',') ) -join '' ) } # if } # foreach if ($changeParameters.Count -gt 0) { # Update any parameters that were identified as different $null = Set-DnsClientGlobalSetting ` @ChangeParameters ` -ErrorAction Stop Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.DnsClientGlobalSettingUpdatedMessage) ) -join '' ) } # if } # Set-TargetResource <# .SYNOPSIS Tests the state of DNS Client Global Settings. .PARAMETER IsSingleInstance Specifies the resource is a single instance, the value must be 'Yes'. .PARAMETER SuffixSearchList Specifies a list of global suffixes that can be used in the specified order by the DNS client for resolving the IP address of the computer name. .PARAMETER UseDevolution. Specifies that devolution is activated. .PARAMETER DevolutionLevel Specifies the number of labels up to which devolution should occur. #> function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [ValidateSet('Yes')] [System.String] $IsSingleInstance, [Parameter()] [System.String[]] $SuffixSearchList, [Parameter()] [System.Boolean] $UseDevolution, [Parameter()] [System.Uint32] $DevolutionLevel ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.TestingDnsClientGlobalSettingMessage) ) -join '' ) # Flag to signal whether settings are correct $desiredConfigurationMatch = $true # Get the current Dns Client Global Settings $dnsClientGlobalSetting = Get-DnsClientGlobalSetting ` -ErrorAction Stop # Check each parameter foreach ($parameter in $script:parameterList) { $parameterSourceValue = $dnsClientGlobalSetting.$($parameter.name) $parameterNewValue = (Get-Variable -Name ($parameter.name)).Value $parameterValueMatch = $true switch ($parameter.Type) { 'Integer' { # Perform a plain integer comparison. if ($PSBoundParameters.ContainsKey($parameter.Name) -and $parameterSourceValue -ne $parameterNewValue) { $parameterValueMatch = $false } } 'Boolean' { # Perform a boolean comparison. if ($PSBoundParameters.ContainsKey($parameter.Name) -and $parameterSourceValue -ne $parameterNewValue) { $parameterValueMatch = $false } } 'Array' { # Array comparison uses Compare-Object if ([System.String]::IsNullOrEmpty($parameterSourceValue)) { $parameterSourceValue = @() } if ([System.String]::IsNullOrEmpty($parameterNewValue)) { $parameterNewValue = @() } if ($PSBoundParameters.ContainsKey($parameter.Name) ` -and ((Compare-Object ` -ReferenceObject $parameterSourceValue ` -DifferenceObject $parameterNewValue -SyncWindow 0).Count -ne 0)) { $parameterValueMatch = $false } } } if ($parameterValueMatch -eq $false) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.DnsClientGlobalSettingParameterNeedsUpdateMessage) ` -f $parameter.Name, ($parameterSourceValue -join ','), ($parameterNewValue -join ',') ) -join '') $desiredConfigurationMatch = $false } } # foreach return $desiredConfigurationMatch } # Test-TargetResource Export-ModuleMember -Function *-TargetResource |