Set-UMServer
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
The Set-UMServer cmdlet lets you set the properties on a Unified Messaging (UM) server.
Syntax
Set-UMServer -Identity <UMServerIdParameter> [-Confirm [<SwitchParameter>]] [-DialPlans <MultiValuedProperty>] [-DomainController <Fqdn>] [-GrammarGenerationSchedule <ScheduleInterval[]>] [-MaxASRSessionsAllowed <Nullable>] [-MaxCallsAllowed <Nullable>] [-MaxFaxCallsAllowed <Nullable>] [-MaxTTSSessionsAllowed <Nullable>] [-Status <Enabled | Disabled | NoNewCalls>] [-WhatIf [<SwitchParameter>]]
Set-UMServer [-Confirm [<SwitchParameter>]] [-DialPlans <MultiValuedProperty>] [-DomainController <Fqdn>] [-GrammarGenerationSchedule <ScheduleInterval[]>] [-Instance <UMServer>] [-MaxASRSessionsAllowed <Nullable>] [-MaxCallsAllowed <Nullable>] [-MaxFaxCallsAllowed <Nullable>] [-MaxTTSSessionsAllowed <Nullable>] [-Status <Enabled | Disabled | NoNewCalls>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Set-UMServer cmdlet is used to set specific properties on a Unified Messaging server. This cmdlet can be used to set individual Unified Messaging parameters for a specified Unified Messaging server.
To run the Set-UMServer cmdlet, the account you use must be delegated the Exchange Server Administrator role and local Administrators group for the target server.
For more information about permissions, delegating roles, and the rights that are required to administer Microsoft Exchange Server 2007, see Permission Considerations.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.UMServerIdParameter |
This parameter specifies the ID for the Unified Messaging server object that is to be configured. This parameter specifies the directory object ID for the UM server. This parameter is required if the Instance parameter is not used. |
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
This parameter causes the command to pause processing and requires that you acknowledge what the command will do before processing continues. The default value is $true. |
DialPlans |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
This 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 |
This parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to the Active Directory directory service. |
GrammarGenerationSchedule |
Optional |
Microsoft.Exchange.Common.ScheduleInterval[] |
This parameter specifies the scheduled times to start speech grammar re-generation. This parameter allows only one start time per day. |
Instance |
Optional |
Microsoft.Exchange.Data.Directory.Management.UMServer |
This parameter specifies the object input parameter. This parameter is required if the Identity parameter is not used. |
MaxASRSessionsAllowed |
Optional |
System.Nullable |
This parameter specifies the maximum number of concurrent Automatic Speech Recognition (ASR) sessions. |
MaxCallsAllowed |
Optional |
System.Nullable |
This parameter specifies the maximum number of concurrent calls that the Unified Messaging server will allow. |
MaxFaxCallsAllowed |
Optional |
System.Nullable |
This parameter specifies the maximum number of concurrent fax calls that the Unified Messaging server will allow. |
MaxTTSSessionsAllowed |
Optional |
System.Nullable |
This parameter specifies the maximum number of concurrent Text-to-Speech (TTS) sessions that the Unified Messaging server will allow. |
Status |
Optional |
Microsoft.Exchange.Data.Directory.SystemConfiguration.ServerStatus |
This parameter lets the administrator manipulate the Unified Messaging server status. Enabled, Disabled, and NoNewCalls are the available options. |
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
This parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, you can view what changes would occur without having to apply any of those changes. The default value is $true. |
Input Types
Return Types
Errors
| Error | Description |
|---|---|
|
|
Example
The first code example prevents a Unified Messaging server named MyUMServer from accepting new calls.
The second code example removes a Unified Messaging server named MyUMServer from all UM dial plans.
The third code 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.
The fourth code example changes the grammar generation schedule to 2:30-3:00 every day on a Unified Messaging server named MyUMServer.
Set-UMServer -Identity MyUMServer -Status NoNewCalls
Set-UMServer -Identity MyUMServer -DialPlans $null
Set-UMServer -Identity MyUMServer -DialPlans MyUMDialPlanName -MaxCalls 50 -MaxFaxCalls 15
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