Set-DynamicDistributionGroup (RTM)
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
Use the Set-DynamicDistributionGroup cmdlet to modify the settings of an existing dynamic distribution group.
Syntax
Set-DynamicDistributionGroup -Identity <DynamicGroupIdParameter> [-AcceptMessagesOnlyFrom <RecipientIdParameter[]>] [-AcceptMessagesOnlyFromDLMembers <RecipientIdParameter[]>] [-Alias <String>] [-ConditionalCompany <MultiValuedProperty>] [-ConditionalCustomAttribute1 <String>] [-ConditionalCustomAttribute10 <String>] [-ConditionalCustomAttribute11 <String>] [-ConditionalCustomAttribute12 <String>] [-ConditionalCustomAttribute13 <String>] [-ConditionalCustomAttribute14 <String>] [-ConditionalCustomAttribute15 <String>] [-ConditionalCustomAttribute2 <String>] [-ConditionalCustomAttribute3 <String>] [-ConditionalCustomAttribute4 <String>] [-ConditionalCustomAttribute5 <String>] [-ConditionalCustomAttribute6 <String>] [-ConditionalCustomAttribute7 <String>] [-ConditionalCustomAttribute8 <String>] [-ConditionalCustomAttribute9 <String>] [-ConditionalDepartment <MultiValuedProperty>] [-ConditionalStateOrProvince <MultiValuedProperty>] [-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>] [-ForceUpgrade <SwitchParameter>] [-GrantSendOnBehalfTo <MailboxOrMailUserIdParameter[]>] [-HiddenFromAddressListsEnabled <$true | $false>] [-IncludedRecipients <Nullable>] [-ManagedBy <GeneralRecipientIdParameter>] [-MaxReceiveSize <Unlimited>] [-MaxSendSize <Unlimited>] [-Name <String>] [-Notes <String>] [-PhoneticDisplayName <String>] [-PrimarySmtpAddress <SmtpAddress>] [-RecipientContainer <OrganizationalUnitIdParameter>] [-RecipientFilter <String>] [-RejectMessagesFrom <RecipientIdParameter[]>] [-RejectMessagesFromDLMembers <RecipientIdParameter[]>] [-ReportToManagerEnabled <$true | $false>] [-ReportToOriginatorEnabled <$true | $false>] [-RequireSenderAuthenticationEnabled <$true | $false>] [-SendOofMessageToOriginatorEnabled <$true | $false>] [-SimpleDisplayName <String>] [-UMDtmfMap <MultiValuedProperty>] [-WindowsEmailAddress <SmtpAddress>]
Set-DynamicDistributionGroup [-AcceptMessagesOnlyFrom <RecipientIdParameter[]>] [-AcceptMessagesOnlyFromDLMembers <RecipientIdParameter[]>] [-Alias <String>] [-ConditionalCompany <MultiValuedProperty>] [-ConditionalCustomAttribute1 <String>] [-ConditionalCustomAttribute10 <String>] [-ConditionalCustomAttribute11 <String>] [-ConditionalCustomAttribute12 <String>] [-ConditionalCustomAttribute13 <String>] [-ConditionalCustomAttribute14 <String>] [-ConditionalCustomAttribute15 <String>] [-ConditionalCustomAttribute2 <String>] [-ConditionalCustomAttribute3 <String>] [-ConditionalCustomAttribute4 <String>] [-ConditionalCustomAttribute5 <String>] [-ConditionalCustomAttribute6 <String>] [-ConditionalCustomAttribute7 <String>] [-ConditionalCustomAttribute8 <String>] [-ConditionalCustomAttribute9 <String>] [-ConditionalDepartment <MultiValuedProperty>] [-ConditionalStateOrProvince <MultiValuedProperty>] [-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>] [-ForceUpgrade <SwitchParameter>] [-GrantSendOnBehalfTo <MailboxOrMailUserIdParameter[]>] [-HiddenFromAddressListsEnabled <$true | $false>] [-IncludedRecipients <Nullable>] [-Instance <DynamicDistributionGroup>] [-ManagedBy <GeneralRecipientIdParameter>] [-MaxReceiveSize <Unlimited>] [-MaxSendSize <Unlimited>] [-Name <String>] [-Notes <String>] [-PhoneticDisplayName <String>] [-PrimarySmtpAddress <SmtpAddress>] [-RecipientContainer <OrganizationalUnitIdParameter>] [-RecipientFilter <String>] [-RejectMessagesFrom <RecipientIdParameter[]>] [-RejectMessagesFromDLMembers <RecipientIdParameter[]>] [-ReportToManagerEnabled <$true | $false>] [-ReportToOriginatorEnabled <$true | $false>] [-RequireSenderAuthenticationEnabled <$true | $false>] [-SendOofMessageToOriginatorEnabled <$true | $false>] [-SimpleDisplayName <String>] [-UMDtmfMap <MultiValuedProperty>] [-WindowsEmailAddress <SmtpAddress>]
Detailed Description
A dynamic distribution group queries the Active Directory directory service mail-enabled objects and builds the group membership based on the results. The group membership is recalculated whenever an e-mail message is sent to a group. You can use Set-DynamicDistributionGroup to overwrite existing settings or to add new settings.
To run the Set-DynamicDistributionGroup cmdlet, the account you use must be delegated the following:
- Exchange Recipient Administrator role
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.DynamicGroupIdParameter |
The Identity parameter identifies the object that you want to modify. The Identity parameter can take any of the following values for the dynamic distribution group object:
The Identity parameter cannot be used if the Instance parameter is specified. |
AcceptMessagesOnlyFrom |
Optional |
Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[] |
The AcceptMessagesOnlyFrom parameter specifies the mailbox users and mail-enabled contacts that can send e-mail messages to this distribution group. The AcceptMessagesOnlyFrom parameter can take any of the following values for the valid senders:
By default, this parameter is blank. This default value enables the distribution group to accept messages from all mailbox users and all mail-enabled contacts. |
AcceptMessagesOnlyFromDLMembers |
Optional |
Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[] |
The AcceptMessagesOnlyFromDLMembers parameter specifies the distribution groups who are allowed to send e-mail messages to this distribution group. You can use any of the following values for the allowed distribution groups:
By default, this parameter is blank. This default value enables the distribution group to accept messages from all distribution groups. |
Alias |
Optional |
System.String |
The Alias parameter specifies the alias of the object. The value of Alias cannot contain spaces. |
ConditionalCompany |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The ConditionalCompany parameter filters the mailbox users or mail-enabled contacts that are used to build the dynamic distribution group. When multiple values of the ConditionalCompany parameter are separated by commas, the OR Boolean operator is applied. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute1 |
Optional |
System.String |
The ConditionalCustomAttribute1 parameter specifies conditional custom attributes. You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute10 |
Optional |
System.String |
The ConditionalCustomAttribute10 parameter specifies conditional custom attributes. You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute11 |
Optional |
System.String |
The ConditionalCustomAttribute11 parameter specifies conditional custom attributes. You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute12 |
Optional |
System.String |
The ConditionalCustomAttribute12 parameter specifies conditional custom attributes. You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute13 |
Optional |
System.String |
The ConditionalCustomAttribute13 parameter specifies conditional custom attributes. You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute14 |
Optional |
System.String |
The ConditionalCustomAttribute14 parameter specifies conditional custom attributes. You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute15 |
Optional |
System.String |
The ConditionalCustomAttribute15 parameter specifies conditional custom attributes. You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute2 |
Optional |
System.String |
The ConditionalCustomAttribute2 parameter specifies conditional custom attributes. You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute3 |
Optional |
System.String |
The ConditionalCustomAttribute3 parameter specifies conditional custom attributes. You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute4 |
Optional |
System.String |
The ConditionalCustomAttribute4 parameter specifies conditional custom attributes. You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute5 |
Optional |
System.String |
The ConditionalCustomAttribute5 parameter specifies conditional custom attributes. You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute6 |
Optional |
System.String |
The ConditionalCustomAttribute6 parameter specifies conditional custom attributes. You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute7 |
Optional |
System.String |
The ConditionalCustomAttribute7 parameter specifies conditional custom attributes. You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute8 |
Optional |
System.String |
The ConditionalCustomAttribute8 parameter specifies conditional custom attributes. You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalCustomAttribute9 |
Optional |
System.String |
The ConditionalCustomAttribute9 parameter specifies conditional custom attributes. You can use these attributes to store additional information. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalDepartment |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The ConditionalDepartment parameter filters the mailbox users or mail-enabled contacts that are used to build the dynamic distribution group. When multiple values of the ConditionalDepartment parameter are separated by commas, the OR Boolean operator is applied. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
ConditionalStateOrProvince |
Optional |
Microsoft.Exchange.Data.MultiValuedProperty |
The ConditionalStateOrProvince parameter filters the mailbox users or mail-enabled contacts that are used to build the dynamic distribution group. When multiple values of the ConditionalStateOrProvince parameter are separated by commas, the OR Boolean operator is applied. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter. |
CreateDTMFMap |
Optional |
System.Boolean |
This parameter specifies that a dual tone multi-frequency (DTMF) map be created for the dynamic distribution group. |
CustomAttribute1 |
Optional |
System.String |
The CustomAttribute1 parameter specifies custom attributes. You can use these attributes to store additional information. |
CustomAttribute10 |
Optional |
System.String |
The CustomAttribute10 parameter specifies custom attributes. You can use these attributes to store additional information. |
CustomAttribute11 |
Optional |
System.String |
The CustomAttribute11 parameter specifies custom attributes. You can use these attributes to store additional information. |
CustomAttribute12 |
Optional |
System.String |
The CustomAttribute12 parameter specifies custom attributes. You can use these attributes to store additional information. |
CustomAttribute13 |
Optional |
System.String |
The CustomAttribute13 parameter specifies custom attributes. You can use these attributes to store additional information. |
CustomAttribute14 |
Optional |
System.String |
The CustomAttribute14 parameter specifies custom attributes. You can use these attributes to store additional information. |
CustomAttribute15 |
Optional |
System.String |
The CustomAttribute15 parameter specifies custom attributes. You can use these attributes to store additional information. |
CustomAttribute2 |
Optional |
System.String |
The CustomAttribute2 parameter specifies custom attributes. You can use these attributes to store additional information. |
CustomAttribute3 |
Optional |
System.String |
The CustomAttribute3 parameter specifies custom attributes. You can use these attributes to store additional information. |
CustomAttribute4 |
Optional |
System.String |
The CustomAttribute4 parameter specifies custom attributes. You can use these attributes to store additional information. |
CustomAttribute5 |
Optional |
System.String |
The CustomAttribute5 parameter specifies custom attributes. You can use these attributes to store additional information. |
CustomAttribute6 |
Optional |
System.String |
The CustomAttribute6 parameter specifies custom attributes. You can use these attributes to store additional information. |
CustomAttribute7 |
Optional |
System.String |
The CustomAttribute7 parameter specifies custom attributes. You can use these attributes to store additional information. |
CustomAttribute8 |
Optional |
System.String |
The CustomAttribute8 parameter specifies custom attributes. You can use these attributes to store additional information. |
CustomAttribute9 |
Optional |
System.String |
The CustomAttribute9 parameter specifies custom attributes. You can use these attributes to store additional information. |
DisplayName |
Optional |
System.String |
The DisplayName parameter specifies the name of the distribution group in the Exchange Management Console and in the Exchange global address list (GAL). |
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. |
EmailAddresses |
Optional |
Microsoft.Exchange.Data.ProxyAddressCollection |
The EmailAddresses parameter specifies the e-mail addresses of the distribution group. All Microsoft Exchange Server 2007 e-mail address types are valid. You can specify multiple values for the EmailAddresses parameter. Separate multiple values by using commas. |
EmailAddressPolicyEnabled |
Optional |
System.Boolean |
The EmailAddressPolicyEnabled parameter controls applying e-mail address policies to this distribution group. Valid values are |
ExpansionServer |
Optional |
System.String |
The ExpansionServer parameter specifies the Exchange server to expand the distribution group. Enter the expansion server as a |
ForceUpgrade |
Optional |
System.Management.Automation.SwitchParameter |
The ForceUpgrade parameter suppresses the following confirmation: "To save changes on object, the object must be upgraded to the current Exchange version. After upgrade, this object cannot be managed by a previous version of Exchange System Manager. Do you want to continue to upgrade and save the object?" This confirmation occurs when you upgrade a dynamic distribution group that was created in Microsoft Exchange Server 2003 or Exchange 2000 Server. You cannot manage an Exchange 2003 or Exchange 2000 dynamic distribution group by using the Exchange Management Console until you update the object's version and change the recipient filter by using either the RecipientFilter, or the IncludedRecipients parameters. |
GrantSendOnBehalfTo |
Optional |
Microsoft.Exchange.Configuration.Tasks.MailboxOrMailUserIdParameter[] |
The GrantSendOnBehalfTo parameter specifies a mailbox user who can send on behalf of this dynamic distribution group. The GrantSendOnBehalfTo parameter can take any of the following values:
By default, the GrantSendOnBehalfTo parameter is blank. This means that no other mailbox user has permission to send on behalf of this distribution group. |
HiddenFromAddressListsEnabled |
Optional |
System.Boolean |
The HiddenFromAddressListsEnabled parameter hides the distribution group from any Exchange address lists. Valid values are |
IncludedRecipients |
Optional |
System.Nullable |
The IncludedRecipients parameter filters the recipient types that are used to build the dynamic distribution group. The available values for the IncludedRecipients parameter are The |
Instance |
Optional |
Microsoft.Exchange.Data.Directory.Management.DynamicDistributionGroup |
The Instance parameter enables you to pass an entire object to the command to be processed. It is mainly used in scripts where an entire object must be passed to the command. The Instance parameter cannot be used if the Identity parameter is specified. |
ManagedBy |
Optional |
Microsoft.Exchange.Configuration.Tasks.GeneralRecipientIdParameter |
The ManagedBy parameter specifies the name of the mailbox user, mail-enabled group, or mail-enabled contact that appears in the Managed by tab of the Active Directory object. You can use any of the following values for this parameter:
|
MaxReceiveSize |
Optional |
Microsoft.Exchange.Data.Unlimited |
The MaxReceiveSize parameter can be used to set 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 0 through 2147482624 bytes. By default, the MaxReceiveSize parameter is set to |
MaxSendSize |
Optional |
Microsoft.Exchange.Data.Unlimited |
The MaxSendSize parameter can be used to specify 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 0 through 2147482624 bytes. By default, the MaxSendSize parameter is set to |
Name |
Optional |
System.String |
The Name parameter specifies the name of the dynamic 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. |
Notes |
Optional |
System.String |
The Notes parameter specifies comments about the distribution group. |
PhoneticDisplayName |
Optional |
System.String |
The PhoneticDisplayName parameter specifies a phonetic pronunciation of the DisplayName parameter. The maximum length of this parameter value is 255 characters. For more information about the PhoneticDisplayName parameter and speech recognition, see Understanding Automatic Speech Recognition Directory Lookups. |
PrimarySmtpAddress |
Optional |
Microsoft.Exchange.Data.SmtpAddress |
The PrimarySmtpAddress parameter specifies the primary return SMTP e-mail address for the distribution group. This parameter has meaning only if the distribution group has multiple SMTP e-mail addresses. |
RecipientContainer |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter |
The RecipientContainer parameter filters the recipients that are used to build the dynamic distribution group based on their location in Active Directory. The value of RecipientContainer can be the canonical name of an organizational unit (OU) or a domain. If a value for RecipientContainer is not specified, the default search filter is the location of the dynamic distribution group in Active Directory. |
RecipientFilter |
Optional |
System.String |
The RecipientFilter parameter filters the mail-enabled recipients that are used to build the dynamic distribution group. RecipientFilter cannot be used if the any of the following parameters are specified:
RecipientFilter uses RecipientFilter can use any combination of the following object types as filters:
|
RejectMessagesFrom |
Optional |
Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[] |
The RejectMessagesFrom parameter specifies mailbox users and mail-enabled contacts that are not allowed to send e-mail messages to this distribution group. You can use any of the following values for the prohibited senders:
By default, this parameter is blank. This default value enables the distribution group to accept messages from all mailbox users and all mail-enabled contacts. |
RejectMessagesFromDLMembers |
Optional |
Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter[] |
The RejectMessagesFromDLMembers parameter specifies the distribution groups who are not allowed to send e-mail messages to the distribution group. You can use any of the following values for the prohibited distribution groups:
By default, this parameter is blank. This default value enables the distribution group to accept messages from all distribution groups. |
ReportToManagerEnabled |
Optional |
System.Boolean |
The ReportToManagerEnabled parameter enables delivery reports to be sent to the distribution group manager. Valid values are |
ReportToOriginatorEnabled |
Optional |
System.Boolean |
The ReportToOriginatorEnabled parameter enables delivery reports to be sent to the sender of e-mail messages that are sent to this distribution group. Valid values are |
RequireSenderAuthenticationEnabled |
Optional |
System.Boolean |
The RequireSenderAuthenticationEnabled parameter requires e-mail message delivery from authenticated senders. Valid values are |
SendOofMessageToOriginatorEnabled |
Optional |
System.Boolean |
The SendOofMessageToOriginatorEnabled parameter enables Out of Office messages to be delivered to the sender of e-mail messages that are 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 |
This parameter specifies if you want to create a user-defined DTMF map for the UM-enabled dynamic distribution group. |
WindowsEmailAddress |
Optional |
Microsoft.Exchange.Data.SmtpAddress |
The WindowsEmailAddress parameter specifies the value of the E-mail field of the Active Directory object. |
Input Types
Return Types
Errors
Error | Description |
---|---|
|
|
Exceptions
Exceptions | Description |
---|---|
|
|
Example
The following code example shows how to use the Set-DynamicDistributionGroup command to apply the following changes to an existing dynamic distribution group that is named Developers:
Change the
ConditionalCompany
query filter toContoso
.Change the
IncludedRecipients
query filter toMailboxUsers
.Add a
Custom Attribute 1
value of Internal.
Set-DynamicDistributionGroup -Identity "Developers" -ConditionalCompany "Contoso" -IncludedRecipients MailboxUsers -ConditionalCustomAttribute1 "Internal"