Microsoft SyncShare reference: Modifies settings of the Sync Share. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.
Use an account with the target resource permissions documented for Set-SyncServerSetting. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.
Supported environments
Windows / SyncShare · Windows Server 2025 documentation; feature/module prerequisites apply
Parameters
-ADFSUrl
Specifies the link, as a URL, of the Active Directory Federation Services (ADFS) for authentication . If you do not specify this parameter, the cmdlet uses the default Windows authentication.
-AdministratorEmail
Specifies a semicolon-separated list of email addresses of the administrators of the Sync Share server. Sync Server sends the email addressed to the client so the client can contact the administrator to report issues and to receive help troubleshooting the issues.
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
-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.
-Confirm
Prompts you for confirmation before running the cmdlet.
-Description
Specifies a description for the Sync Share server. The description appears in Server Manager and in Windows PowerShell. The description does not appear to users.
-InputObject
Specifies the input object that is used in a pipeline command.
-MinimumChangeDetectionMins
Specifies the time, in minutes, before the Sync Share server detects changes on devices and syncs the client and server. The default value is 5 minutes. The minimum value that you can set is 1 minute. The Sync Share server synchronizes with multiple devices for potentially many users. Increasing the frequency that Sync Share detects changes on devices and syncs the client and server results in fresher data on the devices of users. However, this increases the load on the Sync Share server and can affect the performance of the synchronization, particularly for users who make frequent changes to the files directly on the server and who have many devices.
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
-SuspendedUser
Specifies a list of users who are not permitted to synchronize on this server. Needs to be valid user or security-enabled group.
-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.
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Prerequisites
Windows with the SyncShare module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.
Security considerations
This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.
Examples
Example 1: Set the administrator email for the Sync Share server
This command sets the administrator email address for the Sync Share server. The administrator email address is propagated to the client devices so users can send email to the administrator and request help with troubleshooting Work Folders. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.