3.5 csmig Utility

The csmig utility assigns an owner to each calendar in the calendar database and maps each calendar ID (calid) to an owner, if needed.

The csmig utility supports multiple domains and the LDAP Calendar Lookup Database (CLD) plug-in. Calendars in the migrated database are accessible using the LDAP CLD plug-in. For information about the LDAP CLD plug-in, see Chapter 5, Configuring Calendar Database Distribution Across Multiple Machines in Calendar Server Version 6.3.

This section describes the following topics:

• 3.5.1 csmig Utility Functions

• 3.5.2 csmig Utility Requirements

• 3.5.3 csmig Syntax

• 3.5.4 csmig Utility Migration Steps

• 3.5.5 csmig Tips and Troubleshooting

3.5.1 csmig Utility Functions

The csmig migration utility performs the following functions:

• 3.5.1.1 Migrates Calendars

• 3.5.1.2 Assigns Owners to Calendars

• 3.5.1.3 Updates LDAP Attributes

3.5.1.1 Migrates Calendars

csmig migrates both user and resource calendars in the current calendar database (*.db files) specified by the caldb.berkeleydb.homedir.path parameter. In the new destination target database, csmig updates entries required by the LDAP CLD plug-in in the calendar properties (calprops), events, todos (tasks), and group scheduling engine (GSE) database files.

csmig writes only to the destination target database; it does not update your existing calendar database.

3.5.1.2 Assigns Owners to Calendars

csmig assigns an owner to each calendar in the calendar database and maps each calendar ID (calid) to an owner, if needed. All default calids are kept as is, and no changes are made.

Other calendars are mapped as follows:

• User calendars that don’t have valid owners will be owned by the user passed to csmig by the -c option. For example, if calendar ID jsmith doesn’t have an owner, it will be converted to orphan:jsmith, where orphan is specified as the -c option.

• Resource calendars that don’t have an owner will be owned by the resource user passed to csmig by the -r option.

• If a resource calendar has any colons (:) in the name, the colons are converted to underscores, so that the migrated name has only one colon.

  For example, a calendar named football with owner bkamdar will be converted to bkamdar:football. A calendar named tchang:soccer with the owner bkamdar will be converted to bkamdar:tchang_soccer. A resource calendar named auditorium:room1 with an owner admin1 will be converted to admin1:auditorium_room1.

3.5.1.3 Updates LDAP Attributes

csmig updates LDAP attributes for all relevant LDAP entries, including icsSubscribed, icsCalendar, icsCalendarOwned, icsFreeBusy, icsSet, and for resource calendars, uid. csmig creates the icsDWPHost attribute for each calendar in the LDAP directory server database. icsDWPHost specifies the host name of the back-end server where a calendar resides.

3.5.2 csmig Utility Requirements

The requirements for using csmig are:

• The calendar database must not be corrupted. Use the csdb check command to check your calendar database, and if necessary, run the csdb rebuild command to rebuild the database. For information about these commands, Appendix D, Calendar Server Command-Line Utilities Reference.

• You must have sufficient disk space for the new destination target database and if applicable, your backup database.

• To run csmig, log in as icsuser (or as the Calendar Server runtime user ID specified during configuration). If you run csmig as superuser (root), you might need to reset the permissions for the migrated files.

  You must also have privileges to manage the attributes of calendar users in the LDAP directory server that stores user preferences.

• Calendar Server must be stopped.

3.5.3 csmig Syntax

The csmig utility has the following syntax:

csmig [-t DestinationDB]
      [-b Backend-DWPHost]
      [-o OutputFile]
      [-e ErrorFile]
      [-m MappingFile]
      [-c calendarOwner]
      [-r resourceOwner]
      { migrate|dryrun }

The following table lists the utility options, gives a description of each, and gives the default value.

3.5.4 csmig Utility Migration Steps

If you had a version of Calendar Server predating version 5.1.1, after you install and configure Calendar Server 6.3, run csmig to migrate your existing Calendar Server and LDAP databases. Migration of the LDAP data is required for the LDAP CLD plug-in to work properly. Use these steps to migrate calendar data using csmig:

High Level Steps for Using csmig

1. Configure your Directory Server using comm_dssetup.pl.

   If you have not already indexed LDAP attributes using comm_dssetup.pl, do so at this time. This will greatly help performance of the LDAP data migration.

2. Using a staging server (not your production server), perform a test dry run.

   A dry run reports what csmig would do during an actual migration but does not migrate any data. After the dry run, and before you actually migrate, correct any errors and determine a plan to handle any unresolved calendars.

   For instructions on how to perform a test dry run, see 3.5.4 csmig Utility Migration Steps.

3. Migrate Your Production Data

   During a production run, csmig migrates the calendar database (.db files) and LDAP data (user and group preferences data), icsSubscribed, icsCalendar, icsCalendarOwned, icsFreeBusy, icsSet, and uid (for resource calendars). After the migration, all calendar resources will have an LDAP entry created.

   For instructions on how to migrate your production data, see 3.5.4 csmig Utility Migration Steps.

To Perform a Test Dry Run

1. Install Calendar Server 6.3 (if necessary) on the staging server.

2. Copy a snapshot of your calendar database to the staging server.

3. Mimic your production LDAP environment on the staging server by performing the following tasks:

   • Install Directory Server.

   • Install a snapshot of the LDAP database on this server.

4. Run comm_dssetup.pl to configure the staging Directory Server.

5. Run csconfigurator.sh to configure the staging Calendar Server.

6. Log in as icsuser (or, if its different, log in as the Calendar Server runtime user ID specified during configuration). If you run csmig as superuser (root), you might need to reset the permissions for the migrated files.

7. Change to the cal-svr-base/SUNWics5/cal/sbin directory.

8. Run the csdb check command to check your database for corruption. If corruption is indicated, run csdb rebuild to rebuild the database.

9. Consider creating a catchall calid for user calendars that don’t have an owner. For example, the following command creates a user with the calid of orphan:

   ./csuser -g orphan -s adminuser -y password -l en -c orphan create orphan

10. Stop the Calendar Server using the stop-cal command (if necessary).

    cal-svr-base/SUNWics5/cal/sbin/stop-cal

11. Run csmig with the -dryrun option. For example, you might enter:

    ./csmig -b sesta.com -o csmig.out -e csmig.errors
     -m csmig.map -c orphan -r calmaster dryrun

    This command assigns user calendars without an owner (orphan calendars) to the owner orphan and resource calendars without an owner to the owner calmaster.

12. Check the output mapping file (csmig.map). The mapping file lists entries that need to be updated in the LDAP schema.

13. Check the output, mapping, and error files. Resolve any LDAP issues or errors that you find. Determine how you will handle any unresolved calendars before the actual migration.

    Several options are:

    • Delete any unneeded calendars before you migrate.

    • Assign owners to any unresolved calendars.

    • Allow csmig to assign owners to the calendars during migration using the -c and -r options.

14. Run csmig to migrate your staging calendar database.

    For example, the following command migrates the calendar database to the /var/opt/SUNWics5/testcsdb/ directory:

    ./csmig -t /var/opt/SUNWics5/testcsdb/ -b sesta.com 
    -o csmig.out -e csmig.errors -m csmig.map -c orphan 
    -r calmaster migrate

15. After the test migration is finished, perform these steps to check out the newly migrated calendar database.

    1. Copy the migrated database to the /csdb directory specified by the caldb.berkeleydb.homedir.path parameter. Or, edit this parameter to point to the new location of the migrated database.

    2. Run csdb check on the new calendar database. The number of events and todos in the migrated database should match the pre-migration totals.

    3. Search for icsCalendarOwned entries and make sure that the entries match the pre-migration number of calendars.

    4. Log in to Communications Express and verify some of the calendars in the migrated database.

       If the test migration is successful, you are ready to migrate your production database.

To Migrate Your Production Data

1. Log in as icsuser (or as the Calendar Server runtime user ID specified during configuration). If you run csmig as superuser (root), you might need to reset the permissions for the migrated files.

2. Change to the cal-svr-base/SUNWics5/cal/sbin directory.

3. Stop the Calendar Server using the stop-cal command.

   cal-svr-base/SUNWics5/cal/sbin/stop-cal

4. Backup the following data:

   • Calendar database (.db files).

   • LDAP data: slapd database directory and LDAP database.

   • ics.conf file. This step is not actually required, but it can be useful if you need to revert to your original configuration.

5. Run csmig with the -migrate option.

   For example, the following command migrates the calendar database to the /var/opt/SUNWics5/newcsdb/ directory:

   ./csmig -t /var/opt/SUNWics5/newcsdb/ -b sesta.com 
   -o csmig.out -e csmig.errors -m csmig.log -c orphan 
   -r calmaster migrate

6. Check for any unresolved calendars in the error file (csmig.errors) and resolve them according to your plan from 3.5.4 csmig Utility Migration Steps under 3.5.4 csmig Utility Migration Steps.

7. Run the csdb check command to check your migrated database. If any corruption is indicated, run csdb rebuild to rebuild the database.

8. Copy the new migrated database to the /csdb directory specified by the caldb.berkeleydb.homedir.path parameter. Or, edit this parameter to point to the new location of the migrated database.

9. Enable the LDAP CLD plug-in by making any necessary changes to the following configuration parameters in the ics.conf file:

   • service.dwp.enable = "yes"

   • service.dwp.port = "59779"

   • csapi.plugin.calendarlookup = "yes"

   • csapi.plugin.calendarlookup.name = "*"

   • caldb.cld.type = "directory"

   • caldb.dwp.server.default = "default-server-name"

   • caldb.dwp.server.server-hostname.ip = "server-hostname" (for each back-end server including the local server)

   • caldb.cld.cache.enable = "yes" (if you want to use the CLD cache option)

   • caldb.cld.cache.homedir.path specifies the location of the CLD cache directory. The default is /var/opt/SUNWics5/csdb/cld_cache.

     For information about setting configuration parameters for the LDAP CLD plug-in, see Chapter 5, Configuring Calendar Database Distribution Across Multiple Machines in Calendar Server Version 6.3.

10. Restart Calendar Server using the start-cal command.

11. Log in to Communications Express and verify that your configuration is working by checking several of the migrated calendars.

    To disable alarms while you are making your checks, set each of the following parameters in the ics.conf file to "no":

    • caldb.serveralarms = "no"

    • caldb.serveralarms.dispatch = "no"

    • service.ens.enable = "no"

    • service.notify.enable = "no"

    • ine.cancellation.enable = "no"

    • ine.invitation.enable = "no"

    • service.admin.alarm = "no"

3.5.5 csmig Tips and Troubleshooting

The section describes the following tips and trouble shooting examples:

• 3.5.5.1 The csmig dry run calendar shows the wrong owner for a calendar.

• 3.5.5.2 The LDAP calendar search doesn’t work correctly.

• 3.5.5.3 The csmig dry run indicates duplicate calendar names.

• 3.5.5.4 How do I assign orphan calendars to different owners?

• 3.5.5.5 How do I move calendar users to another back-end server?

3.5.5.1 The csmig dry run calendar shows the wrong owner for a calendar.

Example Problem

A calendar named tchang:myCalendar has the owner jsmith in the calendar database, and the csmig dry run shows the mapping as jsmith:tchang_myCalendar. However, you would like to name this calendar tchang:myCalendar and assign the owner as tchang.

Example Solution

Before the migration, use the cscal utility to change the owner of the calendar tchang:myCalendar to tchang. Once this is done, the migration will map this calendar to tchang:myCalendar and add icsCalendarowned to the LDAP entry for user ID tchang.

3.5.5.2 The LDAP calendar search doesn’t work correctly.

Example Problem

After migration, the LDAP calendar search is enabled, but the calendar search dialog does not return any results or returns only partial results.

Example Solution

Enabling the LDAP calendar search allows Calendar Server to search (&(objectclass=icscalendaruser)(icscalendarowned=*substr*)).

Manually run two different searches on the LDAP data with the following filters and compare the output:

• LDAP search with filter (&(objectclass=icscalendaruser)(icscalendarowned=*substr*))

• LDAP search with filter (icscalendarowned=*substr*)

Since the server uses the filter that includes icsCalendarUser object class, the LDAP server might have been deployed with the schema check disabled, and some calendar entries may have been provisioned without the icsCalendarUser object class.

3.5.5.3 The csmig dry run indicates duplicate calendar names.

Example Problem

The csmig dry run mapping file and output file indicate that there is a duplicate calendar name.

For example, in the original database, jsmith owns the following calendars:

• basketball with 5 events

• jsmith:basketball with 10 events

The dry run indicates that during a migration, the two calendars will be merged, and the resulting calendar will be jsmith:basketball with owner jsmith and 15 total events

The output file will include the following warning message:

Error modifying calendar properties, error=2

Example Solution

If you don’t want the two calendars to be merged, change the owner of basketball to a user other than jsmith before the migration. This will preserve the data integrity of the two separate calendars.

3.5.5.4 How do I assign orphan calendars to different owners?

Example Problem

By default csmig assigns all orphan calendars to a single owner, but I would like to assign different owners for some orphan calendars.

Example Solution

csmig does not accept the mapping file in the command line. However, you can assign owners to the orphan calendars in the original database before the migration. Check the dry run mapping file for all orphan calendars. Then use the cscal utility to assign owners to the orphan calendars before the migration. Run csmig in -dryrun mode again to verify the new owners.

3.5.5.5 How do I move calendar users to another back-end server?

Example Problem

How do I move users from one back-end server to another?

Example Solution

To move a calendar user, you export each of the user’s calendars on the original server and then import the calendars on the second server. After the calendars are moved, you can delete the calendars on the original server. For instructions on how to move calendars, see 15.6 Managing User Calendars.