Appendix A       Command-Line Interface


This appendix describes the migration commands "imsdirmig" and "imsdaaci"

imsdirmig

---

The imsdirmig command upgrades SIMS 4.0 or NMS 4.x directory entries (users, groups, domains) to use the attributes for the iPlanet Messaging Server schema. It can also add attribute value pairs to entries without upgrading to the new schema.

Synopsis

imsdirmig [-h ldaphost[:ldapport]] -D AdminDN -M mailserver -b dirname [-A attr:val[\;attr:val ] [\;attr:val][...] [-P] [-O]] [-C configfile] [-F LDAPFilter] [-T number] [-r val1[,val2][,val3][...]] [-c ] [-f logfile] [-l debuglevel] [-m user|group|domain|both] [-n] [-w password]

Options

Option	Description
-D AdminDN	Mandatory. Specifies the DN of the entry to bind to LDAP server. Typically administrator or directory manager DN.
-M mailserver	Mandatory. Specifies if the mail server is sims (Sun Internet Mail Server) or nms (Netscape Messaging Server).
-b DirectoryBaseDn	Mandatory. Specifies the DN of the directory base containing the entries to be migrated. The DN is a starting point for fetching the entries.
-A attr:val[\;attr:val] [\;attr:val][...]	Specifies a separated list (;) of attribute value pairs to be set during migration. Default value is NULL attr:val pairs.
-P	Used in conjunction with -A. When specified, the attributes values provided in -A are added to existing value pairs instead of the default behavior of replacing the existing value pairs.
-C configfile	Specifies the configuration file. This file can be used to store command flags and parameters. See config.fmt for format.
-F LDAPFilter	Specifies the LDAP filter. The default value is NULL. See RFC 1558.
-O	Provides an optimization feature. If specified, imsdirmig processes only the attr:val pair specified in the -A option and does not apply the default migration. It is a quick-run option that applies just the migration rule supplied with -A option. This option is valid only with -A option.
-T number	Specifies the number of update threads to be spawned by imsdirmig. The default value is 2.
-c	Specifies continuous mode operation. When specified, imsdirmig reports any errors and continues the migration process. If omitted, imsdirmig stops after the first error it encounters. Whether the -c option is used or not, imsdirmig produces a report for all errors it encounters.
-f logfile	Specifies the report log file. The default location is /var/tmp/toolname.<TimeStamp>.
-h hostname[:port]	Specifies the LDAP host and port of the master LDAP directory. The default value is local host. LDAP port is 389.
-l debuglevel	Specifies the level of debug information to be written to the debug file, which is stored in /var/tmp/toolname.dbg. Valid debug level values are: 0 - Default messages 1 - Messages that are treated as log always 2 - Error messages 3 - Warning messages 4 - Debug messages The default value is 0.
-m user | group | domain | both	Specifies the entry type. The default value is both, which means user and group entry types.
-n	Specifies the preview option for all entries. The default value is NULL.
-r val1[,val2] [,val3][...]	Specifies comma separated list of the report options. The values are: totals - Lists the counts of entries migrated and entries not migrated because of errors by entry type. nototals - Does not list counts. names - Lists distinguished name of each entry as migration is done. nonames - Does not list distinguished name of each entry. before - Lists the values of all attributes examined by imsdirmig before any changes are made, for each entry examined. nobefore - Does not list values of all attributes before change. after - Lists values of all attributes altered by imsdirmig after any changes have been made, for each entry examined. noafter - Does not list attributes altered after any changes have been made. The default values for report options are totals, nonames, nobefore, and noafter.
-w password	Specifies the bind password. If omitted, imsdirmig prompts for the password with echo suppressed.

Example

imsdirmig -b "dc=com,o=internet" -M sims -D "cn=Directory Manager" -w secret -m both -A mailhost:newmail.siroe.com

All user/group entries under o=internet are assigned a new mailhost and are upgraded to the new schema.

imsdaaci

---

The imsdaaci command creates an LDIF file used to create the Service Administrators group and Domain Administrators group along with the required ACIs. Use ldapmodify to add the groups and ACIs into the DIT. Note that the groups are empty and that in order for user(s) to have administrator privileges, one or more users must be made a member of the Service Administrator group. Refer to "Creating Top-level Administrators" in the iPlanet Messaging Server Provisioning Guide at http://docs.iplanet.com/docs/manuals/messaging/ims50/pg/admins.htm#15246

Synopsis

imsdaaci [-h LDAP_host] -D AdminDN -w password -b DC_Suffix [-p LDAP_Port] [-o OSI_Suffix]

Options

The options for this command are:

Option	Description
-D AdminDN	Mandatory. Specifies the administrator distinguished name.
-w password	Mandatory. Password for AdminDN.
-b DC_Suffix	Mandatory. Specifies the root suffix of the DC tree. Example: o=internet
-h LDAP_host	Optional. Specifies the host name for user/group LDAP server. The default value is local host.
-p LDAP_Port	Optional. Specifies the port number of the user/group LDAP server. The default value is 389.
-o OSI_Suffix	Optional. Specifies the root suffix of the OSI tree. When not specified, it defaults to the value of the DC suffix, which is typically used for existing SIMS deployments where the DC Tree contains the user/group data.

Example

imsdaaci -h ldap.siroe.com -D "cn=Directory Manager" -w secret -b "o=internet" -o "o=siroe.com"