DSCResources/DSC_DnsServerAddress/DSC_DnsServerAddress.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 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 |
$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' <# .SYNOPSIS Returns the current DNS Server Addresses for an interface. .PARAMETER InterfaceAlias Alias of the network interface for which the DNS server address is set. .PARAMETER AddressFamily IP address family. .PARAMETER Address The desired DNS Server address(es). Exclude to enable DHCP. #> function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [String] $InterfaceAlias, [Parameter(Mandatory = $true)] [ValidateSet('IPv4', 'IPv6')] [String] $AddressFamily, [Parameter()] [ValidateNotNullOrEmpty()] [String[]] $Address ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.GettingDnsServerAddressesMessage) ) -join '') # Remove the parameters we don't want to splat $null = $PSBoundParameters.Remove('Address') # Get the current DNS Server Addresses based on the parameters given. [String[]] $currentAddress = Get-DnsClientServerStaticAddress ` @PSBoundParameters ` -ErrorAction Stop $returnValue = @{ Address = $currentAddress AddressFamily = $AddressFamily InterfaceAlias = $InterfaceAlias } return $returnValue } <# .SYNOPSIS Sets the DNS Server Address for an interface. .PARAMETER InterfaceAlias Alias of the network interface for which the DNS server address is set. .PARAMETER AddressFamily IP address family. .PARAMETER Address The desired DNS Server address(es). Exclude to enable DHCP. .PARAMETER Validate Requires that the DNS Server addresses be validated if they are updated. It will cause the resource to throw a 'A general error occurred that is not covered by a more specific error code.' error if set to True and specified DNS Servers are not accessible. #> function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [String] $InterfaceAlias, [Parameter(Mandatory = $true)] [ValidateSet('IPv4', 'IPv6')] [String] $AddressFamily, [Parameter()] [ValidateNotNullOrEmpty()] [String[]] $Address, [Parameter()] [Boolean] $Validate = $false ) Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($script:localizedData.ApplyingDnsServerAddressesMessage) ) -join '') # If address not passed, set to an empty array if (-not $PSBoundParameters.ContainsKey('Address')) { [String[]] $Address = @() } # Remove the parameters we don't want to splat $null = $PSBoundParameters.Remove('Address') $null = $PSBoundParameters.Remove('Validate') # Get the current DNS Server Addresses based on the parameters given. [String[]] $currentAddress = @(Get-DnsClientServerStaticAddress ` @PSBoundParameters ` -ErrorAction Stop) # Check if the Server addresses are the same as the desired addresses. [Boolean] $addressDifferent = (@(Compare-Object ` -ReferenceObject $currentAddress ` -DifferenceObject $Address ` -SyncWindow 0).Length -gt 0) if ($addressDifferent) { $dnsServerAddressSplat = @{ InterfaceAlias = $InterfaceAlias } if ($Address.Count -eq 0) { # Reset the DNS server address to DHCP $dnsServerAddressSplat += @{ ResetServerAddresses = $true } Set-DnsClientServerAddress @dnsServerAddressSplat ` -ErrorAction Stop Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.DNSServersHaveBeenSetToDHCPMessage) ) -join '' ) } else { # Set the DNS server address to static $dnsServerAddressSplat += @{ Address = $Address Validate = $Validate } Set-DnsClientServerAddress @dnsServerAddressSplat ` -ErrorAction Stop Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.DNSServersHaveBeenSetCorrectlyMessage) ) -join '' ) } } else { # Test will return true in this case Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.DNSServersAlreadySetMessage) ) -join '' ) } } <# .SYNOPSIS Tests the current state of a DNS Server Address for an interface. .PARAMETER InterfaceAlias Alias of the network interface for which the DNS server address is set. .PARAMETER AddressFamily IP address family. .PARAMETER Address The desired DNS Server address(es). Exclude to enable DHCP. .PARAMETER Validate Requires that the DNS Server addresses be validated if they are updated. It will cause the resource to throw a 'A general error occurred that is not covered by a more specific error code.' error if set to True and specified DNS Servers are not accessible. #> function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [String] $InterfaceAlias, [Parameter(Mandatory = $true)] [ValidateSet('IPv4', 'IPv6')] [String] $AddressFamily, [Parameter()] [ValidateNotNullOrEmpty()] [String[]] $Address, [Parameter()] [Boolean] $Validate = $false ) # Flag to signal whether settings are correct [Boolean] $desiredConfigurationMatch = $true Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.CheckingDnsServerAddressesMessage) ) -join '' ) # Validate the Address passed or set to empty array if not passed if ($PSBoundParameters.ContainsKey('Address')) { foreach ($ServerAddress in $Address) { Assert-ResourceProperty ` -Address $ServerAddress ` -AddressFamily $AddressFamily ` -InterfaceAlias $InterfaceAlias } # foreach } else { [String[]] $Address = @() } # if # Remove the parameters we don't want to splat $null = $PSBoundParameters.Remove('Address') $null = $PSBoundParameters.Remove('Validate') # Get the current DNS Server Addresses based on the parameters given. [String[]] $currentAddress = @(Get-DnsClientServerStaticAddress ` @PSBoundParameters ` -ErrorAction Stop) # Check if the Server addresses are the same as the desired addresses. [Boolean] $addressDifferent = (@(Compare-Object ` -ReferenceObject $currentAddress ` -DifferenceObject $Address ` -SyncWindow 0).Length -gt 0) if ($addressDifferent) { $desiredConfigurationMatch = $false Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.DNSServersNotCorrectMessage) ` -f ($Address -join ','),($currentAddress -join ',') ) -join '' ) } else { # Test will return true in this case Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.DNSServersSetCorrectlyMessage) ) -join '' ) } return $desiredConfigurationMatch } <# .SYNOPSIS Checks the Address details are valid and do not conflict with Address family. Ensures interface exists. If any problems are detected an exception will be thrown. .PARAMETER InterfaceAlias Alias of the network interface for which the DNS server address is set. .PARAMETER AddressFamily IP address family. .PARAMETER Address The desired DNS Server address. Set to empty to enable DHCP. #> function Assert-ResourceProperty { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [String] $InterfaceAlias, [Parameter(Mandatory = $true)] [ValidateSet('IPv4', 'IPv6')] [String] $AddressFamily, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [String] $Address ) if ( -not (Get-NetAdapter | Where-Object -Property Name -EQ $InterfaceAlias )) { New-InvalidArgumentException ` -Message ($script:localizedData.InterfaceNotAvailableError -f $InterfaceAlias) ` -ArgumentName 'InterfaceAlias' } Assert-IPAddress -Address $Address -AddressFamily $AddressFamily } # Assert-ResourceProperty Export-ModuleMember -function *-TargetResource |