Novell Doc: GroupWise 2012 Administration Guide - GroupWise Time Stamp Utility

34.2 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.2.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 Do Not Purge Items Until They Are Backed Up option must be selected 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.

Restore

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, as described in 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.

Modified Retention

If you use a message retention application, you might need to retain items more than once if you want to capture changes to personal subjects and personal attachments on items. You can use GWTMSTMP to manually update the retention time stamp on modified items, so that they are retained again.

34.2.2 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.2.4, GWTMSTMP Startup Switches.

To remind yourself of these options when you are at your Linux server, view the gwtmstmp man page.

34.2.3 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

More specialized functionality is provided through additional GWTMSTMP startup switches.

34.2.4 GWTMSTMP Startup Switches

The following startup switches can be used with GWTMSTMP:

Linux GWTMSTMP	Windows GWTMSTMP
-p	/p
--backup or -b	/backup
--restore or -r	/restore
--retention or - n	/retention
--modifiedretention or -mn	/modifiedretention
--get or -g	/get
--set or -s	/set
--clear or -c	/clear
--date or -d	/date
--time or -t	/time
--gmttime or -m	/gmttime
--userid or -u	/u
--userdb or -e	/userdb

-p

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

	Linux GWTMSTMP	Windows GWTMSTMP
Syntax:	-p /post_office_dir	/p-drive:\post_office_dir
Example:	-p /gwsystem/dev	/p-j:\dev

--backup, --restore, --retention, and --modifiedretention

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

	Linux GWTMSTMP	Windows GWTMSTMP
Syntax:	--backup -b --restore -r --retention -n --modifiedretention -mn	/backup /restore /retention /modifiedretention

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

Linux:	./gwtmstmp -p /gwsystem/dev --restore --set
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.

	Linux GWTMSTMP	Windows GWTMSTMP
Syntax:	--get -g	/get

For example:

Linux:	./gwtmstmp -p /gwsystem/dev --get
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:

Linux:	./gwtmstmp -p /gwsystem/dev
Windows:	gwtmstmp /p-j:\dev

--set

Sets the current date and time on user databases.

	Linux GWTMSTMP	Windows GWTMSTMP
Syntax:	--set -s	/set

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

Linux:	./gwtmstmp -p /gwsystem/dev --backup --set
Windows:	gwtmstmp /p-j:\dev /backup /set

Linux:	./gwtmstmp -p /gwsystem/dev --set
Windows:	gwtmstmp /p-j:\dev /set

--clear

Clears existing time stamps.

	Linux GWTMSTMP	Windows GWTMSTMP
Syntax:	--clear -c	/clear

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

Linux:	./gwtmstmp -p /gwsystem/dev --clear
Windows:	gwtmstmp /p-j:\dev /clear

--date

Specifies the date that you want placed on user databases.

	Linux GWTMSTMP	Windows GWTMSTMP
Syntax:	--date mm/dd/yyyy -d mm/dd/yyyy	/date-mm/dd/yyyy
Example:	--date 05/18/2012 -d 05/18/2012	/date-04/12/2012

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

Linux:	./gwtmstmp -p /gwsystem/dev --restore --date 06/15/2012
Windows:	gwtmstmp /p-j:\dev /restore /date-06/14/2012

--time

Specifies the time that you want placed on user databases.

	Linux GWTMSTMP	Windows GWTMSTMP
Syntax:	--time hh:mm am\|pm -t hh:mm am\|pm	/time-hh:mm am\|pm
Example:	--time 2:00am -t 2:00am	/time-6:15pm

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

Linux:	./gwtmstmp -p /gwsystem/dev --restore --time 4:45pm
Windows:	gwtmstmp /p-j:\dev /restore /time-4:45pm

--gmttime

Specifies the time in seconds since January 1, 1970, Greenwich Mean Time (GMT), that you want placed on user databases.

	Linux GWTMSTMP	Windows GWTMSTMP
Syntax:	--gmttime seconds -m seconds	/gmttime-seconds

--userid

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

	Linux GWTMSTMP	Windows GWTMSTMP
Syntax:	--userid userID -u userID	/u-userID
Example:	---userid gsmith -u gsmith	/u-mbarnard

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

Linux:	./gwtmstmp -p /gwsystem/dev --userid mpalu --retention --set
Windows:	gwtmstmp /p-j:\dev /u-mpalu /retention /set

--userdb

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

	Linux GWTMSTMP	Windows GWTMSTMP
Syntax:	--userdb user_database -e user_database	/userdb user_database
Example:	--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:

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