Skip to content

Commit 0bef259

Browse files
authored
Merge pull request MicrosoftDocs#1063 from wrall/master
Update documentation for Exchange Migration cmdlets
2 parents b3c75b7 + a694652 commit 0bef259

File tree

7 files changed

+75
-11
lines changed

7 files changed

+75
-11
lines changed

exchange/exchange-ps/exchange/move-and-migration/Complete-MigrationBatch.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ After a migration batch for a local or cross-forest move has successfully run an
3434

3535
When the finalization process is complete, you can remove the batch by using the Remove-MigrationBatch cmdlet.
3636

37-
If a migration batch has a status of Completed with Errors, you can rerun the Complete-MigrationBatch cmdlet. The cmdlet will attempt to finalize the failed users.
37+
If a migration batch has a status of Completed with Errors, you can re-attempt to finalize the failed users. In Exchange Online, use the Start-MigrationBatch cmdlet to retry migration for failed users. In Exchange 2013 or Exchange 2016, use the Complete-MigrationBatch to retry these failed users.
3838

3939
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx).
4040

@@ -101,6 +101,8 @@ Accept wildcard characters: False
101101
```
102102
103103
### -NotificationEmails
104+
This parameter is applicable only to on-premises Exchange.
105+
104106
The NotificationEmails parameter specifies one or more email addresses that status reports are sent to after the migration batch is completed. You can specify multiple email addresses separated by commas.
105107
106108
If you don't use this parameter, the final status report is sent to the administrator who runs the Complete-MigrationBatch cmdlet.

exchange/exchange-ps/exchange/move-and-migration/New-MigrationBatch.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,19 @@ Accept wildcard characters: False
433433
```
434434
435435
### -CompleteAfter
436-
This parameter is reserved for internal Microsoft use.
436+
The CompleteAfter parameter specifies a delay before the batch is completed. The batch is started, but not completed until the date/time you specify with this parameter.
437+
438+
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM".
439+
440+
In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC).
441+
442+
To specify a date/time value for this parameter, use either of the following options:
443+
444+
- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z".
445+
446+
- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313).
447+
448+
This parameter should only be used in the cloud-based service.
437449
438450
```yaml
439451
Type: DateTime
@@ -640,7 +652,11 @@ Accept wildcard characters: False
640652
```
641653
642654
### -ReportInterval
643-
This parameter is reserved for internal Microsoft use.
655+
The ReportInterval parameter specifies how frequently emailed reports should be sent to the email addresses listed within NotificationEmails.
656+
657+
By default, emailed reports are sent every 24 hours for a batch. Setting this value to 0 indicates that reports should never be sent for this batch.
658+
659+
This parameter should only be used in the cloud-based service.
644660
645661
```yaml
646662
Type: TimeSpan
@@ -697,7 +713,19 @@ Accept wildcard characters: False
697713
```
698714
699715
### -StartAfter
700-
This parameter is reserved for internal Microsoft use.
716+
The StartAfter parameter specifies a delay before the data migration for the users within the batch is started. The batch is started, but the data migration for users within the batch isn't started until the date/time you specify with this parameter.
717+
718+
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM".
719+
720+
In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC).
721+
722+
To specify a date/time value for this parameter, use either of the following options:
723+
724+
- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z".
725+
726+
- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313).
727+
728+
This parameter should only be used in the cloud-based service.
701729
702730
```yaml
703731
Type: DateTime

exchange/exchange-ps/exchange/move-and-migration/New-MigrationEndpoint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -579,7 +579,7 @@ Accept wildcard characters: False
579579
### -Security
580580
This parameter is available only in the cloud-based service.
581581
582-
The Security parameter specifies the encryption method used by the IMAP server for an IMAP migration. Options are None, SSL (the default), or TLS. This parameter is required when you want to migrate data from an on-premises IMAP server to cloud-based mailboxes.
582+
For an IMAP migration, the Security parameter specifies the encryption method used by the remote mail server. The options are None, Tls, or Ssl.
583583
584584
```yaml
585585
Type: None | Ssl | Tls

exchange/exchange-ps/exchange/move-and-migration/Set-MigrationBatch.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,19 @@ Accept wildcard characters: False
145145
```
146146
147147
### -CompleteAfter
148-
This parameter is reserved for internal Microsoft use.
148+
The CompleteAfter parameter specifies a delay before the batch is completed. The batch is started, but not completed until the date/time you specify with this parameter.
149+
150+
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM".
151+
152+
In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC).
153+
154+
To specify a date/time value for this parameter, use either of the following options:
155+
156+
- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z".
157+
158+
- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313).
159+
160+
This parameter should only be used in the cloud-based service.
149161
150162
```yaml
151163
Type: DateTime
@@ -255,7 +267,11 @@ Accept wildcard characters: False
255267
```
256268
257269
### -ReportInterval
258-
This parameter is reserved for internal Microsoft use.
270+
The ReportInterval parameter specifies how frequently emailed reports should be sent to the email addresses listed within NotificationEmails.
271+
272+
By default, emailed reports are sent every 24 hours for a batch. Setting this value to 0 indicates that reports should never be sent for this batch.
273+
274+
This parameter should only be used in the cloud-based service.
259275
260276
```yaml
261277
Type: TimeSpan
@@ -287,7 +303,19 @@ Accept wildcard characters: False
287303
```
288304
289305
### -StartAfter
290-
This parameter is reserved for internal Microsoft use.
306+
The StartAfter parameter specifies a delay before the data migration for the users within the batch is started. The batch is started, but the data migration for users within the batch isn't started until the date/time you specify with this parameter.
307+
308+
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2015 to specify September 1, 2015. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2015 5:00 PM".
309+
310+
In Exchange Online, if you specify a date/time value without a time zone, the value is in Coordinated Universal Time (UTC).
311+
312+
To specify a date/time value for this parameter, use either of the following options:
313+
314+
- Specify the date/time value in UTC: For example, "2016-05-06 14:30:00z".
315+
316+
- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, (Get-Date "5/6/2016 9:30 AM").ToUniversalTime(). For more information, see Get-Date (https://go.microsoft.com/fwlink/p/?LinkID=113313).
317+
318+
This parameter should only be used in the cloud-based service.
291319
292320
```yaml
293321
Type: DateTime

exchange/exchange-ps/exchange/move-and-migration/Set-MigrationEndpoint.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Accept wildcard characters: False
8787
### -Authentication
8888
This parameter is available only in the cloud-based service.
8989
90-
The Authentication parameter specifies the authentication method used by the on-premises mail server.
90+
The Authentication parameter specifies the authentication method used by the remote mail server.
9191
9292
```yaml
9393
Type: Basic | Digest | Ntlm | Fba | WindowsIntegrated | LiveIdFba | LiveIdBasic | WSSecurity | Certificate | NegoEx | OAuth | Adfs | Kerberos | Negotiate | LiveIdNegotiate | Misconfigured
@@ -295,7 +295,9 @@ Accept wildcard characters: False
295295
```
296296
297297
### -Security
298-
This parameter is reserved for internal Microsoft use.
298+
This parameter is available only in the cloud-based service.
299+
300+
For an IMAP migration, the Security parameter specifies the encryption method used by the remote mail server. The options are None, Tls, or Ssl.
299301
300302
```yaml
301303
Type: None | Ssl | Tls

exchange/exchange-ps/exchange/move-and-migration/Start-MigrationBatch.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ Start-MigrationBatch [[-Identity] <MigrationBatchIdParameter>] [-Confirm] [-Doma
2525
## DESCRIPTION
2626
The Start-MigrationBatch cmdlet starts a pending migration batch that was created, but not started, with the New-MigrationBatch cmdlet.
2727

28+
The Start-MigrationBatch cmdlet also will resume a Stopped migration batch or retry failures within a Failed or Synced with Errors migration batch. In the cloud-based service, the Start-MigrationBatch cmdlet can also retry failures within a Completed with Errors migration batch.
29+
30+
In the cloud-based service, the Start-MigrationBatch cmdlet can be run at any time to retry failed users within the batch.
31+
2832
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx).
2933

3034
## EXAMPLES

exchange/exchange-ps/exchange/move-and-migration/Test-MigrationServerAvailability.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -513,7 +513,7 @@ Accept wildcard characters: False
513513
### -Security
514514
This parameter is available only in the cloud-based service.
515515
516-
The Security parameter specifies the encryption method used by the remote mail server. The options are None, Tls, or Ssl. Use this parameter only when testing the connection to an IMAP server or in preparation for creating a migration endpoint for an IMAP migration.
516+
For an IMAP migration, the Security parameter specifies the encryption method used by the remote mail server. The options are None, Tls, or Ssl.
517517
518518
```yaml
519519
Type: None | Ssl | Tls

0 commit comments

Comments
 (0)