shelldap - Man Page

Define or display aliases.

Without arguments, `alias' prints the list of aliases in the reusable form `alias NAME=VALUE' on standard output.

Otherwise, an alias is defined for each NAME whose VALUE is given. A trailing space in VALUE causes the next word to be checked for alias substitution when the alias is expanded.

    alias
    alias ll=ls -al
    alias ll
    alias show=cat
    alias cmd1=command 'arg with spaces'
    alias cmd2='command '
    alias cmd2=command 'with_arg '

Print contents of LDAP entry to STDOUT in LDIF format.

Globbing is supported. Specify either full DN, or a RDN. RDNs are local to the current search base ('cwd' in shell terms). If RDN is '.' or missing, it defaults to the current search base. You may additionally add a list of attributes to display (e.g. use '+' for operational attributes or provide a specific space-separated list). Default list of attributes is ['*'] and this default list can be changed using 'attributes' config key or --attributes cmdline option.

    cat uid=mahlon
    cat ou=*
    cat uid=mahlon,ou=People,dc=example,o=company
    cat uid=mahlon + userPassword

Load or save config file.

If no config file is specified as argument to 'load', the default search list is:

    $HOME/.shelldap.rc
    /usr/local/etc/shelldap.conf
    /etc/shelldap.conf

If no config file is specified as argument to 'save', the default path is $HOME/.shelldap.rc.

    configfile load
    configfile load /path/to/config
    configfile save
    configfile save /path/to/config

Like 'cat', but use configured pager to paginate output.

Change the working directory (LDAP search base).

Translated to LDAP, this changes the current basedn. All commands after a 'cd' operate within the new basedn.

    cd                  change to 'home' (binddn if any, or basedn)
    cd ~                change to 'home' (binddn if any, or basedn)
    cd -                change to previous node
    cd ou=People        change to explicit path below current node
    cd ..               change to parent node
    cd ../../ou=Groups  change to node ou=Groups, which is a sibling
                        to the current node's grandparent

Since LDAP doesn't limit what can be a container object, you can 'cd' into any entry. Many commands then work on '.' or default to '.', meaning "wherever I currently am."

    cd uid=mahlon
    cat .
    cat

Clear the terminal screen.

Clears screen similar to 'clear' or Ctrl+l on the shell command line.

Ctrl+l alias is also supported.

Copy an entry.

All copies are relative to the current basedn unless a full DN is specified.  All attributes are copied and then an LDAP moddn() is performed.

    copy uid=mahlon uid=bob
    copy uid=mahlon ou=Others,dc=example,o=company
    copy uid=mahlon,ou=People,dc=example,o=company uid=mahlon,ou=Others,dc=example,o=company

Create an entry.

Arguments are space separated objectClass names.  Possible objectClasses are derived automatically from the server, and will tab-complete.

After the classes are specified, an editor will launch.  Required attributes are listed first, then optional attributes.  Optionals are commented out.  After the editor exits, the resulting LDIF is validated and added to the LDAP directory.

    create top person organizationalPerson inetOrgPerson posixAccount

Remove an entry.

Globbing is supported. All deletes are sanity-prompted.  The -v flag prints the entries out for review before delete.

    delete uid=mahlon
    delete uid=ma*
    rm -v uid=mahlon,ou=People,dc=example,o=company l=office

Edit an entry in an external editor.

After the editor exits, the resulting LDIF is sanity checked, and changes are written to the LDAP directory.

    edit uid=mahlon

Print values of configurable shelldap variables.

This is a subset of all variables configurable via shelldap config file and/or its command line options.

Search using LDAP filters and return matching DN results.

The search string must be a valid LDAP filter.

    grep uid=mahlon
    grep uid=mahlon ou=People
    grep -r (&(uid=mahlon)(objectClass=*))

View schema and flags for an entry or objectClass.

It also includes the most common flags for the objectClass attributes.

    inspect uid=mahlon
    inspect posixAccount organizationalUnit
    inspect _schema

The output is a list of found objectClasses, their schema hierarchy (up to 'top'), whether or not they are a structural class, and then a merged list of all valid attributes for the given objectClasses. Attributes are marked as either required or optional, and whether they allow multiple values or not.

If you ask for the special "_schema" object, the raw server schema is dumped to screen.

List directory contents.

Globbing is supported.

    ls -l
    ls -lR uid=mahlon
    list uid=m*

In 'long' mode, descriptions are listed as well, if they exist. There are some default 'long listing' mappings for common objectClass types.  You can additionally specify your own mappings in your .shelldap.rc, like so:

    ...
    descmaps:
        objectClass: attributename
        posixAccount: gecos
        posixGroup: gidNumber
        ipHost: ipHostNumber

Create a new 'organizationalUnit' LDAP entry.

  mkdir containername
  mkdir ou=whatever

Move (rename) entry.

Usage is identical to copy.

Change user password.

If supported server side, change the password for a specified entry. The entry must have a 'userPassword' attribute.

    passwd uid=mahlon

Print name of current/working LDAP search base.

Change or define shelldap variable.

    setenv debug 1
    export debug=1

Remove each NAME from the list of defined aliases.

    alias ll=ls -al
    alias
    unalias ll
    unalias ll ls
    alias

Remove each NAME from the list of defined shelldap variables.

    unset debug
    unset configfile
    unset myvar1 myvar2 myvar3

Print current bind DN.

Show current auth credentials.  Unless you specified a binddn, this will just show an anonymous bind.