Dell Migration Manager 8.11 Collection Management Utility

Transcription

1 Dell Migration Manager 8.11 Collection Management Utility Version 2.11 February 20, 2015 This readme file provides information about Dell. About Contents of this package Getting started with About Dell About Migration Manager Collection Management Utility The Quest Migration Manager for Exchange Collection Management Utility allows users to automate creation and management of Mailbox Synchronization and Calendar Synchronization collections. In Quest Migration Manager for Exchange 8.11 there are several jobs of new type and format. Current version of utility supports both legacy and new jobs. However, commands and input files are different. The utility allows users to perform the following operations: 1 Create Mailbox Synchronization and Calendar Synchronization collections. 2 Edit Mailbox Synchronization and Calendar Synchronization collections. 3 Delete Mailbox Synchronization and Calendar Synchronization collections. 4 Add and remove collection members. 5 Export collection settings. 6 Export collection members. Please note that this version of the utility is specially designed for QMM for Exchange 8.11 with EX update installed. 1

2 Contents of This Package The following files are shipped: QMMExCM.8.11.exe (version 2.11) - command-line utility for collection management. QMMExCollManNetLib.dll (version 2.11) - DLL file required for utility operation. RegNetLib.ps1 - Windows PowerShell script file for registering QMMExCollManNetLib.dll. QMM.8.11._CollectionManagementUtility_Readme.htm - this file. Getting Started with Migration Manager Collection Management Utility How to Install This Utility The utility is intended to be used with Dell Migration Manager for Exchange version You should install and register the required DLL (QMMExCollManNetLib.dll) using the regasm.exe utility on the computer where QMM for Exchange console is installed. The DLL file should be placed in the same folder where QMMExCM.8.11.exe is located or should be registered with the Codebase parameter of the regasm.exe utility. Place the RegNetLib.ps1 Windows PowerShell script file in the folder along with QMMExCollManNetLib.dll and run it to register DLL with regasm.exe. By default, script registers DLL without the Codebase parameter. Using the Utility Run the utility on the computer where the Migration Manager console is installed. The utility will process the Migration Manager project that is currently opened. Collection Settings Management Create a text file that will provide the required input data for creating/editing a collection; it must contain data in the fields separated by the tab character. Each type of synchronization job requires its own format for input data. NOTE: Please note that all columns are obligatory. The values can be empty if they are optional. The utility checks the format of input data in the input file. If you specify header for the columns in the input file, the utility logs an error and skips the header line just like data in incorrect format. 2

3 Office365 Mailbox Synchronization The values must be separated by the tab character; follow the sequence of the fields order from the table below, for example: <source server name><tab><target server name><tab><collection name>... Field Name Source server name Sample Value SourceOrg1 Target server name off365 Collection name Off365Mail Synchronization type Synchronization state for a collection O365Mailbox Synchronization start date and time 1/28/2015 6:26:47 PM Name of an agent host QMM810 ID of an agent instance 0 Switch time 1/28/2015 6:27:55 PM Maximum number of errors occurred during migration 1 Name of a cloud user Cloud password admin@questmpnaus.onmicrosoft.com FBB990752D1540F525999E3D742464A3E0613AC92003AA6484C082F20 Subscription Expand nested groups tenant:aad_premium Include sub containers Mailbox LDAP filter (optional) (cn=user*) 3

4 Office365 Calendar Synchronization The values must be separated by the tab character; follow the sequence of the fields order from the table below, for example: <source server name><tab><target server name><tab><collection name>... Field Name Source server name Sample Value 1st Target server name Office365 Collection name OC1 Synchronization type Synchronization state for a collection O365Calendar Synchronization start date and time 10/11/2013 4:29:36 PM Name of an agent host QMM810 ID of an agent instance 1 Two-way synchronization (true/false) Name of a cloud user Cloud password Andrew.Smith@QuestMPNAUS.onmicrosoft.com E DF2AAF0D65E8D2A06494A53527D76F9C9DEC419B9A6D Subscription Expand nested groups tenant:enterprisepack Include sub containers Mailbox LDAP filter (optional) <no data> 4

5 Mailbox Synchronization The values must be separated by the tab character; follow the sequence of the fields order from the table below, for example: <source server name><tab><target server name><tab><collection name>... Field Name Source server name Sample Value 1st Target server name BavariaOrg Collection name M1 Synchronization type Mailbox Synchronization state for a collection Synchronization start date and time <no data> Name of an agent host QMM810 ID of an agent instance 1 Name of the target mailbox database Mailbox Database Switch time 10/11/2013 4:26:01 PM Maximum number of errors occurred during migration 1 Expand nested groups Include sub containers Mailbox LDAP filter (optional) <no data> 5

6 Native Move The values must be separated by the tab character; follow the sequence of the fields order from the table below, for example: <source server name><tab><target server name><tab><collection name>... Field Name Source server name Sample Value 1stOrg Target server name AlgarveOrg Collection name N1 Synchronization type NativeMove Synchronization state for a collection Synchronization start date and time 10/11/2013 4:26:42 PM Name of an agent host QMM810 ID of an agent instance 0 Name of the target mailbox database Database2 Name of a target Active Directory domain part algarve1.local Switch time 10/11/2013 4:26:54 PM Maximum number of errors occurred during migration 1 Expand nested groups Include sub containers Mailbox LDAP filter (optional) (objectcategory=person) 6

7 Calendar Synchronization The values must be separated by the tab character; follow the sequence of the fields order from the table below, for example: <source server name><tab><target server name><tab><collection name>... Field Name Source server name Sample Value 1stOrg Target server name BavariaOrg Collection name C2 Synchronization type Calendar Synchronization state for a collection Synchronization start date and time 10/11/2013 4:31:04 PM Name of an agent host QMM810 ID of an agent instance 0 Two-way synchronization (true/false) Name of the target database Mailbox Database Expand nested groups Include sub containers Mailbox LDAP filter (optional) <no data> To create or edit collections via the input file, use the following syntax in the command line: QMMExCM.8.11.exe /addcollections <input_file> or QMMExCM.8.11.exe /ac <input_file> NOTE: You may combine input data for different types of synchronization in the same file or specify a set of input files in a chain of arguments. Leave the CloudUser field blank to use job default Office365 account. To encrypt password for Office365 connection and use encrypted string in the CloudPassword field: QMMExCM.8.11.exe /encrypt [<password>] 7

8 NOTE: You will be prompted for a password if you leave the password argument blank. To delete collections via the input file, use the following syntax in the command line: QMMExCM.8.11.exe /deletecollections <input_file> or QMMExCM.8.11.exe /dc <input_file> NOTE: You need to provide 4 first fields in the input file for the delete collections operation. Collection Members Management Create a text file that will provide the required input data for adding/removing members of collections. This file must contain data in the fields separated by tab character; follow the sequence of the fields order. The following example demonstrates the required file format: Source Server Name Target Server Name Collection Name Collection Type Name 1st BavariaOrg UM1 Mailbox admin MailBox 1st BavariaOrg UC1 Calendar admin MailBox 1st AlgarveOrg NM1 NativeMove admin MailBox 1stOrg Office365 OM1 O365Mailbox AC.DL1 Group Type 1stOrg Office365 OC1 O365Calendar OU=AC.OU, DC=custexch2, DC=local Container NOTE: Use mail aliases to specify mailboxes and groups. Use distinguished names to specify containers and organizational units. To add member into collections via the input file, use the following syntax in the command line: QMMExCM.8.11.exe /addmembers <input_file> or QMMExCM.8.11.exe /am <input_file> To remove members from collections via the input file, use the following syntax in the command line: QMMExCM.8.11.exe /removemembers <input_file> or QMMExCM.8.11.exe /rm <input_file> Export Data To export collection settings into the text file, use the following syntax in the command line: QMMExCM.8.11.exe /export [<export_folder>] To export collection members into the text file, use the following syntax in the command line: QMMExCM.8.11.exe /exportmembers [<export_folder>] NOTE: The utility exports collections data for both new and legacy synchronization jobs. 8

9 Legacy Synchronization Jobs Support NOTE: Please note that all columns are obligatory. The values can be empty if they are optional. The utility checks the format of input data in the input file. If you specify header for the columns in the input file, the utility logs an error and skips the header line just like data in incorrect format. This section describes the functionality for Legacy Synchronization Jobs only. 1 Create a text file that will provide the required input data for creating a collection; it must include the following fields separated by tab character: NOTE: 1. source server 2. target server 3. collection name 4. collection type (mailbox/calendar) 5. collection state (enabled/disabled) 6. collection priority 7. source mailbox database scope filter (optional) - separate several mailbox database names with semicolon. Omit parameter to include all source databases into the scope. 8. mailbox LDAP filter (optional) 9. collection target mailbox database (optional) - omit to use default job settings, use single / to specify Leave mailbox in the current mailbox database setting 10. do not start before datetime (omit to start as soon as possible) 11. switch size limit in kilobytes (optional, use for mailbox collections) 12. maximum number of errors occurred during migration (optional, use for mailbox collections) 13. maximum number of appointments that are not in sync (optional, use for mailbox collections) 14. start switch mailboxes datetime (optional) - omit to disable mailbox switch or preserve offline folder files, use for mailbox collections 15. switch schedule in hexadecimal string format (optional, use for mailbox collections) 16. whether to enable two-way synchronization for calendar collection (Yes or No) (optional) - use for calendar collections only 17. source agent name /calendar agent name (optional) 18. target agent name (optional, use for mailbox collections) 19. preserve offline folder files (optional) - yes/no Columns are actual for mailbox synchronization collections of switch type only; they are ignored for mailbox synchronization collections of other types. Use parentheses to specify the instance number of source or target agent. For example, somemtahost(2) defines instance 2 of agent somemtahost. 2 Create a text file that will provide the required input data for populating a collection; it must include the following fields separated by the tab character: 1. source server 2. target server 3. collection name 4. collection type (mailbox/calendar) 9

10 5. operation type (add/remove) 6. object name (Exchange alias) 7. object type (mailbox/group) 3 Create a text file that will provide the required input data for populating Native Move collections. It must include the following fields separated by the tab character: 1. collection name 2. mailbox name (Exchange alias) 4 Example: The values must be separated by the tab character; follow the sequence of the fields from the table below, for example: <source server name><tab><target server name><tab><collection name>... Field Name Sample Value 1 Sample Value 2 Sample Value 3 Source server name sourceexch1 sourceexch1 sourceexch1 Target server name targetexch2 targetexch2 targetexch2 Collection name Mail1 Calendar1 Calendar1 Synchronizatio n type mailbox calendar mailbox Synchronizatio n state for a collection enabled enabled enabled Source scope LDAP filter First Storage Group/Mailstore 2;MailStore1 (&(extensionattribute1=001)( mailnickname=*)) ExchServer1/MailSt ore1 (&(CN=A*)(mailNick Name=*)) Target Store First Storage Group/MbxStore ExchServer2/MbxSt ore2 Synchronizatio n date and time ExchServer1/MailStore1 <no data> 23/12/ /12/2013 <no data> / Switch Size 4 <no data> <no data> Number of errors Number of appointments 25 <no data> <no data> 10 <no data> <no data> Switch time 23/12/2013 <no data> <no data> Schedule Source agent/two-way Sync 0x0100E00100E00100E00100E0 0100E00100E00100E0 <no data> agent1(1) yes agent1 0x0100E00100E00100E00100E0010 0E00100E00100E0 10

11 Target Agent/Calenda r Agent agent2 agent1 agent2 Preserve OST No <no data> No Using this input (first column) the utility creates (or modifies) collection Mail1 for SOURCEEXCH1<- >TARGETEXCH2 mailbox synchronization job, sets its status to enabled, priority to 1 and start of synchronization to 23/12/ :00, includes all source domain mailboxes corresponding to LDAP filter (&(extensionattribute1=001)(mailnickname=*)) from First Storage Group/Mailstore 2 and MailStore1 mailbox stores. Also, it sets First Storage Group/MbxStore as a target store, switch start to 23/12/ :00 for the mailboxes with 4Kb of unsynchronized mail, permits 25 synchronization errors and 10 appointments and defines switch schedule from 12AM till 4AM every day (use /schedule option to define schedule string for the input file), sets instance #1 of AGENT1 as source agent server and AGENT2 as target agent server. NOTE: By default, the utility adds all domains from source forest to the collection scope for the newly created or edited collections. 5 Run the QMMExCM.8.11.exe utility from the command line with the syntax described below. To create collections using input file and optionally commit changes: QMMExCM.8.11.exe /create <input_file_for_new_collection> [/commit] [/excludedomains <domains_list_filepath> domainname(s)] where <input_file_for_new_collection> - path to.txt file created on step 1. <domains_list_filepath> - path to.txt file with domain name on each line. These domains will be excluded from the collection scope. domainname(s) - domain name (or names) to be excluded from the collection scope. To edit collections using input file and optionally commit changes: QMMExCM.8.11.exe /edit <input_file_for_existing_collection> [/commit] [/excludedomains <domains_list_filepath> domainname(s)] where <input_file_for_existing_collection> - path to.txt file created on step 1. <domains_list_filepath> - path to.txt file with domain name on each line. These domains will be excluded from collection scope. <domainname(s)> - domain name (or names) to be excluded from the collection scope. To delete collections using input file and optionally commit changes: QMMExCM.8.11.exe /delete <input_file_for_collection_to_delete> [/commit] where <input_file_for_collection_to_delete> - path to.txt file of the same format as was created on step 1 with at least 4 first columns. To commit all uncommitted jobs or optionally specify the job to commit: QMMExCM.8.11.exe /commit [<source>=<target> calendar mail] where <source> - source server name <target> - target server name To display the Schedule dialog and get schedule time in string format for using in input file: QMMExCM.8.11.exe /schedule Please note that schedule time in string format will be automatically copied to clipboard after you close the Schedule dialog. To add or remove collections members: QMMExCM.8.11.exe /manage <input_file_for_members> [/commit] where <input_file_for_members> - path to.txt file created on step 2. To export existing QMM for Exchange collections in project: QMMExCM.8.11.exe /export [mailbox calendar] 11

12 The utility writes ExportedCollections.[timestamp].log containing names and settings of QMM for Exchange collections (mailbox, calendar or both types). To export all existing QMM for Exchange members of collections in project: QMMExCM.8.11.exe /exportmembers The tool writes ExportedMembers.[timestamp].log containing members of Exchange collections in the same format as for input file for managing collection members. NOTE: After you install or upgrade Migration Manager for Exchange, you must run the Migration Manager for Exchange console at least once before using the utility. Logging When you run the utility, all information about its activity is written to a log file named QMMExCM.8.11.log. This log file is created in the folder where the utility (.EXE file) is located. Also, if the /verbose switch specified for legacy synchronization jobs operations the utility creates additional log files such as: CollectionNotFound.[timestamp].log - contains objects that cannot be added or removed because the specified collection doesn't exist. ObjectNotFound.[timestamp].log - contains objects that cannot be added or removed because the specified object doesn't exist. LineError.Collections.[timestamp].log - contains collections that cannot be created or modified due to errors in the input file. LineError.Objects.[timestamp].log - contains objects that cannot be imported due to errors in the input file. SuccessfulAdds.[timestamp].log - contains objects that were successfully imported into collection(s). AlreadyExistsInCollection.[timestamp].log - contains objects that cannot be added to the collection(s) because these objects already exist in these collection(s). DoesNotExistInCollection.[timestamp].log - contains objects that cannot be removed from collection(s) due to these objects are not the members of the collection(s). These files are in the same format as for input file for creating collections / managing collection members, so they can be used to quickly re-import collection settings/membership after resolving of the corresponding issues. 12

13 About Dell Dell listens to customers and delivers worldwide innovative technology, business solutions and services they trust and value. For more information, visit Contacting Dell Technical Support: Online Support Product Questions and Sales: (800) Technical support resources Technical support is available to customers who have purchased Dell software with a valid maintenance contract and to customers who have trial versions. To access the Support Portal, go to The Support Portal provides self-help tools you can use to solve problems quickly and independently, 24 hours a day, 365 days a year. In addition, the portal provides direct access to product support engineers through an online Service Request system. The site enables you to: Create, update, and manage Service Requests (cases) View Knowledge Base articles Obtain product notifications Download software. For trial software, go to Trial Downloads. View how-to videos Engage in community discussions Chat with a support engineer 13

14 2015 Dell 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 Dell Inc. The information in this document is provided in connection with Dell 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 Dell products. EXCEPT AS SET FORTH IN THE TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR THIS PRODUCT, DELL 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 DELL 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 DELL HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Dell 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. Dell 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: Dell Inc. Attn: LEGAL Dept 5 Polaris Way Aliso Viejo, CA Refer to our web site (software.dell.com) for regional and international office information. Trademarks Dell and the Dell logo are trademarks of Dell Inc. and/or its affiliates. Other trademarks and trade names may be used in this document to refer to either the entities claiming the marks and names or their products. Dell disclaims any proprietary interest in the marks and names of others. 14