Topic Last Modified: 2013-02-20

Forces the specified Address Book servers to synchronize their contents with the User database. This cmdlet was introduced in Lync Server 2010.

Syntax

Update-CsAddressBook [-Force <SwitchParameter>] [-Fqdn <Fqdn>]

Examples

EXAMPLE 1

In Example 1, the Update-CsAddressBook cmdlet is called without any parameters. This synchronizes all the Address Book servers in the organization.

Copy Code
Update-CsAddressBook

EXAMPLE 2

In Example 2, only a single Address Book server is synchronized: the server with the FQDN atl-abs-001.litwareinc.com.

Copy Code
Update-CsAddressBook -Fqdn atl-abs-001.litwareinc.com

Detailed Description

Address Book servers are intermediaries between Active Directory and Lync Server. The Address Book server ensures that the user information stored in Lync Server is in synch with the user information stored in Active Directory. This is done by periodically synching Address Book files with the information stored in the User database. By default, this synchronization takes place every five minutes. (However, that time interval can be modified by using the Set-CsAddressBookConfiguration cmdlet.)

If you can’t wait for synchronization to take place or if it appears that, for some reason, synchronization isn’t taking place, you can use the Update-CsAddressBook cmdlet to force an Address Book server to immediately synch with the user information stored in the User database.

Who can run this cmdlet: By default, members of the following groups are authorized to run the Update-CsAddressBook 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 custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:

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

Parameters

Parameter Required Type Description

Force

Optional

System.Management.Automation.SwitchParameter

Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet.

Fqdn

Optional

Microsoft.Rtc.Management.Deploy.Fqdn

Enables you to specify an individual Address Book to be updated. If this parameter is not included then all of your Address Book servers will be synchronized with the User database. Individual Address Book servers should be referenced by their fully qualified domain name (FQDN); for example, atl-abs-001.litwareinc.com.

Input Types

None. The Update-CsAddressBook cmdlet does not accept pipelined input.

Return Types

None. Instead, the Update-CsAddressBook cmdlet updates existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings object.

See Also