You can run the BitTitan DeploymentPro module for a few users at a time in MSPComplete. However, it is more efficient to use PowerShell to run the DeploymentPro module if you must do it for 100 or more users. This method is also recommended if the destination domain varies for different users, because you can define various destination domains using a comma-separated value (CSV) file. This article guides you through the steps to use PowerShell to run the DeploymentPro module.
Sections in this article:
- Create a CSV file of users for DeploymentPro
- Run the Start-DeploymentProUserBatch PowerShell script
- Next steps
Complete these prerequisites before you use PowerShell to run the DeploymentPro module:
- Download and install the BitTitan SDK.
For more information: Read the How do I install the BitTitan SDK?
- Configure your DeploymentPro project in MSPComplete.
For more information: Read the DeploymentPro Guide. The process outlined in this article replaces the steps to run the DeploymentPro module.
- Download the Start-DeploymentProUserBatch.zip file, which contains a CSV file and the PowerShell script file (PS1).
- Create a “Scripts” folder in the root of C:\ (example: C:\Scripts) and extract the contents of the Start-DeploymentProUserBatch.zip file to it.
Before you can use PowerShell to run the DeploymentPro module, you must create a CSV file that lists the users who will need their Outlook email profiles configured by DeploymentPro.
Complete these steps to create a CSV file of users for DeploymentPro:
- Open the csv file that you extracted to the C:\Scripts\ directory.
- Add this information under each column header for every user who will need their Outlook email profiles configured by DeploymentPro:
PrimaryEmailAddress: Enter the users’ primary email addresses that are displayed in the DeploymentPro page in MSPComplete, as shown in the screenshot below.
DestinationEmailAddress: Enter the users’ UserPrincipalName (UPN) for the destination mailbox. This is the email address users will enter when they sign in to their destination mailboxes. You can define different destination domains in the CSV file.
A completed CSV file should look like the example below.
- PrimaryEmailAddress: Enter the users’ primary email addresses that are displayed in the DeploymentPro page in MSPComplete, as shown in the screenshot below.
- Save and close the CSV file.
We recommend that you run the Start-DeploymentProUserBatch PowerShell script to run the DeploymentPro module as soon as possible, even if the email cutover (MX record cutover) won't happen for some time. When you run the DeploymentPro module, you define the date and time in which the DeploymentPro wizard will run on user computers. DMA immediately downloads the DeploymentPro module to user computers, even if the wizard isn’t scheduled to run for some time. Run the DeploymentPro module right away to give yourself enough time to troubleshoot connectivity issues that could occur when DMA tries to download the DeploymentPro module to user computers. Read the Troubleshoot DeploymentPro article for more information.
Complete these steps to run the Start-DeploymentProUserBatch PowerShell script and run the DeploymentPro module:
- Search for Windows PowerShell in the Windows Start menu.
- Right-click Windows PowerShell in the search results, and select Run as administrator.
- Click Yes at the prompt to confirm that you want to allow the app to make changes to your device.
- To confirm that the PowerShell execution policy is set to Unrestricted or RemoteSigned, type this command and press Enter:
- To set the execution policy to Unrestricted if it is currently not set to Unrestricted or RemoteSigned, type this command and press Enter:
Note: Do not change the execution policy to RemoteSigned if it is already set to Unrestricted.
- To set the PowerShell location to the C:\Scripts directory where the required files are stored, type this command and press Enter:
- To run the Start-DeploymentProUserBatch PowerShell script, type this command and press Enter:
- Type R and press Enter to confirm that you want to run the PowerShell script.
- The PowerShell script requests the sample.csv file that you configured earlier. Locate the CSV file (C:\Scripts) and double-click it.
- Type Y and press Enter to specify a date and time to run the DeploymentPro module for users.
- Type a date and time for the DeploymentPro wizard to run on user computers. This date and time should happen soon after the email cutover (MX record cutover) date and time. Use the format listed below:
Example: 2020-04-01 10:00
Note: If you have not identified the email cutover date, then enter a date far in the future (i.e., a few months later than the expected cutover date). When you do this, you should also set a reminder for yourself to rerun the PowerShell script to reschedule the date and time for the DeploymentPro wizard once you have identified the exact date and time for the email cutover.
- Type Y to confirm the date and time.
- Enter your BitTitan username and password and click OK.
- Enter the customer ID from MSPComplete and press Enter. The customer ID can be found in the URL when viewing customer information in MSPComplete as highlighted below.
- The script confirms the user email addresses that were successfully scheduled for DeploymentPro. DMA downloads the DeploymentPro module to user computers at the next heartbeat interval, which could take up to an hour.
Note: You may get an error that users were not scheduled due to insufficient licenses. To run the DeploymentPro module, you must apply subscriptions to each user, or purchase standalone DeploymentPro licenses for each user. Refer to the View, purchase, and edit subscriptions article or the View and purchase licenses article for more information about subscriptions and licenses.
- Perform the mailbox migration.
For more information: Follow the steps in the migration guide for your customer’s source and destination.
- On the email cutover date and time, the DeploymentPro wizard will guide the customer’s users through the configuration of their Outlook email profiles. As users complete the DeploymentPro wizard, their email addresses will progress to the “Completed” phase in the DeploymentPro page.
For more information: Read the End user experience when DeploymentPro reconfigures their Outlook profile article for more information.