DSCResources/DSC_IPAddress/DSC_IPAddress.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 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 |
$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 state of an IP address assigned to an interface. .PARAMETER IPAddress The desired IP address. .PARAMETER InterfaceAlias Alias of the network interface for which the IP address should be set. .PARAMETER AddressFamily IP address family. .PARAMETER KeepExistingAddress Indicates whether or not existing IP addresses on an interface will be retained. #> function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter()] [ValidateNotNullOrEmpty()] [System.String[]] $IPAddress, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $InterfaceAlias, [Parameter(Mandatory = $true)] [ValidateSet('IPv4', 'IPv6')] [System.String] $AddressFamily = 'IPv4', [Parameter()] [System.Boolean] $KeepExistingAddress = $false ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.GettingIPAddressMessage) ) -join '') $getNetIPAddressParameters = @{ InterfaceAlias = $InterfaceAlias AddressFamily = $AddressFamily } $currentIPAddress = Get-NetIPAddress @getNetIPAddressParameters $currentIPAddressWithPrefix = $currentIPAddress | Foreach-Object { "$($_.IPAddress)/$($_.prefixLength)" } $returnValue = @{ IPAddress = @($currentIPAddressWithPrefix) AddressFamily = $AddressFamily InterfaceAlias = $InterfaceAlias KeepExistingAddress = $KeepExistingAddress } return $returnValue } <# .SYNOPSIS Sets an IP address on an interface. .PARAMETER IPAddress The desired IP address. .PARAMETER InterfaceAlias Alias of the network interface for which the IP address should be set. .PARAMETER AddressFamily IP address family. .PARAMETER KeepExistingAddress Indicates whether or not existing IP addresses on an interface will be retained. #> function Set-TargetResource { [CmdletBinding()] param ( [Parameter()] [ValidateNotNullOrEmpty()] [System.String[]] $IPAddress, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $InterfaceAlias, [Parameter(Mandatory = $true)] [ValidateSet('IPv4', 'IPv6')] [System.String] $AddressFamily = 'IPv4', [Parameter()] [System.Boolean] $KeepExistingAddress = $false ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.ApplyingIPAddressMessage) ) -join '') # Use $AddressFamily to select the IPv4 or IPv6 destination prefix $destinationPrefix = '0.0.0.0/0' if ($AddressFamily -eq 'IPv6') { $destinationPrefix = '::/0' $prefixLength = 64 } # Get all the default routes - this has to be done in case the IP Address is being Removed $getNetRouteParameters = @{ InterfaceAlias = $InterfaceAlias AddressFamily = $AddressFamily ErrorAction = 'Stop' } $defaultRoutes = @(Get-NetRoute @getNetRouteParameters).Where( { $_.DestinationPrefix -eq $destinationPrefix } ) <# Remove any default routes on the specified interface -- it is important to do this *before* removing the IP address, particularly in the case where the IP address was auto-configured by DHCP #> if ($defaultRoutes) { foreach ($defaultRoute in $defaultRoutes) { $removeNetRouteParameters = @{ DestinationPrefix = $defaultRoute.DestinationPrefix NextHop = $defaultRoute.NextHop InterfaceIndex = $defaultRoute.InterfaceIndex AddressFamily = $defaultRoute.AddressFamily Confirm = $false ErrorAction = 'Stop' } Remove-NetRoute @removeNetRouteParameters } } # Get the current IP Address based on the parameters given. $getNetIPAddressParameters = @{ InterfaceAlias = $InterfaceAlias AddressFamily = $AddressFamily ErrorAction = 'Stop' } $currentIPs = @(Get-NetIPAddress @getNetIPAddressParameters) # Remove any IP addresses on the specified interface if ($currentIPs) { foreach ($currentIP in $currentIPs) { $removeIP = $false if ($currentIP.IPAddress -notin ($IPAddress -replace '\/\S*', '') -and -not $KeepExistingAddress) { $removeIP = $true } elseif ($currentIP.IPAddress -in ($IPAddress -replace '\/\S*', '')) { $existingIP = $IPAddress | Where-Object { $_ -match $currentIP.IPAddress } if ($existingIP -ne "$($currentIP.IPAddress)/$($currentIP.prefixLength)") { $removeIP = $true } } if ($removeIP) { $removeNetIPAddressParameters = @{ IPAddress = $currentIP.IPAddress InterfaceIndex = $currentIP.InterfaceIndex AddressFamily = $currentIP.AddressFamily prefixLength = $currentIP.prefixLength Confirm = $false ErrorAction = 'Stop' } Remove-NetIPAddress @removeNetIPAddressParameters } } } $ipAddressObject = Get-IPAddressPrefix -IPAddress $IPAddress -AddressFamily $AddressFamily foreach ($singleIP in $ipAddressObject) { # Build parameter hash table $newNetIPAddressParameters = @{ IPAddress = $singleIP.IPAddress prefixLength = $singleIP.prefixLength InterfaceAlias = $InterfaceAlias } try { # Apply the specified IP configuration New-NetIPAddress @newNetIPAddressParameters -ErrorAction Stop } catch [Microsoft.Management.Infrastructure.CimException] { $verifyNetIPAddressAdapterParam = @{ IPAddress = $singleIP.IPAddress prefixLength = $singleIP.prefixLength } <# Setting New-NetIPaddress will throw [Microsoft.Management.Infrastructure.CimException] if the IP address is already set. Need to check to make sure the IP is set on correct interface #> $verifyNetIPAddressAdapter = Get-NetIPAddress @verifyNetIPAddressAdapterParam -ErrorAction SilentlyContinue if ($verifyNetIPAddressAdapter.InterfaceAlias -eq $InterfaceAlias) { # The IP Address is already set on the correct interface Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($script:localizedData.IPAddressMatchMessage) ) -join '' ) } else { Write-Error -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.IPAddressDoesNotMatchInterfaceAliasMessage) -f $InterfaceAlias,$verifyNetIPAddressAdapter.InterfaceAlias ) -join '' ) } continue } Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($script:localizedData.IPAddressSetStateMessage) ) -join '' ) } } # Set-TargetResource <# .SYNOPSIS Tests the IP address on the interface. .PARAMETER IPAddress The desired IP address. .PARAMETER InterfaceAlias Alias of the network interface for which the IP address should be set. .PARAMETER AddressFamily IP address family. .PARAMETER KeepExistingAddress Indicates whether or not existing IP addresses on an interface will be retained. #> function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter()] [ValidateNotNullOrEmpty()] [System.String[]] $IPAddress, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $InterfaceAlias, [Parameter(Mandatory = $true)] [ValidateSet('IPv4', 'IPv6')] [System.String] $AddressFamily = 'IPv4', [Parameter()] [System.Boolean] $KeepExistingAddress = $false ) # Flag to signal whether settings are correct [System.Boolean] $desiredConfigurationMatch = $true Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($script:localizedData.CheckingIPAddressMessage) ) -join '') Assert-ResourceProperty @PSBoundParameters <# Get the current IP Address based on the parameters given. First make sure that adapter is available #> [System.Boolean] $adapterBindingReady = $false [System.DateTime] $startTime = Get-Date while (-not $adapterBindingReady -and (((Get-Date) - $startTime).TotalSeconds) -lt 30) { $getNetIPAddressParameters = @{ InterfaceAlias = $InterfaceAlias AddressFamily = $AddressFamily ErrorAction = 'SilentlyContinue' } $currentIPs = @(Get-NetIPAddress @getNetIPAddressParameters) if ($currentIPs) { $adapterBindingReady = $true } else { Start-Sleep -Milliseconds 200 } } # while $ipAddressObject = Get-IPAddressPrefix -IPAddress $IPAddress -AddressFamily $AddressFamily # Test if the IP Address passed is present foreach ($singleIP in $ipAddressObject) { $prefixLength = $singleIP.prefixLength if ($singleIP.IPAddress -notin $currentIPs.IPAddress) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.IPAddressDoesNotMatchMessage) -f $singleIP, $currentIPs.IPAddress ) -join '' ) $desiredConfigurationMatch = $false } else { Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($script:localizedData.IPAddressMatchMessage) ) -join '') # Filter the IP addresses for the IP address to check $filterIP = $currentIPs.Where( { $_.IPAddress -eq $singleIP.IPAddress } ) # Only test the Prefix Length if the IP address is present if (-not $filterIP.prefixLength.Equals([System.Byte] $prefixLength)) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.prefixLengthDoesNotMatchMessage) -f $prefixLength, $currentIPs.prefixLength ) -join '' ) $desiredConfigurationMatch = $false } else { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.prefixLengthMatchMessage) ) -join '' ) } } } return $desiredConfigurationMatch } # Test-TargetResource <# .SYNOPSIS Check the IP Address details are valid and do not conflict with Address family. Also checks the prefix length and ensures the interface exists. If any problems are detected an exception will be thrown. .PARAMETER IPAddress The desired IP address. .PARAMETER InterfaceAlias Alias of the network interface for which the IP address should be set. .PARAMETER AddressFamily IP address family. .PARAMETER KeepExistingAddress Indicates whether or not existing IP addresses on an interface will be retained. #> function Assert-ResourceProperty { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String[]] $IPAddress, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $InterfaceAlias, [Parameter()] [ValidateSet('IPv4', 'IPv6')] [System.String] $AddressFamily = 'IPv4', [Parameter()] [System.Boolean] $KeepExistingAddress = $false ) $prefixLengthArray = ($IPAddress -split '/')[1] if ($prefixLengthArray.Count -ne $IPAddress.Count) { # Return the prefix length of each IP address specified $prefixLengthArray = $IPAddress | Foreach-Object { if ($_ -match '\/\d{1,3}') { ($_ -split '/')[1] } else { if ($_.split('.')[0] -in (0..127)) { $prefixLength = 8 } elseif ($_.split('.')[0] -in (128..191)) { $prefixLength = 16 } elseif ($_.split('.')[0] -in (192..223)) { $prefixLength = 24 } if ($AddressFamily -eq 'IPv6') { $prefixLength = 64 } $prefixLength } } } if (-not (Get-NetAdapter | Where-Object -Property Name -EQ $InterfaceAlias )) { New-InvalidArgumentException ` -Message $($($script:localizedData.InterfaceNotAvailableError) -f $InterfaceAlias) ` -ArgumentName 'InterfaceAlias' } foreach ($singleIPAddress in $IPAddress) { $singleIP = ($singleIPAddress -split '/')[0] Assert-IPAddress -Address $singleIP -AddressFamily $AddressFamily } foreach ($prefixLength in $prefixLengthArray) { $prefixLength = [uint32]::Parse($prefixLength) if (( ($AddressFamily -eq 'IPv4') ` -and (($prefixLength -lt [uint32]0) -or ($prefixLength -gt [uint32]32)) ) -or ( ($AddressFamily -eq 'IPv6') ` -and (($prefixLength -lt [uint32]0) -or ($prefixLength -gt [uint32]128)) )) { New-InvalidArgumentException ` -Message $($($script:localizedData.PrefixLengthError) -f $prefixLength, $AddressFamily) ` -ArgumentName 'IPAddress' } } } # Assert-ResourceProperty Export-ModuleMember -function *-TargetResource |