Novell Documentation: GroupWise 6 - GroupWise Target Service Agent (GWTSA)

GroupWise Target Service Agent (GWTSA)

The GroupWise Target Service Agent (GWTSA) provides reliable backups of a running GroupWise system by successfully backing up open files and locked files, rather than skipping them as some backup software does.

GWTSA Functionality

The GroupWise Target Service Agent (GWTSA) is a GroupWise API that works with other backup software. Compatible backup products include:

Novell^® Storage Management Services^TM (SMS^TM)
Veritas Backup Exec for NetWare^®
Legato SnapShotServer for NetWare
BrightStor ARCserve Backup (version 9)
Syncsort* Backup Express

For a complete and current list of compatible backup software, use the Novell Solutions Search.

The GWTSA has no user interface of its own, but its presence running along with other backup software provides GroupWise options in the backup software that would not otherwise be available.

The GWTSA backs up standard GroupWise directories and files; extra directories and files that appear within a standard GroupWise directory structure are not backed up by the GWTSA. The table below lists the directories and files that are backed up by the GWTSA.

GroupWise Location	Directories	Subdirectories/Files Backed Up
Domain	domain_directory	wpdomain.db wpdomain.dc wphost.dc gwdom.dc gwpo.dc mtaname
	domain_directory\wpgate	async gwia webac60a etc.
Post Office	post_office_directory	wphost.db ngwguard.db ngwguard.dc ngwguard.rfl ngwguard.fbk ngwcheck.db ngwcheck.log gwpo.dc
	post_office_directory\gwdms	dmsh.db
	post_office_directory\gwdms\library_directory	.db archive\.* docs\.
	post_office_directory\offiles	.
	post_office_directory\ofmsg\guardbak	ngwguard.fbk
	post_office_directory\ofusr	userxxx.db
	post_office_directory\ofusr\index	.idx .inc
	post_office_directory\ofviews\win	.vew .ini
Library (Document Storage Area)	library_directory	.db archive\.* docs\.

To see a directory structure diagram of the domain, see Domain Directory in Troubleshooting 3: Message Flow and Directory Structure.

The GWTSA automatically time stamps all backed-up user databases (userxxx.db), so that the Allow Purge of Items Not Backed Up option described in Modifying Environment Options can function to safeguard users' deleted items against being purged from your GroupWise system before they have been backed up.

IMPORTANT: If you decide not to use the GWTSA, user databases must be manually time stamped in order for the feature to work properly. See GroupWise Backup Time Stamp Utility (GWTMSTMP).

Running GWTSA

The GWTSA is available on NetWare. The GWTSA.NLM program file is automatically installed along with the GroupWise agents (POA and MTA). If the domains and post offices to back up are located on a different server from where the agents run, you must copy the GWTSA (gwtsa.nlm), along with the agent engine (gwenn3.nlm), to the server where the data resides and run it there.

During agent installation, a gwtsa.ncf file was created in the directory where you installed the agents. By default, it provides a /home switch for each domain and post office you selected to be serviced by the MTA and POA. For example:

load sys:\system\gwtsa /home-sys:\gwsystem\dev  
     /home-sys:\gwsystem\manufac /home-sys:\gwsystem\provo1

You can add additional instances of the /home switch to back up more domains and post offices. You can also add instances of the /home switch to point to restore areas for post offices or to other temporary locations where you want to restore data.

By default, the GWTSA places temporary files in the sys:\system\temp directory during the backup process. If necessary, use the /tempdir switch to specify an alternate location where more disk space is available for temporary files. Additional configuration of the GWTSA can be done using other startup switches. See GWTSA Startup Switches for a complete list.

To start the GWTSA immediately, run the gwtsa.ncf file at the NetWare server console. To start the GWTSA automatically each time you restart the server, add a gwtsa.ncf line to the autoexec.ncf file. With the GWTSA running, you are ready to back up GroupWise data with Novell Storage Management Services or Veritos Backup Exec for NetWare.

Using the GWTSA with Your Backup Software

The GWTSA adds GroupWise options to your backup software. This section uses Novell Storage Management Services (SMS) as an example of how to integrate the GWTSA into your backup software. Similar steps would be necessary to integrate the GWTSA with other backup software.

If you plan to use the GWTSA with SMS, this section assumes that SMS has been installed and configured and is running properly. If you need assistance with SMS, refer to Backup and Restore Services for NetWare 5 on the Novell Documentation Web site and Technical Information Document 2948659.

Backing Up GroupWise Data

To back up GroupWise data using SMS with the GWTSA running:

Start sbackup.exe from the sys:\public directory of your NetWare server.

You can also use sbcon.nlm at the NetWare server console to perform the backup.
In the Quick Access dialog box, click Backup.
Expand the WHAT TO BACKUP object.

A GROUPWISE DATABASE object has been added to the list of things you can back up.
Expand the GROUPWISE DATABASE object to list GroupWise domains, post offices, and libraries that are available for backup.
After selecting the GroupWise data to back up, continue using SMS as you usually would to perform the backup.

Restoring GroupWise Data

To restore GroupWise data using SMS with the GWTSA running:

Start sbackup.exe from the sys:\public directory of your NetWare server.

You can also use sbcon.nlm at the NetWare server console to restore GroupWise data.
In the Quick Access dialog box, click Restore.
Expand the WHAT TO RESTORE object, then select your backup device.
Expand the WHERE TO RESTORE object.

A GROUPWISE DATABASE object appears on the list of things you can restore.
Expand the GROUPWISE DATABASE object to list GroupWise domains, post offices, libraries, and restore areas where data can be restored.
After selecting the GroupWise data to restore, continue using SMS as you usually would to restore data.

If you need to restore GroupWise data to an existing domain, post office, or library, make sure your backup software is configured to overwrite newer files than those that are being restored.

If you are restoring GroupWise data to a temporary location, make sure you have sufficient free disk space to accommodate the files that are being restored.

GWTSA Startup Switches

The following startup switches can be used with the GWTSA:

/home
Specifies the GroupWise location to back up or restore to. Multiple instances of the /home switch are typical. Use a /home switch for each domain and post office to back up. Also use a /home switch for each post office restore area and any other temporary location to which you want to restore GroupWise data outside the standard GroupWise directory structure.

/tempdir
Specifies where the GWTSA places its temporary files during the backup process. The default is the sys:\system\tsa\temp directory.

/log
Turns on logging and displays a logging screen. By default, logging is turned off. When you turn logging on, a gwtsa.log file is created in the sys:\system\tsa directory.

/ll
Sets the log level to determine how much information is written to the GWTSA log file. Use n for Normal and v for Verbose.