Share via

Get-MailboxServer

  • Article

 

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

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 Microsoft Exchange Server 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 that is returned is the minimum version of Microsoft Exchange that you can use to manage the returned object. This attribute is not the same as the version of Microsoft Exchange that is displayed in the Exchange Management Console when you select Server Configuration.

To run the Get-MailboxServer 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.

Parameters

Parameter Required Type Description

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxServerIdParameter

This parameter specifies the mailbox server. You can use the following values:

  • Name

  • GUID

  • Distinguished name (DN)

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.

Status

Optional

System.Management.Automation.SwitchParameter

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

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 retrieves all of the mailbox servers in the organization.

The second example retrieves a specific server instance called Server1.

Get-MailboxServer
Get-MailboxServer -Identity Server1