Get-MailboxDatabase

  • Article

 

Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3

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

Syntax

Get-MailboxDatabase [-Identity <DatabaseIdParameter>] [-DomainController <Fqdn>] [-IncludePreExchange2007 <SwitchParameter>] [-Status <SwitchParameter>]

Get-MailboxDatabase -Server <ServerIdParameter> [-DomainController <Fqdn>] [-IncludePreExchange2007 <SwitchParameter>] [-Status <SwitchParameter>]

Get-MailboxDatabase -StorageGroup <StorageGroupIdParameter> [-DomainController <Fqdn>] [-IncludePreExchange2007 <SwitchParameter>] [-Status <SwitchParameter>]

Detailed Description

To run the Get-MailboxDatabase cmdlet, the account you use must be delegated the following:

  • Exchange View-Only Administrator role

For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.

If you use the Get-MailboxDatabase cmdlet with no parameters, it will get information about all mailbox databases in the Exchange organization

If you use the Get-MailboxDatabase cmdlet with the Server parameter, it will get information about all mailbox databases on the server that you specify.

If you use the Get-MailboxDatabase cmdlet with the StorageGroup parameter, it will get information about all mailbox databases in the storage group that you specify.

Parameters

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 will retrieve information about all of the mailbox databases on the server that you specify.

StorageGroup

Required

Microsoft.Exchange.Configuration.Tasks.StorageGroupIdParameter

The StorageGroup parameter specifies the name of the storage group from which to retrieve mailbox database information. If you specify this parameter, the command will retrieve information about all of the mailbox databases on the storage group that you specify.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name (FQDN) of the domain controller that retrieves data from the Active Directory directory service, include the DomainController parameter in the command.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter

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

  • GUID

  • Distinguished name (DN)

  • Server\storage group\database name

  • Server\database name

  • Storage groupname\database name

If you do not specify the server name, the cmdlet will search for databases on the local server. If you have multiple databases with the same name, the cmdlet will retrieve all databases with the same name in the specified scope.

IncludePreExchange2007

Optional

System.Management.Automation.SwitchParameter

The IncludePreExchange2007 parameter specifies that you want to include information about mailbox databases on earlier versions of Exchange Server in addition to mailbox databases on Exchange Server 2007.

Status

Optional

System.Management.Automation.SwitchParameter

The Status parameter specifies whether you want to get information about the following attributes:

  • BackupInProgress

  • Mounted

  • OnlineMaintenanceInProgress

You do not need to specify any value with this parameter.

If you specify this parameter, you should format the output in such a way that you can view the additional attributes. For example, pipe the output to format-list.

Input Types

Return Types

Errors

Error Description

 

Exceptions

Exceptions Description

 

Example

The first example shows how to get information about all of the mailbox databases in the Exchange organization, including the mailbox databases that reside on Exchange 2003 servers.

The second example shows how to get information about MailboxDatabase01 on Server01. This example also gets the status information, and pipes the output to format-list so that you can view all the information about the mailbox database.

The third example shows how to view the name and storage group, and whether the database is mounted, for all mailbox databases.

Get-MailboxDatabase -IncludePreExchange2007
Get-MailboxDatabase -Identity Server01\StorageGroup01\MailboxDatabase01 -Status | format-list
Get-MailboxDatabase -Status | format-table Name,StorageGroup,Mounted