This type of sync source can be used to detect real-time changes on any LDAP v3 server that supports persistent search.
To install this custom sync source, you need to create an external server that willstore the configuration information necessary to establish connectionsto the remote server to be used as a source. For example:
dsconfig create-external-server
--server-name example-ldap-server
--type ldap
--set server-host-name:hostname.source.example.com
--set bind-dn:cn=sync-user-at-source-ldap
--set initial-connections:1
--set max-connections:1
--set password:sync-password-at-source
Once an external server has been configured, you can create a sync source like so:
dsconfig create-sync-source
--source-name persistent-search-from-example-ldap-server
--type third-party
--set extension-class:com.pingidentity.sync.source.LDAPPersistentSearch
--set extension-argument:external-server=example-ldap-server
--set extension-argument:base-dn=ou=People,dc=example,dc=com
Allowed Arguments
| Argument Name: | external-server |
| Description: | The name of the external server to issue the persistent search request to. |
| Data Type: | String |
| Is Required: | true |
| Maximum Occurrences: | 1 |
| Argument Name: | base-dn |
| Description: | The base DN for the persistent search |
| Data Type: | LDAP Distinguished Name |
| Is Required: | true |
| Maximum Occurrences: | 1 |
| Argument Name: | filter |
| Description: | The LDAP filter to select which entries the persistent search will return. (Default: (objectClass*) ) |
| Data Type: | LDAP Search Filter |
| Is Required: | false |
| Maximum Occurrences: | 1 |
| Argument Name: | scope |
| Description: | The scope to use for the persistent search. (Default: sub) |
| Data Type: | LDAP Search Scope |
| Is Required: | false |
| Maximum Occurrences: | 1 |
| Argument Name: | change-type |
| Description: | One or more change types to listen for when issuing the persistent search request |
| Data Type: | String |
| Is Required: | false |
| Maximum Occurrences: | 2147483647 |
| Argument Name: | remove-attribute-value |
| Description: | Remove attribute when its value matches the provided regex. Format is attributeName:=:valueRegex |
| Data Type: | String |
| Is Required: | false |
| Maximum Occurrences: | 2147483647 |
| Argument Name: | remove-attribute |
| Description: | Remove attribute when its name matches the provided regex. Format is attributeNameRegex |
| Data Type: | String |
| Is Required: | false |
| Maximum Occurrences: | 2147483647 |
| Argument Name: | response-tineout-ms |
| Description: | Set the response timeout in millisecond (Default: 0) |
| Data Type: | Integer |
| Is Required: | false |
| Maximum Occurrences: | 1 |