TechNet
Export (0) Print
Expand All

Get-MailboxDatabase

 

Applies to: Exchange Server 2016

This cmdlet is available only in on-premises Exchange Server 2016.

Use the Get-MailboxDatabase cmdlet to retrieve one or more mailbox database objects from a server or organization.

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

Get-MailboxDatabase -Server <ServerIdParameter> <COMMON PARAMETERS>
Get-MailboxDatabase [-Identity <DatabaseIdParameter>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-DomainController <Fqdn>] [-DumpsterStatistics <SwitchParameter>] [-IncludePreExchange2013 <SwitchParameter>] [-Status <SwitchParameter>]

This example retrieves information about all the mailbox databases in the Exchange organization, including Exchange 2010 mailbox databases.

Get-MailboxDatabase -IncludePreExchange2013

This example retrieves information about MailboxDatabase01 on Server01. This example also retrieves the status information, and pipes the output to the Format-List cmdlet so that you can view all the information about the mailbox database.

Get-MailboxDatabase -Identity MailboxDatabase01 -Server Server01 -Status | Format-List

If you use the Get-MailboxDatabase cmdlet with no parameters, it retrieves information about all mailbox databases in the Exchange organization. If you use the Get-MailboxDatabase cmdlet with the Server parameter, it retrieves information about all mailbox databases on the server that you specify.

The following list describes the properties that are returned in the results.

  • Name   Name of the database.

  • Server   Server hosting the database.

  • Recovery      Specifies whether the new database is designated as a recovery database.

  • ReplicationType   Replication type of the database.

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

 

Parameter Required Type Description

Server

Required

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The Server parameter specifies the name of the server from which to retrieve mailbox database information. If you specify this parameter, the command retrieves information about all of the mailbox databases on the server that you specify.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

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.

DumpsterStatistics

Optional

System.Management.Automation.SwitchParameter

The DumpsterStatistics switch specifies that transport dumpster statistics be returned with the database status. You don't need to specify a value with this switch.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

The Identity parameter specifies a mailbox database. You can use the following values:

  • GUID

  • Distinguished name (DN)

  • Database name

If you have multiple databases with the same name, the command retrieves all databases with the same name in the specified scope.

IncludePreExchange2013

Optional

System.Management.Automation.SwitchParameter

The IncludePreExchange2013 switch parameter specifies whether to return information about Exchange 2010 mailbox databases. You don't need to specify a value with this switch.

Status

Optional

System.Management.Automation.SwitchParameter

The Status switch specifies whether to retrieve the available free space in the database root and information about the following attributes:

  • BackupInProgress

  • Mounted

  • OnlineMaintenanceInProgress

You don't need to specify a value with this switch.

If you specify this switch, you should format the output in such a way that you can view the additional attributes, for example, pipe the output to the Format-List cmdlet.

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