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.
Third Party Sync Pipe Plugin provide sync pipe plugin implementations created in third-party code using the UnboundID server SDK.
↓Parent Component
↓Properties
↓dsconfig Usage
The Third Party Sync Pipe Plugin component inherits from the Sync Pipe Plugin
The properties supported by this managed object are as follows:
Basic Properties: | Advanced Properties: |
---|---|
↓ description | None |
↓ extension-class | |
↓ extension-argument |
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 |
Description | The fully-qualified name of the Java class providing the logic for the Third Party Sync Pipe Plugin. |
Default Value | None |
Allowed Values | The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sdk.sync.api.SyncPipePlugin |
Multi-Valued | No |
Required | Yes |
Admin Action Required | None. Modification requires no further action |
Description | The set of arguments used to customize the behavior for the Third Party Sync Pipe Plugin. Each configuration property should be given in the form 'name=value'. |
Default Value | None |
Allowed Values | A string |
Multi-Valued | Yes |
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 create a new Third Party Sync Pipe Plugin:
dsconfig create-sync-pipe-plugin --plugin-name {name} --type third-party --set extension-class:{propertyValue} [--set {propertyName}:{propertyValue}] ...
To delete an existing Sync Pipe Plugin:
dsconfig delete-sync-pipe-plugin --plugin-name {name}