LDAP_RESTORE

Edit online

Use the LDAP_RESTORE API or LDAP routine to create and call an LDAP extended operation that requests a directory server restore.

Synopsis

#include ldap.h

     int ldap_restore (LDAP *ld, , Backup_Restore_Result *op_result );

Input parameters

ld
Specifies the address of the LDAP connection.
op_result
Specifies the address of the result code from the administration server response.

Usage

The ldap_restore routine is a wrapper that is used for creating requests to restore a directory server. This extended operation is only supported by the administration server, ibmdiradm.

If LDAP_SUCCESS is returned for a restore request, this status indicates that the request was sent to the administration server. The administration server submits the restore request unless the directory server is running or another backup or restore command is already running. The op_result parameter indicates the status of the request that is based on the action that is taken by the administration server on the request. The result of directory restore operation does not reflect in the return code or in the op_result parameter.

Errors

The ldap_restore routine returns the following error code:
  • LDAP_SUCCESS // if the request is submitted
  • LDAP_NO_MEMORY // if allocation fails
  • LDAP_OPERATIONS_ERROR // if no backup is available
  • LDAP_INSUFFICIENT_ACCESS // DN used for bind does not have authority to send this request
  • LDAP_UNWILLING_TO_PERFORM // if backup configuration is not configured for the server
  • LDAP_PROTOCOL_ERROR // if request sent to the server is from other than administration server
  • LDAP_OTHER // unable to prepare request

See also

ldap_backup