Update-CsUserData
Uses previously-exported user information to update Skype for Business Server user data. This cmdlet was introduced in Lync Server 2013.
Syntax
Update-CsUserData
[-FileName] <String>
[-Confirm]
[-DomainController <Fqdn>]
[-Force]
[-RoutingGroupFilter <String>]
[-UserFilter <String>]
[-WhatIf]
[-TargetPoolFqdn <Fqdn>]
[-TestMode]
[-ThreadCount <Int32>]
[-UserFileFilter <String>]
[<CommonParameters>] 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.
Skype for Business Server Control Panel: The functions carried out by the Update-CsUserData cmdlet are not available in the Skype for Business Server Control Panel.
Examples
-------------------------- Example 1 --------------------------
Update-CsUserData -Filename "C:\Logs\ExportedUserData.zip"The command shown in Example 1 updates Skype for Business Server user data based on information stored in the file C:\Logs\ExportedUserData.zip.
-------------------------- Example 2 --------------------------
Update-CsUserData -Filename "C:\Logs\ExportedUserData.zip" -UserFilter "kenmyer@litwareinc.com"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).
Parameters
-Confirm
Prompts you for confirmation before executing the command.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-DomainController
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.
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-FileName
Full path to the .ZIP file or .XML file containing the user data to be updated. For example:
-FileName "C:\Data\Lync2010.zip"
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-Force
Suppresses the display of any non-fatal error message that might occur when running the command.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-RoutingGroupFilter
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-TargetPoolFqdn
Registrar pool containing the user accounts to be updated.
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Skype for Business Server 2015, Skype for Business Server 2019 |
-TestMode
When included in a command, Update-CsUserData will verify that the data can be updated, but will not actually update that data.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Skype for Business Server 2015, Skype for Business Server 2019 |
-ThreadCount
Number of threads that can be devoted to the update task.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Skype for Business Server 2015, Skype for Business Server 2019 |
-UserFileFilter
Full path to a text file containing a list of user URIs for whom data should be exported.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Skype for Business Server 2015, Skype for Business Server 2019 |
-UserFilter
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"
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
-WhatIf
The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 |
Inputs
None. The Update-CsUserData cmdlet does not accept pipelined input.
Outputs
The Update-CsUserData cmdlet updates Skype for Business Server 2015 user information.