Applies to: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1
Topic Last Modified: 2007-06-28

Use the Remove-DistributionGroupMember cmdlet to remove an existing recipient from a distribution group.

Syntax

Remove-DistributionGroupMember -Identity <DistributionGroupIdParameter> -Member <GeneralRecipientIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.DistributionGroupIdParameter

The Identity parameter specifies the distribution group that you want to modify. The Identity parameter can take any of the following values for the distribution group:

  • Distinguished name (DN)

  • Canonical name

  • GUID

  • Name

  • Display name

  • Alias

  • Legacy Exchange DN

  • Primary Simple Mail Transfer Protocol (SMTP) e-mail address

Member

Required

Microsoft.Exchange.Configuration.Tasks.GeneralRecipientIdParameter

This parameter specifies the recipient that you want to remove from the distribution group. The Member parameter can take any of the following values for the recipient:

  • Distinguished name (DN)

  • Canonical name

  • GUID

  • Name

  • Display name

  • Alias

  • Legacy Exchange DN

  • Primary SMTP e-mail address

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm parameter 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 parameter.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

To specify the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory, include the DomainController parameter.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf 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. You don't have to specify a value with the WhatIf parameter.

Detailed Description

You can use the Remove-DistributionGroupMember cmdlet to remove an existing recipient from a distribution group or a mail-enabled security group. You can't use the Remove-DistributionGroupMember cmdlet to remove a recipient from a dynamic distribution group. A dynamic distribution group queries Microsoft Active Directory mail-enabled objects and builds the group's membership based on the results. The group's membership is recalculated whenever an e-mail message is sent to group.

To run the Remove-DistributionGroupMember cmdlet, the account you use must be delegated the following:

  • Exchange Recipient Administrator role

  • Account Operator role for the applicable Active Directory containers 

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

Input Types

Return Types

Errors

Error Description

 

 

Exceptions

Exceptions Description

 

 

Example

The following code example shows how to use the Remove-DistributionGroupMember cmdlet to remove Ted Bremer from the distribution group that is named Technical Support.

Copy Code 
Remove-DistributionGroupMember -Identity "Technical Support" -Member "Ted Bremer"