Export (0) Print
Expand All

Set-SyncServerSetting

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

Modifies settings of the Sync Share.

Syntax

Parameter Set: InputObject (cdxml)
Set-SyncServerSetting [-ADFSUrl <String> ] [-AdministratorEmail <String> ] [-AsJob] [-CimSession <CimSession[]> ] [-Description <String> ] [-InputObject <CimInstance[]> ] [-MinimumChangeDetectionMins <UInt32> ] [-PassThru] [-SuspendedUser <String[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-SyncServerSetting cmdlet modifies settings of the Sync Share.

Parameters

-ADFSUrl<String>

Specifies the Url of the Active Directory Federation Services (ADFS) for authentication . If you do not specify this parameter, the cmdlet uses the default Windows authentication.


Aliases

ADFSAuthenticationUrl

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-AdministratorEmail<String>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-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 the Sync Share server. The description appears in Server Manager and in Windows PowerShell®. The description does not appear to users.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-InputObject<CimInstance[]>

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-MinimumChangeDetectionMins<UInt32>

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. The minimum value that you can set is 1.

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.


Aliases

none

Required?

false

Position?

named

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

-SuspendedUser<String[]>

Specifies a list of users who are not permitted to sync on this server. Needs to be valid user or security-enabled group.


Aliases

DeniedAccount,BlockedUser

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

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

Outputs

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



  • Change synchronization configuration on the local server.



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.


PS C:\> Set-SyncServerSetting -AdministratorEmail "admin@contoso.com"

Related topics

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