.png)
Get-UMMailboxPolicy
Applies to: Exchange Server 2013
Topic Last Modified: 2012-06-29
Use the Get-UMMailboxPolicy cmdlet to display the properties and values of a Unified Messaging (UM) mailbox policy.
For information about the parameter sets in the Syntax section below, see Syntax.
Get-UMMailboxPolicy [-Identity <MailboxPolicyIdParameter>] [-DomainController <Fqdn>] [-Organization <OrganizationIdParameter>] [-UMDialPlan <UMDialPlanIdParameter>]
This example returns a formatted list of all UM mailbox policies in the Active Directory forest.
Get-UMMailboxPolicy | Format-List
This example returns the properties and values for the UM mailbox policy MyUMMailboxPolicy.
Get-UMMailboxPolicy -Identity MyUMMailboxPolicy
This examples displays all the UM mailbox policies associated with the UM dial plan MyUMDialPlan.
Get-UMMailboxPolicy -UMDialPlan MyUMDialPlan
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.
| 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 specifies that all UM mailbox policies associated with the UM dial plan are displayed. |
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.
