Export (0) Print
Expand All

Get-SyncShare

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Get-SyncShare

Retrieves Sync Shares.

Syntax

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




Detailed Description

The Get-SyncShare cmdlet retrieves one or more Sync Shares and displays their settings.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of names of Sync Shares.


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Scope<String>

Specifies a Virtual Computer Object (VCO), if the server is part of a cluster. Use this parameter to return the Sync Shares that belong to a VCO.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

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.

  • SyncShare

Examples

Example 1: Retrieve all Sync Shares on a server

This command retrieves all of the Sync Shares on the server.


PS C:\> Get-SyncShare
ConflictResolutionPolicy : KeepBoth
Description              : 
DevicePolicy             : t1
Enabled                  : True
ExclusiveAccessToUser    : True
Name                     : t1
Path                     : c:\t1
StagingFolder            : c:\EcsStagingArea\t1
StagingQuota             : 1099511627776
StagingQuotaPerUser      : 10737418240
Type                     : User Data
User                     : {users}
UserFolderName           : %username%
PSComputerName           : 
ConflictResolutionPolicy : KeepBoth
Description              : 
DevicePolicy             : Contoso-share01
Enabled                  : True
ExclusiveAccessToUser    : True
Name                     : Contoso-share01
Path                     : K:\Share1
StagingFolder            : K:\EcsStagingArea\Contoso-share01
StagingQuota             : 1099511627776
StagingQuotaPerUser      : 10737418240
Type                     : User Data
User                     : {EngGroup}
UserFolderName           : %username%
PSComputerName           :  

Example 2: Retrieve a specific Sync Share

This command retrieves the Sync Share named Contoso-share01.


PS C:\> Get-SyncShare Contoso-share01
ConflictResolutionPolicy : KeepBoth
Description              : 
DevicePolicy             : Contoso-share01
Enabled                  : True
ExclusiveAccessToUser    : True
Name                     : Contoso-share01
Path                     : K:\Share01
StagingFolder            : K:\EcsStagingArea\Contoso-share01
StagingQuota             : 1099511627776
StagingQuotaPerUser      : 10737418240
Type                     : User Data
User                     : {EngGroup}
UserFolderName           : %username%
PSComputerName           :  

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft