ExchangeServerMaintenanceMode.psm1
|
# Special thanks to Michael 'Van Hybrid' for the idea and implementation #region Classes add-type @' namespace CPolydorou.Exchange { public class ExchangeServerMaintenanceMode { public string Name; public bool MaintenanceModeEnabled; public bool DatabaseCopyActivationDisabledAndMoveNow; public string DatabaseCopyAutoActivationPolicy; public string HubTransportState; public int ActiveMailboxDatabaseCopies; } } '@ #endregion #region Functions #region StopExchangeServerMaintenanceMode Function Stop-ExchangeServerMaintenanceMode { <# .Synopsis Take an Exchange 2013 server out of maintenance mode. .DESCRIPTION This function will take all the necessary steps to take an Exchange Server 2013 out of maintenance mode. .EXAMPLE Stop-ExchangeServerMaintenanceMode -Server Server1 #> [CmdletBinding( SupportsShouldProcess = $true, ConfirmImpact = "High" )] [OutputType([int])] Param ( # determine what server to put in maintenance mode [Parameter(Mandatory=$false, ValueFromPipelineByPropertyName=$true, Position=0)] [Alias('Name')] [string[]]$Server = $env:COMPUTERNAME, # Controll logging [Parameter(Mandatory = $false)] [switch] $LogActions = $true ) Begin{} Process { foreach($s in $Server) { if($PSCmdlet.ShouldProcess($s)) { $errorCount = 0 # Get the exchange server object Write-Verbose "Searching for exchange server $s" New-Variable discoveredServer -Force try { $discoveredServer = Get-ExchangeServer -Identity $s -ErrorAction Stop | Select IsHubTransportServer,IsFrontendTransportServer,AdminDisplayVersion Write-Verbose "Exchange server $s found." } catch { Write-Error "Could not find exchange server $s" return } #Check for Administrative credentials If ((PermissionsCheck) -ne $true ){ Write-Error "You do not have Administrator rights to run this script!`nPlease re-run this script as an Administrator!" continue } # Check the exchange server version if( (ServerVersionCheck $discoveredServer) -ne $true) { Write-Error "The specified Exchange Server is not an Exchange 2013 or 2016 server!" continue } if($LogActions) { Invoke-Command -ComputerName $s ` -ScriptBlock { # Check if the source exists and create it if(-Not [System.Diagnostics.EventLog]::SourceExists("Microsoft Exchange Server Maintenance Mode")) { [System.Diagnostics.EventLog]::CreateEventSource("Microsoft Exchange Server Maintenance Mode", "Application") } # Write the start on the log Write-EventLog -LogName Application ` -Source "Microsoft Exchange Server Maintenance Mode" ` -EntryType Information ` -EventId 10001 ` -Message "Stopping Exchange server maintenance mode." } } # Enable all server components Write-Verbose "Reactivating all server components..." try { Set-ServerComponentState $s -Component ServerWideOffline -State Active -Requester Maintenance -ErrorAction Stop Write-Verbose "Server component states changed back into active state using requester 'Maintenance'" } catch { Write-Error "Could not set the components." $errorCount++ } # if the server is a mailbox server if($discoveredServer.IsHubTransportServer -eq $true) { $mailboxserver = Get-MailboxServer -Identity $s | Select DatabaseAvailabilityGroup if($mailboxserver.DatabaseAvailabilityGroup -ne $null) { Write-Verbose "Server $s is a member of a Database Availability Group." Write-Verbose "Resuming cluster node." try { $output = Invoke-Command -ComputerName $s -ArgumentList $s {Resume-ClusterNode $args[0]} Write-Verbose ("`tName: " + $output.Name) Write-Verbose ("`tCluster: " + $output.Cluster) Write-Verbose ("`tState: " + $output.State) } catch { Write-Warning "Failed to resume the cluster node." $errorCount++ } try { Set-MailboxServer $s -DatabaseCopyActivationDisabledAndMoveNow $false -ErrorAction Stop Write-Verbose "The DatabaseCopyActivationDisabledAndMoveNow setting is set to False" } catch { Write-Error "Could not set the DatabaseCopyActivationDisabledAndMoveNow setting" $errorCount++ } try { Set-MailboxServer $s -DatabaseCopyAutoActivationPolicy Unrestricted -ErrorAction Stop Write-Verbose "The DatabaseCopyAutoActivationPolicy has been set to Unrestricted." } catch { Write-Error "Could not set the DatabaseCopyAutoActivationPolicy." $errorCount++ } } Write-Verbose "Resuming Transport Service..." try { Set-ServerComponentState –Identity $s -Component HubTransport -State Active -Requester Maintenance -ErrorAction Stop } catch { Write-Warning "Could not activate the HubTransport component." $errorCount++ } Write-Verbose "Restarting the MSExchangeTransport Service on server $s..." try { $output = Invoke-Command -ComputerName $env:COMPUTERNAME {try{ Restart-Service MSExchangeTransport -ErrorAction Stop; return $true}catch{return $false}} if($output) { Write-Verbose "The MSExchangeTransport Service has been restarted on server $s" } else { Write-Warning "Failed to restart the MSExchangeTransport Service on server $s" } } catch { Write-Warning "Could not restart the MSExchangeTransport service on server $s." Write-Warning "Please restart the service manually." $errorCount++ } } #restart FE Transport Services if server is also CAS if($discoveredServer.IsFrontendTransportServer -eq $true) { Write-Verbose "Restarting the MSExchangeFrontEndTransport Service on server $s..." try { $output = Invoke-Command -ComputerName $env:COMPUTERNAME {try{ Restart-Service MSExchangeFrontEndTransport -ErrorAction Stop; return $true}catch{return $false}} if($output) { Write-Verbose "The MSExchangeFrontEndTransport Service has been restarted on server $s" } else { Write-Warning "Failed to restart the MSExchangeFrontEndTransport Service on server $s" } } catch { Write-Error "Could not restart the MSExchangeFrontEndTransport service on server $s." Write-Error "Please restart the service manually." $errorCount++ } } # check for components that are still inactive $components = Get-ServerComponentstate -Identity $s | Where-Object {$_.State -ne "Active"} foreach($component in $components) { $component.LocalStates | Select-Object -Property @{Name = "Identity"; Expression={$component.Identity}}, ` @{Name = "Component"; Expression={$component.Component}}, ` @{Name = "State"; Expression={$_.State}}, ` @{Name="Requester"; Expression={$_.Requester}} } if( $errorCount -gt 0) { Write-Warning "Process completed. Server $s is taken out of Maintenance Mode with warnings." if($LogActions) { Invoke-Command -ComputerName $s ` -ScriptBlock { # Write the end on the log Write-EventLog -LogName Application ` -Source "Microsoft Exchange Server Maintenance Mode" ` -EntryType Error ` -EventId 10003 ` -Message "Failed to stop Exchange server maintenance mode." } } } else { Write-Verbose "Process completed. Server $s is taken out of Maintenance Mode." if($LogActions) { Invoke-Command -ComputerName $s ` -ScriptBlock { # Write the end on the log Write-EventLog -LogName Application ` -Source "Microsoft Exchange Server Maintenance Mode" ` -EntryType Information ` -EventId 10002 ` -Message "Exchange server maintenance mode stopped successfully." } } } } } } End{} } #endregion #region StartExchangeServerMaintenanceMode function Start-ExchangeServerMaintenanceMode { <# .Synopsis Put an Exchange 2013 Server into Maintenance Mode. .DESCRIPTION This function will take all the necessary steps to put an Exchange Server 2013 into maintenance mode. .EXAMPLE Start-ExchangeServerMaintenanceMode -Server Server1 -TargetServerFQDN Server2.domain.com #> [CmdletBinding( SupportsShouldProcess = $true, ConfirmImpact = "high" )] [OutputType([int])] Param ( # determine what server to put in maintenance mode [Parameter(Mandatory=$false, ValueFromPipelineByPropertyName=$true, Position=0)] [Alias('Name')] [string[]]$Server=$env:COMPUTERNAME, [Parameter(Mandatory=$false, ValueFromPipelineByPropertyName=$true, Position=1)] [string]$TargetServer, [Parameter(Mandatory = $false, Position = 2)] [string]$AmbiquousMessageExportPath, [Parameter(Mandatory = $false)] [switch] $ForceQueueDrain = $false, # Controll logging [Parameter(Mandatory = $false)] [switch] $LogActions = $true ) Begin{} Process { foreach($s in $Server) { if($PSCmdlet.ShouldProcess($s)) { $errorCount = 0 New-Variable discoveredServer -Force Write-Verbose "Searching exchange server $s..." try { $discoveredServer = Get-ExchangeServer -Identity $s -ErrorAction Stop | Select IsHubTransportServer,IsFrontendTransportServer,AdminDisplayVersion Write-Verbose "Exchange server found." } catch { Write-Error "Could not find exchange server $s." continue } #Check for Administrative credentials If ((PermissionsCheck) -ne $true ){ Write-Error "You do not have Administrator rights to run this script!`nPlease re-run this script as an Administrator!" Continue } #check if the server is an Exchange 2013 server if((ServerVersionCheck $discoveredServer) -ne $true ){ Write-Error "The specified Exchange Server is not an Exchange 2013 or 2016 server!" continue } else{ if($LogActions) { Invoke-Command -ComputerName $s ` -ScriptBlock { # Create the source if it does not exist if(-Not [System.Diagnostics.EventLog]::SourceExists("Microsoft Exchange Server Maintenance Mode")) { [System.Diagnostics.EventLog]::CreateEventSource("Microsoft Exchange Server Maintenance Mode", "Application") } # Write the start on the log Write-EventLog -LogName Application ` -Source "Microsoft Exchange Server Maintenance Mode" ` -EntryType Information ` -EventId 10004 ` -Message "Starting Exchange server maintenance mode." } } if($discoveredServer.IsHubTransportServer -eq $True){ if(-NOT ($TargetServer)){ Write-Warning "TargetServer is required." $TargetServer = Read-Host -Prompt "Please enter the TargetServer: " } #Get the FQDN of the Target Server through DNS, even if the input is just a host name try { $TargetServerName = ([System.Net.Dns]::GetHostByName($TargetServer)).Hostname } catch { Write-Error "Could not resolve ServerFQDN: $TargetServer" continue } if((Get-ExchangeServer -Identity $TargetServerName | Select IsHubTransportServer).IsHubTransportServer -ne $True) { Write-Error "The target server is not a valid Mailbox server." Continue } # Export ambiquous messages if($AmbiquousMessageExportPath) { # Test if folder exists if( (Test-Path -Path $AmbiquousMessageExportPath) -ne $true) { Write-Error "Could not find the path to export ambiquous messages." } else { Write-Verbose "Exporting ambiguous messages to $AmbiquousMessageExportPath" Export-AmbiguousMessage -Server $s ` -Path $AmbiquousMessageExportPath ` -Confirm:$false ` -Verbose:($PSCmdlet.MyInvocation.BoundParameters["Verbose"].IsPresent -eq $true) } } #Redirecting messages to target system Write-Verbose "Suspending Transport Service. Draining remaining messages..." try { Write-Verbose "Disabling server components using requestor 'Maintenance'..." Set-ServerComponentState $s -Component HubTransport -State Draining -Requester Maintenance -ErrorAction Stop Write-Verbose "Server components disabled." } catch { Write-Warning "Could not disable the server component states." $errorCount++ } try { Write-Verbose "Redirecting messages..." Redirect-Message -Server $s -Target $TargetServerName -Confirm:$false -ErrorAction Stop Write-Verbose "Messages redirected." } catch { Write-Warning "Could not redirect messages." $errorCount++ } #suspending cluster node (if the server is part of a DAG) $mailboxserver = Get-MailboxServer -Identity $s | Select DatabaseAvailabilityGroup if($mailboxserver.DatabaseAvailabilityGroup -ne $null){ Write-Verbose "Server $s is a member of a Database Availability Group." Write-Verbose "Suspending the node now." try { Write-Verbose "Suspending cluster node..." $output = Invoke-Command -ComputerName $s -ArgumentList $s {Suspend-ClusterNode $args[0]} -ErrorAction Stop Write-Verbose ("`tName: " + $output.Name) Write-Verbose ("`tCluster: " + $output.Cluster) Write-Verbose ("`tState: " + $output.State) Write-Verbose "Node suspended." } catch { Write-Verbose "Could not suspend the node." $errorCount++ } try { Write-Verbose "Setting DatabaseCopyActivationDisabledAndMoveNow..." Set-MailboxServer $s -DatabaseCopyActivationDisabledAndMoveNow $true -ErrorAction Stop Write-Verbose "DatabaseCopyActivationDisabledAndMoveNow is now set to True." } catch { Write-Warning "Could not set the DatabaseCopyActivationDisabledAndMoveNow." $errorCount++ } try { Write-Verbose "Setting DatabaseCopyAutoActivationPolicy..." Set-MailboxServer $s -DatabaseCopyAutoActivationPolicy Blocked -ErrorAction Stop Write-Verbose "DatabaseCopyAutoActivationPolicy is now set to Blocked." } catch { Write-Warning "Could not set the DatabaseCopyAutoActivationPolicy." $errorCount++ } } #Evaluate the Transport Queues and put into maintenance mode once all queues are empty evaluatequeues -Server $s Write-Verbose "The transport queues are empty." Write-Verbose "Putting the entire server into maintenance mode..." if(Set-ServerComponentState $s -Component ServerWideOffline -State Inactive -Requester Maintenance) { Write-Verbose "The components of $s have successfully been placed into an inactive state!" } Write-Verbose "Restarting MSExchangeTransport service on server $s..." #Restarting transport services based on info from http://blogs.technet.com/b/exchange/archive/2013/09/26/server-component-states-in-exchange-2013.aspx #Restarting the services will cause the transport services to immediately pick up the changed state rather than having to wait for a MA responder to take action try { $output = Invoke-Command -ComputerName $env:COMPUTERNAME {try{ Restart-Service MSExchangeTransport -ErrorAction Stop; return $true}catch{return $false}} if($output) { Write-Verbose "The MSExchangeTransport Service has been restarted on server $s" } else { Write-Warning "Failed to restart the MSExchangeTransport Service on server $s" } } catch { Write-Warning "Cound not restart the MSExchangeTransport service on server $s." } #restart FE Transport Services if server is also CAS if($discoveredServer.IsFrontendTransportServer -eq $true) { Write-Verbose "Restarting the MSExchangeFrontEndTransport Service on server $s..." try { $output = Invoke-Command -ComputerName $env:COMPUTERNAME {try{ Restart-Service MSExchangeFrontEndTransport -ErrorAction Stop; return $true}catch{return $false}} if($output) { Write-Verbose "The MSExchangeFrontEndTransport Service has been restarted on server $s" } else { Write-Warning "Failed to restart the MSExchangeFrontEndTransport Service on server $s" } } catch { Write-Warning "Could not restart the MSExchangeFrontEndTransport service on server $s." } } Write-Verbose "Done! Server $s is put succesfully into maintenance mode!" } else { Write-Vebose "Server $s is a Client Access Server-only server." Write-Verbose "Putting the server components into inactive state" try { Set-ServerComponentState $s -Component ServerWideOffline -State Inactive -Requester Maintenance -ErrorAction Stop } catch { Write-Warning "Could not set the server components." $errorCount++ } Write-Verbose "Restarting transport services..." try { $output = Invoke-Command -ComputerName $env:COMPUTERNAME {try{ Restart-Service MSExchangeFrontEndTransport -ErrorAction Stop; return $true}catch{return $false}} if($output) { Write-Verbose "The MSExchangeFrontEndTransport Service has been restarted on server $s" } else { Write-Warning "Failed to restart the MSExchangeFrontEndTransport Service on server $s" } } catch { Write-Warning "Failed to restart MSExchangeFrontEndTransport service" } } if($errorCount -gt 0) { Write-Verbose "Process completed with errors. Server $s is now maintenance mode!" if($LogActions) { Invoke-Command -ComputerName $s ` -ScriptBlock { # Write the end on the log Write-EventLog -LogName Application ` -Source "Microsoft Exchange Server Maintenance Mode" ` -EntryType Error ` -EventId 10005 ` -Message "Failed to start Exchange server maintenance mode." } } } else { Write-Warning "Process completed. Server $s in now in maintenance mode." if($LogActions) { Invoke-Command -ComputerName $s ` -ScriptBlock { # Write the start on the log Write-EventLog -LogName Application ` -Source "Microsoft Exchange Server Maintenance Mode" ` -EntryType Information ` -EventId 10006 ` -Message "Exchange server maintenance mode started successfully." } } } } } } } End{} } #endregion #region Get-ExchangeServerMaintenanceMode Function Get-ExchangeServerMaintenanceMode { <# .SYNOPSIS Check if an exchange server is in maintenance mode. .DESCRIPTION The Get-ExchangeServerMaintenanceMode cmdlet checks if an Exchange 2013 server is in maintenance mode. .PARAMETER Server The name of the server to check .EXAMPLE Get-ExchangeServerMaintenanceMode -Server Exchange1 This command will check if the exchange server Exchange1 is in maintenance mode .EXAMPLE Get-MailboxServer | Get-ExchangeServerMaintenanceMode #> [CmdletBinding()] Param ( [parameter(Mandatory=$false, Position=0, ValueFromPipeline=$true)] [Alias("Name","ComputerName")] [string[]]$Server = $env:COMPUTERNAME ) Begin{} Process { foreach($s in $Server) { #region Get Exchange Server New-Variable discoveredServer -Force Write-Verbose "Searching exchange server $s..." try { $discoveredServer = Get-ExchangeServer -Identity $s | Select IsHubTransportServer,IsFrontendTransportServer,AdminDisplayVersion Write-Verbose "Exchange server found." } catch { Write-Error "Could not find exchange server $s." continue } #endregion #region Check Exchange Server Version if((ServerVersionCheck $discoveredServer) -ne $true) { Write-Error "The specified Exchange Server is not an Exchange 2013 or 2016 server!" continue } #endregion #region Get the status of the server $mailboxserver = Get-MailboxServer $s $componentstate = Get-ServerComponentState $s -Component ServerWideOffline $mailboxdatabases = Get-MailboxDatabaseCopyStatus -Server $s | Where-Object {$_.status -eq "Mounted"} #endregion #region Create the custom object $obj = New-Object -TypeName CPolydorou.Exchange.ExchangeServerMaintenanceMode $obj.Name = $s if( $mailboxserver.DatabaseCopyActivationDisabledAndMoveNow -eq $true -and $mailboxserver.DatabaseCopyAutoActivationPolicy -eq "Blocked" -and $mailboxdatabases.Count -eq 0 -and $componentstate.State -eq "Inactive" ) { $obj.MaintenanceModeEnabled = $true } else { $obj.MaintenanceModeEnabled = $false } $obj.DatabaseCopyActivationDisabledAndMoveNow = $mailboxserver.DatabaseCopyActivationDisabledAndMoveNow $obj.DatabaseCopyAutoActivationPolicy = $mailboxserver.DatabaseCopyAutoActivationPolicy $obj.HubTransportState = $componentstate.State $obj.ActiveMailboxDatabaseCopies = $mailboxdatabases.Count $obj #endregion } } End{} } #endregion #endregion #region Utility Functions #region ServerVersionCheck function ServerVersionCheck { # Check the version of an Exchange Server Param ( $Server ) # Check the exchange server version if($Server.AdminDisplayVersion.Major -lt "15" -and $Server.AdminDisplayVersion.Major -gt "16") { return $false } else { return $true } } #endregion #region PermissionsCheck Function PermissionsCheck { #Check if the current user has administrator permissions return ([Security.Principal.WindowsPrincipal] [Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole([Security.Principal.WindowsBuiltInRole] "Administrator") } #endregion #region evaluateQueues function evaluatequeues { # Check the queues of a server for messages pending delivery Param ( [string]$Server ) # Queue check counter $checks = 0 do { #region Get the messages in queues try { $MessageCount = Get-Queue -Server $Server -ErrorAction Stop | Where-Object {$_.Identity -notlike "*\Poison" -and $_.Identity -notlike"*\Shadow\*"} | Measure-Object -Property MessageCount -Sum } catch { Write-Warning "Could not check the queues on server $Server." } #endregion #region Chceck the message count if($MessageCount.Sum -ne 0) { Write-Warning "The transport queues are not empty. Sleeping for 30 seconds before checking again..." Start-Sleep -s 30 } else { break } #endregion #region Force restart of transport service #increase the check counter $checks++ if($ForceQueueDrain) { if($checks -gt 0) { # Reset the counter $checks = 0 # Restart the transport service Write-Warning "Restarting MSExchangeTransport service to force drain the queues." Invoke-Command -ComputerName $Server ` -ScriptBlock { Restart-Service MSExchangeTransport -Force -Confirm:$false } } } #endregion } While($MessageCount.Sum -gt 0) } #endregion #endregion #region Exports Export-ModuleMember -Function Start-ExchangeServerMaintenanceMode Export-ModuleMember -Function Stop-ExchangeServerMaintenanceMode Export-ModuleMember -Function Get-ExchangeServerMaintenanceMode #endregion |