Data Sync Server Documentation Index
Configuration Reference Home

Sun DS Sync Source

An Sun DS Sync Source defines the source of a Sync Pipe that is a topology of Sun/Oracle Directory Server Enterprise Edition instances.

Parent Component
Relations from This Component
Properties
dsconfig Usage

Parent Component

The Sun DS Sync Source component inherits from the Changelog Sync Source

Relations from This Component

The following components have a direct aggregation relation from Sun DS Sync Sources:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description ↓ response-timeout
↓ base-dn ↓ max-failover-error-code-frequency
↓ ignore-changes-by-dn ↓ plugin
↓ server ↓ sync-backlog-alert-threshold
↓ max-backtrack-replication-latency
↓ changelog-search-type

Basic Properties

description

Description
A description for this Sync Source
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

base-dn

Description
Specifies the base DNs of the servers referenced by this Sync Source. These base DNs are used as the base of LDAP searches when locating entries. These base DNs must not overlap.
Default Value
None
Allowed Values
A valid DN.
Multi-Valued
Yes
Required
Yes
Admin Action Required
None. Modification requires no further action

ignore-changes-by-dn

Description
Modifications performed by users with the specified DN will not be synchronized. This property is particularly useful when also using Ping Identity Data Sync Server to synchronize changes to this source. In this case, a unique user DN should be used by the Sync Pipe that applies changes to this source, and that user DN should be specified here to prevent those changes from being synchronized back to their original source. Note: the DN of the user performing a delete operations is not normally available in the changelog. So delete operations by these users will not be ignored.
Default Value
cn=Sync User,cn=Root DNs,cn=config
Allowed Values
A valid DN.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

server

Description
Specifies the names of the Sun/Oracle Directory Server Enterprise Edition instances that should be used as the source of synchronization. The order of values is important as it is used as a priority order for failover. When a location is defined on the Data Sync Server, it will always prefer to fail over to external servers in that same location or in one of the preferred failover locations for that location. If there are multiple external servers available in the target location, then the Data Sync Server will prefer the earliest one in this list and then work its way down. If there is no location defined on the Data Sync Server or if there are no external servers configured in the target location or any of the preferred failover locations, then the Data Sync Server will work its way down the list of servers in the order they are listed here.
Default Value
None
Allowed Values
The DN of any Sun DS External Server.
Multi-Valued
Yes
Required
Yes
Admin Action Required
None. Modification requires no further action


Advanced Properties

response-timeout (Advanced Property)

Description
Specifies the maximum length of time that an operation should be allowed to block while waiting for a response from the server. A value of zero indicates that there should be no client-side timeout; the server's default will be used. This property indicates how long the Data Sync Server should wait for a response from a search request to a source server before failing with LDAP result code 85 (client-side timeout). When this happens, the Sync Source will retry the request according to the max-failover-error-code-frequency property before failing over to a different source server and performing the retry there. The total number of retries will not exceed the max-operation-attempts value defined in the Sync Pipe configuration.
Default Value
1 m
Allowed Values
A duration. Lower limit is 0 milliseconds.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

max-failover-error-code-frequency (Advanced Property)

Description
This property controls the frequency of how often a given LDAP error code may be encountered on a connection before the Data Sync Server fails over to a different source server. This allows the retry logic to be tuned, so that retries can be performed once on the same server before giving up and trying another server. The value can be set to zero if there is no acceptable error code frequency and failover should happen immediately. It can also be set to a very small value (such as 10 ms) if a high frequency of error codes is tolerable. As an example, if the value is set to 3 minutes, this says that a TIMEOUT error code from the currently connected server will not trigger a failover unless there was another TIMEOUT from the same server within the last 3 minutes.

This property applies to all LDAP result codes except the following:

  • SUCCESS
  • BUSY
  • UNAVAILABLE
  • SERVER DOWN
  • CONNECT ERROR
The SUCCESS result code is never treated as an error, and the other four are "forced failover" error codes, meaning they will cause the Data Sync Server to fail over to a different source server immediately.
Default Value
3 m
Allowed Values
A duration. Lower limit is 0 milliseconds.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

plugin (Advanced Property)

Description
Specifies sync source plugins that should be applied to operations that are synchronized by this LDAP Sync Source. If multiple plugins are provided, then they will be invoked in the order they are specified.
Default Value
None
Allowed Values
The DN of any LDAP Sync Source Plugin.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

sync-backlog-alert-threshold (Advanced Property)

Description
This property specifies when the Data Sync Server should generate an administrative alert because of too many outstanding changes. If the Data Sync Server becomes severely backlogged, it may be desirable for it to generate an alert. The value of this property specifies the size (in number of unprocessed changes) at which an alert will be thrown.
Default Value
None
Allowed Values
An integer value. Lower limit is 0.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

max-backtrack-replication-latency (Advanced Property)

Description
This property should be set to a conservative upper-bound of the maximum replication delay between two servers in the topology. It is used only when the Data Sync Server fails over to a different server. It limits how far back in the changelog of the new the Data Sync Server will look to ensure that no changes have been missed. A value of zero implies that there is no limit on the replication latency. When failing over to use a different changelog, the Data Sync Server must look through several changes in the new changelog to find the equivalent place to begin synchronizing changes since LDAP allows changes to appear in a different order on the servers. Normally, this can be achieved with only a few queries of the directory, but in some situations, it might have to look further back through the changelog to make sure that it hasn't missed any changes. This backtracking can be capped by using this upper-bound on how long it takes changes to be replicated from one server to another in a topology. That is, the Data Sync Server can stop looking in the changelog once it finds a change that is more than the maximum replication latency (as specified by this property) older than the last change it processed on the server it failed from.

When the Data Sync Server fails over between source servers, it has to backtrack to figure out where synchronization can safely pick up at, accounting for the fact that replicated changes between directory servers can be interleaved in the change log. It will normally go back until either:

  • It determines that there is no previous change log state available for any source servers, so it must start at the beginning of the change log.
  • It finds the last processed replicationCSN from the last time it was connected to that replica (if it ever was). This will also be the case if you use the realtime-sync tool's "set-startpoint" functionality.
  • It finds the last processed replication CSN from every replica that has produced a change so far, AND it determines that each change entry in the next oldest batch of changes has already been processed.
  • It has encountered a change that is separated by more than a certain duration (specified by this property) from the most recently processed change.

Default Value
2 hours
Allowed Values
A duration. Lower limit is 0 milliseconds.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

changelog-search-type (Advanced Property)

Description
This property specifies how the Retro Change Log will be searched when the Data Sync Server is detecting changes.
Default Value
single-entry-searches
Allowed Values
range-searches - Indicates that this Sun DS Sync Source will perform subtree searches of the Retro Change Log, and retrieve changes in batches. Under heavy load this is sometimes more efficient.

single-entry-searches - Indicates that this Sun DS Sync Source will perform base level searches the Retro Change Log, and retrieve a single entry at a time. This works around a problem in certain environments where searches on the 'changenumber' attribute are reported as unindexed.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Sync Sources:

dsconfig list-sync-sources
     [--property {propertyName}] ...

To view the configuration for an existing Sync Source:

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

To update the configuration for an existing Sync Source:

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

To create a new Sun DS Sync Source:

dsconfig create-sync-source
     --source-name {name}
     --type {type}
     --set base-dn:{propertyValue}
     --set server:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Sync Source:

dsconfig delete-sync-source
     --source-name {name}