Get-SyncUserStatus

Get-SyncUserStatus

Retrieves the user status from the Sync Share server.

Syntax

Parameter Set: Query (cdxml)
Get-SyncUserStatus [-User] <String> [-SyncShare] <String> [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-SyncUserStatus cmdlet retrieves the user status from the Sync Share server, such as the status of a user’s PCs and device synchronization. Use this cmdlet to troubleshoot user connection issues.

Parameters

-AsJob

-CimSession<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<String>

Specifies the name of a Sync Share that hosts the user data.

-ThrottleLimit<Int32>

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<String>

Specifies the user alias and domain name for which to retrieve the data, in Domain\User Name format.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• SyncUserStatus

Examples

Example 1: Retrieve the user status

This command retrieves the synchronization user status for User01.

PS C:\> Get-SyncUserStatus -User User01 -SyncShare Share01