ExchangeServerMaintenanceMode.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
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
# 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