Update-OfflineAddressBook
Applies to: Exchange Server 2007 SP1, Exchange Server 2007 SP2, Exchange Server 2007 SP3
Use the Update-OfflineAddressBook cmdlet to update the offline address books (OABs) that are used by Microsoft Outlook clients.
Syntax
Update-OfflineAddressBook -Identity <OfflineAddressBookIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]
Detailed Description
This cmdlet allows administrators to update OABs.
To run the Update-OfflineAddressBook cmdlet, the account you use must be delegated the following:
- Exchange Server Administrator role and local Administrators group for the target server
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.OfflineAddressBookIdParameter |
Use the Identity parameter to specify the GUID, distinguished name or OAB name that represents a specific OAB. You can also include the path by using the format Server\OfflineAddressBookName. You can omit the parameter label Identity so that only the OAB name or GUID is supplied. |
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 |
To specify the fully qualified domain name of the domain controller that writes this configuration change to Active Directory, include the DomainController parameter on the command. |
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
In this example, the Update-OfflineAddressBook cmdlet is used to update the OAB named "MyOAB."
Update-OfflineAddressBook -Identity MyOAB