[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Removes the specified collection of Address Book settings. Users query Address Book files whenever they search for new contacts.


Remove-CsAddressBookConfiguration -Identity <XdsIdentity> [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]


Parameter Required Type Description




Unique identifier for the collection of Address Book settings to be removed. To remove the global collection, use the following syntax: -Identity global. To remove a site collection use syntax similar to this: -Identity site:Redmond. Note that you cannot use wildcards when specifying a policy Identity.



Switch Parameter

Suppresses the display of any non-fatal error message that might arise when running the command.



Switch Parameter

Prompts you for confirmation before executing the command.



Switch Parameter

Describes what would happen if you executed the command without actually executing the command.

Detailed Description

When people use Microsoft Communicator to search for new contacts they typically do not search Active Directory itself; that’s because hundreds of simultaneous Active Directory searches run the risk of bogging down both your network and your domain controllers. Instead, users searching for contacts typically search through local files generated by an Address Book server.

Address Book servers are intermediaries between Active Directory Domain Services and Microsoft Communications Server 2010. The Address Book server ensures that the user information stored in Communications Server 2010 is in synch with the user information stored in Active Directory. In addition, Address Book servers periodically generate address book files that are downloaded to computers running Communicator. When a person uses Communicator to search for contacts, he or she will typically search through the Address Book files stored on the local computer. That makes searches much faster, and reduces wear on the network and on the domain controllers. This also explains why you can only search for contacts using a limited number of search fields; that’s because Address Book files contain only a relatively small subset of the information stored in Active Directory.

Address Book servers are governed using Address Book configuration settings; these settings determine such things as how often Address Book servers are synchronized with Active Directory and how often Address Book files are generated. When you install Communications Server 2010, a set of global Address Book settings is created for you. You can also create custom configuration settings that can be applied to individual sites. These site configurations, if they exist, apply to any Address Book servers operating in the site, and always take precedence over the global settings.

The New-CsAddressBookConfiguration cmdlet enables you to create site-level Address Book configuration settings. To remove any Address Book settings you configured at the site scope, use the Remove-CsAddressBookConfiguration cmdlet. Note that you can also run Remove-CsAddressBookConfiguration against the global settings; however, the global settings cannot actually be deleted. Instead, running Remove-CsAddressBookConfiguration against the global settings will reset all of the global properties to their default values.

Return Types

Remove-CsAddressBookConfiguration does not return a value or object. Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.AddressBook.AddressBookSettings object.


-------------------------- Example 1 --------------------------

Copy Code
Remove-CsAddressBookConfiguration -Identity site:Redmond

In this example, Remove-CsAddressBookConfiguration is used to delete the Address Book server settings with the identity site:Redmond. Using the Identity parameter ensures that only the specified Address Book server will be removed.

-------------------------- Example 2 --------------------------

Copy Code
Get-CsAddressBookConfiguration -Filter site:* | Remove-CsAddressBookConfiguration

In Example 2, all the Address Book settings collections that have been configured at the site scope are removed. To do this, the Get-CsAddressBookConfiguration cmdlet is used to retrieve a collection of all the Address Book settings that have been configured at the site scope. (This is done by using the Filter parameter and the filter value "site:*".) The retrieved collection is then piped to the Remove-CsAddressBookConfiguration cmdlet, which removes all the settings in that collection. To remove all the site settings. and to reset the global settings to their default values, use this command:

Get-CsAddressBookConfiguration | Remove-CsAddressBookConfiguration

-------------------------- Example 3 --------------------------

Copy Code
Get-CsAddressBookConfiguration | Where-Object {$_.KeepDuration -lt 30.} | Remove-CsAddressBookConfiguration

The preceding command removes all the Address Book settings where change files are kept for less than 30 days. To carry out this task, Get-CsAddressBookConfiguration is used to return a collection of all the Address Book settings in the organization. This collection is then piped to Where-Object, which selects only those setting collections where the KeepDuration property is less than (-lt) 30 days. (Note the syntax: 30., with a period following the number of days.) Finally, the filtered collection is piped to Remove-CsAddressBookConfiguration, which deletes each item in that filtered collection.