i-Planet Administration Guide

Creating New i-Planet Users From a Text File

If you specify neither -srclogin nor -destlogin switches with the create action, then UserAdminCL reads data for the new i-Planet user from text files. You can create multiple identical i-Planet users using predefined defaults that are set up in a defaults file, or by specifying the per i-Planet user configuration in a flat file, or both. You can specify two command line switches:

Each line in the users file contains information for a single user in the form of one or more key-value pairs. Keys and values are separated by an = (equals sign), and key-value pairs are separated by a ; (semicolon); see the example for the Procedure "To Create New Users From a Text File" below. Only the key session.uid is required--any other pairs are optional.

The defaults file format is identical to that of the i-Planet users file, except that it contains only a single line of properties. The properties specified in the defaults are applied to each i-Planet user named in the i-Planet users file for any values not explicitly specified in the i-Planet user's file.


Note -

i-Planet stores an i-Planet user's IMAP mail password as an encrypted value. It is encrypted with a proprietary algorithm. If you wish to specify a mail password for each i-Planet user in the users file, you can do so, but it must be in plain text. The password will be encrypted before it is saved.


For example, to add three i-Planet users and specify an IMAP password, a mail server, and calendar server for each, you can use the following procedure.

To Create New Users From a Text File
  1. Create a ./users file, for example.

    This file should contain the following information:


    session.uid=bob;IMAP.Mail.password=gimme
    session.uid=bill;IMAP.Mail.password=bokbok
    session.uid=jan;IMAP.Mail.password=joshua

    This file is used to specify information that is different for each i-Planet user that is being created. At a minimum, each i-Planet user's login name (session.uid) and the IMAP mail password (IMAP.Mail.password) falls into this category.

  2. Because the mail and calendar server are constant among all the i-Planet users, create a ./defaults file with a single line to populate the mail and calendar server values for all users, for example:


    Common.MailServer=foo.bar.com;Common.CalendarServer=farble.bar.com

  3. With these files in place, type the following command to run UserAdminCL:


    # java com.sun.stnr.useradmin.UserAdminCL +action create 
    
    + created login=bob 
    
    + created login=bill 
    
    + created login=jan
    

    This command returns the confirmation that the user or users indicated in the command were created:


    + created login=bob 
    
    + created login=bill 
    
    + created login=jan