Export (0) Print
Expand All

Set-UMServer

Applies to: Exchange Server 2010

Topic Last Modified: 2011-03-19

Use the Set-UMServer cmdlet to set the properties on a Unified Messaging (UM) server.


Set-UMServer -Identity <UMServerIdParameter> [-Confirm [<SwitchParameter>]] [-DialPlans <MultiValuedProperty>] [-DomainController <Fqdn>] [-ExternalHostFqdn <UMSmartHost>] [-ExternalServiceFqdn <UMSmartHost>] [-GrammarGenerationSchedule <ScheduleInterval[]>] [-MaxCallsAllowed <Nullable>] [-SipTcpListeningPort <Int32>] [-SipTlsListeningPort <Int32>] [-Status <Enabled | Disabled | NoNewCalls>] [-UMForwardingAddressTemplate <String>] [-UMPodRedirectTemplate <String>] [-UMStartupMode <TCP | TLS | Dual>] [-WhatIf [<SwitchParameter>]]

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UMServerIdParameter

The Identity parameter specifies the ID for the Unified Messaging server object to be configured. This parameter specifies the directory object ID for the Unified Messaging server.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

DialPlans

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The DialPlans parameter specifies all the dial plans for which this server will handle UM calls. If no dial plans are defined, the Unified Messaging server will not handle UM calls.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

ExternalHostFqdn

Optional

Microsoft.Exchange.Data.UMSmartHost

The ExternalHostFqdn parameter is the external FQDN or host name of a Unified Messaging server. This host name is sent as the target of a redirect when a Unified Messaging server receives an incoming call. This allows the Microsoft Exchange Unified Messaging service to redirect to the UM Worker Process on the same Unified Messaging server. The ExternalHostFqdn parameter must be used when a Unified Messaging server is located behind a load balancer. The host FQDN is limited to 256 characters.

ExternalServiceFqdn

Optional

Microsoft.Exchange.Data.UMSmartHost

The ExternalServiceFqdn parameter is the FQDN or host name of a load balancer that is servicing Unified Messaging servers. This parameter is useful when you are migrating Unified Messaging servers from within your organization to a Microsoft Exchange Server 2010 hosted environment. The external service host FQDN can contain up to 2,048 characters.

GrammarGenerationSchedule

Optional

Microsoft.Exchange.Common.ScheduleInterval[]

The GrammarGenerationSchedule parameter specifies the scheduled times to start speech grammar generation. This parameter allows only one start time per day. The default scheduled time for grammar generation is 02:00–02:30 local time each day.

MaxCallsAllowed

Optional

System.Nullable

The MaxCallsAllowed parameter specifies the maximum number of concurrent calls that the Unified Messaging server allows.

SipTcpListeningPort

Optional

System.Int32

The SipTcpListeningPort parameter specifies the Transmission Control Protocol (TCP) port used by the Unified Messaging server to receive incoming calls. This TCP port is used by Unified Messaging servers added to a UM dial plan that isn't configured to use SIP Secured or Secured mode. The default is port 5060.

SipTlsListeningPort

Optional

System.Int32

The SipTlsListeningPort parameter specifies the Transport Layer Security (TLS) port used by the Unified Messaging server to receive incoming calls. This TLS port is used by Unified Messaging servers that are added to a UM dial plan configured to use SIP Secured or Secured mode. The default is port 5061.

Status

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ServerStatus

With the Status parameter, you can manipulate the Unified Messaging server status. Enabled, Disabled, and NoNewCalls are the available options.

UMForwardingAddressTemplate

Optional

System.String

The UMForwardingAddressTemplate parameter specifies the FQDN template for forwarding calls to another data center and is reserved for internal Microsoft use.

UMStartupMode

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.UMStartupMode

The UMStartupMode parameter specifies whether the Microsoft Exchange Unified Messaging service on a Unified Messaging server will start up in TCP, TLS or Dual mode. If the UM server is being added to UM dial plans that have different security settings, you should choose Dual mode. In Dual mode, the Unified Messaging server can listen on ports 5060 and 5061 at the same time. If the startup mode is changed, the Microsoft Exchange Unified Messaging service must be restarted.

UMPodRedirectTemplate

Optional

System.String

The UMPodRedirectTemplate parameter is reserved for internal Microsoft use.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

The Set-UMServer cmdlet sets specific properties on a Unified Messaging server. This cmdlet can be used to set individual Unified Messaging parameters for a specified Unified Messaging server.

After this task is completed, the cmdlet sets the parameters and the values that are specified.

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 server" entry in the Unified Messaging Permissions topic.

Error Description

 

 

This example prevents a Unified Messaging server named MyUMServer from accepting new calls.

Set-UMServer -Identity MyUMServer -Status NoNewCalls

This example removes a Unified Messaging server named MyUMServer from all UM dial plans.

Set-UMServer -Identity MyUMServer -DialPlans $null

This example adds the Unified Messaging server named MyUMServer to a UM dial plan named MyUMDialPlanName and also sets the maximum number of incoming voice and fax calls.

Set-UMServer -Identity MyUMServer -DialPlans MyUMDialPlanName -MaxCallsAllowed 50 -MaxFaxCallsAllowed 15

This example changes the grammar generation schedule to 02:30–03:00 every day on a Unified Messaging server named MyUMServer.

Set-UMServer -Identity MyUMServer -GrammarGenerationSchedule 1.02:30-1.03:00, 2.02:30-2.03:00, 3.02:30-3.03:00, 4.02:30-4.03:00, 5.02:30-5.03:00, 6.02:30-6.03:00
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft