Command line tasks for managing replication

This topic contains information about the use of the tools that are at your disposal to check the current advanced replication status for each of your configured replication agreements. These procedures can be used to recover from out of sync conditions between servers participating in advanced replication.

Advanced replication related extended operations

A set of extended operations is provided to allow administrators the opportunity to manage all aspects of advanced replication. Specifically, the extended operations allow an administrator to do the following:
  • Propagate any replication topology entries to all consumers
  • Manage the replication queue, especially in the context of replication scheduling
  • Manage any replication-related errors
  • Manage the quiesce state of the replication context
  • Suspend or resume replication processing

The extended operations also allow for an administrator to manage a specific server and then have the server cascade the management operation to any of its consumers. These extended operations require the user to bind as an LDAP root administrator or an administrator with the appropriate authority. See Administrative roles and extended operations for more information about administrative role authority to run these extended operations. The ldapexop utility is provided to invoke the advanced replication extended operations. This utility provides a command-line interface to all the advanced replication extended operations. See ldapexop utility for more information.

Table 1 summarizes the extended operations with their ldapexop operation value.
Note: The term, cascade, is used to describe the process of a supplier server issuing an extended operation it processed to one or all of its consumers.
Table 1. Description of advanced replication extended operations on the ldapexop utility
ldapexop operation ldapexop description Overview
cascrepl Cascading control replication extended operation This extended operation can quiesce, unquiesce, or force immediate replication of all pending changes (even if scheduling is dictated another way). When the extended operation is performed on the supplier that this extended operation was issued against, it proceeds to cascade the extended operation to one or all of its consumers.

If forcing immediate replication of all pending changes, two variants of the extended operation can be issued. If the replication of all pending changes must complete before the cascade step, an administrator can use the wait option. If there are no dependencies on the completion of the replication operations before cascading, the replnow option can be used. See Cascading control replication for more information about the Cascading control replication extended operation.

controlqueue Control replication queue extended operation This extended operation can skip one or all pending changes in the advanced replication queue. See Control replication queue for more information about the Control replication queue extended operation.
controlrepl Control replication extended operation This extended operation suspends or resumes all advanced replication-related activity.

Also, given any replication schedule objects that might exist, resuming replication does not necessarily cause the immediate replication of any pending changes. Instead, in addition to resume, this extended operation can be used to begin the immediate replication of any pending changes, even if replication schedule objects have deferred replication. See Control replication for more information about the Control replication extended operation.

controlreplerr Control replication error log extended operation This extended operation can delete, retry, or show, any replication operations that resulted in an unsuccessful return code returned to the supplier from the consumer.

The show options returns an LDIF representation of the unsuccessful replication operation. See Control replication error log for more information about the Control replication error log extended operation.

quiesce Quiesce or unquiesce context extended operation This extended operation can quiesce or unquiesce a replication context.

A quiesced replication context typically cannot accept any LDAP update operations. To perform LDAP update operations on a quiesced context, the update operations must be done by an LDAP administrator with the appropriate authority and using the Server Administration control. See Administrative group and roles for more information about administrative role authority. See Quiesce or unquiesce context for more information about the Quiesce or unquiesce context extended operation.

repltopology Replication topology extended operation This extended operation propagates advanced replication topology-related entries to all consumers. It then cascades this extended operation to all the consumers. This results in a cascading of the topology-related entries to all servers that participate in replication for a given replication context. See Replication topology for more information about the Replication topology extended operation.

Viewing replication configuration information

A great deal of information related to replication activity is available using searches. To see the replication topology information related to a particular replicated subtree, you can do a subtree search with the base set to the DN of the subtree and the filter set as (objectclass=ibm-repl*) to find the subentry that is the base of the topology information.
ldapsearch -p port -D adminDN -w adminPW -b baseDn objectclass=ibm-repl*
The objects returned includes the replica group itself, plus the following:
  • Entries with an objectclass of ibm-replicaSubentry for each server that replicates data within this replication context. These entries are replica subentries that contain a server ID attribute and the role that servers plays in the replication topology. See Replica subentries for more information about replica subentries.
  • For each replica subentry, there is a replication agreement entry for each consumer server that receives replication updates from the server described by the replica subentry. See Replication agreements for more information about replication agreement entries.