Get-PublicFolderMailboxMigrationRequestStatistics

This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-PublicFolderMailboxMigrationRequestStatistics cmdlet to view the detailed status of individual jobs in a public folder migration batch created using New-MigrationBatch cmdlet.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).

Syntax

Get-PublicFolderMailboxMigrationRequestStatistics
   [-Identity] <PublicFolderMailboxMigrationRequestIdParameter>
   [-Diagnostic]
   [-DiagnosticArgument <String>]
   [-DomainController <Fqdn>]
   [-IncludeReport]
   [-ReportOnly]
   [<CommonParameters>]
Get-PublicFolderMailboxMigrationRequestStatistics
   [-Identity] <PublicFolderMailboxMigrationRequestIdParameter>
   [-DiagnosticInfo <String>]
   [-IncludeReport]
   [-ReportOnly]
   [<CommonParameters>]
Get-PublicFolderMailboxMigrationRequestStatistics
   -RequestQueue <DatabaseIdParameter>
   [-Diagnostic]
   [-DiagnosticArgument <String>]
   [-DomainController <Fqdn>]
   [-IncludeReport]
   [-ReportOnly]
   [-RequestGuid <Guid>]
   [<CommonParameters>]

Description

The Get-PublicFolderMailboxMigrationRequestStatistics cmdlet displays the following properties by default.

  • Name: The name assigned by the system to a specific mailbox migration job.

  • StatusDetail: The current status of the job.

  • TargetMailbox: The mailbox being migrated.

  • PercentComplete: The percentage of job completion.

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.

Examples

Example 1

Get-PublicFolderMailboxMigrationRequestStatistics -Identity \PublicFolderMailboxMigration4ce124b0-d760-4364-94bc-40d7918fd171

This example uses the Identity parameter to return information about the specified target job.

Parameters

-Diagnostic

This parameter is available only in on-premises Exchange.

The Diagnostic switch specifies whether to return extremely detailed information in the results. Typically, you use this switch only at the request of Microsoft Customer Service and Support to troubleshoot problems.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
-DiagnosticArgument

This parameter is available only in on-premises Exchange.

The DiagnosticArgument parameter modifies the results that are returned by using the Diagnostic switch. Typically, you use the Diagnostic switch and the DiagnosticArgument parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
-DiagnosticInfo

This parameter is available only in the cloud-based service.

Typically, you use the DiagnosticInfo parameter only at the request of Microsoft Customer Service and Support to troubleshoot problems.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online
-DomainController

This parameter is available only in on-premises Exchange.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Type:Fqdn
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
-Identity

The Identity parameter specifies the public folder mailbox migration request. The default identity value is \PublicFolderMailboxMigration<UniqueIdentifier> (for example, \PublicFolderMailboxMigration\ac6d9eb4-ee49-405f-b90d-04e9a258bd7e).

You can't use this parameter with the RequestQueue and RequestGuid parameters.

Type:PublicFolderMailboxMigrationRequestIdParameter
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-IncludeReport

The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
-ReportOnly

The ReportOnly switch returns the results as an array of report entries (encoded strings). You don't need to specify a value with this switch.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019, Exchange Online
-RequestGuid

This parameter is available only in on-premises Exchange.

The RequestGuid parameter specifies the unique RequestGuid identifier of the request that you want to view. To find the RequestGuid value, use the Get-PublicFolderMailboxMigrationRequest cmdlet.

If you use this parameter, you also need to use the RequestQueue parameter. You can't use either of these parameters with the Identity parameter.

Type:Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
-RequestQueue

This parameter is available only in on-premises Exchange.

This parameter is for debugging purposes only.

The RequestQueue parameter identifies the request based on the mailbox database where the request is being run. You can use any value that uniquely identifies the database. For example:

  • Name

  • Distinguished name (DN)

  • GUID

You can't use this parameter with the Identity parameter.

Type:DatabaseIdParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

Inputs

Outputs