See Also
Topic Last Modified: 2014-02-19
Uses previously-exported user information to update Lync Server user data. This cmdlet was introduced in Lync Server 2013.
Syntax
Update-CsUserData -FileName <String> [-Confirm
[<SwitchParameter>]] [-DomainController <Fqdn>] [-Force
<SwitchParameter>] [-RoutingGroupFilter <String>]
[-TargetPoolFqdn <Fqdn>] [-TestMode <SwitchParameter>]
[-ThreadCount <Int32>] [-UserFileFilter <String>]
[-UserFilter <String>] [-WhatIf
[<SwitchParameter>]]
|
Examples
Example 1
The command shown in Example 1 updates Lync Server user data based on information stored in the file C:\Logs\ExportedUserData.zip.
 Copy Code |
|
|---|---|
Update-CsUserData -Filename "C:\Logs\ExportedUserData.zip" |
|
Example 2
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).
| Copy Code |
|
|---|---|
Update-CsUserData -Filename "C:\Logs\ExportedUserData.zip" -UserFilter "kenmyer@litwareinc.com" |
|
Detailed Description
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.
Parameters
| 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 |
PARAMVALUE: Fqdn |
|
TestMode |
Optional |
System.Management.Automation.SwitchParameter |
PARAMVALUE: SwitchParameter |
|
ThreadCount |
Optional |
System.Int32 |
PARAMVALUE: Int32 |
|
UserFileFilter |
Optional |
System.String |
PARAMVALUE: String |
|
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. |
Input Types
None. The Update-CsUserData cmdlet does not accept pipelined input.
Return Types
The Update-CsUserData cmdlet updates Lync Server user information.
