Sun Java System Messaging Server 6.3 Administration Guide

20.12.6 To Use Legato Networker

Messaging Server includes a backup API that provides an interface with third-party backup tools, such as Legato Networker. The physical message store structure and data format are encapsulated within the backup API. The backup API interacts directly with the message store. It presents a logical view of the message store to the backup service. The backup service uses the conceptual representation of the message store to store and retrieve the backup objects.

Messaging Server provides an Application Specific Module (ASM) that can be invoked by the Legato Networker’s save and recover commands to back up and restore the message store data. The ASM then invokes the Messaging Server imsbackup and imsrestore utilities.

Note –

This section provides information about how to use Legato Networker with the Messaging Server message store. To understand the Legato Networker interface, see your Legato documentation.

ProcedureTo Back Up Data Using Legato Networker

  1. Create a symbolic link from /usr/lib/nsr/imsasm to msg-srv-base/lib/msg/imsasm

  2. From Sun or Legato, obtain a copy of the nsrfile binary and copy it to the following directory:


    Note that this is required only if you are using an older version of Networker (5.x). With Networker 6.0 and above, nsrfile is automatically installed under /usr/bin/nsr.

  3. If you want to back up users by groups, perform the following steps:

    1. Create a backup group file as described in 20.12.2 To Create Backup Groups

    2. To verify your configuration, run

      Look at the directory structure created by structure should look similar to that shown in Table 20–4.

      Note that if you do not specify a backup-groups.conf file, the backup process will use the default backup group ALL for all users.

  4. In the directory /nsr/res/, create a res file for your save group to invoke the script before the backup. See Table 20–4 for an example.

    Note –

    Earlier versions of Legato Networker have a limitation of 64 characters for the save set name. If the name of this directory plus the logical name of the mailbox (for example, /primary/groupA/fred) is greater than 64 characters, then you must run -p. Therefore, you should use a short path name for the -p option of For example the following command will create the backup image under the directory /backup: -p /backup

    Important: The backup directory must be writable by the message store owner (example: mailsrv).

    Table 20–6 shows a sample backup groups directory structure.


    The example below shows a sample res file named IMS.res in the /nsr/res directory:

    type: savepnpc;
    precmd: "echo mkbackupdir started",
       "/usr/siroe/server5/msg-siroe/bin/ -p /backup";
    pstcmd: "echo imsbackup Completed";
    timeout: "12:00 pm";

    You are now ready to run the Legato Networker interface as follows:

  5. Create the Messaging Server save group if necessary.

    1. Run nwadmin.

    2. Select Customize | Group | Create.

  6. Create a backup client using savepnpc as the backup command:

    1. Set the save set to the directory created by mkbackupdir.

      For a single session backup, use /backup

      For parallel backups, use /backup/server/group

      Be sure you’ve already created group as defined in 20.12.2 To Create Backup Groups

      You must also set the parallelism to the number of backup sessions.

      See To Back Up Data Using Legato Networker.

  7. Select Group Control | Start to test your backup configuration.

    Example. Creating A Backup Client in Networker:

    To create a backup client in Networker. From nwadmin, select Client | Client Setup | Create

    Name: siroe
    Group: IMS
    Backup Command:savepnpc
    Parallelism: 4
                  Restoring Data Using Legato Networker

To recover data, you can use the Legato Networker nwrecover interface or the recover command-line utility. The following example recovers user a1’s INBOX:

recover -a -f -s siroe /backup/siroe/groupA/a1/INBOX

The next example recovers the entire message store:

recover -a -f -s siroe /backup/siroe