Get-PublicFolderMigrationRequest

 

Applies to: Exchange Online, Exchange Server 2016

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

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 Exchange cmdlet syntax.

Get-PublicFolderMigrationRequest [-Identity <PublicFolderMigrationRequestIdParameter>] <COMMON PARAMETERS>

Get-PublicFolderMigrationRequest [-BatchName <String>] [-HighPriority <$true | $false>] [-Name <String>] [-RequestQueue <DatabaseIdParameter>] [-Status <None | Queued | InProgress | AutoSuspended | CompletionInProgress | Synced | Completed | CompletedWithWarning | Suspended | Failed>] [-Suspend <$true | $false>] <COMMON PARAMETERS>

COMMON PARAMETERS: [-DomainController <Fqdn>] [-ResultSize <Unlimited>]

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

Get-PublicFolderMigrationRequest

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

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

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.

 

Parameter Required Type Description

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

This parameter is available only in on-premises Exchange 2016.

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.

HighPriority

Optional

System.Boolean

This parameter is available only in on-premises Exchange 2016.

The HighPriority parameter filters the results based on the Priority value that was assigned when the request was created. Valid input for this parameter is $true or $false. Here’s how these values filter the results:

  • $true Returns requests that were created with the Priority value High, Higher, Highest or Emergency.

  • $false Returns requests that were created with the Priority value Normal, Low, Lower or Lowest.

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

Identity

Optional

Microsoft.Exchange.MailboxReplicationService.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.

RequestQueue

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

This parameter is available only in on-premises Exchange 2016.

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:

  • Database GUID

  • Database name

You can't use this parameter 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 filters the results based on status. You can use the following values:

  • AutoSuspended

  • Completed

  • CompletedWithWarning

  • CompletionInProgress

  • Failed

  • InProgress

  • None

  • Queued

  • Suspended

  • Synced

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

Suspend

Optional

System.Boolean

The Suspend parameter specifies whether to return requests that have been suspended. Valid input for this parameter is $true or $false.

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

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.

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.

 
Show: