DSCResources/DSC_Route/DSC_Route.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 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 |
$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 a Route for an interface. .PARAMETER InterfaceAlias Specifies the alias of a network interface. .PARAMETER AddressFamily Specify the IP address family. .PARAMETER DestinationPrefix Specifies a destination prefix of an IP route. A destination prefix consists of an IP address prefix and a prefix length, separated by a slash (/). .PARAMETER NextHop Specifies the next hop for the IP route. #> 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, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $DestinationPrefix, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $NextHop ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.GettingRouteMessage) ` -f $AddressFamily, $InterfaceAlias, $DestinationPrefix, $NextHop ` ) -join '' ) # Lookup the existing Route $route = Get-Route @PSBoundParameters $returnValue = @{ InterfaceAlias = $InterfaceAlias AddressFamily = $AddressFamily DestinationPrefix = $DestinationPrefix NextHop = $NextHop } if ($route) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.RouteExistsMessage) ` -f $AddressFamily, $InterfaceAlias, $DestinationPrefix, $NextHop ` ) -join '' ) $returnValue += @{ Ensure = 'Present' RouteMetric = [System.Uint16] $route.RouteMetric Publish = $route.Publish PreferredLifetime = [System.Double] $route.PreferredLifetime.TotalSeconds } } else { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.RouteDoesNotExistMessage) ` -f $AddressFamily, $InterfaceAlias, $DestinationPrefix, $NextHop ` ) -join '' ) $returnValue += @{ Ensure = 'Absent' } } return $returnValue } # Get-TargetResource <# .SYNOPSIS Sets a Route for an interface. .PARAMETER InterfaceAlias Specifies the alias of a network interface. .PARAMETER AddressFamily Specify the IP address family. .PARAMETER DestinationPrefix Specifies a destination prefix of an IP route. A destination prefix consists of an IP address prefix and a prefix length, separated by a slash (/). .PARAMETER NextHop Specifies the next hop for the IP route. .PARAMETER Ensure Specifies whether the route should exist. Defaults to 'Present'. .PARAMETER RouteMetric Specifies an integer route metric for an IP route. Defaults to 256. .PARAMETER Publish Specifies the publish setting of an IP route. Defaults to 'No'. .PARAMETER PreferredLifetime Specifies a preferred lifetime in seconds of an IP route. #> function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $InterfaceAlias, [Parameter(Mandatory = $true)] [ValidateSet('IPv4', 'IPv6')] [System.String] $AddressFamily, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $DestinationPrefix, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $NextHop, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.Uint16] $RouteMetric = 256, [Parameter()] [ValidateSet('No', 'Yes', 'Age')] [System.String] $Publish = 'No', [Parameter()] [System.Double] $PreferredLifetime ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.SettingRouteMessage) ` -f $AddressFamily, $InterfaceAlias, $DestinationPrefix, $NextHop ` ) -join '' ) # Remove any parameters that can't be splatted. $null = $PSBoundParameters.Remove('Ensure') # Lookup the existing Route $route = Get-Route @PSBoundParameters if ($Ensure -eq 'Present') { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.EnsureRouteExistsMessage) ` -f $AddressFamily, $InterfaceAlias, $DestinationPrefix, $NextHop ` ) -join '' ) if ($route) { # The Route exists - update it Set-NetRoute @PSBoundParameters ` -Confirm:$false ` -ErrorAction Stop Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.RouteUpdatedMessage) ` -f $AddressFamily, $InterfaceAlias, $DestinationPrefix, $NextHop ` ) -join '' ) } else { # The Route does not exit - create it New-NetRoute @PSBoundParameters ` -ErrorAction Stop Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.RouteCreatedMessage) ` -f $AddressFamily, $InterfaceAlias, $DestinationPrefix, $NextHop ` ) -join '' ) } } else { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.EnsureRouteDoesNotExistMessage) ` -f $AddressFamily, $InterfaceAlias, $DestinationPrefix, $NextHop ` ) -join '' ) if ($route) { <# The Route exists - remove it Use the parameters passed to Set-TargetResource to delete the appropriate route. Clear the Publish and PreferredLifetime parameters so they aren't passed to the Remove-NetRoute cmdlet. #> $null = $PSBoundParameters.Remove('Publish') $null = $PSBoundParameters.Remove('PreferredLifetime') Remove-NetRoute @PSBoundParameters ` -Confirm:$false ` -ErrorAction Stop Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.RouteRemovedMessage) ` -f $AddressFamily, $InterfaceAlias, $DestinationPrefix, $NextHop ` ) -join '' ) } # if } # if } # Set-TargetResource <# .SYNOPSIS Tests the state of a Route on an interface. .PARAMETER InterfaceAlias Specifies the alias of a network interface. .PARAMETER AddressFamily Specify the IP address family. .PARAMETER DestinationPrefix Specifies a destination prefix of an IP route. A destination prefix consists of an IP address prefix and a prefix length, separated by a slash (/). .PARAMETER NextHop Specifies the next hop for the IP route. .PARAMETER Ensure Specifies whether the route should exist. Defaults to 'Present'. .PARAMETER RouteMetric Specifies an integer route metric for an IP route. Defaults to 256. .PARAMETER Publish Specifies the publish setting of an IP route. Defaults to 'No'. .PARAMETER PreferredLifetime Specifies a preferred lifetime in seconds of an IP route. #> 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(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $DestinationPrefix, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $NextHop, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.Uint16] $RouteMetric = 256, [Parameter()] [ValidateSet('No', 'Yes', 'Age')] [System.String] $Publish = 'No', [Parameter()] [System.Double] $PreferredLifetime ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.TestingRouteMessage) ` -f $AddressFamily, $InterfaceAlias, $DestinationPrefix, $NextHop ` ) -join '' ) # Flag to signal whether settings are correct [System.Boolean] $desiredConfigurationMatch = $true # Remove any parameters that can't be splatted. $null = $PSBoundParameters.Remove('Ensure') # Check the parameters Assert-ResourceProperty @PSBoundParameters # Lookup the existing Route $route = Get-Route @PSBoundParameters if ($Ensure -eq 'Present') { # The route should exist if ($route) { # The route exists and does - but check the parameters if (($PSBoundParameters.ContainsKey('RouteMetric')) ` -and ($route.RouteMetric -ne $RouteMetric)) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.RoutePropertyNeedsUpdateMessage) ` -f $AddressFamily, $InterfaceAlias, $DestinationPrefix, $NextHop, 'RouteMetric' ` ) -join '' ) $desiredConfigurationMatch = $false } if (($PSBoundParameters.ContainsKey('Publish')) ` -and ($route.Publish -ne $Publish)) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.RoutePropertyNeedsUpdateMessage) ` -f $AddressFamily, $InterfaceAlias, $DestinationPrefix, $NextHop, 'Publish' ` ) -join '' ) $desiredConfigurationMatch = $false } if (($PSBoundParameters.ContainsKey('PreferredLifetime')) ` -and ($route.PreferredLifetime.TotalSeconds -ne $PreferredLifetime)) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.RoutePropertyNeedsUpdateMessage) ` -f $AddressFamily, $InterfaceAlias, $DestinationPrefix, $NextHop, 'PreferredLifetime' ` ) -join '' ) $desiredConfigurationMatch = $false } } else { # The route doesn't exist but should Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.RouteDoesNotExistButShouldMessage) ` -f $AddressFamily, $InterfaceAlias, $DestinationPrefix, $NextHop ` ) -join '' ) $desiredConfigurationMatch = $false } } else { # The route should not exist if ($route) { # The route exists but should not Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.RouteExistsButShouldNotMessage) ` -f $AddressFamily, $InterfaceAlias, $DestinationPrefix, $NextHop ` ) -join '' ) $desiredConfigurationMatch = $false } else { # The route does not exist and should not Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.RouteDoesNotExistAndShouldNotMessage) ` -f $AddressFamily, $InterfaceAlias, $DestinationPrefix, $NextHop ` ) -join '' ) } } # if return $desiredConfigurationMatch } # Test-TargetResource <# .SYNOPSIS This function looks up the route using the parameters and returns it. If the route is not found $null is returned. .PARAMETER InterfaceAlias Specifies the alias of a network interface. .PARAMETER AddressFamily Specify the IP address family. .PARAMETER DestinationPrefix Specifies a destination prefix of an IP route. A destination prefix consists of an IP address prefix and a prefix length, separated by a slash (/). .PARAMETER NextHop Specifies the next hop for the IP route. .PARAMETER Ensure Specifies whether the route should exist. Defaults to 'Present'. .PARAMETER RouteMetric Specifies an integer route metric for an IP route. Defaults to 256. .PARAMETER Publish Specifies the publish setting of an IP route. Defaults to 'No'. .PARAMETER PreferredLifetime Specifies a preferred lifetime in seconds of an IP route. #> function Get-Route { param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $InterfaceAlias, [Parameter(Mandatory = $true)] [ValidateSet('IPv4', 'IPv6')] [System.String] $AddressFamily, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $DestinationPrefix, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $NextHop, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.Uint16] $RouteMetric = 256, [Parameter()] [ValidateSet('No', 'Yes', 'Age')] [System.String] $Publish = 'No', [Parameter()] [System.Double] $PreferredLifetime ) try { $route = Get-NetRoute ` -InterfaceAlias $InterfaceAlias ` -AddressFamily $AddressFamily ` -DestinationPrefix $DestinationPrefix ` -NextHop $NextHop ` -ErrorAction Stop } catch [Microsoft.PowerShell.Cmdletization.Cim.CimJobException] { $route = $null } catch { throw $_ } return $route } <# .SYNOPSIS This function validates the parameters passed. Called by Test-Resource. Will throw an error if any parameters are invalid. .PARAMETER InterfaceAlias Specifies the alias of a network interface. .PARAMETER AddressFamily Specify the IP address family. .PARAMETER DestinationPrefix Specifies a destination prefix of an IP route. A destination prefix consists of an IP address prefix and a prefix length, separated by a slash (/). .PARAMETER NextHop Specifies the next hop for the IP route. .PARAMETER Ensure Specifies whether the route should exist. Defaults to 'Present'. .PARAMETER RouteMetric Specifies an integer route metric for an IP route. Defaults to 256. .PARAMETER Publish Specifies the publish setting of an IP route. Defaults to 'No'. .PARAMETER PreferredLifetime Specifies a preferred lifetime in seconds of an IP route. #> function Assert-ResourceProperty { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $InterfaceAlias, [Parameter(Mandatory = $true)] [ValidateSet('IPv4', 'IPv6')] [System.String] $AddressFamily, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $DestinationPrefix, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $NextHop, [Parameter()] [ValidateSet('Present', 'Absent')] [System.String] $Ensure = 'Present', [Parameter()] [System.Uint16] $RouteMetric = 256, [Parameter()] [ValidateSet('No', 'Yes', 'Age')] [System.String] $Publish = 'No', [Parameter()] [System.Double] $PreferredLifetime ) # Validate the Adapter exists if (-not (Get-NetAdapter | Where-Object -Property Name -EQ $InterfaceAlias )) { New-InvalidArgumentException ` -Message $($($script:localizedData.InterfaceNotAvailableError) -f $InterfaceAlias) ` -ArgumentName 'InterfaceAlias' } # Validate the DestinationPrefix Parameter $components = $DestinationPrefix -split '/' $prefix = $components[0] Assert-IPAddress -Address $prefix -AddressFamily $AddressFamily # Validate the NextHop Parameter Assert-IPAddress -Address $NextHop -AddressFamily $AddressFamily } Export-ModuleMember -Function *-TargetResource |