Export (0) Print
Expand All
Related Help Topics
Loading
No resources found.
Related Blog Articles
Loading
No resources found.
Expand Minimize

Get-MailboxImportRequest

Exchange 2010
 

Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-12-10

Use the Get-MailboxImportRequest cmdlet to view the detailed status of an ongoing import request that was initiated using the New-MailboxImportRequest cmdlet.

Get-MailboxImportRequest [-Identity <MailboxImportRequestIdParameter>] [-DomainController <Fqdn>] [-MultiTenant <SwitchParameter>] [-Organization <OrganizationIdParameter>] [-ResultSize <Unlimited>]
Get-MailboxImportRequest [-BatchName <String>] [-Database <DatabaseIdParameter>] [-DomainController <Fqdn>] [-HighPriority <$true | $false>] [-Mailbox <MailboxOrMailUserIdParameter>] [-MultiTenant <SwitchParameter>] [-Name <String>] [-Organization <OrganizationIdParameter>] [-ResultSize <Unlimited>] [-Status <None | Queued | InProgress | AutoSuspended | CompletionInProgress | Completed | CompletedWithWarning | Suspended | Failed>] [-Suspend <$true | $false>]

The search criteria for the Get-MailboxImportRequest cmdlet is a Boolean And statement. If you use multiple parameters, you narrow your search and reduce 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 "Import Export" entry in the Mailbox Permissions topic.

 

Parameter Required Type Description

Identity

Optional

Microsoft.Exchange.Management.RecipientTasks.MailboxImportRequestIdParameter

The Identity parameter specifies the identity of the import request. By default, import requests are named <alias>\MailboxImportX (where X = 0–9). If you specify a name for the import request, use the following syntax: <alias>\<name>. Microsoft Exchange Server 2010 automatically precedes the request with the mailbox's alias.

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

  • BatchName

  • Database

  • Mailbox

  • Name

  • Status

  • Suspend

BatchName

Optional

System.String

The BatchName parameter specifies the name given to a batch import request.

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

Database

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

The Database parameter specifies the database in which the user's mailbox or archive resides. You can use the following values:

  • GUID of the database

  • Database name

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 cmdlet returns requests that were created by using 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 in conjunction with the Identity parameter.

Mailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxOrMailUserIdParameter

The Mailbox parameter specifies the identity of the mailbox or mail user. You can use the following values:

  • GUID

  • Distinguished name (DN)

  • Domain\Account

  • User principal name (UPN)

  • Legacy Exchange DN

  • SMTP address

  • Alias

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

MultiTenant

Optional

System.Management.Automation.SwitchParameter

This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support.

The MultiTenant parameter specifies that the search should be performed across the entire forest, not just across the organization that's currently scoped.

You don't have to specify a value with this parameter.

Name

Optional

System.String

The Name parameter specifies that import requests that have the specified name are returned.

Use this parameter to search on the name that you provided when you created the import request. If you didn't specify a name when the request was created, the default name is MailboxImportX (where X = 0-9).

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

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support.

The Organization parameter specifies the organization in which you'll perform this action. This parameter doesn't accept wildcard characters, and you must use the exact name of the organization.

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 specifies that import requests with the specified status are returned. You can use the following values:

  • AutoSuspended

  • Completed

  • CompletionInProgress

  • CompletedWithWarning

  • Failed

  • InProgress

  • None

  • Queued

  • Suspended

noteNote:
CompletionInProgress and AutoSuspended don't apply to import requests and won't return any information.

You can't use this parameter in conjunction 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 in conjunction 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.

This example returns the default information regarding the status of the ongoing import request with the identity tony\Recovered. The type of information returned by default includes name, mailbox, and status.

Get-MailboxImportRequest -Identity "tony\Recovered"

This example returns the status of in progress import requests for mailboxes or archives that reside on database DB01.

Get-MailboxImportRequest -Status InProgress -Database DB01

This example returns the status of import requests in the ImportingDB1PSTs batch that completed.

Get-MailboxImportRequest -BatchName "ImportingDB1PSTs" -Status Completed

This example returns all import requests that have the name Recovered where the import has been suspended.

Get-MailboxImportRequest -Name "Recovered" -Suspend $true
 © 2010 Microsoft Corporation. All rights reserved.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft