Disable-UMServer (RTM)

  • Article

Microsoft Exchange Server 2007 will reach end of support on April 11, 2017. To stay supported, you will need to upgrade. For more information, see Resources to help you upgrade your Office 2007 servers and clients.

 

Applies to: Exchange Server 2007

The Disable-UMServer cmdlet sets the status of a Unified Messaging (UM) server to disabled. This prevents the Unified Messaging server from processing UM calls.

Syntax

Disable-UMServer -Identity <UMServerIdParameter> [-DomainController <Fqdn>] [-Immediate <$true | $false>]

Detailed Description

The Disable-UMServer cmdlet sets the status of a Unified Messaging server. A Unified Messaging server has a logical status variable that is controlled by using the enable and disable cmdlets. A Unified Messaging server will not process any new calls unless it is in the enabled state. This status variable lets an administrator start or stop call processing on a Unified Messaging server so that the Unified Messaging server can be brought online or taken offline in a controlled way.

To run the Disable-UMServer cmdlet, the account you use must be delegated the following:

  • 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 Exchange Server 2007, see Permission Considerations.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.UMServerIdParameter

This parameter specifies the identifier for the Unified Messaging server that is being disabled. This is the directory object ID for the UM server object.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name of the domain controller that writes this configuration change to the Active Directory directory service, include the DomainController parameter on the cmdlet.

Immediate

Optional

System.Boolean

This parameter specifies whether the Unified Messaging server will drop all current calls or enable current calls to finish. If this parameter is set to $true, all calls that are currently connected will be disconnected.

Input Types

Return Types

Errors

Error Description

 

 

Exceptions

Exceptions Description

 

 

Example

The first example disables Unified Messaging on the Unified Messaging server named MyUMServer but does not disconnect calls that are being processed.

The second example disables Unified Messaging on the Unified Messaging server named MyUMServer and disconnects all calls that are being processed.

Disable-UMServer -Identity MyUMServer

Disable-UMServer -Identity MyUMServer -Immediate $true