Export (0) Print
Expand All
Expand Minimize

Get-MailboxStatistics

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-10-10

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

Use the Get-MailboxStatistics cmdlet to obtain information about a mailbox, such as the size of the mailbox, the number of messages it contains, and the last time it was accessed. In addition, you can get the move history or a move report of a completed move request.

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

Get-MailboxStatistics -Identity <GeneralMailboxOrMailUserIdParameter> [-Archive <SwitchParameter>] [-CopyOnServer <ServerIdParameter>] <COMMON PARAMETERS>
Get-MailboxStatistics [-AuditLog <SwitchParameter>] [-Identity <GeneralMailboxOrMailUserIdParameter>] <COMMON PARAMETERS>
Get-MailboxStatistics -Database <DatabaseIdParameter> [-CopyOnServer <ServerIdParameter>] [-Filter <String>] [-StoreMailboxIdentity <StoreMailboxIdParameter>] <COMMON PARAMETERS>
Get-MailboxStatistics -Server <ServerIdParameter> [-Filter <String>] [-IncludePassive <SwitchParameter>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-DomainController <Fqdn>] [-IncludeMoveHistory <SwitchParameter>] [-IncludeMoveReport <SwitchParameter>] [-IncludeQuarantineDetails <SwitchParameter>] [-NoADLookup <SwitchParameter>]

This example retrieves the mailbox statistics for the mailbox of the user Ayla Kol by using its associated alias AylaKol.

Get-MailboxStatistics -Identity AylaKol

This example retrieves the mailbox statistics for all mailboxes on the server MailboxServer01.

Get-MailboxStatistics -Server MailboxServer01

This example retrieves the mailbox statistics for the specified mailbox.

Get-MailboxStatistics -Identity contoso\chris

This example retrieves the mailbox statistics for all mailboxes in the specified mailbox database.

Get-MailboxStatistics -Database "Mailbox Database"

This example retrieves the mailbox statistics for the disconnected mailboxes for all mailbox databases in the organization. The -ne operator means not equal.

Get-MailboxDatabase | Get-MailboxStatistics -Filter 'DisconnectDate -ne $null'

This example retrieves the mailbox statistics for a single disconnected mailbox. The value for the StoreMailboxIdentity parameter is the mailbox GUID of the disconnected mailbox. You can also use the LegacyDN.

Get-MailboxStatistics -Database "Mailbox Database" -StoreMailboxIdentity 3b475034-303d-49b2-9403-ae022b43742d

This example returns the summary move history for the completed move request for Ayla Kol's mailbox. If you don't pipeline the output to the Format-List cmdlet, the move history doesn't display.

Get-MailboxStatistics -Identity AylaKol -IncludeMoveHistory | Format-List

This example returns the detailed move history for the completed move request for Ayla Kol's mailbox. This example uses a temporary variable to store the mailbox statistics object. If the mailbox has been moved multiple times, there are multiple move reports. The last move report is always MoveReport[0].

$temp=Get-MailboxStatistics -Identity AylaKol -IncludeMoveHistory
$temp.MoveHistory[0]

This example returns the detailed move history and a verbose detailed move report for Ayla Kol's mailbox. This example uses a temporary variable to store the move request statistics object and outputs the move report to a CSV file.

$temp=Get-MailboxStatistics -Identity AylaKol -IncludeMoveReport
$temp.MoveHistory[0] | Export-CSV C:\MoveReport_AylaKol.csv

On Mailbox servers only, you can use the Get-MailboxStatistics cmdlet without parameters. In this case, the cmdlet returns the statistics for all mailboxes on all databases on the local server.

NoteNote:
The Get-MailboxStatistics cmdlet requires at least one of the following parameters to complete successfully: Server, Database, or Identity.

You can use the Get-MailboxStatistics cmdlet to return detailed move history and a move report for completed move requests to troubleshoot a move request. To view the move history, you must pass this cmdlet as an object. Move histories are retained in the mailbox database and are numbered incrementally, and the last executed move request is always numbered 0. For more information, see "EXAMPLE 7," "EXAMPLE 8," and "EXAMPLE 9" in this topic.

NoteNote:
You can only see move reports and move history for completed move requests.

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 "Recipient Provisioning Permissions" section in the Recipients Permissions topic.

 

Parameter Required Type Description

Database

Required

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

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

The Database parameter specifies the name of the mailbox database. When you specify a value for the Database parameter, the Exchange Management Shell returns statistics for all the mailboxes on the database specified.

You can use the following values:

  • GUID

  • Database

This parameter accepts pipeline input from the Get-MailboxDatabase cmdlet.

Identity

Required

Microsoft.Exchange.Configuration.Tasks.GeneralMailboxOrMailUserIdParameter

The Identity parameter specifies a mailbox. When you specify a value for the Identity parameter, the command looks up the mailbox specified in the Identity parameter, connects to the server where the mailbox resides, and returns the statistics for the mailbox.

This parameter accepts the following values:

  • Alias

    Example: JPhillips

  • Canonical DN

    Example: Atlanta.Corp.Contoso.Com/Users/JPhillips

  • Display Name

    Example: Jeff Phillips

  • Distinguished Name (DN)

    Example: CN=JPhillips,CN=Users,DC=Atlanta,DC=Corp,DC=contoso,DC=com

  • Domain\Account

    Example: Atlanta\JPhillips

  • GUID

    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2

  • Immutable ID

    Example: fb456636-fe7d-4d58-9d15-5af57d0354c2@contoso.com

  • Legacy Exchange DN

    Example: /o=Contoso/ou=AdministrativeGroup/cn=Recipients/cn=JPhillips

  • SMTP Address

    Example: Jeff.Phillips@contoso.com

  • User Principal Name

    Example: JPhillips@contoso.com

Server

Required

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

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

The Server parameter specifies the server from which you want to obtain mailbox statistics. You can use one of the following values:

  • Fully qualified domain name (FQDN)

  • NetBIOS name

When you specify a value for the Server parameter, the command returns statistics for all the mailboxes on all the databases, including recovery databases, on the specified server. If you don't specify this parameter, the command returns logon statistics for the local server.

Archive

Optional

System.Management.Automation.SwitchParameter

The Archive switch parameter specifies whether to return mailbox statistics for the archive mailbox associated with the specified mailbox.

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

AuditLog

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

CopyOnServer

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

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

The CopyOnServer parameter is used to retrieve statistics from a specific database copy on the server specified with the Server parameter.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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

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

Filter

Optional

System.String

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

The Filter parameter specifies a filter to filter the results of the Get-MailboxStatistics cmdlet. For example, to display all disconnected mailboxes on a specific mailbox database, use the following syntax for this parameter: -Filter 'DisconnectDate -ne $null'

IncludeMoveHistory

Optional

System.Management.Automation.SwitchParameter

The IncludeMoveHistory switch specifies whether to return additional information about the mailbox that includes the history of a completed move request, such as status, flags, target database, bad items, start times, end times, duration that the move request was in various stages, and failure codes.

IncludeMoveReport

Optional

System.Management.Automation.SwitchParameter

The IncludeMoveReport switch specifies whether to return a verbose detailed move report for a completed move request, such as server connections and move stages.

NoteNote:
Because the output of this command is verbose, you should send the output to a .CSV file for easier analysis.

IncludePassive

Optional

System.Management.Automation.SwitchParameter

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

Without the IncludePassive parameter, the cmdlet retrieves statistics from active database copies only. Using the IncludePassive parameter, you can have the cmdlet return statistics from all active and passive database copies.

IncludeQuarantineDetails

Optional

System.Management.Automation.SwitchParameter

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

The IncludeQuarantineDetails switch specifies whether to return additional quarantine details about the mailbox that aren't otherwise included in the results. You can use these details to determine when and why the mailbox was quarantined.

Specifically, this switch returns the values of the QuarantineDescription, QuarantineLastCrash and QuarantineEnd properties on the mailbox. To see these values, you need use a formatting cmdlet. For example, Get-MailboxStatistics <MailboxIdentity> -IncludeQuarantineDetails | Format-List Quarantine*.

NoADLookup

Optional

System.Management.Automation.SwitchParameter

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

The NoADLookup switch specifies that information is retrieved from the mailbox database, and not from Active Directory. This helps improve cmdlet performance when querying a mailbox database that contains a large number of mailboxes.

StoreMailboxIdentity

Optional

Microsoft.Exchange.Configuration.Tasks.StoreMailboxIdParameter

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

The StoreMailboxIdentity parameter specifies the mailbox identity when used with the Database parameter to return statistics for a single mailbox on the specified database. You can use one of the following values:

  • MailboxGuid

  • LegacyDN

Use this syntax to retrieve information about disconnected mailboxes, which don’t have a corresponding Active Directory object or that has a corresponding Active Directory object that doesn’t point to the disconnected mailbox in the mailbox database.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft