Get-UMServer
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The Get-UMServer cmdlet displays the properties for a single computer that is running Microsoft Exchange Server 2007 that has the Unified Messaging server role installed or displays a list of servers that are enabled for Unified Messaging (UM).
Syntax
Get-UMServer [-Identity <UMServerIdParameter>] [-DomainController <Fqdn>]
Detailed Description
The Get-UMServer cmdlet retrieves the properties for a Unified Messaging server or returns a list of available Unified Messaging servers from Active Directory. When the cmdlet is used for a single Unified Messaging server, it returns the Unified Messaging server properties including status, MaxCalls, MaxFaxCalls, and UMDialPlans. The properties and their values for the Unified Messaging server are stored in the UM section of the Exchange Server configuration object in Active Directory.
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-UMServer cmdlet on a computer that has the Unified Messaging server role installed, the account you use must be delegated the 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 |
|---|---|---|---|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet. |
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.UMServerIdParameter |
This parameter specifies the name of the Unified Messaging server. If this parameter is not supplied, a list of all Unified Messaging servers will be returned. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Exceptions
| Exceptions | Description |
|---|---|
|
|
Example
The first example displays a list of all the Unified Messaging servers in the Active Directory forest.
The second example displays a formatted list of properties for the Unified Messaging server named MyUMServer.
Get-UMServer
Get-UMServer -Identity MyUMServer | format-list