Synchronization Server Documentation Index
Configuration Reference Home

Global Sync Configuration

Global Sync Configuration contains the properties that affect the overall operation of Sync with Synchronization Server.

Properties
dsconfig Usage

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ started  None
↓ changelog-password-decryption-key
↓ sync-failover-polling-interval

Basic Properties

started

Description
Indicates whether the Sync is running. When set to false, all synchronization is stopped globally. When set to true, all synchronization is started for all Sync Pipes that are enabled.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

changelog-password-decryption-key

Description
This property is used to decrypt user password values (if present) from changelog entries. This enables the Synchronization Server to synchronize passwords to other types of endpoints which do not use the same password storage scheme as the UnboundID Directory Server. Passwords are initially encrypted using the encryption password specified on the Changelog Backend of the server receiving the change. There can be multiple values for this property, because you may opt to use different encryption keys on different directory server environments. The Synchronization Server can match encrypted passwords with the keys that were used to encrypt them, so it is safe to specify several different values here.
Default Value
None
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

sync-failover-polling-interval

Description
The amount of time (in milliseconds) this server will wait between polls of the other servers in the Synchronization Server topology. A lower value will make for a quicker failover in the event of a failure, but it will also cause more frequent traffic among the Synchronization Servers.
Default Value
5000
Allowed Values
An integer value. Lower limit is 1.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To view the Global Sync Configuration configuration:

dsconfig get-global-sync-configuration-prop
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the Global Sync Configuration configuration:

dsconfig set-global-sync-configuration-prop
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...