Lat-users

From SME Server
Revision as of 18:28, 24 June 2013 by Stephdl (talk | contribs) (Created page with "lat-users - The lazy administrator's tool to add user accounts ==DESCRIPTION== Creates or deletes user accounts on Mitel's SME servers (5.x/6.x). This tool is f...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

lat-users - The lazy administrator's tool to add user accounts

DESCRIPTION

      Creates or deletes user accounts on Mitel's SME servers (5.x/6.x).
      This tool is functionally equivalent to the 'User accounts' option in
      the server-manager, but can be run from the command line or called from
      an other script.  It allows you, for example, to create a large number
      of accounts in a batch process, or delete accounts on a remote machine
      via an ssh console.
      See /usr/doc/lazy-admin-tools/example.users for the format of the input
      file.

See /usr/doc/lazy-admin-tools/example.users for the format of the input file.

Smecontribs repository for SME Server 8.0

yum install --enablerepo=smecontribs smeserver-lazy_admin_tools
signal-event post-upgrade; signal-event reboot

SYNOPSIS

      lat-tools -a [-p] -c "user | first | last | password | department |
      company | street | city | tel | forward | email | uid | group1 [|
      group..]"
      lat-users -a [-p] -i /path/to/users.list
      lat-users -d [-f] -c "user"
      lat-users -d [-f] -i /path/to/users.list

OPTIONS

The following options are supported:

      -a, --add
          Add a user account to the server.
      -c ""Arguments"", --command-line=""Arguments""
          Take arguments from the command line.  See the 'Arguments' section
          below for the various arguments that are accepted.
      -d, --delete
          Delete a user account from the server. Wildcards (* and ?) are
          accepted.
      -f, --force
          Don't prompt before deleting.
      -h, --help
          Extended help for this tool
      -i=FILE, --input-file=FILE
          Use the information from FILE to create or delete the user
          accounts.  See /usr/doc/lazy-admin-tools for an example of an input
          file.
      -p, --passwords
          Generate random passwords for the users and write them to ./pass-
          words.new. If a password was supplied, this option will be ignored.
      Arguments:
         user*      - Must contain only lower-case letters, numbers,
                      hyphens, periods and underscores, and should start
                      with a lower-case letter. Wildcards (* and ?) can
                      only be used to delete users.
         first*     - First name
         last*      - Last name
         password   - Password for the user (in clear-text!)
         department - Department
         company    - Company
         street     - Street name and number
         city       - Zip & City
         tel        - Telephone number
         forward    - E-mail delivery: 'local', 'forward' or 'both'
         email      - Forwarding e-mail adres
         uid        - User ID. If omitted, a suitable uid will be generated.
         group(s)   - Group name(s) to which the user should be added. If the
                      group doesn't exist, it will be created.
         * mandatory field

EXAMPLES

lat-users -a -c "harry | Harry | Potter | Quidditch"
      Creates user 'harry' from the command line, with password 'Quidditch'.
lat-users -a -i /root/users.list
      Uses the arguments specified in /root/users.list to create user
      accounts.  Please refer to /usr/doc/lazy-admin-tools/example.users for
      an example of an input file.
lat-users -d -f -c "user*"
      Deletes all user accounts that start with 'user'. All users and their
      files will be deleted without prompting (-f).
lat-users -a -p -i /root/users.list
      Creates user accounts as defined in /root/users.list and generates a
      random password for each user.  The names and passwords are written to
      ./passwords.new.
lat-users -a -c "ron | Ron | Weasley ||||||||| 6005"
      Creates user 'ron' with user ID 6005. All other fields (company,
      departments, etc.)  are left empty.
lat-users -a -c "ron | Ron | Weasley |||||||||| quiddich | dada "
      Creates user 'ron' and assigns him to groups quiddich and dada. If any
      of these groups doesn't exist, it will be created.