Get-MailboxDatabaseCopyStatus
Applies to: Exchange Server 2013
Topic Last Modified: 2013-05-16
Use the Get-MailboxDatabaseCopyStatus cmdlet to view health and status information about one or more mailbox database copies.
For information about the parameter sets in the Syntax section below, see Syntax.
Get-MailboxDatabaseCopyStatus -Server <MailboxServerIdParameter> <COMMON PARAMETERS>
Get-MailboxDatabaseCopyStatus [-Identity <DatabaseCopyIdParameter>] [-Local <SwitchParameter>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-Active <SwitchParameter>] [-ConnectionStatus <SwitchParameter>] [-DomainController <Fqdn>] [-ExtendedErrorInfo <SwitchParameter>] [-UseServerCache <SwitchParameter>]
This example returns status information for all copies of the database DB1. The status results are displayed in a list format.
Get-MailboxDatabaseCopyStatus -Identity DB1 | Format-List
This example returns the status for all database copies on the Mailbox server MBX1. The status results are also displayed in a list format.
Get-MailboxDatabaseCopyStatus -Server MBX1 | Format-List
This example returns the status for the copy of database DB1 on the Mailbox server MBX2. The status results are also displayed in a list format.
Get-MailboxDatabaseCopyStatus -Identity DB1\MBX2 | Format-List
If a database is specified by using the Identity parameter with the command, the status of all copies of the database is returned. If a server is specified by using the Server parameter with the command, information about all database copies on the server is returned. If neither parameter is specified with the command, information about all database copies in the organization is returned.
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 "Database availability groups" entry in the High Availability and Site Resilience Permissions topic.
| Parameter | Required | Type | Description |
|---|---|---|---|
| Server | Required | Microsoft.Exchange.Configuration.Tasks.MailboxServerIdParameter | The Server parameter specifies that a Mailbox server returns status information for all of its mailbox database copies. This parameter can't be combined with the Identity parameter. |
| Active | Optional | System.Management.Automation.SwitchParameter | The Active switch specifies whether to return mailbox database copy status for the active mailbox database copy only. |
| ConnectionStatus | Optional | System.Management.Automation.SwitchParameter | The ConnectionStatus switch is obsolete and in the process of being deprecated. Use of this switch will be ignored by the task. The information previously provided by this switch is now provided through an internal caching mechanism and, as such, the switch is no longer needed. |
| 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. |
| ExtendedErrorInfo | Optional | System.Management.Automation.SwitchParameter | The ExtendedErrorInfo switch specifies whether to return an output object containing any exception details. |
| Identity | Optional | Microsoft.Exchange.Configuration.Tasks.DatabaseCopyIdParameter | The Identity parameter specifies the name of the database copy for which the command should gather information. The Identity parameter can be specified in the form of <database>\<server>. Specifying just <database> returns information for all copies of the database. This parameter can't be combined with the Server parameter. |
| Local | Optional | System.Management.Automation.SwitchParameter | The Local switch specifies whether to return mailbox database copy status information from only the local Mailbox server. |
| UseServerCache | Optional | System.Management.Automation.SwitchParameter | The UseServerCache switch specifies whether to enable a server-side remote procedure call (RPC) caching of status information for 5 seconds. |
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.
