.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::LDAP::Extra::eDirectory 3"
.TH Net::LDAP::Extra::eDirectory 3 2023-07-26 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Net::LDAP::Extra::eDirectory \-\- extensions for Novell eDirectory
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Net::LDAP::Extra qw(eDirectory);
\&
\&  $ldap = Net::LDAP\->new( ... );
\&
\&  ...
\&
\&  if ($ldap\->is_eDirectory)
\&    my $mesg $ldap\->list_replicas($server_dn);
\&
\&    print "Replicas on $server_dn\en* " . join("\en* ", $mesg\->replicas) . "\en"
\&      if (!$mesg\->code);
\&  }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Net::LDAP::Extra::eDirectory provides functions / LDAP extensions
specific to Novell eDirectory.
.PP
To do so, it provides the following methods:
.SH METHODS
.IX Header "METHODS"
.IP "is_eDirectory ( )" 4
.IX Item "is_eDirectory ( )"
Tell if the LDAP server queried is Novell eDirectory server.
.Sp
As the check is done by querying the root DSE of the directory,
it works without being bound to the directory.
.Sp
In contrast to other Net::LDAP methods this method returns
TRUE / FALSE respectively undef on error.
.IP "list_replicas ( SERVER_DN, OPTIONS )" 4
.IX Item "list_replicas ( SERVER_DN, OPTIONS )"
Query the replicas on the given server \fISERVER_DN\fR.
.Sp
On success, the resulting Net::LDAP::Message object supports the method
\&\f(CW\*(C`replicas\*(C'\fR that returns the list of replicas on \fISERVER_DN\fR.
.IP "get_replica_info ( SERVER_DN, REPLICA_DN, OPTIONS )" 4
.IX Item "get_replica_info ( SERVER_DN, REPLICA_DN, OPTIONS )"
Query information of \fIREPLICA_DN\fR on \fISERVER_DN\fR.
.Sp
On success, the resulting Net::LDAP::Message object supports the method
\&\f(CW\*(C`replica_info\*(C'\fR that returns a hash containing information on \fIREPLICA_DN\fR.
.IP "trigger_backlinker ( OPTIONS )" 4
.IX Item "trigger_backlinker ( OPTIONS )"
Trigger the BackLinker process, which resolves external references
to ensure they refer to real entries.
.IP "trigger_janitor ( OPTIONS )" 4
.IX Item "trigger_janitor ( OPTIONS )"
Trigger the Janitor process, which checks connectivity to all servers in database.
.IP "trigger_limber ( OPTIONS )" 4
.IX Item "trigger_limber ( OPTIONS )"
Trigger the Limber process, which verifies the server name,
internal ipx address and tree connectivity of all replicas.
.IP "trigger_skulker ( OPTIONS )" 4
.IX Item "trigger_skulker ( OPTIONS )"
Trigger the Skulker process, which checks the synchronization status
of every server in the replica ring.
.IP "trigger_schemasync ( OPTIONS )" 4
.IX Item "trigger_schemasync ( OPTIONS )"
Trigger SchemaSync.
.IP "trigger_partitionpurge ( OPTIONS )" 4
.IX Item "trigger_partitionpurge ( OPTIONS )"
Trigger PartitionPurge.
.IP "refresh_ldap_server ( OPTIONS )" 4
.IX Item "refresh_ldap_server ( OPTIONS )"
Trigger refreshing the NLDAP service.
.SH AUTHOR
.IX Header "AUTHOR"
Peter Marschall <peter@adpm.de>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2013 Peter Marschall. All rights reserved. This program is
free software; you can redistribute it and/or modify it under the same
terms as Perl itself.