Applies to: Exchange Server 2013

Topic Last Modified: 2012-12-11

Use the Get-PublicFolderMigrationRequest cmdlet to view the detailed status of on-going public folder migration requests that were initiated by using the New-PublicFolderMigrationRequest cmdlet.

For information about the parameter sets in the Syntax section below, see Syntax.

Syntax

Get-PublicFolderMigrationRequest [-AccountPartition <AccountPartitionIdParameter>] [-Identity <PublicFolderMigrationRequestIdParameter>] [-Organization <OrganizationIdParameter>] <COMMON PARAMETERS>
Get-PublicFolderMigrationRequest [-AccountPartition <AccountPartitionIdParameter>] [-BatchName <String>] [-HighPriority <$true | $false>] [-Name <String>] [-Organization <OrganizationIdParameter>] [-RequestQueue <DatabaseIdParameter>] [-Status <None | Queued | InProgress | AutoSuspended | CompletionInProgress | Completed | CompletedWithWarning | Suspended | Failed>] [-Suspend <$true | $false>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-DomainController <Fqdn>] [-ResultSize <Unlimited>]

Examples

EXAMPLE 1

This example returns the status of in-progress migration requests.

Copy Code
Get-PublicFolderMigrationRequest

EXAMPLE 2

This example returns all migration requests that have the name PFMigrate10_11_12, and the request has been suspended.

Copy Code
Get-PublicFolderMigrationRequest -Identity "PFMigrate10_11_12" | Format-List Suspended,AutoSuspended

Detailed Description

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Public folders" entry in the Sharing and Collaboration Permissions topic.

Parameters

Parameter Required Type Description

AccountPartition

Optional

Microsoft.Exchange.Configuration.Tasks.AccountPartitionIdParameter

This parameter is reserved for internal Microsoft use.

BatchName

Optional

System.String

The BatchName parameter specifies the name that was given to a batch migration request.

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

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory.

HighPriority

Optional

System.Boolean

The HighPriority parameter specifies that the command returns all migration requests with a status of HighPriority.

Identity

Optional

Microsoft.Exchange.Management.RecipientTasks.PublicFolderMigrationRequestIdParameter

The Identity parameter specifies the identity of the public folder. You can use the following values:

  • GUID

  • Name

You can’t use this parameter in conjunction with the following parameters:

  • BatchName

  • RequestQueue

  • Status

  • Suspend

Name

Optional

System.String

The Name parameter specifies the name of the public folder migration request.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

RequestQueue

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

The RequestQueue parameter specifies the identity of the mailbox database on which the migration request has been run.

You can’t use this parameter in conjunction with the Identity parameter.

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.

Status

Optional

Microsoft.Exchange.Data.Directory.Recipient.RequestStatus

The Status parameter returns migration requests in the specified status. You can use the following values:

  • AutoSuspended

  • Completed

  • CompletedWithWarning

  • CompletionInProgress

  • Failed

  • InProgress

  • None

  • Queued

  • Suspended

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

Suspend

Optional

System.Boolean

The Suspend parameter specifies whether to return public folder migration requests that have been suspended. This parameter accepts $true or $false.

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

Input Types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

Return Types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.