Set-SyncShare
Modifies the settings for a Sync Share.
Syntax
Query (cdxml) (Default)
Set-SyncShare
[-Name] <String[]>
[-Description <String>]
[-User <String[]>]
[-InheritParentFolderPermission]
[-MaxUploadFile <UInt64>]
[-RequireEncryption <Boolean>]
[-RequirePasswordAutoLock <Boolean>]
[-FallbackEnterpriseID <String>]
[-PasswordAutolockExcludeDomain <String[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InputObject (cdxml)
Set-SyncShare
-InputObject <CimInstance[]>
[-Description <String>]
[-User <String[]>]
[-InheritParentFolderPermission]
[-MaxUploadFile <UInt64>]
[-RequireEncryption <Boolean>]
[-RequirePasswordAutoLock <Boolean>]
[-FallbackEnterpriseID <String>]
[-PasswordAutolockExcludeDomain <String[]>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-SyncShare cmdlet modifies the settings for a Sync Share.
Examples
Example 1: Modify a sync share to enable inherited permissions
PS C:\> Set-SyncShare -Name "Share01" -InheritParentFolderPermission
This command modifies settings on the share named Share01, and sets the InheritParentFolderPermission parameter to enable the share to inherit permissions from the parent folder.
Example 2: Modify the sync share to change the user group
PS C:\> Set-SyncShare -Name "Share01" -User "ContosoGroup"
This command modifies settings on the share named Share01, and sets the user group to ContosoGroup.
Example 3: Modify a sync share to add a user group
PS C:\> $Current = Get-SyncShare -Name "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 :
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.
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 |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Description
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.
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 |
-FallbackEnterpriseID
Specifies the fallback Enterprise ID that the Sync Share uses if it cannot successfully query Active Directory® Domain Services (nextref_adds). If the server cannot successfully query nextref_adds, 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 nextref_adds 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 instance, EvanNarvaez@Contoso.com yields the contoso.com Enterprise ID.
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 |
-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.
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: | True |
| Value from remaining arguments: | False |
-InputObject
Specifies the input object that is used in a pipeline command.
Parameter properties
| Type: | CimInstance[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
InputObject (cdxml)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MaxUploadFile
Specifies the maximum file size, in bytes, that users can upload to the server. The minimum value that you can specify is 1 MB.
Parameter properties
| Type: | UInt64 |
| 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 |
-Name
Specifies a name for the Sync Share as an array. 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: <>:"/\\|?*
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Query (cdxml)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
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 |
-PasswordAutolockExcludeDomain
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.
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 |
-RequireEncryption
Indicates whether the sync server requests that the contents of work folders be encrypted on each PC and device that accesses the Sync Share.
Parameter properties
| Type: | Boolean |
| 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 |
-RequirePasswordAutoLock
Indicates whether the device meets 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
Parameter properties
| Type: | Boolean |
| 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 |
-User
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.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AllowedAccount, AllowedUser |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
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.
Inputs
SyncShare Module
You can pass an array of SyncShare objects to the InputObject parameter by using the pipeline operator.
Outputs
SyncShare Module
If you specify the PassThru parameter, this cmdlet outputs an object that represents the modified Sync Shares.