Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2012-08-09
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 settings that aren't available by using the Set-Group cmdlet.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Set-Group -Identity <GroupIdParameter> <COMMON
PARAMETERS>
|
Set-Group -Identity <GroupIdParameter> [-Universal
<SwitchParameter>] <COMMON PARAMETERS>
|
COMMON PARAMETERS: [-BypassSecurityGroupManagerCheck
<SwitchParameter>] [-Confirm [<SwitchParameter>]]
[-DisplayName <String>] [-DomainController <Fqdn>]
[-IgnoreDefaultScope <SwitchParameter>] [-IsHierarchicalGroup
<$true | $false>] [-ManagedBy
<GeneralRecipientIdParameter[]>] [-Name <String>]
[-Notes <String>] [-PhoneticDisplayName <String>]
[-SeniorityIndex <Int32>] [-SimpleDisplayName <String>]
[-WhatIf [<SwitchParameter>]] [-WindowsEmailAddress
<SmtpAddress>]
|
Examples
EXAMPLE 1
This example applies the following changes to the existing global security group Legal Department:
- Change the group's scope to universal.
- Add a Notes parameter value of verified.
Copy Code | |
---|---|
Set-Group -Identity "Legal Department" -Universal -Notes "verified" |
EXAMPLE 2
This example specifies that the group Human Resources is a hierarchical group and will display last within its hierarchy because its index number is 1.
Copy Code | |
---|---|
Set-Group -Identity "Human Resources" -IsHierarchicalGroup $true -SeniorityIndex 1 |
Detailed Description
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 groups" entry in the Recipients Permissions topic.
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.GroupIdParameter |
The Identity parameter specifies the object that you want to modify. This parameter accepts the following values:
|
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
|
DisplayName |
Optional |
System.String |
The DisplayName parameter specifies the name of the group in the Exchange Administration Center 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. |
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:
|
IsHierarchicalGroup |
Optional |
System.Boolean |
The IsHierarchicalGroup parameter specifies whether the
group is part of a hierarchical address book. This parameter
accepts |
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. This parameter accepts the following values:
|
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. |
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. |
SeniorityIndex |
Optional |
System.Int32 |
The SeniorityIndex parameter specifies the order in which this group will display in a hierarchical address book. A group with a value of 2 will display higher in an address book than a group with a value of 1. |
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 |
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. |
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.