Share via

Set-GlobalAddressList (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-GlobalAddressList cmdlet to modify the attributes in the Active Directory directory service for a global address list (GAL).

Syntax

Set-GlobalAddressList -Identity <GlobalAddressListIdParameter> [-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>] [-DomainController <Fqdn>] [-ForceUpgrade <SwitchParameter>] [-IncludedRecipients <Nullable>] [-Name <String>] [-RecipientFilter <String>]

Set-GlobalAddressList [-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>] [-DomainController <Fqdn>] [-ForceUpgrade <SwitchParameter>] [-IncludedRecipients <Nullable>] [-Instance <GlobalAddressList>] [-Name <String>] [-RecipientFilter <String>]

Detailed Description

The Set-GlobalAddressList cmdlet modifies the properties on a GAL.

To run the Set-GlobalAddressList cmdlet, the account you use must be delegated the following:

  • Exchange Organization 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.GlobalAddressListIdParameter

Use the Identity parameter to specify the GUID, distinguished name, or global address list (GAL) name that represents a specific GAL. You can also include the path by using the format Path\GlobalAddressListName.

You can omit the parameter label Identity so that only the GAL name or GUID is supplied.

ConditionalCompany

Optional

Microsoft.Exchange.Data.MultiValuedProperty

The ConditionalCompany parameter is used to specify a company. You can use multiple values as a comma-delimited list. 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

This parameter specifies 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

This parameter specifies 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

This parameter specifies 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

This parameter specifies 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

This parameter specifies 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

This parameter specifies 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

This parameter specifies 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

This parameter specifies custom attributes. You can use these attributes to store additional information.

ConditionalCustomAttribute3

Optional

System.String

This parameter specifies 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

This parameter specifies 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

This parameter specifies 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

This parameter specifies 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

This parameter specifies 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

This parameter specifies 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

This parameter specifies 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 is used to specify a department. All GALs with a department attribute that matches the value that you input for this parameter will be included. You can use multiple values as a comma-delimited list. You must use the IncludedRecipients parameter if you use a Conditional parameter. You cannot use this parameter if you use the RecipientFilter parameter.

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 in the command.

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 GAL that was created in Microsoft Exchange Server 2003 or Exchange 2000 Server. You cannot manage an Exchange 2003 or Exchange 2000 GAL 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 parameter.

IncludedRecipients

Optional

System.Nullable

The IncludedRecipients parameter filters the recipient types that are used to build the GAL. The available values for the IncludedRecipients parameter are AllRecipients, MailboxUsers, Resources, Contacts, and MailGroups.

The AllRecipients value can be used only by itself. When multiple values of the IncludedRecipients parameter are separated by commas, the OR Boolean operator is applied.

You must use this parameter if you are using the any of the Conditional parameters. You cannot use this parameter if you use the RecipientFilter parameter.

Instance

Optional

Microsoft.Exchange.Data.Directory.Management.GlobalAddressList

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.

Name

Optional

System.String

None.

RecipientFilter

Optional

System.String

The RecipientFilter parameter specifies a filter for recipients to include in the GAL. You cannot use this parameter if you use any of the following filter parameters:

  • ConditionalCompany

  • ConditionalDepartment

  • IncludedRecipients

  • ConditionalStateorProvince

You must use either this parameter or one of the previously listed filter parameters.

For more information about the filterable properties, see Filterable Properties for the -RecipientFilter parameter.

ConditionalStateOrProvince

Optional

Microsoft.Exchange.Data.MultiValuedProperty

None.

Input Types

Return Types

Errors

Error Description

 

Exceptions

Exceptions Description

 

Example

In this example, the Set-GlobalAddressList command is used to assign a new name, GALwithNewName, to the GAL with the GUID 96d0c505-eba8-4103-ad4f-577a1bf4ad7b.

Set-GlobalAddressList 96d0c505-eba8-4103-ad4f-577a1bf4ad7b -Name GALwithNewName