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

Topic Last Modified: 2012-11-19

Use the Get-UMMailboxPolicy cmdlet to display the properties and values of a Unified Messaging (UM) mailbox policy.

Syntax

Get-UMMailboxPolicy [-Identity <MailboxPolicyIdParameter>] [-DomainController <Fqdn>] [-Organization <OrganizationIdParameter>] [-UMDialPlan <UMDialPlanIdParameter>]

Detailed Description

The Get-UMMailboxPolicy cmdlet retrieves the configuration properties and values for a UM mailbox policy or returns a list of UM mailbox policies.

After this task is completed, if the Identity parameter is supplied, the properties and values for the specified UM mailbox policy object are returned. If no parameter is specified at the command prompt, all UM mailbox policies in the Active Directory forest are 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 "UM mailbox policies" entry in the Unified Messaging 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.MailboxPolicyIdParameter

The Identity parameter specifies the identifier for the UM mailbox policy being viewed. This is the directory object ID for the UM mailbox policy.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

UMDialPlan

Optional

Microsoft.Exchange.Configuration.Tasks.UMDialPlanIdParameter

The UMDialPlan parameter displays all the UM mailbox policies that are associated with the UM dial plan that's specified.

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 returns a formatted list of all UM mailbox policies in the Active Directory forest.

Copy Code
Get-UMMailboxPolicy | Format-List

EXAMPLE 2

This example returns the properties and values for the UM mailbox policy MyUMMailboxPolicy.

Copy Code
Get-UMMailboxPolicy -Identity MyUMMailboxPolicy

Example 3

This examples displays all the UM mailbox policies that are associated with the UM dial plan MyUMDialPlan.

Copy Code
Get-UMMailboxPolicy -UMDialPlan MyUMDialPlan