start-collectOnPremSendAs.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 |
function start-collectOnPremSendAs { <# .SYNOPSIS This function exports all of the mailbox folders from the on premises environment with custome permissions. .DESCRIPTION Trigger function. .PARAMETER logFolder *REQUIRED* The location where logging for the migration should occur including all XML outputs for backups. .PARAMETER exchangeServer *REQUIRED IF HYBRID MAIL FLOW ENALBED* This is the on-premises Exchange server that is required for enabling hybrid mail flow if the option is specified. If using a load balanced namespace - basic authentication on powershell must be enabled on all powersell virtual directories. If using a single server (direct connection) then kerberos authentication may be utilized. .PARAMETER exchangeCredential *REQUIRED IF HYBRID MAIL FLOW ENABLED* This is the credential utilized to establish remote powershell sessions to Exchange on-premises. This acccount requires Exchange Organization Management rights in order to enable hybrid mail flow. .PARAMETER exchangeAuthenticationMethod *OPTIONAL* This allows the administrator to specify either Kerberos or Basic authentication for on premises Exchange Powershell. Basic is the assumed default and requires basic authentication be enabled on the powershell virtual directory of the specified exchange server. .OUTPUTS Logs all activities and backs up all original data to the log folder directory. Moves the distribution group from on premieses source of authority to office 365 source of authority. .EXAMPLE Start-collectOnPremFolderPermissions -exchangeServer Server -exchangeCredential $credential #> #Portions of the audit code adapted from Tony Redmon's project. #https://github.com/12Knocksinna/Office365itpros/blob/master/ReportPermissionsFolderLevel.PS1 #Don't tell him - he can get grumpy at times. [cmdletbinding()] Param ( [Parameter(Mandatory = $true)] [string]$logFolderPath, [Parameter(Mandatory = $false)] [string]$exchangeServer=$NULL, [Parameter(Mandatory = $false)] [pscredential]$exchangeCredential=$NULL, [Parameter(Mandatory = $false)] [ValidateSet("Basic","Kerberos")] [string]$exchangeAuthenticationMethod="Basic", [Parameter(Mandatory = $false)] [boolean]$retryCollection=$FALSE, [Parameter(Mandatory = $false)] $bringMyOwnRecipients=$NULL ) $windowTitle = "Start-collectOnPremSendAs" $host.ui.RawUI.WindowTitle = $windowTitle #Delare global variables. $global:logFile=$NULL #This is the global variable for the calculated log file name [string]$global:staticFolderName="\AuditData\" #Declare function variables. $auditRecipients=@() [array]$auditSendAs=@() [int]$forCounter=0 [int]$recipientCounter=0 [int]$totalRecipients=0 $commandStartTime = get-date $commandEndTime = $NULL [int]$kerberosRunTime = 4 $xmlFiles = @{ onPremRecipientSendAs= @{"Value" = "onPremRecipientSendAs.xml" ; "Description" = "XML file that holds send as permissions from on premises"} onPremRecipientList= @{"Value" = "onPremRecipientListSendAs.xml" ; "Description" = "XML file that holds recipients to process for send as rights"} onPremRecipientProcessed= @{"Value" = "onPremRecipientProcessedSendAs.xml" ; "Description" = "XML file that holds the last processed recipient"} } $onPremExchangePowershell = @{ exchangeServerConfiguration = @{"Value" = "Microsoft.Exchange" ; "Description" = "Defines the Exchange Remote Powershell configuration"} exchangeServerAllowRedirection = @{"Value" = $TRUE ; "Description" = "Defines the Exchange Remote Powershell redirection preference"} exchangeServerURI = @{"Value" = "https://"+$exchangeServer+"/powershell" ; "Description" = "Defines the Exchange Remote Powershell connection URL"} exchangeServerURIKerberos = @{"Value" = "http://"+$exchangeServer+"/powershell" ; "Description" = "Defines the Exchange Remote Powershell connection URL"} exchangeOnPremisesPowershellSessionName = @{ "Value" = "ExchangePowershell" ; "Description" = "Exchange On-Premises powershell session name."} } new-LogFile -groupSMTPAddress OnPremSendAsPermissions -logFolderPath $logFolderPath if (($bringMyOwnRecipients -ne $NULL )-and ($retryCollection -eq $TRUE)) { out-logfile -string "You cannot bring your own mailboxes when you are retrying the collection." out-logfile -string "If mailboxes were previously provided - rerun command with just retry collection." -iserror:$TRUE -isAudit:$TRUE } #Output all parameters bound or unbound and their associated values. write-functionParameters -keyArray $MyInvocation.MyCommand.Parameters.Keys -parameterArray $PSBoundParameters -variableArray (Get-Variable -Scope Local -ErrorAction Ignore) function session-toImport { if ($exchangeAuthenticationMethod -eq "Basic") { try { Out-LogFile -string "Calling New-PowerShellSession" $sessiontoImport=new-PowershellSession -credentials $exchangecredential -powershellSessionName $onPremExchangePowershell.exchangeOnPremisesPowershellSessionName.value -connectionURI $onPremExchangePowershell.exchangeServerURI.value -authenticationType $exchangeAuthenticationMethod -configurationName $onPremExchangePowershell.exchangeServerConfiguration.value -allowredirection $onPremExchangePowershell.exchangeServerAllowRedirection.value -requiresImport:$TRUE } catch { out-logfile -string $_ Out-LogFile -string "ERROR: Unable to create powershell session." -isError:$TRUE } } elseif ($exchangeAuthenticationMethod -eq "Kerberos") { try { Out-LogFile -string "Calling New-PowerShellSession" $sessiontoImport=new-PowershellSession -credentials $exchangecredential -powershellSessionName $onPremExchangePowershell.exchangeOnPremisesPowershellSessionName.value -connectionURI $onPremExchangePowershell.exchangeServerURIKerberos.value -authenticationType $exchangeAuthenticationMethod -configurationName $onPremExchangePowershell.exchangeServerConfiguration.value -allowredirection $onPremExchangePowershell.exchangeServerAllowRedirection.value -requiresImport:$TRUE } catch { out-logfile -string $_ Out-LogFile -string "ERROR: Unable to create powershell session." -isError:$TRUE } } else { out-logfile -string "Major issue creating on-premsies Exchange powershell session - unknown - ending." -isError:$TRUE } try { out-logFile -string "Attempting to import powershell session." import-powershellsession -powershellsession $sessionToImport -isAudit:$TRUE } catch { out-logFile -string "Unable to import powershell session." out-logfile -string $_ -isError:$TRUE -isAudit:$TRUE } try { out-logFile -string "Attempting to set view entire forest to TRUE." enable-ExchangeOnPremEntireForest -isAudit:$TRUE } catch { out-logFile -string "Unable to set view entire forest to TRUE." out-logfile -string $_ -isError:$TRUE -isAudit:$TRUE } } session-toImport #Define the log file path one time. $logFolderPath = $logFolderPath+$global:staticFolderName try { if ($retryCollection -eq $FALSE) { if ($bringMyOwnRecipients -eq $NULL) { out-logFile -string "Obtaining all on premises mailboxes." $auditRecipients = get-recipient -resultsize unlimited | select-object identity,primarySMTPAddress #Exporting mailbox operations to csv - the goal here will be to allow retry. $fileName = $xmlFiles.onPremRecipientList.value $exportFile=Join-path $logFolderPath $fileName $auditRecipients | export-clixml -path $exportFile } else { out-logFile -string "Using recipients provided by function caller.." foreach ($mailbox in $bringMyOwnRecipients) { out-logfile -string ("Testing recipient: "+$mailbox) try{ $auditRecipients += get-recipient -identity $mailbox -errorAction STOP | select-object identity,primarySMTPAddress } catch { out-logfile -string $_ out-logfile -string $mailbox out-logfile -string "The SMTP address specified is not a recipient - skipping." } } #Exporting mailbox operations to csv - the goal here will be to allow retry. $fileName = $xmlFiles.onPremRecipientList.value $exportFile=Join-path $logFolderPath $fileName $auditRecipients | export-clixml -path $exportFile } } elseif ($retryCollection -eq $TRUE) { out-logfile -string "Retry operation - importing the mailboxes from previous export." try{ $fileName = $xmlFiles.onPremRecipientList.value $importFile=Join-path $logFolderPath $fileName $auditRecipients = import-clixml -path $importFile } catch{ out-logfile -string "Retry was specified - unable to import the XML file." out-logfile -string $_ -isError:$TRUE -isAudit:$true } out-logfile -string "Import the count of the last mailbox processed." try { $fileName = $xmlFiles.onPremRecipientProcessed.value $importFile=Join-path $logFolderPath $fileName $recipientCounter=Import-Clixml -path $importFile #The import represents the last mailbox processed. #It's permissions were already exported - add 1 to start with the next mailbox in the list. $recipientCounter=$recipientCounter+1 out-logfile -string ("Next recipient to process = "+$recipientCounter.toString()) } catch { out-logfile -string "Unable to read the previous mailbox processed." out-logfile -string $_ -isError:$TRUE -isAudit:$true } out-logfile -string "Importing the previously exported permissions." try { $fileName=$xmlFiles.onPremRecipientSendAs.value $importFile=Join-path $logFolderPath $fileName $auditSendAs = import-clixml -Path $importFile } catch { out-logfile -string "Unable to import the previously exported permissions." -isError:$TRUE -isAudit:$true } } } catch { out-logFile -string "Unable to get mailboxes." out-logfile -string $_ -isError:$TRUE -isAudit:$TRUE } #For each mailbox - we will iterate and grab the folders for processing. $ProgressDelta = 100/($auditRecipients.count); $PercentComplete = (($recipientCounter / $auditRecipients.count)*100); $recipientNumber = 0 $totalRecipients=$auditRecipients.count #Here we're going to use a for loop based on count. #This is to support a retry operation. for ($recipientCounter ; $recipientCounter -lt $totalRecipients ; $recipientCounter++) { #Drop the mailbox into a working variable. $recipient = $auditRecipients[$recipientCounter] $commandEndTime = get-Date if (($forCounter -gt 500) -and (($commandEndTime - $commandStartTime).totalHours -lt $kerberosRunTime)) { start-sleepProgress -sleepstring "Powershell pause at 500 operations - total operation time less than ." -sleepSeconds 5 -sleepParentID 1 -sleepID 2 $forCounter=0 out-logfile -string (($commandEndTime - $commandStartTime).totalhours).tostring() } elseif ($forCounter -gt 500) { start-sleepProgress -sleepString "Throttling for 5 seconds at 500 operations." -sleepSeconds 5 $forCounter=0 $commandStartTime = get-Date if ($exchangeAuthenticationMethod -eq "Kerberos") { out-logfile -string "Kerberos authentication utilized - reset powershell session." disable-allPowerShellSessions session-toImport } } else { $forCounter++ } out-logfile -string ("Processing recipient = "+$recipient.primarySMTPAddress) out-logfile -string ("Processing recipient number: "+$recipientCounter.toString()+" of "+$totalRecipients.tostring()) $recipientNumber++ $progressString = "Recipient Name: "+$recipient.primarySMTPAddress+" Recipient Number: "+$recipientCounter+" of "+$totalRecipients Write-Progress -Activity "Processing recipient" -Status $progressString -PercentComplete $PercentComplete -Id 1 $PercentComplete += $ProgressDelta try { $auditSendAs+=get-adPermission -identity $recipient.identity | where {($_.ExtendedRights -like "*send-as*") -and -not ($_.User -like "nt authority\self") -and ($_.isInherited -eq $false)} -errorAction STOP } catch { out-logfile -string "Error obtaining folder statistics." out-logfile -string $_ -isError:$TRUE -isAudit:$TRUE } $fileName = $xmlFiles.onPremRecipientSendAs.value $exportFile=Join-path $logFolderPath $fileName $auditSendAs | Export-Clixml -Path $exportFile $fileName = $xmlFiles.onPremRecipientProcessed.value $exportFile=Join-path $logFolderPath $fileName $recipientCounter | export-clixml -path $exportFile } write-shamelessPlug disable-allPowerShellSessions } |