IBM Tivoli Storage Manager for Mail, Data Protection for IBM Domino, Version 7.1

Domdsmc restorelogarchive

How to use the domdsmc restorelogarchive command is described.

Purpose

Domdsmc restorelogarchive restores archived transaction logs from Tivoli® Storage Manager storage to the Domino® server. This command assists with disaster recovery operations. By retrieving the most recent archived log file, it is possible to rebuild the Domino transaction log control file. In this way archived transaction log files can be used to recover restored database backups to a more current state, even after a loss of the active transaction log.

When you are restoring a transaction log file from an old Logger ID during an alternate server or alternate partition restore procedure, you must specify the /pick parameter with the restorelogarchive command to choose the log extent. For more information see NSF databases restore to alternate server and alternate partition.

For more information on disaster recovery procedures, see Recovering from loss of Domino transaction logs for NSF databases.

Read syntax diagramSkip visual syntax diagram
                               .-lastarchivedlogfile-.   
>>-DOMDSMC--RESTORELOGArchive--+---------------------+---------->
                               | .-,-------.         |   
                               | V         |         |   
                               '---logname-+---------'   

>--+----------------------+------------------------------------->
   '-/ADSMNODe=--nodename-'   

>--+--------------------------------+--------------------------->
   |                .-dsm.opt-----. |   
   '-/ADSMOPTFile=--+-optionsfile-+-'   

>--+---------------------+-------------------------------------->
   '-/ADSMPWD=--password-'   

>--+--------------------------------------------+--------------->
   |            .-3----------.  .-,1024-------. |   
   '-/BUFFers=--+-numbuffers-+--+-,buffersize-+-'   

>--+-------------------------------+---------------------------->
   |               .-domdsm.cfg--. |   
   '-/CONFIGfile=--+-cfgfilename-+-'   

>--+------------------------------+----------------------------->
   |             .-translogpath-. |   
   '-/INTOPath=--+-pathname-----+-'   

>--+----------------------------+--+--------------------+------->
   |            .-domdsm.log--. |  |             .-60-. |   
   '-/LOGFile=--+-logfilename-+-'  '-/LOGPRUne=--+-n--+-'   
                                                 '-No-'     

>--+----------------------+--+------------------------+--------->
   |              .-Yes-. |  |         .-SHOWACtive-. |   
   '-/MOUNTWait=--+-No--+-'  '-/PICk=--+-SHOWALl----+-'   

>--+--------+--+--------------------+--------------------------->
   '-/Quiet-'  |            .-Yes-. |   
               '-/REPlace=--+-No--+-'   

>--+-----------------------------+-----------------------------><
   |           .-currentserver-. |   
   '-/SERVer=--+-servername----+-'   

Parameters

logname,...,logname
The logname optional parameter specifies the logname of the archived transaction log to be restored. Multiple lognames can be specified as long as they are separated with commas. Use the wildcard character (*) to specify a group of files when used in logname.

When a logname is not specified with the restorelogarchive command, the last transaction log archived to the Tivoli Storage Manager server (that is still active on the Tivoli Storage Manager server) is restored. The lastarchivedlogfile variable shown in the syntax diagram represents the default behavior and is not a keyword that can be specified on the command line.

To restore an inactive transaction log file from the Tivoli Storage Manager server, use the /pick=showall parameter and select the desired file from the list.

/ADSMNODe=nodename
Specifies the Tivoli Storage Manager node name Data Protection for IBM® Domino uses to log on to the Tivoli Storage Manager server. The command-line value overrides the value in the Tivoli Storage Manager options file.
/ADSMOPTFile=optionsfile
Specifies the Tivoli Storage Manager options file name. The file name can include a fully qualified path name. If you do not specify a path, the installation directory and then the current directory are searched for the specified file. The default is dsm.opt.
/ADSMPWD=password
Specifies the Tivoli Storage Manager password Data Protection for IBM Domino uses to logon to the Tivoli Storage Manager server. If you specify passwordaccessgenerate in the Tivoli Storage Manager options file, then the password is not required. In this case, Data Protection for IBM Domino uses the password that is stored by the Tivoli Storage Manager API.

If passwordaccess is set to generate and you specify a password, the value is ignored unless a password for this node is not stored. In this case, the specified password is stored and used for the current command execution.

If passwordaccess is set to prompt and you specify a password on the command line, you are not prompted for a password. The command-line value overrides the prompt.

If passwordaccess is set to prompt and you do not specify a password on the command line, then you are prompted for a password.

/BUFFers=numbuffers, buffersize
Specifies the number and size of data buffers that transfer data between the Domino server and the Tivoli Storage Manager API. Increasing the number or size (or both) of the data buffers can improve throughput.

You can specify 2 - 8 buffers. The default value is 3. The size of the buffers can be 64 - 8192 kb. The default value is 1024.

If the /buffers parameter is not specified on the command line or defined in the preferences file, Data Protection for IBM Domino uses the default values.

/CONFIGfile=cfgfilename
Specifies the name of the Data Protection for IBM Domino preferences file. The file name can include a fully qualified path. If you do not specify a path, it is assumed the preferences file in the directory where Data Protection for IBM Domino is installed.

The default preferences file is domdsm.cfg.

/INTOPath=translogpath|pathname
Specifies the file path that is used for the restored transaction logs. The file path must be a fully qualified physical path. The translogpath variable that is shown in the syntax diagram represents the default location of the Domino server transaction log files and is not a keyword that can be specified on the command line. The default location of the Domino server transaction log files is defined by the TRANSLOG_Path variable in the notes.ini file.
/LOGFile=logfilename
Specifies the name of the activity log that is generated by Data Protection for IBM Domino. The log file name is used for the current command and does not update the default log file that is stored in the preferences file. You can use the set command to change the default log file name that is stored in the preferences file. The command-line parameter can be used to override the default for one command run. If the specified file does not exist, it is created. If it does exist, new log entries are appended to the file. The file name can include a fully qualified path. If you do not specify a path, the file is written to the directory where Data Protection for IBM Domino is installed.

The default log file is domdsm.log.

When you are using multiple simultaneous instances of Data Protection for IBM Domino to run operations, use the /logfile parameter to specify a different log file for each instance. Using this parameter directs logging for each instance to a different log file and prevents interspersed log file records. Failure to specify a different log file for each instance can result in unreadable log files.

/LOGPRUne=60|n|No
Specifies whether to prune log entries. By default, log pruning is enabled and done daily. You can use the set command to do one of the following actions:
  • Change the defaults so that log pruning is disabled
  • Change the number of days log entries are saved
You can use the /logprune option to override these defaults for one command run. Note, when the value of /logprune is a number, the prune is done even if one is complete for the day.
You can specify:
60
Specifies that log entries are saved for 60 days before pruning.
n
Specifies the number of days to save log entries. The range of values is 0 - 9999. A value of 0 deletes all entries in the log except for the current command run entries.
No
Do not prune the log.
Changes to the value of the timeformat or dateformat parameter can result in an undesired pruning of the log file. If you are running a command that prunes the log file and the value of the timeformat or dateformat parameter changes, run one of the following to prevent pruning of the log file:
  • Make a copy of the existing log file.
  • Specify a new log file with the /logfile parameter or logfile setting.
/MOUNTWait=Yes|No
If the Tivoli Storage Manager server is configured to store transaction log backup data on removable media, then the Tivoli Storage Manager server can indicate to Data Protection for IBM Domino that it is waiting for a required storage volume to be mounted. In this case, you can specify whether Data Protection for IBM Domino waits for the media mount or stops the current operation. Removable media is media such as tapes.
You can specify:
Yes
Wait for tape mounts. This value is the default.
No
Do not wait for tape mounts.
/PICk=SHOWACtive|SHOWALl
Displays a list of database backups that match the dbname pattern that can be selected for restore. The pick list is displayed as a scrollable list from which you can select the database backups for restore.
You can specify:
SHOWACtive
Displays a list of active database backup versions.
SHOWALl
Displays a list of both active and inactive database backup versions. All the backup versions that match the dbname pattern are shown.
/Quiet
Specifies that status information does not display. However, the information is written to the activity log.
/REPlace=Yes|No
Specifies whether to replace existing databases on the target system.
You can specify:
Yes
Allows an existing database on the target system to be replaced during the restore process.
No
Prevents an existing database on the target system from being overwritten during the restore process.
/SERVer=currentserver|servername
Specifies the Domino server name. If not specified, Data Protection for IBM Domino uses the current Domino server.

Example

The following example restores the last transaction log archived to the Tivoli Storage Manager server.
domdsmc restorelogarchive /intopath=c:\restoredLogs
Output Example:
Starting transaction log file restore...

Initializing Domino connection...
Logging on to the Tivoli Storage Manager server, please wait...
Querying Tivoli Storage Manager server for a list of transaction log file archives, please wait...


Restoring transaction log file S0000524.TXN
to c:\restoredLogs\S0000524.TXN
Full: 0 Read: 67,109,888 Written: 67,109,888 Rate: 2,326.56 Kb/Sec
Restore of S0000524.TXN completed successfully.


Total transaction log file archives inspected: 27
Total transaction log file archives requested for restore: 1
Total transaction log file archives restored: 1

Throughput rate: 2,326.40 Kb/Sec
Total bytes transferred: 67,109,888
Total LanFree bytes transferred: 0
Elapsed processing time: 28.17 Secs


Feedback