LDAP_BACKUP

Edit online

Use the LDAP_BACKUP API to request a server backup. This LDAP routine is used to create and call an LDAP extended operation for requesting a directory server backup.

Synopsis

#include ldap.h

    int ldap_backup ( 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_backup routine is a wrapper that is used for creating requests to back up a directory server. This extended operation is only supported by the administration server, ibmdiradm.

If LDAP_SUCCESS is returned for a backup request, the request is sent to the administration server. The administration server submits the backup request unless the directory server is running. It is not configured for online backups or another bulkload, 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 backup operation on a directory server does not reflect in the return code or in the op_result parameter.

Errors

The ldap_backup routine returns the following error code:
  • LDAP_SUCCESS // if the request is submitted
  • LDAP_NO_MEMORY // if allocation fails
  • 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 a 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_restore