DSCResources/MSFT_xExchMailboxDatabase/MSFT_xExchMailboxDatabase.psm1
|
function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [parameter(Mandatory = $true)] [System.String] $Name, [parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] $Credential, [parameter(Mandatory = $true)] [System.UInt32] $DatabaseCopyCount, [parameter(Mandatory = $true)] [System.String] $EdbFilePath, [parameter(Mandatory = $true)] [System.String] $LogFolderPath, [parameter(Mandatory = $true)] [System.String] $Server, [System.Boolean] $AllowServiceRestart = $false, [System.Boolean] $AutoDagExcludeFromMonitoring, [System.Boolean] $BackgroundDatabaseMaintenance, [System.String] $CalendarLoggingQuota, [System.Boolean] $CircularLoggingEnabled, [ValidateSet("None","SecondCopy","SecondDatacenter","AllDatacenters","AllCopies")] [System.String] $DataMoveReplicationConstraint, [System.String] $DeletedItemRetention, [System.String] $DomainController, [System.String] $EventHistoryRetentionPeriod, [System.Boolean] $IndexEnabled, [System.Boolean] $IsExcludedFromProvisioning, [System.String] $IssueWarningQuota, [System.Boolean] $IsSuspendedFromProvisioning, [System.String] $JournalRecipient, [System.String] $MailboxRetention, [System.Boolean] $MountAtStartup, [System.String] $OfflineAddressBook, [System.String] $ProhibitSendQuota, [System.String] $ProhibitSendReceiveQuota, [System.String] $RecoverableItemsQuota, [System.String] $RecoverableItemsWarningQuota, [System.Boolean] $RetainDeletedItemsUntilBackup ) #Load helper module Import-Module "$((Get-Item -LiteralPath "$($PSScriptRoot)").Parent.Parent.FullName)\Misc\xExchangeCommon.psm1" -Verbose:0 LogFunctionEntry -Parameters @{"Name" = $Name} -VerbosePreference $VerbosePreference #Establish remote Powershell session GetRemoteExchangeSession -Credential $Credential -CommandsToLoad "Get-MailboxDatabase" -VerbosePreference $VerbosePreference $db = GetMailboxDatabase @PSBoundParameters if ($db -ne $null) { $returnValue = @{ Name = $Name Server = $Server EdbFilePath = $EdbFilePath LogFolderPath = $LogFolderPath DatabaseCopyCount = $DatabaseCopyCount AutoDagExcludeFromMonitoring = $db.AutoDagExcludeFromMonitoring BackgroundDatabaseMaintenance = $db.BackgroundDatabaseMaintenance CalendarLoggingQuota = $db.CalendarLoggingQuota CircularLoggingEnabled = $db.CircularLoggingEnabled DataMoveReplicationConstraint = $db.DataMoveReplicationConstraint DeletedItemRetention = $db.DeletedItemRetention EventHistoryRetentionPeriod = $db.EventHistoryRetentionPeriod IndexEnabled = $db.IndexEnabled IsExcludedFromProvisioning = $db.IsExcludedFromProvisioning IssueWarningQuota = $db.IssueWarningQuota IsSuspendedFromProvisioning = $db.IsSuspendedFromProvisioning JournalRecipient = $db.JournalRecipient MailboxRetention = $db.MailboxRetention MountAtStartup = $db.MountAtStartup OfflineAddressBook = $db.OfflineAddressBook ProhibitSendQuota = $db.ProhibitSendQuota ProhibitSendReceiveQuota = $db.ProhibitSendReceiveQuota RecoverableItemsQuota = $db.RecoverableItemsQuota RecoverableItemsWarningQuota = $db.RecoverableItemsWarningQuota RetainDeletedItemsUntilBackup = $db.RetainDeletedItemsUntilBackup } } $returnValue } function Set-TargetResource { [CmdletBinding()] param ( [parameter(Mandatory = $true)] [System.String] $Name, [parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] $Credential, [parameter(Mandatory = $true)] [System.UInt32] $DatabaseCopyCount, [parameter(Mandatory = $true)] [System.String] $EdbFilePath, [parameter(Mandatory = $true)] [System.String] $LogFolderPath, [parameter(Mandatory = $true)] [System.String] $Server, [System.Boolean] $AllowServiceRestart = $false, [System.Boolean] $AutoDagExcludeFromMonitoring, [System.Boolean] $BackgroundDatabaseMaintenance, [System.String] $CalendarLoggingQuota, [System.Boolean] $CircularLoggingEnabled, [ValidateSet("None","SecondCopy","SecondDatacenter","AllDatacenters","AllCopies")] [System.String] $DataMoveReplicationConstraint, [System.String] $DeletedItemRetention, [System.String] $DomainController, [System.String] $EventHistoryRetentionPeriod, [System.Boolean] $IndexEnabled, [System.Boolean] $IsExcludedFromProvisioning, [System.String] $IssueWarningQuota, [System.Boolean] $IsSuspendedFromProvisioning, [System.String] $JournalRecipient, [System.String] $MailboxRetention, [System.Boolean] $MountAtStartup, [System.String] $OfflineAddressBook, [System.String] $ProhibitSendQuota, [System.String] $ProhibitSendReceiveQuota, [System.String] $RecoverableItemsQuota, [System.String] $RecoverableItemsWarningQuota, [System.Boolean] $RetainDeletedItemsUntilBackup ) #Load helper module Import-Module "$((Get-Item -LiteralPath "$($PSScriptRoot)").Parent.Parent.FullName)\Misc\xExchangeCommon.psm1" -Verbose:0 LogFunctionEntry -Parameters @{"Name" = $Name} -VerbosePreference $VerbosePreference #Establish remote Powershell session GetRemoteExchangeSession -Credential $Credential -CommandsToLoad "*MailboxDatabase","Move-DatabasePath","Mount-Database" -VerbosePreference $VerbosePreference $db = GetMailboxDatabase @PSBoundParameters if ($db -eq $null) #Need to create a new DB { #Create a copy of the original parameters $originalPSBoundParameters = @{} + $PSBoundParameters RemoveParameters -PSBoundParametersIn $PSBoundParameters -ParamsToKeep "Name","Server","EdbFilePath","LogFolderPath","DomainController" #Create the database $db = New-MailboxDatabase @PSBoundParameters if ($db -ne $null) { #Add original props back AddParameters -PSBoundParametersIn $PSBoundParameters -ParamsToAdd $originalPSBoundParameters if ($AllowServiceRestart -eq $true) { Write-Verbose "Restarting Information Store" Restart-Service MSExchangeIS } else { Write-Warning "The configuration will not take effect until MSExchangeIS is manually restarted." } #Mount the DB if the service restart didn't take care of it already MountDatabase @PSBoundParameters } else { throw "Failed to create new Mailbox Database" } } if ($db -ne $null) #Set props on existing DB { #First check if a DB or log move is required if (($PSBoundParameters.ContainsKey("EdbFilePath") -and (CompareStrings -String1 $db.EdbFilePath.PathName -String2 $EdbFilePath -IgnoreCase) -eq $false) -or ($PSBoundParameters.ContainsKey("LogFolderPath") -and (CompareStrings -String1 $db.LogFolderPath.PathName -String2 $LogFolderPath -IgnoreCase) -eq $false)) { if ($db.DatabaseCopies.Count -le 1) { Write-Verbose "Moving database and/or log path" MoveDatabaseOrLogPath @PSBoundParameters } else { Write-Error "Database must have only a single copy for the DB path or log path to be moved" } } #setup params AddParameters -PSBoundParametersIn $PSBoundParameters -ParamsToAdd @{"Identity" = $Name} RemoveParameters -PSBoundParametersIn $PSBoundParameters -ParamsToRemove "Name","Server","DatabaseCopyCount","AllowServiceRestart","EdbFilePath","LogFolderPath","Credential" #Remove parameters that depend on all copies being added if ($db.DatabaseCopies.Count -lt $DatabaseCopyCount) { RemoveParameters -PSBoundParametersIn $PSBoundParameters -ParamsToRemove "CircularLoggingEnabled","DataMoveReplicationConstraint" } Set-MailboxDatabase @PSBoundParameters } } function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [parameter(Mandatory = $true)] [System.String] $Name, [parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] $Credential, [parameter(Mandatory = $true)] [System.UInt32] $DatabaseCopyCount, [parameter(Mandatory = $true)] [System.String] $EdbFilePath, [parameter(Mandatory = $true)] [System.String] $LogFolderPath, [parameter(Mandatory = $true)] [System.String] $Server, [System.Boolean] $AllowServiceRestart = $false, [System.Boolean] $AutoDagExcludeFromMonitoring, [System.Boolean] $BackgroundDatabaseMaintenance, [System.String] $CalendarLoggingQuota, [System.Boolean] $CircularLoggingEnabled, [ValidateSet("None","SecondCopy","SecondDatacenter","AllDatacenters","AllCopies")] [System.String] $DataMoveReplicationConstraint, [System.String] $DeletedItemRetention, [System.String] $DomainController, [System.String] $EventHistoryRetentionPeriod, [System.Boolean] $IndexEnabled, [System.Boolean] $IsExcludedFromProvisioning, [System.String] $IssueWarningQuota, [System.Boolean] $IsSuspendedFromProvisioning, [System.String] $JournalRecipient, [System.String] $MailboxRetention, [System.Boolean] $MountAtStartup, [System.String] $OfflineAddressBook, [System.String] $ProhibitSendQuota, [System.String] $ProhibitSendReceiveQuota, [System.String] $RecoverableItemsQuota, [System.String] $RecoverableItemsWarningQuota, [System.Boolean] $RetainDeletedItemsUntilBackup ) #Load helper module Import-Module "$((Get-Item -LiteralPath "$($PSScriptRoot)").Parent.Parent.FullName)\Misc\xExchangeCommon.psm1" -Verbose:0 LogFunctionEntry -Parameters @{"Name" = $Name} -VerbosePreference $VerbosePreference #Establish remote Powershell session GetRemoteExchangeSession -Credential $Credential -CommandsToLoad "Get-MailboxDatabase","Get-Mailbox" -VerbosePreference $VerbosePreference $db = GetMailboxDatabase @PSBoundParameters if ($db -eq $null) { return $false } else { if (!(VerifySetting -Name "AutoDagExcludeFromMonitoring" -Type "Boolean" -ExpectedValue $AutoDagExcludeFromMonitoring -ActualValue $db.AutoDagExcludeFromMonitoring -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "BackgroundDatabaseMaintenance" -Type "Boolean" -ExpectedValue $BackgroundDatabaseMaintenance -ActualValue $db.BackgroundDatabaseMaintenance -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "CalendarLoggingQuota" -Type "Unlimited" -ExpectedValue $CalendarLoggingQuota -ActualValue $db.CalendarLoggingQuota -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } #Only check these if all copies have been added if ($db.DatabaseCopies.Count -ge $DatabaseCopyCount) { if (!(VerifySetting -Name "CircularLoggingEnabled" -Type "Boolean" -ExpectedValue $CircularLoggingEnabled -ActualValue $db.CircularLoggingEnabled -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "DataMoveReplicationConstraint" -Type "Boolean" -ExpectedValue $DataMoveReplicationConstraint -ActualValue $db.DataMoveReplicationConstraint -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } } if (!(VerifySetting -Name "DeletedItemRetention" -Type "Timespan" -ExpectedValue $DeletedItemRetention -ActualValue $db.DeletedItemRetention -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "EventHistoryRetentionPeriod" -Type "Timespan" -ExpectedValue $EventHistoryRetentionPeriod -ActualValue $db.EventHistoryRetentionPeriod -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "IndexEnabled" -Type "Boolean" -ExpectedValue $IndexEnabled -ActualValue $db.IndexEnabled -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "IsExcludedFromProvisioning" -Type "Boolean" -ExpectedValue $IsExcludedFromProvisioning -ActualValue $db.IsExcludedFromProvisioning -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "IssueWarningQuota" -Type "Unlimited" -ExpectedValue $IssueWarningQuota -ActualValue $db.IssueWarningQuota -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "IsSuspendedFromProvisioning" -Type "Boolean" -ExpectedValue $IsSuspendedFromProvisioning -ActualValue $db.IsSuspendedFromProvisioning -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "JournalRecipient" -Type "ADObjectID" -ExpectedValue $JournalRecipient -ActualValue $db.JournalRecipient -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "MailboxRetention" -Type "Timespan" -ExpectedValue $MailboxRetention -ActualValue $db.MailboxRetention -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "MountAtStartup" -Type "Boolean" -ExpectedValue $MountAtStartup -ActualValue $db.MountAtStartup -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "OfflineAddressBook" -Type "String" -ExpectedValue $OfflineAddressBook -ActualValue $db.OfflineAddressBook.Name -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "ProhibitSendQuota" -Type "Unlimited" -ExpectedValue $ProhibitSendQuota -ActualValue $db.ProhibitSendQuota -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "ProhibitSendReceiveQuota" -Type "Unlimited" -ExpectedValue $ProhibitSendReceiveQuota -ActualValue $db.ProhibitSendReceiveQuota -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "RecoverableItemsQuota" -Type "Unlimited" -ExpectedValue $RecoverableItemsQuota -ActualValue $db.RecoverableItemsQuota -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "RecoverableItemsWarningQuota" -Type "Unlimited" -ExpectedValue $RecoverableItemsWarningQuota -ActualValue $db.RecoverableItemsWarningQuota -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } if (!(VerifySetting -Name "RetainDeletedItemsUntilBackup" -Type "Boolean" -ExpectedValue $RetainDeletedItemsUntilBackup -ActualValue $db.RetainDeletedItemsUntilBackup -PSBoundParametersIn $PSBoundParameters -VerbosePreference $VerbosePreference)) { return $false } } return $true } #Runs Get-MailboxDatabase, only specifying Identity and optionally DomainController function GetMailboxDatabase { [CmdletBinding()] param ( [parameter(Mandatory = $true)] [System.String] $Name, [parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] $Credential, [parameter(Mandatory = $true)] [System.UInt32] $DatabaseCopyCount, [parameter(Mandatory = $true)] [System.String] $EdbFilePath, [parameter(Mandatory = $true)] [System.String] $LogFolderPath, [parameter(Mandatory = $true)] [System.String] $Server, [System.Boolean] $AllowServiceRestart = $false, [System.Boolean] $AutoDagExcludeFromMonitoring, [System.Boolean] $BackgroundDatabaseMaintenance, [System.String] $CalendarLoggingQuota, [System.Boolean] $CircularLoggingEnabled, [ValidateSet("None","SecondCopy","SecondDatacenter","AllDatacenters","AllCopies")] [System.String] $DataMoveReplicationConstraint, [System.String] $DeletedItemRetention, [System.String] $DomainController, [System.String] $EventHistoryRetentionPeriod, [System.Boolean] $IndexEnabled, [System.Boolean] $IsExcludedFromProvisioning, [System.String] $IssueWarningQuota, [System.Boolean] $IsSuspendedFromProvisioning, [System.String] $JournalRecipient, [System.String] $MailboxRetention, [System.Boolean] $MountAtStartup, [System.String] $OfflineAddressBook, [System.String] $ProhibitSendQuota, [System.String] $ProhibitSendReceiveQuota, [System.String] $RecoverableItemsQuota, [System.String] $RecoverableItemsWarningQuota, [System.Boolean] $RetainDeletedItemsUntilBackup ) AddParameters -PSBoundParametersIn $PSBoundParameters -ParamsToAdd @{"Identity" = $Name} RemoveParameters -PSBoundParametersIn $PSBoundParameters -ParamsToKeep "Identity","DomainController" return (Get-MailboxDatabase @PSBoundParameters -ErrorAction SilentlyContinue) } #Moves the database or log path. Doesn't validate that the DB is in a good condition to move. Caller should do that. function MoveDatabaseOrLogPath { [CmdletBinding()] param ( [parameter(Mandatory = $true)] [System.String] $Name, [parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] $Credential, [parameter(Mandatory = $true)] [System.UInt32] $DatabaseCopyCount, [parameter(Mandatory = $true)] [System.String] $EdbFilePath, [parameter(Mandatory = $true)] [System.String] $LogFolderPath, [parameter(Mandatory = $true)] [System.String] $Server, [System.Boolean] $AllowServiceRestart = $false, [System.Boolean] $AutoDagExcludeFromMonitoring, [System.Boolean] $BackgroundDatabaseMaintenance, [System.String] $CalendarLoggingQuota, [System.Boolean] $CircularLoggingEnabled, [ValidateSet("None","SecondCopy","SecondDatacenter","AllDatacenters","AllCopies")] [System.String] $DataMoveReplicationConstraint, [System.String] $DeletedItemRetention, [System.String] $DomainController, [System.String] $EventHistoryRetentionPeriod, [System.Boolean] $IndexEnabled, [System.Boolean] $IsExcludedFromProvisioning, [System.String] $IssueWarningQuota, [System.Boolean] $IsSuspendedFromProvisioning, [System.String] $JournalRecipient, [System.String] $MailboxRetention, [System.Boolean] $MountAtStartup, [System.String] $OfflineAddressBook, [System.String] $ProhibitSendQuota, [System.String] $ProhibitSendReceiveQuota, [System.String] $RecoverableItemsQuota, [System.String] $RecoverableItemsWarningQuota, [System.Boolean] $RetainDeletedItemsUntilBackup ) AddParameters -PSBoundParametersIn $PSBoundParameters -ParamsToAdd @{"Identity" = $Name} RemoveParameters -PSBoundParametersIn $PSBoundParameters -ParamsToKeep "Identity","DomainController","EdbFilePath","LogFolderPath" Move-DatabasePath @PSBoundParameters -Confirm:$false -Force } #Mounts the specified database function MountDatabase { [CmdletBinding()] param ( [parameter(Mandatory = $true)] [System.String] $Name, [parameter(Mandatory = $true)] [System.Management.Automation.PSCredential] $Credential, [parameter(Mandatory = $true)] [System.UInt32] $DatabaseCopyCount, [parameter(Mandatory = $true)] [System.String] $EdbFilePath, [parameter(Mandatory = $true)] [System.String] $LogFolderPath, [parameter(Mandatory = $true)] [System.String] $Server, [System.Boolean] $AllowServiceRestart = $false, [System.Boolean] $AutoDagExcludeFromMonitoring, [System.Boolean] $BackgroundDatabaseMaintenance, [System.String] $CalendarLoggingQuota, [System.Boolean] $CircularLoggingEnabled, [ValidateSet("None","SecondCopy","SecondDatacenter","AllDatacenters","AllCopies")] [System.String] $DataMoveReplicationConstraint, [System.String] $DeletedItemRetention, [System.String] $DomainController, [System.String] $EventHistoryRetentionPeriod, [System.Boolean] $IndexEnabled, [System.Boolean] $IsExcludedFromProvisioning, [System.String] $IssueWarningQuota, [System.Boolean] $IsSuspendedFromProvisioning, [System.String] $JournalRecipient, [System.String] $MailboxRetention, [System.Boolean] $MountAtStartup, [System.String] $OfflineAddressBook, [System.String] $ProhibitSendQuota, [System.String] $ProhibitSendReceiveQuota, [System.String] $RecoverableItemsQuota, [System.String] $RecoverableItemsWarningQuota, [System.Boolean] $RetainDeletedItemsUntilBackup ) AddParameters -PSBoundParametersIn $PSBoundParameters -ParamsToAdd @{"Identity" = $Name} RemoveParameters -PSBoundParametersIn $PSBoundParameters -ParamsToKeep "Identity","DomainController" Mount-Database @PSBoundParameters } Export-ModuleMember -Function *-TargetResource |