Get-NormalizedDN.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 |
<#
.SYNOPSIS This function is used to normalize the DN information of users on premises to SMTP addresses utilized in Office 365. .DESCRIPTION This function is used to normalize the DN information of users on premises to SMTP addresses utilized in Office 365. .PARAMETER GlobalCatalog The global catalog to make the query against. .PARAMETER DN The DN of the object to pass to normalize. .PARAMETER CN THe canonical name of an object to normalize. .PARAMETER adCredential The AD credential for global catalog connections. .PARAMETER originalGroupDN The DN of the original group on premises. .PARAMETER isMember Boolean if the object to be tested is a member. .OUTPUTS Selects the mail address of the user by DN and returns the mail address. .EXAMPLE get-normalizedDN -globalCatalog GC -DN DN -adCredential CRED -isMember FALSE #> Function Get-NormalizedDN { [cmdletbinding()] Param ( [Parameter(Mandatory = $true)] [string]$globalCatalogServer, [Parameter(Mandatory = $true)] [string]$groupSMTPAddress, [Parameter(Mandatory = $true)] [string]$DN, [Parameter(Mandatory = $true)] [string]$CN, [Parameter(Mandatory = $TRUE)] $adCredential, [Parameter(Mandatory = $TRUE)] [string]$originalGroupDN, [Parameter(Mandatory = $false)] [boolean]$isMember=$FALSE, [Parameter(Mandatory = $true)] [string]$activeDirectoryAttribute, [Parameter(Mandatory = $true)] [string]$activeDirectoryAttributeCommon ) #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) #Declare function variables. $functionTest=$NULL #Holds the return information for the group query. $functionObject=$NULL #This is used to hold the object that will be returned. [string]$functionSMTPAddress=$NULL $functionDN=$NULL #Start function processing. Out-LogFile -string "********************************************************************************" Out-LogFile -string "BEGIN GET-NormalizedDN" Out-LogFile -string "********************************************************************************" #Get the specific user using ad providers. $stopLoop = $FALSE [int]$loopCounter = 0 $activeDirectoryDomainName ="" do { try { Out-LogFile -string "Attempting to find the AD object associated with the member." if ($DN -ne "None") { try { out-logfile -string "Obtaining the active directory domain for this operation." $activeDirectoryDomainName=get-activeDirectoryDomainName -dn $DN -errorAction STOP out-logfile -string ("Active Directory Domain Calculated: "+$activeDirectoryDomainName) } catch { out-logfile $_ out-logfile "Unable to calculate the active directory domain name via DN." -isError:$TRUE } out-logfile -string "Attepmting to find the user via distinguished name." $functionTest = get-adObject -filter {distinguishedname -eq $dn} -properties * -credential $adCredential -errorAction STOP -server $activeDirectoryDomainName if ($functionTest -eq $NULL) { throw "The array member cannot be found by DN in Active Directory." } Out-LogFile -string "The array member was found by DN." } else { out-logfile -string "Attempting to find member by canonical name converted to distinguished name." #Canonical name is a calculated value - need to tranlate to DN and then search directory. try { $DN = get-distinguishedName -canonicalName $CN -errorAction STOP } catch { out-logfile -string "Unable to obtain the DN from canoincal name." -isError:$TRUE } try { out-logfile -string "Obtaining the active directory domain for this operation." $activeDirectoryDomainName=get-activeDirectoryDomainName -dn $DN -errorAction STOP out-logfile -string ("Active Directory Domain Calculated: "+$activeDirectoryDomainName) } catch { out-logfile $_ out-logfile "Unable to calculate the active directory domain name via DN." -isError:$TRUE } $functionTest = get-adObject -filter {distinguishedname -eq $dn} -properties * -credential $adCredential -errorAction STOP -server $activeDirectoryDomainName if ($functionTest -eq $NULL) { throw "The array member cannot be found by DN in Active Directory." } Out-LogFile -string "The array member was found by DN." } $stopLoop=$TRUE } catch { if ($loopCounter -gt 4) { Out-LogFile -string $_ -isError:$TRUE } else { out-logfile -string "Error getting AD object. Sleep and try again." $loopcounter = $loopCounter+1 start-sleepProgress -sleepString "Sleeping for 5 seconds get-adobjectError" -sleepSeconds 5 } } } until ($stopLoop -eq $TRUE) try { #In this iteraction of the script were changing how we track recipients - since we're using adsi. #First step check to see if the object has a recipient display type - that means it's mail enabled. #If the object is mail enabled - regardless of object type - look to see if the previous migration was done (group to contact conversion.) #If the group was not migrated or is not a group - take those attributes. #The next case is that we do allow contacts to have a mail attribute but not be a full recipient. (The only wayt to get them into the group is to use ADUC to do it - but it happens.) #If the object has MAIL and is a CONTACT record information we can. It can be migrated. #Otherwise we've found non-mail present object (user with mail attribute / bad user / bad group - end.) #Check to see if the recipient has a recipient display type and is a user, or is a contact. Out-LogFile -string "Interpreting DN evaluation..." if ($functiontest.msExchRecipientDisplayType -eq "3") { out-logfile -string "A dynamic distribution group was found." out-logfile -string "This could be either member or permission." out-logfile -string "It will be included as an object but failure will occur if not already provisioned in Office 365." $functionObject = New-Object PSObject -Property @{ Alias = $functionTest.mailNickName Name = $functionTest.Name PrimarySMTPAddressOrUPN = $functionTest.mail GUID = $NULL RecipientType = $functionTest.objectClass ExchangeRecipientTypeDetails = $functionTest.msExchRecipientTypeDetails ExchangeRecipientDisplayType = $functionTest.msExchRecipientDisplayType ExchangeRemoteRecipientType = $functionTest.msExchRemoteRecipientType GroupType = $NULL RecipientOrUser = "Recipient" ExternalDirectoryObjectID = $null OnPremADAttribute = $activeDirectoryAttribute OnPremADAttributeCommonName = $activeDirectoryAttributeCommon DN = $DN ParentGroupSMTPAddress = $groupSMTPAddress isAlreadyMigrated = $false isError=$false isErrorMessage="" } } elseif (($functionTest.msExchRecipientDisplayType -ne $NULL) -and (($functionTest.objectClass -eq "User") -or ($functionTest.objectClass -eq "Contact"))) { Out-LogFile -string "The object has a recipient display type and is a user or contact." #If the object has already been mirgated - then custom attribute 1 is migrated by script. #Update the object to include the custom attribute not the object itself. if ($functionTest.extensionAttribute1 -eq "MigratedByScript") { Out-LogFile -string "The object was previously migrated - using migrated information." $functionObject = New-Object PSObject -Property @{ Alias = $functionTest.mailNickName Name = $functionTest.Name PrimarySMTPAddressOrUPN = $functionTest.extensionAttribute2 GUID = $NULL RecipientType = $functionTest.objectClass ExchangeRecipientTypeDetails = $functionTest.msExchRecipientTypeDetails ExchangeRecipientDisplayType = $functionTest.msExchRecipientDisplayType ExchangeRemoteRecipientType = $functionTest.msExchRemoteRecipientType GroupType = $NULL RecipientOrUser = "Recipient" ExternalDirectoryObjectID = $functionTest.'msDS-ExternalDirectoryObjectId' OnPremADAttribute = $activeDirectoryAttribute OnPremADAttributeCommonName = $activeDirectoryAttributeCommon DN = $DN ParentGroupSMTPAddress = $groupSMTPAddress isAlreadyMigrated = $true isError=$false isErrorMessage="" } } #If the object has not been migrated - then proceed with recording the original attributes. else { Out-LogFile -string "The object was not previously migrated - using directory information." $functionObject = New-Object PSObject -Property @{ Alias = $functionTest.mailNickName Name = $functionTest.Name PrimarySMTPAddressOrUPN = $functionTest.mail GUID = $NULL RecipientType = $functionTest.objectClass ExchangeRecipientTypeDetails = $functionTest.msExchRecipientTypeDetails ExchangeRecipientDisplayType = $functionTest.msExchRecipientDisplayType ExchangeRemoteRecipientType = $functionTest.msExchRemoteRecipientType GroupType = $NULL RecipientOrUser = "Recipient" ExternalDirectoryObjectID = $functionTest.'msDS-ExternalDirectoryObjectId' OnPremADAttribute = $activeDirectoryAttribute OnPremADAttributeCommonName = $activeDirectoryAttributeCommon DN = $DN ParentGroupSMTPAddress = $groupSMTPAddress isAlreadyMigrated = $false isError=$false isErrorMessage="" } } } elseif (($functiontest.mail -ne $NULL) -and ($functiontest.msExchRecipientDisplayType -eq $NULL) -and ($functionTest.objectClass -eq "Contact")) { Out-LogFile -string "The object is a contact with a mail attribute - but is not fully exchange enabled." $functionObject = New-Object PSObject -Property @{ Alias = $NULL Name = $functionTest.Name PrimarySMTPAddressOrUPN = $functionTest.mail GUID = $NULL RecipientType = $functionTest.objectClass ExchangeRecipientTypeDetails = $functionTest.msExchRecipientTypeDetails ExchangeRecipientDisplayType = $functionTest.msExchRecipientDisplayType ExchangeRemoteRecipientType = $functionTest.msExchRemoteRecipientType GroupType = $NULL RecipientOrUser = "Recipient" ExternalDirectoryObjectID = $functionTest.'msDS-ExternalDirectoryObjectId' OnPremADAttribute = $activeDirectoryAttribute DN = $DN ParentGroupSMTPAddress = $groupSMTPAddress isAlreadyMigrated = $false isError=$false isErrorMessage="" } } elseif ($functionTest.objectClass -eq "User") { Out-LogFile -string "The object is a user only object hopefully in managedBY or USERS." $functionObject = New-Object PSObject -Property @{ Alias = $NULL Name = $functionTest.Name PrimarySMTPAddressOrUPN = $functionTest.userPrincipalName GUID = $NULL RecipientType = $functionTest.objectClass ExchangeRecipientTypeDetails = $functionTest.msExchRecipientTypeDetails ExchangeRecipientDisplayType = $functionTest.msExchRecipientDisplayType ExchangeRemoteRecipientType = $functionTest.msExchRemoteRecipientType GroupType = $NULL RecipientOrUser = "User" ExternalDirectoryObjectID = $functionTest.'msDS-ExternalDirectoryObjectId' OnPremADAttribute = $activeDirectoryAttribute OnPremADAttributeCommonName = $activeDirectoryAttributeCommon DN = $DN ParentGroupSMTPAddress = $groupSMTPAddress isAlreadyMigrated = $FALSE isError=$false isErrorMessage="" } } elseif ($functionTest.objectClass -eq "Group") { out-logfile -string "The recipient is a group." #It is possible that the group has permissions to itself. if (($functionTest.distinguishedname -eq $originalGroupDN) -and ($isMember -eq $FALSE)) { out-logFile -string "The group has permissions to itself - this is permissable - adding to array." #The group has permissions to itself and this is permissiable. $functionObject = New-Object PSObject -Property @{ Alias = $functionTest.mailNickName Name = $functionTest.Name PrimarySMTPAddressOrUPN = $functionTest.mail GUID = $NULL RecipientType = $functionTest.objectClass ExchangeRecipientTypeDetails = $functionTest.msExchRecipientTypeDetails ExchangeRecipientDisplayType = $functionTest.msExchRecipientDisplayType ExchangeRemoteRecipientType = $functionTest.msExchRemoteRecipientType GroupType = $functionTest.GroupType RecipientOrUser = "Recipient" ExternalDirectoryObjectID = $functionTest.'msDS-ExternalDirectoryObjectId' OnPremADAttribute = $activeDirectoryAttribute OnPremADAttributeCommonName = $activeDirectoryAttributeCommon DN = $DN ParentGroupSMTPAddress = $groupSMTPAddress isAlreadyMigrated = $false isError=$false isErrorMessage="" } } #A group can be present that was previously migrated and then disabled - if so allow the migration to proceed. #Otherwise the group was not previously migrated and would need to be cleaned up. elseif ($functionTest.extensionattribute1 -eq "MigratedByScript") { out-logfile -string "A group was found as a member and that group was previously migrated." $functionObject = New-Object PSObject -Property @{ Alias = $functionTest.mailNickName Name = $functionTest.Name PrimarySMTPAddressOrUPN = $functionTest.extensionAttribute2 GUID = $NULL RecipientType = $functionTest.objectClass ExchangeRecipientTypeDetails = $functionTest.msExchRecipientTypeDetails ExchangeRecipientDisplayType = $functionTest.msExchRecipientDisplayType ExchangeRemoteRecipientType = $functionTest.msExchRemoteRecipientType GroupType = $functionTest.GroupType RecipientOrUser = "Recipient" ExternalDirectoryObjectID = $functionTest.'msDS-ExternalDirectoryObjectId' OnPremADAttribute = $activeDirectoryAttribute OnPremADAttributeCommonName = $activeDirectoryAttributeCommon DN = $DN ParentGroupSMTPAddress = $groupSMTPAddress isAlreadyMigrated = $true isError=$false isErrorMessage="" } } elseif (($functionTest.msExchRecipientDisplayType -ne $NULL) -and ($isMember -eq $TRUE)) { #The group is mail enabled and a member. All nested groups have to be migrated first. out-logfile -string "A mail enabled group was found as a member of the DL or has permissions on the DL." $functionObject = New-Object PSObject -Property @{ Alias = $functionTest.mailNickName Name = $functionTest.Name PrimarySMTPAddressOrUPN = $functionTest.mail GUID = $NULL RecipientType = $functionTest.objectClass ExchangeRecipientTypeDetails = $functionTest.msExchRecipientTypeDetails ExchangeRecipientDisplayType = $functionTest.msExchRecipientDisplayType ExchangeRemoteRecipientType = $functionTest.msExchRemoteRecipientType GroupType = $functionTest.GroupType RecipientOrUser = "Recipient" ExternalDirectoryObjectID = $functionTest.'msDS-ExternalDirectoryObjectId' OnPremADAttribute = $activeDirectoryAttribute OnPremADAttributeCommonName = $activeDirectoryAttributeCommon DN = $DN ParentGroupSMTPAddress = $groupSMTPAddress isAlreadyMigrated = $false isError=$true isErrorMessage="NESTED_GROUP_EXCEPTION: A mail enabled group is a child member of the migrated list. The child group must be migrated first or removed from group membership." } } elseif (($functionTest.msExchRecipientDisplayType -ne $NULL) -and ($isMember -eq $FALSE)) { #The group is a recipient and has permissions to an attribute. out-logfile -string "The group has permissions on the DL and this is permissiable." out-logfile -string $dn $functionObject = New-Object PSObject -Property @{ Alias = $functionTest.mailNickName Name = $functionTest.Name PrimarySMTPAddressOrUPN = $functionTest.mail GUID = $NULL RecipientType = $functionTest.objectClass ExchangeRecipientTypeDetails = $functionTest.msExchRecipientTypeDetails ExchangeRecipientDisplayType = $functionTest.msExchRecipientDisplayType ExchangeRemoteRecipientType = $functionTest.msExchRemoteRecipientType GroupType = $functionTest.GroupType RecipientOrUser = "Recipient" ExternalDirectoryObjectID = $functionTest.'msDS-ExternalDirectoryObjectId' OnPremADAttribute = $activeDirectoryAttribute OnPremADAttributeCommonName = $activeDirectoryAttributeCommon DN = $DN ParentGroupSMTPAddress = $groupSMTPAddress isAlreadyMigrated = $false isError=$false isErrorMessage="" } } else { out-logfile -string ("The following object "+$dn+" is not mail enabled and must be removed or mail enabled to continue.") $functionObject = New-Object PSObject -Property @{ Alias = $null Name = $dn PrimarySMTPAddressOrUPN = $null GUID = $NULL RecipientType = $functionTest.objectClass ExchangeRecipientTypeDetails = $functionTest.msExchRecipientTypeDetails ExchangeRecipientDisplayType = $functionTest.msExchRecipientDisplayType ExchangeRemoteRecipientType = $functionTest.msExchRemoteRecipientType GroupType = $functionTest.GroupType RecipientOrUser = "Recipient" ExternalDirectoryObjectID = $null OnPremADAttribute = $activeDirectoryAttribute OnPremADAttributeCommonName = $activeDirectoryAttributeCommon DN = $DN ParentGroupSMTPAddress = $groupSMTPAddress isAlreadyMigrated = $false isError=$true isErrorMessage="OBJECT_NOT_MAIL_ENALBED_EXCEPTION: The member is not mail enabled. The object must be removed or mail enabled to continue." } } } else { out-logfile -string ("The following object "+$dn+" is not mail enabled and must be removed or mail enabled to continue.") $functionObject = New-Object PSObject -Property @{ Alias = $null Name = $dn PrimarySMTPAddressOrUPN = $null GUID = $NULL RecipientType = $functionTest.objectClass ExchangeRecipientTypeDetails = $functionTest.msExchRecipientTypeDetails ExchangeRecipientDisplayType = $functionTest.msExchRecipientDisplayType ExchangeRemoteRecipientType = $functionTest.msExchRemoteRecipientType GroupType = $functionTest.GroupType RecipientOrUser = "Recipient" ExternalDirectoryObjectID = $null OnPremADAttribute = $activeDirectoryAttribute OnPremADAttributeCommonName = $activeDirectoryAttributeCommon DN = $DN ParentGroupSMTPAddress = $groupSMTPAddress isAlreadyMigrated = $false isError=$true isErrorMessage="OBJECT_NOT_MAIL_ENABLED_EXCEPTION: The member is not mail enabled. The object must be removed or mail enabled to continue." } } } catch { Out-LogFile -string $_ -isError:$true } Out-LogFile -string "END GET-NormalizedDN" Out-LogFile -string "********************************************************************************" #This function is designed to open local and remote powershell sessions. #If the session requires import - for example exchange - return the session for later work. #If not no return is required. return $functionObject } |