Update-Recipient

Update-Recipient

Update-Recipient

Topic Last Modified: 2007-07-18

Use the Update-Recipient cmdlet to add Microsoft Exchange Server 2007 attributes to recipient objects that are created by the global address list (GAL) synchronization management agent in Identity Lifecycle Manager (ILM) 2007. The recipient objects you modify using this cmdlet must reside on an Exchange 2007 server.

Syntax


Update-Recipient -Identity <RecipientIdParameter> [-Confirm [<SwitchParameter>]] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Server <ServerIdParameter>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter	Required	Type	Description
Identity	Required	Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter	The Identity parameter identifies the recipient. You can use one of the following values: GUID Domain\Account User principal name (UPN) LegacyExchangeDN Simple Mail Transfer Protocol (SMTP) address Name Alias
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 do not have to specify a value with the Confirm parameter.
Credential	Optional	System.Management.Automation.PSCredential	The Credential parameter specifies the user name and password to use to access Active Directory. If the Credential parameter is used, the command prompts for the account's password before continuing.
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.
Server	Optional	Microsoft.Exchange.Configuration.Tasks.ServerIdParameter	The Server parameter specifies the server on which to perform the selected operations.
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 do not have to specify a value with the WhatIf parameter.

Detailed Description

Due to mergers and acquisitions or legal requirements, customers may have a need to deploy Exchange in a multiple Exchange forest topology. These deployments require the synchronization of recipient objects across disparate Active Directory directory service forests. To learn more about multiple Exchange forest topologies, see Planning for a Complex Exchange Organization.

Microsoft provides the GAL synchronization management agent for synchronizing recipient objects. The version of the GAL synchronization management agent that was included in Microsoft Identity Integration Server (MIIS) 2003 was designed to work with Exchange Server 2003 and relied on the Recipient Update Service (RUS). Because RUS is a deprecated feature and is no longer required for Exchange 2007, the new GAL synchronization management agent that is included in ILM 2007 is designed to function without RUS.

As part of the synchronization process, the ILM 2007 GAL synchronization management agent creates recipient objects in both Active Directory forests. After the recipients are created, the management agent uses the Update-Recipient cmdlet to add the attributes required by Exchange 2007 to complete the provisioning of these recipients.

Note:
If you are using MIIS 2003, you must run various cmdlets to complete the provisioning process of the mail contacts created by the GAL synchronization management agent. For detailed information about provisioning mail contacts created by MIIS 2003, see How to Deploy Exchange 2007 in a Cross-Forest Topology. The Update-Recipient cmdlet provides an alternative and more efficient method to accomplish this. You can simply run the Update-Recipient cmdlet against the recipient objects created by the MIIS 2003 GAL synchronization management agent to complete their provisioning process.

Note:

If you are using MIIS 2003, you must run various cmdlets to complete the provisioning process of the mail contacts created by the GAL synchronization management agent. For detailed information about provisioning mail contacts created by MIIS 2003, see How to Deploy Exchange 2007 in a Cross-Forest Topology. The Update-Recipient cmdlet provides an alternative and more efficient method to accomplish this. You can simply run the Update-Recipient cmdlet against the recipient objects created by the MIIS 2003 GAL synchronization management agent to complete their provisioning process.

To run the Update-Recipient cmdlet, the account you use must be delegated the following:

Exchange Recipient Administrator role

For more information about permissions, delegating roles, and the rights that are required to administer Exchange 2007, see Permission Considerations.

Input Types

Return Types

Errors

Error	Description

Example

The first example shows how to use the Update-Recipient cmdlet to add Exchange 2007 attributes to the mail contact that represents John Smith's mailbox.

The second example shows how to update all contacts in a specific organizational unit (OU). This example assumes that recipients are synchronized between two forests, contoso.com and fabrikam.com, and all the synchronized recipients from the fabrikam.com domain are stored in a specific OU called fabrikam.com Users in the contoso.com domain.

Update-Recipient -Identity "John Smith"
Get-MailContact -OrganizationalUnit "contoso.com/fabrikam.com Users" | Update-Recipient