Applies to: Exchange Server 2013

Topic Last Modified: 2012-08-08

Use the New-EdgeSyncServiceConfig cmdlet to create edge synchronization service settings that control the general synchronization behavior shared by all EdgeSync services.

Syntax


New-EdgeSyncServiceConfig [-ConfigurationSyncInterval <EnhancedTimeSpan>] [-Confirm [<SwitchParameter>]] [-CookieValidDuration <EnhancedTimeSpan>] [-DomainController <Fqdn>] [-FailoverDCInterval <EnhancedTimeSpan>] [-LockDuration <EnhancedTimeSpan>] [-LockRenewalDuration <EnhancedTimeSpan>] [-LogEnabled <$true \| $false>] [-LogLevel <None \| Low \| Medium \| High>] [-LogMaxAge <EnhancedTimeSpan>] [-LogMaxDirectorySize <Unlimited>] [-LogMaxFileSize <Unlimited>] [-LogPath <String>] [-OptionDuration <EnhancedTimeSpan>] [-RecipientSyncInterval <EnhancedTimeSpan>] [-Site <AdSiteIdParameter>] [-WhatIf [<SwitchParameter>]]

New-EdgeSyncServiceConfig [-ConfigurationSyncInterval
<EnhancedTimeSpan>] [-Confirm [<SwitchParameter>]]
[-CookieValidDuration <EnhancedTimeSpan>] [-DomainController
<Fqdn>] [-FailoverDCInterval <EnhancedTimeSpan>]
[-LockDuration <EnhancedTimeSpan>] [-LockRenewalDuration
<EnhancedTimeSpan>] [-LogEnabled <$true | $false>]
[-LogLevel <None | Low | Medium | High>] [-LogMaxAge
<EnhancedTimeSpan>] [-LogMaxDirectorySize <Unlimited>]
[-LogMaxFileSize <Unlimited>] [-LogPath <String>]
[-OptionDuration <EnhancedTimeSpan>] [-RecipientSyncInterval
<EnhancedTimeSpan>] [-Site <AdSiteIdParameter>]
[-WhatIf [<SwitchParameter>]]

Examples

EXAMPLE 1

This example creates EdgeSync service settings with the following configuration:

EdgeSync logging is enabled.
The log files are stored in the EdgeSyncLog share on Server01.
The maximum individual log file size is 5 megabytes (MB).
The log files are kept for 3 days.

	Copy Code
New-EdgeSyncServiceConfig -LogEnabled $true -LogPath "\\Server01\EdgeSyncLog" -LogMaxFileSize 5MB -LogMaxAge 3

Detailed Description

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "EdgeSync" entry in the Mail Flow Permissions topic.

Parameters

Parameter	Required	Type	Description
ConfigurationSyncInterval	Optional	Microsoft.Exchange.Data.EnhancedTimeSpan	The ConfigurationSyncInterval parameter specifies how frequently the EdgeSync service synchronizes configuration data. The default value is 3 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.
Confirm	Optional	System.Management.Automation.SwitchParameter	The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.
CookieValidDuration	Optional	Microsoft.Exchange.Data.EnhancedTimeSpan	The CookieValidDuration parameter specifies how long a cookie record is valid. The default value is 21 days. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.
DomainController	Optional	Microsoft.Exchange.Data.Fqdn	The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.
FailoverDCInterval	Optional	Microsoft.Exchange.Data.EnhancedTimeSpan	The FailoverDCInterval parameter specifies how long EdgeSync waits before failing over to another domain controller if it can't read configuration data from Active Directory. The default value is 5 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.
LockDuration	Optional	Microsoft.Exchange.Data.EnhancedTimeSpan	The LockDuration parameter specifies how long an instance of the EdgeSync service can maintain an exclusive lock on the synchronization rights. While an EdgeSync service maintains an exclusive lock on synchronization rights, no other EdgeSync service can take over synchronization. The default value is 6 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.
LockRenewalDuration	Optional	Microsoft.Exchange.Data.EnhancedTimeSpan	The LockRenewalDuration parameter specifies how long before the expiry of an exclusive lock an EdgeSync service can renew the lock. The default value is 4 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.
LogEnabled	Optional	System.Boolean	The LogEnabled parameter enables or disables the EdgeSync log. Valid input for this parameter is `$true` or `$false`. The default value is `$true`.
LogLevel	Optional	Microsoft.Exchange.Data.Directory.SystemConfiguration.EdgeSyncLoggingLevel	The LogLevel parameter specifies the EdgeSync logging level. Valid values for this parameter are `None`, `Low`, `Medium` and `High`. The default value is `None`.
LogMaxAge	Optional	Microsoft.Exchange.Data.EnhancedTimeSpan	The LogMaxAge parameter specifies the maximum duration in days to keep the EdgeSyncLog files. Log files older than the specified value can be overwritten. The default value is 30 days. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.
LogMaxDirectorySize	Optional	Microsoft.Exchange.Data.Unlimited	The LogMaxDirectorySize parameter specifies the maximum amount of disk space the EdgeSyncLog directory can use. The default value is 250 MB. When you enter a value, qualify the value with one of the following units: `B` (bytes) `KB` (kilobytes) `MB` (megabytes) `GB` (gigabytes) `TB` (terabytes) Unqualified values are treated as bytes. The value of the LogMaxFileSize parameter must be less than or equal to the value of the LogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of `unlimited`, no size limit is imposed on the EdgeSyncLLog directory.
LogMaxFileSize	Optional	Microsoft.Exchange.Data.Unlimited	The LogMaxFileSize parameter specifies the maximum log file size for the EdgeSyncLog files. The default value is 10 MB. When you enter a value, qualify the value with one of the following units: `B` (bytes) `KB` (kilobytes) `MB` (megabytes) `GB` (gigabytes) `TB` (terabytes) Unqualified values are treated as bytes. The value of the LogMaxFileSize parameter must be less than or equal to the value of the LogMaxDirectorySize parameter. The valid input range for either parameter is from 1 through 9223372036854775807 bytes. If you enter a value of `unlimited`, no size limit is imposed on the EdgeSyncLog files.
LogPath	Optional	System.String	The LogPath parameter specifies the default location for the EdgeSyncLog files. The default value is `TransportRoles\Logs\EdgeSync\`.
OptionDuration	Optional	Microsoft.Exchange.Data.EnhancedTimeSpan	The OptionDuration parameter specifies how long an instance of the EdgeSync service can maintain an optional lock on synchronization rights. While an EdgeSync service maintains an optional lock on synchronization rights, another EdgeSync service can take over synchronization after the optional lock has expired if it's initiated using the Start-EdgeSynchronization command. The default value is 30 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.
RecipientSyncInterval	Optional	Microsoft.Exchange.Data.EnhancedTimeSpan	The RecipientSyncInterval parameter specifies how frequently the EdgeSync service synchronizes recipient data from the global catalog. The default value is 5 minutes. To specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.
Site	Optional	Microsoft.Exchange.Configuration.Tasks.AdSiteIdParameter	The Site parameter specifies the Active Directory site that EdgeSync connects to for synchronizing configuration and recipient data.
WhatIf	Optional	System.Management.Automation.SwitchParameter	The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

Input Types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

Return Types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.