Domdsmc help

Edit online

How to use the domdsmc help command is described.

Purpose

The domdsmc help command provides online help for domdsmc. Running domdsmc help returns a list of commands and their parameters.

                      .-"*"---------.  .-"*"--------.   
>>-DOMDSMC--+-?----+--+-+---------+-+--+-+--------+-+----------><
            '-HELP-'    '-cmdname-'      '-subcmd-'

Parameters

"*"|cmdname
Identifies the specific Data Protection for HCL Domino command that is to be displayed. If the wildcard character * is used, help for all Data Protection for HCL Domino commands is displayed. If you do not specify a command name, asterisk (*) is the default.

The valid command names are shown here:

  ACTIVatedbs
  ARCHivelog
  CHANGEADSMPwd
  DB2ACTivatedbs
  DB2ARCHivelog
  DB2DELetealternate
  DB2INActivateobjs
  DB2RESTore
  DB2ROLLforward
  DB2Selective
  FULLSelective
  HELP
  INACTivatelogs
  Incremental
  Query
  RESETdatabase
  RESTore
  RESTORELOGArchive
  SELective
  SET
  UPDATEDB2Pwd
"*"|subcmd
Help can be displayed for commands that have several subcommands, for example, the query commands. If you do not specify a subcommand or the wildcard character asterisk *, then help for all Data Protection for HCL Domino query commands is displayed.

The valid subcommand names for the query commands are shown in the following list:

  Adsmserver
  DBBackup
  DB2Backup
  DB2Pendingdbs
  DB2ROLLforward
  DOMino
  LOGArchive
  PENDingdbs
  PREFerences

Examples

Example 1: The command domdsmc or domdsmc help "*" provides information about the syntax of all the commands.

Output example:

Choose from the following commands:

DOMDSMC ACTIVatedbs
  [/ADSMNODe=nodename]
  [/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
  [/ADSMPWD=password]
  [/APPLYLogs=date[,time]] (default: currentdate,currenttime)
  [/BUFFers=numbuffers[,buffersize]] (default: 3,1024)
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)
  [/MOUNTWait=Yes|No] (default: Yes)
  [/PICk]
  [/Quiet]

DOMDSMC ARCHivelog
  [/ADSMNODe=nodename]
  [/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
  [/ADSMPWD=password]
  [/BUFFers=numbuffers[,buffersize]] (default: 3,1024)
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)
  [/MOUNTWait=Yes|No] (default: Yes)
  [/Quiet]
  [/THRESHold=highvalue[,lowvalue]]

DOMDSMC CHANGEADSMPwd [oldpw [newpw [verifypw]]]
  [/ADSMNODe=nodename]
  [/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)

DOMDSMC DB2ACTivatedbs dbname[dbname,...]
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/DB2ALtdbnames=db2database] (default: DOM_ALT)
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/INTO=filename]
  [/ISOLATE]
  [/LOCKGroup]
  [/LOGPRUne=60|n|No] (default: 60)
  [/PICk=[SHOWAl]]
  [/REPlace=Yes|No] (default: Yes)
  [/Quiet]

DOMDSMC DB2ARCHivelog
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)
  [/Quiet]

DOMDSMC DB2DELetealternate db2database
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)

DOMDSMC DB2INActivateobjs
  [/ADSMNODe=nodename]
  [/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
  [/ADSMPWD=password]
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)
  [/Quiet]
  [/SERVer=currentserver|servername]

DOMDSMC DB2RESTore db2group[,db2group,...]
  [/ADSMNODe=nodename]
  [/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
  [/ADSMPWD=password]
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/DB2ALtdbname=db2datbase] (default: DOM_ALT)
  [/DB2DATAbase=db2database]
  [/DB2CONTainerpath=path]
  [/DB2LOGPath=path]
  [/DB2REPlace=Yes|No] (default;Yes)
  [/DB2RESTIntopath=path]
  [/DB2SESSIONS=numsessions] (default: 1)
  [/FULL]
  [/INPlace]
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)
  [/PICk=SHOWACtive|SHOWALl] (default: SHOWACtive)
  [/PIT=date[,time]] (default: currentdate,currenttime)
  [/Quiet]
  [/SERVer=currentserver|servername]

DOMDSMC DB2ROLLforward db2database
  [/APPLYLogs=date[,time]]
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)
  [/PICk=[SHOWALl]]
  [/Quiet]

DOMDSMC DB2Selective db2group[,db2group,...]
  [/ADSMNODe=nodename]
  [/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
  [/ADSMPWD=password]
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/DB2SESSIONS=numsessions] (default: 1)
  [/FULL]
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)
  [/Quiet]

DOMDSMC FULLSelective
  [/ADSMNODe=nodename]
  [/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
  [/ADSMPWD=password]
  [/BUFFers=numbuffers[,buffersize]] (default: 3,1024)
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/DB2SESSions=numsessions (default: 1)
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)
  [/MOUNTWait=Yes|No] (default: Yes)
  [/Quiet]
  [/SESSions=numsessions (default: 1)

DOMDSMC HELP|? [*|command] [*|subcmd]
Valid command names :        Valid subcmds :
   ACTIVatedbs                  Adsmserver
   ARCHivelog                   DBBackup
   CHANGEADSMPwd                DB2Backup
   DB2ACTivatedbs               DB2Pendingdbs
   DB2ARCHivelog                DB2ROLLforward
   DB2DELetealternate           DOMino
   DB2INActivateobjs            LOGArchive
   DB2RESTore                   PENDingdbs
   DB2ROLLforward               PREFerences
   DB2Selective
   FULLSelective
   HELP
   INACTivatelogs
   Incremental
   Query
   RESETdatabase
   RESTore
   RESTORELOGArchive
   Selective
   SET

DOMDSMC INACTivatelogs
  [/ADSMNODe=nodename]
  [/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
  [/ADSMPWD=password]
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)
  [/Quiet]
  [/SERVer=currentserver|servername]

DOMDSMC Incremental dbname[,dbname,...]
  [/ADSMNODe=nodename]
  [/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
  [/ADSMPWD=password]
  [/BUFFers=numbuffers[,buffersize]] (default: 3,1024)
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)
  [/MOUNTWait=Yes|No] (default: Yes)
  [/Quiet]
  [/SUBDir=No|Yes] (default: No)
  [/SESSions=numsessions (default: 1)

DOMDSMC Query Adsmserver
  [/ADSMNODe=nodename]
  [/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
  [/ADSMPWD=password]
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)

DOMDSMC Query DBBackup *|dbname
  [/ADSMNODe=nodename]
  [/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
  [/ADSMPWD=password]
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/DEtail]
  [/INACTive]
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)
  [/SERVer=currentserver|servername]
  [/SUBDir=No|Yes]  (default: No)

DOMDSMC Query DB2Backup *|db2group
  [/ADSMNODe=nodename]
  [/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
  [/ADSMPWD=password]
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/DB2DATAbase=db2database]
  [/DEtail]
  [/FULL]
  [/INACTive]
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)
  [/SERVer=currentserver|servername]

DOMDSMC Query DB2Pendingdbs
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)

DOMDSMC Query DB2ROLLforward
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)

DOMDSMC Query DOMino [*|dbname]
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)
  [/SUBDir=No|Yes] (default: No)
  [/TYpe=All|Nsf|Db2] (default: All)

DOMDSMC Query LOGArchive
  [/ADSMNODe=nodename]
  [/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
  [/ADSMPWD=password]
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/DEtail]
  [/INACTive]
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)
  [/SERVer=currentserver|servername]
  [/FROMDate=date]
  [/TODate=date]

DOMDSMC Query PENDingdbs
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)

DOMDSMC Query PREFerences
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)

DOMDSMC RESETdatabase [dbname|dbname,...]
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)

DOMDSMC RESTore dbname[,dbname,...]
  [/ACTIVate=No|Yes] (default: No)
  [/ADSMNODe=nodename]
  [/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
  [/ADSMPWD=password]
  [/BUFFers=numbuffers[,buffersize]] (default: 3,1024)
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/INTO=filename]
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)
  [/MOUNTWait=Yes|No] (default: Yes)
  [/PICk=SHOWACtive|SHOWALl] (default: SHOWACtive)
  [/PIT=date[,time]] (default: currentdate,currenttime)
  [/Quiet]
  [/REPlace=Yes|No]  (default: Yes)
  [/SERVer=currentserver|servername]
  [/SUBDir=No|Yes] (default: No)

DOMDSMC RESTORELOGArchive [logname[,logname,...]] (default: 'last')
  [/ADSMNODe=nodename]
  [/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
  [/ADSMPWD=password]
  [/BUFFers=numbuffers[,buffersize]] (default: 3,1024)
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/INTOPath=pathname]
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)
  [/MOUNTWait=Yes|No] (default: Yes)
  [/PICk=SHOWACtive|SHOWALl] (default: SHOWACtive)
  [/Quiet]
  [/REPlace=Yes|No]  (default: Yes)
  [/SERVer=currentserver|servername]
  [/FROMDate=date]
  [/TODate=date]

DOMDSMC Selective dbname[,dbname,...]
  [/ADSMNODe=nodename]
  [/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
  [/ADSMPWD=password]
  [/BUFFers=numbuffers[,buffersize]] (default: 3,1024)
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGGedonly]
  [/LOGPRUne=60|n|No] (default: 60)
  [/MOUNTWait=Yes|No] (default: Yes)
  [/Quiet]
  [/SESSions=numsessions (default: 1)
  [/SUBDir=No|Yes] (default:No)

DOMDSMC SET PARMname=value
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)

  where PARMname and default values are:
     ADSMLOGDir=
     ADSMOPTFile=
     BUFFers=3  (2..8)
     BUFFERSIze=1024  (64..8192)
     DATEformat=
       0    locale-specified
       1    MM/DD/YYYY
       2    DD-MM-YYYY
       3    YYYY-MM-DD
       4    DD.MM.YYYY
       5    YYYY.MM.DD
     DB2ALtdbname=DOM_ALT
     DB2CONTainerpath=
     DB2LOGPath=
     DB2LOGTarget=
     DB2REPlace=Yes (Yes|No)
     DB2RESTIntopath=
     DB2SESSions=1 (1..64)
     DB2USER=
     DOMI_DIR=
     DOMINstallpath=
     LOGFile=domdsm.log
     LOGPRUne=60  (0..9999 | No)
     MOUNTWait=Yes  (Yes|No)
     NOTESInipath=
     NUMberformat=
       0    locale-specified
       1    n,nnn.dd
       2    n,nnn,dd
       3    n nnn,dd
       4    n nnn.dd
       5    n.nnn,dd
       6    n'nnn,dd
     REPlace=Yes  (Yes|No)
     SESSions=1 (1..64)
     STATistics=No (No|Yes)
     SUBDir=No  (No|Yes)
     TIMEformat=
       0    locale-specified
       1    HH:MM:SS
       2    HH,MM,SS
       3    HH.MM.SS
       4    HH:MM:SSA/P
     DOMTXNBYTElimit=0 (0...2097152)
     DOMTXNGROUPmax=2 (2,65000)
     COMMRESTARTDuration=60(1,9999)
     COMMRESTARTInterval=15(1,9999)

DOMDSMC UPDATEDB2Pwd [oldpw [newpw [verifypw]]]
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)

EXAMPLES:

  DOMDSMC Selective adb.nsf
  DOMDSMC Query Domino

Example 2: To display help for all the query commands, enter the following command:

domdsmc help query "*" or domdsmc help query

Output example:

DOMDSMC Query Adsmserver
[/ADSMNODe=nodename]
[/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
[/ADSMPWD=password]
[/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
[/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
[/LOGPRUne=60|n|No] (default: 60)

DOMDSMC Query DBBackup *|dbname
[/ADSMNODe=nodename]
[/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
[/ADSMPWD=password]
[/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
[/DEtail]
[/INACTive]
[/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
[/LOGPRUne=60|n|No] (default: 60)
[/SERVer=currentserver|servername]
[/SUBDir=No|Yes] (default: No)

DOMDSMC Query DB2Backup *|db2group
[/ADSMNODe=nodename]
[/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
[/ADSMPWD=password]
[/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
[/DB2DATAbase=db2database]
[/DEtail]
[/FULL]
[/INACTive]
[/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
[/LOGPRUne=60|n|No] (default: 60)
[/SERVer=currentserver|servername]

DOMDSMC Query DB2Pendingdbs
[/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
[/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
[/LOGPRUne=60|n|No] (default: 60)

DOMDSMC Query DB2ROLLforward
[/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
[/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
[/LOGPRUne=60|n|No] (default: 60)

DOMDSMC Query DOMino [*|dbname]
[/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
[/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
[/LOGPRUne=60|n|No] (default: 60)
[/SUBDir=No|Yes] (default: No)
[/TYpe=All|Nsf|Db2] (default: All)

DOMDSMC Query LOGArchive
[/ADSMNODe=nodename]
[/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
[/ADSMPWD=password]
[/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
[/DEtail]
[/INACTive]
[/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
[/LOGPRUne=60|n|No] (default: 60)
[/SERVer=currentserver|servername]
[/FROMDate=date]
[/TODate=date]

DOMDSMC Query PENDingdbs
[/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
[/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
[/LOGPRUne=60|n|No] (default: 60)

DOMDSMC Query PREFerences
[/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
[/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
[/LOGPRUne=60|n|No] (default: 60)

Example 3: To display help for the query domino command, enter the following command:

domdsmc help query domino

Output example:

DOMDSMC Query DOMino [*|dbname]
[/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
[/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
[/LOGPRUne=60|n|No] (default: 60)
[/SUBDir=No|Yes] (default: No)
[/TYpe=All|Nsf|Db2] (default: All)

Example 4: To display help for the db2selective command, enter the following command:

domdsmc help db2selective

Output example:

 DOMDSMC DB2Selective db2group[,db2group,...]
  [/ADSMNODe=nodename]
  [/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
  [/ADSMPWD=password]
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/DB2SESSIONS=numsessions] (default: 1)
  [/FULL]
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)
  [/Quiet]

Example 5: To display help for the query db2backup command, enter the following command:

domdsmc help query db2backup

Output example:

 DOMDSMC Query DB2Backup *|db2group
  [/ADSMNODe=nodename]
  [/ADSMOPTFile=dsm.opt|filename] (default: dsm.opt)
  [/ADSMPWD=password]
  [/CONFIGfile=domdsm.cfg|filename] (default: domdsm.cfg)
  [/DB2DATAbase=db2database]
  [/DEtail]
  [/FULL]
  [/INACTive]
  [/LOGFile=domdsm.log|logfilename] (default: domdsm.log)
  [/LOGPRUne=60|n|No] (default: 60)
  [/SERVer=currentserver|servername]