Update-GlobalAddressList
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Update-GlobalAddressList cmdlet to update a global address list (GAL).
Syntax
update-GlobalAddressList -Identity <GlobalAddressListIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-UseRusServer <String>] [-WhatIf [<SwitchParameter>]]
Detailed Description
To run the Update-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 |
The Identity parameter specifies a unique identifier of the GAL that is being updated. These unique identifiers include the common name (CN), GUID, or distinguished name (DN). |
||
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm parameter causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm parameter. |
||
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the domain controller to be used by the command. |
||
UseRusServer |
Optional |
System.String |
The UseRusServer parameter instructs the command to use the specified Mailbox server on which the Address List service is running to obtain and then set mailbox and Active Directory user attributes. The Address List service is a component in the Exchange System Attendant service. The Address List service creates and maintains Exchange-specific attribute values in Active Directory. You can use the Address List service to update recipient objects in a domain by using specific information, such as address list membership and e-mail addresses. |
||
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf parameter instructs the command to simulate the actions that it would take on the object. By using the WhatIf parameter, 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 parameter. |
Input Types
Return Types
Errors
Error | Description |
---|---|
Exceptions
Exceptions | Description |
---|---|
Example
The following is an example of the Update-GlobalAddressList command.
In this example, the filter properties of the GlobalAddressList object with the CN, GUID, or DN equal to <GALIdentity1> are changed to the specified value. All related recipients are also updated.
Update-GlobalAddressList -Identity <GALIdentity1> -BaseFilter <OpathFilter>