new-RoutingContact.ps1
|
<#
.SYNOPSIS This function creates the routing contact that will be utilized later if hybrid mail flow is enabled <and> to track attribute membership. .DESCRIPTION This function creates the routing contact that will be utilized later if hybrid mail flow is enabled <and> to track attribute membership. .PARAMETER originalDLConfiguration This is the original DL configuration from on premises. .PARAMETER office365DLConfiguration The configuration of the DL from Office 365. .PARAMETER GlobalCatalog The global catalog server the operation should be performed on. .PARAMETER adCredential The active directory credential. .PARAMETER isRetry Determines if this operation is being retried. .PARAMETER isRetryOU The OU that will be utilized when the operation is retried. .OUTPUTS No return. .EXAMPLE new-routingContact -originalDLConfiguration $config -office365DLConfiguration $configo365 -globalCatalogServer $GC -adCredential $cred #> Function new-routingContact { [cmdletbinding()] Param ( [Parameter(Mandatory = $true)] $originalDLConfiguration, [Parameter(Mandatory = $true)] $office365DLConfiguration, [Parameter(Mandatory = $true)] $globalCatalogServer, [Parameter(Mandatory = $true)] $adCredential, [Parameter(Mandatory = $false)] [ValidateSet("Basic","Negotiate")] $activeDirectoryAuthenticationMethod="Negotiate", [Parameter(Mandatory = $false)] [boolean]$isRetry = $false, [Parameter(Mandatory = $false)] [string]$isRetryOU = $false, [Parameter(Mandatory = $false)] [string]$customRoutingDomain = "" ) #Define function variables. [string]$functionMigratedByScript = "-MigratedByScript" [string]$functionMigratedByScriptShort = "MigratedByScript" [int]$functionMaxLength = 64 [string]$functionNameTest = "" $functionPoliciesExcluded = @("{26491cfc-9e50-4857-861b-0cb8df22b5d7}") $functionTargetAddress = "" #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) #Start function processing. Out-LogFile -string "********************************************************************************" Out-LogFile -string "BEGIN new-RoutingContact" Out-LogFile -string "********************************************************************************" #Declare function variables and output to screen. [string]$functionCustomAttribute1="MigratedByDLConversionV3" out-logfile -string ("Function Custom Attribute 1 = "+$functionCustomAttribute1) [string]$functionCustomAttribute2=$office365DLConfiguration.externalDirectoryObjectID out-logfile -string ("Function Custom Attribute 2 = "+$functionCustomAttribute2) out-logfile -string "Evaluate OU location to utilize." if ($isRetry -eq $FALSE) { out-logfile -string "Operation is not retried - using on premises value." [string]$functionOU=Get-OULocation -originalDLConfiguration $originalDLConfiguration } else { out-logfile -string "Operation is being retried - use administrator supplied value." $functionOU = $isRetryOU } out-logfile -string ("Function OU = "+$functionOU) out-logfile -string "Attempting to locate the existing routing address on the group." #Note: The custom routing domain is ALWAYS the domain we should be using. #Note: In the main function if custom routing domain is specified we set the onmicrosoft.com domain to be it. #Note: If the custom routing domain is not specified then we calculate the onmicorosft.com or microosftonline.com (legacy). out-logfile -string "Calculate the SMTP address prefix that will be utilized for routing." if ($originalDLConfiguration.'ms-ds-ConsistencyGuid' -ne $NULL) { out-logfile -string "MS-DS-ConsistencyGuid utilized." $guid = $originalDLConfiguration.'ms-ds-ConsistencyGuid'.tostring() out-logfile -string $guid } else { out-logfile -string "ObjectGUID utilized" $guid = $originalDLConfiguration.ObjectGUID.tostring() out-logfile -string $guid } try { out-logfile -string "Calculate immutable ID." $functionPrefix = convert-ID -id $GUID -errorAction STOP out-logfile -string $functionPrefix } catch { out-logfile -string 'Unable to obtain immutable id.' out-logfile -string $_ -isError:$TRUE } out-logfile -string "Calculate the cross premises routing address." $functionTargetAddress = "SMTP:"+$functionPrefix+"@"+$customRoutingDomain out-logfile -string "Perform safety check on the address calculated." do { if(get-o365Recipient -identity $functionTargetAddress.replace("SMTP:","")) { out-logfile -string "Calcuated target routing address utilized in service - generate random." $isValidAddress = $false $newAlias = ((Get-Random)+(Get-Random)+(Get-Random)) out-logfile -string $newAlias $functionEmailAddress = $functionTargetAddress.split("@") foreach ($item in $functionEmailAddress) { out-logfile -string $item } $functionEmailAddress[0]=$newAlias foreach ($item in $functionEmailAddress) { out-logfile -string $item } $functionTargetAddress = $functionEmailAddress[0]+"@"+$functionEmailAddress[1] } else { out-logfile -string "Target routing address as calculated not utilized in serivce otherwise." $isValidAddress = $true } } until ( $isValidAddress -eq $TRUE ) <# foreach ($address in $office365DLConfiguration.emailAddresses) { out-logfile -string ("Testing address for remote routing address = "+$address) if (($address.tolower()).contains($customRoutingDomain)) { out-logfile -string ("The remote routing address was found = "+$address) $functionTargetAddress=$address $functionTargetAddress=$functionTargetAddress.toUpper() break } else { $functionTargetAddress = "" } } out-logfile -string ("Function Target Address: "+$functionTargetAddress) if ($functionTargetAddress -ne "") { out-logfile -string "Remote routing address is located - use this for cross premises mail flow calculation." $functionEmailAddress = $functionTargetAddress.split("@") foreach ($item in $functionEmailAddress) { out-logfile -string $item } if ($originalDLConfiguration.'ms-ds-ConsistencyGuid' -ne $NULL) { $functionPrefix = convert-id -id $originalDLConfiguration.'ms-ds-ConsistencyGuid' out-logfile -string $functionPrefix } else { $functionPrefix = convert-id -id $originalDLConfiguration.ObjectGuid out-logfile -string $functionPrefix } $functionEmailAddress[0] = "SMTP:"+$functionPrefix+"-migratedByV3" out-logfile -string $functionEmailAddress[0] foreach ($item in $functionEmailAddress) { out-logfile -string $item } $functionTargetAddress = $functionEmailAddress[0]+"@"+$functionEmailAddress[1] out-logfile -string $functionTargetAddress } else { out-logfile -string "Constructing the remote routing address based on alias and domain." $functionTargetAddress = $office365DLConfiguration.alias+"@"+$customRoutingDomain out-logfile -string $functionTargetAddress } $isValidAddress = $FALSE do { if(get-o365Recipient -identity $functionTargetAddress.replace("SMTP:","")) { out-logfile -string "Calcuated target routing address utilized in service - generate random." $isValidAddress = $false $newAlias = ((Get-Random)+(Get-Random)+(Get-Random)) out-logfile -string $newAlias $functionEmailAddress = $functionTargetAddress.split("@") foreach ($item in $functionEmailAddress) { out-logfile -string $item } $functionEmailAddress[0]=$newAlias foreach ($item in $functionEmailAddress) { out-logfile -string $item } $functionTargetAddress = $functionEmailAddress[0]+"@"+$functionEmailAddress[1] } else { out-logfile -string "Target routing address as calculated not utilized in serivce otherwise." $isValidAddress = $true } } until ( $isValidAddress -eq $TRUE ) #> out-logfile -string ("Function target address = "+$functionTargetAddress) out-logfile -string "Add the email address to the migrated office 365 dl." try { set-o365DistributionGroup -identity $office365DLConfiguration.externalDirectoryObjectID -emailAddresses @{add=$functionTargetAddress.toLower()} -errorAction STOP } catch { out-logfile -string "Unable to update the migrated cloud dl with the cross premises routing address." out-logfile -string $_ -isError:$TRUE } #This logic allows the code to be re-used when only the Office 365 information is available. if (($isRetry -eq $FALSE) -and ($originalDLConfiguration.cn.length -gt 0)) { out-logfile -string "Operation is not retried - use on premises value." [string]$functionCN=$originalDLConfiguration.CN.replace(' ','')+$functionMigratedByScript if ($functionCN.length -gt $functionMaxLength) { out-logfile -string "CalculatedCN is greater than 64 characters." $functionCN = (($originalDLConfiguration.CN.substring(0,($originalDLConfiguration.cn.length - $functionMigratedByScript.Length)))+$functionMigratedByScript) out-logfile -string ("Updated function CN: "+$functionCN) } } else { out-logfile -string "Operation is retried - use Office 365 value." [string]$functionCN=$office365DLConfiguration.alias.replace(' ','')+$functionMigratedByScript if ($functionCN.length -gt $functionMaxLength) { out-logfile -string "CalculatedCN is greater than 64 characters." (($office365DLConfiguration.CN.substring(0,($office365DLConfiguration.alias.length - $functionMigratedByScript.Length)))+$functionMigratedByScript) out-logfile -string ("Updated function CN: "+$functionCN) } } if (($isRetry -eq $FALSE) -and ($originalDLConfiguration.mail.length -gt 0)) { out-logfile -string "Operation is not retried - use on premises value." [array]$functionProxyAddressArray=$originalDLConfiguration.mail.split("@") } else { out-logfile -string "Operation is retried - use Office 365 value." if ($office365DLConfiguration.recipientTypeDetails -ne "GroupMailbox") { out-logfile -string "Office 365 group is normal - use windows email address." [array]$functionProxyAddressArray=$office365DLConfiguration.windowsEmailAddress.split("@") } else { out-logfile -string "Office 365 group is unified - use primary SMTP address." [array]$functionProxyAddressArray=$office365DLConfiguration.primarySMTPAddress.split("@") } } foreach ($member in $functionProxyAddressArray) { out-logfile -string $member } if ($originalDLConfiguration.displayName -ne $NULL) { [string]$functionDisplayName = $originalDLConfiguration.DisplayName+$functionMigratedByScript $functionDisplayName=$functionDisplayName.replace(' ','') } else { [string]$functionDisplayName = $office365DLConfiguration.DisplayName+$functionMigratedByScript $functionDisplayName=$functionDisplayName.replace(' ','') } [string]$functionName=$functionCN if ($originalDLConfiguration.name -ne $NULL) { [string]$functionFirstName = $originalDLConfiguration.Name out-logfile -string ("Function First Name: "+$functionFirstName) } else { [string]$functionFirstName = $office365DLConfiguration.Name out-logfile -string ("Function First Name: "+$functionFirstName) } [string]$functionLastName = $functionMigratedByScriptShort [boolean]$functionHideFromAddressList=$true [string]$functionRecipientDisplayType="6" [string]$functionMail=$functionProxyAddressArray[0]+$functionMigratedByScript+"@"+$functionProxyAddressArray[1] [string]$functionProxyAddress="SMTP:"+$functionMail if (($isRetry -eq $FALSE) -and ($originalDLConfiguration.mailNickName.length -gt 0)) { out-logfile -string "Operation is not retried - use on premises value." [string]$functionMailNickName=$originalDLConfiguration.mailNickName.replace(' ','')+$functionMigratedByScript if ($functionMailNickName.length -gt $functionMaxLength) { out-logfile -string "Calculated mail nickname is greater than 64 characters." $functionMailNickName = (($originalDLConfiguration.mailNickName.substring(0,($originalDLConfiguration.mailNickName.length - $functionMigratedByScript.Length)))+$functionMigratedByScript) out-logfile -string ("Updated function mail nickname: "+$functionMailNickName) } } else { out-logfile -string "Operation is retried - use Office 365 value." [string]$functionMailNickName=$office365DLConfiguration.alias.replace(' ','')+$functionMigratedByScript if ($functionMailNickName.length -gt $functionMaxLength) { out-logfile -string "Calculated mail nick name is greater than 64 characters." (($office365DLConfiguration.alias.substring(0,($office365DLConfiguration.alias.length - $functionMigratedByScript.Length)))+$functionMigratedByScript) out-logfile -string ("Updated function mail nick name: "+$functionMailNickName) } } [string]$functionDescription="This is the mail contact created post migration to allow non-migrated DLs to retain memberships and permissions settings. DO NOT DELETE" [string]$functionSelfAccountSid = "S-1-5-10" out-logfile -string ("Function display name = "+$functionDisplayName) out-logfile -string ("Function Name = "+$functionName) out-logfile -string ("Function First Name = "+$functionFirstName) out-logfile -string ("Function Last Name = "+$functionLastName) out-logfile -string ("Function hide from address list = "+$functionHideFromAddressList) out-logfile -string ("Function recipient display type = "+$functionRecipientDisplayType) out-logfile -string ("Function proxy address = "+$functionProxyAddress) out-logfile -string ("Function mail nickname = "+$functionMailNickname) out-logfile -string ("Function description = "+$functionDescription) out-logfile -string ("Function mail address = "+$functionMail) #Provision the routing contact. #When the contact is provisioned we add the master account sid of self. This tricks exchange commands into allowing us to assign permissions that are reserved for security principals. try { new-adobject -server $globalCatalogServer -type "Contact" -name $functionName -displayName $functionDisplayName -description $functionDescription -path $functionOU -otherAttributes @{givenname=$functionFirstName;sn=$functionLastName;mail=$functionMail;extensionAttribute1=$functionCustomAttribute1;extensionAttribute2=$functionCustomAttribute2;targetAddress=$functionTargetAddress;msExchHideFromAddressLists=$functionHideFromAddressList;msExchRecipientDisplayType=$functionRecipientDisplayType;proxyAddresses=$functionProxyAddress;mailNickName=$functionMailNickname;msExchMasterAccountSid=$functionSelfAccountSid;msExchPoliciesExcluded=$functionPoliciesExcluded} -credential $adCredential -authType $activeDirectoryAuthenticationMethod -errorAction STOP } catch { out-Logfile -string $_ -isError:$TRUE } Out-LogFile -string "END new-RoutingContact" Out-LogFile -string "********************************************************************************" } |