ldap_trigger_back_process

Triggers a background process.

LDAP Version:v3

Library:*ldapx.*

NDS Version:8.5, SP1

Platform:NLM, Windows (NT, 95, 98, 2000, XP, Vista 32-bit and 64-bit ), Linux (32-bit and 64-bit), Solaris, AIX, and HP-UX

Syntax

  #include <ldapx.h>
  
  LIBLDAP_F(int) ldap_trigger_back_process (
     LDAP   *ld, 
     int    processID);

Parameters

ld: (IN) Points to the handle for the LDAP session.
processID: (IN) Flag determining the background process to trigger. This flag will be one of the following: LDAP_BK_PROCESS_BKLINKER 1 LDAP_BK_PROCESS_JANITOR 2 LDAP_BK_PROCESS_LIMBER 3 LDAP_BK_PROCESS_SKULKER 4 LDAP_BK_PROCESS_SCHEMA_SYNC 5 LDAP_BK_PROCESS_PART_PURGE 6

Return Values

0x00	LDAP_SUCCESS
0x53	LDAP_ENCODING_ERROR
0x59	LDAP_PARAM_ERROR
0x5A	LDAP_NO_MEMORY
0x5C	LDAP_NOT_SUPPORTED
Non-zero	Non-zero values indicate errors. See LDAP Return Codes.

Remarks

eDirectory background processes run automatically at periodic intervals to keep different replicas in an eDirectory tree synchronized. On rare occasions, it may be desirable to initiate one or more of these processes manually rather than waiting for the next scheduled execution.

Back Linker (Reference Checker). Keeps the "backlink" attribute of objects synchronized between servers. This attribute keeps track of external references to the object and also maintains DRLs (Dynamic Reference Links, "Used By" attribute).

Janitor. Cleans up bindery information, refreshes server status, and updates inherited ACLs.

Limber. Maintains tree connectivity, making sure tree names are consistent among servers. Also caches information from the NCPServer object and index information. After creating a new index, an application may want to kick off the limber process to cause it to start creating the index immediately.

Skulker. Replicates and synchronizes directory data among replicas. A developer may want to initiate this process to start data synchronization immediately.

Schema Sync. Replicates and synchronizes the schema.

Partition Purge. Purges deleted entries and deleted values that have been synchronized with all replicas.