Applies to: Exchange Server 2013
Topic Last Modified: 2012-07-09
Use the Get-UMService cmdlet to display the properties for a single Mailbox server that's running the Microsoft Exchange Unified Messaging service or to display a list of Mailbox servers that are running the Microsoft Exchange Unified Messaging service.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Get-UMService [-Identity <UMServerIdParameter>]
[-DomainController <Fqdn>]
|
Examples
EXAMPLE 1
This example displays a list of all the Mailbox servers in the Active Directory forest.
Copy Code | |
---|---|
Get-UMService |
EXAMPLE 2
This example displays a formatted list of properties for the Mailbox server MyUMServer.
Copy Code | |
---|---|
Get-UMService -Identity MyUMServer | Format-List |
Detailed Description
The Get-UMService cmdlet retrieves the properties for a Mailbox server that's running the Microsoft Exchange Unified Messaging service or returns a list of available Mailbox servers from Active Directory. When the cmdlet is used for a single Mailbox server, it returns the Mailbox server properties including MaxCalls, MaxFaxCalls, and UMDialPlans. The properties and their values for the Mailbox server are stored in the Unified Messaging section of the Exchange Server configuration object in Active Directory.
The ExchangeVersion attribute that's returned is the minimum version of Microsoft Exchange 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 Administration Center when you select Server Configuration.
After this task is completed, you can view the parameters and values for a single Mailbox server or a list of all of the Mailbox servers in Active Directory.
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 (UM service)" 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.UMServerIdParameter |
The Identity parameter specifies the name of the Mailbox server that's running the Microsoft Exchange Unified Messaging service. If this parameter isn't supplied, a list of all Mailbox servers is returned. |
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.