Topic Last Modified: 2010-11-04

Returns information about Address Book configuration settings.


Get-CsAddressBookConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>]
Get-CsAddressBookConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>]


Parameter Required Type Description




Unique identifier for the collection of Address Book settings to be returned. To refer to the global settings, use this syntax: -Identity global. To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond.

Note that you cannot use wildcards when specifying an Identity. If you need to use wildcards, then include the Filter parameter instead.

If this parameter is not specified, then Get-CsAddressBookConfiguration returns a collection of all the Address Book settings in use in the organization.




Enables you to use wildcard characters in order to return a collection (or multiple collections) of Address Book settings. For example, to return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity, use this syntax: -Filter *EMEA*.



Switch Parameter

Retrieves the Address Book configuration data from the local replica of the Central Management store rather than from the Central Management store itself.

Detailed Description

Address Book servers are intermediaries between Active Directory Domain Services (AD DS) and Microsoft Lync Server 2010. The Address Book server ensures that the user information stored in Lync Server 2010 is in synch with the user information stored in Active Directory. This is done by periodically synching Address Book files with information stored in the User database.

In addition, Address Book servers periodically generate index files that are downloaded to computers running Lync 2010. When a user searches for contacts, he or she either search through these index files or search the Address Book index files stored in the Central Management store.

Address Book servers are governed using Address Book configuration settings; these settings determine such things as how often Address Book files are synchronized with the user database and how often these Address Book index files are generated. When you install Lync 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 settings, if they exist, apply to any Address Book servers operating in the site, and take precedence over the global settings.

You can use the Get-CsAddressBookConfiguration cmdlet to return information about any (or all) of the Address Book settings currently in use in your organization.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsAddressBookConfiguration cmdlet locally: RTCUniversalUserAdmins, RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsAddressBookConfiguration"}

Input Types

None. Get-CsAddressBookConfiguration does not accept pipelined input.

Return Types

Get-CsAddressBookConfiguration returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings object.


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

Copy Code

The preceding example returns information about all the Address Book configuration settings in use in your organization. This is the default behavior if you call Get-CsAddressBookConfiguration without any additional parameters.

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

Copy Code
Get-CsAddressBookConfiguration -Identity site:Redmond

Example 2 returns information for the Address Book configuration settings with the Identity site:Redmond.

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

Copy Code
Get-CsAddressBookConfiguration -Filter site:*

In the preceding example, the Filter parameter and the filter value "site:*" are used to return information about all the Address Book configuration settings that have been applied at the site scope. The supplied filter value returns information for all the Address Book settings that have an Identity that begins with the string value "site:".

-------------------------- Example 4 --------------------------

Copy Code
Get-CsAddressBookConfiguration | Where-Object {$_.UseNormalizationRules -eq $True}

In Example 4, information is returned for all the Address Book configuration settings where the settings uses normalization rules when parsing phone numbers. To do this, the command first uses Get-CsAddressBookConfiguration to return a collection of all the Address Book settings in the organization. That collection is then piped to the Where-Object cmdlet, which selects only those settings where the UseNormalizationRules property is equal to True.

See Also