Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-11-19

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

Syntax


Set-UMServer -Identity <UMServerIdParameter> [-Confirm [<SwitchParameter>]] [-DialPlans <MultiValuedProperty>] [-DomainController <Fqdn>] [-ExternalHostFqdn <UMSmartHost>] [-ExternalServiceFqdn <UMSmartHost>] [-GrammarGenerationSchedule <ScheduleInterval[]>] [-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>]]

Set-UMServer -Identity <UMServerIdParameter>
[-Confirm [<SwitchParameter>]] [-DialPlans
<MultiValuedProperty>] [-DomainController <Fqdn>]
[-ExternalHostFqdn <UMSmartHost>] [-ExternalServiceFqdn
<UMSmartHost>] [-GrammarGenerationSchedule
<ScheduleInterval[]>] [-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>]]

Detailed Description

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

Parameters

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 won't 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 servicing Unified Messaging servers. This parameter is useful when you're 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.
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 the value 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\V14. 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 the Unified Messaging server allows.
SIPAccessService	Optional	Microsoft.Exchange.Data.ProtocolConnectionSettings	The SIPAccessService parameter specifies the FQDN and Transmission Control Protocol (TCP) port of Office Communications Server A/V Edge servers used for inbound or outbound calls from remote users located outside the network.
SipTcpListeningPort	Optional	System.Int32	The SipTcpListeningPort parameter specifies the 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	The Status parameter specifies the Unified Messaging server status. The available options are `Enabled`, `Disabled`, and `NoNewCalls`.
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.
UMPodRedirectTemplate	Optional	System.String	The UMPodRedirectTemplate 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 a Unified Messaging server will start up in `TCP`, `TLS`, or `Dual` mode. If the Unified Messaging 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.
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.

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.

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

Examples

EXAMPLE 1

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

	Copy Code
Set-UMServer -Identity MyUMServer -Status NoNewCalls

EXAMPLE 2

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

	Copy Code
Set-UMServer -Identity MyUMServer -DialPlans $null

EXAMPLE 3

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

	Copy Code
Set-UMServer -Identity MyUMServer -DialPlans MyUMDialPlanName -MaxCallsAllowed 50

EXAMPLE 4

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

	Copy Code
Set-UMServer -Identity MyUMServer -GrammarGenerationSchedule 0.02:30-1.03:00, 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