Domdsmc query DB2backup

How to use the domdsmc query db2backup command is described.

Purpose

domdsmc query db2backup lists DB2® backup objects.

Syntax


>>-DOMDSMC--Query -DB2Backup--+-*------------+------------------>
                              | .-,--------. |   
                              | V          | |   
                              '---db2group-+-'   

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

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

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

>--+---------------------------------+--+---------+------------->
   '-/DB2DATAbase=--db2database name-'  '-/DEtail-'   

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

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

Parameters

*|db2group,db2group,...
Specifies the DB2 Group to query.
/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 Tivoli Storage Manager options file, then the password is not required. In this case, Data Protection for HCL 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 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.

/DB2DATAbase=database name
Specify the name of the alternate DB2 database to use for restore. If the db2altdbname parameter is not specified, the configuration option db2altdbname is used.
/DEtail
Specify whether to display a detailed output of the DB2 Groups and databases that are contained in the backup images.
/FULL
Specify whether a full DB2 database backup image is queried.
/INACTive
Specify that both active and inactive backup objects are displayed. The default value is to display only the active backup objects.
/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 HCL 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 used. This 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:
  • 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 IBM Domino uses the current Domino server.

Examples

Example 1: The following example queries a list of active and inactive DB2 Group backups:

domdsmc query db2backup * /inactive

Output example:

    Domino Server: domino7     DB2 Database Name: DOMINO
    --------------             ------------------

  Group Backup Date          Size      A/I  Type   Class         Group(TID)
  -----------------          ----      ---  ----   ---------     ----------
  01.08.2008 14:46:40       162.00B     A    T     DEFAULT       GRP1(6)
  01.08.2008 14:44:37       166.00B     A    T     DEFAULT       GRP2(8)

Example 2: The following example queries (and displays) a list of active DB2 Group backups and the DB2 enabled Notes® databases that are contained within the DB2 Group backup:

domdsmc query db2backup * /detail

Output example:

    Domino Server: domino7     DB2 Database Name: DOMINO
    --------------             ------------------

  Group Backup Date          Size      A/I  Type   DB2 Group     Group Name
  -----------------          ----      ---  ----   ---------     ----------
  01.08.2008 11:46:52       160.00B     A    T      DEFAULT       GRP2

                             Size      Database Title   Database File
                             ----      --------------   -------------
                            160.00B    db2 nsf 1        ab2nsf1.nsf
                            160.00B    db2 nsf 2        db2b.nsf
                            160.00B    db2 nsf 1        db2g.nsf
                            160.00B    db2 nsf 1        xb2nsf1.nsf

Example 3: The following example queries a full DB2 database backup and the DB2 Groups and DB2 enabled Notes databases that are contained within the full DB2 database backup:

domdsmc query db2backup * /detail /full

Output example:

    Domino Server: domino7     DB2 Database Name: DOMINO
    --------------             ------------------

  Group Backup Date          Size      A/I  Type   Class         Group(TID)
  -----------------          ----      ---  ----   ---------     ----------
  01.08.2008 14:46:40       162.00B     A    T     DEFAULT       GRP1(6)

                             Size      Database Title   Database File
                             ----      --------------   -------------
                            162.00B    db2 nsf 1        db1.nsf
                            162.00B    db2 nsf 2        db2a.nsf
                            162.00B    db2 nsf 1        db2c.nsf
                            162.00B    db2 nsf 1        db2e.nsf

  Group Backup Date          Size      A/I  Type   Class         Group(TID)
  -----------------          ----      ---  ----   ---------     ----------
  01.08.2008 14:44:37       166.00B     A    T     DEFAULT       GRP2(8)

                             Size      Database Title   Database File
                             ----      --------------   -------------
                            166.00B    db2 nsf 1        ab2nsf1.nsf
                            166.00B    db2 nsf 2        db2b.nsf
                            166.00B    db2 nsf 1        db2g.nsf
                            166.00B    db2 nsf 1        xb2nsf1.nsf