git.sur5r.net Git - openldap/blob - doc/man/man8/slurpd.8

   1 .TH SLURPD 8C "20 August 2000" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 slurpd \- Standalone LDAP Update Replication Daemon
   7 .SH SYNOPSIS
   8 .B LIBEXECDIR/slurpd [\-d debug\-level]
   9 .B [\-f slapd\-config\-file] [\-r slapd\-replog\-file]
  10 .B [\-t temp\-dir] [\-o] [\-k srvtab\-file]
  11 .B
  12 .SH DESCRIPTION
  13 .LP
  14 .B Slurpd
  15 is used to propagate changes from one slapd database to another.  If
  16 slapd is configured to produce a replication log,
  17 .B slurpd
  18 reads that
  19 replication log and sends the changes to the slave
  20 .B slapd
  21 instances
  22 via the LDAP protocol.
  23 .B slurpd
  24 is typically invoked at boot time, usually out of
  25 .BR  /etc/rc.local .
  26 .LP
  27 Upon startup,
  28 .B slurpd
  29 normally forks and disassociates itself from the invoking tty,
  30 then reads the replication log (given either by the
  31 .I replogfile
  32 directive in the
  33 .B slapd
  34 config file, or by the
  35 .RB \- r
  36 command-line option).
  37 If the replication log file does not exist or is empty,
  38 .B slurpd
  39 goes to sleep.  It periodically wakes up and checks to see if there
  40 are any changes to be propoagated.
  41 .LP
  42 When
  43 .B slurpd
  44 notices that there are changes to propagate to slave
  45 .B slapd
  46 instances, it locks the replication log, makes its own private copy,
  47 releases the lock, and forks one copy of itself for each replica
  48 .B slapd
  49 to be updated.  Each child process binds to the slave
  50 .B slapd
  51 as the
  52 DN given by the
  53 .I binddn
  54 option to the
  55 .I replica
  56 directive in the
  57 .B slapd
  58 config file, and sends the changes.
  59 .LP
  60 See
  61 .BR slapd (8)
  62 for details on the standalone LDAP daemon.
  63 .SH OPTIONS
  64 .TP
  65 .BI \-d " debug\-level"
  66 Turn on debugging as defined by
  67 .I debug\-level.
  68 If this option is specified, even with a zero argument,
  69 .B slurpd
  70 will not fork or disassociate from the invoking terminal.  Some general
  71 operation and status messages are printed for any value of \fIdebug\-level\fP.
  72 \fIdebug\-level\fP is taken as a bit string, with each bit corresponding to a
  73 different kind of debugging information.  See <ldap.h> for details.
  74 .TP
  75 .BI \-f " slapd\-config\-file"
  76 Specifies the slapd configuration file.  The default is
  77 .BR ETCDIR/slapd.conf .
  78 .TP
  79 .BI \-r " slapd\-replog\-file"
  80 Specifies the name of the
  81 .B slapd
  82 replication logfile.  Normally, the name
  83 of the replication log file is read from the
  84 .B slapd
  85 configuration file.  The file should be located in a directory
  86 with limited read/write/execute access.
  87 The
  88 .B \-r
  89 option allows you to override this.  In conjunction with the
  90 .B \-o
  91 option, you can process a replication log file in a "one\-shot" mode.  For
  92 example, if
  93 .B slurpd
  94 has encountered errors in processing a replication log,
  95 you can run it in one\-shot mode and give the rejection file name as
  96 the argument to the \-r option, once you've resolved the problem which caused
  97 the replication to fail.
  98 .TP
  99 .B \-o
 100 Run in "one\-shot" mode.  Normally,
 101 .B slurpd
 102 processes the replog file
 103 and then watches for more replication entries to be appended.  In
 104 one\-shot mode,
 105 .B slurpd
 106 processes a replication log and exits.
 107 .TP
 108 .BI \-t " temp\-dir"
 109 .B slurpd
 110 copies the replication log to a working directory before processing it.
 111 The directory permissions should limit read/write/execute access as
 112 temporary files may contain sensitive information.
 113 This option allows you to specify the location of these temporary files.
 114 The default is
 115 .BR LOCALSTATEDIR/openldap-slurp .
 116 .TP
 117 .BI \-k " srvtab\-file"
 118 Specify the location of the kerberos srvtab file which contains keys
 119 for the replica
 120 .I slapd
 121 instances.  Overrides the srvtab argument to the
 122 replica directive in the
 123 .I slapd
 124 configuration file.
 125 .SH EXAMPLES
 126 To start
 127 .I slurpd
 128 and have it fork and detach from the terminal and process
 129 the replication logs generated by
 130 .I slapd,
 131 just type:
 132 .LP
 133 .nf
 134 .ft tt
 135         LIBEXECDIR/slurpd
 136 .ft
 137 .fi
 138 .LP
 139 To start
 140 .I slurpd
 141 with an alternate
 142 .I slapd
 143 configuration file, and turn
 144 on voluminous debugging which will be printed on standard error, type:
 145 .LP
 146 .nf
 147 .ft tt
 148         LIBEXECDIR/slurpd -f ETCDIR/slapd.conf -d 255
 149 .ft
 150 .fi
 151 .LP
 152 .SH "SEE ALSO"
 153 .BR ldap (3),
 154 .BR slapd.replog (5),
 155 .BR slapd (8)
 156 .LP
 157 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 158 .SH ACKNOWLEDGEMENTS
 159 .B      OpenLDAP
 160 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 161 .B      OpenLDAP
 162 is derived from University of Michigan LDAP 3.3 Release.