SLAPO-RETCODE(5)              File Formats Manual             SLAPO-RETCODE(5)

<?><?><?> (NAME)
       slapo-retcode - <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?> <?><?><?><?> slapd

<?><?><?><?><?> <?><?><?><?><?> (SYNOPSIS)
       /etc/openldap/slapd.conf

<?><?><?><?><?><?><?> (DESCRIPTION)
       <?><?><?><?> retcode <?><?><?><?> slapd(8) <?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?><?> <?>/<?><?>
       <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?>
       <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?><?> (referrals)<?> <?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?><?> <?><?><?> <?><?> <?><?> <?> <?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?> <?><?><?>.

       <?><?><?><?><?><?><?><?> <?><?><?> <?><?> <?><?><?><?>
       <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?>.

       <?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?>
       <?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?><?><?>
       <?><?><?><?> <?><?> <?><?><?> <?><?><?><?> <?><?><?><?><?><?><?>
       <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?> DN
       <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?> <?> <?><?> <?><?><?>
       <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?>: <?><?> <?><?> <?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?>
       <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?>
       <?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?> DN
       <?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?> <?>
       <?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?> <<referral>> <?><?><?><?>
       (<?><?><?><?><?><?> <?><?>) <?><?><?><?><?>(<?><?>).

       <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?><?><?> <?><?>
       <?><?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?> retcode.conf
       <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?>
       <?><?> <?><?> <?><?> <?><?> <?><?><?><?><?><?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?><?> (include) <?><?><?>.

       <?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?>
       errAbsObject<?> <?><?><?><?><?> errObject <?><?> errAuxObject<?>
       <?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
       <?><?> <?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?><?> <?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?><?>.

       <?><?><?><?> <?><?><?> <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?>
       <?><?> <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?> <?><?> <?><?><?><?> <?><?><?> <?><?><?> <?><?><?><?>
       <?><?><?><?><?> <?><?> errAbsObject <?><?><?><?><?><?><?>
       <?><?><?><?><?><?> <?><?> <?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?>
       <?><?> <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?><?><?> <?><?><?><?><?><?>.

       <?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?><?><?><?> <?><?>
       <?><?><?><?><?> manageDSAit (RFC 3296) <?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?> <?><?><?>
       <?><?><?><?> (<?><?> <?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?> <?><?> <?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?>
       <?><?><?><?> <?><?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?> <?><?>
       <?><?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?> <?><?><?><?>)
       <?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?><?>.

       <?><?><?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
       <?><?><?><?> <?><?><?><?> retcode <?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?> retcode- <?><?><?><?><?> <?><?> <?><?>
       <?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?><?><?><?><?><?><?>
       <?><?><?> <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?>
       <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?> <?><?>
       <?><?><?><?><?><?><?><?> (stacked) <?><?><?><?><?><?><?> <?><?><?>.
       <?><?><?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?> <?><?><?>
       <?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>
       <?><?><?><?> retcode <?><?><?><?><?><?><?> <?><?><?><?>:

       retcode-parent <DN>
              <?><?><?> <?><?><?><?><?><?><?><?><?><?> DN <?><?><?><?> <?><?>
              <?><?><?><?> <?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?>
              <?><?> <?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>. <?><?><?>
              <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?>
              <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?><?> <?><?><?><?><?><?>.

       retcode-item <RDN> <errCode> [op=<oplist>] [text=<message>]
              [ref=<referral>] [sleeptime=<sec>] [matched=<DN>]
              [unsolicited=<OID>[:<data>]] [flags=[pre|post-]disconnect[,...]]
              <?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?>
              retcode-parent <?><?><?><?> <?><?><?><?>.  <?><?><?><?><?>
              errCode <?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?> <?><?>
              <?><?><?><?> strtol(3) <?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?> <?><?><?><?>.  <?><?><?><?><?><?><?>
              <?><?><?><?><?><?><?> oplist <?><?><?><?><?><?> <?><?>
              <?><?><?><?><?><?> <?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?>
              <?><?> <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?> <?><?><?><?>
              <?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?>
              <?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>.
              <?><?><?><?> matched <?><?><?><?> DN
              <?><?><?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?> <?><?>
              <?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?><?><?><?><?><?>
              <?><?><?><?><?><?><?> <?><?> <?><?><?><?> <?><?> <?><?><?><?>
              text <?><?> <?><?><?><?> <?><?><?><?><?><?>
              <?><?><?><?><?><?><?> <?><?><?>.  <?><?><?><?> ref <?><?><?><?>
              <?><?><?><?> <?><?> <?><?><?><?> referral <?><?><?><?>
              <?><?><?>.  <?><?><?><?> sleeptime <?><?><?><?>
              <?><?><?><?><?><?> slapd(8) <?><?><?> <?><?> <?><?><?><?><?>
              <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?>
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?>
              <?><?><?><?> <?><?><?><?> <?><?><?><?> (<?><?><?> <?><?><?>).
              <?><?><?><?> unsolicited <?><?><?><?><?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?><?> RFC 4511
              <?><?><?><?><?><?><?> <?><?><?><?> <?><?><?> OID <?><?><?><?><?>
              <?><?> <<0>> <?><?><?><?><?><?> <?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?> data
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>.
              <?><?><?> flags <?><?><?><?> disconnect <?><?> pre-disconnect
              <?><?><?><?><?> slapd(8) <?><?> <?><?><?><?>
              <?><?><?><?><?><?><?> <?> <?><?><?><?> <?><?><?><?><?>
              <?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?>
              <?><?><?><?><?><?><?> <?><?><?><?><?> post-disconnect
              <?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?>
              <?><?> <?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?>
              <?><?><?><?><?><?>.

       retcode-indir
              <?><?><?><?><?><?><?><?><?><?><?> <?><?> errAbsObject
              <?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?><?>
              <?><?> <?><?><?><?> <?><?><?><?><?><?>. <?><?><?><?> <?><?><?>
              <?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?><?><?>
              <?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?>
              <?><?><?>.

       retcode-sleep [-]<n>
              <?><?><?> <?><?><?><?> <?><?><?><?> <?><?> <?><?><?>
              <?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?><?> <?><?>
              <?><?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?><?> <?><?>
              <?><?> <?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?>.
              <?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?>
              <?><?><?><?><?><?> <?><?><?> <?> <?> <?><?><?><?><?> <?><?><?>
              <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
              <?><?><?><?><?><?>.


<?><?><?><?><?><?><?><?> (SCHEMA)
       <?><?><?><?> retcode <?><?> <?><?><?><?><?><?><?><?> <<<?><?>
       <?><?><?><?><?><?><?>>> <?><?> <?><?> <?><?><?><?><?> <?><?><?>
       <?><?><?><?> <?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?>.
       <?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?>
       <?><?><?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?>
       <?><?><?><?><?> <?><?><?> <?> <?><?><?><?> <?><?><?><?><?><?><?><?><?>
       <?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?>.
       <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?>
       <?><?><?><?><?><?><?><?> <?><?><?> <?><?><?><?> <?><?><?> <?><?>
       <?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?> <?><?><?> <?>
       <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?> <?><?><?><?>
       <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?>.
       <?><?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?><?>.

       <?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?> <?><?><?> <?> <?><?><?><?><?> <?><?><?><?><?><?><?><?><?>
       <?><?><?><?><?> <?><?><?> <?><?> <?><?> <?><?><?> <?><?><?>
       <?><?><?><?> <?><?><?><?><?><?><?>:


       <?><?> <?><?><?>:
           (  1.3.6.1.4.1.4203.666.11.4.1.1
               NAME ( 'errCode' )
               DESC 'LDAP error code'
               EQUALITY integerMatch
               ORDERING integerOrderingMatch
               SYNTAX 1.3.6.1.4.1.1466.115.121.1.27
               SINGLE-VALUE )

       <?><?><?><?><?><?><?> <?><?> <?><?><?><?> <?><?> <?><?><?><?>
       <?><?><?><?><?>:
           ( 1.3.6.1.4.1.4203.666.11.4.1.2
               NAME ( 'errOp' )
               DESC 'Operations the errObject applies to'
               EQUALITY caseIgnoreMatch
               SUBSTR caseIgnoreSubstringsMatch
               SYNTAX 1.3.6.1.4.1.1466.115.121.1.15 )

       <?><?><?><?> <?><?><?><?>:
           ( 1.3.6.1.4.1.4203.666.11.4.1.3
               NAME ( 'errText' )
               DESC 'LDAP error textual description'
               EQUALITY caseIgnoreMatch
               SUBSTR caseIgnoreSubstringsMatch
               SYNTAX 1.3.6.1.4.1.1466.115.121.1.15
               SINGLE-VALUE )

       <?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?> <?><?>
       <?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?> <?><?>
       <?><?><?><?><?><?>:
           ( 1.3.6.1.4.1.4203.666.11.4.1.4
               NAME ( 'errSleepTime' )
               DESC 'Time to wait before returning the error'
               EQUALITY integerMatch
               SYNTAX 1.3.6.1.4.1.1466.115.121.1.27
               SINGLE-VALUE )

       <?><?><?><?><?> DN <?><?><?><?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?>:
           ( 1.3.6.1.4.1.4203.666.11.4.1.5
               NAME ( 'errMatchedDN' )
               DESC 'Value to be returned as matched DN'
               EQUALITY distinguishedNameMatch
               SYNTAX 1.3.6.1.4.1.1466.115.121.1.12
               SINGLE-VALUE )

       <?><?><?><?><?> OID <?><?><?><?> <?><?><?><?><?><?><?><?><?><?> <?><?>
       <?><?><?><?><?> OID <?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?>
       <?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?> RFC 4511
       (<?><?><?><?><?> <<0>> <?><?> <?><?><?><?> <?><?><?><?> <?><?> msgid
       <?><?><?><?><?><?><?><?><?> <?><?><?> 0 <?><?><?><?><?>
       <?><?><?><?><?><?>):
           ( 1.3.6.1.4.1.4203.666.11.4.1.6
               NAME ( 'errUnsolicitedOID' )
               DESC 'OID to be returned within unsolicited response'
               EQUALITY objectIdentifierMatch
               SYNTAX 1.3.6.1.4.1.1466.115.121.1.38
               SINGLE-VALUE )

       <?><?><?><?> <?><?><?><?><?><?><?><?> (octet string) <?><?><?><?>
       <?><?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?>
       <?><?> <?><?><?><?> <?><?><?><?><?><?><?><?> RFC 4511:
           ( 1.3.6.1.4.1.4203.666.11.4.1.7
               NAME ( 'errUnsolicitedData' )
               DESC 'Data to be returned within unsolicited response'
               SYNTAX 1.3.6.1.4.1.1466.115.121.1.40
               SINGLE-VALUE )

       <?><?> <?><?><?><?> TRUE<?> slapd(8) <?><?><?><?> <?><?><?><?><?>
       <?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?>
       <?><?> <?><?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?><?> FALSE<?>
       <?><?> <?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?><?><?><?><?>:
           ( 1.3.6.1.4.1.4203.666.11.4.1.8
               NAME ( 'errDisconnect' )
               DESC 'Disconnect without notice'
               SYNTAX 1.3.6.1.4.1.1466.115.121.1.7
               SINGLE-VALUE )

       <?><?><?><?> <?><?><?><?><?><?><?> (abstract class) <?><?> <?><?><?><?>
       <?><?> <?><?><?><?> <?><?><?><?><?><?>:
           ( 1.3.6.1.4.1.4203.666.11.4.3.0
               NAME ( 'errAbsObject' )
               SUP top ABSTRACT
               MUST ( errCode )
               MAY ( cn $ description $ errOp $ errText $ errSleepTime
                   $ errMatchedDN ) )

       <?><?><?><?> <?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
       <?><?><?><?><?><?><?><?>:
           ( 1.3.6.1.4.1.4203.666.11.4.3.1
               NAME ( 'errObject' )
               SUP errAbsObject STRUCTURAL )

       <?><?><?><?> <?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?>:
           ( 1.3.6.1.4.1.4203.666.11.4.3.2
               NAME ( 'errAuxObject' )
               SUP errAbsObject AUXILIARY )


<?><?><?><?><?><?><?> (EXAMPLE)
              overlay         retcode
              retcode-parent  "ou=RetCodes,dc=example,dc=com"

              # <?><?><?><?> retcode.conf <?><?> tests/data/ <?><?> <?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?>
              include         ./retcode.conf

              # <?><?> <?><?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?><?><?> (0x00) <?><?> <?><?><?><?><?><?><?><?><?><?><?><?>
              retcode-item    "cn=Success after 10 seconds" 0x00 sleeptime=10
              # <?><?> <?><?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?><?> <?><?><?><?><?> timelimitExceeded (0x03) <?><?> <?><?><?><?><?><?><?><?><?><?><?><?>
              retcode-item    "cn=Timelimit after 10 seconds" 0x03 sleeptime=10

<?><?><?><?><?><?><?> (FILES)
       /etc/openldap/slapd.conf
              <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
              slapd

<?><?><?><?><?><?> <?><?><?><?><?><?> (SEE ALSO)
       slapd.conf(5), slapd-config(5), slapd(8).

       <?><?><?><?> slapo-retcode(5) <?><?> <?><?><?><?><?><?><?><?>
       <?><?><?><?> <?><?> <?><?><?><?> back-config <?><?><?><?><?><?><?><?>
       <?><?><?><?><?><?>.

<?><?><?><?><?><?><?> (ACKNOWLEDGEMENTS)
       <?><?><?> <?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?> <?><?><?><?>
       Pierangelo Masarati <?><?><?><?> SysNet s.n.c <?><?><?><?><?> <?><?><?>
       <?><?><?>.

OpenLDAP 2.6.13                   2026/03/09                  SLAPO-RETCODE(5)