Export (0) Print
Expand All

Set-Group

Applies to: Exchange Server 2010

Topic Last Modified: 2011-03-19

Use the Set-Group cmdlet to modify group object settings visible in Active Directory Users and Computers. If the group is a mail-enabled security group or a distribution group, you can use the Set-DistributionGroup cmdlet to modify other Microsoft Exchange Server 2010 settings that aren't available by using the Set-Group cmdlet.


Set-Group -Identity <GroupIdParameter> [-BypassSecurityGroupManagerCheck <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-DisplayName <String>] [-DomainController <Fqdn>] [-ExternalManaged <SwitchParameter>] [-IgnoreDefaultScope <SwitchParameter>] [-ManagedBy <GeneralRecipientIdParameter[]>] [-Name <String>] [-Notes <String>] [-PhoneticDisplayName <String>] [-SimpleDisplayName <String>] [-WhatIf [<SwitchParameter>]] [-WindowsEmailAddress <SmtpAddress>]


Set-Group -Identity <GroupIdParameter> [-BypassSecurityGroupManagerCheck <SwitchParameter>] [-Confirm [<SwitchParameter>]] [-DisplayName <String>] [-DomainController <Fqdn>] [-ExternalManaged <SwitchParameter>] [-IgnoreDefaultScope <SwitchParameter>] [-ManagedBy <GeneralRecipientIdParameter[]>] [-Name <String>] [-Notes <String>] [-PhoneticDisplayName <String>] [-SimpleDisplayName <String>] [-Universal <SwitchParameter>] [-WhatIf [<SwitchParameter>]] [-WindowsEmailAddress <SmtpAddress>]

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.GroupIdParameter

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

  • Distinguished name (DN)
  • Canonical name
  • GUID
  • Name
  • Display name

BypassSecurityGroupManagerCheck

Optional

System.Management.Automation.SwitchParameter

The BypassSecurityGroupManagerCheck parameter specifies whether to bypass security checks and moderation if the specified group is a moderated distribution group.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch can be used to suppress the confirmation prompt that appears by default when this cmdlet is run. To suppress the confirmation prompt, use the syntax -Confirm:$False. You must include a colon ( : ) in the syntax.

DisplayName

Optional

System.String

The DisplayName parameter specifies the name of the group in the Exchange Management Console and in the Exchange global address list (GAL). This parameter has significance only if the group is mail-enabled.

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.

ExternalManaged

Optional

System.Management.Automation.SwitchParameter

The ExternalManaged parameter specifies that the group is managed by an external application.

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:

  • You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically.
  • You can only use the DN for the Identity parameter. Other forms of identification, such as GUID, aren't accepted.

ManagedBy

Optional

Microsoft.Exchange.Configuration.Tasks.GeneralRecipientIdParameter[]

The ManagedBy parameter specifies the name of the user, group, or contact that appears in the Managed by tab of the Active Directory object. You can use any of the following values for this parameter:

  • DN
  • Canonical name
  • GUID
  • Name
  • Display name

Name

Optional

System.String

The Name parameter specifies the name of the group. The Name parameter specifies the group name in Active Directory Users and Computers and also in the Group Name field in the Exchange Management Console if the group is mail-enabled.

Notes

Optional

System.String

The Notes parameter specifies the notes that describe the purpose of the 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.

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.

The SimpleDisplayName parameter has meaning only for mail-enabled objects.

Universal

Optional

System.Management.Automation.SwitchParameter

The Universal parameter changes the scope of the group from global or domain local to universal.

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.

You can't use the Set-Group cmdlet to modify dynamic distribution groups. To modify dynamic distribution groups, use the Set-DynamicDistributionGroup cmdlet.

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 group" entry in the Mailbox Permissions topic.

Error Description

 

 

Exceptions Description

 

 

This example applies the following changes to an existing global security group named Legal Department:

  • Change the group's scope to universal.
  • Add a Notes parameter value of verified.
Set-Group -Identity "Legal Department" -Universal -Notes "verified"
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft