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 support in order to understand the potential impact of that change.
Groovy Scripted Sync Pipe Plugin provide sync pipe plugin implementations defined in a dynamically-loaded Groovy script which implements the ScriptedSyncPipePlugin class defined in the UnboundID server SDK.
The Groovy Scripted Sync Pipe Plugin component inherits from the Scripted Sync Pipe Plugin
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| description | None |
| script-argument | |
| script-class |
| 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 set of arguments used to customize the behavior for the Scripted Sync Pipe Plugin. Each configuration property should be given in the form 'name=value'. |
| Default Value | None |
| Allowed Values | An argument in the form 'name=value'. Argument names are allowed to contain only ASCII alphabetic characters, numeric digits, dashes, and underscores. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The fully-qualified name of the Groovy class providing the logic for the Groovy Scripted Sync Pipe Plugin. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| 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 Groovy Scripted Sync Pipe Plugin:
dsconfig create-sync-pipe-plugin
--plugin-name {name}
--type groovy
--set script-class:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Sync Pipe Plugin:
dsconfig delete-sync-pipe-plugin
--plugin-name {name}