DSCResources/MSFT_xExchMailboxTransportService/MSFT_xExchMailboxTransportService.psm1
|
function Get-TargetResource { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSDSCUseVerboseMessageInDSCResource", "")] [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [System.String] $Identity, [Parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] [System.Management.Automation.Credential()] $Credential, [System.Boolean] $AllowServiceRestart = $false, [System.Boolean] $ConnectivityLogEnabled, [System.String] $ConnectivityLogMaxAge, [System.String] $ConnectivityLogMaxDirectorySize, [System.String] $ConnectivityLogMaxFileSize, [System.String] $ConnectivityLogPath, [System.Boolean] $ContentConversionTracingEnabled, [System.Int32] $MaxConcurrentMailboxDeliveries, [System.Int32] $MaxConcurrentMailboxSubmissions, [System.Boolean] $PipelineTracingEnabled, [System.String] $PipelineTracingPath, [System.String] $PipelineTracingSenderAddress, [System.String] $ReceiveProtocolLogMaxAge, [System.String] $ReceiveProtocolLogMaxDirectorySize, [System.String] $ReceiveProtocolLogMaxFileSize, [System.String] $ReceiveProtocolLogPath, [System.String] $RoutingTableLogMaxAge, [System.String] $RoutingTableLogMaxDirectorySize, [System.String] $RoutingTableLogPath, [System.String] $SendProtocolLogMaxAge, [System.String] $SendProtocolLogMaxDirectorySize, [System.String] $SendProtocolLogMaxFileSize, [System.String] $SendProtocolLogPath ) #Load helper module Import-Module "$((Get-Item -LiteralPath $PSScriptRoot).Parent.Parent.FullName)\Misc\xExchangeCommon.psm1" -Verbose:0 LogFunctionEntry -Parameters @{"Identity" = $Identity} -VerbosePreference $VerbosePreference #Establish remote Powershell session GetRemoteExchangeSession -Credential $Credential -CommandsToLoad "Get-MailboxTransportService" -VerbosePreference $VerbosePreference #Remove Credential and Ensure so we don't pass it into the next command RemoveParameters -PSBoundParametersIn $PSBoundParameters -ParamsToRemove "Credential","AllowServiceRestart" $mbxTransportService = Get-MailboxTransportService $Identity -ErrorAction SilentlyContinue if ($null -ne $mbxTransportService) { $returnValue = @{ Identity = $Identity ConnectivityLogEnabled = $mbxTransportService.ConnectivityLogEnabled ConnectivityLogMaxAge = $mbxTransportService.ConnectivityLogMaxAge ConnectivityLogMaxDirectorySize = $mbxTransportService.ConnectivityLogMaxDirectorySize ConnectivityLogMaxFileSize = $mbxTransportService.ConnectivityLogMaxFileSize ConnectivityLogPath = $mbxTransportService.ConnectivityLogPath ContentConversionTracingEnabled = $mbxTransportService.ContentConversionTracingEnabled MaxConcurrentMailboxDeliveries = $mbxTransportService.MaxConcurrentMailboxDeliveries MaxConcurrentMailboxSubmissions = $mbxTransportService.MaxConcurrentMailboxSubmissions PipelineTracingEnabled = $mbxTransportService.PipelineTracingEnabled PipelineTracingPath = $mbxTransportService.PipelineTracingPath PipelineTracingSenderAddress = $mbxTransportService.PipelineTracingSenderAddress ReceiveProtocolLogMaxAge = $mbxTransportService.ReceiveProtocolLogMaxAge ReceiveProtocolLogMaxDirectorySize = $mbxTransportService.ReceiveProtocolLogMaxDirectorySize ReceiveProtocolLogMaxFileSize = $mbxTransportService.ReceiveProtocolLogMaxFileSize ReceiveProtocolLogPath = $mbxTransportService.ReceiveProtocolLogPath SendProtocolLogMaxAge = $mbxTransportService.SendProtocolLogMaxAge SendProtocolLogMaxDirectorySize = $mbxTransportService.SendProtocolLogMaxDirectorySize SendProtocolLogMaxFileSize = $mbxTransportService.SendProtocolLogMaxFileSize SendProtocolLogPath = $mbxTransportService.SendProtocolLogPath } } $returnValue } function Set-TargetResource { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")] [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $Identity, [Parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] [System.Management.Automation.Credential()] $Credential, [System.Boolean] $AllowServiceRestart = $false, [System.Boolean] $ConnectivityLogEnabled, [System.String] $ConnectivityLogMaxAge, [System.String] $ConnectivityLogMaxDirectorySize, [System.String] $ConnectivityLogMaxFileSize, [System.String] $ConnectivityLogPath, [System.Boolean] $ContentConversionTracingEnabled, [System.Int32] $MaxConcurrentMailboxDeliveries, [System.Int32] $MaxConcurrentMailboxSubmissions, [System.Boolean] $PipelineTracingEnabled, [System.String] $PipelineTracingPath, [System.String] $PipelineTracingSenderAddress, [System.String] $ReceiveProtocolLogMaxAge, [System.String] $ReceiveProtocolLogMaxDirectorySize, [System.String] $ReceiveProtocolLogMaxFileSize, [System.String] $ReceiveProtocolLogPath, [System.String] $RoutingTableLogMaxAge, [System.String] $RoutingTableLogMaxDirectorySize, [System.String] $RoutingTableLogPath, [System.String] $SendProtocolLogMaxAge, [System.String] $SendProtocolLogMaxDirectorySize, [System.String] $SendProtocolLogMaxFileSize, [System.String] $SendProtocolLogPath ) #Load helper module Import-Module "$((Get-Item -LiteralPath $PSScriptRoot).Parent.Parent.FullName)\Misc\xExchangeCommon.psm1" -Verbose:0 #Establish remote Powershell session GetRemoteExchangeSession -Credential $Credential -CommandsToLoad "Set-MailboxTransportService" -VerbosePreference $VerbosePreference #Remove Credential and Ensure so we don't pass it into the next command RemoveParameters -PSBoundParametersIn $PSBoundParameters -ParamsToRemove "Credential","AllowServiceRestart" #if PipelineTracingSenderAddress exists and is empty, set it to $null so Set-MailboxTransportService nulls out the stored value if ($PSBoundParameters.ContainsKey('PipelineTracingSenderAddress') -and [string]::IsNullOrEmpty($PipelineTracingSenderAddress)) { $PSBoundParameters['PipelineTracingSenderAddress'] = $null } Set-MailboxTransportService @PSBoundParameters if ($AllowServiceRestart -eq $true) { Write-Verbose "Restart service MSExchangeDelivery" Restart-Service -Name MSExchangeDelivery -WarningAction SilentlyContinue Write-Verbose "Restart service MSExchangeSubmission" Restart-Service -Name MSExchangeSubmission -WarningAction SilentlyContinue } else { Write-Warning "The configuration will not take effect until the MSExchangeDelivery and/or MSExchangeSubmission services are manually restarted." } } function Test-TargetResource { [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSDSCUseVerboseMessageInDSCResource", "")] [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [System.String] $Identity, [Parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] [System.Management.Automation.Credential()] $Credential, [System.Boolean] $AllowServiceRestart = $false, [System.Boolean] $ConnectivityLogEnabled, [System.String] $ConnectivityLogMaxAge, [System.String] $ConnectivityLogMaxDirectorySize, [System.String] $ConnectivityLogMaxFileSize, [System.String] $ConnectivityLogPath, [System.Boolean] $ContentConversionTracingEnabled, [System.Int32] $MaxConcurrentMailboxDeliveries, [System.Int32] $MaxConcurrentMailboxSubmissions, [System.Boolean] $PipelineTracingEnabled, [System.String] $PipelineTracingPath, [System.String] $PipelineTracingSenderAddress, [System.String] $ReceiveProtocolLogMaxAge, [System.String] $ReceiveProtocolLogMaxDirectorySize, [System.String] $ReceiveProtocolLogMaxFileSize, [System.String] $ReceiveProtocolLogPath, [System.String] $RoutingTableLogMaxAge, [System.String] $RoutingTableLogMaxDirectorySize, [System.String] $RoutingTableLogPath, [System.String] $SendProtocolLogMaxAge, [System.String] $SendProtocolLogMaxDirectorySize, [System.String] $SendProtocolLogMaxFileSize, [System.String] $SendProtocolLogPath ) #Load helper module Import-Module "$((Get-Item -LiteralPath $PSScriptRoot).Parent.Parent.FullName)\Misc\xExchangeCommon.psm1" -Verbose:0 LogFunctionEntry -Parameters @{"Identity" = $Identity} -VerbosePreference $VerbosePreference #Establish remote Powershell session GetRemoteExchangeSession -Credential $Credential -CommandsToLoad "Get-MailboxTransportService" -VerbosePreference $VerbosePreference $mbxTransportService = Get-MailboxTransportService $Identity -ErrorAction SilentlyContinue if ($null -ne $mbxTransportService) { if (!(VerifySetting -Name "ConnectivityLogEnabled" -Type "Boolean" -ExpectedValue $ConnectivityLogEnabled -ActualValue $mbxTransportService.ConnectivityLogEnabled -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "ConnectivityLogMaxAge" -Type "Timespan" -ExpectedValue $ConnectivityLogMaxAge -ActualValue $mbxTransportService.ConnectivityLogMaxAge -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "ConnectivityLogMaxDirectorySize" -Type "Unlimited" -ExpectedValue $ConnectivityLogMaxDirectorySize -ActualValue $mbxTransportService.ConnectivityLogMaxDirectorySize -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "ConnectivityLogMaxFileSize" -Type "Unlimited" -ExpectedValue $ConnectivityLogMaxFileSize -ActualValue $mbxTransportService.ConnectivityLogMaxFileSize -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "ConnectivityLogPath" -Type "String" -ExpectedValue $ConnectivityLogPath -ActualValue $mbxTransportService.ConnectivityLogPath -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "ContentConversionTracingEnabled" -Type "Boolean" -ExpectedValue $ContentConversionTracingEnabled -ActualValue $mbxTransportService.ContentConversionTracingEnabled -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "MaxConcurrentMailboxDeliveries" -Type "Int" -ExpectedValue $MaxConcurrentMailboxDeliveries -ActualValue $mbxTransportService.MaxConcurrentMailboxDeliveries -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "MaxConcurrentMailboxSubmissions" -Type "Int" -ExpectedValue $MaxConcurrentMailboxSubmissions -ActualValue $mbxTransportService.MaxConcurrentMailboxSubmissions -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "PipelineTracingEnabled" -Type "Boolean" -ExpectedValue $PipelineTracingEnabled -ActualValue $mbxTransportService.PipelineTracingEnabled -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "PipelineTracingPath" -Type "String" -ExpectedValue $PipelineTracingPath -ActualValue $mbxTransportService.PipelineTracingPath -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "PipelineTracingSenderAddress" -Type "SMTPAddress" -ExpectedValue $PipelineTracingSenderAddress -ActualValue $mbxTransportService.PipelineTracingSenderAddress -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "ReceiveProtocolLogMaxAge" -Type "TimeSpan" -ExpectedValue $ReceiveProtocolLogMaxAge -ActualValue $mbxTransportService.ReceiveProtocolLogMaxAge -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "ReceiveProtocolLogMaxDirectorySize" -Type "Unlimited" -ExpectedValue $ReceiveProtocolLogMaxDirectorySize -ActualValue $mbxTransportService.ReceiveProtocolLogMaxDirectorySize -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "ReceiveProtocolLogMaxFileSize" -Type "Unlimited" -ExpectedValue $ReceiveProtocolLogMaxFileSize -ActualValue $mbxTransportService.ReceiveProtocolLogMaxFileSize -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "ReceiveProtocolLogPath" -Type "String" -ExpectedValue $ReceiveProtocolLogPath -ActualValue $mbxTransportService.ReceiveProtocolLogPath -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "SendProtocolLogMaxAge" -Type "TimeSpan" -ExpectedValue $SendProtocolLogMaxAge -ActualValue $mbxTransportService.SendProtocolLogMaxAge -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "SendProtocolLogMaxDirectorySize" -Type "Unlimited" -ExpectedValue $SendProtocolLogMaxDirectorySize -ActualValue $mbxTransportService.SendProtocolLogMaxDirectorySize -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "SendProtocolLogMaxFileSize" -Type "Unlimited" -ExpectedValue $SendProtocolLogMaxFileSize -ActualValue $mbxTransportService.SendProtocolLogMaxFileSize -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "SendProtocolLogPath" -Type "String" -ExpectedValue $SendProtocolLogPath -ActualValue $mbxTransportService.SendProtocolLogPath -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } } else { return $false } return $true } Export-ModuleMember -Function *-TargetResource |