Identity Data Store Documentation Index
Configuration Reference Home

Synchronization Provider

Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact UnboundID support in order to understand the potential impact of that change.

Note: this is an abstract component that cannot be instantiated.

Synchronization Providers are responsible for handling synchronization of the Identity Data Store data with other Identity Data Store instances or other data repositories.

The UnboundID Identity Data Store takes a centralized approach to replication, rather than the point-to-point approach taken by other types of servers. In the UnboundID Identity Data Store, one or more replication servers are created in the environment. The replication servers typically do not store user data but keep a log of all changes made within the topology. Each Identity Data Store instance in the topology is pointed at the replication servers. This plan simplifies the deployment and management of the environment. Although you can run the replication server on the same system (or even in the same instance) as the Identity Data Store, the two servers can be separated onto different systems. This approach can provide better performance or functionality in large environments.

Direct Subcomponents
Properties
dsconfig Usage

Direct Subcomponents

The following Synchronization Providers are available in the server :

These Synchronization Providers inherit from the properties described below.

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ java-class

Basic Properties

description

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

enabled

Description
Indicates whether the Synchronization Provider is enabled for use.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

java-class (Read-Only)

Description
Specifies the fully-qualified name of the Java class that provides the Synchronization Provider implementation.
Default Value
None
Allowed Values
The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.api.SynchronizationProvider
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Synchronization Providers:

dsconfig list-synchronization-providers
     [--property {propertyName}] ...

To view the configuration for an existing Synchronization Provider:

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

To update the configuration for an existing Synchronization Provider:

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