DSCResources/MSFT_xDefaultGatewayAddress/MSFT_xDefaultGatewayAddress.psm1
|
$script:ResourceRootPath = Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) # Import the xNetworking Resource Module (to import the common modules) Import-Module -Name (Join-Path -Path $script:ResourceRootPath -ChildPath 'xNetworking.psd1') # Import Localization Strings $localizedData = Get-LocalizedData ` -ResourceName 'MSFT_xDefaultGatewayAddress' ` -ResourcePath (Split-Path -Parent $Script:MyInvocation.MyCommand.Path) <# .SYNOPSIS Returns the current state of the Default Gateway for an interface. .PARAMETER InterfaceAlias Alias of the network interface for which the default gateway address is set. .PARAMETER AddressFamily IP address family. .PARAMETER Address The desired default gateway address - if not provided default gateway will be removed. #> function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [String] $InterfaceAlias, [Parameter(Mandatory = $true)] [ValidateSet('IPv4', 'IPv6')] [String] $AddressFamily, [String] $Address ) Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($LocalizedData.GettingDefaultGatewayAddressMessage) ) -join '' ) # Use $AddressFamily to select the IPv4 or IPv6 destination prefix $destinationPrefix = '0.0.0.0/0' if ($AddressFamily -eq 'IPv6') { $destinationPrefix = '::/0' } # Get all the default routes $defaultRoutes = Get-NetRoute -InterfaceAlias $InterfaceAlias -AddressFamily ` $AddressFamily -ErrorAction Stop | ` Where-Object { $_.DestinationPrefix -eq $destinationPrefix } $returnValue = @{ AddressFamily = $AddressFamily InterfaceAlias = $InterfaceAlias } # If there is a Default Gateway defined for this interface/address family add it # to the return value. if ($defaultRoutes) { $returnValue += @{ Address = $defaultRoutes.NextHop } } else { $returnValue += @{ Address = $null } } $returnValue } <# .SYNOPSIS Sets the Default Gateway for an interface. .PARAMETER InterfaceAlias Alias of the network interface for which the default gateway address is set. .PARAMETER AddressFamily IP address family. .PARAMETER Address The desired default gateway address - if not provided default gateway will be removed. #> function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [String] $InterfaceAlias, [Parameter(Mandatory = $true)] [ValidateSet('IPv4', 'IPv6')] [String] $AddressFamily, [String] $Address ) Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($LocalizedData.ApplyingDefaultGatewayAddressMessage) ) -join '' ) # Use $AddressFamily to select the IPv4 or IPv6 destination prefix $destinationPrefix = '0.0.0.0/0' if ($AddressFamily -eq 'IPv6') { $destinationPrefix = '::/0' } # Get all the default routes $defaultRoutes = @(Get-NetRoute ` -InterfaceAlias $InterfaceAlias ` -AddressFamily $AddressFamily ` -ErrorAction Stop).Where( { $_.DestinationPrefix -eq $destinationPrefix } ) # Remove any existing default route foreach ($defaultRoute in $defaultRoutes) { Remove-NetRoute ` -DestinationPrefix $defaultRoute.DestinationPrefix ` -NextHop $defaultRoute.NextHop ` -InterfaceIndex $defaultRoute.InterfaceIndex ` -AddressFamily $defaultRoute.AddressFamily ` -Confirm:$false -ErrorAction Stop } if ($Address) { # Set the correct Default Route # Build parameter hash table $parameters = @{ DestinationPrefix = $destinationPrefix InterfaceAlias = $InterfaceAlias AddressFamily = $AddressFamily NextHop = $Address } New-NetRoute @Parameters -ErrorAction Stop Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($LocalizedData.DefaultGatewayAddressSetToDesiredStateMessage) ) -join '' ) } else { Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($LocalizedData.DefaultGatewayRemovedMessage) ) -join '' ) } } <# .SYNOPSIS Tests the state of the Default Gateway for an interface. .PARAMETER InterfaceAlias Alias of the network interface for which the default gateway address is set. .PARAMETER AddressFamily IP address family. .PARAMETER Address The desired default gateway address - if not provided default gateway will be removed. #> function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [String] $InterfaceAlias, [Parameter(Mandatory = $true)] [ValidateSet('IPv4', 'IPv6')] [String] $AddressFamily, [String] $Address ) # Flag to signal whether settings are correct [Boolean] $desiredConfigurationMatch = $true Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($LocalizedData.CheckingDefaultGatewayAddressMessage) ) -join '' ) Assert-ResourceProperty @PSBoundParameters # Use $AddressFamily to select the IPv4 or IPv6 destination prefix $destinationPrefix = '0.0.0.0/0' if ($AddressFamily -eq 'IPv6') { $destinationPrefix = '::/0' } # Get all the default routes $defaultRoutes = @(Get-NetRoute ` -InterfaceAlias $InterfaceAlias ` -AddressFamily $AddressFamily ` -ErrorAction Stop).Where( { $_.DestinationPrefix -eq $destinationPrefix } ) # Test if the Default Gateway passed is equal to the current default gateway if ($Address) { if ($defaultRoutes) { if (-not $defaultRoutes.Where( { $_.NextHop -eq $Address } )) { Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($LocalizedData.DefaultGatewayNotMatchMessage) -f $Address,$defaultRoutes.NextHop ) -join '' ) $desiredConfigurationMatch = $false } else { Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($LocalizedData.DefaultGatewayCorrectMessage) ) -join '' ) } } else { Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($LocalizedData.DefaultGatewayDoesNotExistMessage) -f $Address ) -join '' ) $desiredConfigurationMatch = $false } } else { # Is a default gateway address set? if ($defaultRoutes) { Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($LocalizedData.DefaultGatewayExistsButShouldNotMessage) ) -join '' ) $desiredConfigurationMatch = $false } else { Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($LocalizedData.DefaultGatewayExistsAndShouldMessage) 'Default Gateway does not exist which is correct.' ) -join '' ) } } return $desiredConfigurationMatch } <# .SYNOPSIS Check 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 default gateway address is set. .PARAMETER AddressFamily IP address family. .PARAMETER Address The desired default gateway address - if not provided default gateway will be removed. #> function Assert-ResourceProperty { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [String] $InterfaceAlias, [ValidateSet('IPv4', 'IPv6')] [String] $AddressFamily = 'IPv4', [String] $Address ) if (-not (Get-NetAdapter | Where-Object -Property Name -EQ $InterfaceAlias )) { $errorId = 'InterfaceNotAvailable' $errorCategory = [System.Management.Automation.ErrorCategory]::DeviceError $errorMessage = $($LocalizedData.InterfaceNotAvailableError) -f $InterfaceAlias $exception = New-Object -TypeName System.InvalidOperationException ` -ArgumentList $errorMessage $errorRecord = New-Object -TypeName System.Management.Automation.ErrorRecord ` -ArgumentList $exception, $errorId, $errorCategory, $null $PSCmdlet.ThrowTerminatingError($errorRecord) } if ($Address) { if (-not ([System.Net.IPAddress]::TryParse($Address, [ref]0))) { $errorId = 'AddressFormatError' $errorCategory = [System.Management.Automation.ErrorCategory]::InvalidArgument $errorMessage = $($LocalizedData.AddressFormatError) -f $Address $exception = New-Object -TypeName System.InvalidOperationException ` -ArgumentList $errorMessage $errorRecord = New-Object -TypeName System.Management.Automation.ErrorRecord ` -ArgumentList $exception, $errorId, $errorCategory, $null $PSCmdlet.ThrowTerminatingError($errorRecord) } $detectedAddressFamily = ([System.Net.IPAddress]$Address).AddressFamily.ToString() if (($detectedAddressFamily -eq [System.Net.Sockets.AddressFamily]::InterNetwork.ToString()) ` -and ($AddressFamily -ne 'IPv4')) { $errorId = 'AddressMismatchError' $errorCategory = [System.Management.Automation.ErrorCategory]::InvalidArgument $errorMessage = $($LocalizedData.AddressIPv4MismatchError) -f $Address,$AddressFamily $exception = New-Object -TypeName System.InvalidOperationException ` -ArgumentList $errorMessage $errorRecord = New-Object -TypeName System.Management.Automation.ErrorRecord ` -ArgumentList $exception, $errorId, $errorCategory, $null $PSCmdlet.ThrowTerminatingError($errorRecord) } if (($detectedAddressFamily -eq [System.Net.Sockets.AddressFamily]::InterNetworkV6.ToString()) ` -and ($AddressFamily -ne 'IPv6')) { $errorId = 'AddressMismatchError' $errorCategory = [System.Management.Automation.ErrorCategory]::InvalidArgument $errorMessage = $($LocalizedData.AddressIPv6MismatchError) -f $Address,$AddressFamily $exception = New-Object -TypeName System.InvalidOperationException ` -ArgumentList $errorMessage $errorRecord = New-Object -TypeName System.Management.Automation.ErrorRecord ` -ArgumentList $exception, $errorId, $errorCategory, $null $PSCmdlet.ThrowTerminatingError($errorRecord) } } } # Assert-ResourceProperty Export-ModuleMember -function *-TargetResource |