Tools & Utilities > Developer Tools > Command Line > Command Line Interface > CommCell Management > CommServe QCommands

Command Line Interface - CommServe QCommands

Before executing a command, log on to the CommCell environment using the qlogin command. Similarly, use the qlogout command to log off.

qdelete client

Description

This command can be used to deconfigure and delete a client, along with its agents.

Note: You can mass-delete clients with or without their associated MediaAgents using the qdelete client command. You can include this command (along with the qdelete mediaagent command, if desired) in a script. Mass deletion of these items is useful if you want to remove them after a split of a CommCell. To mass-delete items where the CommCell is not split, be sure to run the script from the install location of the CommServe.

By default, the qdelete client command asks for confirmation before deleting the client. You can skip the confirmation prompt with the -y option.

Upon successful completion, qdelete client displays the message "Deleted the client successfully" on the command prompt. In case of an error, an error code and description are displayed as: "client: Error errorcode: errordescription" 

Usage

qdelete client [-cs <commserve_host_name>] -c <client> [-deconfigure] [-y] [-tf <tokenfile>] [-tk <token>] [-af <clientfile>] [-h]

Options

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Examples

• Delete a client with name client1.

  qdelete client -c client1
  This command deconfigures and deletes a client, do you want to continue (y/n)? [n]

• Deconfigure, but do not delete, a client with name client1

  qdelete client -c client1 -deconfigure -y

• Delete a set of clients specified in an argument file.

  qdelete client -af "E:\clients.txt"

  In this example, clients.txt is a text file containing a list of client names. Ensure that the file is in the following format:

  [client]
  Client01
  Client02
  ClientXX

qgeterrorstring

Description

This command displays the error description of a given error code. See Error Codes for more information.

If the error code given by the user is invalid, the following error message is displayed: "qgeterrorstring: Error errorcode: errordescription"

Usage

qgeterrorstring error number [-tf <tokenfile>] [-tk <token>] [-h]

Options

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

• Display error description of error number 10.

  qgeterrorstring 10
  Connection to the CommServe terminated, Relogin required

• Display error description of invalid error number.

  qgeterrorstring 4543584
  qgeterrorstring: Error 0x771: Invalid error no 4543584

qlist backupfiles

Description

This command performs a search operation on backed up files and saves the results to a file. The type of operation is defined in the opType attribute in the XML request file:

• Find: Performs a recursive search and returns a list of files and folders. Specify recursion by using asterisks in the path attribute as shown: <paths path="C:\data\**\*" />.
• Browse: Performs a search on one directory and returns a list of files and folders in that directory. (The Browse operation is not recursive.)
• Versions: Lists all of the versions of a single file.

For the Find and Browse operations, you can limit the results to backed up files for a specific job by using the <jobId> element in the XML request file.

In case of an error, an error code and description are displayed as: "backupfiles: Error errorcode: errordescription"

Usage

qlist backupfiles -af <path_to_input_XML_file> -dpath <path_to_output_XML_file> [-tf <tokenfile>] [-tk <token>] [-example] [-h]

Options

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure. 

Examples

• For the default subclient, finds all of the files and folders in the C:\data directory and its subdirectories.

  qlist backupfiles -af c:\searches\find.xml -dpath c:\results\find_results.xml

  XML example for the Find operation:

  <databrowse_BrowseRequest opType="Find">
    <entity _type_="0" appName="Windows File System" backupsetName="defaultBackupSet" clientName="vmcs100_cn" subclientName="default"/>
    <paging pageSize="4294967295" skipNode="0"/>
    <mode mode="2"/>
    <paths path="C:\data\**\*" />
  </databrowse_BrowseRequest>

• For the default subclient, browses the files and folders in the C:\ directory.

  qlist backupfiles -af c:\searches\browse.xml -dpath c:\results\browse_results.xml

  XML example for the Browse operation:

  <databrowse_BrowseRequest opType="Browse">
    <entity _type_="0"appName="Windows File System" backupsetName="defaultBackupSet" clientName="vmcs100_cn" subclientName="default"/>
    <mode mode="2"/>
    <paging pageSize="4294967295" skipNode="0"/>
    <paths path="C:\"/>
    <timeRange fromTime="0" toTime="1331280338"/>
  </databrowse_BrowseRequest>

• For job ID 857 run on the default subclient, browses the files and folders in the C:\ directory.

  qlist backupfiles -af c:\searches\find.xml -dpath c:\results\find_results.xml

  XML example for the Browse operation for a specific job ID:

  <databrowse_BrowseRequest opType="Browse">
    <entity _type_="0"appName="Windows File System" backupsetName="defaultBackupSet" clientName="vmcs100_cn" subclientName="default"/>
    <mode mode="2"/>
    <paging pageSize="4294967295" skipNode="0"/>
    <paths path="C:\"/>
    <timeRange fromTime="0" toTime="1331280338"/>
    <advOptions>
      <advConfig>
        <browseAdvancedConfigBrowseByJob>
          <jobId>857</jobId>
        </browseAdvancedConfigBrowseByJob>
      </advConfig>
    </advOptions>
  </databrowse_BrowseRequest>

• For the default subclient, lists the versions available for the mydata.txt file.

  qlist backupfiles -af c:\searches\versions.xml -dpath c:\results\versions_results.xml

  XML example for the Versions operation:

  <databrowse_BrowseRequest opType="Versions">
    <entity _type_="0"appName="Windows File System" backupsetName="defaultBackupSet" clientName="vmcs100_cn" subclientName="default"/>
    <mode mode="2"/>
    <paths path="C:\Users\Administrator\Documents\test\mydata.txt"/>
  </databrowse_BrowseRequest>

qlist client

Description

This command lists the names, operating systems, and installation state of all the client computers configured in the CommCell. Whenever more than one client is found, the name of each client is listed in its own line. No message is displayed when clients are not found.

In case of an error, an error code and description are displayed as: "client: Error errorcode: errordescription"

Usage

qlist client [-cs commserve] [-cg clientgroup] [-tf <tokenfile>] [-tk <token>] [-h]

Options

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

List all the clients configured in the CommCell.

E:\commandline>qlist client

NAME          OS                     ACTIVE

----          --                     ------

spock         Windows Server 2003     Yes

caput         AIX                     Yes

virgo         SunOS                   Yes

aries         HP-UX                   Yes

copper-Irina    Windows Server 2003   No

Microsoft Windows x64 platform information may not be displayed correctly when 32-bit components are installed on x64 client computers.

qlist clientgroup

Description

This command lists names of all the client groups configured in the CommCell. When more than one client group is found, the name of each client groups is listed in its own line. No message is displayed when clients are not found.

In case of an error, an error code and description are displayed as: "clientgroup: Error errorcode: errordescription"

Usage

qlist clientgroup [-tf <tokenfile>] [-tk <token>] [-h]

Options

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

List all the client groups configured in the CommCell environment.

qlist clientgroup
Grp1
Grp2

qlist globalfilter

Description

This command lists the names of all the global filters configured in a given subclient type within the CommCell. When more than one global filter is found, the name of each global filter is listed in its own line. No message is displayed in the console when global filters are not found.

In case of an error, an error code and description are displayed as: "globalfilters: Error errorcode: errordescription"

Usage

qlist globalfilter -t <filter type>  [-tf <tokenfile>] [-tk <token>] [-h]

Options

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure. 

Example

List all the global filters configured in the CommCell under Windows subclients.

qlist globalfilter -t Windows

qlist job

Description

This command returns the job ID, type, phase, status, failure reason, and user-defined description for a specific job ID or for all of the active jobs under a client, agent, instance, backup set, or subclient.

You can filter jobs based on the job type or status. When more than one job is found, the jobs are listed one job per line. "No jobs to display" is returned when no jobs match the filter criteria.

In case of an error, an error code and the error description are displayed in the following format: "job: Error errorcode: errordescription".

Usage

qlist job [-cs commserve_host_name] [-co i|o|s|p|r|d|c] [-j jobid] [-jt jobtype] [-js Running|Suspended|Waiting|Pending] [-c client] [-a iDataAgentType] [-i instance] [-b backupset] [-s subclient] [-waitForJobComplete] [-waitTimeoutSecs waitTimeoutSecs] [-tf tokenfile] [-tk token] [-h] [-af argsfile]

Use the -jt jobtype option to specify the type of job to return, for example -jt restore returns restore jobs.

Options

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Examples

• Lists the active jobs in XML format:

  E:\commandline>qlist job -format xml
  
  <?xml version="1.0" encoding="UTF-8" standalone="no" ?><GalaxyUtilities_QGetJobsRespMsg pendingJobs="0" queuedJobs="0" runningJobs="1" suspendedJobs="0" waitingJobs="0"><error errorCode="0" errorString=""/><header build="0" hostName="" osType="0" version=""/><jobs appName="Default Application Type Name" backupLevel="Unknown" backupSetName="" clientName="" completePercentage="0" description="" destclientName="" instanceName="" jobId="184" jobPhase="Data Aging" jobStatus="Running" jobType="Prune" subclientName=""/></GalaxyUtilities_QGetJobsRespMsg>

• Lists the details for a specific job ID in tab format:

  E:\commandline>qlist job -j 160
  
  JOBID  OPERATION  STATUS   PHASE  JOB DESCRIPTION COMPLETE PERCENTAGE
  -----  ---------  -------  -----  --------------- --------------------
  160    Backup     Running  Scan                   25

• Lists the job ID and status for a specific job ID in tab format:

  E:\commandline>qlist job -j 160 -co is
  
  JOBID  STATUS
  -----  -------
  160    Running

• Displays the failure/pending reason for a job in tab format:

  E:\commandline>qlist job -j 160 -co r
  
  FAILURE REASON
  --------------
  13187897
  Message for job failure/pending reasons:
  160   13187897  -> Job has been killed by the user

qlist jobhistory

Description

This command displays the backup job history of a given subclient. It displays job details such as job ID, status and the associated storage policy.

When more than one backup job is found, the jobs are listed one job per line in the command prompt. The system displays the message "No job history found" when no job history is found.

In case of an error, an error code and the error description are displayed in the following format: "jobhistory: Error errorcode: errordescription"

Usage

qlist jobhistory [-cs <commserve_host_name>] -c <client> -a <iDataAgent> -i <instance> -b <backupset> -s <subclient> [-js <jobstatus>] [-st <start time>] [-et <end time>] [-dispJobTime <displays job time>] [-dispJobTimeUnix <displays unix time>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Lists the backup job history of subclient subclient1 for a File System Agent:

E:\commandline>qlist jobhistory -c client1 -a Q_WIN2K_FS -b backupset1 -s subclient1

JOBID  STATUS     Subclient   STORAGEPOLICY
-----  ---------  ---------   -------------
160    Completed  subclient1  SP_12
161    Completed  subclient1  SP_12

qlist jobsummary

Description

This command lists the current state of all active jobs in the CommServe. Jobs are classified into the following states:

• Running
• Suspended
• Pending
• Queued
• Waiting

You can also filter the jobs by client, agent, instance, backup set or subclient.

In case of an error, an error code and description are displayed as: "media: Error errorcode: errordescription"

Usage

qlist jobsummary [-c <client>] [-a <iDataAgent>] [-i <instance>] [-b <backupset>] [-s <subclient>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure. 

Example

Display job summary of all jobs of client cl1.

qlist jobsummary -c cl1
RUNNING PENDING WAITING QUEUED SUSPENDED TOTAL
 1       10      0       4      1         16

qlist lastjob

Description

This command displays the summary details of all previous backup jobs completed by a specific client, instance, backup set or subclient. Whenever more than one job is found, the name of each backup job is listed in its own line. The message, "No job found," is displayed on the command prompt whenever backup jobs are not found.

In case of an error, an error code and description are displayed as: "lastjob: Error errorcode: errordescription"

Usage

qlist lastjob -c <client> -a <iDataAgent> -i <instance> -b <backupset> -s <subclient> [-js <jobstatus>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure. 

Example

Display the last backup job that ran under client client01.

qlist lastjob -c client01

JOBID STATUS    STORAGE POLICY APPTYPE    BACKUPSET SUBCLIENT INSTANCE  START TIME
----- ------    -------------- -------    --------- --------- --------  ----------
101   Completed SP_12          Filesystem set001    Sub01     <default> 01/01/2013 01:20:55

qlist schedule

Description

This command lists the weekly and daily schedules configured in the CommCell for a particular day or hour in given week. No message is displayed on the command prompt whenever schedules are not found.

In case of an error, an error code and description are displayed as: "schedule: Error errorcode: errordescription"

To see additional schedule details, use the XML file method described in Viewing Schedules and Schedule Policies Using the Command Line Interface.

Usage

qlist schedule [-day <weekday>] [-hour <hour>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

List the schedule

qlist schedule 

TIME              BACKUPJOBS          RESTOREJOBS        ADMINJOBS

Sun 12:30:45      0                   0                  4

Mon 12:30:45      0                   0                  4

Tue 12:30:45      0                   0                  4

Wed 12:30:45      0                   0                  4

Thu 12:30:45      0                   0                  4

Fri 12:30:45      0                   0                  4

Sat 12:30:45      0                   0                  4

qlist snap

Description

This command lists all the snapshots for a given backup job ID. It can also display the volume IDs of the backup job ID.

In case of an error, an error code and description are displayed as: "snap: Error errorcode: errordescription"

Usage

qlist snap [-cs <commserve_host_name>] -j <jobid> [-cid <commcellid>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Display the volume IDs of the IntelliSnap backup job ID 1.

E:\commandline>qlist snap -cs server1 -j 1

qlogin

Description

This command logs on to a given CommServe by using the credentials of a CommCell Console user with sufficient permissions to perform the desired operations. The qlogin command writes encrypted user logon information to a .qsessions file in the install directory. The .qsessions file is used by subsequent commands until the session times out or you log off from the CommServe. The .qsessions file appears as qsessions.osuser on Windows and qsessions.osuserId on Unix.

By default, the timeout for each logon session is 14 days, so sessions idle for more than 14 days are terminated automatically. For instructions on changing the timeout for logon sessions, see Modifying the Timeout Session.

On Windows client computers, you can log on to the CommServe using the -sso option with the qlogin command. The -sso option uses your account credentials from the Active Directory service provider. For more information on this CommCell feature, see Single Sign On (SSO).

If multiple user sessions are needed to the CommServe, each user must use the qlogin command with the -f or -gt option to obtain a token. A token is an encrypted string that uniquely identifies the user and the CommServe to which the user is connected. For more information, see Using Tokens to Perform QCommands.

Upon successful completion, qlogin does not display any message in the command prompt. In case of an error, an error code and description are displayed as: "qlogin: Error errorcode: errordescription"

Note: When a user upgrades from a previous version to the current version a new session file is generated. To run the qcommands using this session file the user has to do a qlogout -all and has to login in again.

Usage

qlogin [-cs <commserve_host_name>] [-u <username>] [-ps <passwordstrong>] [-clp <plainpasswordtext>] [-af <argsfile>] [-f <logintokenfile>] [-gt <givetoken>] [-csn <csClientName>] [-sso] [-localadmin <localadmin>] [-h]

Options

Argument File

For information on creating an argument file, see Command Line - FAQ - How do I use argument files in commands.

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Examples

• Log on to CommServe server1 with user name user1.

  E:\commandline>qlogin -cs server1 -u user1
  Password:

• Log on to CommServe server1 with user name user1 and plain text password.

  E:\commandline>qlogin -cs server1 -u user1 -clp pwd123
  User logged in successfully.

• On a Windows client computer, log on to the CommServe without providing credentials using the Single Sign-On option.

  E:\commandline>qlogin -sso
  User logged in successfully

• Unsuccessful Log on to CommServe server1 with user name user1 due to Invalid Password.

  E:\commandline>qlogin -cs server1 -u user1
  Password:
  qlogin: Error 0x260: Invalid Login/Password

• Use the following command to log on to a remote CommServe server2 which is behind a firewall.

  E:\commandline>qlogin -cs server2.mycompany.com -csn server2 -u user1
  Password:

Modifying the Timeout Session

You can modify the timeout for a logon session. By default, the timeout for each logon session is 14 days, so sessions idle for more than 14 days are terminated automatically. After a session times out, the user must log on again to continue running commands.

Note: The modified timeout is implemented for all active sessions.

1. On the command line, go to software_installation_directory/Base and type the following command:

   qoperation execscript -sn SetKeyIntoGlobalParamTbl.sql -si QSDKSessionTimeout -si y -si 'timeout_period'

   where timeout_period is the number of seconds the session is valid before it times out, surrounded by single-quote marks. The minimum timeout is 300 seconds (5 minutes).

   Note: To prevent sessions from timing out, set timeout_period to -1.

2. Restart the Commvault Commands Manager (QSDK) service.

   For information on restarting a service, see Restarting a Service.

qlogin Using a Token

If multiple user sessions are needed to the CommServe, each user must use the qlogin command with the -f or -gt option to obtain a token. A token is an encrypted string that uniquely identifies the user and the CommServe to which the user is connected. Use one of the following methods to set up a token:

Method 1: Using a Token File

1. Execute the following command to create a token file:

   C:\commandline>qlogin -f <tokenFile>

   where tokenFile is the file name and location where you want to create the token file, for example, c:\tokenfile.

2. Provide the user name and password of the account you want to use to access the CommServe.

   Enter User Name:
   Password:

   An encrypted token file is created. You can run any qcommand operation by appending the token file to your qcommand.

   UNIX Example

   ./qlist client -tf /root/token/tokenfile

   Windows Example

   C:\commandline>qlist client -tf c:\tokenFile

Method 2: Using a Token String

1. Execute the following command to obtain a token string:

   C:\commandline>qlogin -gt

2. Provide the user name and password of the account you want to use to access the CommServe.

   Enter User Name:
   Password:

   A token string is displayed. You can run any qcommand operation by appending the token string to your qcommand. For example:

   C:\commandline>qlist client -tk 3405d9d1394cb7a023f66f7e31b23b65ca29d
   9df88ff2cb5de884bf6ff42cd1281ae818fd0
   30f047f297c769353f65e63690bd1de0260f1
   c1339e38d59f449c02108aca351bd1a70eb4a
   a7a37c2c3e90a16b91cd8a15a22c8691f3f53
   5a72e015b362b992018cdc3b067ed12fc8165
   77fe52624d513b9e7d2646bcdf5adf260dc39
   a6e8036f6e0e4c63f4408e8dadf20fe4b26a2
   008a02fb7446f8337852a8ae7c7d1014ad162
   76b15b3221246a2547c2189c04e54648518fb
   837f6922f81c378e0b5d9ce516ca7409dbb75
   521d3cef7d3cfa8720ea27568e6c352d2b83f
   d58d2c0debafc11eb273025ff8bee217473db
   b65da0365114326f51a868c2e1e36a2ade624
   741661cf1c392045a9ad323908f0224c9ade0
   0949bf46aec0c8f121f9a2

qlogout

Description

This command allows you to log off from a specified CommServe and terminates the secure connection with the CommServe established by qlogin. By default, if a CommServe name is not specified, this command logs out from the CommServe in the current host.

Upon successful completion, qlogout displays that the user logged out successfully and the login information is removed from the qsessions file. The qsessions file is deleted upon successful logout from all the CommServes. In case of an error, an error code and description are displayed as: "qlogout: Error errorcode: errordescription"

Usage

qlogout [-cs <commserve_host_name>] [-all] [-tf <tokenfile>] [-tk <token>] [-h]

Options

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Examples

• Logout command executed when connected to a CommServe.

  E:\commandline>qlogout

• Logout all users locally when connected to a local CommServe.

  E:\commandline>qlogout -all

• Logout all users specifically when connected to a specific CommServe (for example, server2).

  E:\commandline>qlogout -cs Server2 -all

• Logout command executed when you are not logged on to any CommServe.

  E:\commandline>qlogout
  qlogout: Error 0x268: User not logged in

qmodify clientgroup

Description

This command adds or removes a client to/from a client group. Upon successful completion, qmodify clientgroup displays the message "qmodify clientgroup add/remove operation successful" on the console.

In case of an error, an error code and description are displayed as: "clientgroup: Error errorcode: errordescription"

Usage

qmodify clientgroup -o <add|delete> -c <client> -cg <clientgroup> [-tf <tokenfile>] [-tk <token>] [-h]

Options

Argument File

For information on creating an argument file, see Command Line - FAQ - How do I use argument files in commands.

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Add a client client1 to clientgroup clientgroup1.

E:\commandline>qmodify clientgroup -c client1 -cg clientgroup1 -o add

qmodify globalfilter

Description

This command modifies global filters for Windows and UNIX subclients.

Upon successful completion, qmodify globalfilter displays the message "Updated global filters successfully" on the command prompt. In case of an error, an error code and description are displayed as: "globalfilter: Error errorcode: errordescription"

Usage

qmodify globalfilter -o <append|overwrite> -t <subclient type> -ff <filter file> [-tf <tokenfile>] [-tk <token>] [-h]

Options

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Append the files/directories listed in the file test.txt to the Windows global filters

qmodify globalfilter -o append -t Windows -ff test.txt

qmodify schedulepolicy

Description

This command associates or dissociates a given schedule policy to a client, iDataAgent, instance, backup set or subclient.

In the case of data protection schedule policies, you can only modify the schedule policies that were created for all agents or a group of agents.

In case of an error, an error code and description are displayed as: "schedulepolicy: Error errorcode: errordescription"

Usage

qmodify schedulepolicy [-cs <commserve_host_name>] -o <add|remove> -scp <schedulepolicy> [-c <client>] [-a <iDataAgent>] [-i <instance>] [-b <backupset>] [-s <subclient>] [-cg <clientgroup>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

• Associate a schedule policy scp1 with client cl1.

  qmodify schedulepolicy -o add -scp scp1 -c cl1

• Dissociate a schedule policy scp1 from client cl1.

  qmodify schedulepolicy -o remove -scp scp1 -c cl1

• Associate a schedule policy scp1 with client computer group Laptop Clients.

  qmodify schedulepolicy -o add -scp scp1 -cg "Laptop Clients"

qoperation agedata

Description

This command performs the following data aging operations:

• prunes multiple jobs using a text file
• prunes a single job using the command line.

In case of an error, an error code and description are displayed as: "agedata: Error errorcode: errordescription"

Usage

qoperation agedata [-delbyjobid -j <jobid>] [-delbystoreid -sid <storeid>] -sp <storagepolicy> -spc <copy> -ft [-cs <commserve_host_name>][-af <ArgumentFilepath>][-tf <tokenfile>] [-tk <token>] [-h]

Options

Argument File

To prune jobs using an argument file, download the sample text file and modify the following parameters. For information on creating an argument file, see Command Line - FAQ - How do I use argument files in commands.

Example

• To run a data aging job.

  qoperation agedata

• To prune job 23453 for file type "log" from the primary copy of the Storage Policy 01.

  qoperation agedata -delbyjobid -j 23453 -sp 'Storage Policy 01' -spc 'Primary Copy' -ft Q_LOG

• To prune job 23453 for file type "log" from all copies of the Storage Policy 01.

  qoperation agedata -delbyjobid -j 23453 -delJobsOnAllCopies -sp 'Storage Policy 01' -ft Q_LOG

• To prune multiple jobs provided in the jobstodelete.txt file.

  qoperation agedata -delbyjobid -af x:\JobsToDelete.txt

qoperation capture

Description

This command captures information from a single client or multiple clients and stores the information in the form of a database on the CommServe. An answer file is also created which can be edited by a user during the merge operation. This answer file can be created either on the CommServe or on the local client machine. If the database file path is a UNC path, then the command line operation will prompt the user for impersonation details. When completed successfully, the qoperation capture command displays the message "Capture Successful" in the command prompt.

In case of an error, an error code and description are displayed as: "capture: Error errorcode: errordescription"

Usage

qoperation capture -c <client> -dfn <dumpfile> [-dbn <databasename>] [-afn <answerfile]> [-st <starttime>] [-et <endtime>] [-u <username>] [-p <password>] [-rp <alternate database path>][-af <argsfile>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

Argument File

For information on creating an argument file, see Command Line - FAQ - How do I use argument files in commands.

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

In windows, capture a client with the name client1, store the information in a dump file at c:\capturedb on the CommServe computer, and save the answer file at C:\afile on the local client.

qoperation capture -c client1 -dfn c:\capturedb -dbn db -afn c:\afile

qoperation checkready

Description

This command checks the network for client connectivity and generates a report to show if the client is accessible. The Summary Report is the default report displayed. You can also use the -dt option with this command for a detailed report.

Usage

checkready [-cs <commserve_host_name>] -c <client> [-sm <summary>] [-dt <detail>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

Example

Checks if the client is accessible and displays a summary report in html format.

qoperation checkready -c shr90_2 -sm>"E:\detail.html"

Checks if the client is accessible and displays a detailed report in html format.

qoperation checkready -c shr90_2 -dt>"E:\detail.html"

qoperation dock

Description

This command and the qoperation register command register a new client computer with the CommServe after a decoupled install using Custom Package. For more information, see Registering the Client Using the Command Line.

Usage

qoperation dock -c <client_display_name> [-roaming <y/n>][-tf <tokenfile>] [-tk <token>] [-h]

Options

Example

Register the client ranger on its associated CommServe.

qoperation dock -c ranger
Confirmed client registration successfully.

qoperation drbackup

Description

This command starts a disaster recovery backup operation. The Job ID is returned and displayed in the console if the disaster recovery backup job was successfully initiated by the CommServe.

In case of an error, an error code and description are displayed as: "drbackup: Error errorcode: errordescription" 

Usage

qoperation drbackup -t <Q_FULL|Q_DIFF> [-af <ArgumentFilepath>][-tf <tokenfile>] [-tk <token>] [-h]

Options

Argument File

For information on creating an argument file, see Command Line - FAQ - How do I use argument files in commands.

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Start a full disaster recovery backup.

qoperation drbackup -t Q_FULL
175

qoperation execscript

Description

Use this command to execute the QScripts available on the CommServe computer, either from the CommServe computer or from a client computer. The script name and the parameters for executing the script are provided as inputs to the command. In addition, you can provide the file name to which the output will be redirected, and the format in which the output will be displayed. The output could be obtained in three formats: xml, xls and csv (where .XLS is tab separated and .CSV is comma separated.) By default, the output is displayed in .XLS format. Refer to QScripts to view the list of available qscripts.

If there is a failure when creating the output file, the output is displayed on the command prompt after the script is executed. Also, if you do not provide a file name, the output is displayed on the command prompt.

QScripts are recommended for advanced users only. QScripts can be directly executed using qoperation execscript qcommand. Therefore caution is recommended while using them since the operations performed using the QScripts do not have the same safety protocols that are available with other options from the CommCell Console.

Permission

Executing QScripts requires the Administrative Management permission at the CommCell level unless otherwise stated in the readme file for the qscript.

Usage

qoperation execscript [-cs <commserve_host_name>] -sn <scriptname> [-c <client>] [-si <scriptparam>] [-p1 <password>] [-p2 <password>] [-p3 <password>] [-file <outFile>] [-format <outputFormat>] [-help] [-tf <tokenfile>] [-tk <token>] [-h]

Options

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

• The following command uses the qscript GetSubclients to retrieve the subclient usage information on client1:

  qoperation execscript -sn GetSubclients.sql -si client1

• The following command can be used to configure all SQL Clients to delete the databases from subclient content when the database is physically removed from SQL server:

  qoperation execscript -sn SetKeyIntoGlobalParamTbl.sql -si IgnoreNonExistentDB -si y -si 1

• The following command can be used to trigger an even to run a full backup before a transaction log backup. This reduces the chance of data loss if any transaction log backup becomes corrupted.

  qoperation execscript -sn SetKeyIntoGlobalParamTbl.sql -si SQLiDALogThreshHoldCount -si y -si <number>

qoperation execute

Description

The qoperation execute command is used to execute any operation.

This command is applicable to all jobs, for example, admin, backup, restore, and reports. The QCommands to be executed are written in an .xml file, which is provided as input to this command. Parameters from the generated XML can also be specified along with the QCommand during execution.

You can use this command to run the XML files generated from the Save As Script option in the CommCell Console as well as user-created XML files.

The Save as Script option includes a batch (.bat) and .xml file. The batch file includes the qlogin, qoperation execute, and qlogout commands. The input to the qoperation execute command is provided in the generated XML file. This allows you to set any parameter from the generated XML file when running the batch file in the command prompt.

Note: When the SaveAsScriptForceUserLogin additional setting is enabled, users must enter their credentials when they run the qoperataion execute command. For more information, see Forcing Users to Enter Credentials to Run a Saved Script.

Note: For the qoperation to create a new array for filer, the XML file should be generated using the Save As Script version 10.0 or higher.

Usage

qoperation execute [-cs <commserve_host_name>] [-af <argsfile>] [-req <request>] [-insert] [-tf <tokenfile>] [-tk <token>] [-h]

Options

Diagnostics

Possible exit status values are:

0 - Successful.

1 - Client side error

2 - Server side error.

Example

qoperation execute -af “a.xml”

where a.xml is the input file.

qoperation jobcontrol

Description

This command allows you to kill, resume, suspend, or change/set the progress (in percentage) of a given job. To operate on a single job, specify the Job ID. To operate on more than one job in a specific area, specify the client or MediaAgent name. You can also specify additional levels such as the agent, instance, backup set and/or subclient. The -all option can be used to suspend/resume all jobs.

If the operation is successful, no message is displayed on the command prompt. In case of an error, an error code and description are displayed as: "jobcontrol: Error errorcode: errordescription"

Usage

qoperation jobcontrol [-o <joboperation>] [-j <jobid>] - all [-m <media_agent>] [-c <client>] [-a <dataagenttype>] [-i <instance>] [-b <backupset>] [-s <subclient>] [-p <priority>] [-tfx <total files to transfer>] [-fx <files transferred>] [-ifx <files transferred since last update>] [-tbx <total bytes to transfer>][-tf <tokenfile>] [-tk <token>] [-h]

Options

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

• Kill a job with job ID 175.

  qoperation jobcontrol -j 175 -o kill

• Suspend all jobs under MediaAgent ma1.

  qoperation jobcontrol -m ma1 -o suspend

• Suspend all jobs.

  qoperation jobcontrol -all -o suspend

• Resume all jobs under client cl1 and dataagent "Q_WIN2K_FS".

  qoperation jobcontrol -c cl1 -a Q_WIN2K_FS -o resume

• Change priority of a job with job ID 175 to 100.

  qoperation jobcontrol -j 175 -p 100 -o changepriority

qoperation merge

Description

This command merges a captured database into a target CommCell. The database should reside on the CommServe and the user should supply the database name and the location.

This command also supports an option to read the answer file for the merge configuration. If the database file path is a UNC path, then the command line prompts the user to enter the impersonation details. You can specify whether or not to consume a license during this merge.

Upon successful completion, qoperation merge displays the message "Merge Successful" in the console.

In case of an error, an error code and description are displayed as: "merge: Error errorcode: errordescription"

Usage

qoperation merge -dfn <dumpfile> [-afn <answerfile>] [-u <username>] [-p <password>] [-cl <y|n>] [-rt <y|n>] [-rp <alternate database path>] [-tf <tokenfile>] [-tk <token>] [-af <argsfile>] [-h]

Options

Argument File

For information on creating an argument file, see Command Line - FAQ - How do I use argument files in commands.

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

In windows, merge using dump file c:\capturedump.dmp on the CommServe, and read the answer file at C:\test.xml on the local client.

qoperation merge -dfn c:\capturedump.dmp -afn c:\test.xml

qoperation move

Description

This command moves an Oracle instance from one or more clients to a single destination client.

• If the specified instance is found on any of the source clients, then it is deconfigured on the source client and a new instance with the same name appears on the destination client.
• If the instance is not found on any of the source clients, or, it is found on two or more source clients, then the command fails and returns an appropriate error message. Use the -sc option multiple times for specifying more than one source client from the command line.

The qoperation move command allows you to optimize the client configuration to run a single backup job for multiple instances on a client or cluster node using RMAN scripts. This eliminates the need to configure each database separately for backups on clusters. You can also use this command to move data and backup history from an instance that has failed over on a cluster from one client to another with the same operating system. Nevertheless, RMAN log cannot be moved using this command to the destination client.

Upon successful completion, qoperation move displays the message "Move operation successful" on the command prompt. In case of an error, an error code and description are displayed as: "move: Error errorcode: errordescription"

Usage

qoperation move -sc <sourceclient> -a <iDataAgent> -i <instance> -dc <destinationclient> [-af <argsfile>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

Argument File

For information on creating an argument file, see Command Line - FAQ - How do I use argument files in commands.

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Move an instance rman901 from source clients sc1 or sc2 to a destination client dc1.

qoperation move -sc sc1 -sc sc2 -a Q_ORACLE -i rman901 -dc dc1

qoperation register

Description

This command and the qoperation dock command register a new client computer with the CommServe after a decoupled install using Custom Package. For more information, see Registering the Client Using the Command Line.

Usage

qoperation register [-cs <commserve_host_name>] [-hn <client_host_name>] [-port <Commvault Communications Service port number>] [-file <path to XML file>] [-ocn <display name override>] [-ohn <host name override>] [-dock <yes/no>] [-roaming <yes/no>] [-af <argsfile>] [-tf <tokenfile>] [-tk <token>] [-h]

options

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

CommServe name, client host name, CVD port number and dock are mandatory options for registering a new client computer with the CommServe after a decoupled install.

qoperation register -cs server1 -hn client1 -port 8600 -dock yes

qoperation snap

Description

This command allows you to mount or unmount snapshots.

In case of an error, an error code and description are displayed as: "snap: Error errorcode: errordescription"

Usage

qoperation snap [-cs <commserve_host_name>] -o <mount|unmount> [-cid <Commcell Id>] -v <Volume Id> [-dc <Destination Client Name>] [-dpath <Destination Path>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure. 

Example

• For mounting -o mount -v volumeID -dc Destination Client Name -dpath Destination Path are mandatory options.

  E:\commandline>qoperation snap -v 128 -o "mount" -dc "client1" -dpath "/mpath"

• For unmounting -o unmount -v volumeID are mandatory options.

  E:\commandline>qoperation snap -v 128 -o "unmount"

qoperation setencryptionprops

Description

This command allows you to set encryption properties for a given client.

In case of an error, an error code and description are displayed as: "setencryptionprops: Error errorcode: errordescription"

Usage

qoperation setencryptionprops [-cs <commserve_host_name>] -c <client> -encryptdata <encrypt> [-cipher <cipher>] [-keylength <keylength>] [-synthfull <synthfull>] [-mediaaccess <mediaaccess>] [-af <argsfile>] [-h]

Options

Argument Files

For information on creating an argument file, see Command Line - FAQ - How do I use argument files in commands.

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures, due to the use of an unsupported option or missing argument.

2 - Any other failure.

Example

• To set Data Encryption Algorithm:

  qoperation setencryptionprops -c "client1" -encryptdata y -cipher SERPENT
  Updated client (client1) encryption properties successfully.

• To set Direct Encryption Algorithm BLOWFISH with Keylength of 256:

  qoperation setencryptionprops -c "client1" -encryptdata y -cipher BLOWFISH -keylength 256
  Updated client (client1) encryption properties successfully.

Last modified: 4/6/2018 6:14:23 PM