Applies to: Exchange Server 2013
Topic Last Modified: 2012-12-11
Use the Get-MailboxExportRequest cmdlet to view the detailed status of an ongoing export request that was initiated by using the New-MailboxExportRequest cmdlet.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Get-MailboxExportRequest [-AccountPartition
<AccountPartitionIdParameter>] [-Identity
<MailboxExportRequestIdParameter>] [-Organization
<OrganizationIdParameter>] <COMMON PARAMETERS>
|
Get-MailboxExportRequest [-AccountPartition
<AccountPartitionIdParameter>] [-BatchName <String>]
[-HighPriority <$true | $false>] [-Mailbox
<MailboxOrMailUserIdParameter>] [-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 the ongoing export request with the identity tony\DB01toPST.
 Copy Code |
|
|---|---|
Get-MailboxExportRequest -Identity "tony\DB01toPST" |
|
EXAMPLE 2
This example returns the status of export requests in the Attachment_CompanyReport batch that completed.
| Copy Code |
|
|---|---|
Get-MailboxExportRequest -BatchName "Attachment_CompanyReport" -Status Completed |
|
EXAMPLE 3
This example returns all export requests that have the name DB01toPST where the export has been suspended.
| Copy Code |
|
|---|---|
Get-MailboxExportRequest -Name "DB01toPST" -Suspend $true |
|
Detailed Description
The search criteria for the Get-MailboxExportRequest 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 Recipients 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 given to a batch export 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 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 in conjunction with the Identity parameter. |
||
|
Identity |
Optional |
Microsoft.Exchange.Management.RecipientTasks.MailboxExportRequestIdParameter |
The Identity parameter specifies the identity of the export request. By default, export requests are named <alias>\MailboxExportX (where X = 0–9). If you specified a name for the export request when the request was created using the New-MailboxExportRequest cmdlet, use the following syntax: <alias>\<name>. Microsoft Exchange Server 2013 automatically precedes the request with the mailbox's alias. This parameter can't be used in conjunction with the following parameters:
|
||
|
Mailbox |
Optional |
Microsoft.Exchange.Configuration.Tasks.MailboxOrMailUserIdParameter |
The Mailbox parameter specifies the identity of the mailbox or mail user from which contents are being exported. You can use the following values:
You can't use this parameter in conjunction with the Identity parameter. |
||
|
Name |
Optional |
System.String |
The Name parameter specifies that export requests that have the specified name are returned. Use this parameter to search on the name that you provided when you created the export request. If you didn't specify a name when the request was created, the default name is MailboxExportX (where X = 0–9). You can't use this parameter in conjunction with the Identity parameter. |
||
|
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
The Organization parameter specifies the organization you want configuration data from. |
||
|
RequestQueue |
Optional |
Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter |
The RequestQueue parameter specifies that the cmdlet retrieves requests that are based in a queue on the specified database. By default, the request is created in a queue on the same database as where the mailbox is hosted. |
||
|
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 |
||
|
Status |
Optional |
Microsoft.Exchange.Data.Directory.Recipient.RequestStatus |
The Status parameter specifies that export requests with the specified status are returned. You can use the following values:
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 export requests that have been suspended. This
parameter accepts You can't use this parameter in conjunction with the Identity parameter. |
Note: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.