ldap_list_replicas

Lists all the replicas on the specified directory server.

LDAP Version:v3

Library:*ldapx.*

NDS Version:8.5

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>
  
  int ldap_list_replicas (
     LDAP     *ld, 
     char     *serverDN, 
     char   ***replicaList);

Parameters

ld: (IN) Points to the handle for the LDAP session.
serverDN: (IN) Points to the distinguished name, in LDAP format, of the server whose replicas are being listed.
replicaList: (OUT) Points to a list of replicas.

Return Values

0x00	LDAP_SUCCESS
0x01	LDAP_OPERATIONS_ERROR: A string is returned with this error code that indicates the source of the error.
0x53	LDAP_ENCODING_ERROR
0x5A	LDAP_NO_MEMORY
0x5C	LDAP_NOT_SUPPORTED
Non-zero	Non-zero values indicate errors. See LDAP Return Codes.

Remarks

The function allocates the memory for replicaList, but the caller is responsible for freeing the memory with the ldapx_memfree function.

This function returns all replicas including subordinate references. The replicaList agrument points to a null terminated array of strings. Each string in the array contains the distinguished name of a replica's partition root.

For sample code, see listrepl.c.

Packet Format

The requestName is set to the OID (2.16.840.1.113719.1.27.100.19) and the requestValue is a BER encoding of the following:

  RequestBer
      serverDN    LDAPDN

The responseName is set to the OID (2.16.840.1.113719.1.27.100.20) and the responseValue is a BER encoding of the following: