Synchronization Server Documentation Index
Configuration Reference Home

Scripted Sync Source

Note: this is an abstract component that cannot be instantiated.

Scripted Sync Source provide sync source implementations defined in a dynamically-loaded script which implements the ScriptedSyncSource class defined in the UnboundID server SDK.

↓Direct Subcomponents
↓Parent Component
↓Properties
↓dsconfig Usage

Direct Subcomponents

The following Scripted Sync Sources are available in the server :

These Scripted Sync Sources inherit from the properties described below.

Parent Component

The Scripted Sync Source component inherits from the Sync Source

Properties

The properties supported by this managed object are as follows:


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

Basic Properties

java-class (Read-Only)

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

description

Description
A description for this Sync Source
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 Sync Source. 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


dsconfig Usage

To list the configured Sync Sources:

dsconfig list-sync-sources
     [--property {propertyName}] ...

To view the configuration for an existing Sync Source:

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

To update the configuration for an existing Sync Source:

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

To delete an existing Sync Source:

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