Applies to: Exchange Server 2013
Topic Last Modified: 2012-07-12
Use the Remove-OfflineAddressBook cmdlet to remove (delete) offline address books (OABs).
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Remove-OfflineAddressBook -Identity
<OfflineAddressBookIdParameter> [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>] [-Force
<SwitchParameter>] [-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example removes the OAB My OAB from Active Directory.
 Copy Code |
|
|---|---|
Remove-OfflineAddressBook -Identity "\My OAB" |
|
Detailed Description
The Remove-OfflineAddressBook cmdlet removes an existing OAB. For example, to uninstall a Client Access server that contains an OAB, you have to remove the OAB and re-create it on another Client Access server.
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Offline address books" entry in the Email Address and Address Book Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.OfflineAddressBookIdParameter |
The Identity parameter specifies the GUID, distinguished name (DN), 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 so that only the OAB name or GUID is supplied. |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch can be used to suppress the
confirmation prompt that appears by default when this cmdlet is
run. To suppress the confirmation prompt, use the syntax
|
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
|
Force |
Optional |
System.Management.Automation.SwitchParameter |
The Force switch specifies whether to suppress warning or confirmation messages. This switch can be used when the task is run programmatically and prompting for administrative input is inappropriate. If the Force switch isn't provided in the command, you're prompted for administrative input. You don't have to specify a value with this parameter. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, 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 switch. |
Input Types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
Return Types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.