Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-11-15

Use the Get-MailboxServer cmdlet to return a Mailbox server object and all its attributes. If no parameter is specified, a complete list of the Mailbox servers in the entire Exchange organization is returned.

Syntax

Get-MailboxServer [-Identity <MailboxServerIdParameter>] [-DomainController <Fqdn>] [-Status <SwitchParameter>]

Detailed Description

To view all the Mailbox server attributes that this cmdlet returns, you must pipe the command to the Format-List cmdlet.

The ExchangeVersion attribute returned is the minimum version of Microsoft Exchange that you can use to manage the returned object. This attribute isn't the same as the version of Microsoft Exchange that's displayed in the Exchange Management Console when you select Server Configuration.

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 server configuration" entry in the Mailbox Permissions topic.

Parameters

Parameter Required Type Description

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.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxServerIdParameter

The Identity parameter specifies the Mailbox server. You can use the following values:

  • Name

  • GUID

  • Distinguished name (DN)

Status

Optional

System.Management.Automation.SwitchParameter

The Status parameter specifies whether you want to get additional status information, such as locale.

You don't 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 the Format-List cmdlet.

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.

Examples

EXAMPLE 1

This example retrieves all the Mailbox servers in the organization.

Copy Code
Get-MailboxServer

EXAMPLE 2

This example retrieves a specific server instance called Server1.

Copy Code
Get-MailboxServer -Identity Server1