Update-CsUserData
Uses previously-exported user information to update Skype for Business Server user data. This cmdlet was introduced in Lync Server 2013.
Syntax
Default (Default)
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
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Prompts you for confirmation before executing the command.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DomainController
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
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.
Parameter properties
| Type: | Fqdn |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-FileName
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Full path to the .ZIP file or .XML file containing the user data to be updated. For example:
-FileName "C:\Data\Lync2010.zip"
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Suppresses the display of any non-fatal error message that might occur when running the command.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RoutingGroupFilter
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TargetPoolFqdn
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Registrar pool containing the user accounts to be updated.
Parameter properties
| Type: | Fqdn |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-TestMode
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
When included in a command, Update-CsUserData will verify that the data can be updated, but will not actually update that data.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ThreadCount
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Number of threads that can be devoted to the update task.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserFileFilter
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Full path to a text file containing a list of user URIs for whom data should be exported.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserFilter
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
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"
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
The Update-CsUserData cmdlet does not accept pipelined input.
Outputs
Microsoft.Rtc.Management.User.UserData
The Update-CsUserData cmdlet updates Skype for Business Server 2015 user information.