Command Line Interface - CommServe QCommands

Table of Contents

Available Commands

Before executing a command, make sure to log on to the CommServe using the qlogin command. Similarly, use the qlogout command to log off from the CommServe.

qcreate user

The qcreate user command is deprecated. For similar functionality, use the XML template method explained in User Administration and Security - Advanced - Creating a User.

qdelete client

Description

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

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

-cs CommServe host name
-c Client computer name
-deconfigure Deconfigures a client without deleting it
-y Delete without confirmation
-tf Reads token from a file
-tk Token string
-af Reads client name from a file
-h Displays help

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

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.

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

-h Displays help

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.

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

-af XML file that contains the request
-dpath Destination path and file name for the XML output file
-tf Reads token from a file
-tk Token string
-example Sample "find" and "browse" XML requests
-h Displays help

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 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 [-tf <tokenfile>] [-tk <token>] [-h]

Options

-tf Reads token from a file
-tk Token string
-h Displays help

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

ursa_major    Windows XP              Yes

metal         Windows 2000            Yes

virgo         SunOS                   Yes

aries         HP-UX                   Yes

chara         NetWare                 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

-tf Reads token from a file
-tk Token string
-h Displays help

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.

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

-t Filter type (Windows or Unix)
-tf Reads token from a file
-tk Token string
-h Displays help

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 displays the job details of a given job ID, or of all the active jobs under a client, agent, instance backup set or subclient. The command displays job details such as job ID, type, phase, status, failure reason, and user-defined description.

When a job ID is specified, the job details are displayed regardless of the job status. When no option is specified in the command, it displays all active jobs in the CommServe. Only active jobs are displayed when you query jobs based on client, agent, instance, backup set, or subclient.

Additionally, you can filter the jobs based on the job type or status. Only those jobs with the specified type/status are displayed in the command prompt. When more than one job is found, the jobs are listed one job per line, and are displayed in the command prompt. The system displays a message "No jobs to display" when there are no jobs.

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 <iDataAgent Type>] [-i <instance>] [-b <backupset>] [-s <subclient>] [-waitForJobComplete] [-waitTimeoutSecs <waitTimeoutSecs>] [-tf <tokenfile>] [-tk <token>] [-h] [-af <argsfile>]

Use the [-jt <jobtype>] option to specify the job operation that you want to display. This will prevent displaying other job operations, such as administration jobs.

Options

-cs CommServe host name
-co Columns to return. By default, all columns are enabled except the Failure/Pending Reason column. Use the following column codes with the -co option:
Code Description Comments
i Job ID  
o Job Type  
s Job Status Job statuses:
  • Running
  • Suspend Pending
  • Suspended
  • Pending
  • Waiting
  • Kill pending
  • Queued
The following job statuses are valid if the -j option is used:
  • Failed
  • Failed to Start
  • Killed
  • Completed
p Job Phase  
r Failure/Pending Reason  
d Job Description  
c Job Progress (percentage of completion)  
-j Job ID
-jt Filters the jobs by type. Valid values are:
  • Backup
  • Restore
  • Admin
-js Filters the jobs by status. Valid values are:
  • Running
  • Suspended
  • Waiting
  • Pending
-c Client computer name
-a Agent type installed on the client computer (see Argument Values - Agent Types).
-i Instance name
-b Backup set name
-s Subclient name
-waitForJobComplete Waits indefinitely until the job completes. If the operation returns error code 0x205, retry the operation.

This option must be used with the -j option. To define a specific wait period, use this option with the -waitTimeoutSecs option.

-waitTimeoutSecs Use with the –waitForJobComplete option. Waits the specified seconds for the job to complete. If the job does not complete within the specified seconds, the current status of the job is returned.
-tf Reads token from a file
-tk Token string
-h Displays help
-af Reads arguments from a file

When you run the qlist job command with no options specified (to display all the active jobs), any description that the user specified for the job is partially displayed. Similarly, a partial description is displayed if you run the command for a specific job along with the -co option (including the d value), for example qlist job -j jobid -co iod.

To display the entire user-defined description for a specific job, you must run the following command: qlist job -j jobid -co d.

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

  • List the details of a given job ID

    E:\commandline>qlist job -j 160

    JOBID  OPERATION  STATUS   PHASE  JOB DESCRIPTION COMPLETE PERCENTAGE
    -----  ---------  -------  -----  --------------- --------------------
    160    Backup     Running  Scan                   25

  • List the details of a given job ID and display only the ID and status.

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

    JOBID  STATUS
    -----  -------
    160    Running

  • Display the failure/pending reason for a job

    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

-cs CommServe host name
-c Client computer name
-a iDataAgent type installed on client computer (see Argument Values - Agent Types).
-i Instance name
-b Backup set name
-s Subclient name
-js Filters the jobs by status. Valid values are:
  • Completed
  • Failed
  • Killed
-st Start time

The time must be entered in the following format: mm/dd/yyyy hh:mm[:ss] or yyyy/mm/dd hh:mm[:ss].

-et End time

The time must be entered in the following format: mm/dd/yyyy hh:mm[:ss] or yyyy/mm/dd hh:mm[:ss].

-dispJobTime  Displays the job start and end time
-dispJobTimeUnix  Displays the job start and end time in Unix time format
-tf Reads token from a file
-tk Token string
-h Displays help

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 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

-c Client computer name
-a Agent type installed on client computer (see Argument Values - Agent Types)
-i Instance name, required for certain agents
-b Backup set name, required for certain agents
-s Name of the subclient
-tf Reads token from a file
-tk Token string
-h Displays help

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

-c Client computer name
-a Agent type installed on client computer (see Argument Values - Agent Types)
-i Instance name, required for certain agents
-b Backup set name, required for certain agents
-s Name of the subclient
-js The completion status of the job. Use this option to see the last backup job that completed with a particular status. Valid values for this option are:
  • Completed
  • Failed
  • Killed
-tf Reads token from a file
-tk Token string
-h Displays help

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, it is recommended to execute the XML file described in List Schedules and Schedule Policies from different CommCell Levels.

Usage

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

Options

-day Week day (0- Sunday .....6-Saturday)
-hour Hour(0-23)
-tf Reads token from a file
-tk Token string
-h Displays help

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 schedulepolicy

The qlist schedulepolicy command is deprecated. For similar functionality, use the XML template method explained in Schedule Policy - Advanced - List All Schedule Policies in the CommCell.

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

-cs CommServe host name
-j Job ID
-cid CommCell ID
-tf Reads token from a file
-tk Token string
-h Displays help

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 SnapProtect backup job ID 1.

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

qlist usergroup

Description

This command lists all of the user groups configured in the CommCell. Whenever multiple user groups are found, the name of each user group is listed in its own line and displayed on the console. No message is displayed on the console when user groups are not found.

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

Usage

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

Options

-tf Reads token from a file
-tk Token string
-h Displays help

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.

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 login 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.

The timeout for each login session is 14 days by default. If a session is idle for more than 14 days, it is terminated automatically.

The minimum timeout is 300 seconds (5 minutes).

You can modify the timeout using the SetKeyIntoGlobalParamTbl.sql qscript.

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

Use the following command to set the timeout for a CommServe:

qoperation execscript -sn SetKeyIntoGlobalParamTbl.sql -si QSDKSessionTimeOut -si y -si 3600

In the previous example, if the session is idle for more than 3600 seconds, the user must log in again to continue running commands.

Note: After you modify the timeout for login session, restart the Simpana Commands Manager (QSDK) service to allow the changes to take effect. For more information on how to restart a service, see Restarting a Service.

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>] [-p <password>] [-ps <passwordstrong>] [-clp <plainpasswordtext>] [-af <argsfile>] [-f <logintokenfile>] [-gt <givetoken>] [-csn <csClientName>] [-sso] [-localadmin <localadmin>] [-h]

Options

-cs CommServe host name

If a CommServe host name is not specified, this command logs on to the CommServe of the current host. To log on to a remote CommServe configured behind a firewall, specify the CommServe host name along with the CommServe client name.

-csn CommServe client name

If the CommServe client name is not specified, this command will automatically select the current CommServe client name.

-clp Plain text password
-u User name (prompted if not specified)
-p Encrypted password to log on to the CommServe.

You can create an encrypted password by saving any supported operation (i.e., backup or restore job) as a script using the CommCell Console. The script contains the qlogin string with the encrypted password, which you can copy and paste into other scripts.

-ps Strong encrypted password to log on to the CommServe. This option should be used for CommServe version 9 or higher.

You can create an encrypted password by saving any supported operation (i.e., backup or restore job) as a script using the CommCell Console. The script contains the qlogin string with the encrypted password, which you can copy and paste into other scripts.

-af Reads arguments from a file
-f Saves token to a file
-gt Returns the token after login
-sso Single Sign-On (SSO) login using the user account credentials from the Active Directory service provider. This option is available on Windows client computers.
-localadmin Allows the local administrator of a client computer (or a user with administrative rights) to log on to the CommServe without the need to specify a user name and password.

This option verifies that the user currently logged on to the client is a local administrator. Once authenticated, the user is automatically logged on to the CommServe as the owner of the client. All the operations that the user can perform will be limited to that client.

To enable this option, you need to set the nQSDK_ALLOW_LOCAL_ADMIN additional setting. See Configuring QLogin Command for Local Administrators to Access without Credentials for step-by-step instructions.

-h Displays help

Argument File

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

server CommServe host name
user User name (prompted if not specified)
passwordstrong Strong encrypted password to log on to the CommServe. (prompted if not specified)

You can create an encrypted password by saving any supported operation (i.e., backup or restore job) as a script using the CommCell Console. The script contains the qlogin string with the encrypted password, which you can copy and paste into other scripts.

To use plain text password, use the -clp command line option.

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:

Using Tokens to Perform QCommands

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

-cs CommServe host name
-all Logout all users
-tf Reads token from a file
-tk Token string
-h Displays help

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

-o Operation to be performed on the client group. Valid values are:
  • add
  • delete
-c Client computer name
-cg Client group name
-af Input file containing arguments
-tf Reads token from a file
-tk Token string
-h Displays help

Argument File

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

client [string] Client computer name
clientgroup [string] Client group name
operation [string] Operation to be performed on the client group. Valid values are:
  • add
  • delete
description [list<string>|multiline] Description provided by the user

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 galaxypassword

Description

This command changes the password of a CommCell user. The user whose password is to be changed is provided as a command line option. The user is prompted for the current password (for security purposes) and then prompted for the new password. This command also supports the option to provide the password at the command line for scripting purposes, in which case it modifies the password silently without any user intervention.

Upon successful completion, qmodify galaxypassword displays the message "Changed user password successfully" on the command prompt. In case of an error, an error code and description are displayed as: "galaxypassword: Error errorcode: errordescription"

Usage

qmodify galaxypassword -u <username> [-p <password>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

-u User name
-p Password
-tf Reads token from a file
-tk Token string
-h Displays help

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.

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

-o Operation to be performed on the global filter
-t Windows or UNIX subclients
-ff Reads files, folders, and patterns to be excluded from the file.
-tf Reads token from a file
-tk Token string
-h Displays help

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

-cs CommServe host name
-o Operation to be performed on the client group
-scp Schedule policy name
-c Client computer name
-a Agent type installed on the client computer (see Argument Values - Agent Types)
-i Instance name
-b Backup set name
-s Subclient name
-cg Client computer group name
-tf Reads token from a file
-tk Token string
-h Displays help

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 adduser

Description

This command adds an existing CommCell user to an existing CommCell user group.

Upon successful completion, qoperation adduser displays the message "Added user to the group successfully" in the command prompt. In case of an error, an error code and description are displayed as: "adduser: Error errorcode: errordescription"

Usage

qoperation adduser -u <user> -ug <group> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-u User name
-ug User group name
-h Displays help

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 user user1 to group group1.

qoperation adduser -u user1 -ug group1

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

-delbyjobid Flag to delete jobs by job ID.

When the -delbyjobid option is specified, the list of jobs or specified job is pruned based on the storage policy, storage policy copy or file type. If the CommServe name is not specified, the default CommCell value of the current CommServe is accepted.

When the -delbyjobid option is not specified, the agedata command starts a data aging job. The Job ID is returned in the command line and a job is displayed in the CommCell Console.

-delbystoreid Flag to delete jobs by deduplication database ID. This option is applicable for deduplication copies.
-j Job ID.
-sid Deduplication database ID.
-sp Name of the storage policy.
-spc Name of the storage policy copy.
-ft Valid values:
  • Q_LOG - To prune only log files for a specified job.
  • Q_DATA - To prune only data files for a specified job.
  • Q_DATA_LOG - To prune both data files and log files for the specified job.
-cs  CommCell name.
-af   Reads arguments from a file.
-tf Reads token from a file.
-tk Token string.
-h    Displays help.

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.

jobid  Provide job ID.
sp Name of the storage policy.
spcopy Name of the storage policy copy.
filetype
  • Q_LOG - To prune only log files for a specified job.
  • Q_DATA - To prune only data files for a specified job.
  • Q_DATA_LOG - To prune both data files and log files for the specified job.

Example

  • To run a data aging job.

    qoperation agedata

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

    qoperation agedata -delbyjobid -j 23453 -sp 'Storage Policy 01' -spc 'Primary Copy' -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

-c Name of the client to capture
-dfn Full path and the dump file name on the CommServe
-dbn Name of the database from which you wish to capture data.
(This is useful when you want to capture data from a database
other than the current CommServe.)
-afn Full path and the answer file name on the local Client
-st Start date and time from which data will be captured. The time must be entered in the following format: mm/dd/yyyy hh:mm[:ss] or yyyy/mm/dd hh:mm[:ss].
-et End date and time until which data must be captured. The time must be entered in the following format: mm/dd/yyyy hh:mm[:ss] or yyyy/mm/dd hh:mm[:ss].
-u User name, if database location is an UNC path
-p Password, if database location is an UNC path
-rp Alternative database restore path.

This option is useful when migrating clients in the clustered environment. In a cluster, the CommServe binaries are installed on the physical server and the database is located on the shared disk resource. As the capture and merge operations are executed on the physical server that hosts the binaries, the -rp option provides a way to specify the path to the shared disk resource in which the database resides. (If this option is not specified, the command will by default look for the database in the same drive in which the binaries reside and the operation will fail.)

-af Reads arguments from a file
-tf Reads token from a file
-tk Token string
-h Displays help

Argument File

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

clients [list] List of clients to capture
dumpfilename [string] Full path and the dump file name on the CommServe
databasename [string] Name of the database from which you wish to capture data.
(This is useful when you want to capture data from a database
other than the current CommServe)
answerfile [string] Full path and the answer file name on the local Client
starttime [time] Start date and time from which data will be captured The time must be entered in the following format: mm/dd/yyyy hh:mm[:ss] or yyyy/mm/dd hh:mm[:ss].
endtime [time] End date and time until which data must be captured. The time must be entered in the following format: mm/dd/yyyy hh:mm[:ss] or yyyy/mm/dd hh:mm[:ss].
user [string] User name, if database location is an UNC path
password [string] Password, if database location is an UNC path

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

-cs CommServe host name
-c Client computer name
-sm Displays summary of check readiness
-dt Displays detailed report on check readiness
-tf Reads token from a file
-tk Token string
-h Displays help

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. For more information, see Register the Client from the Command Line.

Usage

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

Options

-c Client name
-roaming Designates a client with the Workstation Backup Agent as a roaming client

Valid values are y/n

-tf Reads token from a file
-tk Token string
-h Displays help

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

-t Backup type. Valid values are:
  • Q_FULL
  • Q_DIFF
-af Reads arguments from a file
-tf Reads token from a file
-tk Token string
-h Displays help

Argument File

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

backuptype Backup type (Q_FULL|Q_DIFF)
alert Alert name
retryno Number of times to retry the job
retrytime Number of hours to retry the job
jobdescription User-defined comments regarding the job

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

This command can be used 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 any failure in creating the output file, the output is displayed on the command prompt after the script is executed. Also, if you do not provide any file name, the output is displayed on the command prompt by default.

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

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.

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

-cs CommServe Name
-sn (String) Name of the script to be executed
-c Remote client name
-si (String) Inputs to the script

Note that the -si option must precede every input parameter to the script

-p1 Password to be encrypted using V1 Encryption
-p2 Password to be encrypted using V2 Encryption
-p3 Password to be encrypted using V3 Encryption
-file File where the output is to be written
-format Output format, which can be xml, xls or csv (where xls:tab, csv:comma separated)
-help Displays help on SQL script
-tf Reads token from a file
-tk Token string
-h Displays help

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 as well as user-created XML files.

Alternatively, you can perform this operation using the Save as Script option from the CommCell Console. The Save as Script option includes a batch (.bat) and .xml file. The batch file will include 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.

Usage

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

Options

-cs CommServe host name
-af input file
-req XML request (tag of the XML)
-insert Insert the fields into XML
-tf Reads token from a file
-tk Token string
-h Displays help

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.

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

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 <mediaagent>] [-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

-o Operation to be performed on the job. Valid values are:
  • kill
  • suspend
  • resume
  • changepriority
  • setpercentcomplete
-j Job ID
-all All jobs
-m MediaAgent name
-c Client computer name
-a iDataAgent type installed on client computer (see Argument Values - Agent Types)
-i Instance name
-b Backup set name
-s Subclient name
-p Job priority
-tfx Total files to transfer
-fx Files transferred
-ifx Files transferred since last update
-tbx Total bytes to transfer
-tf Reads token from a file
-tk Token string
-h Displays help

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

-dfn Path and Dump file name on the CommServe
-afn Answer file name (with the path) on the client that was generated during capture
-u User name, if database location is an UNC path
-p Password, if database location is an UNC path
-cl y or n - This option determines whether a licenses is consumed or not for the merged client.
-rt y or n - This option determines whether or not to mark the media as reusable in the new CommCell.
  • If the answer is set to 'Y', the media will be reused even if the library option to use media from a different CommCell is disabled.
  • If the answer is set to 'N', you can later select the media for reuse at the destination CommCell using the Mark Migrated Media Reusable option.
-rp Alternative database restore path.

This option is useful when migrating clients in the clustered environment. In a cluster, the CommServe binaries are installed on the physical server and the database is located on the shared disk resource. As the capture and merge operations are executed on the physical server that hosts the binaries, the -rp option provides a way to specify the path to the shared disk resource in which the database resides. (If this option is not specified, the command will look for the database in the same drive in which the binaries reside by default, and the operation will fail.)

-af Reads arguments from a file
-tf Reads token from a file
-tk Token string
-h Displays help

Argument File

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

dumpfilename [string] Path and Dump file name on the CommServe
answerfile [string] Answer file name (with the path) on the client that was generated during capture
consumelicense [y|n] This option determines whether a licenses is consumed or not for the merged client.
reusetapes [y|n] This option determines whether or not to mark the media as reusable in the new CommCell.
  • If the answer is set to 'Y', the media will be reused even if the library option to use media from a different CommCell is disabled.
  • If the answer is set to 'N', you can later select the media for reuse at the destination CommCell using the Mark Migrated Media Reusable option.
user [string] User name
password [string] Password

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

-sc Source client computer name
-a Agent type installed on source client computer (see Argument Values - Agent Types)
-i Instance name to be moved
-dc Destination client name
-af Reads arguments from a file
-tf Reads token from a file
-tk Token string
-h Displays help

Argument File

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

sourceclient List of source client computer names
dataagent Agent type installed on source client computer (see Argument Values - Agent Types)
instance Instance name to be moved
destinationclient Destination client computer name

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. For more information, see Register the Client from the Command Line.

Usage

qoperation register [-cs <commserve_host_name>] [-hn <client_host_name>] [-port <NetApp 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

-cs CommServe host name
-hn Host name of the client being registered
-port Port number to contact CVD on the client
-file Path to the XML file with installation details
-ocn Override client display name in the XML file
-ohn Override client host name in the XML file
-dock Flag to confirm registration
-roaming Flag to indicate roaming client
-af Reads arguments from a file
-tf Reads token from a file
-tk Token string
-h Displays help

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

-cs CommServe host name
-o Operation to be performed on the snapshot
-cid CommCell Id
-v Volume Id
-dc Destination client name
-dpath Destination path
-tf Reads token from a file
-tk Token string
-tf Reads token from a file
-tk Token string
-h Displays help

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>] [-restoreaccess <restoreaccess>] [-synthfull <synthfull>] [-mediaaccess <mediaaccess>] [-passphrase <passphrase>] [-af <argsfile>] [-h]

Options

-cs CommServe host name
-c Client computer name
-encryptdata Encrypt data.
-cipher Data Encryption Algorithm (BLOWFISH|GOST|AES|SERPENT|TWOFISH|3-DES)
-keylength Key Length(128|256)
-restoreaccess Restore Access Type (regular|passphrase)
-synthfull Enable Synthetic Full. Valid values are 'y' and 'n'
-mediaaccess Direct Media Access (password|passphrase|noaccess)
  • The Pass-Phrase feature is deprecated.
  • Clients with existing Pass-Phrase configurations are supported.
-passphrase Pass-Phrase Present. Valid values are 'y' and 'n'
  • The Pass-Phrase feature is deprecated.
  • Clients with existing Pass-Phrase configurations are supported.
-af Reads arguments from a file
-tf Reads token from a file
-tk Token string
-h Displays help

Argument Files

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

server CommServe host name
client Client computer name
encryptdata Encrypt Data. Valid values are 'y' and 'n'
cipher Data Encryption Algorithm (BLOWFISH|AES|SERPENT|TWOFISH|3-DES)
keylength Key Length(128|256)
restoreaccess passphrase
synthfull Enable Synthetic Full. Valid values are 'y' and 'n'
mediaaccess Direct Media Access (password|passphrase|noaccess)
  • The Pass-Phrase feature is deprecated.
  • Clients with existing Pass-Phrase configurations are supported.
passphrase Pass-Phrase Present. Valid values are 'y' and 'n'
  • The Pass-Phrase feature is deprecated.
  • Clients with existing Pass-Phrase configurations are supported.

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.

qoperation setpassphrase

  • The Pass-Phrase feature is deprecated. For similar functionality, use Privacy.
  • Clients with existing Pass-Phrase configurations are supported.

Description

This command allows you to set the passphrase for a given client.

Prerequisites:

  • Encryption option should be enabled.               
  • Media Access option should not be "via Pass-phrase"

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

Usage

qoperation setpassphrase [-cs <commserve_host_name>] -c <client> -o <operation> [-h]

Options

-cs CommServe host name
-c Client computer name
-o operation (create|modify)
-tf Reads token from a file
-tk Token string
-h Displays help

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 modify a pass-phrase:

    qoperation setpassphrase -c "c1" -o "modify"

    Old Pass-Phrase:
    New Pass-Phrase:
    New Pass-Phrase Again:
    Modified Pass-Phrase Successfully.

  • If passphrase doesn't exists and user tries to modify it:

    qoperation setpassphrase -c "c1" -o "modify"

    Old Pass-Phrase:
    New Pass-Phrase:
    New Pass-Phrase Again:
    setpassphrase: Error 0x13f: Pass-Phrase not exist for the client.