Remove-OfflineAddressBook (RTM)

Article
01/23/2017

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 Remove-OfflineAddressBook cmdlet to remove (delete) offline address books (OABs).

Syntax

Remove-OfflineAddressBook -Identity <OfflineAddressBookIdParameter> [-DomainController <Fqdn>] [-Force <SwitchParameter>]

Detailed Description

This cmdlet allows an administrator to remove an existing OAB. For example, if you want to uninstall a Client Access server that contains an OAB, you will have to remove the OAB and re-create it on another Client Access server.

To run the Remove-OfflineAddressBook 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

Parameter	Required	Type	Description
Identity	Required	Microsoft.Exchange.Configuration.Tasks.OfflineAddressBookIdParameter	Use the Identity parameter to specify the GUID, distinguished name or offline address book name that represents a specific offline address book. You can also include the path by using the format Server\OfflineAddressBookName. You can omit the parameter label Identity so that only the offline address book name or GUID is supplied.
DomainController	Optional	Microsoft.Exchange.Data.Fqdn	This parameter specifies the domain controller to be used by the command.
Force	Optional	System.Management.Automation.SwitchParameter	If set to `$true`, this parameter forces the command to run now.

Identity

Required

Microsoft.Exchange.Configuration.Tasks.OfflineAddressBookIdParameter

Use the Identity parameter to specify the GUID, distinguished name or offline address book name that represents a specific offline address book. You can also include the path by using the format Server\OfflineAddressBookName.

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

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter specifies the domain controller to be used by the command.

Force

Optional

System.Management.Automation.SwitchParameter

If set to $true, this parameter forces the command to run now.

Input Types

Return Types

Errors

Error	Description

Exceptions

Exceptions	Description

Example

In this example the Remove-OfflineAddressBook cmdlet is used to remove the offline address book named "My OAB" from Active Directory.

Remove-OfflineAddressBook -Identity "\My OAB"

Share via