Control replication extended operation

Edit online

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

Description
This extended operation is used to control the following aspects of currently running replications:
  • Suspend replication
  • Resume replication
  • Cause changes to be replicated immediately
Request
OID
1.3.18.0.2.12.16
Syntax
requestValue ::= SEQUENCE {
action ActionValue,
scope ScopeValue
entryDN DistinguishedName
}
ActionValue ::= INTEGER {
suspend (0),
resume (1),
replicateNow (2),
terminateFullReplication (3)
}
ScopeValue ::= INTEGER {
singleAgreement (0),
allAgreements (1)
}
Response
OID
1.3.18.0.2.12.16
Syntax
Response Value ::= SEQUENCE {
#fields of interest from LDAPResult:
resultCode INTEGER (0..MAX),
errorMessage LDAPString,
consumer LDAPString
}
The following return codes are possible:
  • LDAP_SUCCESS
  • LDAP_NO_SUCH_OBJECT
  • LDAP_UNWILLING_TO_PERFORM
  • LDAP_OPERATIONS_ERROR
  • LDAP_INSUFFICIENT_ACCESS
  • LDAP_NO_MEMORY
Behavior
This extended operation is used to control the following aspects of currently running replications:
Suspend replication
Changes are not replicated for the replication agreement or for all replication agreements for the context until the resume replication or replicate immediately operation is used.
Resume replication
If the replication agreement is suspended, then replication resumes.
Cause changes to be replicated immediately
If the replication agreement is suspended or is waiting for scheduled replication to occur, any outstanding changes are replicated.
The following persons are enabled to call the extended operation:
  • Primary Directory Administrator
  • Local Administration Group members with DirDataAdmin and ReplicationAdmin roles
  • Global Administration Group members
  • Master Server DN
  • Authenticated Directory User
Note: If the extended operation is called by a user who does not have access, LDAP_INSUFFICIENT_ACCESS is returned.
This extended operation has the following possible return codes:
  • LDAP_SUCCESS
  • LDAP_PROTOCOL_ERROR
  • LDAP_DECODING_ERROR
  • LDAP_NO_MEMORY
  • LDAP_UNDEFINED_TYPE
  • LDAP_INVALID_DN_SYNTAX
This extended operation is not supported by the Administration Server.
Scope
This extended operation affects only the current operation.
Auditing
Action: [Suspend | Resume | ReplNow | Unknown]
Scope: [Single | All | Unknown]
DN: dn