COMMAND EVERYTHING.

Get-SyncUserStatus

Gets the user status from the Sync Share server.

PowerShell · Risk: Low · Documentation Verified

Last verified: 2026-10-26

Microsoft SyncShare reference: Gets the user status from the Sync Share server. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.

Get-SyncUserStatus [-User] <String> [-SyncShare] <String> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
 [-AsJob] [<CommonParameters>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Get-SyncUserStatus. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.

Supported environments

Windows / SyncShare · Windows Server 2025 documentation; feature/module prerequisites apply

Parameters

-AsJob: Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
-CimSession: Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.
-SyncShare (required): Specifies the name of a Sync Share that hosts the user data.
-ThrottleLimit: Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.
-User (required): Specifies the user alias and domain name for which this cmdlet gets the data, in Domain\User Name format.

Prerequisites

Windows with the SyncShare module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.

Security considerations

This is a read-oriented cmdlet; protect any sensitive results and check the documented effects of your selected parameters.

Examples

Example 1: Get the synchronization user status

Get-SyncUserStatus -User "User01" -SyncShare "Share01"

This command retrieves the synchronization user status for User01. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.

Sources

https://github.com/MicrosoftDocs/windows-powershell-docs/blob/b7645dd8c687139b28e845119da30ec670526507/docset/winserver2025-ps/SyncShare/Get-SyncUserStatus.md

https://learn.microsoft.com/powershell/module/syncshare/get-syncuserstatus?view=windowsserver2025-ps

Personal collections

Explain or customize this command with AI

Related commands