The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Samba-LDAP-0.05
River stage zero No dependents
++
/ Samba::LDAP::Group

NAME

Samba::LDAP::Group - Manipulate Samba LDAP Groups

VERSION

This document describes Samba::LDAP::Group version 0.05

SYNOPSIS

    use Carp;
    use Samba::LDAP::Group;

    my $group = Samba::LDAP::Group->new()
        or croak "Can't create object\n";

DESCRIPTION

Various methods to add, delete, modify and show Samba LDAP Groups

DEVELOPER RELEASE!

BE WARNED - Not yet complete and neither are the docs!

INTERFACE

new

Create a new Samba::LDAP::Group object

add_group

Not complete.

add_to_group

Add $username to LDAP group $group

    my $result = $group->add_to_group( $group, $username);
    print "$username added to $group\n" if $result;

add_to_groups

Pass in a list of groups for the user or users to be added to.

For one user:

    my $groups_aref = [ 'staff', 'directors', 'contractors', ];

    my $result = $group->add_to_groups( $groups_aref, $username  );
    print "$username added to groups\n" if $result;

List of users and groups:

    my $groups_ref = {
                        admin => [ 'staff', 'directors', 'contractors', ],
                        ghenry => [ 'web_team', 'finance', 'cleaners', ],
                     };

    my $result = $group->add_to_groups( $group_ref );
    print "Added to groups\n" if $result;

find_groups

Find the groups that $username belongs to. Returns an Array of groups.

    my @groups = $group->find_groups( $username );
    print "@groups";

delete_group

Deletes group name from LDAP tree

    my $delete_result = $group->delete_group( $group_name );
    print "$delete_result";

remove_from_group

Remove the user from $group. Removes memberUid and member entries

    my $result = $group->remove_from_group( $group, $username )
    print "$group removed\n" if $result;

show_group

Lists the entries for that group

    my $group_info = $group->show_group( $group );
    print "$group_info\n";

list_groups

Not complete.

parse_group

Check the group is either a name or number.

    my $result = $group->parse_group( $userGidNumber );

Not complete.

is_group_member

Check that the user is a member of the group already

    my $result = $self->is_group_member( $dn,$userid );
    print "$userid is a member of $dn\n" if $result;

read_group_entry

Return all posixGroup details. Similar to show_group and will be re-organised later

    my $group_info = $group->read_group_entry( $group );
    print "$group_info\n";

Utility method.

read_group_entry_gid

Read the group number in the LDAP Directory.

    my $group_number = $group->read_group_entry_gid( $group );
    print $group_number\n";

Utility method.

DIAGNOSTICS

None yet.

CONFIGURATION AND ENVIRONMENT

Samba::LDAP::Group requires no configuration files or environment variables.

DEPENDENCIES

Carp, Regexp::DefaultFlags, Readonly and List::MoreUtils

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-samba-ldap@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

Gavin Henry <ghenry@suretecsystems.com>

ACKNOWLEDGEMENTS

IDEALX for original scripts.

LICENCE AND COPYRIGHT

Copyright (c) 2001-2002 IDEALX - Original smbldap-tools

Copyright (c) 2006, Suretec Systems Ltd. - Gavin Henry <ghenry@suretecsystems.com>

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. See perlgpl.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.