Command Line - FAQ

Table of Contents

What are the argument values used for an agent?

The following table lists the argument values that can be used when specifying the agent type in a command string or arguments file.

Note: Argument values used in a command string or arguments file are case-sensitive.

File System Argument Value
File System (Generic) Q_FILESYSTEM
File System Agents Argument Value
AIX File System Agent Q_AIX_FS
FreeBSD File System Agent Q_FREEBSD_FS
FreeBSD File System Agent Q_FREEBSD_FS
HP-UX File System Agent Q_HPUX_FS
IRIX File System Agent Q_SGI_FS
Linux File System Agent Q_LINUX_FS
Macintosh File System Agent Q_MAC_FS
OpenVMS File System Agent Q_FILESYSTEM
NAS iDataAgent Q_NAS
Solaris File System Agent Q_SOLARIS_FS
Windows File System Agent (Windows XP 32-bit) Q_WINXP32_FS
Windows File System Agent (Windows XP 64-bit) Q_WINXP64_FS
Windows File System Agent (Windows Server 2003 32-bit) Q_WINNET32_FS
Windows File System Agent (Windows Server 2003 64-bit) Q_WINNET64_FS
Windows File System Agent (Windows Vista 32-bit) Q_WINDOWS_FS
Windows File System Agent (Windows Vista 64-bit) Q_WINDOWS_FS
Windows File System Agent (Windows Server 2008 32-bit) Q_WINDOWS_FS
Windows File System Agent (Windows Server 2008 64-bit) Q_WINDOWS_FS
Windows File System Agent (Windows Server 2012 32-bit) Q_WINDOWS_FS
Windows File System Agent (Windows Server 2012 64-bit) Q_WINDOWS_FS
Agents Argument Value
Active Directory Agent Q_ACTIVEDIR
DB2 Agent (Windows) Q_DB2
DB2 Agent (UNIX) Q_UNIX_DB2
DB2 MultiNode Agent (UNIX) Q_DB2_DPF
Documentum Agent Q_DOCUMENTUM
Image Level Agent (Windows) Q_IMAGELEVEL_WIN
Image Level Agent (UNIX) Q_IMAGELEVEL_UNIX
Informix Agent Q_INFORMIX
IBM Domino Agent (Notes Database for Windows) Q_LOTUS_DOMINO_DB
IBM Domino Agent (Notes Database for UNIX) Q_LOTUS6_DB
IBM Domino Agent (Notes Document for Windows) Q_LOTUS_DOMINO_DOC
IBM Domino Agent (Notes Document for UNIX) Q_LOTUS_UNIX_DOC
Microsoft Exchange Database Agent Q_MSEXCH_DB
Microsoft Exchange Mailbox Agent Q_MSEXCH_MB
Microsoft Exchange Public Folder Agent Q_MSEX_PUB
Microsoft SQL Server Agent Q_MSSQL
MySQL Agent (Both Windows and UNIX) Q_MYSQL
Oracle Database Agent Q_ORACLE
Oracle RAC Agent Q_ORACLE_RAC
PostGreSQL Agent Q_POSTGRESS
SAP Agent (Oracle) Q_SAP_ORADB
SAP Agent (MAXDB) Q_SAP_SAPDB
SharePoint Server Q_SHAREPOINT_SERVER
Sybase Agent Q_SYBASE
Virtual Server Agent Q_VIRTUAL_SERVER
Archiver Agents Argument Value
Content Store Q_CONTENT_STORE
Domino Mailbox Archiver Q_LOTUS_DOC_MIG
Exchange Public Folder Archiver Q_MSEXPF_MIG
File Archiver for Windows Q_WINFS_MIG
File Archiver for Unix Q_UNIXFS_MIG
SharePoint Archiver Q_SHAREPOINT_ARCH
ContinuousDataReplicator Argument Value
ContinuousDataReplicator Q_FILE_REPLICATION
External Data Connector Argument Value
External Data Connector Q_EXTERNAL_DATA_CONNECTOR
Unknown Argument Value
Unknown Data Agent type Q_UNSUPPORTED

What are the argument values used for backup options?

The qoperation backup command was replaced by an XML driven approach.

The following table lists the argument values that were used when backup options where specified in a command string or arguments file.

Argument values used in a command string or arguments file are case-sensitive.

Options Argument Value
Full Backup QB_FULL
Incremental Backup QB_INCREMENTAL
Differential Backup QB_DIFFERENTIAL
Synthetic full Backup QB_SYNTHETIC_FULL
Start new media QB_STARTNEWMEDIA
Mark media full after successful operation QB_NEWMEDIA_ONSUCCESS
Start the job in suspended state QB_START_SUSPENDED
Run Incremental Backup Before Synthetic Full QB_INCR_BEFORE_SYNTH
Run Incremental Backup After Synthetic Full QB_INCR_AFTER_SYNTH
Create new index QB_CREATEINDEX
Allow Full Content Indexing QB_FULL_CONT_INDEXING
Backup data in remote storage QB_BACKUP_RSS_DATABASE
Backup files protected by system file protection QB_SYSTEMFILE_PROTECT
Stop DHCP service when backing up system state data QB_STOP_DHCP
Stop WINS service when backing up system state data QB_STOP_WINS
Truncate Log QB_TRUNC_LOG
File/File group subclient backup QB_SQL_BKP_FILE_GROUPS
Transaction Log Backup QB_TRANLOG
Pre-Selected Backup Type QB_PRE_SELECT
Backup all subclients QB_ALLSUBCLIENTS
Skip metafile creation QB_SKIP_METAFILE_CREATION
Create QR Volume QB_CREATE_REPLICA
Update QR Volume QB_UPDATE_REPLICA
Any level QB_ANYLEVEL
Template QB_TEMPLATE
Backup all except default subclient QB_EXCEPT_DEFAULT_SUBCLIENT
Snapshot QB_SNAPSHOT
Start media movement QB_START_MEDIA_MOVEMENT
Backup file groups in SQL QB_SQL_BKP_FILE_GROUPS
Skip meta file creation QB_SKIP_METAFILE_CREATION
Wait for inline copy resources QB_WAIT_INLINE_COPY_RES
Reserve resources before scan QB_RESERVE_RES_BEFORE_SCAN
Workflow task QB_WORKFLOW_TASK
Job qualifies extended rule QB_JOB_QUALIFIES_EXTENDED_RULE
Skip full after log backup QB_SKIP_FULL_AFTER_LOG_BACKUP
Preserve media not copied QB_PRESERVE_MEDIA_NOT_COPIED
Filter by retention QB_FILTER_BY_RETENTION
FBR type extended QB_FBR_TYPE_EXTENDED
On demand source input file QB_ON_DEMAND_SOURCE_INPUT_FILE
Don't hold reserve during meta data phase QB_DONT_HOLD_RESV_DURING_METADATA_PHASE
Service pack info QB_SERVICE_PACK_INFO
Client level backup QB_CLIENT_LEVEL_BACKUP
Log backup after successful Backup QB_LOG_BKP_AFTER_BACKUP
Do not use media started by other job QB_DO_NOT_USE_MEDIA_STARTED_OTHER_JOB
Migration Archiving using Data Classification QB_ILM_CLASSES_MIGRATION
Consistent Recovery Point creation QB_CONSISTENCY_POINT_CREATION
Back up Consistent Recovery Point QB_MOVING_CONSISTENCY_TO_TAPE
Recovery point creation QB_RECOVERY_POINT_CREATION
Kill job exceeding run time QB_KILL_JOB_EXCEED_RUN_TIME
Backup recovery point QB_BACKUP_RECOVERY_POINT
No partial stream QB_NO_PARTIAL_STREAM
No multiplex stream QB_NO_MULTIPLEX_STREAM
Clear Read/Write flag QB_CLEAR_RO_FLAG
Import snapshot flag QB_IMPORT_SNAPSHOT_FLAG
Activate snapshot flag QB_ACTIVATE_SNAPSHOT_FLAG
Oracle Options Argument Value
No logs (logs not saved) QB_ARCH_LOG_NO_TYPE
Logs older than QB_ARCH_LOG_OLDER_THAN
Logs not older than QB_ARCH_LOG_NOT_OLDER_THAN
Logs per a start time, end time QB_ARCH_LOG_BY_TIME
Logs by Log Sequence Number QB_ARCH_LOG_BY_LSN
Logs by System Change Number QB_ARCH_LOG_BY_SCN
Like expression (used to select logs) QB_ARCH_LOG_LIKE
Archive log destinations QB_ARCH_LOG_ALL
Do not use Oracle connect string for backup QB_DO_NOT_USE_ORA_CONNECT_STRING

What are the argument values used for restore options?

The qoperation restore command was replaced by an XML driven approach.

The following table lists the argument values that were used when restore options where specified in a command string or arguments file.

Argument values used in a command string or arguments file are case-sensitive.

Options Argument Value
Restore/recover all versions of the file/object per time constraints QR_ALLVERSION
Browse data QR_BROWSE
Leave database in DBO use only state QR_DBOONLY
Overwrite existing databases or files QR_OVERWRITE
Point in time restore QR_POINT_OF_TIME_RST
Database in fully operational state after recovery QR_DB_STATE_RECOVER
Database in Offline state after recovery QR_DB_STATE_NORECOVER
Database in Standby state after recovery QR_DB_STATE_STANDBY
No loss restore QR_NOLOSS_RST
Unconditional Overwrite QR_UNCONDITIONAL
Preserve Level QR_PRESERVE_LEVEL
Strip Level QR_STRIP_LEVEL
Restore ACLs QR_RESTORE_ACLS
Restore ACLs only QR_RESTORE_ACLS_ONLY
Recreate Mount Points QR_RECREATE_MOUNT_POINTS
InPlace Restore QR_INPLACEMENT
Restore Data QR_RESTORE_DATA
Restore Space Restrictions QR_RESTORE_SPACE_RESTRICTIONS
Ignore Namespace Requirements QR_IGNORE_NAMESPACE_REQS
Skip if exists QR_SKIP_IF_EXISTS
Dismount store during Exchange database restores QR_DISMOUNT_STORE
Point in Time QR_RECOVER_POINT_IN_TIME
Overwrite Database Links QR_OVERWRITE_DATABASE_LINKS
Overwrite Design QR_OVERWRITE_DESIGN_DOCUMENTS
Overwrite Data QR_OVERWRITE_DATA_DOCUMENTS
Overwrite Database Links Only QR_OVERWRITE_DATABASE_LINKS_ONLY
Restore documents in created state QR_CREATE_DOC
Restore documents in checked-in state QR_CREATE_AND_CHECKIN
Restore documents in published state QR_CREATE_AND_PUBLISH
Index free Restore QR_INDEX_FREE_RESTORE
Restore System State QR_SYSTEM_STATE
Restore Deleted Files QR_NOIMAGE
Restore file system QR_FILE_SYSTEM
Primary (Used for one touch restore) QR_PRIMARY
Authoritative QR_AUTHORITATIVE
Non-Authoritative QR_NON_AUTHORITATIVE
No loss restore QR_NOLOSS_RST
No recursion QR_NORECURSE
Image level restore QR_VOLUME_IMAGE_LEVEL
Real time QR_RLT_TIME
Kill job exceeding run time QR_KILL_JOB_EXCEED_RUN_TIME
Create devices for Sybase QR_SYBASE_CREATE_DEVICES
Step by step QR_SYBASE_STEP_BY_STEP
SR restore QR_SR_RESTORE
Auto dismount restore QR_AUTO_DISM_STORE
Use recovery storage group QR_USE_RECOVERY_STORAGE_GROUP
Restore only if STUB exists QR_RESTORE_ONLY_STUB_EXISTS
Search and retrieve QR_SEARCH_AND_RETRIEVE
Check in restore doc QR_CHECK_IN_RESTORE_DOC
Restore option if source path has wildcards QR_WILDCARD
File System and File Archiver Options Argument Value
Restore only if the source folder or directory exists QR_RESTORE_ONLY_IF_TARGET_EXISTS
Oracle Options Argument Value
Restore relocation QR_ORA_RESTORE_RELOCATION
Restore mode QR_ORA_RESTORE_MODE
Restore control file QR_ORA_RESTORE_CONTROL_FILE
Table level Restore QR_ORA_IS_TABLE_RESTORE
Duplicate the source database QR_ORA_AUXILIARY_INSTANCE
Deletes existing table before importing table QR_ORA_DROP_TABLE
Table will be left in staging area QR_ORA_DO_NOT_IMPORT
Import to the source database QR_ORA_IMPORT_TO_SOURCE
Import the table to a different database QR_ORA_IMPORT_TO_ANOTHER
Specify control file QR_ORA_SPECIFY_CONTROL_FILE
Validate restore QR_ORA_RESTORE_VALIDATE
Autobackup control file QR_ORA_CONTROLFILE_AUTOBACKUP
Replicate control file QR_ORA_CONTROLFILE_REPLICATE
SP file QR_ORA_SP_FILE
Autobackup SP file QR_ORA_SP_FILE_AUTOBACKUP
SP file time QR_ORA_SP_FILE_TIME
Specify SP file QR_ORA_SPECIFY_SP_FILE
Restore Logs QR_ORA_RESTORE_LOGS
Start LSN QR_ORA_START_LSN
End LSN QR_ORA_END_LSN
Restore QR_ORA_RESTORE
Recover QR_ORA_RECOVER
Start Log time QR_ORA_START_LOG_TIME
No catalog QR_ORA_NO_CATALOG
Specify control file time QR_ORA_SPECIFY_CONTROL_FILE_TIME
Start log QR_ORA_START_LOG
End log QR_ORA_END_LOG
Check read only QR_ORA_CHECK_READONLY
Reset database QR_ORA_RESET_DATABASE
Do not recover redo logs QR_ORA_DONOT_RECOVER_REDO_LOGS
Open database QR_ORA_OPEN_DATABASE
Duplicate QR_ORA_DUPLICATE
No file name check QR_ORA_DUPLICATE_NOFILENAMECHECK
Duplicate Standby QR_ORA_DUPLICATE_STANDBY
Duplicate standby no recover QR_ORA_DUPLICATE_STANDBY_DO_RECOVER
Duplicate to QR_ORA_DUPLICATE_TO
Skip read only QR_ORA_DUPLICATE_SKIP_READONLY
Duplicate open restricted QR_ORA_DUPLICATE_OPEN_RESTRICTED
Duplicate skip tablespace QR_ORA_DUPLICATE_SKIP_TABLESPACE
Duplicate log file QR_ORA_DUPLICATE_LOGFILE
Restore maximum open files QR_ORA_RESTORE_MAXOPENFILES
Do not use Oracle connect string for restore QR_DO_NOT_USE_ORA_CONNECT_STRING
SQL Server Options Argument Value
DBO only QR_SQL_DBO_ONLY
Overwrite QR_SQL_OVERWRITE
Start server QR_SQL_STARTSERVER
Point in time restore QR_SQL_POINT_OF_TIME_RST
Step restore QR_SQL_STEP_RST
DB state recover QR_SQL_DB_STATE_RECOVER
DB state no recover QR_SQL_DB_STATE_NORECOVER
DB state standby QR_SQL_DB_STATE_STANDBY
Recovery only QR_SQL_RECOVERYONLY
Latest backup data QR_SQL_HOTSERVERRESTORE
Discreet time QR_SQL_DISCREET_TIME
Stop and start SSA QR_SQL_STOPSTART_SSA
Keep replication QR_SQL_KEEPREPLICATION
Stop at mark QR_SQL_STOPATMARK_RST
Stop before mark QR_SQL_STOPBEFOREMARK_RST

What are token and token files?

A token is an encrypted string that uniquely identifies the user and the CommServe to which he/she is connected to. The user can securely save the token file to a desired location using (-t) option in order to avoid other users from the same machine running qcommands without a valid session.

Running commands on UNIX computers. What should I take into account?

Consider the following when running Command Line operations on a Unix computer:

  • Running multiple CLI commands on the same Unix client may cause one or more of the commands to hang. Therefore, be sure to run multiple simultaneous CLI commands on the client as different Unix users.
  • When running Qcommands, the user must have write permissions to both the logs directory (for the qcommand.log file) and the install directory (for qsession files). To allow access to these files by multiple users on Unix computers, the umask and newgrp commands should be properly set to ensure that files are created with the correct permissions and group ID.

How are XML files used to perform command line operations?

XML files are used as input files by the qoperation execute command in order to perform CommCell operations. These XML files can be created using one of the following methods:

XML Files Generated by the Save as Script Option

The CommCell Console provides the Save As Script option for many of the operations performed in the console. Use Save As Script to save CommCell operations as an XML input file which can later be used by either a Windows batch or Unix shell command. Save as Script helps you start a script by filling in most of the actions you need without having to start from scratch. You can edit and modify the saved script to enhance it or incorporate it into other scripts. See Advanced Configurations - Save As Script for more information.

Backup and restore operations are frequently saved as a script. For an example on how to generate these scripts, see the backup and restore pages for the Windows File System Agent.

User-Defined XML Files

Some of the options that are not available as Save as Script in the CommCell Console, can also be created as user-defined xml scripts and executed from the command line interface using the qoperation execute command.

The following table lists the software components which employ user-defined XML files:

CommServe

MediaAgent

Lotus Notes Database iDataAgent

Lotus Notes Document iDataAgent

Microsoft Exchange Database iDataAgent

Microsoft SQL Server iDataAgent

Microsoft Windows File System iDataAgent

NAS iDataAgent

Oracle Instance Configuration

Oracle Subclient Configuration

Oracle RAC iDataAgent

SAP for MAXDB iDataAgent

SAP for Oracle iDataAgent

Sybase iDataAgent

Unix File System iDataAgent

What are QCommands and what agents still use them?

QCommands are a suite of utility programs and commands that are packaged in the software and are available on all computers having any CommServe, MediaAgent, or Agent software installed.

The following table lists the software components using QCommands for all types of configuration:

CommServe

MediaAgent

DB2 iDataAgent

DB2 DPF iDataAgent

Image Level iDataAgent

Informix iDataAgent

Macintosh File System iDataAgent

Microsoft Exchange Mailbox iDataAgent

Microsoft Exchange Public Folder iDataAgent

Microsoft SharePoint Server iDataAgent

MySQL iDataAgent

OES File System iDataAgent

PostgreSQL iDataAgent

Virtual Server iDataAgent

  VMware

  Microsoft Hyper-V

ContinuousDataReplicator

Where are the command line errors logged?

All errors originating from QCommand operations are logged in the following locations:

Client Errors

  • Windows: software_installation_folder\Log Files\qcommand.log
  • UNIX: log_directory/Log_Files/qcommand.log

Server Errors

Windows:

  • software_installation_folder\Log Files\QSDK.log
  • software_installation_folder\Log Files\EvMgrS.log

You can also customize the logs by limiting the type of entries that appear in them by following the steps described in Setting the Debug Level.

How do I use argument files in commands

Some commands can read command line arguments from a file. This is useful for complex commands that require many arguments. You can provide this file as an input to the command using the -af <filename> option as follows:

qoperation auxcopy -af ArgumentFilePath

Commands can accept both the input file as well as the command arguments. However, when both exist, arguments provided through the input file will overwrite the command line options.

Some of the Commands that support Argument Files

  • qcreate backupset
  • qcreate subclient
  • qdelete client
  • qdelete backupset
  • qdelete subclient
  • qmodify instance
  • qmodify subclient
  • qoperation auxcopy

Format

The input file contains a list of options and their value(s). Consider the following rules when creating the argument file:

  • Options must be always surrounded by "[" and "]", and must be written in lower-case letters. Any line that begins with "[" and ends with a "]" in this documentation is treated as an option.
  • Both options and values should always start on a new line.
  • Argument values are case-sensitive.
  • Options can take more than one value, and each value should be specified in a new line.
  • All lines that start with "#" are treated as comments and are ignored.

QCommands that support argument files have the Argument File table listing the argument options that you can specify in the argument file. For example, see qoperation auxcopy.

Sample Argument file

Can command line operations limit access to CommCell information?

Similar to the CommCell Console, the Command Line Interface also has the ability to restrict user access for performing various operations. For example, if a user with limited permissions uses the command to obtain the list of all CommCell clients, then only the clients that the user has access to will be displayed.

What do I do when I get an invalid XML error after I download the XML templates?

If you are using Microsoft Internet Explorer to download the XML templates, invalid characters can be added to the XML. Download and install Mozilla Firefox or Google Chrome, download a new version of the template using either browser, and retry the operation.