Sun Java System Messaging Server 6.3 Administration Reference


The mkbackupdir utility creates and synchronizes the backup directory with the information in the message store. It is used in conjunction with Solstice Backup (Legato Networker). The backup directory is an image of the message store. It does not contain the actual data. mkbackupdir scans the message store’s user directory, compares it with the backup directory, and updates the backup directory with the new user names and mailbox names under the message store’s user directory.

The backup directory is created to contain the information necessary for Networker to backup the message store at different levels (server, group, user, and mailbox). Figure 1–1 displays the structure.

Figure 1–1 Backup directory hierarchy

This graphic shows the backup directory hierarchy.

Location: msg-svr-base/sbin

The variables in the backup directory contents are:




Message store administrator root directory. 


Store partition. 


System administrator-defined directories containing user directories. Breaking your message store into groups of user directories allows you to do concurrent backups of groups of user mailboxes. 

To create groups automatically, specify your groups in the msg-svr-base/config/backup-groups.conf file. The format for specifying groups is:

groupname= pattern

groupname is the name of the directory under which the user and mailbox directories will be stored, and pattern is a folder name with IMAP wildcard characters specifying user directory names that will go under the groupname directory.


Name of the message store user. 


Name of the user mailbox. 


Name of the user mailbox. 

The mkbackupdir utility creates:

groupA=a* (regexp)

The .nsr file is the NSR configuration file that informs the Networker to invoke imsasm. imsasm then creates and interprets the data stream.

Each user mailbox contains files of zero length. This includes the INBOX, which is located under the user directory.

Note –

Make sure the backup directory is writable by the message store owner (mailsrv).


mkbackupdir [-a name_of_asm] [-i | -f | -u] [-g] 
[-t number_of_threads] [-e encoding] [-v] -p directory


The options for this command are:



-a name_of_asm

Creates .nsr files using the specified asm name. This can be used for when you have multiple instances of Messaging Server as in symmetric HA environments.

-e encoding

Specify an encoding option. 


Backs up the folders only. By default, all mailboxes are backed up. 


Executes the command in debug mode. 


Backs up the inbox only. By default, all mailboxes are backed up. 

-p directory

Specifies the directory for the backup image. This is a required option when is not configured.

The max_thread parameter must be set between 1 and 1024. 

Note: The Networker has a limitation of 64 characters for saveset name. If your default backup directory pathname is too long, you should use this option to specify another pathname.

-t number_of_threads

Specifies the number of threads that can be used to create the backup directory. The default is one thread for each partition, which is usually adequate. If you have many partitions, and you do not want mkbackupdir to consume all your resources, you can lower this number.


User level backup. Instead of backing up each folder as a file, create a backup file per user. 


Executes the command in verbose mode. 


To create the mybackupdir directory, enter the following:

mkbackupdir -p /mybackupdir