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

Set-UMService

 

Applies to: Exchange Server 2013

Topic Last Modified: 2013-10-03

Use the Set-UMService cmdlet to set the properties on a Microsoft Exchange Server 2013 Mailbox server or Exchange Server 2007 or Exchange Server 2010 Unified Messaging server that's running the Microsoft Exchange Unified Messaging (UM) service.

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

Set-UMService -Identity <UMServerIdParameter> [-Confirm [<SwitchParameter>]] [-DialPlans <MultiValuedProperty>] [-DomainController <Fqdn>] [-ExternalHostFqdn <UMSmartHost>] [-ExternalServiceFqdn <UMSmartHost>] [-GrammarGenerationSchedule <ScheduleInterval[]>] [-IPAddressFamily <IPv4Only | IPv6Only | Any>] [-IPAddressFamilyConfigurable <$true | $false>] [-IrmLogEnabled <$true | $false>] [-IrmLogMaxAge <EnhancedTimeSpan>] [-IrmLogMaxDirectorySize <Unlimited>] [-IrmLogMaxFileSize <ByteQuantifiedSize>] [-IrmLogPath <LocalLongFullPath>] [-MaxCallsAllowed <Int32>] [-SIPAccessService <ProtocolConnectionSettings>] [-SipTcpListeningPort <Int32>] [-SipTlsListeningPort <Int32>] [-Status <Enabled | Disabled | NoNewCalls>] [-UMForwardingAddressTemplate <String>] [-UMPodRedirectTemplate <String>] [-UMStartupMode <TCP | TLS | Dual>] [-WhatIf [<SwitchParameter>]]

This example performs the following actions:

  • Enables the Microsoft Exchange Unified Messaging service on the Mailbox server MyUMServer to accept both IPv4 and IPv6 data packets.

  • Enables the Microsoft Exchange Unified Messaging service on the Mailbox server MyUMServer to start up using both TCP and TLS mode.

Set-UMService -Identity MyUMServer -IPAddressFamily Any -UMStartupMode Dual

This example removes the Mailbox server MyUMServer from all UM dial plans.

Set-UMService -Identity MyUMServer -DialPlans $null

This example performs the following actions:

  • Adds the Mailbox server MyUMServer to the UM dial plan MySIPDialPlan.

  • Sets the maximum number of incoming calls to 50.

  • Sets northamerica.lyncpoolna.contoso.com as the FQDN for the SIP access service that is used by Microsoft Lync Server for inbound and outbound calling from remote Lync clients.

  • Enables the Microsoft Exchange Unified Messaging service on the Mailbox server MyUMServer to start up in TLS mode.

Set-UMService -Identity MyUMServer -DialPlans MySIPDialPlan -MaxCallsAllowed 50 -SipAccessService northamerica.lyncpoolna.contoso.com -UMStartupMode TLS

The Set-UMService cmdlet sets specific properties on an Exchange 2013 Mailbox server or Exchange 2007 or Exchange 2010 Unified Messaging server that's running the Microsoft Exchange Unified Messaging service. This cmdlet can be used to set individual Unified Messaging parameters for a specified Mailbox or Unified Messaging 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 "Mailbox server (UM service)" entry in the Unified Messaging Permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UMServerIdParameter

The Identity parameter specifies the ID for the Exchange 2013 Mailbox or Exchange 2007 or Exchange 2010 Unified Messaging server object to be configured that's running the Microsoft Exchange Unified Messaging service. This parameter specifies the directory object ID for the Mailbox 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 dial plans for which an Exchange 2013 Client Access or Mailbox server or Exchange 2007 or Exchange 2010 Unified Messaging server handles incoming calls. Exchange 2013 Client Access and Mailbox servers can't be associated with a TelExt or E.164 UM dial plan but can be associated or added to SIP dial plans. If you're integrating Unified Messaging with Microsoft Office Communications Server 2007 R2, Lync Server 2010, or Lync Server 2013, you must associate or add all Client Access and Mailbox servers to SIP dial plans. This parameter can also be used to associate Exchange 2007 or Exchange 2010 Unified Messaging servers to a UM dial plan.

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.

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.

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.

IrmLogEnabled

Optional

System.Boolean

The IrmLogEnabled parameter specifies whether to enable logging of Information Rights Management (IRM) transactions. IRM logging is enabled by default. Values include:

  • $true   Enable IRM logging

  • $false   Disable IRM logging

IrmLogMaxAge

Optional

Microsoft.Exchange.Data.EnhancedTimeSpan

The IrmLogMaxAge parameter specifies the maximum age for the IRM log file. Log files that are older than the specified value are deleted. The default value is 30 days.

To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.

The valid input range for this parameter is from 00:00:00 through 24855.03:14:07. Setting the value of the IrmLogMaxAge parameter to 00:00:00 prevents the automatic removal of IRM log files because of their age.

IrmLogMaxDirectorySize

Optional

Microsoft.Exchange.Data.Unlimited

The IrmLogMaxDirectorySize parameter specifies the maximum size of all IRM logs in the connectivity log directory. When a directory reaches its maximum file size, the server deletes the oldest log files first. The default value is 250 megabytes (MB).

When you enter a value, qualify the value with one of the following units:

  • B (bytes)

  • KB (kilobytes)

  • MB (megabytes)

  • GB (gigabytes)

  • TB (terabytes)

Unqualified values are treated as bytes.

The value of the IrmLogMaxFileSize parameter must be less than or equal to the value of the IrmLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the connectivity log directory.

IrmLogMaxFileSize

Optional

Microsoft.Exchange.Data.ByteQuantifiedSize

The IrmLogMaxFileSize parameter specifies the maximum size of each IRM log file. When a log file reaches its maximum file size, a new log file is created. The default value is 10 MB.

When you enter a value, qualify the value with one of the following units:

  • B (bytes)

  • KB (kilobytes)

  • MB (megabytes)

  • GB (gigabytes)

  • TB (terabytes)

Unqualified values are treated as bytes.

The value of the IrmLogMaxFileSize parameter must be less than or equal to the value of the IrmLogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of unlimited, no size limit is imposed on the IRM log files.

IrmLogPath

Optional

Microsoft.Exchange.Data.LocalLongFullPath

The IrmLogPath parameter specifies the default IRM log directory location. The default value is C:\Program Files\Microsoft\Exchange Server\V15. If you set the value of the IrmLogPath parameter to $null, you effectively disable IRM logging. However, if you set the value of the IrmLogPath parameter to $null when the value of the IrmLogEnabled attribute is $true, Exchange will log errors in the Application event log. The preferred way for disabling IRM logging is to set the IrmLogEnabled parameter to $false.

MaxCallsAllowed

Optional

System.Int32

The MaxCallsAllowed parameter specifies the maximum number of concurrent voice calls that an Exchange 2013 Mailbox server or Exchange 2013 Mailbox or Exchange 2007 or Exchange 2010 Unified Messaging server that's running the Microsoft Exchange Unified Messaging service allows.

SIPAccessService

Optional

Microsoft.Exchange.Data.ProtocolConnectionSettings

The SIPAccessService parameter specifies the FQDN and Transmission Control Protocol (TCP) port of the nearest Lync Server pool location for inbound and outbound calls from remote Lync users located outside of the network. When this parameter isn't set, the Mailbox server running the Microsoft Exchange Unified Messaging service may select a Lync pool for Real-Time Transport Protocol (RTP) media traffic that isn't the closest geographically to the remote user.

This parameter is optional when you're configuring Unified Messaging with single Lync Server pool deployments. However, for Lync Server deployments that span multiple geographic regions, it's recommended that you specify this parameter. This parameter is set on a per-Mailbox server running the Microsoft Exchange Unified Messaging service basis and must point to the Lync Server pool that is located the closest geographically to the Mailbox server.

SipTcpListeningPort

Optional

System.Int32

This parameter is reserved for internal Microsoft use.

SipTlsListeningPort

Optional

System.Int32

This parameter is reserved for internal Microsoft use.

Status

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ServerStatus

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

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 Microsoft Exchange Unified Messaging service on an Exchange 2013 Mailbox server or Exchange 2007 or Exchange 2010 Unified Messaging server will start up in TCP, TLS, or Dual mode. If the Mailbox or Unified Messaging server is being added to UM dial plans that have different security settings, you should choose Dual mode. In Dual mode, the Mailbox or 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.

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.