Applies to: Exchange Server 2013
Topic Last Modified: 2012-11-16
Use the Disable-UMService cmdlet to set the status of an Exchange 2007 or Exchange 2010 Unified Messaging server to disabled. This prevents the UM server from processing UM incoming calls.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Disable-UMService -Identity <UMServerIdParameter>
[-Confirm [<SwitchParameter>]] [-DomainController
<Fqdn>] [-Immediate <$true | $false>] [-WhatIf
[<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example disables Unified Messaging on the UM server MyUMServer but doesn't disconnect calls that are being processed.
 Copy Code |
|
|---|---|
Disable-UMService -Identity MyUMServer |
|
EXAMPLE 2
This example disables Unified Messaging on the UM server MyUMServer and disconnects all calls being processed.
| Copy Code |
|
|---|---|
Disable-UMService -Identity MyUMServer -Immediate $true |
|
Detailed Description
The Disable-UMService cmdlet sets the status of a UM server. A UM server has a logical status variable controlled using the enable and disable cmdlets. A UM server won't process any new calls unless it's in the enabled state. With this status variable, you can start or stop call processing on a UM server so the UM server can be brought online or taken offline in a controlled way.
 Warning: |
|---|
| This cmdlet only is available for Exchange 2007 and Exchange 2010 servers running the Unified Messaging server role and is not available for Exchange 2013 Client Access and Mailbox servers. |
After this task is completed, the UM server can no longer:
- Answer any incoming calls.
- Respond to Play on Phone requests from a UM server.
- Be used to manage UM-enabled mailboxes.
- Be queried when a diagnostic task is used.
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.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.UMServerIdParameter |
The Identity parameter specifies the identifier for the UM server being disabled. This is the directory object ID for the UM 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. |
|
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. |
|
Immediate |
Optional |
System.Boolean |
The Immediate parameter specifies whether the UM server
drops all current calls or enables current calls to finish. If this
parameter is set to |
|
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.