Share via

Disable-UMMailbox

  • Article

 

Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3

The Disable-UMMailbox cmdlet disables Unified Messaging (UM) for a UM-enabled recipient.

Syntax

Disable-UMMailbox -Identity <MailboxIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-KeepProperties <$true | $false>] [-WhatIf [<SwitchParameter>]]

Detailed Description

The Disable-UMMailbox cmdlet disables Unified Messaging for a Microsoft Exchange Server 2007 recipient who is currently UM-enabled. After the task has finished running, Unified Messaging servers will no longer handle calls for the extension number that is associated with the mailbox. You can continue to use the Exchange 2007 mailbox for all other operations that are not related to Unified Messaging.

To run the Disable-UMMailbox cmdlet, the account you use must be delegated the Exchange Recipient Administrator role.

For more information about permissions, delegating roles, and the rights that are required to administer Exchange 2007, see Permission Considerations.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

This parameter specifies the user to enable for Unified Messaging. The variables for this parameter include the following:

  • ADObjectID

  • GUID

  • DN

  • Domain\Account

  • UPN

  • LegacyExchangeDN

  • SmtpAddress

  • Alias

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 the administrator to acknowledge what the command will do before processing continues. The default value is $true.

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.

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

This parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell and use the entire forest as the scope. This allows the command to access Active Directory objects that are not currently in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions:

  • You cannot use the DomainController parameter. The command will use an appropriate global catalog server automatically.

  • You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, are not accepted.

KeepProperties

Optional

System.Boolean

This parameter specifies whether the mailbox and directory resident properties should be retained. If this parameter is not included, the user's Unified Messaging properties will be retained.

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, the administrator can view what changes would occur without having to apply any of those changes. The default value is $true.

Input Types

Type Description

 

 

Return Types

Type Description

 

 

Errors

Error Description

 

 

Example

This example disables Unified Messaging on the mailbox for yanli@contoso.com.

Disable-UMMailbox -Identity yanli@contoso.com