ldapuserdir/docs/ldapuserdir-ctl.rst

Command Line Utility

ldapuserdir-ctl

Usage: ldapuserdir-ctl [options] groupname [usernames]

Used to inspect or change members of a group in Active Directory User names can be given as full distinguished names or just as the short names (in that case they will be extended by the standard OU extension)

Options:

-h, --help            show this help message and exit
-a                    add group members
-d                    delete group members
-c CFGFILE            path of a config file
--configfile          show an example configuration file
-u USERFILTER         list all matching ldap users that have defined unix
                      mappings
--debug               debug mode: log messages at debug level
-D USER_DN            DN or CN of ldap user for binding to the AD server
                      (CN=minpriv_user,OU=Services,DC=example.com,DC=org)
-f PWFILE             path to password file (without this pwd will be
                      prompted for)
-g USER_TO_GROUP      get group memberships for this user
-v                    use more verbose output (with user list only)
--user-ou=USER_OU     default OU for users (OU=Users,DC=example.com,DC=org)
--group-ou=GROUP_OU   default OU for groups (OU=Groups,DC=example.com,DC=org)
-n, --allow-no-mssfu  do not restrict to entries with unix (msSFU) mappings
-V                    show version information

Examples:

List group members
  $> ldapuserdir-ctl svc_ra_x06sa
  $> ldapuserdir-ctl 'svc_ra_*'

Get group memberships for user mueller
  $> ldapuserdir-ctl -g mueller

Add/delete users to/from a group (requires access rights!)
  $> ldapuserdir-ctl -a svc_ra_x06sa user1 user2 user3
  $> ldapuserdir-ctl -d svc_ra_x06sa user1 user2

List users matching a pattern
  $> ldapuserdir-ctl -u 'mueller*'

Configuration file

The configuration is read from a configuration file that is searched for in these default locations:

• ~/.ldapuserdir-ctl.cfg
• /etc/ldapuserdir-ctl.cfg

../etc/ldapuserdir-ctl.cfg