SLAPD-SHELL(5) SLAPD-SHELL(5)

NAME
       slapd-shell - Shell backend to slapd

SYNOPSIS
       /etc/openldap/slapd.conf

DESCRIPTION
       The  Shell  backend to ssllaappdd(8) executes external programs to implement
       operations, and is designed to make it easy to tie an existing database
       to the ssllaappdd front-end.

       This backend is is primarily intended to be used in prototypes.

WWAARRNNIINNGG
       The aabbaannddoonn shell command has been removed since OpenLDAP 2.1.

CCOONNFFIIGGUURRAATTIIOONN
       These ssllaappdd..ccoonnff options apply to the SHELL backend database.  That is,
       they must follow a "database shell" line and come before any subsequent
       "backend" or "database" lines.  Other database options are described in
       the ssllaappdd..ccoonnff(5) manual page.

       These options specify the pathname and arguments of the program to exe-
       cute  in response to the given LDAP operation.  Each option is followed
       by the input lines that the program receives:

       aadddd <> <>......
              ADD
              msgid: 
               }>
              

       bbiinndd <> <>......
              BIND
              msgid: 
               }>
              dn: 
              method: 
              credlen: >
              cred: 

       ccoommppaarree <> <>......
              COMPARE
              msgid: 
               }>
              dn: 
              : 

       ddeelleettee <> <>......
              DELETE
              msgid: 
               }>
              dn: 

       mmooddiiffyy <> <>......
              MODIFY
              msgid: 
               }>
              dn: 
              : 
                  :  }>
                  -
              }>

       mmooddrrddnn <> <>......
              MODRDN
              msgid: 
               }>
              dn: 
              newrdn: 
              deleteoldrdn: <0 or 1>
              ">

       sseeaarrcchh <> <>......
              SEARCH
              msgid: 
               }>
              base: 
              scope: <0-2, see ldap.h>
              deref: <0-3, see ldap.h>
              sizelimit: 
              timelimit: 
              filter: 
              attrsonly: <0 or 1>
              attrs: <"all" or space-separated attribute list>

       uunnbbiinndd <> <>......
              UNBIND
              msgid: 
               }>
              dn: 

       Note that you need only supply configuration lines for  those  commands
       you  want the backend to handle.  Operations for which a command is not
       supplied will be refused with an "unwilling to perform" error.

       The commands - except uunnbbiinndd - should output:
              RESULT
              code: 
              matched: 
              info: 
       where only RESULT is mandatory.  The sseeaarrcchh RESULT should  be  preceded
       by  the  entries  in  LDIF format, each entry followed by a blank line.
       Lines starting with `#' or `DEBUG:' are ignored.

EEXXAAMMPPLLEE
       There is an example search script in the slapd/back-shell/ directory in
       the OpenLDAP source tree.

LLIIMMIITTAATTIIOONNSS
       The  shell  backend does not support threaded environments.  When using
       the shell backend, ssllaappdd(8) should be built -without-threads.

FILES       /etc/openldap/slapd.conf
              default slapd configuration file

SEE ALSO
       ssllaappdd..ccoonnff(5), ssllaappdd(8), sshh(1).



OpenLDAP 2.2.19                   2004/11/26                    SLAPD-SHELL(5)