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 Pipe Plugin defines a plugin for a Sync Pipe that performs processing on synchronization operations as they are synchronized from the source to the destination.
↓Direct Subcomponents
↓Relations From this Component
↓Properties
↓dsconfig Usage
The following Sync Pipe Plugins are available in the server :
These Sync Pipe Plugins inherit from the properties described below.
The following components have a direct aggregation relation to Sync Pipe Plugins:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ java-class | None |
| ↓ description |
| Description | Specifies the fully-qualified name of the Java class that provides the Synchronization Server extension implementation. |
| Default Value | None |
| Allowed Values | The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sync.api.SyncPipePlugin |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | A description for this Sync Pipe Plugin |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Sync Pipe Plugins:
dsconfig list-sync-pipe-plugins
[--property {propertyName}] ...
To view the configuration for an existing Sync Pipe Plugin:
dsconfig get-sync-pipe-plugin-prop
--plugin-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Sync Pipe Plugin:
dsconfig set-sync-pipe-plugin-prop
--plugin-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To delete an existing Sync Pipe Plugin:
dsconfig delete-sync-pipe-plugin
--plugin-name {name}