Edit

Share via


Get-SyncShare

Gets one or more Sync Shares.

Syntax

Default (Default)

Get-SyncShare
    [[-Name] <String[]>]
    [-Scope <String>]
    [-CimSession <CimSession[]>]
    [-ThrottleLimit <Int32>]
    [-AsJob]
    [<CommonParameters>]

Description

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

Examples

Example 1: Get all Sync Shares on a 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           :

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

Example 2: Get a specific Sync Share

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           :

This command gets the Sync Share named Contoso-share01.

Parameters

-AsJob

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

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

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

Parameter properties

Type:

CimSession[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:Session

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies an array of names of Sync Shares that this cmdlet gets.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Scope

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.

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:True
Value from remaining arguments: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.

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

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.

Outputs

SyncShare Module