Modules/NetworkingDsc.Common/NetworkingDsc.Common.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 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 |
$modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules' Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common') # Import Localization Strings $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US' <# .SYNOPSIS Converts any IP Addresses containing CIDR notation filters in an array to use Subnet Mask notation. .PARAMETER Address The array of addresses to that need to be converted. #> function Convert-CIDRToSubhetMask { [CmdletBinding()] [OutputType([ Microsoft.Management.Infrastructure.CimInstance])] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String[]] $Address ) $results = @() foreach ($entry in $Address) { if (-not $entry.Contains(':') -and -not $entry.Contains('-')) { $entrySplit = $entry -split '/' if (-not [String]::IsNullOrEmpty($entrySplit[1])) { # There was a / so this contains a Subnet Mask or CIDR $prefix = $entrySplit[0] $postfix = $entrySplit[1] if ($postfix -match '^[0-9]*$') { # The postfix contains CIDR notation so convert this to Subnet Mask $cidr = [System.Int32] $postfix $subnetMaskInt64 = ([convert]::ToInt64(('1' * $cidr + '0' * (32 - $cidr)), 2)) $subnetMask = @( ([math]::Truncate($subnetMaskInt64 / 16777216)) ([math]::Truncate(($subnetMaskInt64 % 16777216) / 65536)) ([math]::Truncate(($subnetMaskInt64 % 65536) / 256)) ([math]::Truncate($subnetMaskInt64 % 256)) ) } else { $subnetMask = $postfix -split '\.' } <# Apply the Subnet Mast to the IP Address so that we end up with a correctly masked IP Address that will match what the Firewall rule returns. #> $maskedIp = $prefix -split '\.' for ([System.Int32] $Octet = 0; $octet -lt 4; $octet++) { $maskedIp[$Octet] = $maskedIp[$octet] -band $SubnetMask[$octet] } $entry = '{0}/{1}' -f ($maskedIp -join '.'), ($subnetMask -join '.') } } $results += $entry } return $results } # Convert-CIDRToSubhetMask <# .SYNOPSIS This function will find a network adapter based on the provided search parameters. .PARAMETER Name This is the name of network adapter to find. .PARAMETER PhysicalMediaType This is the media type of the network adapter to find. .PARAMETER Status This is the status of the network adapter to find. .PARAMETER MacAddress This is the MAC address of the network adapter to find. .PARAMETER InterfaceDescription This is the interface description of the network adapter to find. .PARAMETER InterfaceIndex This is the interface index of the network adapter to find. .PARAMETER InterfaceGuid This is the interface GUID of the network adapter to find. .PARAMETER DriverDescription This is the driver description of the network adapter. .PARAMETER InterfaceNumber This is the interface number of the network adapter if more than one are returned by the parameters. .PARAMETER IgnoreMultipleMatchingAdapters This switch will suppress an error occurring if more than one matching adapter matches the parameters passed. #> function Find-NetworkAdapter { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter()] [System.String] $Name, [Parameter()] [System.String] $PhysicalMediaType, [Parameter()] [ValidateNotNullOrEmpty()] [ValidateSet('Up', 'Disconnected', 'Disabled')] [System.String] $Status = 'Up', [Parameter()] [System.String] $MacAddress, [Parameter()] [System.String] $InterfaceDescription, [Parameter()] [System.UInt32] $InterfaceIndex, [Parameter()] [System.String] $InterfaceGuid, [Parameter()] [System.String] $DriverDescription, [Parameter()] [System.UInt32] $InterfaceNumber = 1, [Parameter()] [System.Boolean] $IgnoreMultipleMatchingAdapters = $false ) Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($script:localizedData.FindingNetAdapterMessage) ) -join '') $adapterFilters = @() if ($PSBoundParameters.ContainsKey('Name')) { $adapterFilters += @('($_.Name -eq $Name)') } # if if ($PSBoundParameters.ContainsKey('PhysicalMediaType')) { $adapterFilters += @('($_.PhysicalMediaType -eq $PhysicalMediaType)') } # if if ($PSBoundParameters.ContainsKey('Status')) { $adapterFilters += @('($_.Status -eq $Status)') } # if if ($PSBoundParameters.ContainsKey('MacAddress')) { $adapterFilters += @('($_.MacAddress -eq $MacAddress)') } # if if ($PSBoundParameters.ContainsKey('InterfaceDescription')) { $adapterFilters += @('($_.InterfaceDescription -eq $InterfaceDescription)') } # if if ($PSBoundParameters.ContainsKey('InterfaceIndex')) { $adapterFilters += @('($_.InterfaceIndex -eq $InterfaceIndex)') } # if if ($PSBoundParameters.ContainsKey('InterfaceGuid')) { $adapterFilters += @('($_.InterfaceGuid -eq $InterfaceGuid)') } # if if ($PSBoundParameters.ContainsKey('DriverDescription')) { $adapterFilters += @('($_.DriverDescription -eq $DriverDescription)') } # if if ($adapterFilters.Count -eq 0) { Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($script:localizedData.AllNetAdaptersFoundMessage) ) -join '') $matchingAdapters = @(Get-NetAdapter) } else { # Join all the filters together $adapterFilterScript = '(' + ($adapterFilters -join ' -and ') + ')' $matchingAdapters = @(Get-NetAdapter | Where-Object -FilterScript ([ScriptBlock]::Create($adapterFilterScript))) } # Were any adapters found matching the criteria? if ($matchingAdapters.Count -eq 0) { New-InvalidOperationException ` -Message ($script:localizedData.NetAdapterNotFoundError) # Return a null so that ErrorAction SilentlyContinue works correctly return $null } else { Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($script:localizedData.NetAdapterFoundMessage -f $matchingAdapters.Count) ) -join '') if ($matchingAdapters.Count -gt 1) { if ($IgnoreMultipleMatchingAdapters) { # Was the number of matching adapters found matching the adapter number? if (($InterfaceNumber -gt 1) -and ($InterfaceNumber -gt $matchingAdapters.Count)) { New-InvalidOperationException ` -Message ($script:localizedData.InvalidNetAdapterNumberError ` -f $matchingAdapters.Count, $InterfaceNumber) # Return a null so that ErrorAction SilentlyContinue works correctly return $null } # if } else { New-InvalidOperationException ` -Message ($script:localizedData.MultipleMatchingNetAdapterFound ` -f $matchingAdapters.Count) # Return a null so that ErrorAction SilentlyContinue works correctly return $null } # if } # if } # if # Identify the exact adapter from the adapters that match $exactAdapter = $matchingAdapters[$InterfaceNumber - 1] $returnValue = [PSCustomObject] @{ Name = $exactAdapter.Name PhysicalMediaType = $exactAdapter.PhysicalMediaType Status = $exactAdapter.Status MacAddress = $exactAdapter.MacAddress InterfaceDescription = $exactAdapter.InterfaceDescription InterfaceIndex = $exactAdapter.InterfaceIndex InterfaceGuid = $exactAdapter.InterfaceGuid MatchingAdapterCount = $matchingAdapters.Count } return $returnValue } # Find-NetworkAdapter <# .SYNOPSIS Returns the DNS Client Server static address that are assigned to a network adapter. This is required because Get-DnsClientServerAddress always returns the currently assigned server addresses whether regardless if they were assigned as static or by DHCP. The only way that could be found to do this is to query the registry. .PARAMETER InterfaceAlias Alias of the network interface to get the static DNS Server addresses from. .PARAMETER AddressFamily IP address family. #> function Get-DnsClientServerStaticAddress { [CmdletBinding()] [OutputType([System.String[]])] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $InterfaceAlias, [Parameter(Mandatory = $true)] [ValidateSet('IPv4', 'IPv6')] [System.String] $AddressFamily ) Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($script:localizedData.GettingDNSServerStaticAddressMessage) -f $AddressFamily, $InterfaceAlias ) -join '') # Look up the interface Guid $adapter = Get-NetAdapter ` -InterfaceAlias $InterfaceAlias ` -ErrorAction SilentlyContinue if (-not $adapter) { New-InvalidOperationException ` -Message ($script:localizedData.InterfaceAliasNotFoundError ` -f $InterfaceAlias) # Return null to support ErrorAction Silently Continue return $null } # if $interfaceGuid = $adapter.InterfaceGuid.ToLower() if ($AddressFamily -eq 'IPv4') { $interfaceRegKeyPath = "HKLM:\SYSTEM\CurrentControlSet\Services\Tcpip\Parameters\Interfaces\$interfaceGuid\" } else { $interfaceRegKeyPath = "HKLM:\SYSTEM\CurrentControlSet\Services\Tcpip6\Parameters\Interfaces\$interfaceGuid\" } # if $interfaceInformation = Get-ItemProperty ` -Path $interfaceRegKeyPath ` -ErrorAction SilentlyContinue $nameServerAddressString = $interfaceInformation.NameServer # Are any statically assigned addresses for this adapter? if ([System.String]::IsNullOrWhiteSpace($nameServerAddressString)) { # Static DNS Server addresses not found so return empty array Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($script:localizedData.DNSServerStaticAddressNotSetMessage) -f $AddressFamily, $InterfaceAlias ) -join '') return $null } else { # Static DNS Server addresses found so split them into an array using comma Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($script:localizedData.DNSServerStaticAddressFoundMessage) -f $AddressFamily, $InterfaceAlias, $nameServerAddressString ) -join '') return @($nameServerAddressString -split ',') } # if } # Get-DnsClientServerStaticAddress <# .SYNOPSIS Returns the WINS Client Server static address that are assigned to a network adapter. The CIM class Win32_NetworkAdapterConfiguration unfortunately only supports the primary and secondary WINS server. The registry gives more flexibility. .PARAMETER InterfaceAlias Alias of the network interface to get the static WINS Server addresses from. #> function Get-WinsClientServerStaticAddress { [CmdletBinding()] [OutputType([System.String[]])] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $InterfaceAlias ) Write-Verbose -Message ("$($MyInvocation.MyCommand): $($script:localizedData.GettingWinsServerStaticAddressMessage -f $InterfaceAlias)") # Look up the interface Guid $adapter = Get-NetAdapter -InterfaceAlias $InterfaceAlias -ErrorAction SilentlyContinue if (-not $adapter) { New-InvalidOperationException -Message ($script:localizedData.InterfaceAliasNotFoundError -f $InterfaceAlias) # Return null to support ErrorAction Silently Continue return $null } $interfaceGuid = $adapter.InterfaceGuid.ToLower() $interfaceRegKeyPath = "HKLM:\SYSTEM\CurrentControlSet\Services\NetBT\Parameters\Interfaces\Tcpip_$interfaceGuid\" $interfaceInformation = Get-ItemProperty -Path $interfaceRegKeyPath -ErrorAction SilentlyContinue $nameServerAddressString = $interfaceInformation.NameServerList # Are any statically assigned addresses for this adapter? if (-not $nameServerAddressString) { # Static DNS Server addresses not found so return empty array Write-Verbose -Message ("$($MyInvocation.MyCommand): $($script:localizedData.WinsServerStaticAddressNotSetMessage -f $InterfaceAlias)") return $null } else { # Static DNS Server addresses found so split them into an array using comma Write-Verbose -Message ("$($MyInvocation.MyCommand): $($script:localizedData.WinsServerStaticAddressFoundMessage -f $InterfaceAlias, ($nameServerAddressString -join ','))") return $nameServerAddressString } } # Get-WinsClientServerStaticAddress <# .SYNOPSIS Sets the WINS Client Server static address on a network adapter. The CIM class Win32_NetworkAdapterConfiguration unfortunately only supports the primary and secondary WINS server. The registry gives more flexibility. .PARAMETER InterfaceAlias Alias of the network interface to set the static WINS Server addresses on. #> function Set-WinsClientServerStaticAddress { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $InterfaceAlias, [Parameter(Mandatory = $true)] [AllowEmptyCollection()] [System.String[]] $Address ) Write-Verbose -Message ("$($MyInvocation.MyCommand): $($script:localizedData.SettingWinsServerStaticAddressMessage -f $InterfaceAlias, ($Address -join ', '))") # Look up the interface Guid $adapter = Get-NetAdapter -InterfaceAlias $InterfaceAlias -ErrorAction SilentlyContinue if (-not $adapter) { New-InvalidOperationException -Message ($script:localizedData.InterfaceAliasNotFoundError -f $InterfaceAlias) } $interfaceGuid = $adapter.InterfaceGuid.ToLower() $interfaceRegKeyPath = "HKLM:\SYSTEM\CurrentControlSet\Services\NetBT\Parameters\Interfaces\Tcpip_$interfaceGuid\" Set-ItemProperty -Path $interfaceRegKeyPath -Name NameServerList -Value $Address } # Set-WinsClientServerStaticAddress <# .SYNOPSIS Gets the IP Address prefix from a provided IP Address in CIDR notation. .PARAMETER IPAddress IP Address to get prefix for, can be in CIDR notation. .PARAMETER AddressFamily Address family for provided IP Address, defaults to IPv4. #> function Get-IPAddressPrefix { [cmdletbinding()] param ( [Parameter(Mandatory = $true, ValueFromPipeline)] [System.String[]] $IPAddress, [Parameter()] [ValidateSet('IPv4', 'IPv6')] [System.String] $AddressFamily = 'IPv4' ) process { foreach ($singleIP in $IPAddress) { $prefixLength = ($singleIP -split '/')[1] if (-not ($prefixLength) -and $AddressFamily -eq 'IPv4') { if ($singleIP.split('.')[0] -in (0..127)) { $prefixLength = 8 } elseif ($singleIP.split('.')[0] -in (128..191)) { $prefixLength = 16 } elseif ($singleIP.split('.')[0] -in (192..223)) { $prefixLength = 24 } } elseif (-not ($prefixLength) -and $AddressFamily -eq 'IPv6') { $prefixLength = 64 } [PSCustomObject]@{ IPAddress = $singleIP.split('/')[0] prefixLength = $prefixLength } } } } <# .SYNOPSIS Returns a filter string for the net adapter CIM instances. Wildcards supported. .PARAMETER InterfaceAlias Specifies the alias of a network interface. Supports the use of '*' or '%'. #> function Format-Win32NetworkAdapterFilterByNetConnectionId { [CmdletBinding()] [OutputType([System.String])] param ( [Parameter(Mandatory = $true)] [System.String] $InterfaceAlias ) if ($InterfaceAlias.Contains('*')) { $InterfaceAlias = $InterfaceAlias.Replace('*','%') } if ($InterfaceAlias.Contains('%')) { $operator = ' LIKE ' } else { $operator = '=' } $returnNetAdapaterFilter = 'NetConnectionID{0}"{1}"' -f $operator, $InterfaceAlias return $returnNetAdapaterFilter } Export-ModuleMember -Function @( 'Convert-CIDRToSubhetMask' 'Find-NetworkAdapter' 'Get-DnsClientServerStaticAddress' 'Get-WinsClientServerStaticAddress' 'Set-WinsClientServerStaticAddress' 'Get-IPAddressPrefix' 'Format-Win32NetworkAdapterFilterByNetConnectionId' ) |