.png)
Update-CsUserData
Topic Last Modified: 2013-02-22
Uses previously-exported user information to update Lync Server user data. This cmdlet was introduced in Lync Server 2013.
Update-CsUserData -FileName <String> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-RoutingGroupFilter <String>] [-UserFilter <String>] [-WhatIf [<SwitchParameter>]]
The command shown in Example 1 updates Lync Server user data based on information stored in the file C:\Logs\ExportedUserData.zip.
Update-CsUserData -Filename "C:\Logs\ExportedUserData.zip"
In Example 2, user data is updated for a single user: the user with the SIP address kenmyer@litwareinc.com. This is done by including the UserFilter parameter followed by the user’s SIP address (minus the sip: prefix).
Update-CsUserData -Filename "C:\Logs\ExportedUserData.zip" -UserFilter "kenmyer@litwareinc.com"
The Update-CsUserData cmdlet enables administrators to update user data for a specified user or set of users. (Note that this data must have previously been exported by using the Export-CsUserData cmdlet.) This updating is typically done in order to restore lost data to a logged-on user.
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 command-line interface prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Update-CsUserData"}
Lync Server Control Panel: The functions carried out by the Update-CsUserData cmdlet are not available in the Lync Server Control Panel.
| Parameter | Required | Type | Description |
|---|---|---|---|
| FileName | Required | System.String | Full path to the .ZIP file or .XML file containing the user data to be updated. For example: -FileName “C:\Data\Lync2010.zip" |
| Confirm | Optional | System.Management.Automation.SwitchParameter | Prompts you for confirmation before executing the command. |
| DomainController | Optional | Microsoft.Rtc.Management.Deploy.Fqdn | Enables administrators to specify the FQDN of the domain controller to be used when running the Update-CsUserData cmdlet. If not specified, the cmdlet will use the first available domain controller. |
| Force | Optional | System.Management.Automation.SwitchParameter | Suppresses the display of any non-fatal error message that might occur when running the command. |
| RoutingGroupFilter | Optional | System.String | Enables you to update data only for the specified routing groups. Routing groups are used to indicate the Front End server that users register with. |
| TargetPoolFqdn | Optional | Microsoft.Rtc.Management.Deploy.Fqdn | Fully qualified domain name of the pool whose user information should be updated. If this parameter is included then only users homed on the specified pool will be updated. Users from all other pools will be skipped. For example -TargetPoolFqdn "atl-cs-001.litwareinc.com" |
| TestMode | Optional | System.Management.Automation.SwitchParameter | When specified, the Update-CsUserData cmdlet will run in order to verify that the specified user data can be updated. However, the data will not actually be updated and no changes will be made to Lync Server. |
| UserFileFilter | Optional | System.String | When included in a call to the Update-CsUserData cmdlet, only users included in the specified file will be updated; users not found in the specified file will be skipped. Note that the file used as the user filter file must have been generated by using the Export-CsUserData cmdlet. When including the UserFileFilter parameter, specify the full path to the .ZIP file. For example: -UserFileFilter "C:\Updates\RedmondUserUpdates.ZIP" |
| UserFilter | Optional | System.String | Enables you to update data for a single user. That user specified by using his or her SIP address, minus the sip: prefix. For example: -UserFilter "kenmyer@litwareinc.com" |
| WhatIf | Optional | System.Management.Automation.SwitchParameter | Describes what would happen if you executed the command without actually executing the command. |
None. The Update-CsUserData cmdlet does not accept pipelined input.
The Update-CsUserData cmdlet updates Lync Server user information.
