Export (0) Print
Expand All

Get-UMMailbox

Applies to: Exchange Server 2010

Topic Last Modified: 2011-03-19

Use the Get-UMMailbox cmdlet to display the Unified Messaging (UM) properties for a recipient who is UM-enabled.


Get-UMMailbox [-Identity <MailboxIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-IgnoreDefaultScope <SwitchParameter>] [-Organization <OrganizationIdParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>] [-SortBy <String>]


Get-UMMailbox [-Anr <String>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-IgnoreDefaultScope <SwitchParameter>] [-Organization <OrganizationIdParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-ResultSize <Unlimited>] [-SortBy <String>]

Parameter Required Type Description

Anr

Optional

System.String

The Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects that have an attribute that matches that string. The following default attributes are searched:

  • CommonName (CN)
  • DisplayName
  • FirstName
  • LastName
  • Alias

Credential

Optional

System.Management.Automation.PSCredential

The Credential parameter specifies the user name and password to use to access Active Directory.

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.

Filter

Optional

System.String

The Filter parameter filters the results returned by the cmdlet.

For more information about the filterable properties, see Filterable Properties for the -Filter Parameter.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Identity parameter specifies the user to enable for Unified Messaging. The values for this parameter include the following:

  • ADObjectID
  • GUID
  • DN
  • Domain\Account
  • UPN
  • LegacyExchangeDN
  • SmtpAddress
  • Alias

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

The IgnoreDefaultScope parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell session and use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions:

  • You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically.
  • You can only use the distinguished name for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted.
  • You can't use the OrganizationalUnit and Identity parameters together.
  • You can't use the Credential parameter.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

OrganizationalUnit

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

The OrganizationalUnit parameter specifies an organizational unit (OU) and is used to limit the results. If you use this parameter, you retrieve only mailboxes in the container you specify. You can use the OU or the domain name. If you use the OU, you must specify the canonical name of the OU.

ReadFromDomainController

Optional

System.Management.Automation.SwitchParameter

The ReadFromDomainController parameter specifies that the user information is read from a domain controller in the user's domain. If you have set the recipient scope to include all recipients in the forest and if you don't use this parameter, the user information may be read from a global catalog whose information is outdated. If you do use this parameter, multiple reads may be necessary to get the information. By default, the recipient scope is set to the domain that hosts your Exchange servers.

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

The ResultSize parameter specifies a maximum number of results to be returned. Otherwise, a maximum number isn't specified, and the command returns all results.

SortBy

Optional

System.String

The SortBy parameter specifies the attribute by which to sort the results. You can sort by only one attribute at a time. You can sort by the following attributes:

  • Alias
  • DisplayName
  • Name

The results are sorted in ascending order.

The Get-UMMailbox cmdlet retrieves the UM properties for a single UM mailbox. It can also return a list of UM-enabled mailboxes.

After this task is completed, you can see the properties and values configured on a single UM mailbox. Or, if the Identity parameter isn't used, the cmdlet returns a list of all the UM-enabled mailboxes in a forest.

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 "UM mailbox" entry in the Unified Messaging Permissions topic.

Type Description

 

 

Type Description

 

 

Error Description

 

 

This example displays a list of all the UM-enabled mailboxes in the Active Directory forest in a formatted list.

Get-UMMailbox | Format-List

This example displays the UM mailbox properties for tonysmith@contoso.com.

Get-UMMailbox -Identity tonysmith@contoso.com
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft