Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

Set-UMCallRouterSettings

 

Applies to: Exchange Server 2013

Topic Last Modified: 2013-10-03

Use the Set-UMCallRouterSettings cmdlet to set specific properties on a Client Access server running the Microsoft Exchange Unified Messaging Call Router service. This cmdlet can be used to set individual parameters for a specified Client Access server.

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

Set-UMCallRouterSettings [-Confirm [<SwitchParameter>]] [-DialPlans <MultiValuedProperty>] [-DomainController <Fqdn>] [-ExternalHostFqdn <UMSmartHost>] [-ExternalServiceFqdn <UMSmartHost>] [-IPAddressFamily <IPv4Only | IPv6Only | Any>] [-IPAddressFamilyConfigurable <$true | $false>] [-MaxCallsAllowed <Int32>] [-Server <ServerIdParameter>] [-SipTcpListeningPort <Int32>] [-SipTlsListeningPort <Int32>] [-UMForwardingAddressTemplate <String>] [-UMPodRedirectTemplate <String>] [-UMStartupMode <TCP | TLS | Dual>] [-WhatIf [<SwitchParameter>]]

This example creates the following configuration on the Client Access server MyUMCallRouter:

  • Adds the Client Access server to the UM SIP dial plan MySIPDialPlan.

  • Enables the Microsoft Exchange Unified Messaging Call Router service on the Client Access server to accept both IPv4 and IPv6 data packets.

  • Sets the maximum number of incoming voice, fax, auto attendant, and Outlook Voice Access calls to 150.

  • Enables the Microsoft Exchange Unified Messaging Call Router service to start up using TLS mode.

Set-UMCallRouterSettings -DialPlans MySIPDialPlan -IPAddressFamily Any -Server MyUMCallRouter.northwindtraders.com -UMStartupMode TLS

This example removes the Client Access server UMCallRouter001 from all UM SIP dial plans.

Set-UMCallRouterSettings -DialPlans $null -Server UMCallRouter001.contoso.com

The Set-UMCallRouterSettings cmdlet sets specific properties on a Client Access server running the Microsoft Exchange Unified Messaging Call Router service. This cmdlet can be used to set individual Unified Messaging parameters for a specified Client Access server.

After this task is completed, the cmdlet sets the parameters and the values 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 "Client Access Server (UM call router service)" entry in the Unified Messaging Permissions topic.

 

Parameter Required Type Description

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 the dial plan used by the Microsoft Exchange Unified Messaging Call Router service on a Client Access server. The Client Access server only needs to be associated with a UM dial plan if Microsoft Office Communications Server 2007 R2, Lync Server 2010, or Lync Server 15 is used in your organization. To remove a Client Access server from a dial plan, use $null. The default is no dial plans assigned.

To enter multiple values and overwrite any existing entries, use the following syntax: <value1>,<value2>.... If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: "<value1>","<value2>"....

To add or remove one or more values without affecting any existing entries, use the following syntax: @{Add="<value1>","<value2>"...; Remove="<value1>","<value2>"...}.

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

This parameter is reserved for internal Microsoft use.

ExternalServiceFqdn

Optional

Microsoft.Exchange.Data.UMSmartHost

This parameter is reserved for internal Microsoft use.

IPAddressFamily

Optional

Microsoft.Exchange.Data.Directory.IPAddressFamily

The IPAddressFamily parameter specifies whether the UM IP gateway will use Internet Protocol version 4 (IPv4), IPv6, or both to communicate. If set to IPv4Only, the UM IP gateway only uses IPv4 to communicate. If set to IPv6Only, the UM IP gateway only uses IPv6. If set to Any, IPv6 is used first, and then if necessary, it falls back to IPv4. The default is IPv4Only.

IPAddressFamilyConfigurable

Optional

System.Boolean

The IPAddressFamilyConfigurable parameter specifies whether you're able to set the IPAddressFamily parameter to IPv6Only or Any. The default is $true.

MaxCallsAllowed

Optional

System.Int32

The MaxCallsAllowed parameter will be removed in future versions of the product.

Server

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The Server parameter specifies the name of the Client Access server that runs the Microsoft Exchange Unified Messaging Call Router service that will be changed. This parameter specifies the directory object ID for the Client Access server.

SipTcpListeningPort

Optional

System.Int32

The SipTcpListeningPort parameter specifies the TCP port used by the Client Access server running the Microsoft Exchange Unified Messaging Call Router service to receive incoming calls. This TCP port is used by a Client Access server when a UM dial plan 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 a Client Access server running the Microsoft Exchange Unified Messaging Call Router service to receive incoming calls. This TLS port is used by a Client Access server when a UM dial plan is configured to use SIP Secured or Secured mode. The default is port 5061.

UMForwardingAddressTemplate

Optional

System.String

This parameter is reserved for internal Microsoft use.

UMPodRedirectTemplate

Optional

System.String

This parameter is reserved for internal Microsoft use.

UMStartupMode

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.UMStartupMode

The UMStartupMode parameter specifies whether the Client Access server running the Microsoft Exchange Unified Messaging Call Router service starts up in TCP, TLS, or Dual mode. If the Client Access server isn't associated with any UM dial plans or is being added to UM dial plans that have different security settings, you should choose Dual mode. In Dual mode, the Client Access server can listen on ports 5060 and 5061 at the same time. If the startup mode is changed, the Microsoft Exchange Unified Messaging Call Router service must be restarted.

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.

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.

 
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.