Sun Java System Communications Services 6 2005Q4 Schema Migration Guide

commdirmig Syntax

The commdirmigutility has the following syntax:


commdirmig -t {1|2|3}
            -D AuthenticationID    -w AuthenticationPasswordFile
            -X DirectoryServerHost    -p DirectoryServerPort
            -b OSIRoot    -r DCRoot
            [-o online]             [-a AuditLDIFFile]
            [-d Domain [, Domain]... [, Domain] | “*”]
            [-f DomainFile]
            [-S mail, cal]          [-H MailHost]
            [-i InputFile]    [-l LogFile]
            [-v]                    [-c]
            [-m LogMaxSize]    [-k]
            [-u UndoFile]
            [-h Option]  [-? Option]  [-V]

commdirmig Syntax lists the commdirmig mandatory options and summarizes the information in the following sections.

Table 3–1 commdirmig Mandatory Options

commdirmigMandatory Option

Description  

-t 1|2|3

1 specifies a migration from Schema 1 to Schema 2, native mode. 2— specifies a migration from Schema 1 to Schema 2, compatibility mode.3— specifies a migration from Schema 2, compatibility mode to Schema 2, native mode.

-D AuthenticationID

Specifies the login ID of the user authorized to run and modify the Directory Server. 


-w
Authentication
PasswordFile

Specifies a text file containing the password for the Directory Server login ID. You can choose to set the password file to be readable only by superuser (root). 

-X DirectoryServerHost

Specifies the host name of the Directory Server that manages the LDAP directory you are migrating. 

-p DirectoryServerPort

Specifies the port number for accessing the Directory Server. 

-b OSIRoot

Specifies the root suffix of the OSI (Organization) Tree in the LDAP directory. 

-r DCRoot

Specifies the root suffix of the DC Tree in the LDAP directory. 

commdirmig Syntax lists the commdirmig non-mandatory options and summarizes the information in the following sections.

Table 3–2 commdirmig Non-Mandatory Options

commdirmig

Non-Mandatory Option 

Description  

[-o ]

Directs commdirmig to migrate the LDAP directory online (immediately).

[-a AuditLDIFFile]

Directs commdirmig to write the migration audit to an LDIF-formatted file you specify. The directory entries are not changed.

By default, commdirmig writes the migration audit to a file. It does not migrate online.

The default AuditLDIFFile is commdirmig.audit.ldif.n

where n is a random number appended to the file name when the LDIF file is generated. The appended number makes the file name unique, which prevents the utility from overwriting any existing LDIF file. For example:

commdirmig.audit.ldif.1126206446358

The default paths (and name) for AuditLDIFFile are as follows:

Solaris: /var/opt/SUNWcomm/log/commdirmig.audit.ldif

Linux: /var/opt/sun/comms/commcli/log/commdirmig.audit.ldif

[-d Domain[,Domain]

...[,Domain]

| “*”]

Domain[,Domain]...[,Domain] specifies individual domain names. You can specify a single domain or a comma-separated list of domains.

“*” specifies all domains in the LDAP directory. You must enclose the asterisk in quotes or use the Escape character before the asterisk.

The default is to migrate all domains in the LDAP directory. 

[-f DomainFile]

DomainFile– specifies an ASCII text file that contains a blank-line separated list of domain names. commdirmig migrates the domains named in the file.

Optionally, you can specify a preferred mail host associated with a specified domain. This option is used as the mail host when mail service is added to users and groups in the domain. 

For details about formatting the DomainFile, see Domains Being Migrated

[-S mail, cal]

mail– adds new Messaging services to the directory.

cal– adds new Calendar services to the directory.

The default is to migrate only the services commdirmig finds in the current directory.

[-H MailHost]

Specifies the mail host to be used to add mail services to users and groups. When you use -S mail to add mail services, -H MailHost is required.

[-i InputFile]

Directs commdirmig to migrate the directory by using the options and arguments listed in a user-created file, InputFile.

[-l LogFile]

Specifies the file to which commdirmig writes log information. The default is commdirmig.log.

[-v ]

Specifies verbose (maximum) log details. The default level is standard. 

[-c ]

Directs commdirmig to continue running when an error occurs. The default is to exit when an error occurs.

[-m LogMaxSize]

Specifies the maximum size of the log file. Size can be configured in kilobytes (K) or megabytes (M). For example: 500 K or 2 M.

[-k ]

Checks for erroneous domain provisioning in the existing LDAP directory and reports the erroneous information to the log file. 

[-u UndoFile]

Directs commdirmig to create an undo log that can be applied to undo the migration. The log entries are saved in LDIF format in the user-specified file, UndoFile.

The default is to create an undo log. The default file is commdirmig.undo.ldif.

[-h Option]

Displays help information about the specified option. 

[-? Option]

Displays help information about the specified option. 

[-V ]

Displays the current version of the commdirmig utility.