TechNet
Export (0) Print
Expand All

Get-MoveRequest

 

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-MoveRequest cmdlet to view the detailed status of an ongoing asynchronous mailbox move that was initiated by using the New-MoveRequest cmdlet.

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

Get-MoveRequest [-Identity <MoveRequestIdParameter>] [-IncludeSoftDeletedObjects <SwitchParameter>] <COMMON PARAMETERS>

Get-MoveRequest [-BatchName <String>] [-Flags <None | CrossOrg | IntraOrg | Push | Pull | Offline | Protected | RemoteLegacy | HighPriority | Suspend | SuspendWhenReadyToComplete | MoveOnlyPrimaryMailbox | MoveOnlyArchiveMailbox | TargetIsAggregatedMailbox | Join | Split | MoveOnlyAuxMailbox>] [-HighPriority <$true | $false>] [-IncludeSoftDeletedObjects <SwitchParameter>] [-MoveStatus <None | Queued | InProgress | AutoSuspended | CompletionInProgress | Synced | Completed | CompletedWithWarning | Suspended | Failed>] [-Offline <$true | $false>] [-Protect <$true | $false>] [-RemoteHostName <Fqdn>] [-SourceDatabase <DatabaseIdParameter>] [-Suspend <$true | $false>] [-SuspendWhenReadyToComplete <$true | $false>] [-TargetDatabase <DatabaseIdParameter>] <COMMON PARAMETERS>

COMMON PARAMETERS: [-Credential <PSCredential>] [-DomainController <Fqdn>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ProxyToMailbox <MailboxIdParameter>] [-ResultSize <Unlimited>] [-SortBy <String>]

This example retrieves the status of the ongoing mailbox move for Tony Smith's mailbox (tony@contoso.com).

Get-MoveRequest -Identity 'tony@contoso.com'

This example retrieves the status of ongoing mailbox moves to the target database DB05.

Get-MoveRequest -MoveStatus InProgress -TargetDatabase DB05

This example retrieves the status of move requests in the FromDB01ToDB02 batch that completed, but had warnings.

Get-MoveRequest -BatchName "FromDB01ToDB02" -MoveStatus CompletedWithWarning

The search criteria for the Get-MoveRequest cmdlet is a Boolean And statement. If you use multiple parameters, it narrows your search and reduces your search results.

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 "Mailbox moves" entry in the Recipients Permissions topic.

 

Parameter Required Type Description

BatchName

Optional

System.String

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

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

Credential

Optional

System.Management.Automation.PSCredential

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

The Credential parameter specifies the user name and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions.

This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see Get-Credential.

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.

Flags

Optional

Microsoft.Exchange.Data.Directory.Recipient.RequestFlags

The Flags parameter specifies the move type to retrieve information for. The following values may be used:

  • CrossOrg

  • HighPriority

  • IntraOrg

  • Join

  • MoveOnlyArchiveMailbox

  • MoveOnlyPrimaryMailbox

  • None

  • Offline

  • Protected

  • Pull

  • Push

  • RemoteLegacy

  • Split

  • Suspend

  • SuspendWhenReadyToComplete

  • TargetIsAggregatedMailbox

HighPriority

Optional

System.Boolean

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

The HighPriority parameter specifies that the cmdlet returns requests that were created with the HighPriority flag. The HighPriority flag indicates that the request should be processed before other lower priority requests in the queue.

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

Identity

Optional

Microsoft.Exchange.MailboxReplicationService.MoveRequestIdParameter

The Identity parameter specifies the identity of the move request, which is the identity of the mailbox or mail user. You can use any value that uniquely identifies the mailbox or mail user.

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • <domain name>\<account name>

  • Email address

  • GUID

  • LegacyExchangeDN

  • SamAccountName

  • User ID or user principal name (UPN)

This parameter can't be used with the following parameters:

  • BatchName

  • HighPriority

  • MoveStatus

  • Offline

  • Protect

  • RemoteHostName

  • SourceDatabase

  • Suspend

  • SuspendWhenReadyToComplete

  • TargetDatabase

IncludeSoftDeletedObjects

Optional

System.Management.Automation.SwitchParameter

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

The IncludeSoftDeletedObjects parameter specifies whether to return mailboxes that have been soft deleted. This parameter accepts $true or $false.

MoveStatus

Optional

Microsoft.Exchange.Data.Directory.Recipient.RequestStatus

The MoveStatus parameter returns move 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 with the Identity parameter.

Offline

Optional

System.Boolean

The Offline parameter specifies whether to return mailboxes that are being moved in offline mode. This parameter accepts $true or $false.

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

OrganizationalUnit

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example:

  • Name

  • Canonical name

  • Distinguished name (DN)

  • GUID

Protect

Optional

System.Boolean

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

The Protect parameter returns mailboxes being moved in protected mode. This parameter accepts $true or $false.

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

ProxyToMailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

PARAMVALUE: MailboxIdParameter

RemoteHostName

Optional

Microsoft.Exchange.Data.Fqdn

The RemoteHostName parameter specifies the FQDN of the cross-forest organization from which you're moving the mailbox.

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.

SortBy

Optional

System.String

The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order.

If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto <Property1>,<Property2>... to create a new view that contains all of the properties that you want to see. Wildcards (*) in the property names are supported.

You can sort by the following properties:

  • Name

  • DisplayName

  • Alias

SourceDatabase

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

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

The SourceDatabase parameter specifies that all mailboxes being moved from the specified source database are returned. You can use the following values:

  • GUID of the database

  • Database name

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

Suspend

Optional

System.Boolean

The Suspend parameter specifies whether to return mailboxes with moves that have been suspended. This parameter accepts $true or $false.

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

SuspendWhenReadyToComplete

Optional

System.Boolean

The SuspendWhenReadytoComplete parameter specifies whether to return mailboxes that have been moved with the New-MoveRequest command and its SuspendWhenReadyToComplete switch. This parameter accepts $true or $false.

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

TargetDatabase

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

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

The TargetDatabase parameter specifies whether to return all mailboxes that are being moved to the specified target database. You can use the following values:

  • GUID of the database

  • Database name

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:
© 2016 Microsoft