Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2012-11-15
Use the Set-DistributionGroup cmdlet to modify the settings of an existing distribution group.
Syntax
Set-DistributionGroup -Identity
<DistributionGroupIdParameter> [-AcceptMessagesOnlyFrom
<MultiValuedProperty>] [-AcceptMessagesOnlyFromDLMembers
<MultiValuedProperty>]
[-AcceptMessagesOnlyFromSendersOrMembers
<MultiValuedProperty>] [-Alias <String>]
[-ArbitrationMailbox <MailboxIdParameter>]
[-BypassModerationFromSendersOrMembers <MultiValuedProperty>]
[-BypassNestedModerationEnabled <$true | $false>]
[-BypassSecurityGroupManagerCheck <SwitchParameter>]
[-Confirm [<SwitchParameter>]] [-CreateDTMFMap <$true |
$false>] [-CustomAttribute1 <String>] [-CustomAttribute10
<String>] [-CustomAttribute11 <String>]
[-CustomAttribute12 <String>] [-CustomAttribute13
<String>] [-CustomAttribute14 <String>]
[-CustomAttribute15 <String>] [-CustomAttribute2
<String>] [-CustomAttribute3 <String>]
[-CustomAttribute4 <String>] [-CustomAttribute5
<String>] [-CustomAttribute6 <String>]
[-CustomAttribute7 <String>] [-CustomAttribute8
<String>] [-CustomAttribute9 <String>] [-DisplayName
<String>] [-DomainController <Fqdn>] [-EmailAddresses
<ProxyAddressCollection>] [-EmailAddressPolicyEnabled
<$true | $false>] [-ExpansionServer <String>]
[-ExtensionCustomAttribute1 <MultiValuedProperty>]
[-ExtensionCustomAttribute2 <MultiValuedProperty>]
[-ExtensionCustomAttribute3 <MultiValuedProperty>]
[-ExtensionCustomAttribute4 <MultiValuedProperty>]
[-ExtensionCustomAttribute5 <MultiValuedProperty>]
[-ForceUpgrade <SwitchParameter>] [-GrantSendOnBehalfTo
<MultiValuedProperty>] [-HiddenFromAddressListsEnabled
<$true | $false>] [-IgnoreDefaultScope
<SwitchParameter>] [-IgnoreNamingPolicy
<SwitchParameter>] [-MailTip <String>]
[-MailTipTranslations <MultiValuedProperty>] [-ManagedBy
<MultiValuedProperty>] [-MaxReceiveSize <Unlimited>]
[-MaxSendSize <Unlimited>] [-MemberDepartRestriction
<Closed | Open | ApprovalRequired>] [-MemberJoinRestriction
<Closed | Open | ApprovalRequired>] [-ModeratedBy
<MultiValuedProperty>] [-ModerationEnabled <$true |
$false>] [-Name <String>] [-PrimarySmtpAddress
<SmtpAddress>] [-RejectMessagesFrom
<MultiValuedProperty>] [-RejectMessagesFromDLMembers
<MultiValuedProperty>] [-RejectMessagesFromSendersOrMembers
<MultiValuedProperty>] [-ReportToManagerEnabled <$true |
$false>] [-ReportToOriginatorEnabled <$true | $false>]
[-RequireSenderAuthenticationEnabled <$true | $false>]
[-RoomList <SwitchParameter>] [-SamAccountName
<String>] [-SendModerationNotifications <Never | Internal
| Always>] [-SendOofMessageToOriginatorEnabled <$true |
$false>] [-SimpleDisplayName <String>] [-UMDtmfMap
<MultiValuedProperty>] [-WhatIf [<SwitchParameter>]]
[-WindowsEmailAddress <SmtpAddress>]
|
Detailed Description
Distribution groups are used to consolidate groups of recipients into a single point of contact for e-mail messages. Distribution groups can't be used to assign permissions to network resources in Active Directory. You can use the Set-DistributionGroup cmdlet to overwrite existing settings or to add new settings.
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 "Distribution groups" entry in the Mailbox Permissions topic.
Parameters
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.DistributionGroupIdParameter |
The Identity parameter specifies the object that you want to modify. This parameter accepts the following values:
|
||
|
AcceptMessagesOnlyFrom |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The AcceptMessagesOnlyFrom parameter specifies the mailbox users, mail users, and mail contacts who can send e-mail messages to this distribution group. You can also specify Microsoft Exchange as a valid recipient for this parameter. If you configure a distribution group to accept messages only from the Microsoft Exchange recipient, the distribution group only receives system-generated messages. This parameter accepts the following values:
By default, the value of this parameter is blank, which enables the distribution group to accept messages from all senders. |
||
|
AcceptMessagesOnlyFromDLMembers |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The AcceptMessagesOnlyFromDLMembers parameter specifies the distribution groups whose members are allowed to send e-mail messages to this distribution group. This parameter accepts the following values:
By default, the value of this parameter is blank, which enables the distribution group to accept messages from all senders. |
||
|
AcceptMessagesOnlyFromSendersOrMembers |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The AcceptMessagesOnlyFromSendersOrMembers parameter specifies the recipients who can send e-mail messages to this distribution group. You can specify users, contacts, or distribution groups. If you specify a distribution group, messages are accepted from all recipients that are members of that distribution group. You can also specify Exchange as a valid recipient for this parameter. If you configure a distribution group to accept messages only from the Exchange recipient, the distribution group only receives system-generated messages. This parameter accepts the following values:
By default, the value of this parameter is blank, which enables the distribution group to accept messages from all senders. |
||
|
Alias |
Optional |
System.String |
The Alias parameter specifies the alias of the distribution group. The Alias parameter is used to generate the primary SMTP e-mail address of the object. The value of the Alias parameter can't contain spaces. If the Alias parameter isn't specified, the value of the SamAccountName parameter is used to generate the primary SMTP e-mail address, with any spaces converted to underscores. |
||
|
ArbitrationMailbox |
Optional |
Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter |
The ArbitrationMailbox parameter specifies the mailbox that's used to manage the moderation process. This parameter is automatically set when blank and moderation is enabled. |
||
|
BypassModerationFromSendersOrMembers |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The BypassModerationFromSendersOrMembers parameter specifies senders for whom moderation is to be bypassed. This parameter accepts the following values:
|
||
|
BypassNestedModerationEnabled |
Optional |
System.Boolean |
The ByPassNestedModerationEnabled parameter specifies
whether to allow the parent group moderators to provide approval
for any nested groups that are also moderated. If you set this
parameter to The default value is |
||
|
BypassSecurityGroupManagerCheck |
Optional |
System.Management.Automation.SwitchParameter |
The BypassSecurityGroupManagerCheck parameter specifies whether to bypass security checks and moderation for the member that's being added. Use this parameter when the specified distribution group is a moderated distribution group, and you want to bypass security checks and moderation for the member that's being added. |
||
|
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. |
||
|
CreateDTMFMap |
Optional |
System.Boolean |
The CreateDTMFMap parameter specifies that a dual tone multi-frequency (DTMF) map be created for the distribution group. |
||
|
CustomAttribute1 |
Optional |
System.String |
The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. |
||
|
CustomAttribute10 |
Optional |
System.String |
The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. |
||
|
CustomAttribute11 |
Optional |
System.String |
The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. |
||
|
CustomAttribute12 |
Optional |
System.String |
The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. |
||
|
CustomAttribute13 |
Optional |
System.String |
The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. |
||
|
CustomAttribute14 |
Optional |
System.String |
The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. |
||
|
CustomAttribute15 |
Optional |
System.String |
The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. |
||
|
CustomAttribute2 |
Optional |
System.String |
The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. |
||
|
CustomAttribute3 |
Optional |
System.String |
The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. |
||
|
CustomAttribute4 |
Optional |
System.String |
The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. |
||
|
CustomAttribute5 |
Optional |
System.String |
The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. |
||
|
CustomAttribute6 |
Optional |
System.String |
The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. |
||
|
CustomAttribute7 |
Optional |
System.String |
The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. |
||
|
CustomAttribute8 |
Optional |
System.String |
The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. |
||
|
CustomAttribute9 |
Optional |
System.String |
The CustomAttribute1 to CustomAttribute15 parameters specify custom attributes. You can use these attributes to store additional information. |
||
|
DisplayName |
Optional |
System.String |
The DisplayName parameter specifies the distribution group's name in the Exchange Management Console and in the Exchange global address list (GAL). |
||
|
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. |
||
|
EmailAddresses |
Optional |
Microsoft.Exchange.Data.ProxyAddressCollection |
The EmailAddresses parameter specifies the e-mail alias of the distribution group. All valid Microsoft Exchange Server 2010 e-mail address types can be used. You can specify multiple values for the EmailAddresses parameter as a comma-delimited list.
|
||
|
EmailAddressPolicyEnabled |
Optional |
System.Boolean |
The EmailAddressPolicyEnabled parameter specifies the
application of e-mail address policies to this distribution group.
Valid values are |
||
|
ExpansionServer |
Optional |
System.String |
The ExpansionServer parameter specifies the Exchange server used to expand the distribution group. Enter the expansion server as a legacy Exchange DN value. The default behavior is to use the closest Exchange Server 2003 computer, or the closest Exchange Server 2007 or Exchange 2010 server that has the Hub Transport server role installed. |
||
|
ExtensionCustomAttribute1 |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. For more information about custom attributes, see Understanding Custom Attributes. For more information about using multivalued properties, see Modifying Multivalued Properties. |
||
|
ExtensionCustomAttribute2 |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. For more information about custom attributes, see Understanding Custom Attributes. For more information about using multivalued properties, see Modifying Multivalued Properties. |
||
|
ExtensionCustomAttribute3 |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. For more information about custom attributes, see Understanding Custom Attributes. For more information about using multivalued properties, see Modifying Multivalued Properties. |
||
|
ExtensionCustomAttribute4 |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. For more information about custom attributes, see Understanding Custom Attributes. For more information about using multivalued properties, see Modifying Multivalued Properties. |
||
|
ExtensionCustomAttribute5 |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The ExtensionCustomAttribute1-5 parameters specify custom attributes that store additional information. You can specify multiple values for these parameters as a comma delimited list. Each ExtensionCustomAttribute parameter can hold up to 1,300 values. For more information about custom attributes, see Understanding Custom Attributes. For more information about using multivalued properties, see Modifying Multivalued Properties. |
||
|
ForceUpgrade |
Optional |
System.Management.Automation.SwitchParameter |
The ForceUpgrade parameter suppresses the following confirmation: "To save changes on object <object name>, the object must be upgraded to the current Exchange version. After the upgrade, this object can't be managed by an earlier version of the Exchange Management Tools. Do you want to continue to upgrade and save the object?" This confirmation occurs when you upgrade a distribution group that was created in Microsoft Exchange Server 2003. You can't manage an Exchange 2003 distribution group by using the Exchange Management Console until you update the object's version. |
||
|
GrantSendOnBehalfTo |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The GrantSendOnBehalfTo parameter specifies a mailbox user who can send on behalf of this distribution group. This parameter accepts the following values:
By default, the value of the GrantSendOnBehalfTo parameter is blank, which means that no other mailbox user has permission to send on behalf of this distribution group. |
||
|
HiddenFromAddressListsEnabled |
Optional |
System.Boolean |
The HiddenFromAddressListsEnabled parameter specifies
whether to hide the distribution group from any Exchange address
list. Values are |
||
|
IgnoreDefaultScope |
Optional |
System.Management.Automation.SwitchParameter |
The IgnoreDefaultScope parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell session and use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions:
|
||
|
IgnoreNamingPolicy |
Optional |
System.Management.Automation.SwitchParameter |
The IgnoreNamingPolicy parameter specifies that the naming policy defined in the DistributionGroupNamingPolicy parameter of the Set-OrganizaitonConfig cmdlet can be ignored. You don't need to specify a value with this parameter. |
||
|
MailTip |
Optional |
System.String |
The MailTip parameter specifies the message that's displayed to senders when they start drafting an e-mail message to this recipient. The MailTip parameter message must be less than or equal to 250 characters. |
||
|
MailTipTranslations |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The MailTipTranslations parameter specifies additional languages when you want to provide the MailTip parameter information for this recipient in multiple languages. For each language, you must provide the locale, followed by a colon and the specific MailTip parameter message in that language. Each MailTip parameter message must be less than or equal to 250 characters. Multiple languages can be separated by commas. |
||
|
ManagedBy |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The ManagedBy parameter specifies the name of the mailbox recipient that appears on the Managed by tab of the Active Directory object. If this parameter isn't specified, the creator of the group is the owner. This parameter accepts the following values:
The recipients specified with the ManagedBy parameter aren't automatically members of the distribution group. If you want recipients specified in this parameter to be added as members of the distribution group, you need to add them as members. |
||
|
MaxReceiveSize |
Optional |
Microsoft.Exchange.Data.Unlimited |
The MaxReceiveSize parameter specifies the maximum allowed e-mail message size that can be sent to this distribution group. When you enter a value, qualify the value with one of the following units:
Unqualified values are treated as bytes. Valid values are from 0 through 2147482624 bytes. By default, the MaxReceiveSize parameter is set to unlimited. |
||
|
MaxSendSize |
Optional |
Microsoft.Exchange.Data.Unlimited |
The MaxSendSize parameter specifies the maximum allowed e-mail message size that can be sent from this distribution group. When you enter a value, qualify the value with one of the following units:
Unqualified values are treated as bytes. Valid values are from 0 through 2147482624 bytes. By default, the MaxSendSize parameter is set to unlimited. |
||
|
MemberDepartRestriction |
Optional |
Microsoft.Exchange.Data.Directory.Recipient.MemberUpdateType |
The MemberDepartRestriction parameter specifies the restrictions that you can put on recipients who want to depart the group membership. This parameter takes the following values:
|
||
|
MemberJoinRestriction |
Optional |
Microsoft.Exchange.Data.Directory.Recipient.MemberUpdateType |
The MemberJoinRestriction parameter specifies the restrictions that you can put on recipients who want to join the group membership. You can use the following values:
|
||
|
ModeratedBy |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The ModeratedBy parameter specifies the list of users who are responsible for moderating the messages sent to this distribution group. To designate more than one user, separate the users by commas. This parameter accepts the following values:
This parameter is required if you set the
ModerationEnabled parameter to |
||
|
ModerationEnabled |
Optional |
System.Boolean |
The ModerationEnabled parameter specifies whether to
enable moderation of e-mail sent to this distribution group. To
ensure moderation, set this parameter to The default value is |
||
|
Name |
Optional |
System.String |
The Name parameter specifies the name of the distribution group. The Name parameter specifies the distribution group name in Active Directory Users and Computers and also in the Group Name field in the Exchange Management Console.
|
||
|
PrimarySmtpAddress |
Optional |
Microsoft.Exchange.Data.SmtpAddress |
The PrimarySmtpAddress parameter specifies the primary return SMTP e-mail address for the distribution group. This parameter only has meaning if the distribution group has multiple SMTP e-mail addresses. |
||
|
RejectMessagesFrom |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The RejectMessagesFrom parameter specifies mailbox users and mail-enabled contacts who aren't allowed to send e-mail messages to this distribution group. This parameter accepts the following values:
By default, the value of this parameter is blank, which enables the distribution group to accept messages from all mailbox users and all mail-enabled contacts. |
||
|
RejectMessagesFromDLMembers |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The RejectMessagesFromDLMembers parameter specifies the distribution groups who aren't allowed to send e-mail messages to the distribution group. This parameter accepts the following values:
By default, the value of this parameter is blank, which enables the distribution group to accept messages from all distribution groups. |
||
|
RejectMessagesFromSendersOrMembers |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The RejectMessagesFromSendersOrMembers parameter specifies the identity of recipients from whom messages are rejected. This parameter accepts the following values:
|
||
|
ReportToManagerEnabled |
Optional |
System.Boolean |
The ReportToManagerEnabled parameter specifies whether to
allow delivery reports to be sent to the distribution group
manager. Valid values are |
||
|
ReportToOriginatorEnabled |
Optional |
System.Boolean |
The ReportToOriginatorEnabled parameter specifies whether
to allow delivery reports to be sent to the senders of e-mail
messages that are sent to this distribution group. Valid values are
|
||
|
RequireSenderAuthenticationEnabled |
Optional |
System.Boolean |
The RequireSenderAuthenticationEnabled parameter
specifies whether to require e-mail message delivery from
authenticated senders. If the value is |
||
|
RoomList |
Optional |
System.Management.Automation.SwitchParameter |
The RoomList parameter specifies that all members of the distribution group are room resource mailboxes. You can create a distribution list for an office building in your organization and add all the rooms in that building to the distribution group. Room list distribution groups are used to generate a list of building locations in Microsoft Outlook 2010 so the user can select a building and get suggestions about when rooms are available in that building, without having to add the rooms in that building individually. You can't use the RoomList parameter in conjunction with the ExternalManaged parameter. |
||
|
SamAccountName |
Optional |
System.String |
The SamAccountName parameter specifies the name for clients of the object running older operating systems. The SamAccountName parameter is displayed in Active Directory and in the Exchange Management Console in the Group name (pre-Windows 2000) field. |
||
|
SendModerationNotifications |
Optional |
Microsoft.Exchange.Data.Directory.Recipient.TransportModerationNotificationFlags |
The SendModerationNotifications parameter specifies whether status notifications are sent to users when they send a message to the moderated distribution group. You can specify one of the following values:
If you want notifications to be sent to all external and
internal senders, set this parameter to If you want notifications to be sent only to the senders who are
internal to your organization, set this parameter to
To disable all status notifications, set this parameter to
|
||
|
SendOofMessageToOriginatorEnabled |
Optional |
System.Boolean |
The SendOofMessageToOriginatorEnabled parameter specifies
whether to allow out-of-office messages to be delivered to the
senders of e-mail messages sent to this distribution group. Valid
values are |
||
|
SimpleDisplayName |
Optional |
System.String |
The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. This limited set of characters consists of ASCII characters 26 through 126, inclusively. |
||
|
UMDtmfMap |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The UMDtmfMap parameter specifies whether you want to create a user-defined DTMF map for the UM-enabled distribution group. |
||
|
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. |
||
|
WindowsEmailAddress |
Optional |
Microsoft.Exchange.Data.SmtpAddress |
The WindowsEmailAddress parameter specifies the value of the E-mail field of the Active Directory object. |
Important:
Note: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.
Examples
EXAMPLE 1
This example changes the display name of an existing distribution group from Accounting to Accounting Group.
 Copy Code |
|
|---|---|
Set-DistributionGroup -Identity "Accounting" -DisplayName "Accounting Group" |
|
EXAMPLE 2
This example converts the Bldg34 Conf Rooms distribution group to a room list.
| Copy Code |
|
|---|---|
Set-DistributionGroup -Identity "Bldg34 Conf Rooms" -RoomList |
|
EXAMPLE 3
This example changes the name of an existing distribution group from Ed_DirectReports to Ayla_DirectReports and ignores the group naming policy.
| Copy Code |
|
|---|---|
Set-DistributionGroup -Identity Ed_DirectReports -Name Ayla_DirectReports -IgnoreNamingPolicy |
|