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

Returns information about Address Book server settings, including the number of days that Address Book change files are retained and the percentage of Address Book information that must be modified before a new change file is created. Users typically query Address Book files any time they search for a new contact.

Syntax


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


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

Parameters

Parameter	Required	Type	Description
Identity	Optional	XdsIdentity	Indicates the unique identifier for the collection of Address Book settings you want to return. 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 will return a collection of all the Address Book settings in use in the organization.
Filter	Optional	String	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 (the only property you can filter on), use this syntax: -Filter EMEA*.
LocalStore	Optional	Switch Parameter	This parameter is for testing purposes only.

Parameter

Required

Type

Description

Identity

Optional

XdsIdentity

Indicates the unique identifier for the collection of Address Book settings you want to return. 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 will return a collection of all the Address Book settings in use in the organization.

Filter

Optional

String

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 (the only property you can filter on), use this syntax: -Filter *EMEA*.

LocalStore

Optional

Switch Parameter

This parameter is for testing purposes only.

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, 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. 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.

Return Types

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

Examples

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

	Copy Code
Get-CsAddressBookConfiguration

The preceding example returns information about all the Address Book servers 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 server 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 servers that have been configured at the site scope. This is done by returning information for all the Address Book severs 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 setting collections where the Address Book server 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 (-eq) True ($True).