Edit

Share via

Get-SyncUserStatus

  • Reference
Module:
SyncShare

Gets the user status from the Sync Share server.

Syntax

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

Description

The Get-SyncUserStatus cmdlet gets 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.

Examples

Example 1: Get the synchronization user status

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

This command retrieves the synchronization user status for User01.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SyncShare

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

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-User

Specifies the user alias and domain name for which this cmdlet gets the data, in Domain\User Name format.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Outputs

SyncUserStatus