Synchronization Server Documentation Index
Configuration Reference Home

Groovy Scripted LDAP Sync Source 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.

Groovy Scripted LDAP Sync Source Plugin provide LDAP sync source plugin implementations defined in a dynamically-loaded Groovy script which implements the ScriptedLDAPSyncSourcePlugin class defined in the UnboundID server SDK.

↓Parent Component
↓Properties
↓dsconfig Usage

Parent Component

The Groovy Scripted LDAP Sync Source Plugin component inherits from the Scripted LDAP Sync Source Plugin

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ script-argument
↓ script-class

Basic Properties

description

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

script-argument

Description
The set of arguments used to customize the behavior for the Scripted LDAP Sync Source 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

script-class

Description
The fully-qualified name of the Groovy class providing the logic for the Groovy Scripted LDAP Sync Source Plugin.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Sync Source Plugins:

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

To view the configuration for an existing Sync Source Plugin:

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

To update the configuration for an existing Sync Source Plugin:

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

To create a new Groovy Scripted LDAP Sync Source Plugin:

dsconfig create-sync-source-plugin
     --plugin-name {name}
     --type groovy
     --set script-class:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Sync Source Plugin:

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