gwtmstmp (1)

Name

gwtmstmp - GroupWise Time Stamp utility.

Syntax

gwtmstmp --postpath post_office_directory [--set] [--get] [--clear] [--backup] [--restore] [--retention] [--date mm/dd/yyyy] [--time hh:mm[am|pm]] [--gmttime seconds] [--userid GroupWise_userID] [--userdb user_database] 

Description

The GroupWise Time Stamp utility (GWTMSTMP) places a time stamp on a GroupWise user database to indicate the last time the database was backed up. If a user deletes an item from his or her mailbox and purges it from the Trash, the item is removed from the user’s database only if the time stamp shows that the item has already been backed up. Otherwise, the item remains in the user’s database until the database is backed up, at which time it is purged from the database.

The GroupWise Time Stamp utility 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 the GroupWise Time Stamp utility 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 for the post office in ConsoleOne (Tools > GroupWise Utilities > Client Options > Environment > Cleanup).

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

Restore

You can use the GroupWise Time Stamp utility to manually 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, 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 use the GroupWise Time Stamp utility to manually add a retention time stamp.

Options

Usage Options:

--postpath /post_office_directory , -p /post_office_directory

(Required) Specifies the full path to the post office directory where the user databases to time-stamp are located.

--set , -s

Sets the current date and time (of backup, restore, or retention) on user databases.

--get , -g

Lists existing backup, restore, and retention time stamp information for user databases. If no time stamps are set, “unknown” is displayed. If no other operational switch is used, --get is assumed.

--clear , -c

Removes time stamps (of backup, restore, or retention) from user databases.

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

Specifies the type of time stamp (backup, restore, or retention) on which to perform the get or set operation. If no time stamp type is specified, the operation is performed on the backup time stamp. Multiple time stamp types can be specified together.

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

Specifies the date that you want placed on user databases. Use the format mm/dd/yyyy; for example, 05/18/2010 for May 18, 2010. If no date is specified, the current date is used. If your locale does not use the mm/dd/yyyy format, use gwtmstmp --help to determine the format for your locale.

--time hh:mm[am|pm] , -t hh:mm[am|pm]

Specifies the time that you want placed on user databases. Use the format hh:mm, expressed in a 24-hour format (for example, 20:45) or expressed with the am or pm option (for example, 8:45pm. If no time is specified, 00:00 is used.

--gmttime seconds , -m seconds

Specifies the number of seconds since midnight on January 1, 1970 GMT that you want placed on the user databases.

--userid username , -u username

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

--userdb user_database , -e user_database

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

Help Options:

--help , -?

Displays the help information and exits.

Examples

This program normally runs as root.

/opt/novell/groupwise/agents/bin/gwtmstmp -p /gwsystem/acct

Checks the existing time stamp on all GroupWise user databases in a post office.

/opt/novell/groupwise/agents/bin/gwtmstmp -p /gwsystem/acct --set

Set a current time stamp on all user databases in a post office.

Diagnostics

For information about GroupWise Time Stamp utility error messages, see Troubleshooting 1: Error Messages.

Authors

Copyright 2004-2010, Novell, Inc.. All rights reserved.

See Also

dbcopy (1).

To report problems with this software or its documentation, visit Novell Bugzilla..