Public Folder Synchronization PowerShell Reference
File info: application/pdf · 58 pages · 1.20MB
Public Folder Synchronization PowerShell Reference
Full PDF Document
If the inline viewer fails, it will open the original document in compatibility mode automatically. You can also open the file directly.
Extracted Text
Quest� Migration Manager 8.15
Public Folder Synchronization (MAgE)
� 2020 Quest Software Inc. ALL RIGHTS RESERVED.
This guide contains proprietary information protected by copyright. The software described in this guide is furnished under a software license or nondisclosure agreement. This software may be used or copied only in accordance with the terms of the applicable agreement. No part of this guide may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording for any purpose other than the purchaser's personal use without the written permission of Quest Software Inc.
The information in this document is provided in connection with Quest Software products. No license, express or implied, by estoppel or otherwise, to any intellectual property right is granted by this document or in connection with the sale of Quest Software products. EXCEPT AS SET FORTH IN THE TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR THIS PRODUCT, QUEST SOFTWARE ASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORY WARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL QUEST SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTAL DAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS INTERRUPTION OR LOSS OF INFORMATION) ARISING OUT OF THE USE OR INABILITY TO USE THIS DOCUMENT, EVEN IF QUEST SOFTWARE HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Quest Software makes no representations or warranties with respect to the accuracy or completeness of the contents of this document and reserves the right to make changes to specifications and product descriptions at any time without notice. Quest Software does not make any commitment to update the information contained in this document.
If you have any questions regarding your potential use of this material, contact:
Quest Software Inc.
Attn: LEGAL Dept
4 Polaris Way
Aliso Viejo, CA 92656
Refer to our Web site (https://www.quest.com) for regional and international office information. Patents
Quest Software is proud of our advanced technology. Patents and pending patents may apply to this product. For the most current information about applicable patents for this product, please visit our website at https://www.quest.com/legal. Trademarks
Quest, the Quest logo, and Join the Innovation are trademarks and registered trademarks of Quest Software Inc. For a complete list of Quest marks, visit https://www.quest.com/legal/trademark-information.aspx. All other trademarks and registered trademarks are property of their respective owners. Legend
CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed.
IMPORTANT, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information.
Migration Manager Public Folder Synchronization (MAgE) Updated - September 2020 Version - 8.15
Contents
About This Document
5
How It Works
6
Before You Begin
8
Supported Configurations
8
System Requirements
8
Required Permissions
8
Considerations
13
Public Folder Synchronization
15
Managing Migration Agent for Exchange
15
Starting Synchronization
15
Mapping File Structure
17
Managing Public Folder Synchronization
17
Getting Synchronization Statistics
18
Tuning Statistics
18
Specific Case Workarounds
20
The public folder deleted
20
New top-level public folders added
20
Synchronizing public folders containing more than 10000 elements from Exchange 2010
21
Technical Reference
22
Cmdlet Reference
22
Get-MMExPublicFolderStatistics
23
Get-MMExAgent
25
Start-MMExPublicFolderMigration
26
Export-MMExPublicFolderMapping
30
Set-MMExGroupMatching
32
Import-MMExPublicFolderMapping
34
Initialize-MMExPublicFolderMigration
35
Restart-MMExPublicFolderMigration
37
Sync-MMExMailPublicFolder
39
Suspend-MMExPublicFolderMigration
42
Resume-MMExPublic FolderMigration
43
Remove-MMExPublicFolderMigration
44
Install-MMExAgent
45
Start-MMExAgent
46
Migration Manager 8.15 Public Folder Synchronization (MAgE)
3
Stop-MMExAgent
47
Repair-MMExAgent
48
Restart-MMExAgent
50
Uninstall-MMExAgent
51
Granting Permissions
52
Granting Read Permission to Microsoft Exchange Container
52
Granting the Public Folders Role
53
Granting the View-Only Configuration Role
53
Granting Read Permission for Each Public Folder
53
Granting CreateSubfolders and FolderVisible Access Rights for the Root Folder
53
Granting Full Access Permission for Public Folder to an account
54
Granting Owner Permissions for Each Public Folder
54
Office 365 account: Granting the Public Folders Role
54
Office 365 account: Granting the View-Only Configuration Role
55
Office 365 account: Granting Public Folder Owner Permission
55
Office 365 account: Granting CreateSubfolders and FolderVisible access rights
55
Using Task Scheduler to Automate Tasks
56
About us
58
Technical support resources
58
Migration Manager 8.15 Public Folder Synchronization (MAgE)
4
About This Document
This document help you perform public folders synchronization by enhanced Migration Agent for Exchange (MAgE) combined with extended MMEx PowerShell module instead of legacy agents in migration scenarios from Microsoft Exchange 2010/2013/2016/2019 to Microsoft Office 365 or Microsoft Exchange 2013/2016/2019.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
About This Document
5
How It Works
To synchronize public folders you can use enhanced Migration Agent for Exchange (MAgE) combined with enhanced MMEx PowerShell module instead of legacy agents in migration scenarios from Microsoft Exchange 2010/2013/2016/2019 to Microsoft Office 365 or to Microsoft Exchange 2013/ 2016/2019. This approach has lots of benefits including significantly increased performance, migration statistics right from the MMEx PowerShell module, more transparent set of required permissions, configuration, update and troubleshooting processes are simplified, etc. Enhanced MMEx PowerShell module complements Quest Migration Manager by synchronizing the mailenabled state and public folders directory properties.
IMPORTANT: To ensure permission synchronization you should set object matching for migrated by Quest Migration Manager for Active Directory (Microsoft Office 365) mail-enabled universal security distribution groups using Set-MMExGroupMatching cmdlet. Public folder synchronization process is collection-based. All public folders are included in one public folder collection Public Folder Collection (AgentHostName). Public folder collection properties are used as synchronization process properties. You can specify the direction that will be applied to all public folders:
l One-way, public folders are migrated from the source to the target, and then all source changes are periodically transferred to the target.
l Two-way, public folders are synchronized from the source to the target, and then source and target changes are synchronized.
Conflict resolution
Consider the following specifics on how conflicts will be resolved for migrated public folders after migration:
l In case both source and target messages / permissions are changed, source change will be used, target change will be discarded.
l In case there are no conflicts, any source change will be added to target, and then any target change will be added to source
Hierarchy changes handling
The following hierarchy changes can be handled automatically using folder ID:
l Public folder moved to another location l Public folder renamed l Public folder deleted. This change might need additional settings. Refer to The public folder deleted
for details. l New subfolder added to the public folder that are already included in the synchronization scope. All new
subfolders of public folders that are already included in synchronization scope will be detected and automatically added to the project. l New top-level public folders can be detected and added to migration automatically by MAgE using DetectNewTopLevelFolders parameter for Set-MMExProjectOptions cmdlet or you can add them manually. Refer to New top-level public folders added for details.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
How It Works
6
Migration Agent for Exchange at the beginning of the session detects a change of the full path of the source or the target public folder.
In case of change, Agent changes data in the project database to restart synchronization in next session and the following record is reported The folder path is changed. The folder will be processed in the next session.
In the next session, the new path will be reported in the Migration Agent log and in the statistics (GetMMExPublicFolderStatistics cmdlet). Synchronization will be restarted using new data.
Migration Agent for Exchange at the beginning of the session detects a change of the name of the source or the target public folder. If the target public folder renamed after the migration has been started, the GetMMExPublicFolderStatistics returns the System.Exception: Not Found error in Last error field.
In the next session, the new name will be reported in the MigrationAgent log and in the statistics (GetMMExPublicFolderStatistics cmdlet). Synchronization will be restarted using new data.
Refer to specific case workarounds for instructions on how to handle the rest of hierarchy changes.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
How It Works
7
Before You Begin
Before you begin migration to Microsoft Office 365, you need to provision user accounts in it. For that, use the Migration Manager for Active Directory (Office 365) console for migration to Office 365 or Migration Manager for Active Directory console for migration to Exchange 2019. The information about user matching is stored in the corresponding migration project database. It is important that you use the same migration project in the Migration Manager for Exchange console when you configure public folder synchronization. This document introduces a toolkit of Windows PowerShell cmdlets to support public folder synchronization for supported configurations.
Supported Configurations
This document is intended for the following migration scenarios supported by MAgE: To Exchange 2013 To Exchange 2016 Exchange 2019 To Office 365
From Exchange 2010
From Exchange 2013
From Exchange 2016
From Exchange 2019
System Requirements
Refer to System Requirements and Access Rights document for the Migration Agent for Exchange (MAgE) requirements.
Required Permissions
The administrative accounts used for public folder synchronization requires the following minimal permissions l Administrative account permissions required for target Office 365 organization l Administrative account permissions required for target Exchange 2016/2019 organization l Administrative account permissions required for source Exchange 2010 organization l Administrative account permissions required for source Exchange 2013/2016/2019 organization
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Before You Begin
8
Target Office 365 Account To set the target administrative account perform the following steps;
l Open Migration Manager Console l Right click Target Exchange Organization node of the Migration Manager Console management tree. l On General settings page specify Office 365 credentials to use as target administrative account.
IMPORTANT: The account assigned to be a target Office 365 administrative account used by Migration Agent for Exchange should meet the following requirements:
l Valid Microsoft Exchange Online license. This account should have a mailbox. l Default UPN
The following permissions are required for target Office 365 administrative account used by Migration Agent for Exchange during public folder synchronization:
Permission
Used for
Used by
How to Grant
The Public Folders management role
Getting access permissions MAgE and MMEX
to perform public folder
PowerShell module
migration
The View-Only Configuration
management role
Getting organization configuration data
MAgE and MMEX PowerShell module (GetOrganizationConfig)
Owner permission for each public folder you want to synchronize
Creating and syncing content and permissions (including Migration Manager Recycle Bin, if applicable)
MAgE and MMEX PowerShell module
CreateSubfolders and FolderVisible access rights to the root public folder folder ("\") *
Creating Migration Manager Recycle Bin folder
MAgE and MMEX PowerShell module
Office 365 account: Granting the Public Folders Role
Office 365 account: Granting the View-Only Configuration Role
Office 365 account: Granting Public Folder Owner Permission
Office 365 account: Granting CreateSubfolders and FolderVisible access rights to the root folder
Mail Recipients and Mail Enabled Public Folders management roles
Syncing Mail Public Folders properties
Distribution Groups management role
Syncing Public Folder Client permissions for Distribution Groups
MAgE and MMEX PowerShell module for SyncMMExMailPublicFolder
Office 365 account: Granting the Mail Recipients and Mail Enabled Public Folders Roles
MAgE and MMEX PowerShell module for SetMMExGroupMatching
Office 365 account: Granting the Distribution Groups Role
* it is required only to create Migration Manager Recycle Bin from MMEx PoSh scripts, but if admin created it manually, he/she can skip it. Make sure Exchange Organization Account has Owner client permission for Migration Manager Recycle Bin folder.
Notify your users that they should expect to see this account as the owner of their public folders. Consider setting an informative display name for this account.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Before You Begin
9
Target Exchange 2013/2016/2019 Organization Account
To set the target administrative account perform the following steps;
l Open Migration Manager Console l Right click Target Exchange Organization node of the Migration Manager Console management tree. l In Add Target Organization Wizard on the Specify Active Directory Domain page provide or change, if
necessary, the account credentials in the Logon As area and finish the wizard. This account will be used by MAgE for public folder synchronization.
CAUTION: Consider, in case you decide to change account in Mailbox Migration Job or Calendar Synchronization Job properties later, this account for access to Exchange will be used instead the target administrative account you specified using Add Source Organization Wizard. To avoid any issues, it is not recommended to use multiple administrative accounts.
IMPORTANT: The account assigned to be a target administrative account used by Migration Agent for Exchange should have a mailbox. The following permissions are required for target Exchange account used by Migration Agent for Exchange during public folder synchronization:
Permission
Used for
Read permission for the Microsoft Exchange container in the Configuration
partition of source Active Directory (including all descendant objects)
Adding source Exchange organization using the Add Source Organization Wizard
The Public Folders
management role
Getting access permissions to perform public folder migration
The View-Only Configuration
management role
Getting organization configuration data
Used by MMEx console
MAgE and MMEX PowerShell module MAgE and MMEX PowerShell module (GetOrganizationConfig)
Owner permission for each public folder you want to synchronize
Creating and syncing content and permissions (including Migration Manager Recycle Bin, if applicable)
CreateSubfolders and FolderVisible access rights to the root public folder folder ("\") *
Creating Migration Manager Recycle Bin folder
Mail Recipients Syncing Mail Public Folders and Mail Enabled properties Public Folders
MAgE and MMEX PowerShell module
MAgE and MMEX PowerShell module
MAgE and MMEX PowerShell module for Sync-
How to Grant
Granting Read Permission to Microsoft Exchange Container
Granting the Public Folders Role
Granting the ViewOnly Configuration Role
Granting Owner permissions for each Public Folder
Granting CreateSubfolders and FolderVisible access rights to the root folder
Granting the Mail Recipients and Mail Enabled
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Before You Begin
10
Permission
management roles
Used for
Used by MMExMailPublicFolder
How to Grant
Public Folders Roles
* It is required only to create Migration Manager Recycle Bin from MMEx PoSh scripts, but if admin created it manually, he/she can skip it. Make sure Exchange Organization Account has Owner client permission for Migration Manager Recycle Bin folder. Notify your users that they should expect to see this account as the owner of their public folders. Consider setting an informative display name for this account.
Source Exchange 2010 Account
To set the source administrative account perform the following steps;
l Open Migration Manager Console
l Right click Source Exchange Organization node of the Migration Manager Console management tree.
l In Add Source Organization Wizard on the Specify Active Directory Domain page provide or change, if necessary, the account credentials in the Logon As area and finish the wizard. This account will be used by MAgE for public folder synchronization.
NOTE: Consider, in case you decide to change account in Mailbox Migration Job or Calendar Synchronization Job properties later, this account for access to Exchange will be used instead the source administrative account you specified using Add Source Organization Wizard. To avoid any issues, it is recommended to select one administrative account to use.
IMPORTANT: The account assigned to be a source administrative account used by Migration Agent for Exchange should have a mailbox.
The following permissions are required for source Exchange 2010 administrative account used by Migration Agent for Exchange during public folder synchronization:
Permission
Used for
Used by How to Grant
Read permission for the Microsoft Exchange container in the Configuration partition of the source Active Directory (including all descendant objects
Adding source Exchange organization using the Add Source Organization Wizard
MMEx console
Granting Read Permission to Microsoft Exchange Container
The Public Folders management role
Getting access permissions to perform public folder migration
MAgE and MMEX PowerShell module
Granting the Public Folders Role
Owner permission for each public folder you want to synchronize*.
Creating and syncing content and permissions (including Migration Manager Recycle Bin, if applicable)
MAgE and MMEX PowerShell module
Granting Owner Permission for Public Folders
Full access right to the root public folder folder ("\") **
Creating Migration Manager Recycle Bin folder
MAgE and MMEX PowerShell module
Granting Full Access Permission of public folder to an account
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Before You Begin
11
TIP:
* In case the one-way synchronization is selected, at least Read permission for each public folder you want to synchronize can be granted to make permissions more granular.
** It is required only to create Migration Manager Recycle Bin from MMEx PoSh scripts, but if admin created it manually, he/she can skip it. Make sure Exchange Organization Account has Owner client permission for Migration Manager Recycle Bin folder.
Source Exchange 2013/2016/2019 Organization Account
To set the source administrative account perform the following steps;
l Open Migration Manager Console l Right click Source Exchange Organization node of the Migration Manager Console management tree. l In Add Source Organization Wizard on the Specify Active Directory Domain page provide or change,
if necessary, the account credentials in the Logon As area and finish the wizard. This account will be used by MAgE for public folder synchronization.
NOTE: Consider, in case you decide to change account in Office 365 Mailbox Migration Job or Office 365 Calendar Synchronization Job properties later, this account for access to Exchange will be used instead the source administrative account you specified using Add Source Organization Wizard. To avoid any issues, it is recommended to select one administrative account to use.
IMPORTANT: The account assigned to be a source administrative account used by Migration Agent for Exchange should have a mailbox. The following permissions are required for source Exchange 2013/2016/2019 administrative account used by Migration Agent for Exchange during public folder synchronization:
Permission
Used for
Used by
How to Grant
Read permission for the Microsoft Exchange container in the Configuration partition of the source Active Directory (including all descendant objects)
Adding source Exchange organization using the Add Source Organization Wizard
MMEx console
The Public Folders management role
Getting access permissions to perform public folder migration
MAgE and MMEX PowerShell module
Owner permission for each public folder you want to synchronize.
Creating and syncing content and permissions (including Migration Manager Recycle Bin, if applicable)
MAgE and MMEX PowerShell module
The View-Only Configuration management role*
Creating and syncing content and permissions (including Migration Manager Recycle Bin, if applicable)
MAgE and MMEX PowerShell module
Granting Read Permission to Microsoft Exchange Container
Granting the Public Folders Role
Granting Owner permissions for each Public Folder
Granting the View-Only Configuration Role
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Before You Begin
12
Permission
Used for
CreateSubfolder and
Creating Migration
FolderVisible access rights to Manager Recycle
the root public folder ("\") ** Bin folder
Used by
How to Grant
MAgE and MMEX PowerShell module
Granting CreateSubfolders and FolderVisible access rights to the root folder
TIP:
* In case the one-way synchronization is selected, at least Read permission for each public folder you want to synchronize can be granted to make permissions more granular.
** It is required only to create Migration Manager Recycle Bin from MMEx PoSh scripts, but if admin created it manually, he/she can skip it. Make sure Exchange Organization Account has Owner client permission for Migration Manager Recycle Bin folder.
Considerations
Refer to Specific Case Workarounds for instructions on how to resolve the specific cases related to public folder hierarchy changes.
l Before you migrate public folders to Microsoft Office 365 keep in mind the following cases:
a. During synchronization of pubic folders with Microsoft Office 365 Exchange Online, MAgE is unable to set the message owner (creator) correctly for items in folders. The administrative account becomes the creator of the message instead of the actual mailbox owner. This causes unwanted effects on the target. For example, the user cannot modify and delete their own migrated messages unless they have Owner permissions on the containing folder. This behavior is a result of Exchange and Office 365 architecture aimed at preventing security risks.
b. A single MAgE instance performs all migration to Office 365.
c. To sync the source SMTP public folder address, you need to add a custom email domain as an accepted domain for your target Exchange organization. Then, you could sync proxy addresses using ProxyAddresses parameter of Sync-MMExMailPublicFolder.
d. The migrated public folders always inherit the client permissions from this root folder. To avoid granting unnecessary privileges, make sure that the client permissions for the target root folder are granted to the administrative account only before starting the migration.
e. MAgE cannot automatically handle the following change in public folder hierarchy in some specific cases. Refer to New top-level public folders added for details
Refer to Specific Case Workarounds for instructions on how to resolve the issues related to public folder hierarchy change.
e. Public folders matched with deleted (soft or hard deleted) public folders by default are moved to source or target Migration Manager Recycle Bin public folders. If the Migration Manager Recycle Bin public folder does not exist , it will be created automatically. Refer to The public folder deleted for details.
f. Mail-enabled source folders are synchronized as non-mail-enabled to Office 365. As a
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Before You Begin
13
workaround, use Sync-MMExMailPublicFolder to make the target folders mail-enabled and set directory properties for them.
g. To ensure permission synchronization you should set object matching for migrated by Quest Migration Manager for Active Directory (Microsoft Office 365) mail-enabled universal security distribution groups using Set-MMExGroupMatching cmdlet.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Before You Begin
14
Public Folder Synchronization
This section help you to perform the following tasks related to the public folder synchronization using PowerShell cmdlet toolkit:
l Managing Migration Agent for Exchange l Configuring and starting public folder synchronization l Managing public folder synchronization for specified objects l Monitoring public folder synchronization l Specific case workarounds
Managing Migration Agent for Exchange
The following cmdlets help you to manage Migration Agent for Exchange (MAgE): l Install-MMExAgent l Get-MMExAgent l Start-MMExAgent l Stop-MMExAgent l Repair-MMExAgent l Restart-MMExAgent l Uninstall-MMExAgent
Starting Synchronization
After the user accounts were successfully provisioned and calendars were successfully synchronized with Microsoft Exchange Online, you can synchronize public folders if necessary. It is recommended to synchronize public folders before you start to migrate mailboxes. Before the users are migrated to the new environment, you need to copy the contents of the public folders to the new servers. This will ensure that the first migrated user will have access to up-to-date public folder information. Two modes are now available:
l Simple mode with minimal customization l Advanced mode The following synchronization directions can now be selected to start synchronization process: l One-way synchronization from source to target. All changes on the target will not be synchronized. l Two-way synchronization between source and target. All changes will be synchronized.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Public Folder Synchronization
15
This parameter can be set before migration project initialization using StartMMExPublicFolderMigrationor Initialize-MMExPublicFolderMigration cmdlets. Synchronization direction cannot be changed after initialization
To start public folder synchronization in simple mode, take the following steps:
1. Register the Source and Target organizations in Migration Manager Console 2. Verify that the host meets the requirements described in System Requirements. 3. Run MMExPowerShell module as described in Configuring Migration Using PowerShell. 4. Call Start-MMExPublicFolderMigration cmdlet for your source and target organizations. By default, all
public folders from source organization will be added to synchronization job and synchronized to target . Refer to Start-MMExPublicFolderMigration for information on how you can limit the synchronization scope and for parameters you can set.
The following actions will be performed during the Start-MMExPublicFolderMigration execution with default settings:
l Migration Agent for Exchange (MAgE) will be installed on the host by Install-MMExAgent cmdlet in case it is not already installed.
l Object matching will be set for mail-enabled universal security distribution groups (Microsoft Office 365 only) by Set-MMExGroupMatching cmdlet.. Object matching is required to synchronize client permissions of these distribution groups. You can schedule this task using Task Scheduler. For details refer to Using Task Scheduler to Automate Tasks.
l A mapping file for synchronization will be generated by Export-MMExPublicFolderMapping cmdlet. All public folders from the source organization will be included in this mapping file.
l The mapping file will be used to create the empty public folders in the target organization by ImportMMExPublicFolderMapping cmdlet. Public folder structure and naming will fully match the source public folder hierarchy.
l Project database for synchronization of public folders will be prepared using InitializeMMExPublicFolderMigration cmdlet.
l Migration Agent for Exchange (MAgE) will be started by Start-MMExAgent cmdlet. l Target public folders will be mail-enabled in case matched source public folders are mail-enabled using
Sync-MMExMailPublicFolder. You can schedule this task using Task Scheduler. For details refer to Using Task Scheduler to Automate Tasks.
TIP: To synchronize proxy addresses, Send As permissions, Send On Behalf permissions, alias, simple display name properties for these public folders call Sync-MMExMailPublicFolder again with necessary settings after the Start-MMExPublicFolderMigration execution.
To start public folder synchronization in advanced mode, take the following steps:
1. Register the Source and Target organizations in Migration Manager Console 2. Verify that the host meets the requirements described in System Requirements. 3. Run MMExPowerShell module as described in Configuring Migration Using PowerShell. 4. Install Migration Agent for Exchange (MAgE) using Install-MMExAgent cmdlet.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Public Folder Synchronization
16
5. Call Set-MMExGroupMatching cmdlet for your source and target organizations to set object matching for migrated by Quest Migration Manager for Active Directory (Microsoft Office 365 only) mail-enabled universal security distribution groups.
6. Call Export-MMExPublicFolderMappingcmdlet for your source organization to generate a mapping file for synchronization.
7. Call Import-MMExPublicFolderMapping cmdlet for your target organization to create the empty public folders in the target organization according to the mapping file from the previous step.
8. Stop MAgE using Stop-MMExAgent cmdlet in case it is started. 9. Prepare project database for synchronization of public folders by calling Initialize-
MMExPublicFolderMigration cmdlet. 10. Mail-enable target public folders in case matched source public folders are mail-enabled and
synchronize proxy addresses, Send As permissions, Send On Behalf permissions, alias, simple display name properties for these public folders using Sync-MMExMailPublicFolder. 11. Start MAgE using Start-MMExAgent cmdlet to start synchronization. 12. Call Get-MMExPublicFolderStatistics cmdlet to get synchronization statistics and monitor the process.
Mapping File Structure
The mapping is CSV file with the following fields:
l SourceFolder field contains full path to source public folder, e.g.: in the following format: \CustomRoot\folder1
l SourcePFMailbox field contains source public folder mailbox associated with source public folder. It is empty in case Exchange 2010 on source.
l FolderSize specifies size of the source public folder. l FolderClass specifies class of the source public folder. The following valued are available: <values>. l TargetFolder field contains full path to paired target public folder in the following format:
\CustomRoot\folder1. l TargetPFMailbox contains target public folder mailbox associated with target public folder.
Managing Public Folder Synchronization
To manage public folder synchronization, use the following cmdlets:
To manage mail-enabled settings and directory properties
l The Restart-MMExPublicFolderMigration cmdlet searches the source for mail-enabled public folders, sets matched target public folders as mail-enabled, and synchronizes Active Directory properties of these public folder.
You can schedule this task using Task Scheduler. For details refer to Using Task Scheduler to Automate Tasks.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Public Folder Synchronization
17
To manage synchronization process for specified folders
l The Restart-MMExPublicFolderMigration cmdlet restarts migration for specified public folders. You can resynchronize content and permissions or permissions only.
l The Suspend-MMExPublicFolderMigration cmdlet suspends migration for specified public folders. l The Resume-MMExPublic FolderMigration cmdlet resumes suspended migration for specified
public folders. l The Remove-MMExPublicFolderMigration cmdlet is intended for troubleshooting purposes only.
Temporarily removes the public folder from the migration project and cleans all associated data in the migration project database to process this source public folder anew..
To monitor synchronization process
l The Get-MMExPublicFolderStatistics cmdlet gets synchronization statistics that can be used for all actions specified above as described in Tuning Statistics
Getting Synchronization Statistics
You can get public folder synchronization statistics using the Get-MMExPublicFolderStatistics cmdlet. To understand how to configure statistics and how to use it refer to Tuning Statistics.
IMPORTANT: Currently, regardless of which direction of synchronization is selected, all counters display source item statistics. But you can track all events, if any.
You can get information about public folder collection using Get-MMExPublicFolderStatistics cmdlet. Currently there is only one public folder collection.
Tuning Statistics
To select what information can be retrieved by cmdlet, use the following command: Get-MMExPublicFolderStatistics | fl The list of available fields is displayed.
TIP: Some hidden fields, like IsSuspended are not displayed, but can be used, as described below.
To obtain a list public folders to see for what folders synchronization is suspended, run cmdlet Get-MMExPublicFolderStatistics as follows: Get-MMExPublicFolderStatistics | select Path, DisplayName, IsSuspended.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Public Folder Synchronization
18
How to use with PowerShell Out-GridView
You can select type of statistics data to display: Get-MMExPublicFolderStatistics | select Path, Progress, DiscoveredItems, ProcessedItems, FailedItems, LastProcessedTime, LastError, DisplayName, FolderID | Out-GridView This command display statistics for the public folder including the following data:
l Path specifies the location of the folder in the folder hierarchy, for example, \Legal\Cases. l Progress specifies current synchronization progress of a public folder. It is calculated as the ratio of
number of items already processed by the agent to the total number of discovered items. Note that this number can also decrease when, for example, a new content is added causing number of discovered items to increase. l DiscoveredItems specifies the number of items discovered in the public folder l ProcessedItems specifies the number of the number of items processed in the public folder l FailedItems specifies the number of the number of items that failed to be processed in the public folder l LastProcessedTime specifies timestamp that indicates when last processing of a public folder was completed. The time zone is the same as used in console. l LastError specifies the error message of the last appeared error (if any) in the current or previous migration sessions. After the error is fixed, the fields gets cleared. l DisplayName specifies displayName property of a user who owns the public folder l FolderID specifies public folder identifier
How to use with PowerShell Out-GridView -PassThru
To initiate resynchronization for the public folders that match selected criteria, take the following actions: Request statistics using Get-MMExPublicFolderStatistics, select problem folders, press OK
Get-MMExPublicFolderStatistics | select Path, Progress, DiscoveredItems, ProcessedItems, FailedItems, LastProcessedTime, LastError, DisplayName, FolderID | Out-GridView -PassThru |Restart-MMExPublicFolderMigration
Migration was restarted for the item 'F1' (#7) from the collection 'PFColl_DMMCONSOLE' (#2). Migration was restarted for the item 'IPM_SUBTREE' (#4) from the collection 'PFColl_DMMCONSOLE' (#2). Migration was restarted for the item 'Root01' (#6) from the collection 'PFColl_DMMCONSOLE' (#2).
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Public Folder Synchronization
19
Specific Case Workarounds
IMPORTANT: Public Folders are matched by their EntryId values. Source EntryID and target EntryID pairs are stored in project database. In case of any EntryID change, refer to this section to work it around manually. The following cases might need additional settings:
l The public folder deleted
The following cases need to be worked around manually:
l New top-level public folders added
Resolving the public folder synchronization issues for specific environments:
l Synchronizing public folders containing more than 10000 elements from Exchange 2010
The public folder deleted
If the source or target public folder deleted (hard or soft), the deleted public folder be handled automatically depending on the UsePublicFolderRecycleBin parameter of migration project. The following cases are possible:
l If source public folder has been deleted including all subfolders and migration project parameter UsePublicFolderRecycleBin set as True (default), then matched target public folder with all subfolders will be moved to the target Migration Manager Recycle Bin folder. If the Migration Manager Recycle Bin public folder does not exist, it will be created automatically. In case the Migration Manager Recycle Bin folder already contains the deleted public folder, both versions will be retained, but a later version will have an added number tag for the folder name.
l If target public folder has been deleted including all subfolders, and migration project parameter UsePublicFolderRecycleBin set as True, and two-way synchronization is enabled, all matched source public folder with all subfolders will be moved to the source Migration Manager Recycle Bin folder. If the Migration Manager Recycle Bin public folder does not exist, it will be created automatically. In case the Migration Manager Recycle Bin folder already contains this deleted public folder, both versions will be retained, but a later version will have an added number tag for the folder name.
l If public folder has been deleted in source and target, this deleted folder will not appear in source and target Migration Manager Recycle Bin folder.
TIP: To avoid storing deleted public folders, set UsePublicFolderRecycleBin to False.
New top-level public folders added
After migration starts, new top-level public folders that are added need to be synchronized. New top level public folders can be detected and added to migration automatically by MAgE using DetectNewTopLevelFolders parameter for Set-MMExProjectOptions cmdlet. Both of the following conditions should be satisfied:
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Specific Case Workarounds
20
l IPM_SUBTREE should be configured as public folder synchronization root folder. New top-level public folders will be detected on source (and target, respectively) only IPM_SUBTREE is processed by the MAgE
l DetectNewTopLevelFolders parameter should be set to True for current project.
For details refer to Configuring Migration Using PowerShell. NOTE: If for some reason it is not acceptable to use DetectNewTopLevelFolders, but certain source top level folder with subfolders needs to be migrated, use procedure described below. Here are some examples of cases where this approach should be used: target organization contains top-level folders that are not supposed to be synced back to source, or only particular source top level folders should be migrated.
Take the following steps to synchronize the new top-level public folder manually:
1. Call Stop-MMExAgent -Type PublicFolder -AgentHost <agent host name> 2. Prepare updated CSV file using Export-MMExPublicFolderMapping cmdlet, you can also create new
CSV file (only new folder can be included) manually.
3. Call Import-MMExPublicFolderMappingcmdlet using updated CSV file. 4. Call Stop-MMExAgent -Type PublicFolder -AgentHost <agent host name> to stop MAgE
before synchronization start. 5. Call Initialize-MMExPublicFolderMigration cmdlet using updated CSV file. 6. Call Start-MMExAgent -Type PublicFolder -AgentHost <agent host name> to start
synchronization.
You can see these added public folders in the statistics with Get-MMExPublicFolderStatistics.
Synchronizing public folders containing more than 10000 elements from Exchange 2010
This section is applicable in case Microsoft Exchange 2010 as source. In case source public folder contains more than 10000 elements it can take a while to gather necessary information related to content. It may cause MAgE cannot read necessary information or fails to transfer the content of such folders. In case the Progress value for a public folder returned by GetMMExPublicFolderStatistics does not grow, and this public folder contains more than 10000 elements, you can take the following actions:
l Reduce the number of elements in a folder by dividing into several public folders
-OR-
l In Public Folder Management console open the public folder properties to clear Maintain per-user read and unread information for this folder option until the migration is complete.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Specific Case Workarounds
21
Technical Reference
l Cmdlet Reference l Granting permissions
Cmdlet Reference
This is a collection of Windows PowerShell cmdlets to perform public folder synchronization for supported configurations: Starting public folder migration in simple mode with minimal customization
l Start-MMExPublicFolderMigration Configuring public folder synchronization in advanced mode
l Set-MMExGroupMatching (Microsoft Office 365 only) l Export-MMExPublicFolderMapping l Import-MMExPublicFolderMapping l Initialize-MMExPublicFolderMigration l Sync-MMExMailPublicFolder Managing public folder synchronization (granular synchronization) l Restart-MMExPublicFolderMigration l Suspend-MMExPublicFolderMigration l Resume-MMExPublic FolderMigration l Remove-MMExPublicFolderMigration l Restart-MMExPublicFolderMigration Monitoring public folder synchronization l Get-MMExPublicFolderStatistics l Get-MMExAgent Managing Migration Agent for Exchange (MAgE) l Install-MMExAgent l Get-MMExAgent l Start-MMExAgent l Stop-MMExAgent l Repair-MMExAgent l Restart-MMExAgent l Uninstall-MMExAgent
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
22
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).
Get-MMExPublicFolderStatistics
Gets synchronization statistics of public folders.
Detailed Description
The Get-MMExPublicFolderStatistics cmdlet gets synchronization statistics of public folders. The obtained information can be then exported to a CSV file. See Tuning Statistics to use full functionality of this cmdlet.
Syntax
Get-MMExPublicFolderStatistics [-FolderPath] <String> [<CommonParameters>]
Examples
Example 1 Get-MMExPublicFolderStatistics
This command gets statistics of all public folders in the Migration Manager for Exchange project.
Example 2
Get-MMExPublicFolderStatistics |?{$_.SourcePath -eq '\Folder1'} | fl
This command gets detailed statistics of the public folder \Folder1:
Folder Id
: 9
Collection Id
: 1
Source Name
: Folder1
Source Path
: \Folder1
Source EntryId
:
0x0000000093BDFE1CB63DD74E94AD8A0CD0028A730100F9B5E1322292134898CB269CC88977F40000B384
1FE50000
Target Path
: \Folder1
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
23
Target EntryId
:
0x000000001A447390AA6611CD9BC800AA002FC45A03009521443180DC7248BBA93A26524A992600009DF9
A4030000
Progress
: 100
Discovered Items : 463
Processed Items
: 463
Failed Items
: 0
Last Processed Time : 2019-07-02T15:47:35Z
Last Error
:
Example 3 Get-MMExPublicFolderStatistics | Out-GridView
This command gets statistics of all public folders in the Migration Manager for Exchange project and then sends the output to an interactive table in a separate window.
Example 4 Get-MMExPublicFolderStatistics |?{$_.Progress -eq 100} This command gets synchronization statistics of the public folders that have progress = 100%.
Example 5 Get-MMExPublicFolderStatistics | ?{$_.Path -like "\PF_Root\*"} This command gets statistics of the public folders that have path like = '\PF_Root\*'.
Example 6 Get-MMExPublicFolderStatistics | ?{$_.Path -like "\PF_Root\*"} | Export-Csv NoTypeInformation -Encoding UTF8 -Path "C:\MMEx\export.csv"
This command gets statistics of the public folders and export it to the export.csv file.
Parameters
-FolderPath The full path to the public folder to obtain statistics.
Required? Position? Default value Accept pipeline input? Accept wildcard characters?
false 1 none false false
<CommonParameters>
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
24
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, see about_CommonParameters.
Inputs
FolderPath
Outputs
Grid view CSV file
Get-MMExAgent
Gets parameters of specified Agents.
Detailed Description
The Get-MMExAgent cmdlet gets parameters of one or more Agents specified by the Agent Host and type.
Syntax
Get-MMExAgent -Type PublicFolder -AgentHost <hostname>
Parameters
-Type
Specifies the agent type, currently only 'PublicFolder' is allowed.
Required? Position?
false 1
Default value Accept pipeline input? Accept wildcard characters?
PublicFolder false false
-AgentHost
Specifies host name to install specified agent. TIP: If this parameter is not specified, the agent will be installed on the local server (localhost)..
Required? Position? Default value
false 2 localhost
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
25
Accept pipeline input? Accept wildcard characters?
false false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, see about_CommonParameters.
Examples
Example 1 Get-MMExAgent -Type PublicFolder This command gets all Public Folder agents. Example 2 Get-MMExAgent -AgentHost 'dmmconsole' This command gets all agents from Agent host 'dmmconsole'.
Example 3 Get-MMExAgent -Type PublicFolder -AgentHost 'dmmconsole' This command gets all Public Folder agents from Agent host 'dmmconsole'.
Start-MMExPublicFolderMigration
Starts public folders migration process in express-mode with minimal customization.
Detailed Description
The Start-MMExPublicFolderMigration cmdlet consequentially executes Install-MMExAgent, SetMMExGroupMatching, Export-MMExPublicFolderMapping, Import-MMExPublicFolderMapping, InitializeMMExPublicFolderMigration, Start-MMExAgent and Sync-MMExMailPublicFolder. This command should be executed after source and target organizations are added to migration project.
Syntax
Start-MMExPublicFolderMigration -SourceOrganization <source organization name (as displayed in tree-view)> -TargetOrganization <target organization name (as displayed in tree-view)> [-Direction] [-TargetMailboxSize <size limit>] [-TargetRootFolderName <root folder name>] [-TargetMailboxNameTemplate <mailbox name prefix>] [-MigrateOnly <root folder name>] [-SkipGroupMatching] [-SkipSyncMailPublicFolders]
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
26
Examples
Example 1 Start-MMExPublicFolderMigration -SourceOrganization 'My Source Organization' TargetOrganization 'My Target Organization'
This command starts public folder migration from 'My Source Organization' organization to 'My Target Organization' organization.
Example 2 Start-MMExPublicFolderMigration -SourceOrganization 'My Source Organization' TargetOrganization 'My Target Organization' -TargetMailboxSize 2GB
This command calculates the number of mailboxes necessary to handle source public folder structure considering 2GB size limit for target folder mailboxes, and starts public folder migration from 'My Source Organization' organization to 'My Target Organization' organization.
Example 3 Start-MMExPublicFolderMigration -SourceOrganization 'My Source Organization' TargetOrganization 'My Target Organization' -TargetMailboxNameTemplate "BrandNewMailbox"
This command calculates the number of mailboxes necessary to handle source public folder structure, and starts public folder migration from 'My Source Organization' organization to 'My Target Organization' organization. Target public folder mailboxes will be named like BrandNewMailbox plus numeric index.
Example 4 Start-MMExPublicFolderMigration -SourceOrganization 'My Source Organization' TargetOrganization 'My Target Organization' -TargetRootFolderName "CustomRoot"
This command calculates the number of mailboxes necessary to handle source public folder structure, and starts public folder migration from 'My Source Organization' organization to 'My Target Organization' organization. Target public folders hierarchy will reside in the root folder named "CustomRoot".
Example 5 Start-MMExPublicFolderMigration -SourceOrganization 'My Source Organization' TargetOrganization 'My Target Organization' - MigrateOnly "\Marketing"
This command calculates the number of mailboxes necessary to handle source public folder structure within \Marketing root, and starts public folder migration from 'My Source Organization' organization to 'My Target Organization' organization.
Example 6 Start-MMExPublicFolderMigration -SourceOrganization 'My Source Organization' TargetOrganization 'My Target Organization' - Direction TwoWay
This command starts 2-way synchronization of public folders between 'My Source Organization' organization and 'My Target Organization' organization.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
27
Parameters
-SourceOrganization
Specifies the source organization from which mail-enabled universal security distribution groups will be migrated.
Required? Position? Default value Accept pipeline input? Accept wildcard characters?
-TargetOrganization
true 1 none false false
Specifies the target organization to which mail-enabled universal security distribution groups will be migrated.
Required? Position? Default value Accept pipeline input? Accept wildcard characters?
-TargetMailboxSize
true 2 none false false
Specifies maximum size allowed for target public folder mailbox.
Required?
false
Position?
3
Default value
15GB
Accept pipeline input?
false
Accept wildcard characters?
false
-Direction
Specifies public folder synchronization direction. The following values are available:
l OneWay - 1-way public folder synchronization l TwoWay - 2-way public folder synchronization
IMPORTANT: This decision applies to the current migration project and cannot be changed later. In case this parameter is not set you will be prompted to make this selection during initialization.
Required? Position? Default value
false 4 none
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
28
Accept pipeline input? Accept wildcard characters?
false false
-TargetRootFolderName
Specifies name of a folder that will contain migrated public folders on target
Required?
false
Position?
5
Default value
none
Accept pipeline input?
false
Accept wildcard characters?
false
-TargetMailboxNameTemplate
Specifies naming template for target public folders mailboxes.
Required?
false
Position?
6
Default value
PfMigrationMailbox
Accept pipeline input?
false
Accept wildcard characters?
false
-MigrateOnly
Limits migration scope by specifying source public folder root to migrate. NOTE: This parameter requires setting of the TargetMailboxNameTemplate parameter.
Required? Position? Default value Accept pipeline input? Accept wildcard characters?
false 7 none false false
SkipGroupMatching
Specifies if object matching for migrated by Quest Migration Manager for Active Directory (Microsoft Office 365)
mail-enabled universal security distribution groups will be skipped.
Required?
false
Position?
8
Default value
false
Accept pipeline input?
false
Accept wildcard characters?
false
SkipSyncMailPublicFolder
Specifies if mail-enabling of target public folders and setting directory properties for them will be skippedt.
Required?
false
Position?
9
Default value
false
Accept pipeline input?
false
Accept wildcard characters?
false
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
29
Inputs
SourceOrganization TargetOrganization TargetMailboxSize (optional) TargetRootFolderName (optional) TargetMailboxNameTemplate (optional) MigrateOnly (optional) SkipGroupMatching (optional) SkipSyncMailPublicFolder (optional)
Export-MMExPublicFolderMapping
Exports public folder configuration and calculated mapping between source and target public folder mailboxes into comma-separated values (CSV) file.
Detailed Description
The Export-MMExPublicFolderMapping cmdlet calculates the number of mailboxes necessary to handle source public folder structure according to specified size requirements, and exports public folder configuration and mapping between source and target public folder mailboxes into comma-separated values (CSV) file. This operation is required to prepare public folder synchronization and in case of changes in source public folder hierarchy as described in Specific Case Workarounds
Syntax
Export-MMExPublicFolderMapping -SourceOrganization <source organization name (as displayed in tree-view)> -MappingFilePath <path and filename for the output CSV file> [-TargetMailboxSize <size limit>] [-TargetMailboxNameTemplate <mailbox name prefix>] [-TargetRootFolderName <root folder name>]
Examples
Example 1 Export-MMExPublicFolderMapping -SourceOrganization 'My Source Organization' MappingFilePath MigrationMapping.csv
This command calculates the number of mailboxes necessary to handle source public folder structure, and writes public folder configuration and mapping for public folder migration from 'My Source Organization' organization to "MigrationMapping.csv file.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
30
Example 2
Export-MMExPublicFolderMapping -SourceOrganization 'My Source Organization' MappingFilePath MigrationMapping.csv -TargetMailboxSize 2GB
This command calculates the number of mailboxes necessary to handle source public folder structure considering 2GB size limit for target folder mailboxes, and writes public folder configuration and mapping for public folder migration from 'My Source Organization' organization to "MigrationMapping.csv file.
Example 3
Export-MMExPublicFolderMapping -SourceOrganization 'My Source Organization' MappingFilePath MigrationMapping.csv -TargetMailboxNameTemplate "BrandNewMailbox"
This command calculates the number of mailboxes necessary to handle source public folder structure, and writes public folder configuration and mapping for public folder migration from 'My Source Organization' organization to "MigrationMapping.csv file. Target public folder mailboxes will be named like BrandNewMailbox plus numeric index.
Example 4
Export-MMExPublicFolderMapping -SourceOrganization 'My Source Organization' MappingFilePath MigrationMapping.csv -TargetRootFolderName "CustomRoot"
This command calculates the number of mailboxes necessary to handle source public folder structure, and writes public folder configuration and mapping for public folder migration from 'My Source Organization' organization to "MigrationMapping.csv file. Target public folders hierarchy will reside in the root folder named "CustomRoot".
Parameters
-SourceOrganization
Specifies the source organization from which mail-enabled universal security distribution groups will be migrated.
Required? Position? Default value Accept pipeline input? Accept wildcard characters?
true 1 none false false
-MappingFilePath
Specifies the full path for the output CSV file to be generated.
TIP: If only file name is specified for CSV file, then the output file will be generated in the current directory.
Required? Position? Default value
true 2 none
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
31
Accept pipeline input? Accept wildcard characters?
false false
-TargetMailboxSize
Specifies maximum size allowed for target public folder mailbox.
Required?
false
Position?
3
Default value
15GB
Accept pipeline input?
false
Accept wildcard characters?
false
-TargetMailboxNameTemplate
Specifies naming template for target public folders mailboxes.
Required?
false
Position?
3
Default value
PfMigrationMailbox
Accept pipeline input?
false
Accept wildcard characters?
false
-TargetRootFolderName
Specifies name of a folder that will contain migrated public folders on target
Required?
false
Position?
3
Default value
none
Accept pipeline input?
false
Accept wildcard characters?
false
Inputs
SourceOrganization MappingFilePath TargetMailboxSize TargetMailboxNameTemplate TargetRootFolderName
Outputs
CSV file
Set-MMExGroupMatching
Sets object matching for migrated by Quest Migration Manager for Active Directory (Microsoft Office 365 only) mail-enabled universal security distribution groups. This cmdlet cannot be used for on-premises targets. This task can be scheduled as described in Using Task Scheduler to Automate Tasks
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
32
Detailed Description
The Set-MMExGroupMatching mdlet searches the source organization My Source Organization for mailenabled universal security distribution groups and then copies legacyExchangeDN of each source group as an X500 address for migrated target group to set object matching. It is required to synchronize client permissions of these distribution groups.
CAUTION: This command should be performed before starting the public folder migration process. It is recommended to repeat this command in case a new mail-enabled universal security distribution group is added.
Syntax
Set-MMExGroupMatching -SourceOrganization <source organization name (as displayed in tree-view)> -TargetOrganization <target organization name (as displayed in tree-view)>
Example
Set-MMExGroupMatching -SourceOrganization 'My Source Organization' -TargetOrganization 'My Target Organization'
This command searches the source organization My Source Organization for mail-enabled universal security distribution groups and then copies legacyExchangeDN of each source group as an X500 address to migrated mail-enabled universal security distribution group on the target organization My Target Organization to synchronize client properties of these distribution groups and to set object matching.
Parameters
-SourceOrganization
Specifies the source organization from which mail-enabled universal security distribution groups will be migrated.
Required? Position? Default value Accept pipeline input? Accept wildcard characters?
-TargetOrganization
true 1 none false false
Specifies the target organization to which mail-enabled universal security distribution groups will be migrated.
Required?
true
Position?
2
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
33
Default value Accept pipeline input? Accept wildcard characters?
none false false
Import-MMExPublicFolderMapping
Imports public folder mapping to provision public folder mailboxes in target.
Detailed Description
The Import-MMExPublicFolderMapping cmdlet imports public folder mapping from a comma-separated values (CSV) file for provisioning necessary public folder mailboxes on target. This operation is required to prepare public folder synchronization and in case of changes in source public folder hierarchy as described in Specific Case Workarounds During import operation, Migration Manager for Exchange reads files and connects to source and to target organization using credentials from the project database to ensure that these public folders exist in source and in target and can be processed. In case this verification is successful, the public folder pair will be added to database for synchronization, but really synchronization will be started after initialization.
Syntax
Import-MMExPublicFolderMapping -MappingFilePath <path and filename for the output CSV file> -Organization <target organization name (as displayed in tree-view)>
Examples
Import-MMExPublicFolderMapping -MappingFilePath MigrationMapping.csv -Organization 'My Target Organization'
This command imports public folder mapping from "MigrationMapping.csv" file and provisions public folder mailboxes and empty public folders in organization named 'My Target Organization' according CSV file values.
Parameters
-MappingFilePath
Specifies the full path for the output CSV file to be generated.
TIP: If only file name is specified for CSV file, then the output file will be generated in the current directory.
Required? Position? Default value Accept pipeline input? Accept wildcard characters?
true 1 none false false
-Organization
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
34
Specifies the target organization to which mail-enabled universal security distribution groups will be migrated.
Required? Position? Default value Accept pipeline input? Accept wildcard characters?
true 2 none false false
Inputs
Organization MappingFilePath
Outputs
CSV file
Initialize-MMExPublicFolderMigration
Prepares public folder migration project database for synchronization IMPORTANT: MAgE must be stopped before this operation, in case it is started.
Detailed Description
The Initialize-MMExPublicFolderMigration cmdlet prepares project database for public folder migration using specified CSV file. This operation is required to start public folder migration and in case of changes in source public folder hierarchy as described in Specific Case Workarounds. The CSV file contains SourceFolder, FolderSize, FolderClass, TargetFolder and TargetPFMailbox fields.
Syntax
Initialize-MMExPublicFolderMigration -MappingFilePath <path and filename for the output CSV file> -SourceOrganization <source organization name (as displayed in tree-view)> -TargetOrganization <target organization name (as displayed in tree-view)> [-Direction]
Examples
Example 1
Initialize-MMExPublicFolderMigration -MappingFilePath MigrationMapping.csv SourceOrganization 'My Source Organization' -TargetOrganization 'My Target Organization'
This command imports public folder mapping from "MigrationMapping.csv" file and prepares project database for public folders migration from organization 'My Source Organization' to organization 'My Target Organization'.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
35
Example 2
Initialize-MMExPublicFolderMigration -MappingFilePath MigrationMapping.csv SourceOrganization 'My Source Organization' -TargetOrganization 'My Target Organization' -Direction OneWay
This command imports public folder mapping from "MigrationMapping.csv" file and prepares project database for public folders migration from organization 'My Source Organization' to organization 'My Target Organization' with 1- way synchronization from source to target.
Parameters
-MappingFilePath
Specifies the full path for the output CSV file to be generated.
TIP: If only file name is specified for CSV file, then the output file will be generated in the current directory.
Required? Position? Default value Accept pipeline input? Accept wildcard characters?
true 1 none false false
-SourceOrganization
Specifies the source organization from which mail-enabled universal security distribution groups will be migrated.
Required? Position? Default value Accept pipeline input? Accept wildcard characters?
-TargetOrganization
true 2 none false false
Specifies the target organization to which mail-enabled universal security distribution groups will be migrated.
Required? Position? Default value Accept pipeline input? Accept wildcard characters?
true 3 none false false
-Direction Specifies public folder synchronization direction. The following values are available:
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
36
l OneWay - 1-way public folder synchronization l TwoWay - 2-way public folder synchronization
IMPORTANT: This decision applies to the current migration project and cannot be changed later. In case this parameter is not set you will be prompted to make this selection during initialization.
Required? Position? Default value Accept pipeline input? Accept wildcard characters?
false 4 none false false
Inputs
SourceOrganization TargetOrganization MappingFilePath
Restart-MMExPublicFolderMigration
This command restarts public folder migration or resynchronizes permissions for the specified public folder depending on specified parameters.
Detailed Description
The Restart-MMExPublicFolderMigration cmdlet restarts migration for a specified public folder to resynchronize content and permissions, or resynchronizes permissions only for the public folder if PermissionsOnly parameter is specified. See Managing Public Folder Synchronization for details. Two resynchronization modes are available depending on PermissionsOnly parameter for the project:
l PermissionsOnly is not set
Permissions and folder content will be resynchronized for specified public folder. Migration will be restarted for public folder and all currently available permissions and messages from source will be migrated to target again. It can be useful in case some messages or permissions were found to be migrated incorrectly, restart of migration forces MAgE to repeat data transferring attempt. NOTE: MAgE will not cleanup ALL content of target public folder. For 1-way synchronization, MAgE will reapply all permissions from the source folder to target and will migrate all source messages to target. If some of those messages had been previously migrated by MAgE, old copies will be overwritten (recreated).
l PermissionsOnly is set
Permissions will be cleared from project database and then resynchronized for specified public folder. This is the only action that will be performed. No public folder content is affected.
Syntax
Restart-MMExPublicFolderMigration
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
37
-FolderId <public folder ID value> [<PermissionsOnly>] [<CommonParameters>]
Examples
Example 1
Restart-MMExPublicFolderMigration -FolderId 5
This command restarts synchronization for single public folder specified by public folder identifier 5. Identifier could be retrieved using Get-MMExPublicFolderStatistics cmdlet or from a log file. Synchronization was restarted for the public folder MyFolder with identifier 5 Example 2 Restart-MMExPublicFolderMigration -FolderId 11 �PermissionsOnly This command only resynchronizes permissions for the public folder with ID 11.
Parameters
-FolderID
Specifies the identifier of a public folder to restart.
Required?
true
Position?
1
Default value
none
Accept pipeline input?
false
Accept wildcard characters?
false
-PermissionsOnly
Specifies whether permissions for the specified public folder will be cleared from project database and then
resynchronized. This is the only action that will be performed.
Required?
false
Position?
2
Default value
none
Accept pipeline input?
false
Accept wildcard characters?
false
TIP: You can find public folder identifier in the log entry, it is a number after the "M":
e.g., in the following log entry 2019-01-28 11:50:52.7225 Px1F48 Tx27 A1 C2 M7 Trace ... public folder identifier is "7".
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
38
Sync-MMExMailPublicFolder
Searches the source for mail-enabled public folders, sets matched target public folders as mail-enabled, and synchronizes Active Directory properties of these public folder. This task can be scheduled as described in Using Task Scheduler to Automate Tasks
Detailed Description
The Sync-MMExMailPublicFolder searches the source for mail-enabled public folders, sets matched target public folders as mail-enabled, and synchronizes proxy addresses, Send As permissions, Send On Behalf permissions, alias, custom attributes, simple display name properties from mail-enabled source public folder to matched target public folder. Also this cmdlet synchronizes public folder mailbox visibility in the GAL and copies legacyExchangeDN of each source public folder as an X500 address for migrated target public folder.
CAUTION: It is highly recommended to execute right after public folder migration initialization. It is recommended to repeat this command in case of changes in the source that can affect public folder synchronization (for example, a new mail-enabled public folder added).
Syntax
Sync-MMExMailPublicFolder -SourcePath <path to the source public folder> -TargetPath <path to the target public folder> -CollectionId <public folder collection identifier, integer> [-SimpleDisplayName ] [-Alias ] [-ProxyAddresses ] [-PreservePrimarySMTP ] [-Permissions ] [-CustomAttributes]
Examples
Example 1
Get-MMExPublicFolderStatistics |Sort-Object -Property CollectionID | SyncMMExMailPublicFolder -ProxyAddresses -Permissions
This command mail-enables target public folder, synchronizes proxy addresses and permissions of source mailenabled publics folders.
Example 2
Sync-MMExMailPublicFolder -SourcePath "\PFScust25" -TargetPath "\PFScust25" CollectionId 1 -ProxyAddresses -PreservePrimarySMTP -Permissions -Alias SimpleDisplayName
This command synchronizes Active Directory properties of source mail-enabled public folder PFScust25 which belongs to collection with ID = 1, and target mail-enabled public folder PFScust25.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
39
Parameters
-SourcePath
Specifies path to the source mail-enabled public folder. This public folder properties will be synchronized as specified by the cmdlet. This action will be performed for the public folder only, sub-folder properties, if any, should be synchronized separately.
Required? Position? Default value Accept pipeline input? Accept wildcard characters?
true 1 none true false
-TargetPath
Specifies path to the target mail-enabled public folder. This public folder properties will be synchronized as specified by the cmdlet.
Required? Position? Default value
true 2 none
Accept pipeline input? Accept wildcard characters?
true false
-CollectionId
Specifies identifier of public folder collection. The CollectionId can be retrieved using Get-
MMExPublicFolderStatistics cmdlet, or from the log file.
Required?
true
Position?
3
Default value
none
Accept pipeline input?
true
Accept wildcard characters?
false
-SimpleDisplayName
Specifies if simple display name will be synchronized.
Required?
false
Position?
3
Default value
none
Accept pipeline input?
false
Accept wildcard characters?
false
-Alias
Specifies if alias will be synchronized. Required?
false
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
40
Position? Default value Accept pipeline input? Accept wildcard characters?
4 none false false
-ProxyAddresses
Specifies if proxy addresses will be synchronized.
Required?
false
Position?
5
Default value
none
Accept pipeline input?
false
Accept wildcard characters?
false
IMPORTANT: To sync the source SMTP public folder address, you need to add a custom email domain as an accepted domain for your target Exchange organization.
-PreservePrimarySMTP
Specifies if target primary SMTP address will be preserved.
Required?
false
Position?
6
Default value
none
Accept pipeline input?
false
Accept wildcard characters?
false
-Permissions
Specifies if Send As and CanSendOnBehalfTo permissions will be synchronized.
Required?
false
Position?
7
Default value
none
Accept pipeline input?
false
Accept wildcard characters?
false
-CustomAttributes
Specifies if custom attributes 1-15 will be synchronized.
Required?
false
Position?
8
Default value
none
Accept pipeline input?
false
Accept wildcard characters?
false
Inputs
SourcePath TargetPath CollectionID SimpleDisplayName Alias ProxyAddresses
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
41
PreservePrimarySMTP Permissions CustomAttributes
Suspend-MMExPublicFolderMigration
Suspends public folder migration.
Detailed Description
Suspends public folder migration.
To obtain a list of already suspended public folders, run cmdlet Get-MMExPublicFolderStatistics as follows:
Get-MMExPublicFolderStatistics | select FolderPath, DisplayName, IsSuspended.
Syntax
Suspend-MMExPublicFolderMigration [-FolderId] <Int32> [<CommonParameters>]
Examples
Example 1
Suspend-MMExPublicFolderMigration -FolderId 5
This command suspends migration of a public folder with identifier 5. Migration was suspended for the following public folder: '\PF_Root\PF1' (#5) from the collection 'Public Folder Collection (agenthost)' (#1).
Example 2
Get-MMExPublicFolderStatistics -FolderPath "\PF_Root\PF1" | SuspendMMExPublicFolderMigration
This command suspends migration of a public folder returned by Get-MMExPublicFolderStatistics cmdlet using path to the public folder. Migration was suspended for the following public folder: '\PF_Root\PF1' (#5) from the collection 'Public Folder Collection (agenthost)' (#1).
Parameters
-FolderID
Specifies the identifier of a public folder to restart.
Required?
true
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
42
Position? Default value Accept pipeline input? Accept wildcard characters?
Inputs
FolderID
1 none false false
Resume-MMExPublic FolderMigration
Resumes suspended migration
Detailed Description
The Resume-MMExPublic FolderMigration cmdlet resumes public folder migration for specified public folders. To obtain a list of already suspended public folders, run cmdlet Get-MMExPublicFolderStatistics as follows: Get-MMExPublicFolderStatistics | select FolderPath, DisplayName, IsSuspended.
Syntax
Resume-MMExPublicFolderMigration [-FolderId] <Int32> [<CommonParameters>]
Examples
Example 1
Resume-MMExPublicFolderMigration -FolderId 5
This command resumes suspended migration of a public folder with identifier 5. Suspended migration was resumed for the following public folder: '\PF_Root\PF1' (#5) from the collection 'Public Folder Collection (agenthost)' (#1).
Example 2
Get-MMExPublicFolderStatistics -FolderPath "\PF_Root\PF1" | ResumeMMExPublicFolderMigration
This command resumes suspended migration of a public folder returned by Get-MMExPublicFolderStatistics cmdlet using path to the public folder. Suspended migration was resumed for the following public folder: '\PF_Root\PF1' (#5) from the collection 'Public Folder Collection (agenthost)' (#1).
Parameters
-FolderID
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
43
Specifies the identifier of a public folder to restart.
Required?
true
Position?
1
Default value
none
Accept pipeline input?
false
Accept wildcard characters?
false
Inputs
FolderID
Remove-MMExPublicFolderMigration
This cmdlet is intended for troubleshooting purposes only. Temporarily removes the public folder from the migration project and cleans all associated data in the migration project database to process this source public folder anew.
Detailed Description
The Remove-MMExPublicFolderMigration cmdlet temporarily removes the public folder from the migration project and cleans all associated data in the migration project database to process this source public folder anew.
Parameters
CAUTION: Stop Migration Agent for Exchange (MAgE) using Stop-MMExAgent before execute this command. After the command has been executed restart the agent using Start-MMExAgent to continue synchronization process for the rest of public folders.
Syntax
Remove-MMExPublicFolderMigration -FolderId <Int32>
Examples
Example 1 Remove-MMExPublicFolderMigration -FolderId 5
The following public folder: '\PF_Root\PF1' (#5) from the collection 'Public Folder Collection (agenthost)' (#1) was temporarily removed from the migration project. This command temporarily removes a public folder with identifier 5 from migration project.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
44
Parameters
Example 2
PS C:\>Get-MMExPublicFolderStatistics -FolderPath "\PF_Root\PF1" | RemoveMMexPublicFolderMigration
The following public folder: '\PF_Root\PF1' (#5) from the collection 'Public Folder Collection (agenthost)' (#1) was temporarily removed from the migration project. This command removes a public folder returned by Get-MMExPublicFolderStatistics cmdlet from migration project.
Parameters
-FolderID
Specifies the identifier of a public folder to remove. Identifier could be retrieved using Get-
MMExPublicFolderStatistics cmdlet or from the log file..
Required?
true
Position?
1
Default value
none
Accept pipeline input?
false
Accept wildcard characters?
false
Inputs
FolderID
Install-MMExAgent
Installs an agent on the selected host.
Detailed Description
The Install-MMExAgent cmdlet installs the agent specified by type on the selected host.
Syntax
Install-MMExAgent -Type PublicFolder -AgentHost <hostname> -AgentHostAccount <PSCredential> [-InstallPath <full path>] [<CommonParameters>]
Parameters
-Type Specifies the agent type, currently only 'PublicFolder' is allowed.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
45
Required? Position? Default value Accept pipeline input? Accept wildcard characters?
true 1 PublicFolder false false
-AgentHost
Specifies host name to install specified agent. TIP: If this parameter is not specified, the agent will be installed on the local server (localhost)..
Required? Position? Default value Accept pipeline input? Accept wildcard characters?
false 2 localhost false false
-AgentHostAccount
Specifies credentials of service account required to install the agent on the specified host.
Required?
true
Position?
3
Default value
none
Accept pipeline input?
false
Accept wildcard characters?
false
-InstallPath
Specifies full path to the agent installation folder.
Required?
false
Position?
4
Default value
$Env:ProgramW6432*\Quest Software\Migration Manager\Migration Agent for Exchange
Accept pipeline input?
false
Accept wildcard characters?
false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, see about_CommonParameters.
Examples
Install-MMExAgent -Type PublicFolder -InstallPath "c:\QuestAgentPath This command installs the public folder synchronization agent to the QuestAgentPath folder on the disc C.
Start-MMExAgent
Starts an agent on the selected host.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
46
Detailed Description
The Start-MMExAgent cmdlet starts Migration Agent for Exchange (MAgE) installed on the selected host.
Syntax
Start-MMExAgent -Type PublicFolder [-AgentHost <agent host name>] [<CommonParameters>]
Examples
Start-MMExAgent -Type PublicFolder This command starts the agent installed on the localhost.
Parameters
-Type
Specifies the agent type, currently only 'PublicFolder' is allowed.
Required?
true
Position?
2
Default value
PublicFolder
Accept pipeline input?
false
Accept wildcard characters?
false
-AgentHost
Specifies host name where specified agent is installed to start the agent. TIP: If this parameter is not specified, the agent will be started on the local server (localhost)..
Required? Position? Default value Accept pipeline input? Accept wildcard characters?
false 1 <localhost> false false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, see about_CommonParameters.
Stop-MMExAgent
Stops an agent on the selected host.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
47
Detailed Description
The Start-MMExAgent cmdlet stops the Migration Agent for Exchange (MAgE) running on the selected host.
Syntax
Stop-MMExAgent -Type PublicFolder [-AgentHost <agent host name>] [<CommonParameters>]
Examples
Stop-MMExAgent -Type PublicFolder This command stops the agent running on the localhost.
Parameters
-Type
Specifies the agent type, currently only 'PublicFolder' is allowed.
Required? Position? Default value
true 4 PublicFolder
Accept pipeline input? Accept wildcard characters?
false false
-AgentHost
Specifies host name where specified agent is running on to stop the agent. TIP: If this parameter is not specified, the agent will be stopped on the local server (localhost)..
Required? Position? Default value Accept pipeline input? Accept wildcard characters?
false 1 localhost false false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, see about_CommonParameters.
Repair-MMExAgent
Repairs an agent instance on the selected host.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
48
Detailed Description
The Repair-MMExAgent cmdlet repairs an Migration Agent for Exchange (MAgE) instance installed on the selected host. This operation is used to update agents on a host after Public Update installation. During the Repair operation for an instance of MAgE agent or for the certain agent role, this update will be installed on all instances of all MAgE agent roles that reside on the agent host.
Syntax
Repair-MMExAgent -Type PublicFolder [-AgentHost <agent host name>] [<CommonParameters>]
Examples
Repair-MMExAgent -Type PublicFolder
This command repairs the agent instance installed on the localhost.
Parameters
-Type
Specifies the agent type, currently only 'PublicFolder' is allowed.
Required?
true
Position?
2
Default value
PublicFolder
Accept pipeline input?
false
Accept wildcard characters?
false
-AgentHost
Specifies host name where specified agent is installed to repair the agent instance.
TIP: If this parameter is not specified, the agent instance will be repaired or updated on the local server (localhost).
Required? Position? Default value Accept pipeline input? Accept wildcard characters?
false 1 <localhost> false false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, see about_CommonParameters.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
49
Restart-MMExAgent
Restarts an agent on the selected host.
Detailed Description
The Restart-MMExAgent cmdlet stops and then starts again the Migration Agent for Exchange (MAgE) installed on the selected host.
Syntax
Restart-MMExAgent -Type PublicFolder [-AgentHost <agent host name>] [<CommonParameters>]
Examples
Restart-MMExAgent -Type PublicFolder This command restarts the agent installed on the localhost.
Parameters
-Type
Specifies the agent type, currently only 'PublicFolder' is allowed.
Required? Position? Default value
true 2 PublicFolder
Accept pipeline input? Accept wildcard characters?
false false
-AgentHost
Specifies host name where specified agent is installed to restart the agent. TIP: If this parameter is not specified, the agent will be restarted on the local server (localhost)..
Required? Position? Default value Accept pipeline input? Accept wildcard characters?
false 1 <localhost> false false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, see about_CommonParameters.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
50
Uninstall-MMExAgent
Uninstalls an agent from the selected host.
Detailed Description
The Uninstall-MMExAgent cmdlet uninstalls Migration Agent for Exchange (MAgE) installed on the selected host.
Syntax
Uninstall-MMExAgent -Type PublicFolder [-AgentHost <agent host name>] [<CommonParameters>]
Examples
Uninstall-MMExAgent -Type PublicFolder This command uninstalls the agent installed on the localhost.
Parameters
-Type
Specifies the agent type, currently only 'PublicFolder' is allowed.
Required? Position? Default value
true 2 PublicFolder
Accept pipeline input? Accept wildcard characters?
false false
-AgentHost
Specifies host name where specified agent is installed to uninstall the agent. TIP: If this parameter is not specified, the agent will be uninstalled from the local server (localhost).
Required? Position? Default value Accept pipeline input? Accept wildcard characters?
false 1 <localhost> false false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, see about_CommonParameters.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
51
Granting Permissions
This section provides reference information on how to grant an administrative accounts the following required permissions:
Source Exchange 2010 Organization l Granting the Public Folders Role l Granting Read permission for public folders l Granting Owner Permissions for Each Public Folder l Granting Full Access Permission for Public Folder to an account
Source Exchange 2013/2016/2019 Organization l Granting the Public Folders Role l Granting Read permission for public folders l Granting the View-Only Configuration Role l Granting Owner Permissions for Each Public Folder l Granting CreateSubfolders and FolderVisible Access Rights for the Root Folder
Target Exchange 2013/2016/2019 Organization l Granting Read Permission to Microsoft Exchange Container l Granting the Public Folders Role l Granting the View-Only Configuration Role l Granting Owner Permissions for Each Public Folder l Granting CreateSubfolders and FolderVisible access rights to the root folder
Target Office 365 Organization l Office 365 account: Granting the Public Folders Role l Office 365 account: Granting the View-Only Configuration Role l Office 365 account: Granting Public Folder Owner Permission l Office 365 account: Granting CreateSubfolders and FolderVisible access rights
Granting Read Permission to Microsoft Exchange Container
To grant this permission to an account, perform the following: 1. From the Start menu, select Run. In the Run dialog box, type ADSIEdit.msc. Click OK. 2. In the ADSIEdit snap-in, open the CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=<...>,DC=<...> container. 3. Right-click the Microsoft Exchange container and select Properties.
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
52
4. In the Properties dialog box, click the Security tab. 5. On the Security tab, click Add to provide the account to which you wish to assign permissions. 6. Select the account name, and then enable the Allow option for the Read permission in the
Permissions box. 7. Click the Advanced button. In the Advanced Security Settings dialog box, select the account you
specified on step 5 and click Edit. 8. In the Permission Entry dialog box, select This object and all child (descendant) objects from the
Apply onto drop-down list. 9. Click OK to accept changes.
Granting the Public Folders Role
To grant the Public Folders management role to the <User> (for example, LA\JohnSmith), run the following cmdlet in Exchange Management Shell: New-ManagementRoleAssignment -Role "Public Folders" -User "LA\JohnSmith"
Granting the View-Only Configuration Role
To grant the required permission to the <User> (for example, JohnSmith), run the following cmdlet in Exchange Management Shell: New-ManagementRoleAssignment -Role "View-Only Configuration" -User "LA\JohnSmith"
Granting Read Permission for Each Public Folder
To grant the required permission the administrative account, for example, JohnSmith), run the following cmdlet in Exchange Management Shell: Get-PublicFolder -Recurse | Add-PublicFolderClientPermission -User "LA\JohnSmith" AccessRights Reviewer
NOTE:This permission must be granted for all public folders you want to synchronize.
Granting CreateSubfolders and FolderVisible Access Rights for the Root Folder
To grant CreateSubfolders and FolderVisible permission to the <User> (for example, LA\JohnSmith), run the following cmdlet in Exchange Management Shell: Add-PublicFolderClientPermission -Identity "\" -User "LA\JohnSmith" -AccessRights "CreateSubfolders","FolderVisible"
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
53
Granting Full Access Permission for Public Folder to an account
To grant Full Access permission for Public Folder to the account perform the following steps:
1. From the Start menu, select Run. In the Run dialog box, type ADSIEdit.msc. Click OK. 2. In the ADSIEdit snap-in, open the CN=Folder Hierarchies CN=Exchange Administrative Group(...)
CN=Administrative Group CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=<...>,DC=<...> container. 3. Righ-tclick the Folder Hierarchies and select Properties. 4. In the Properties dialog box, click the Security tab. 5. On the Security tab, click Add to provide the account to which you wish to assign permissions. 6. Select the account name, and then enable the Allow option for the Full Access permission in the Permissions box. 7. Click the Advanced button. In the Advanced Security Settings dialog box, select the account you specified on step 5 and click Edit. 8. In the Permission Entry dialog box, select This object and all child (descendant) objects from the Apply onto drop-down list. 9. Click OK to accept changes
Granting Owner Permissions for Each Public Folder
To grant the required permission the administrative account, for example, JohnSmith), run the following cmdlet in Exchange Management Shell:
Get-PublicFolder -Recurse | Add-PublicFolderClientPermission -User "LA\JohnSmith" AccessRights Owner
NOTE:This permission must be granted for all public folders you want to synchronize.
Office 365 account: Granting the Public Folders Role
To grant the required permission to the <User> (for example, JohnSmith), run the following cmdlet in Exchange Management Shell:
$session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/powershell-liveid/ -Credential $cred -Authentication Basic �AllowRedirection
Import-PSSession $session
New-ManagementRoleAssignment -Role "Public Folders" -User "JohnSmith"
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
54
Remove-PSSession $session
Office 365 account: Granting the View-Only Configuration Role
To grant the required permission to the <User> (for example, JohnSmith), run the following cmdlet in Exchange Management Shell:
$session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/powershell-liveid/ -Credential $cred -Authentication Basic �AllowRedirection Import-PSSession $session New-ManagementRoleAssignment -Role "View-Only Configuration" -User "JohnSmith" Remove-PSSession $session
Office 365 account: Granting Public Folder Owner Permission
The administrative account should be granted by Owner permissions on all public folders. Grant this account Owner client permissions on all public folders you want to synchronize. In the Office 365 Exchange admin center, do the following:
1. Click public folders. 2. Select the root folder. 3. In the toolbar on the right, click the ellipsis icon and select Root permissions. 4. Add the necessary account and assign it the Owner client permission. Select the Apply changes to this
public folder and all its subfolders option and save your changes. In case the inheritance will be broken, the subfolders cannot be synchronized.
Office 365 account: Granting CreateSubfolders and FolderVisible access rights
To grant CreateSubfolders and FolderVisible permissions to the <User> (for example, LA\JohnSmith), run the following cmdlet in Exchange Management Shell:
$session = New-PSSession -ConfigurationName Microsoft.Exchange -ConnectionUri https://outlook.office365.com/powershell-liveid/ -Credential $cred -Authentication Basic �AllowRedirection
Import-PSSession $session
Add-PublicFolderClientPermission -Identity "\" -User "LA\JohnSmith" -AccessRights "CreateSubfolders","FolderVisible"
Remove-PSSession $session
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
55
Using Task Scheduler to Automate Tasks
On the computer where the Migration Manager console is installed, you can create, edit, and delete scheduled tasks using Task Scheduler, and in this guide we'll show you how to do it. To create a scheduled task, perform the following:
1. From the Start menu, select Run. In the Run dialog box, type taskschd.msc to start Task Scheduler. Click OK.
2. Right-click the Task Scheduler Library and select Create Task.... 3. In the Create Task dialog box, name the task in Name field. 4. (Optional) In the Description field, create a description for the task. 5. Task Scheduler allows you to select from a number of triggers, including on a specific date, during
startup, or when you or a particular user signs in. Depending on your requirements, you will need to configure additional parameters. Select desired security options: Run only when user is logged on or Run whether user is logged on or not. 6. On Triggers tab, click the New button to create a trigger. 7. In the New Trigger dialog box, schedule your task depending on how often your environment changes. 8. Use Advanced settings to schedule a recurrence of a task. Confirm to proceed. 9. On Actions tab, click the New button to create an action 10. Select Start a program action in Action drop-down box 11. In the Settings area provide the powershell.exe(x86) location, default location is C:\Windows\SysWOW64\WindowsPowerShell\v1.0.
12. In the Add arguments(optional): field, you can enter script for your task. 13. On Settings tab, specify additional settings for the task, select whether the task can be started in parallel.
The Run a new instance in parallel setting would be useful for processing of multiple objects (e.g., more than 100 public folders). 14. Confirm to save your automated task.
NOTE: A separate task should be created for every synchronized source public folder root.
Below you can find examples of the scripts you can use for specific purposes:
l Mail-enable created public folders l Add source legacyExchangeDN property as X500 in the target
Automate mail-enabling of created public folders
Use the following script with your parameters to create your own script for Add arguments(optional): field to automate mail-enabling of created public folders:
Set-ExecutionPolicy RemoteSigned
cd "C:\Program Files (x86)\Quest Software\Migration Manager\Exchange Data\Tools\MMExPowerShell"
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
56
Import-Module "C:\Program Files (x86)\Quest Software\Migration Manager\Exchange Data\Tools\MMExPowerShell"
Get-MMExPublicFolderStatistics |Sort-Object -Property CollectionID | SyncMailPublicFolder -ProxyAddresses -Permissions
Automate adding source legacyExchangeDN property as X500 in the target
Use the following script with your parameters to create your own script for Add arguments(optional): field to automate adding source legacyExchangeDN property as X500 in the target for group matching:
Set-MMExExecutionPolicy RemoteSigned
cd "C:\Program Files (x86)\Quest Software\Migration Manager\Exchange Data\Tools\MMExPowerShell"
Import-Module "C:\Program Files (x86)\Quest Software\Migration Manager\Exchange Data\Tools\MMExPowerShell"
Set-GroupMatching -SourceOrganization `My Source Organization' -TargetOrganization `My Target Organization'
Migration Manager 8.15 Public Folder Synchronization (MAgE)
Technical Reference
57
About us
Ab o u t u s
Quest creates software solutions that make the benefits of new technology real in an increasingly complex IT landscape. From database and systems management, to Active Directory and Office 365 management, and cyber security resilience, Quest helps customers solve their next IT challenge now. Around the globe, more than 130,000 companies and 95% of the Fortune 500 count on Quest to deliver proactive management and monitoring for the next enterprise initiative, find the next solution for complex Microsoft challenges and stay ahead of the next threat. Quest Software. Where next meets now. For more information, visit www.quest.com.
Technical support resources
Technical support is available to Quest customers with a valid maintenance contract and customers who have trial versions. You can access the Quest Support Portal at https://support.quest.com. The Support Portal provides self-help tools you can use to solve problems quickly and independently, 24 hours a day, 365 days a year. The Support Portal enables you to:
l Submit and manage a Service Request l View Knowledge Base articles l Sign up for product notifications l Download software and technical documentation l View how-to-videos l Engage in community discussions l Chat with support engineers online l View services to assist you with your product
Migration Manager 8.15 Public Folder Synchronization (MAgE)
About us
58