Get-UmServer

Reference

Module:: ExchangePowerShell

Applies to:: Exchange Server 2010

This cmdlet is available only in Exchange Server 2010.

Use the Get-UMServer cmdlet to view settings that are associated with the Unified Messaging (UM) server role.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Syntax

Get-UmServer
   [[-Identity] <UMServerIdParameter>]
   [-DomainController <Fqdn>]
   [<CommonParameters>]

Description

The Get-UMServer cmdlet retrieves the properties for a Unified Messaging server or returns a list of available UM servers from Active Directory. When the cmdlet is used for a single UM server, it returns the UM server properties including MaxCalls, MaxFaxCalls, and UMDialPlans. The properties and their values for the UM 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 Management Console when you select Server Configuration.

After this task is completed, you can view the parameters and values for a single Unified Messaging server or a list of all of the Unified Messaging servers in Active Directory.

You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.

Examples

Example 1

Get-UMServer

This example returns a summary list of Unified Messaging servers in the organization.

Example 2

Get-UMServer -Identity MyUMServer | Format-List

This example returns detailed information for the Unified Messaging server named MyUMServer.

Parameters

-DomainController

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Type:	Fqdn
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010

-Identity

The Identity parameter specifies the Unified Messaging server that you want to view. You can use any value that uniquely identifies the server. For example:

Name
GUID
Distinguished name (DN)
ExchangeLegacyDN

Type:	UMServerIdParameter
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Server 2010

Inputs

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.

Outputs

Output 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.