1Net::LDAP::Control::SubUesnetrriCeosn(t3r)ibuted Perl DoNceutm:e:nLtDaAtPi:o:nControl::Subentries(3)
2
3
4

NAME

6       Net::LDAP::Control::Subentries - LDAPv3 Subentries control object
7

SYNOPSIS

9        use Net::LDAP;
10        use Net::LDAP::Control::Subentries;
11
12        $ldap = Net::LDAP->new( "ldap.mydomain.eg" );
13
14        $subentries = Net::LDAP::Control::Subentries->new( visibility => 1 );
15
16        $msg = $ldap->search( base => 'dc=sub,dc=mydomain,dc=eg",
17                              filter => '(objectclass=*)',
18                              attrs => [ qw/1.1/ ],
19                              control => [ $subentries ] );
20
21        die "error: ",$msg->code(),": ",$msg->error()  if ($msg->code());
22

DESCRIPTION

24       "Net::LDAP::Control::Subentries" provides an interface for the creation
25       and manipulation of objects that represent the "Subentries" control as
26       described by RFC 3672.
27
28       This control, for which no corresponding response control exists, is
29       appropriate for LDAP search operations only.
30
31       In absence of this control, subentries are visible only to LDAP search
32       requests with "scope => 'base'", but not to searches with any other
33       "scope" value.
34

CONSTRUCTOR ARGUMENTS

36       In addition to the constructor arguments described in
37       Net::LDAP::Control the following are provided:
38
39       visibility
40           A Boolean value indicating the visibility of subentries or regular
41           entries.
42
43           The value "TRUE" indicates that subentries are visible and normal
44           entries are not; the value "FALSE" indicates that normal entries
45           are visible and subentries are not.
46

METHODS

48       As with Net::LDAP::Control each constructor argument described above is
49       also available as a method on the object which will return the current
50       value for the attribute if called without an argument, and set a new
51       value for the attribute if called with an argument.
52

SEE ALSO

54       Net::LDAP, Net::LDAP::Control,
55

AUTHOR

57       Peter Marschall <peter@adpm.de>.
58
59       Please report any bugs, or post any suggestions, to the perl-ldap
60       mailing list <perl-ldap@perl.org>
61

63       Copyright (c) 2020 Peter Marschall. All rights reserved. This program
64       is free software; you can redistribute it and/or modify it under the
65       same terms as Perl itself.
66
67
68
69perl v5.32.1                      2021-02-16 Net::LDAP::Control::Subentries(3)
Impressum