Domdsmc query logarchive

Edit online

How to use the Domdsmc query logarchive command is described.

Purpose

This command displays a list of the archived transaction log extents that are stored on the IBM Storage Protect server. By default, only the active log extents are listed. To display inactive extents, use the /inactive parameter.

Syntax

>>-DOMDSMC--Query--LOGArchive--+----------------------+--------->
                               '-/ADSMNODe=--nodename-'   

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

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

>--+---------+--+-----------+--+----------------------------+--->
   '-/DEtail-'  '-/INACTive-'  |            .-domdsm.log--. |   
                                '-/LOGFile=--+-logfilename-+-'   

>--+--------------------+--+-----------------------------+-----><
   |             .-60-. |  |           .-currentserver-. |   
   '-/LOGPRUne=--+-n--+-'  '-/SERVer=--+-servername----+-'   
                 '-No-'

Parameters

/ADSMNODe=nodename
Specifies the IBM Storage Protect node name Data Protection for IBM® Domino® uses to log on to the IBM Storage Protect server. The command-line value overrides the value in the IBM Storage Protect options file.
/ADSMOPTFile=optionsfile
Specifies the IBM Storage Protect 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 IBM Storage Protect password Data Protection for HCL Domino uses to log on to the IBM Storage Protect server. If you specify passwordaccess generate in the IBM Storage Protect options file, then the password is not required. In this case, Data Protection for HCL Domino uses the password that is stored by the IBM Storage Protect 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 requirement to 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.

/CONFIGfile=cfgfilename
Specifies the name of the Data Protection for HCL 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 HCL Domino is installed.

The default preferences file is domdsm.cfg.

/DEtail
Displays information about the backup, such as whether it is encrypted, compressed, or deduplicated.
/INACTive
Specifies that both active and inactive backup objects are displayed. The default is to display only the active backup objects.
/LOGFile=logfilename
Specifies the name of the activity log that is generated by Data Protection for HCL 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 HCL Domino is installed.

The default log file is domdsm.log.

When you are using multiple simultaneous instances of Data Protection for HCL Domino to run operations, use the /logfile parameter to specify a different log file for each instance used. Logging is directed 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:
  • 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. 60 days is the default.
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.
/SERVer=currentserver|servername
Specifies the Domino server name. If not specified, Data Protection for HCL Domino uses the current Domino server.

Examples

Example 1: The following example displays the list of archived log extents that are stored on the IBM Storage Protect server. 
domdsmc query logarchive
Output example: 
    Domino Server: chilly
    --------------

    Logger Id: OF8525679F:004266F1-ON000003EC:BD9D27DB
    ----------

                         Transaction
  Log Archive Date       Log Filename    A/I     Size
---------------------    ------------    ---    ------
01/22/2013 16:52:15      S0000001.TXN     A       64MB
Example 2: The following example displays the list of archived log extents that are stored on the IBM Storage Protect server, including inactive backup objects. This example uses a IBM Storage Protect options file named aserver.opt. 
domdsmc query logarchive /inactive /adsmoptfile=aserver.opt
Output example: 
    Domino Server: chilly
    --------------

    Logger Id: OF8525679F:004266F1-ON000003EC:BD9D27DB
    ----------

                         Transaction
  Log Archive Date       Log Filename    A/I     Size
---------------------    ------------    ---    ------
01/23/2013 09:43:16      S0000003.TXN     A       64MB
01/23/2013 09:41:22      S0000002.TXN     A       64MB
01/22/2013 16:52:15      S0000001.TXN     I       64MB
Example 3: The following example queried the IBM Storage Protect server and included the /adsmpwd parameter: 
domdsmc q loga /adsmpwd=neil
Output example: 
ACD5819I There are no archived logs for the server named SnailTrail.
Example 4: The example displays detailed information for the list of archived log extents that are stored on the IBM Storage Protect server: 
domdsmc query logarchive /detail
Output example: 
Backup Object Information
-------------------------

Domino Server Name .................. DOMINOTESTSERVER
Logger Id ........................... OF09A666BF:AACF9914-ON00000302:A048A61F
Log Archive File .................... S0000035.TXN
Log Archive Date .................... 07/22/2013 12:52:37
Log Archive Size .................... 64.00MB
Log Archive State ................... Active
Log Archive Compressed .............. Yes
Log Archive Encryption Type ......... None
Log Archive Client-deduplicated ..... Yes