DSCResources/DSC_NetIPInterface/DSC_NetIPInterface.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 |
$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 It can be used by several of the functions to reduce the amount of code required Each element contains 4 properties: Name: The parameter name Type: This is the content type of the paramater (it is either array or string or blank) A blank type means it will not be compared MockedValue: This value is used for unit testing and will be used as the value that will be returned in mocks. TestValue: This value is used for unit testing and will be used to compare with the value returned by the mocks. #> $script:resourceData = Import-LocalizedData ` -BaseDirectory $PSScriptRoot ` -FileName 'DSC_NetIPInterface.data.psd1' $script:parameterList = $script:resourceData.ParameterList <# .SYNOPSIS Returns the current state of the Network Interface. .PARAMETER InterfaceAlias Alias of the network interface to configure. .PARAMETER AddressFamily IP address family on the interface to configure. #> function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $InterfaceAlias, [Parameter(Mandatory = $true)] [ValidateSet('IPv4', 'IPv6')] [System.String] $AddressFamily ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.GettingNetIPInterfaceMessage) -f $InterfaceAlias, $AddressFamily ) -join '') $netIPInterfaceParameters = @{ InterfaceAlias = $InterfaceAlias AddressFamily = $AddressFamily } $netIPInterface = Get-NetworkIPInterface @netIPInterfaceParameters <# Populate the properties for get target resource by looping through the parameter array list and adding the values to the result array #> foreach ($parameter in $script:parameterList) { $parameterName = $parameter.Name $parameterValue = $netIPInterface.$($parameter.Name) $netIPInterfaceParameters.Add($parameterName, $parameterValue) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.NetIPInterfaceParameterValueMessage) -f ` $InterfaceAlias, $AddressFamily, $parameterName, $parameterValue ) -join '') } return $netIPInterfaceParameters } <# .SYNOPSIS Sets the current state of the Network Interface. .PARAMETER InterfaceAlias Alias of the network interface to configure. .PARAMETER AddressFamily IP address family on the interface to configure. .PARAMETER AdvertiseDefaultRoute Specifies the default router advertisement for an interface. .PARAMETER Advertising Specifies the router advertisement value for the IP interface. .PARAMETER AutomaticMetric Specifies the value for automatic metric calculation. .PARAMETER Dhcp Specifies the Dynamic Host Configuration Protocol (DHCP) value for an IP interface. .PARAMETER DirectedMacWolPattern Specifies the wake-up packet value for an IP interface. .PARAMETER EcnMarking Specifies the value for Explicit Congestion Notification (ECN) marking. .PARAMETER ForceArpNdWolPattern Specifies the Wake On LAN (WOL) value for the IP interface. .PARAMETER Forwarding Specifies the packet forwarding value for the IP interface. .PARAMETER IgnoreDefaultRoutes Specifies a value for Default Route advertisements. .PARAMETER ManagedAddressConfiguration Specifies the value for managed address configuration. .PARAMETER NeighborUnreachabilityDetection Specifies the value for Neighbor Unreachability Detection (NUD). .PARAMETER OtherStatefulConfiguration Specifies the value for configuration other than addresses. .PARAMETER RouterDiscovery Specifies the value for router discovery for an IP interface. .PARAMETER WeakHostReceive Specifies the receive value for a weak host model. .PARAMETER WeakHostSend Specifies the send value for a weak host model. #> function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $InterfaceAlias, [Parameter(Mandatory = $true)] [ValidateSet('IPv4', 'IPv6')] [System.String] $AddressFamily, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $AdvertiseDefaultRoute, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $Advertising, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $AutomaticMetric, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $Dhcp, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $DirectedMacWolPattern, [Parameter()] [ValidateSet('Disabled', 'UseEct1', 'UseEct0', 'AppDecide')] [System.String] $EcnMarking, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $ForceArpNdWolPattern, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $Forwarding, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $IgnoreDefaultRoutes, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $ManagedAddressConfiguration, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $NeighborUnreachabilityDetection, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $OtherStatefulConfiguration, [Parameter()] [ValidateSet('Enabled', 'Disabled', 'ControlledByDHCP')] [System.String] $RouterDiscovery, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $WeakHostReceive, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $WeakHostSend ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.ApplyingNetIPInterfaceMessage) ` -f $InterfaceAlias, $AddressFamily ) -join '') $netIPInterfaceParameters = @{ InterfaceAlias = $InterfaceAlias AddressFamily = $AddressFamily } $netIPInterface = Get-NetworkIPInterface @netIPInterfaceParameters <# Loop through each possible property and if it is passed to the resource and the current value of the property is different then add it to the netIPInterfaceParameters array that will be used to update the net IP interface settings. #> $parameterUpdated = $false foreach ($parameter in $script:parameterList) { $parameterName = $parameter.Name if ($PSBoundParameters.ContainsKey($parameterName)) { $parameterValue = $netIPInterface.$($parameterName) $parameterNewValue = (Get-Variable -Name ($parameterName)).Value if ($parameterNewValue -and ($parameterValue -ne $parameterNewValue)) { $null = $netIPInterfaceParameters.Add($parameterName, $parameterNewValue) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.SettingNetIPInterfaceParameterValueMessage) ` -f $InterfaceAlias, $AddressFamily, $parameterName, $parameterNewValue ) -join '') $parameterUpdated = $true } } } if ($parameterUpdated) { $null = Set-NetIPInterface @netIPInterfaceParameters } } <# .SYNOPSIS Sets the current state of the Network Interface. .PARAMETER InterfaceAlias Alias of the network interface to configure. .PARAMETER AddressFamily IP address family on the interface to configure. .PARAMETER AdvertiseDefaultRoute Specifies the default router advertisement for an interface. .PARAMETER Advertising Specifies the router advertisement value for the IP interface. .PARAMETER AutomaticMetric Specifies the value for automatic metric calculation. .PARAMETER Dhcp Specifies the Dynamic Host Configuration Protocol (DHCP) value for an IP interface. .PARAMETER DirectedMacWolPattern Specifies the wake-up packet value for an IP interface. .PARAMETER EcnMarking Specifies the value for Explicit Congestion Notification (ECN) marking. .PARAMETER ForceArpNdWolPattern Specifies the Wake On LAN (WOL) value for the IP interface. .PARAMETER Forwarding Specifies the packet forwarding value for the IP interface. .PARAMETER IgnoreDefaultRoutes Specifies a value for Default Route advertisements. .PARAMETER ManagedAddressConfiguration Specifies the value for managed address configuration. .PARAMETER NeighborUnreachabilityDetection Specifies the value for Neighbor Unreachability Detection (NUD). .PARAMETER OtherStatefulConfiguration Specifies the value for configuration other than addresses. .PARAMETER RouterDiscovery Specifies the value for router discovery for an IP interface. .PARAMETER WeakHostReceive Specifies the receive value for a weak host model. .PARAMETER WeakHostSend Specifies the send value for a weak host model. #> function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $InterfaceAlias, [Parameter(Mandatory = $true)] [ValidateSet('IPv4', 'IPv6')] [System.String] $AddressFamily, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $AdvertiseDefaultRoute, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $Advertising, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $AutomaticMetric, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $Dhcp, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $DirectedMacWolPattern, [Parameter()] [ValidateSet('Disabled', 'UseEct1', 'UseEct0', 'AppDecide')] [System.String] $EcnMarking, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $ForceArpNdWolPattern, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $Forwarding, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $IgnoreDefaultRoutes, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $ManagedAddressConfiguration, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $NeighborUnreachabilityDetection, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $OtherStatefulConfiguration, [Parameter()] [ValidateSet('Enabled', 'Disabled', 'ControlledByDHCP')] [System.String] $RouterDiscovery, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $WeakHostReceive, [Parameter()] [ValidateSet('Enabled', 'Disabled')] [System.String] $WeakHostSend ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.CheckingNetIPInterfaceMessage) -f $InterfaceAlias, $AddressFamily ) -join '') $netIPInterfaceParameters = @{ InterfaceAlias = $InterfaceAlias AddressFamily = $AddressFamily } $netIPInterface = Get-NetworkIPInterface @netIPInterfaceParameters $desiredConfigurationMatch = $true <# Loop through the $script:parameterList array and compare the source with the value of each parameter. If different then set $desiredConfigurationMatch to false. #> foreach ($parameter in $script:parameterList) { $parameterName = $parameter.Name if ($PSBoundParameters.ContainsKey($parameterName)) { $parameterValue = $netIPInterface.$($parameterName) $parameterNewValue = (Get-Variable -Name ($parameterName)).Value switch -Wildcard ($parameter.Type) { 'String' { # Perform a plain string comparison. if ($parameterNewValue -and ($parameterValue -ne $parameterNewValue)) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.PropertyNoMatchMessage) ` -f $parameterName, $parameterValue, $parameterNewValue ) -join '') $desiredConfigurationMatch = $false } } } } } return $desiredConfigurationMatch } <# .SYNOPSIS Get the network IP interface for the address family. If the network interface is not found or the address family is not bound to the inerface then an exception will be thrown. .PARAMETER InterfaceAlias Alias of the network interface to configure. .PARAMETER AddressFamily IP address family on the interface to configure. #> function Get-NetworkIPInterface { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $InterfaceAlias, [Parameter(Mandatory = $true)] [ValidateSet('IPv4', 'IPv6')] [System.String] $AddressFamily ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.GettingNetIPInterfaceMessage) -f $InterfaceAlias, $AddressFamily ) -join '') $netIPInterface = Get-NetIPInterface @PSBoundParameters -ErrorAction SilentlyContinue if (-not $netIPInterface) { # The Net IP Interface does not exist or address family is not bound New-InvalidOperationException ` -Message ($script:localizedData.NetIPInterfaceDoesNotExistMessage -f $InterfaceAlias, $AddressFamily) } return $netIPInterface } Export-ModuleMember -Function *-TargetResource |