34.3 GroupWise Time Stamp Utility

You can use the GroupWise Time Stamp (GWTMSTMP) utility to ensure that GroupWise user databases include the dates when they were last backed up, restored, and retained.

The following sections provide information about the utility:

34.3.1 GWTMSTMP Functionality

GWTMSTMP places date and time information on user databases (userxxx.db) in order to support message backup, restore, and retention. No other databases are affected. You can run GWTMSTMP on all user databases in a post office or on a single user database.

Backup

To ensure thorough user database backups, you can make sure that deleted items are not purged from users’ databases until they have been backed up. Two conditions must be met in order to provide this level of protection against loss of deleted items:

  • The Allow Purge of Items Not Backed Up option must be deselected in ConsoleOne, as described in Environment Options: Cleanup.

  • User databases (userxxx.db) must be time-stamped every time a backup is performed so that items can be purged only after being backed up.

If you use GWTSA on NetWare 5.1 or TSAFS on NetWare 6.x/OES or Linux to back up user databases, the backup time stamp is automatically added as part of the backup process. However, if you do not use GWTSA or TSAFS, you must use GWTMSTMP to make sure that user databases are time-stamped so that items will not be prematurely purged.

Restore

If you use the GWTSA on NetWare 5.1 or TSAFS on NetWare 6.x/OES or Linux to restore a mailbox, the restore time stamp is automatically added as part of the restore process. However, if you do not use GWTSA or TSAFS, you can use GWTMSTMP to add the restore time stamp to the database. The restore time stamp is not required for any GroupWise feature to work properly. Its primary purpose is informational.

Retention

If you use a message retention application (see Section 33.0, Retaining User Messages), the application should automatically add the retention time stamp after retaining the database’s messages. Any messages with dates that are newer than the retention time stamp cannot be purged from the database.

You can also use GWTMSTMP to manually add a retention time stamp.

34.3.2 Running GWTMSTMP on NetWare

The GWTMSTMP program (gwtmstmp.nlm) is installed into the same directory where you installed the GroupWise agents (POA and MTA). You can copy it to additional locations if needed.

To check the existing time stamp on all GroupWise user databases in a post office, use the following command:

Syntax:
gwtmstmp.nlm /p-volume:\post_office_directory
Example:
gwtmstmp.nlm /p-sys:\gwsystem\dev

The results are written to the console.log file.

To set a current time stamp on all user databases in a post office, use the following command:

Syntax:
gwtmstmp.nlm /p-volume:\post_office_directory /set
Example:
gwtmstmp.nlm /p-sys:\gwsystem\dev /set

A basic backup time stamp can also be set in ConsoleOne. Select a Post Office object, then click Tools > GroupWise Utilities > Backup/Restore Mailbox. On the Backup tab, select Backup, then click Yes.

More specialized functionality is provided through additional GWTMSTMP startup switches. See Section 34.3.5, GWTMSTMP Startup Switches.

34.3.3 Running GWTMSTMP on Linux

The GWTMSTMP executable (gwtmstmp) is installed into the bin and lib subdirectories of /opt/novell/groupwise/agents along with the GroupWise agents (POA and MTA). You can copy it to additional locations if needed.

To check the existing time stamp on all GroupWise user databases in a post office, use the following command:

Syntax:
./gwtmstmp -p /post_office_directory
Example:
./gwtmstmp -p /gwsystem/acct

The results are displayed on the screen.

To set a current time stamp on all user databases in a post office, use the following command:

Syntax:
./gwtmstmp -p /post_office_directory --set
Example:
./gwtmstmp -p /gwsystem/acct --set

A basic backup time stamp can also be set in ConsoleOne. Select a Post Office object, then click Tools > GroupWise Utilities > Backup/Restore Mailbox. On the Backup tab, select Backup, then click Yes.

More specialized functionality is provided through additional GWTMSTMP startup switches. See Section 34.3.5, GWTMSTMP Startup Switches.

34.3.4 Running GWTMSTMP on Windows

The GWTMSTMP program file (gwtmstmp.exe) is installed into the same directory where you installed the GroupWise agents (POA and MTA). You can copy it to additional locations if needed.

To check the existing time stamp on all GroupWise user databases in a post office, use the following command:

Syntax:
gwtmstmp.exe /p-drive:\post_office_directory
Example:
gwtmstmp.exe /p-m:\gwsystem\acct

The results are displayed on the screen

To set a current time stamp on all user databases in a post office, use the following command:

Syntax:
gwtmstmp.exe /p-drive:\post_office_directory /set
Example:

gwtmstmp.exe /p-m:\gwsystem\acct /set

A basic backup time stamp can also be set in ConsoleOne. Select a Post Office object, then click Tools > GroupWise Utilities > Backup/Restore Mailbox. On the Backup tab, select Backup, then click Yes.

More specialized functionality is provided through additional GWTMSTMP startup switches.

34.3.5 GWTMSTMP Startup Switches

The following startup switches can be used with GWTMSTMP:

/p

Specifies the post office directory where the user databases to time-stamp are located. This switch is required.

NetWare GWTMSTMP

Linux GWTMSTMP

Windows GWTMSTMP

Syntax:

/p-volume:\post_office_dir

-p /post_office_dir

/p-drive:\post_office_dir

Example:

/p-mail:\dev

-p /gwsystem/dev

/p-j:\dev

/backup, /restore, and /retention

Specifies the time stamp on which to perform the operation. If no time stamp is specified, the operation is performed on the backup time stamp.

NetWare GWTMSTMP

Linux GWTMSTMP

Windows GWTMSTMP

Syntax:

/backup /restore /retention

-b --backup -r --restore -n --retention

/backup /restore /retention

For example, to set the restore time stamp, you would use:

NetWare:

gwtmstmp /p-j:\dev /restore /set

Linux:

./gwtmstmp -p /gwsystem/dev -r -s

Windows:

gwtmstmp /p-j:\dev /restore /set

/get

Lists existing backup, restore, and retention time stamp information for user databases. If no time stamps are set, no times are displayed.

NetWare GWTMSTMP

Linux GWTMSTMP

Windows GWTMSTMP

Syntax:

/get

-g --get

/get

For example:

NetWare:

gwtmstmp /p-j:\dev /get

Linux:

./gwtmstmp -p /gwsystem/dev -g

Windows:

gwtmstmp /p-j:\dev /get

If no other operational switch is used, /get is assumed. The following example returns the same results as the above example:

NetWare:

gwtmstmp /p-j:\dev

Linux:

./gwtmstmp -p /gwsystem/dev

Windows:

gwtmstmp /p-j:\dev

/set

Sets the current date and time on user databases.

NetWare GWTMSTMP

Linux GWTMSTMP

Windows GWTMSTMP

Syntax:

/set

-s --set

/set

For example, to set the backup time stamp, you would use:

NetWare:

gwtmstmp /p-j:\dev /backup /set

Linux:

./gwtmstmp -p /gwsystem/dev -b -s

Windows:

gwtmstmp /p-j:\dev /backup /set

or

NetWare:

gwtmstmp /p-j:\dev /set

Linux:

./gwtmstmp -p /gwsystem/dev -s

Windows:

gwtmstmp /p-j:\dev /set

-c, --clear

Clears existing time stamps.

NetWare GWTMSTMP

Linux GWTMSTMP

Windows GWTMSTMP

Syntax:

/clear

-c --clear

/clear

For example, to clear all time stamps on databases in a post office, you would use:

NetWare:

gwtmstmp /p-j:\dev /clear

Linux:

./gwtmstmp -p /gwsystem/dev -c

Windows:

gwtmstmp /p-j:\dev /clear

/date

Specifies the date that you want placed on user databases.

NetWare GWTMSTMP

Linux GWTMSTMP

Windows GWTMSTMP

Syntax:

/date-mm/dd/yyyy

-d mm/dd/yyyy --date mm/dd/yyyy

/date-mm/dd/yyyy

Example:

/date-01/03/2007

-d 05/18/2007 --date 05/18/2007

/date-04/12/2007

For example, to set the restore date to June 15, 2007, you would use:

NetWare:

gwtmstmp /p-j:\dev /restore /date-06/14/2007

Linux:

./gwtmstmp -p /gwsystem/dev --restore --date 06/15/2007

Windows:

gwtmstmp /p-j:\dev /restore /date-06/14/2007

/time

Specifies the time that you want placed on user databases.

NetWare GWTMSTMP

Linux GWTMSTMP

Windows GWTMSTMP

Syntax:

/time-hh:mm am|pm

-t hh:mm am|pm --time hh:mm am|pm

/time-hh:mm am|pm

Example:

/time-11:30pm

-t 2:00am --time 2:00am

/time-6:15pm

For example, to set the restore time to 4:45 p.m., you would use:

NetWare:

gwtmstmp /p-j:\dev /restore /time-4:45pm

Linux:

./gwtmstmp -p /gwsystem/dev -r -t 4:45pm

Windows:

gwtmstmp /p-j:\dev /restore /time-4:45pm

/u

Provides a specific GroupWise user ID so that an individual user database can be time-stamped.

NetWare GWTMSTMP

Linux GWTMSTMP

Windows GWTMSTMP

Syntax:

/u-userID

-u userID --userid userID

/u-userID

Example:

/u-khuang

-u sjones --userid gsmith

/u-mbarnard

For example, to set the retention time stamp for a user whose GroupWise user ID is mpalu, you would use:

NetWare:

gwtmstmp /p-j:\dev /u-mpalu /retention /set

Linux:

./gwtmstmp -p /gwsystem/dev -u mpalu -n -s

Windows:

gwtmstmp /p-j:\dev /u-mpalu /retention /set

-e, --userdb

Provides a specific GroupWise user database (userxxx.db) so that an individual user database can be time-stamped.

NetWare GWTMSTMP

Linux GWTMSTMP

Windows GWTMSTMP

Syntax:

/userdb user_database

-e user_database --userdb user_database

/userdb user_database

Example:

/userdb user3gh.db

-e user3gh.db --userdb user3gh.db

/userdb user3gh.db

For example, to set the retention time stamp for a user whose user database is named user3gh, you would use:

NetWare:

gwtmstmp /p-j:\dev /userdb user3gh.db /retention /set

Linux:

./gwtmstmp -p /gwsystem/dev -e user3gh.db -n -s

Windows:

gwtmstmp /p-j:\dev /userdb user3gh.db /retention /set