This repository has been archived by the owner on Dec 6, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathLitigationHold-UI.ps1
1689 lines (1180 loc) · 76 KB
/
LitigationHold-UI.ps1
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
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Author: Eyal Doron
# Version: 1.1.1
# Last Modified Date: 24/10/2019
# Last Modified By: [email protected]
# TODO : Fix exchange connection module. I use my own.
#------------------------------------------------------------------------------
# PowerShell Functions
#------------------------------------------------------------------------------
Function Write-ToLOGFfile()
{
param( $LOGFileEntry )
"$LOGFileEntry" | Out-File $LOGFilePath -Append
}
function checkConnection ()
{
$a = Get-PSSession
if ($a.ConfigurationName -ne "Microsoft.Exchange")
{
write-host 'You are not connected to Exchange Online PowerShell ;-( '
write-host 'Please connect using the Menu option 1) Login to Office 365 + Exchange Online using Remote PowerShell '
#Read-Host "Press Enter to continue..."
Add-Type -AssemblyName System.Windows.Forms
[System.Windows.Forms.MessageBox]::Show("You are not connected to Exchange Online PowerShell ;-( `nSelect menu 1 to connect `nPress OK to continue...", "o365info.com PowerShell script", [System.Windows.Forms.MessageBoxButtons]::OK, [System.Windows.Forms.MessageBoxIcon]::Warning)
Clear-Host
break
}
}
Function DisconnectExchangeOnline ()
{
Get-PSSession | Where-Object {$_.ConfigurationName -eq "Microsoft.Exchange"} | Remove-PSSession
}
Function Set-AlternatingRows {
<#
#>
[CmdletBinding()]
Param(
[Parameter(Mandatory=$True,ValueFromPipeline=$True)]
[string]$Line,
[Parameter(Mandatory=$True)]
[string]$CSSEvenClass,
[Parameter(Mandatory=$True)]
[string]$CSSOddClass
)
Begin {
$ClassName = $CSSEvenClass
}
Process {
If ($Line.Contains("<tr>"))
{ $Line = $Line.Replace("<tr>","<tr class=""$ClassName"">")
If ($ClassName -eq $CSSEvenClass)
{ $ClassName = $CSSOddClass
}
Else
{ $ClassName = $CSSEvenClass
}
}
Return $Line
}
}
#------------------------------------------------------------------------------
# Genral
#------------------------------------------------------------------------------
$FormatEnumerationLimit = -1
$Date = Get-Date
$Datef = Get-Date -Format "\Da\te dd-MM-yyyy \Ti\me H-mm"
#------------------------------------------------------------------------------
$lineH = "+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++"
$lineH1 = "+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++"
$line = "--------------------------------------------------------------------------------------------------"
$line1 = "-------------------------------------------------------------------------------------------------------------------------------------"
#------------------------------------------------------------------------------
# PowerShell console window Style
#------------------------------------------------------------------------------
$pshost = get-host
$pswindow = $pshost.ui.rawui
$newsize = $pswindow.buffersize
if($newsize.height){
$newsize.height = 3000
$newsize.width = 150
$pswindow.buffersize = $newsize
}
$newsize = $pswindow.windowsize
if($newsize.height){
$newsize.height = 50
$newsize.width = 150
$pswindow.windowsize = $newsize
}
#------------------------------------------------------------------------------
# HTML Style start
#------------------------------------------------------------------------------
$Header = @"
<style>
Body{font-family:segoe ui,arial;color:black; }
H1 {font-size: 26px; font-weight:bold;width: 70% text-transform: uppercase; color: #0000A0; background:#2F5496 ; color: #ffffff; padding: 10px 10px 10px 10px ; border: 3px solid #00B0F0;}
H2{ background:#F2F2F2 ; padding: 10px 10px 10px 10px ; color: #013366; margin-top:35px;margin-bottom:25px;font-size: 22px;padding:5px 15px 5px 10px; }
.TextStyle {font-size: 26px; font-weight:bold ; color:black; }
TABLE {border-width: 1px;border-style: solid;border-color: black;border-collapse: collapse;}
TH {border-width: 1px;padding: 5px;border-style: solid;border-color: #d1d3d4;background-color:#0072c6 ;color:white;}
TD {border-width: 1px;padding: 3px;border-style: solid;border-color: black;}
.odd { background-color:#ffffff; }
.even { background-color:#dddddd; }
.o365info {height: 90px;padding-top:5px;padding-bottom:5px;margin-top:20px;margin-bottom:20px;border-top: 3px dashed #002060;border-bottom: 3px dashed #002060;background: #00CCFF;font-size: 120%;font-weight:bold;background:#00CCFF url(http://o365info.com/wp-content/files/PowerShell-Images/o365info120.png) no-repeat 680px -5px;
}
</style>
"@
$EndReport = "<div class=o365info> This report was created by using <a href= http://o365info.com target=_blank>o365info.com</a> PowerShell script </div>"
#-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------
#+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
# Exchange Online | Manage Litigation Hold - PowerShell - Script menu
#+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
$Loop = $true
While ($Loop)
{
write-host
write-host +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
write-host "Exchange Online | Manage Litigation Hold - PowerShell - Script menu"
write-host +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
write-host
write-host -ForegroundColor white '----------------------------------------------------------------------------------------------'
write-host -ForegroundColor white -BackgroundColor DarkCyan 'Connect Exchange Online using Remote PowerShell '
write-host -ForegroundColor white '----------------------------------------------------------------------------------------------'
write-host -ForegroundColor Yellow ' 1) Login to Exchange Online using Remote PowerShell '
write-host
write-host -ForegroundColor green '----------------------------------------------------------------------------------------------'
write-host -ForegroundColor white -BackgroundColor Blue 'SECTION A: Assign Litigation Hold to Mailbox '
write-host -ForegroundColor green '----------------------------------------------------------------------------------------------'
write-host ' 2) Assign Litigation Hold | Single Mailbox '
write-host ' 3) Assign Litigation Hold + define time range | Single Mailbox '
write-host -ForegroundColor green '----------------------------------------------------------------------------------------------'
write-host ' 4) Assign Litigation Hold | ALL USER Mailboxes witout Litigation Hold (BULK mode) '
write-host ' 5) Assign Litigation Hold based on a Property (Department) | ALL USER Mailboxes (BULK mode) '
write-host ' 6) Assign Litigation ALL USER Mailboxes that dont have Litigation Hold |(BULK mode) '
write-host -ForegroundColor green '----------------------------------------------------------------------------------------------'
write-host -ForegroundColor white -BackgroundColor DarkGreen 'SECTION B: Display + Export information about Litigation Hold '
write-host -ForegroundColor green '----------------------------------------------------------------------------------------------'
write-host ' 7) Display information about Litigation Hold | Single Mailbox '
write-host ' 8) Export information about Litigation Hold | ALL USER Mailboxes '
write-host ' 9) Export information about Litigation Hold | USERS Mailboxes which have a Litigation Hold enabled '
write-host ' 10) Export information about Litigation Hold | USERS Mailboxes Mailboxes witout Litigation Hold '
write-host -ForegroundColor green '----------------------------------------------------------------------------------------------'
write-host ' 11) Export information about Litigation Hold | Information about the recoverable items folder '
write-host -ForegroundColor green '----------------------------------------------------------------------------------------------'
write-host -ForegroundColor white -BackgroundColor DarkRed 'SECTION C: Remove Litigation Hold '
write-host -ForegroundColor green '----------------------------------------------------------------------------------------------'
write-host ' 12) Remove (Disable) Litigation Hold | Single Mailbox '
write-host ' 13) Remove (Disable) Litigation Hold based on a criterion (Department) | ALL USER Mailboxes (Bulk mode) '
write-host ' 14) Remove (Disable) Litigation Hold | ALL USER Mailboxes WITH Litigation Hold enabled (BULK mode) '
write-host -ForegroundColor green '----------------------------------------------------------------------------------------------'
write-host -ForegroundColor white -BackgroundColor DarkCyan 'End of PowerShell - Script menu '
write-host -ForegroundColor green '----------------------------------------------------------------------------------------------'
write-host -ForegroundColor Yellow "20) Disconnect PowerShell session"
write-host
write-host -ForegroundColor Yellow "21) Exit (Or use the keyboard combination - CTRL + C)"
write-host
$opt = Read-Host "Select an option [1-21]"
write-host $opt
switch ($opt)
{
1
{
#####################################################################
# Connect Exchange Online using Remote PowerShell
#####################################################################
# == Section: General information ===
clear-host
write-host
write-host
write-host -ForegroundColor Magenta oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
write-host -ForegroundColor white Information
write-host -ForegroundColor white ------------------------------------------------------------------------------------------
write-host -ForegroundColor white 'To be able to use the PowerShell menus in the script, '
write-host -ForegroundColor white 'you will need to Login to Exchange Online using Remote PowerShell. '
write-host -ForegroundColor white 'In the credentials windows that appear, '
write-host -ForegroundColor white 'provide your Office 365 Global Administrator credentials. '
write-host -ForegroundColor white ------------------------------------------------------------------------------------------
write-host -ForegroundColor Magenta oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
write-host
write-host
DisconnectExchangeOnline
## This is my alias to connect to exchange @Atea with MFA. You can use your own/Will fix later.
exchange
# EXO | Exchange Online Recipient type - Uers object
#------------------------------------------------------
# EXO | Exchange Online mailbox type
#------------------------------------------------------
# All Exchange Online USER Mailboxes
$global:GetMBXUser = Get-MailBox -ResultSize Unlimited -Filter '(RecipientTypeDetails -eq "UserMailbox")' | Sort-Object -Property displayname
#------------------------------------------------------------------------------
# Object Properties Array
#------------------------------------------------------------------------------
# Report included fields
$global:Array1 = "DisplayName","Alias","LitigationHoldEnabled","LitigationHoldDate", "LitigationHoldOwner","LitigationHoldDuration ","RecipientType","RecipientTypeDetails"
$global:Array2 = "DisplayName","Alias","LitigationHoldEnabled","LitigationHoldDate", "LitigationHoldOwner","LitigationHoldDuration"
}
#=========================================================================================
# SECTION A: Assign Litigation Hold to Mailbox
#=========================================================================================
2
{
#####################################################################
# Assign Litigation Hold | Single Mailbox
#####################################################################
# == Section: General information ===
clear-host
write-host
write-host
write-host -ForegroundColor Magenta oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
write-host -ForegroundColor white Information
write-host -ForegroundColor white ----------------------------------------------------------------------------
write-host -ForegroundColor white 'This option will: '
write-host -ForegroundColor white 'Assign Litigation Hold | Single Mailbox. '
write-host -ForegroundColor white --------------------------------------------------------------------
write-host -ForegroundColor white 'The PowerShell command that we use is: '
write-host -ForegroundColor Cyan 'Set-Mailbox <Mailbox> -LitigationHoldEnabled $True '
write-host
write-host -ForegroundColor Magenta oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
write-host
write-host
# == Section: User input ===
write-host -ForegroundColor white 'User input '
write-host -ForegroundColor white ----------------------------------------------------------------------------
write-host -ForegroundColor Yellow "You will need to provide 1 parameter:"
write-host
write-host -ForegroundColor Yellow "1. Mailbox name "
write-host -ForegroundColor Yellow "Provide the Identity (Alias or E-mail address) of the Target mailbox"
write-host -ForegroundColor Yellow "For example: [email protected]"
write-host
$Alias = Read-Host "Type the mailbox name "
write-host
write-host
# == Section: Display Information ===
write-host
write-host -------------------------------------------------------------------------------------------------
write-host -ForegroundColor white -BackgroundColor Blue Display information about: "$Alias".ToUpper() LitigationHold => BEFORE the update
write-host -------------------------------------------------------------------------------------------------
Get-Mailbox $Alias | Select-Object $global:Array2 | Out-String
write-host -------------------------------------------------------------------------------------------------
# == Section: PowerShell Command ===
Set-Mailbox $Alias -LitigationHoldEnabled $True
# == Section: Display Information ===
write-host
write-host -------------------------------------------------------------------------------------------------
write-host -ForegroundColor white -BackgroundColor Magenta Display information about: "$Alias".ToUpper() LitigationHold => AFTER the update
write-host -------------------------------------------------------------------------------------------------
Get-Mailbox $Alias | Select-Object $global:Array2 | Out-String
write-host -------------------------------------------------------------------------------------------------
# == Section: End the menu command ===
write-host
write-host
Read-Host "Press Enter to continue..."
write-host
write-host
}
3
{
#####################################################################
# Assign Litigation Hold + define time range | Single Mailbox
#####################################################################
# == Section: General information ===
clear-host
write-host
write-host
write-host -ForegroundColor Magenta oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
write-host -ForegroundColor white Information
write-host -ForegroundColor white ----------------------------------------------------------------------------
write-host -ForegroundColor white 'This option will: '
write-host -ForegroundColor white 'Assign Litigation Hold + define time range | Single Mailbox. '
write-host -ForegroundColor white --------------------------------------------------------------------
write-host -ForegroundColor white 'The PowerShell command that we use is: '
write-host -ForegroundColor Cyan 'Set-Mailbox <Mailbox> -LitigationHoldEnabled $True -LitigationHoldDuration <Time Range >'
write-host
write-host -ForegroundColor Magenta oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
write-host
write-host
# == Section: User input ===
write-host -ForegroundColor white 'User input '
write-host -ForegroundColor white ----------------------------------------------------------------------------
write-host -ForegroundColor Yellow "You will need to provide 2 parameters:"
write-host
write-host -ForegroundColor Yellow "1. Mailbox name "
write-host -ForegroundColor Yellow "Provide the Identity (Alias or E-mail address) of the Target mailbox"
write-host -ForegroundColor Yellow "For example: [email protected]"
write-host
$Alias = Read-Host "Type the mailbox name "
write-host
write-host
write-host -ForegroundColor Yellow "2. Time Range "
write-host -ForegroundColor Yellow "The Second parameter is the time range for the Litigation Hold"
write-host -ForegroundColor Yellow "for example - 2555 for time range of 7 years"
write-host
$Time = Read-Host "Type the time range for the Litigation Hold"
# == Section: Display Information ===
write-host
write-host -------------------------------------------------------------------------------------------------
write-host -ForegroundColor white -BackgroundColor Blue Display information about: "$Alias".ToUpper() LitigationHold => BEFORE the update
write-host -------------------------------------------------------------------------------------------------
Get-Mailbox $Alias | Select-Object $global:Array2 | Out-String
write-host -------------------------------------------------------------------------------------------------
# == Section: PowerShell Command ===
Set-Mailbox $Alias -LitigationHoldEnabled $True -LitigationHoldDuration $Time
# Display Information ===
write-host
write-host -------------------------------------------------------------------------------------------------
write-host -ForegroundColor white -BackgroundColor Magenta Display information about: "$Alias".ToUpper() LitigationHold => AFTER the update
write-host -------------------------------------------------------------------------------------------------
Get-Mailbox $Alias | Select-Object $global:Array2 | Out-String
write-host -------------------------------------------------------------------------------------------------
# == Section: End the menu command ===
write-host
write-host
Read-Host "Press Enter to continue..."
write-host
write-host
}
4
{
###################################################################################################################################
# Assign Litigation Hold | ALL USER Mailboxes (Bulk mode)
###################################################################################################################################
checkConnection
# General information
clear-host
write-host
write-host
write-host -ForegroundColor Magenta oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
write-host -ForegroundColor white Information
write-host -ForegroundColor white ----------------------------------------------------------------------------
write-host -ForegroundColor white "Assign Litigation Hold | ALL USER Mailboxes (Bulk mode) "
write-host -ForegroundColor white ----------------------------------------------------------------------------
write-host -ForegroundColor white "This menu option, will enable Exchange Litigation Hold for each existing Exchange Online "
write-host -ForegroundColor white "User mailbox (Enable Audit in Bulk mode) Which doesn’t have Litigation Hold enabled. "
write-host -ForegroundColor white --------------------------------------------------------------------
write-host -ForegroundColor Magenta oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
write-host
write-host
#---------------------------------------------------------------------------------------------------
# Define variables
#---------------------------------------------------------------------------------------------------
# Define date format variable
$Datef = Get-Date -Format "\Da\te dd-MM-yyyy \Ti\me H-mm"
#---------------------------------------------------------------------------------------------------
# Define variables that contain the folders names
#---------------------------------------------------------------------------------------------------
# C:\INFO\Litigation Hold informaiton
$A20 = "C:\INFO\Litigation Hold informaiton - $Datef"
# 1. Report mailboxes which the Litigation Hold where enabled for them
$A21 = "$A20\1. Report mailboxes which the Litigation Hold where enabled for them"
# 2. All mailboxes with Litigation Hold
$A22 = "$A20\2. All mailboxes with Litigation Hold"
#---------------------------------------------------------------------------------------------------
# Create folders Structure that contain the exported information to TXT, CSV and HTML files
#---------------------------------------------------------------------------------------------------
# C:\INFO\Litigation Hold informaiton -<Date>
if (!(Test-Path -path $A20))
{New-Item $A20 -type directory}
# 1. Report mailboxes which the Litigation Hold where enabled for them
if (!(Test-Path -path $A21))
{New-Item $A21 -type directory}
# 2. All mailboxes with Litigation Hold
if (!(Test-Path -path $A22))
{New-Item $A22 -type directory}
#---------------------------------------------------------------------------------------------------
# Define various parameter that are related to the Log file
#---------------------------------------------------------------------------------------------------
# Define variables for the LOG file name
$LOGFileName = "Log File.TXT"
$LOGFilePath = "$A21\$LOGFileName"
# Define variables for the LOG file header text
write-ToLOGFfile $lineH1
Write-ToLOGFfile "Enable Litigation Hold for All Exchange Online USER mailboxes without Litigation Hold | $Datef"
write-ToLOGFfile $lineH1
#---------------------------------------------------------------------------------------------------
# Define the Array
#---------------------------------------------------------------------------------------------------
# Define the Array of Exchange Online mailboxes | All USER mailboxes
$GetMBXUser = Get-MailBox -ResultSize Unlimited -Filter '(RecipientTypeDetails -eq "UserMailbox")' | Sort-Object -Property displayname
# Define the Array of Exchange Online mailboxes | All USER mailboxes with LitigationHold Enabled
$AllMailboxesWithLitigationHold = $GetMBXUser | Where-Object {$_.LitigationHoldEnabled -eq $True} | Sort-Object -Property displayname
# Define the Array of Exchange Online mailboxes | All USER mailboxes with LitigationHold Disabled
$AllMailboxesWithOUTLitigationHold = $GetMBXUser | Where-Object {$_.LitigationHoldEnabled -eq $False} | Sort-Object -Property displayname
# Count the number of Exchange Online USER mailboxes
$GetMBXUserCount = ($GetMBXUser).count
# Count the number of Exchange Online USER mailboxes with Litigation Hold Enabled
$AllMailboxesWithLitigationHoldCount = ($AllMailboxesWithLitigationHold).count
# Count the number of Exchange Online USER mailboxes with OUT Litigation Hold
$AllMailboxesWithOUTLitigationHoldCount = ($AllMailboxesWithOUTLitigationHold).count
# Display information about: Exchange Online USER mailboxes and Litigation Hold
write-host
write-host -------------------------------------------------------------------------------------------------
write-host -ForegroundColor white -BackgroundColor blue "Display information about: Exchange Online USER mailboxes and Litigation Hold"
write-host -------------------------------------------------------------------------------------------------
write-host -------------------------------------------------------------------------------------------------
write-host "There are: " -nonewline; write-host "$GetMBXUserCount" -ForegroundColor Yellow -BackgroundColor blue -nonewline; write-host " Exchange Online USER mailboxes "
write-host
write-host "There are: " -nonewline; write-host "$AllMailboxesWithLitigationHoldCount" -ForegroundColor Yellow -BackgroundColor blue -nonewline; write-host " Exchange Online USER mailboxes with Litigation Hold Enabled "
write-host
write-host "There are: " -nonewline; write-host "$AllMailboxesWithOUTLitigationHoldCount" -ForegroundColor Yellow -BackgroundColor blue -nonewline; write-host " Exchange Online USER mailboxes with OUT Litigation Hold "
write-host -------------------------------------------------------------------------------------------------
write-host
write-host
#---------------------------------------------------------------------------------------------------
# PowerShell Command
#---------------------------------------------------------------------------------------------------
$AllMailboxes = $AllMailboxesWithOUTLitigationHold
# Document the updates by writing information to LOG file
write-ToLOGFfile $line1
write-ToLOGFfile "There are: $GetMBXUserCount Exchange Online USER mailboxes "
write-host
write-ToLOGFfile "There are: $AllMailboxesWithLitigationHoldCount Exchange Online USER mailboxes with Litigation Hold Enabled"
write-host
write-ToLOGFfile "There are: $AllMailboxesWithOUTLitigationHoldCount Exchange Online USER mailboxes WITH OUT Litigation Hold"
write-ToLOGFfile $line1
ForEach ($Mailbox in $AllMailboxes)
{
# User \ Mailbox identity | Single member from the Array
$ID1 = $Mailbox.Displayname
# Enable Litigation Hold on The specified Exchange mailbox (Array member)
Set-Mailbox $ID1 -LitigationHoldEnabled $True
# Display progress bar information on the PowerShell console
Write-Progress -Activity "Enable Litigation Hold on - Exchange $ID1 Mailbox"
# Document the updates by writing information to LOG file
write-ToLOGFfile $line1
Write-ToLOGFfile "Litigation Hold was enabled for - $ID1 mailbox"
write-ToLOGFfile $line1
# Display information about the action that was performed
write-host
write-host -ForegroundColor white ----------------------------------------------------------------------------
write-host -ForegroundColor white "Litigation Hold was enabled for - " -nonewline; write-host $ID1 -ForegroundColor white -BackgroundColor Darkgreen -nonewline; write-host " mailbox " -ForegroundColor white
write-host -ForegroundColor white ----------------------------------------------------------------------------
write-host
}
#---------------------------------------------------------------------------------------------------
# Export Exchange Online Mailboxes Litigation Hold settings to files
#---------------------------------------------------------------------------------------------------
$GetMBXUser = $null
# Define the Array of Exchange Online mailboxes | All USER mailboxes
$GetMBXUser = Get-MailBox -ResultSize Unlimited -Filter '(RecipientTypeDetails -eq "UserMailbox")' | Sort-Object -Property displayname
#---------------------------------------------------------------------------------------------------
# Define variables that contain the files names
#---------------------------------------------------------------------------------------------------
$FileName1 = "Exchange Online Mailboxes Litigation Hold settings"
### TXT ####
$GetMBXUser | Select-Object $global:Array1 | Format-List | Out-File $A22\"$FileName1.txt" -Encoding UTF8
##########
### CSV ####
$GetMBXUser | Select-Object $global:Array1 | Export-CSV $A22\"$FileName1.CSV" –NoTypeInformation -Encoding utf8
##########
### HTML ####
$GetMBXUser | Select-Object $global:Array1 | ConvertTo-Html -post $EndReport -head $Header -Body "<H1>$FileName1 | $Datef </H1>" | Set-AlternatingRows -CSSEvenClass even -CSSOddClass odd | Out-File $A22\"$FileName1.html"
##########
# START User notification about the location of the exported files
write-host
write-host -ForegroundColor Magenta oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
write-host -ForegroundColor white Information
write-host -ForegroundColor white ----------------------------------------------------------------------------
write-host -ForegroundColor white "The information about Exchange Online mailboxes that their Litigation Hold was enabled, was written to a LOG file "
write-host -ForegroundColor white "You can find the LOG file in the following path: "
write-host -BackgroundColor DarkGreen $A20
write-host -ForegroundColor white --------------------------------------------------------------------
write-host -ForegroundColor Magenta oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
# END User notification about the location of the exported files
# Empty the content of the variable
$LOGFilePath = $null
$Datef = $null
$AllMailboxes = $null
$ID1 = $null
$GetMBXUser = $null
$AllMailboxes = $null
$AllMailboxesWithLitigationHold = $null
$AllMailboxesWithOUTLitigationHold = $null
# End the Command
write-host
write-host
Read-Host "Press Enter to continue..."
write-host
write-host
}
5
{
#####################################################################
# Assign Litigation Hold based on a criterion (Department) | ALL USER Mailboxes (Bulk mode)
#####################################################################
# == Section: General information ===
clear-host
write-host
write-host
write-host -ForegroundColor Magenta oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
write-host -ForegroundColor white Information
write-host -ForegroundColor white ----------------------------------------------------------------------------
write-host -ForegroundColor white 'This option will: '
write-host -ForegroundColor white 'Assign Litigation Hold based on a criterion (Department) | ALL USER Mailboxes (Bulk mode). '
write-host -ForegroundColor white --------------------------------------------------------------------
write-host -ForegroundColor white 'The PowerShell command that we use is: '
write-host -ForegroundColor Cyan 'Get-Recipient -RecipientTypeDetails UserMailbox -ResultSize unlimited -Filter (Department -eq "<Department>") | Set-Mailbox -LitigationHoldEnabled $True'
write-host
write-host -ForegroundColor Magenta oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
write-host
write-host
# == Section: User input ===
write-host -ForegroundColor white 'User input '
write-host -ForegroundColor white ----------------------------------------------------------------------------
write-host -ForegroundColor Yellow "You will need to provide 1 parameter:"
write-host
write-host -ForegroundColor Yellow "1. Department name "
write-host -ForegroundColor Yellow "Provide the Department name"
write-host -ForegroundColor Yellow "For example: HR"
write-host
$Department = Read-Host "Type the Department name "
write-host
write-host
# == Section: Display Information about xxxx ===
$DepartmentUsers = Get-user | Where-Object {($_.RecipientTypeDetails -eq 'UserMailbox') -and ($_.Department -eq $Department)}
write-host
write-host -------------------------------------------------------------------------------------------------
write-host -ForegroundColor white -BackgroundColor Blue Display information users from : "$Department".ToUpper()
write-host -------------------------------------------------------------------------------------------------
$DepartmentUsers | Out-String
write-host -------------------------------------------------------------------------------------------------
write-host
write-host
write-host
write-host
write-host -------------------------------------------------------------------------------------------------
write-host -ForegroundColor white -BackgroundColor Blue Display information about: Litigation Hold Settings => BEFORE the update
write-host -------------------------------------------------------------------------------------------------
$DepartmentUsers | Select-Object $global:Array2 | Out-String
write-host -------------------------------------------------------------------------------------------------
# == Section: PowerShell Command ===
$DepartmentUsers | Set-Mailbox -LitigationHoldEnabled $True
# == Section: Display Information about xxxx ===
write-host
write-host -------------------------------------------------------------------------------------------------
write-host -ForegroundColor white -BackgroundColor Magenta Display information about: Litigation Hold Settings => AFTER the update
write-host -------------------------------------------------------------------------------------------------
$DepartmentUsers | Select-Object $global:Array2 | Out-String
write-host -------------------------------------------------------------------------------------------------
# == Section: End the menu command ===
write-host
write-host
Read-Host "Press Enter to continue..."
write-host
write-host
}
6
{
#####################################################################
# Assign Litigation ALL USER Mailboxes that dont have Litigation Hold | (Bulk mode)
#####################################################################
# == Section: General information ===
clear-host
write-host
write-host
write-host -ForegroundColor Magenta oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
write-host -ForegroundColor white Information
write-host -ForegroundColor white ----------------------------------------------------------------------------
write-host -ForegroundColor white 'This option will: '
write-host -ForegroundColor white ' Assign Litigation ALL USER Mailboxes that dont have Litigation Hold | (Bulk mode). '
write-host -ForegroundColor white --------------------------------------------------------------------
write-host -ForegroundColor white 'The PowerShell command that we use is: '
write-host -ForegroundColor Cyan 'Get-Mailbox | Where {$_.LitigationHoldEnabled -match "False"} | ForEach-Object {$Identity = $_.alias; Set-Mailbox -Identity $Identity -LitigationHoldEnabled $True } '
write-host
write-host -ForegroundColor Magenta oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
write-host
write-host
# == Section: Display Information about xxxx ===
write-host
write-host -------------------------------------------------------------------------------------------------
write-host -ForegroundColor white -BackgroundColor Blue Display information about: Litigation Hold Settings => BEFORE the update
write-host -------------------------------------------------------------------------------------------------
$global:GetMBXUser | Where-Object {$_.LitigationHoldEnabled -match "False"} | Select-Object Name,LitigationHold* | Out-String
write-host -------------------------------------------------------------------------------------------------
# == Section: PowerShell Command ===
$global:GetMBXUser | Where-Object {$_.LitigationHoldEnabled -match "False"} | ForEach-Object {$Identity = $_.alias; Set-Mailbox -Identity $Identity -LitigationHoldEnabled $True }
# == Section: Display Information about xxxx ===
write-host
write-host -------------------------------------------------------------------------------------------------
write-host -ForegroundColor white -BackgroundColor Magenta Display information about: Litigation Hold Settings => AFTER the update
write-host -------------------------------------------------------------------------------------------------
$global:GetMBXUser | Where-Object {$_.LitigationHoldEnabled -match "False"} | Select-Object Name,LitigationHold* | Out-String
write-host -------------------------------------------------------------------------------------------------
# == Section: End the menu command ===
write-host
write-host
Read-Host "Press Enter to continue..."
write-host
write-host
}
#===============================================================================================================
# SECTION B: Display + Export information about Litigation Hold
#===============================================================================================================
7
{
#####################################################################
# Display information about Litigation Hold | Single Mailbox
#####################################################################
# == Section: General information ===
clear-host
write-host
write-host
write-host -ForegroundColor Magenta oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
write-host -ForegroundColor white Information
write-host -ForegroundColor white ----------------------------------------------------------------------------
write-host -ForegroundColor white 'This option will: '
write-host -ForegroundColor white 'Display information about Litigation Hold | Single Mailbox. '
write-host -ForegroundColor white --------------------------------------------------------------------
write-host -ForegroundColor white 'The PowerShell command that we use is: '
write-host -ForegroundColor Cyan 'Get-Mailbox <Mailbox> | Select-Object Name,LitigationHold* '
write-host
write-host -ForegroundColor Magenta oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
write-host
write-host
# == Section: User input ===
write-host -ForegroundColor white 'User input '
write-host -ForegroundColor white ----------------------------------------------------------------------------
write-host -ForegroundColor Yellow "You will need to provide 1 parameter:"
write-host
write-host -ForegroundColor Yellow "1. Mailbox name "
write-host -ForegroundColor Yellow "Provide the Identity (Alias or E-mail address) of the Target mailbox"
write-host -ForegroundColor Yellow "For example: [email protected]"
write-host
$Alias = Read-Host "Type the mailbox name "
write-host
write-host
# == Section: Display Information ===
write-host
write-host -------------------------------------------------------------------------------------------------
write-host -ForegroundColor white -BackgroundColor Blue Display information about: "$Alias".ToUpper() LitigationHold
write-host -------------------------------------------------------------------------------------------------
Get-Mailbox $Alias | Select-Object Name,LitigationHold* | Out-String
write-host -------------------------------------------------------------------------------------------------
# == Section: End the menu command ===
write-host
write-host
Read-Host "Press Enter to continue..."
write-host
write-host
}
8
{
##########################################################################################################
# Export information about Litigation Hold | ALL USER Mailboxes
##########################################################################################################
checkConnection
# == Section: General information ===
clear-host
write-host
write-host
write-host -ForegroundColor Magenta oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
write-host -ForegroundColor white Introduction
write-host -ForegroundColor white --------------------------------------------------------------------------------------
write-host -ForegroundColor white 'This option will: '
write-host -ForegroundColor white 'Export information about Litigation Hold | ALL USER Mailboxes '
write-host -ForegroundColor white --------------------------------------------------------------------------------------
write-host -ForegroundColor white 'NOTE - The export command will: '
write-host -ForegroundColor white '1. Create a folder named INFO in drive C: '
write-host -ForegroundColor white '2. Save all of the exported information to diffrent file formats: TXT,CSV and HTML '
write-host -ForegroundColor white 'The files will be saved in the follwoing path:' -NoNewline;Write-Host 'C:\INFO\Litigation Hold informaiton\1. ALL USER Mailboxes' -ForegroundColor Yellow -BackgroundColor DarkGreen
write-host -ForegroundColor Magenta oooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
write-host
# == Section: Export Data to Files ===
#---------------------------------------------------------------------------------------------------
# Export information to Files
#---------------------------------------------------------------------------------------------------
#---------------------------------------------------------------------------------------------------
# Create folders Structure that contain the exported information to TXT, CSV and HTML files
#---------------------------------------------------------------------------------------------------
#------------------------------------------------------------------------------
# Folder and path Structure
#------------------------------------------------------------------------------
$A20 = "C:\INFO\Litigation Hold informaiton"
$A21 = "$A20\1. ALL USER Mailboxes"
#---------------------------------------------------------------------------------------------------
# Create the required folders in Drive C:\INFO
#---------------------------------------------------------------------------------------------------
# C:\INFO\Litigation Hold informaiton
if (!(Test-Path -path $A20))
{New-Item $A20 -type directory}
# 1. ALL USER Mailboxes
if (!(Test-Path -path $A21))
{New-Item $A21 -type directory}
# == Section: Export data to files ===
### TXT ####
$global:GetMBXUser | Select-Object $global:Array1 | Format-List | Out-File $A21\"Litigation Hold - Settings.txt" -Encoding UTF8
##########
### CSV ####
$global:GetMBXUser | Select-Object $global:Array1 | Export-CSV $A21\"Litigation Hold - Settings.CSV" –NoTypeInformation -Encoding utf8
##########
### HTML ####
$global:GetMBXUser | Select-Object $global:Array1 | ConvertTo-Html -post $EndReport -head $Header -Body "<H1>Litigation Hold - Settings | $Datef </H1>" | Set-AlternatingRows -CSSEvenClass even -CSSOddClass odd | Out-File $A21\"Litigation Hold - Settings.html"
##########
# == Section: End the menu command ===
write-host
write-host
Read-Host "Press Enter to continue..."
write-host
write-host
}
9
{
##########################################################################################################
# Display + Export information about Litigation Hold | Mailboxes which have a Litigation Hold enabled
##########################################################################################################
checkConnection