A Sync Pipe defines how data is synchronized from a Sync Source to a Sync Destination.
↓Relations To this Component
↓Properties
↓dsconfig Usage
The following components have a direct composition relation from Sync Pipes:
The following components have a direct aggregation relation from Sync Pipes:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | ↓ max-operation-attempts |
| ↓ started | ↓ retry-backoff-initial-wait |
| ↓ sync-source | ↓ retry-backoff-max-wait |
| ↓ sync-destination | ↓ retry-backoff-increase-by |
| ↓ change-detection-polling-interval | ↓ retry-backoff-percentage-increase |
| ↓ num-worker-threads | ↓ max-failed-op-background-retries |
| ↓ failed-op-background-retry-delay | |
| ↓ plugin |
| Description | A description for this Sync Pipe |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the synchronization for the Sync Pipe is started. If a Sync Pipe is not started, then synchronization does not occur from the Sync Source to the Sync Destination. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the source of the synchronization changes. |
| Default Value | None |
| Allowed Values | The DN of any Sync Source. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the destination of the synchronization changes. |
| Default Value | None |
| Allowed Values | The DN of any Sync Destination. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
change-detection-polling-interval
| Description | The amount of time to wait between polls of the Sync Source for changes. Using a larger value will increase the synchronization latency. Using a smaller value may slightly increase the load on the source server. |
| Default Value | 500 ms |
| Allowed Values | A duration. Lower limit is 0 milliseconds. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the number of worker threads that should be used to process synchronization operations. This value controls how many threads concurrently synchronize changes from the Sync Source to the Sync Destination. Using a large value can increase throughput, but it also increases the resources allocated at the Sync Source and Sync Destination. For example, using 20 worker threads will open up to 20 concurrent LDAP connections to both the Sync Source Server and the Sync Destination Server. When synchronizing with a relational database, the number of JDBC connections is configurable, but care should be taken that the number of worker threads does not exceed the number of available connections; otherwise thread starvation may occur. If there is a large network delay to the Sync Source or Sync Destination, then using a larger value can improve throughput. |
| Default Value | 20 |
| Allowed Values | An integer value. Lower limit is 1. Upper limit is 1000 . |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
max-operation-attempts (Advanced Property)
| Description | The maximum number of times a worker thread should attempt to process a synchronization operation before putting it in the background retry queue or failing the operation altogether. A sync operation that fails may or may not trigger a failover to a different source or destination server (depending on the failover settings) before retrying, but the maximum tries across all servers will not exceed this value. The exception to this rule is if the failure is due to a connection error. Connection errors trigger an immediate failover and do not count against the total number of tries for the sync operation; they get unlimited retries. For a directory server, the following LDAP result codes are considered a connection error:
|
| Default Value | 5 |
| Allowed Values | An integer value. Lower limit is 1. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
retry-backoff-initial-wait (Advanced Property)
| Description | The initial amount of time to wait before retrying an operation for the first time. Whenever an operation fails, such as connecting to a server or searching for an entry, the operation is retried with a (possibly) increasing amount of backoff. This attribute defines the duration to wait before retrying the operation for the first time. This attribute works in conjunction with retry-backoff-max-wait, retry-backoff-increase-by, and retry-backoff-percentage-increase. |
| Default Value | 100 ms |
| Allowed Values | A duration. Lower limit is 0 milliseconds. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
retry-backoff-max-wait (Advanced Property)
| Description | The maximum amount of time to wait between operation retry attempts. Whenever an operation fails, such as connecting to a server or searching for an entry, the operation is retried with a (possibly) increasing amount of backoff. This attribute defines the maximum duration to wait between consecutive retry attempts. This attribute works in conjunction with retry-backoff-initial-wait, retry-backoff-increase-by, and retry-backoff-percentage-increase. |
| Default Value | 10 s |
| Allowed Values | A duration. Lower limit is 0 milliseconds. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
retry-backoff-increase-by (Advanced Property)
| Description | This specifies the amount of time to increase the backoff by between consecutive retry attempts. Whenever an operation fails, such as connecting to a server or searching for an entry, the operation is retried with a (possibly) increasing amount of backoff. This attribute defines the amount of time to increase the backoff by between retry attempts. This attribute works in conjunction with retry-backoff-initial-wait, retry-backoff-max-wait, and retry-backoff-percentage-increase. |
| Default Value | 0 s |
| Allowed Values | A duration. Lower limit is 0 milliseconds. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
retry-backoff-percentage-increase (Advanced Property)
| Description | Between consecutive retry attempts, the percentage that the wait duration should be increased. Whenever an operation fails, such as connecting to a server or searching for an entry, the operation is retried with a (possibly) increasing amount of backoff. This attribute defines the percentage to increase the current backoff value by between retry attempts. For example, a value of 100 will double the backoff each time. This attribute works in conjunction with retry-backoff-initial-wait, retry-backoff-max-wait, and retry-backoff-increase-by. |
| Default Value | 100 |
| Allowed Values | An integer value. Lower limit is 0. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
max-failed-op-background-retries (Advanced Property)
| Description | The number of times a failed operation should be retried in the background, after a specified delay. This can be set to zero if there should be no delayed retries. Note that this applies after the max-operation-attempts have been exceeded. Whenever an operation fails, such as searching for or modifying an entry, the operation is retried according to the max-operation-attempts and retry-backoff-xxx properties. If the maximum attempts are reached and the operation has still not succeeded, it can be added to a delayed-retry queue which will retry the operation in the background after a specified delay. This attribute works in conjunction with the failed-op-background-retry-delay attribute. |
| Default Value | 0 |
| Allowed Values | An integer value. Lower limit is 0. Upper limit is 1000 . |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
failed-op-background-retry-delay (Advanced Property)
| Description | Specifies how long to wait between consecutive retries of an operation that is in the delayed-retry queue. Note that this applies after the max-operation-attempts have been exceeded. Whenever an operation fails, such as searching for or modifying an entry, the operation is retried according to the max-operation-attempts and retry-backoff-xxx properties. If the maximum attempts are reached and the operation has still not succeeded, it can be added to a delayed-retry queue which will retry the operation in the background after a delay (specified by this property). This attribute works in conjunction with the max-failed-op-background-retries attribute. |
| Default Value | 1 m |
| Allowed Values | A duration. Lower limit is 0 milliseconds. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies sync pipe plugins that should be applied to operations that are synchronized by this Sync Pipe. 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 Sync Pipe Plugin. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Sync Pipes:
dsconfig list-sync-pipes
[--property {propertyName}] ...
To view the configuration for an existing Sync Pipe:
dsconfig get-sync-pipe-prop
--pipe-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Sync Pipe:
dsconfig set-sync-pipe-prop
--pipe-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Sync Pipe:
dsconfig create-sync-pipe
--pipe-name {name}
--set sync-source:{propertyValue}
--set sync-destination:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Sync Pipe:
dsconfig delete-sync-pipe
--pipe-name {name}