Synchronization Server Documentation Index
Configuration Reference Home

Sync Destination Plugin

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.

A Sync Destination Plugin defines a plugin for a Sync Destination that performs processing on synchronization operations as they are synchronized from the destination to the destination.

↓Direct Subcomponents
↓Properties
↓dsconfig Usage

Direct Subcomponents

The following Sync Destination Plugins are available in the server :

These Sync Destination Plugins inherit from the properties described below.

Properties

The properties supported by this managed object are as follows:


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

Basic Properties

java-class (Read-Only)

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

description

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


dsconfig Usage

To list the configured Sync Destination Plugins:

dsconfig list-sync-destination-plugins
     [--property {propertyName}] ...

To view the configuration for an existing Sync Destination Plugin:

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

To update the configuration for an existing Sync Destination Plugin:

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

To delete an existing Sync Destination Plugin:

dsconfig delete-sync-destination-plugin
     --plugin-name {name}