Share via

Set-Group (RTM)

  • Article

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-Group cmdlet to modify the settings of an existing Microsoft Windows group.

Syntax

Set-Group -Identity <GroupIdParameter> [-DisplayName <String>] [-DomainController <Fqdn>] [-ManagedBy <GeneralRecipientIdParameter>] [-Name <String>] [-Notes <String>] [-PhoneticDisplayName <String>] [-SimpleDisplayName <String>] [-WindowsEmailAddress <SmtpAddress>]

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

Set-Group [-DisplayName <String>] [-DomainController <Fqdn>] [-Instance <WindowsGroup>] [-ManagedBy <GeneralRecipientIdParameter>] [-Name <String>] [-Notes <String>] [-PhoneticDisplayName <String>] [-SimpleDisplayName <String>] [-WindowsEmailAddress <SmtpAddress>]

Detailed Description

You can use the Set-Group cmdlet to modify group object settings that are 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 2007 settings that are not available by using the Set-Group cmdlet.

You cannot use the Set-Group cmdlet to modify dynamic distribution groups. To modify dynamic distribution groups, use the Set-DynamicDistributionGroup cmdlet. For more information about the Set-DynamicDistributionGroup cmdlet, see Set-DynamicDistributionGroup (RTM).

To run the Set-Group 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.

Parameters

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

Identity cannot be used if the Instance parameter is specified.

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

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

Instance

Optional

Microsoft.Exchange.Data.Directory.Management.WindowsGroup

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 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:

  • Distinguished name (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 displays 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. SimpleDisplayName 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.

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-Group command to apply the following changes to an existing global security group that is named Legal Department:

  • Change the group's scope to universal.

  • Add a Notes value of verified.

Set-Group -Identity "Legal Department" -Universal -Notes "verified"