ServerBackupRestore extended operation

Edit online

The ServerBackupRestore extended operation explains its use with the server and provides the results.

Description
The ServerBackupRestore extended operation issues request to the administration server to back up a directory server data and configuration files or restore a directory server data and configuration files from an existing backup.
Request
OID
1.3.18.0.2.12.81
Syntax
requestValue ::= SEQUENCE {
        action	ActionValue	
}

ActionValue ::= ENUMERATED {
       backup    (1),
       restore   (2)
}
Response
OID
1.3.18.0.2.12.81
Syntax
responseValue ::= SEQUENCE {
       result	OperationResult	
}

OperationResult ::= ENUMERATED {
       No_Operation_Attempted (1),
       Backup_Submitted (2),
       Failed_Backup_Requires_Server_Stop (3),
       Failed_Backup_In_Progress (4),
       Unknown_Backup_Result (5),
       Restore_Submitted (6),
       Failed_Restore_Requires_Server_Stop (7),
       Failed_Restore_In_Progress (8),
       Failed_Restore_No_Backup_Exists (9),
       Unknown_Restore_Result (10),
       Failed_Backup_Requires_Onetime_Server_Stop (11)
}
Behavior
This extended operation requests the administration server to do the following actions:
  • Back up a directory server data and configuration files
  • Restore a directory server data and configuration files from an existing backup that depends on the action value
This extended operation can be disabled by setting the ibm-slapdBackupEnabled attribute in the server configuration file to FALSE.
This extended operation has the following possible return codes:
  • LDAP_SUCCESS - If the request is submitted successfully.
  • LDAP_INSUFFICIENT_ACCESS - If the bind DN does not have the required permission to send request.
  • LDAP_PROTOCOL_ERROR - If not an administration server, a directory server with RDBM, not configured for backup and restore, or backup and restore not enabled.
  • LDAP_OPERATIONS_ERROR - If the action value is unsupported or missing.
The backup and restore operations can be only run by the following users:
  • Primary directory administrator
  • Local administration group member that has DirDataAdmin, ServerStartStopAdmin, ServerConfigGroupMember, and SchemaAdmin roles

This extended operation is only supported by the Administration Server.

Scope
At a time only one operation can be run. If a backup or restore operation is running, other backup or restore requests results in error unless the earlier operation is completed. If a bulkload operation is running, then backup or restore operation does not proceed.
Auditing
Action: [backup|restore]
Response: [ 1 - No Operation Attempted |
            2 - Backup_Submitted |
            3 - Failed_Backup_Requires_Server_Stop |
            4 - Failed_Backup_In_Progress |
            5 - Unknown_Backup_Result | 
            6 - Restore_Submitted |
            7 - Failed_Restore_Requires_Server_Stop |
            8 - Failed_Restore_In_Progress |
            9 - Failed_Restore_No_Backup_Exists |
           10 - Unknown_Restore_Result |
           11 - Failed_Backup_Requires_Onetime_Server_Stop
         ]