Export (0) Print
Expand All

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

Set-SyncShare

Modifies the settings for a sync share.

Syntax

Parameter Set: Query (cdxml)
Set-SyncShare [-Name] <String[]> [-AsJob] [-CimSession <CimSession[]> ] [-Description <String> ] [-FallbackEnterpriseID <String> ] [-InheritParentFolderPermission] [-MaxUploadFile <UInt64> ] [-PassThru] [-PasswordAutolockExcludeDomain <String[]> ] [-RequireEncryption <Boolean> ] [-RequirePasswordAutoLock <Boolean> ] [-ThrottleLimit <Int32> ] [-User <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: InputObject (cdxml)
Set-SyncShare -InputObject <CimInstance[]> [-AsJob] [-CimSession <CimSession[]> ] [-Description <String> ] [-FallbackEnterpriseID <String> ] [-InheritParentFolderPermission] [-MaxUploadFile <UInt64> ] [-PassThru] [-PasswordAutolockExcludeDomain <String[]> ] [-RequireEncryption <Boolean> ] [-RequirePasswordAutoLock <Boolean> ] [-ThrottleLimit <Int32> ] [-User <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-SyncShare cmdlet modifies the settings for a sync share.

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

-Description<String>

Specifies a description for a sync share configuration. The description appears in Server Manager and in Windows PowerShell® but is not visible to end users. The description can have a maximum of a 150 characters.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-FallbackEnterpriseID<String>

Specifies the fallback Enterprise ID that the sync share uses if it cannot successfully query Active Directory® Domain Services (AD DS). If the server cannot successfully query AD DS, the server uses the fully qualified domain name (FQDN) of the sync server as the fallback Enterprise ID unless you specify a different Enterprise ID by using this parameter. The Enterprise ID is issued by the Work Folders client to encrypt data on the PC or device.

The Enterprise ID is typically constructed by querying AD DS for the primary SMTP address of the user, removing the username and ampersand (user@), and sending the remainder to the client as the Enterprise ID. For example, EvanNarvaez@Contoso.com yields the contoso.com Enterprise ID.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InheritParentFolderPermission

Indicates that the sync share inherits the permissions of the parent folder. If you specify this parameter, the user folder inherits permissions from the parent folder of the sync share, and administrators can access the data. If you do not specify this parameter, by default each user is granted exclusive access to their user folder, and administrators have no access rights.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InputObject<CimInstance[]>

Specifies the SyncShare object to use as input to this cmdlet. You can use this parameter, or you can use the pipeline operator to pass input to this cmdlet.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-MaxUploadFile<UInt64>

Specifies the maximum file size, in bytes, that users can upload to the server. The minimum value that you can specify is 1 MB.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Name<String[]>

Specifies a name for the sync share. The name that you specify has the following requirements:

-- The name must be unique on the sync server
-- The name can have a maximum of 75 characters
-- You cannot start or end a name with a space
-- You cannot end a name with a period
-- You cannot used a reserved name, such as COM1, LPT1, or NUL
-- You cannot use the following characters: <>:\"/\\|?*


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PasswordAutolockExcludeDomain<String[]>

Specifies a list of domain names in FQDN format whose clients are to be exempted from the password policy. If the RequirePasswordAutoLock property on the sync share is false, then this parameter has no effect. If RequirePasswordAutoLock is true, then clients that are members of the specified domains are not requested by Work Folders to enforce password length and lock policies on the device. It is assumed that their security is managed by the Group Policy of their domain.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RequireEncryption<Boolean>

Indicates whether the sync server requests that the contents of Work Folders be encrypted on each PC and device that accesses the sync share.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RequirePasswordAutoLock<Boolean>

Indicates whether the device meet the following policies:

-- Password minimum length of six characters
-- Lock screen activates after a maximum of 15 minutes
-- User account lockout after a maximum of 10 failed sign-in attempts


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

-User<String[]>

Specifies an array of security groups or users who are allowed to sync data with this sync share. Add accounts or security groups in Security Accounts Manager (SAM) account format.


Aliases

AllowedAccount,AllowedUser

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

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.

  • SyncShare

    You can pass an array of SyncShare objects to the InputObject parameter by using the pipeline operator.


Outputs

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

  • SyncShare

    If you specify the PassThru parameter, this cmdlet outputs an object that represents the modified sync shares.


Examples

Example 1: Modify a sync share to enable inherited permissions

This command modifies settings on the share named Share01, and sets KeepParentFolderPermission to enable the share to inherit permissions from the parent folder.


PS C:\> Set-SyncShare Share01 -KeepParentFolderPermission 

Example 2: Modify the sync share to change the user group

This command modifies settings on the share named Share01, and sets the user group to ContosoGroup.


PS C:\> Set-SyncShare Share01 -User "ContosoGroup"

Example 3: Modify a sync share to add a user group

This example modifies settings on the share named Share01, and enables the user group named ContosoEngGroup to access the share.

The first command uses the Get-SyncShare cmdlet to retrieve the sync share for Share01, and assigns the results to the variable $Current.

The second command uses the Set-SyncShare cmdlet to modify the sync share and add the current user and the ContosoEngGroup to the list of users allowed to access the share.

The third command uses the Get-SyncShare cmdlet to verify the results.


PS C:\> $Current = Get-SyncShare Share01
PS C:\> Set-SyncShare Share01 -User $Current.user,"ContosoEngGroup"
PS C:\> Get-SyncShare Share01
ConflictResolutionPolicy : KeepLatest
Description :
DevicePolicy : Share01
Enabled : True
ExclusiveAccessToUser : False
Name : Share01
Path : K:\Share01
StagingFolder : K:\EcsStagingArea\Share01
StagingQuota : 1099511627776
StagingQuotaPerUser : 10737418240
Type : User Data
User : {HRGroup, EngGroup}
UserFolderName : %username%
PSComputerName :

Related topics

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