Command Line Interface

Topics | QScripts | How To | Troubleshoot | Support | Related Topics

Overview

• Configuration
• Log In Sessions
• Argument Files
• Date/Time Format
• Error Logging

Saving a Job as a Script

• Script Considerations

Writing and Editing Scripts

QCommands:

Overview

QCommands provide access to several basic functions through the command line, and can be integrated into your own scripts and scheduling programs. You can write scripts using the commands listed below. Note that scripts can also be generated through the CommCell Console for some features using the Save as Script option. All commands have consistent output in all situations to facilitate easier script writing.

Although several command line options are supported, it must be noted that the CommCell Console is the recommended method to manage your CommCell as it provides comprehensive support for all options available in the software. See CommCell Console for more information.

English is the only language that is supported across all qcommands.

Configuration

No special configuration is required to use the command line interface. The commands are integrated with the Base package, and are therefore available on all computers which have any CommServe, MediaAgent, or Agent software installed.

In order for the commands to function, the Bull Calypso Commands Manager service should be up and running on the CommServe. The Bull Calypso Commands Manager is a service that is installed with the CommServe, and is responsible for handling command line requests and forwarding them to the Event Management Service of the target CommServe. See Services for more information.

For non-root Unix users to have access to command line interface, the following two conditions must be met:

1. All non-root user logins must be associated with the same group as the application.
2. The software's home directory (for example, /opt/<software_installation_directory>) must have the permission value set to 775.

Log In Sessions

Using the Qlogin command, you can start a User login session, removing the need to log in for every command. Once the Qlogin command is successful, the login session for all computers remain valid until you explicitly log out using the Qlogout command. This is true for all command sessions, not just the one for which the login took place.

Argument Files

Some commands can read command line arguments from a file. This is useful for complex commands that require many arguments. If a command can accept an argument file, an Argument File section will appear under Options in the command documentation below.

You can provide this file as an input to the command through the -af <filename> option. Command lines can accept both the input file, as well as command line arguments. However, when both exist, arguments provided through the input file will overwrite the command line options.

Commands that support file inputs

• qcreate backupset
• qcreate subclient
• qdelete backupset
• qdelete subclient
• qmodify instance
• qmodify subclient
• qoperation auxcopy
• qoperation backup
• qoperation report
• qoperation restore

Format

The input file contains a list of options and their value(s). Both options and values should always start on a new line (white space at the beginning and end of each line is ignored). Options are surrounded by "[" and "]", and they must always be written in lower-case letters. Any line that begins with "[" and ends with a "]" is treated as an option. An option can take more than one value, and each value should be specified in a separate line. All lines that start with "#" are treated as comments and are ignored.

Sample input file

# Sample input file which has three options option1, option2 and option3.
# option1 takes one value "value1"
# option2 takes two values "value2" and "value3"
# option3 takes one value "value4"

[option1]

value1

[option2]

value2

value3

[option3]

value4

Argument file samples

Several argument file samples are available in the <software install folder>\QCommands-Samples. They are:

• Sample-Capture: argument file to create a Capture file for CommCell Migration.
• Sample-CreateBackupset: argument file to create a backup set under the given agent with specified name.
• Sample-CreateSubclient: argument file to create a subclient under the given backup set with the specified storage policy and content.
• Sample-DeleteBackupset: argument file to delete a given backup set name.
• Sample-DeleteSubclient: argument file to delete a subclient.
• Sample-Merge: argument file to create a merge file for CommCell Migration.
• Sample-ModifySubclient: argument file to modify an existing subclient's content and/or storage policy.

Date/Time Format

For commands in which a time must be specified, the time must be entered in the following format:

mm/dd/yyyy hh:mm[:ss]

Example:

08/30/2005 05:58
Or
08/30/2005 05:58:15

Error Logging

All errors from qcommands are logged in the following locations:

In the Client computer:

<software_install_folder>\Log Files\qcommand.log

In the CommServe computer:

<software_install_folder>\Log Files\QSDK.log

Back to Top

Saving a Job as a Script

Data Protection, Recovery, Auxiliary Copy, Disaster Recovery Backup, and Data Aging operations and their selected options can be saved as script files using the CommCell Console, which can later be executed from the command line. See Command Line Interface - Save a Job as a Script for more information.

Script Considerations

Consider the following before you save a job as a script:

• When you use the CommCell Console to save a script, only the options that are available for the corresponding QCommand are saved. For example, the Job Retry option is available in the CommCell Console for several operations such as backup and restore. However, this option is not available in the corresponding QCommand. Therefore, if you Save a Script with Job Retry options selected, they will be ignored when the script is generated.

• If a script with same name exists, you can decide if the existing script must be overwritten. In addition, you can decide the extension of the save as script file.

• You can also save a script remotely.

  To save the script on a remote computer, you must enter the path and file extension. For e.g., .bat, .sh, etc.
• Saving an operation as a script through the CommCell Console creates the script and an input file on the CommServe computer. After they have been saved, the script can be run on the CommServe or you may move and run it on any other client computer. If you move the script, you must move both the script and input files to the client computer from which the script will be executed.
  • On Windows, add a rem comment to the line that sets the GALAXY_BASE variable to the CommServe path and remove the rem comment from the line that sets it to the client's path. The batch file contains instructions on how to do this.
  • On Unix, the script must be edited to reflect the absolute path for the GALAXY_BASE variable only in cases where you have added a node to a cluster beyond the first physical and virtual node. The batch file contains instructions on how to do this.

• A save a job as script file can run as a pre/post process only if you include the absolute path of the associated input file in the script file. Therefore, be sure to include this path in the script file.

• When you use the CommCell Console to save a script, certain characters (for example, the left bracket [ and number sign #) in front of an object name (for example, #csmacs as the subclient name) may cause the script to not work correctly when it is run from the command line. If your script does not work from the command line, check it for these characters. You may need to rename the object by removing the characters, and then rerun your script.
• When you use the CommCell Console to save a backup script for a Microsoft SharePoint 2003 Document iDataAgent and run it from the command line, the script will only back up the latest version of a document. This will happen even when you choose the Backup All Versions option when generating the script.
• You cannot save a script to a cluster virtual server; as such, the Client selection list will not include cluster virtual servers when you use the CommCell Console to save a script. Be sure to save the script locally on a non-clustered computer (CommServe or client) and then copy the script to the desired location on the cluster.

Back to Top

Writing and Editing Scripts

When writing or editing scripts, note the following:

• Character Limitations
  • Commands and their options are all contained on a single line. Check your operating system guidelines to ensure you do not exceed any line length limitations.
  • Unicode is not supported by the command line interface.
• File Archiver with Data Classification

  For the File Archiver with Data Classification, the DataClassSet is represented internally as an archive set, and the DataClassSet subclient is represented internally as a subclient.

  • When executing a Data Classification-enabled File Archiver script that requires both the DataClassSet and the DataClassSet subclient, provide the DataClassSet with the same name as that for the DataClassSet subclient. For Data Classification, the DataClassSet name is the same as the DataClassSet subclient name. For example, consider the following command:

    E:\commandline>qoperation backup -c COMPUTERNAME -a Q_WINFS_MIG -b BACKUPSET -s SUBCLIENT -t Q_FULL

    To archive data for a DataClassSet and a DataClassSet subclient, the command might appear as follows:

    E:\commandline>qoperation backup -c BERRY -a Q_WINFS_MIG -b department01 -s department01 -t Q_FULL

  • Since Data Classification is an enabler, any File Archiver for Windows with Data Classification command always requires that you use the File Archiver for Windows parameter (i.e., Q_WINFS_MIG).
• Username and encrypted password
  • Before using any of the commands, you must log on the CommServe using the qlogin command. The -p argument of the qlogin command provides a password for this purpose. You can obtain this encrypted value by saving any supported operation (i.e., a backup or restore job) as a script through the CommCell Console. This creates the qlogin string and encrypted password for the user that is currently logged on to the CommCell Console. You can then copy and reuse the qlogin string from that script in other scripts. For more information, see the description for the qlogin command.
• Argument Options

  The options within an argument file are always enclosed within "[" and "]", and they must always be written in lower-case letters (e.g., [client]).

• Argument Values
  • When specifying paths in command line arguments, always use the full path. In most cases, relative paths are not supported. However, they can be used if arguments are supplied using an input file.
  • Avoid using the following characters when specifying argument values:
    " % * ? - \ $
  • On Windows, when entering argument values that contain a space or special character, be sure to put the argument value in quotes (e.g., -argument "argument value"). On the Unix platform, use "\"\"" notation (e.g., -argument "\"argument value\""). If the argument value is an empty string, enter "" (Windows) and enter "\"\"" (Unix).

  Argument values that you use in a command string or arguments file are case-sensitive. Some argument values that are available for use in both a command string and an arguments file may not work in a command string; however, these values should always work when included in an arguments file. Therefore, use argument files as appropriate.

• Miscellaneous
  • If you are performing a backup of multiple subclients (for example, a backup at the backup set level), the command line will default to asynchronous mode.
• Platforms
  • QCommands cannot be executed on the NetWare platform. However, QCommand scripts for the NetWare agents can be run on the CommServe, or another Windows or Unix client in the CommCell.

Back to Top

qcreate

This command creates an entity based on the specified command.

Usage:

qcreate command <command-options-arguments> [-h]

Supported Commands:

• backupset
• instance
• repset
• sp (storage policy)
• spcopy (storage policy copy)
• subclient
• user

backupset

This command creates a backup set under the given agent or instance with the specified name.

Usage:

qcreate backupset -c client -a dataagenttype -i instance -n backupset [-sp storagepolicy] [-t NORMAL|DEFAULT|ONDEMAND] [-af Argument Filepath] [-h]

Description:

This command creates a new backup set with the given backup set name under the specified client and agent. An instance name is required for those agents that allow backup sets under instances. This command also allows the user to create default backup sets and on-demand backup sets. The default subclient created under the backup set can also be associated with a storage policy (the subclient will remain unassigned if the storage policy name is not passed).

Upon successful completion, qcreate backupset displays the message "Created backupset successfully" in the console. In case of an error, an error code and the error description are displayed in the following format: "backupset: Error errorcode: errordescription"

Options:

Command Line

Argument File

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:

Create a backup set with name bs1 under client client1 and  Agent Q_WIN2K_FS.
E:\commandline>qcreate backupset -c client1 -a Q_WIN2K_FS -n bs1

Back to Top

instance

This command creates an instance under the given agent.

Usage:

qcreate instance -c client -a iDataAgent -n instance -dsp defaultstoragepolicy -csp cmdlinestoragepolicy -lsp logstoragepolicy [-o overrideCSSettings] [-lsa localsysaccount] [-su SQLUser] [-p SQLpassword] [-hu Host User Windows|Unix)] [-ntu ntuser] [-ntp ntpas sword] [-oh oracleHome] [-ocu connectUser] [-ocp connectPassword] [-ocs connectService] [-ct usecatalog] [-ctu catalogUser] [-ctp catalogPassword] [-cts catalogService] [-du DB2user] [-dp DB2password] [-dh DB2Home][-af argsfile] [-h]

Description:

This command creates an instance under the specified agent. Instance creation for the following agents is supported:

• DB2 iDataAgent
• Oracle iDataAgent (including On Demand instance)
• SQL Server iDataAgent

All the instances require the client name, agent name and the name of the instance for the agent.

• DB2 iDataAgent instance creation requires the default storage policy, a log storage policy and a command line storage policy. The DB2 user name and password are required for authentication, and the DB2 Home is also required. If the user name and password are not provided using the options, you will be prompted for this information. Also, the Windows NT user name and password are required for authentication.
• Oracle iDataAgent instance creation requires the name of the instance for the agent, the default storage policy, a log storage policy and a command line storage policy. Also, the Windows NT user name and password are required for authentication, and the Oracle Home, connect user name, password and service are required to connect to the Oracle service. You also need to provide the host user name (for Windows Client) or Oracle user name (for Unix Client) to create an Oracle iDataAgent instance.  If a catalog is required, the usecatalog option must be set to yes, and the catalog user, password and service must be provided; otherwise, the option must be set to no.
  • On Demand Oracle instance creation requires no additional options; all options specified for the Oracle iDataAgent are accepted per their default value. The instance name is a string and must be provided as an On Demand Instance.

  In order to create an instance for Oracle on Unix client on a Windows CommServe, you need to use the QCreate Instance command with an input file. This is because "/" is an argument separator in Windows and hence cannot be used for paths.

• SQL Server iDataAgent instance creation requires the default storage policy, a log storage policy, and the appropriate authentication.

  Three types of authentication are supported:

  • The user can provide the authentication that is at the global (Control Panel, Client Group, or iDataAgent) level by setting the override option (-o) to no.
  • The user can override the global settings and use the local machine authentication by setting the override option (-o) to yes.
  • The user can override the global settings to impersonate the user by setting the override option (-o) to yes, the local system account option (-lsa) to no and by providing the SQL user name and password. The authentication provided must allow you to connect to the SQL instance for the agent.

Upon successful completion, qcreate instance displays the "Created instance successfully" message on the CommCell Console. In case of an error, an error code and the error description are displayed in the following format: "Instance: Error errorcode: errordescription".

Options:

Command Line

Argument File

General

DB2

Oracle

SQL

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:

Create an instance with name CLIENT1\BullCalypso under client Client1 and  Agent Q_MSSQL.
C:\calypso\Base\qcreateinstance -c Client1 -a Q_MSSQL -n -CLIENT1\BullCalypso -dsp SP1 -lsp SP1 -o no

Created instance successfully.

Create an On Demand instance under client rman10g and Agent Q_ORACLE.
C:\calypso\Base\qcreate instance -c rman10g -a Q_ORACLE -n -"On Demand Instance"

Created instance successfully.

Create an Oracle instance for agent Q_ORACLE

C:\calypso\Base\qcreate instance -c rdlab04 -a Q_ORACLE -n DB1 -dsp ora_data -csp Lin_mag -lsp ora_log -hu oracle -oh "/export/home/oracle/oracle10" -ocu sys -ocp sys -ocs DB1 -ct yes -ctu rdlabdb1 -ctp rdlabdb1 -cts rcat10g2

Created instance successfully.

Back to Top

repset

This command creates a replication set under the given agent or instance with the specified name.

Usage:

qcreate repset -rp repset policy -c client -a idataagent -n repset name [-h]

Description:

This command creates a new Replication Set which is similar in concept to a Backup Set which is used by some Agents, and represents a logical grouping of Replication Pairs. This allows you to configure certain properties and activities at the Replication Set level, and thus control all the included Replication Pairs together.

Upon successful completion, qcreate repset displays the message "Created replication set successfully" in the console. In case of an error, an error code and the error description are displayed in the following format: "sp: Error errorcode: errordescription"

Options:

Command Line

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:

Create a repset with name rd1 and replication set policy rp_policy1 under client client1 and agent Q_FILE_REPLICATION.
E:\commandline>qcreate repset -rp rp_policy1 -c client1 -a Q_FILE_REPLICATION -n rd1

sp

This command creates a new storage policy (for data protection).

Usage:

qcreate sp -sp storagepolicy -m mediaagent -l library -d drivepool -srp scratchpool [-isp incstoragepolicy] [-h]

Description:

This command creates a new storage policy for data protection. The drive pool name to which the backup data of Primary copy is directed, the incremental storage policy name, and the scratch pool from which the copy obtains new media can also be specified.

Upon successful completion, qcreate sp displays the message "Created storage policy successfully" in the console. In case of an error, an error code and the error description are displayed in the following format: "sp: Error errorcode: errordescription"

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:

Create a copy with name copy1 for storage policy sp1, MediaAgent magent1, library maglib1.
E:\commandline>qcreate sp -sp sp1 -m magent1 -l maglib1

Back to Top

spcopy

This command creates a new secondary copy (synchronous) for the specified storage policy.

Usage:

qcreate spcopy -sp storagepolicy -n copy -m mediaagent -l library -d drivepool -srp scratchpool [-h]

Description:

This command creates a new secondary copy of the specified storage policy. The new copy will be a synchronous copy, which means that everything from the primary copy (including full, differential, and incremental backups) are copied to the secondary copy. By default, the new copy is enabled for media reads/writes. The drive pool name to which the backup data of the Primary copy is directed, as well as the scratch pool from which the copy obtains new media, can also be specified.

Upon successful completion, qcreate spcopy displays the message "Created storage policy copy successfully" in the console. In case of an error, an error code and the error description are displayed in the following format: "qcreate spcopy: Error errorcode: errordescription"

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:

Create a copy with name copy1 for storage policy sp1, MediaAgent magent1, library maglib1.
E:\commandline>qcreate spcopy -n copy1 -sp sp1 -m magent1 -l maglib1

Back to Top

subclient

This command creates a subclient under the given backup set or instance with the specified storage policy and content.

Usage:

qcreate subclient -c client -a dataagenttype -b backupset -i instance -n subclient -sp storagepolicy -f content [-wc y|n] [-af argsfilepath] [-h]

Description:

This command creates a new subclient with the given subclient name and content under the specified client and agent. The instance name and backup set name are required for certain agents, and should be specified when applicable. The new subclient will be associated with the specified storage policy. If you want to enable de-duplication, create the [singleinst] section in the Argument file and specify whether de-duplication should be performed in the MediaAgent or the Client.

Upon successful completion, qcreate subclient displays the message "Created subclient successfully" in the console. In case of an error, an error code and the error description are displayed in the following format: "subclient: Error errorcode: errordescription"

Options:

Command Line

Argument File

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

Create a subclient with name sc1 under client client1, iDataAgent Q_WIN_FS and backup set bs1 with content c:\ and storage policy sp1. E:\commandline>qcreate subclient -c client1 -a Q_WIN_FS -b bs1 -n sc1 -f "c:\" -sp sp1

Example 2:

Create a subclient with name sc1 under client client1, iDataAgent Q_MSSQL and backup set bs1 with content c:\ and storage policy sp1.
E:\commandline>qcreate subclient -c client1 -a Q_MSSQL -b bs1 -n sc1 -f "c:\" -sp sp1

Example 3:

Create a subclient with name sc1 under client client1, iDataAgent Q_SHAREPOINT_SERVER and backup set bs1 with content c:\ and storage policy sp1.
E:\commandline>qcreate subclient -c client1 -a Q_SHAREPOINT_SERVER -b bsl -n sc1 -f "c:\" -sp sp1

Back to Top

user

This command creates a user account.

Usage:

qcreate user -u username [-p password] [-fn fullname] [-desc description] [-e email] [-en loginEnabled] [-pa agepassword] [-ug usergroups] [-af argsfile] [-h]

Description:

This command creates a new user account with the supplied user name and password. If the password is not specified at the command line, it will be prompted. The other options are optional.

By default, the login is enabled when there is no input specified for the [-en loginEnabled] option. Also, by default, the user belongs to the View All group when there is no input specified for the [-ug usergroups] option.

Upon successful completion, qcreate user displays the message "Created a new user successfully" in the console. In case of an error, an error code and the error description are displayed in the following format: "user: Error errorcode: errordescription"

Options:

Argument File:

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:

Create a user user1 with password password1.
E:\commandline>qcreate user -u user1 -p password1

Back to Top

qdelete

This command deletes an entity based on the specified command.

Usage:

qdelete command <command-options-arguments> [-h]

Supported Commands:

• backupset
• client
• dataagent
• mediaagent
• sp (storage policy)
• spcopy (storage policy copy)
• subclient

backupset

This command deletes a given backup set.

Usage:

qdelete backupset -c client -a dataagenttype -b backupset [-af ArgumentFilepath] [-h]

Description:

This command allows you to delete a given backup set.

Upon successful completion, qdelete backupset displays the message "Deleted backupset successfully" in the console. In case of an error, an error code and the error description are displayed in the following format: "backupset: Error errorcode: errordescription"

Options:

Command Line

Argument File

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:

Delete a backupset with name bs1 under client client1 and Agent Q_WIN2K_FS.
E:\commandline>qdelete backupset -c client1 -a Q_WIN2K_FS -b bs1

Back to Top

client

This command either deconfigures a given client or both deletes and deconfigures the client.

Usage:

qdelete client -c client [-deconfigure][-y] [-h]

Description:

This command either:

• Deconfigures a given client along with its iDataAgents without deleting these components, or
• Both deconfigures and deletes a given client as well as its iDataAgents

By default, this command asks for confirmation before deletion but this prompting can be suppressed by using the -y option.

Upon successful completion, qdelete client displays the message "Deleted the client successfully" in the console. In case of an error, an error code and the error description are displayed in the following format: "client: Error errorcode: errordescription" 

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.
E:\commandline>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 without any confirmation .
E:\commandline>qdelete client -c client1 -deconfigure -y

NOTES

• You can mass-delete clients by themselves or along with their associated MediaAgents by including this command (along with the qdelete mediaagent command, if desired) in the appropriate script and then running the script from the correct location. 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.

dataagent

This command either deconfigures a given iDataAgent or both deletes and deconfigures the iDataAgent.

Usage:

qdelete dataagent -c client -a iDataAgent [-deconfigure] [-y] [-h]

Description:

This command either:

• Deconfigures a given iDataAgent without deleting it, or
• Both deconfigures and deletes a given iDataAgent

By default, this command asks for confirmation before deletion but this prompting can be suppressed by using the "-y" option.

Upon successful completion, qdelete dataagent displays the message "Deleted the iDataAgent successfully" on the console. In case of an error, an error code and the error description are displayed in the following format: "dataagent: Error errorcode: errordescription"

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 an iDataAgent Q_ORACLE under client client1.
E:\commandline>qdelete dataagent -c client1 -a Q_ORACLE
This command deconfigures and deletes an iDataAgent, do you want to configure (y/n)

Deconfigure an iDataAgent Q_ORACLE under client client1 without any confirmation.
E:\commandline>qdelete client -c client1 -a Q_ORACLE -deconfigure - y

Back to Top

mediaagent

This command deconfigures and deletes a given Mediaagent.

Usage:

qdelete mediaagent -m mediaagent [-y] [-h]

Description:

This command deconfigures and deletes a Mediaagent. By default, this command asks for confirmation before deletion but this prompting can be suppressed by using the "-y" option.

Upon successful completion, qdelete mediaagent displays the message "Deleted the MediaAgent  successfully" in the console. In case of an error, an error code and the error description are displayed in the following format: "mediaagent: Error errorcode: errordescription"

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:

Delete a MediaAgent with name M_Agent .
E:\commandline>qdelete mediadataagent -m M_Agent

NOTES

• You can mass-delete MediaAgents by themselves or along with their associated clients by including this command (along with the qdelete client command, if desired) in the appropriate script and then running the script from the correct location. 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.

Back to Top

sp

This command deletes a given storage policy.

Usage:

qdelete sp -sp storagepolicy [-h]

Description:

This command allows you to delete a given storage policy.

Upon successful completion, qdelete sp displays the message "Deleted storage policy successfully" in the console. In case of an error, an error code and the error description are displayed in the following format: "sp: Error errorcode: errordescription"

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:

Delete a storage policy with name sp1.
E:\commandline>qdelete sp -sp sp1

spcopy

This command deletes a given storage policy copy.

Usage:

qdelete spcopy -sp storagepolicy -spc copy [-h]

Description:

This command allows you to delete a given storage policy copy.

Upon successful completion, qdelete spcopy displays the message "Deleted storage policy successfully" in the console. In case of an error, an error code and the error description are displayed in the following format: "spcopy: Error errorcode: errordescription"

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:

Delete a storage policy copy with name spc1 under storage policy sp1.
E:\commandline>qdelete spcopy -sp sp1 -spc spc1

Back to Top

subclient

This command deletes a given subclient.

Usage:

qdelete subclient -c client -a dataagenttype -b backupset -s subclient [-af ArgumentFilepath] [-h]

Description:

This command allows you to delete a given subclient.

Upon successful completion, qdelete subclient displays the message "Deleted subclient successfully" in the console. In case of an error, an error code and the error description are displayed in the following format: "subclient: Error errorcode: errordescription"

Options:

Command Line

Argument File

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:

Delete a subclient with name sc1 under client client1 and Agent Q_WIN2K_FS and backupset bs1.
E:\commandline>qdelete subclient -c client1 -a Q_WIN2K_FS -b bs1 -s sc1 

Back to Top

qdrive

This command performs various drive operations.

Usage:

qdrive command <command-options-arguments> [-h]

Supported Commands:

• clean
• disable
• enable
• reset
• unload
• stampmedia

clean

This command cleans a given drive.

Usage:

qdrive clean -dr drive -l library [-h]

Description:

This command allows you to clean a drive.

Upon successful completion, qdrive clean displays the message "Request successful" in the console. In case of an error, an error code and the error description are displayed in the following format: "Clean: Error errorcode: errordescription"

Options:

Command Line

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:

Clean a drive Drive1 in library Library1.
E:\commandline>qdrive clean -dr Drive1 -l library1

Back to Top

disable

This command disables a given drive.

Usage:

qdrive disable -dr drive -l library [-h]

Description:

This command disables a drive in a specified library.

Upon successful completion, qdrive disable displays the message "Request successful" in the console. In case of an error, an error code and the error description are displayed in the following format: "disable: Error errorcode: errordescription"

Options:

Command Line

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:

Disable a drive Drive1 in library Library1.
E:\commandline>qdrive disable -dr Drive1 -l Library1

enable

This command enables a given drive.

Usage:

qdrive enable -dr drive -l library [-h]

Description:

This command enables a drive in a specified library

Upon successful completion, qdrive enable displays the message "Request successful" in the console. In case of an error, an error code and the error description are displayed in the following format: "enable: Error errorcode: errordescription"

Options:

Command Line

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:

Enable a drive Drive1 in the library Library1.
E:\commandline>qdrive enable -dr Drive1 -l Library1

Back to Top

reset

This command resets a given drive.

Usage:

qdrive reset -dr drive -l library [-h]

Description:

This command allows you to reset a drive for a specified library.

Upon successful completion, qdrive reset displays the message "Request successful" in the console. In case of an error, an error code and the error description are displayed in the following format: "reset: Error errorcode: errordescription"

Options:

Command Line

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:

Reset a drive Drive1 for library Library1.
E:\commandline>qdrive reset -dr Drive1 -l Library1

Back to Top

unload

This command unloads a given drive.

Usage:

qdrive unload -dr drive -l library [-h]

Description:

This command allows you to unload a drive for the specified library.

Upon successful completion, qdrive unload displays the message "Request successful" in the console. In case of an error, an error code and the error description are displayed in the following format: "unload: Error errorcode: errordescription"

Options:

Command Line

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:

Unloads a drive Drive1 for library Library1.
E:\commandline>qdrive unload -dr Drive1 -l Library1

Back to Top

stampmedia

This command labels media.

Usage:

stampmedia -dr drive -l library -b barcode [-h]

Description:

This command labels media associated with the standalone drive.

Upon successful completion, qdrive stampmedia displays the message "Request successful" in the console. In case of an error, an error code and the error description are displayed in the following format: "unload: Error errorcode: errordescription"

Options:

Command Line

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:

Unloads a drive Drive1 for library Library1.
E:\commandline>qdrive stampmedia -dr Drive1 -l Library1 -b Barcode1

Back to Top

qgeterrorstring

This command displays the error description of a given error number.

Usage:

qgeterrorstring error number [-h]

Description:

If the specified error number is valid, the error description for the error code is displayed. Otherwise, an error code and the error description are displayed in the following format: "qgeterrorstring: Error errorcode: errordescription"

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.
  E:\commandline>qgeterrorstring 10
  Connection to the CommServe terminated, Relogin required
• Display error description of invalid error number.
  E:\commandline>qgeterrorstring 4543584
  qgeterrorstring: Error 0x771: Invalid error no 4543584

Back to Top

qinfo

This command displays information about an entity.

Usage:

qinfo command <command-options-arguments> [-h]

Supported Commands:

• backupset
• instance
• media
• subclient

backupset

This command displays information about a backup set.

Usage:

qinfo backupset -c client -a dataagenttype -i instance -b backupset [-desc] [-h]

Description:

This command displays information about a given backup set in the specified client and iDataAgent. If the iDataAgent supports instances above backup sets, only those backup sets under the specified instance are listed. 

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

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 information about a backup set defaultBackupSet in client client1 and Agent Q_WIN_FS.
E:\commandline>qinfo backupset -c client1 -a Q_WIN_FS -b defaultBackupSet

Display only user description for a backup set defaultBackupSet in client qsdk and Agent Q_WIN_NET32_FS.
E:\commandline>qinfo backupset -c qsdk -a Q_WIN_NET32_FS -b defaultBackupSet [-desc]

This is the XPATH pattern used to identify the nodes to be processed as rows. Indicates the mapping that should be used between the XML data and the relational rowset and also how the spillover column should be filled. Input parameter 'flags is optional, and it can be one of the following values.

Back to Top

instance

This command displays information about an instance under the given client and iDataAgent.

Usage:

qinfo instance -c client -a dataagenttype -i instancename [-h]

Description:

This command displays information about a given instance in the specified client and iDataAgent. If the iDataAgent does not support instances, the default instance name is returned. This command is mainly used for instances in Oracle agents where command line and log storage policy are displayed. For other instances, just the name is displayed.

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

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 information about an instance OEMREP in client client1 and Agent Q_ORACLE.
E:\commandline>qinfo instance -c client1 -a Q_ORACLE -i OEMREP

Back to Top

media

This command displays information about a given media.

Usage:

qinfo media -b barcode [-desc] [-h]

Description:

This command displays information about a given media.

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

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 information about a media O10010WW.
E:\commandline>qinfo media -b 010010WW

Name                :10010WW
Storage policy      :battra_t(battra)-DP(2)
Copy                :Primary
Location            :slot2
Library             :Library1
Status              :Idle
Description         :Media description

Back to Top

subclient

This command displays information about a subclient under the given instance or backup set.

Usage:

qinfo subclient -c client -a dataagenttype -i instance -b backupset -s subclient [-desc] [-h]

Description:

This command displays information about a subclient in the specified client, iDataAgent, and backup set/instance. The backup set name and instance name should be specified based on the iDataAgent, as certain agents place subclients under backup sets, and others place them under the instance.

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

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 information about a subclient sc1 in the client client1 Agent Q_WIN_FS and backup set  bs1
E:\commandline>qinfo subclient -c client1 -a Q_WIN_2KFS -b bs1 -s sc1

Back to Top

qlibrary

This command performs several library related operations.

Usage:

qlibrary command <command-options-arguments> [-h]

Supported Commands:

• disable
• discover
• enable
• fullscan
• import
• reset

disable

This command disables a given library.

Usage:

qlibrary disable -l library [-h]

Description:

This command disables a given library. In case of an error, an error code and the error description are displayed in the following format: "disable: Error errorcode: errordescription"

Options:

Command Line

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:

disable a given library Library1
E:\commandline>qlibrary disable -l Library1

Back to Top

discover

This command discovers new media in a given library.

Usage:

qlibrary discover -l library -srp scratchpool -mt mediatype [-h]

Description:

This command discovers new media in a given library. If the library is available and discovered, it will be moved into the specified scratch pool and assigned the specified media type name.

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:

disable a given library Library1
E:\commandline>qlibrary discover -l STK9730 ACSLS -srp spares for 4000 -mt DLTape IV

Back to Top

enable

This command enables a given library.

Usage:

qlibrary enable -l library [-h]

Description:

This command enables a given library.

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

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:

enable a given library Libary1.
E:\commandline>qlibrary enable -l Library1

Back to Top

fullscan

This command performs a fullscan on a given library.

Usage:

qlibrary fullscan -l library [-h]

Description:

This command performs a fullscan of a given library.

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

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:

Perform a fullscan on a given library Library 1
E:\commandline>qlibrary fullscan -l Library1

Back to Top

import

This command imports media into a given library.

Usage:

qlibrary import -l library [-h]

Description:

This command imports media into a given library. On successful completion, qlibrary import displays the message "After all the media have been moved into the slots, the library finishes its initialization without errors. Please use "Discover" option to identify the new media." in the console.

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

Options:

Command Line

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:

Import media into given library Library1.
E:\commandline>qlibrary import -l Library1

Back to Top

reset

This command resets a given library.

Usage:

qlibrary reset -l library [-h]

Description:

This command resets a given library.

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

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:

Resets a given library Library1.
E:\commandline>qlibrary reset -l Library1

Back to Top

qlist

This command lists down various entities based on the specified command.

Usage:

qlist command <command-options-arguments> [-h]

Supported Commands:

• backupset
• client
• clientgroup
• dataagent
• drive
• drivepool
• globalfilter
• instance
• job
• jobhistory
• jobsummary
• lastjob
• library
• location
• masterdrivepool
• media
• mediaagent
• quickmedia
• replicationpair
• replicationset
• schedule
• schedulepolicy
• scratchpool
• subclient
• sp (storage policy)
• spcopy (storage policy copy)
• usergroup
• vtp (VaultTracker policy)

backupset

This command lists all of the backup sets under the given client, agent and instance (if applicable).

Usage:

qlist backupset -c client -a dataagenttype -i instance [-h]

Description:

This command lists the names of all the backup sets in the specified client and agent. If the agent supports instances above the backup set level, then only those backup sets under the specified instance are listed. When more than one backup set is found, the backup sets are listed one backup set per line, and are displayed in the console. No message is displayed when backup sets are not found.

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

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 Backup sets in the client client1, Agent Q_WIN_FS.
E:\commandline>qlist backupset -c client1 -a Q_WIN2K_FS
defaultBackupSet
bs1

Back to Top

client

This command lists all of the client computers configured in the CommCell.

Usage:

qlist client [-h]

Description:

This command lists names of all the client computers configured in the CommCell. In addition to the client name, the operating system and installation state are also displayed. When more than one client is found, the clients are listed one client per line, and are displayed in the console. No message is displayed when clients are not found.

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

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:

List all the clients configured in the CommCell.
E:\commandline>qlist client

Back to Top

clientgroup

This command lists all of the clientgroups configured in the CommCell.

Usage:

qlist clientgroup [-h]

Description:

This command lists names of all the clientgroups configured in the CommCell. When more than one clientgroup is found, one clientgroup per line are listed, and are displayed in the console. No message is displayed when clients are not found.

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

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:

List all the clientgroups configured in the CommCell.
E:\commandline>qlist clientgroup

Back to Top

dataagent

This command lists all of the agents installed on the given client computer.

Usage:

qlist dataagent -c client [-h]

Description:

This command lists all of the agents installed on the specified client computer. For a list of possible agents that qlist dataagent can return, see Argument Values - Agent Types. When more than one agent is found, the agents are listed one agent per line, and are displayed in the console. No message is displayed in the console when no agents are found.

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

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 agents configured in the client client1.
E:\commandline>qlist dataagent -c client1

Back to Top

drive

This command lists the names of the drives under the specified library.

Usage:

qlist drive -l library [-h]

Description:

This command lists the names of the drives under the specified library. When more than one drive is found, the drive are listed as one drive per line, and are displayed in the console. No message is displayed in the console when drive are not found.

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

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 drives configured in the library library1
E:\commandline>qlist drive -l library1
drive1
drive2

drivepool

This command lists all the drive pools under the specified master drive pool.

Usage:

qlist drivepool -m mediaagent -l library -md masterdrivepool [-h]

Description:

This command lists the names of all the drive pools available under the specified MediaAgent, library and master drive pool. When more than one drive pool is found, the drive pools are listed as one drive pool per line, and are displayed in the console. No message is displayed in the console when drive pools are not found.

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

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 drive pools available in the MediaAgent client1, media library maglib1 and master drive pool MasterPool_Magnetic_33.
E:\commandline>qlist drivepool -m client1 -l maglib1 -md MasterPool_Magnetic_33
DrivePool_Magnetic_33

globalfilter

This command lists all the globalfilters configured for the specified subclient.

Usage:

qlist globalfilter -t filter type  [-h]

Description:

This command lists the names of all the globalfilters configured on the specified subclient type under the commcell. When more than one globalfilter is found, they are listed as one globalfilter per line, and are displayed in the console. No message is displayed in the console when globalfilters are not found.

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

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 globalfilters configured in the commcell under Windows subclients.
E:\commandline>qlist globalfilter -t Windows
C:\dell
D:\programfiles

instance

This command lists all of the instances under the given client and agent.

Usage:

qlist instance -c client -a dataagenttype [-h]

Description:

This command lists names of all the instances in the specified client and agent. If the agent does not support instances, the default instance name is returned. When more than one instance is found, the instances are listed as one instance per line, and are displayed in the console. No message is displayed in the console when instances are not found.

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

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 Instances in the client client1, Agent Q_WIN_FS.
E:\commandline>qlist instance -c client1 -a Q_WIN2K_FS
defaultInstanceName

Back to Top

job

This command lists job details of "a given job ID" OR "all active jobs under a given "client/agent/instance/backupset/subclient".

Usage:

qlist job [-co i|o|s|p|r|d] [-j jobid] [-jt jobtype] [-js Running|Suspended|Waiting|Pending] [-c client] [-a iDataAgent Type] [-i instance] [-b backupset] [-s subclient] [-h]

Description:

This command displays job details such as job ID, type, phase, status, failure reason, and user-defined description. When a job ID is specified, its details are displayed irrespective of the job status. Only active jobs are displayed when you query jobs based on client, agent, instance, backup set, or subclient. This commands displays all active jobs in the CommServe when no option is specified. 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 console. When more than one job is found, the jobs are listed one job per line, and are displayed in the console. 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"

Options:

Column Codes:

Column codes are used to filter the columns that are displayed by the command. Only those columns that are set using the "-co" option are displayed.

By default, i, o, s, p columns are enabled.

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 job details of a given job ID.
  E:\commandline>qlist job -j 1
  JOBID   OPERATION STATUS   PHASE
  -----   ----------------   -----
  1       Backup Running     Scan
   
• List job details of a given job ID and display only the ID and Status.
  E:\commandline>qlist job -j 1
  JOBID   STATUS
  -----   ------
  1       Running
   
• Display failure/pending reason (ID and the message) for a job.
  E:\commandline>qlist job -j 1 -co r
  FAILUREREASON
  -------------
  13187897
  Message for job failure/pending reasons:
  1     13187897   ->  Job has been killed by the user

Back to Top

jobhistory

This command displays the backup job history under a specified subclient.

Usage:

qlist jobhistory -c client -a iDataAgent -i instance -b backupset -s subclient [-js jobstatus] [-st start time] [-et End time] [-h]

Description:

This command displays the backup job history under the specified subclient with the given job status and the time range specified. When more than one backup job is found, the jobs are listed one per line and displayed on the console. When no job history is found, a message is displayed on the console in the following format: "No job history found"

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

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 backup jobhistory under a subclient.
E:\commandline>qlist jobhistory -c client1 -a Q_WIN2K_FS -b bs1 -s SC_1
 

JOBID     STATUS       SUBCLIENT     STORAGEPOLICY
101       Completed    SC_1          SP_12

102       Completed    SC_1          SP_12

Back to Top

jobsummary

This command displays summary of the jobs in the CommServe.

Usage:

qlist jobsummary [-c client] [-a iDataAgent] [-i instance] [-b backupset] [-s subclient] [-h]

Description:

This command displays the summary of all the jobs currently active in the CommServe. Jobs are classified into Running, Suspended, Pending, Queued and Waiting states. You can filter the jobs by limiting them to a client, agent, instance, backup set or subclient.

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

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.
E:\commandline>qlist jobsummary -c cl1
RUNNING PENDING WAITING QUEUED SUSPENDED TOTAL
1       10      0       4      1         16

Back to Top

lastjob

This command displays the summary of the last backup job under the specified subclient.

Usage:

qlist lastjob -c client -a iDataAgent -i instance -b backupset -s subclient[-js Completed|Failed|Killed] [-h]

Description:

This command displays the summary of the last backup job under the specified subclient with a given job status.  When more than one job is found, the jobs are listed one per line and displayed on the console. When no job history is found, a message is displayed on the console in the following format: "No job found".

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

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 under a subclient.
E:\commandline>qlist lastjob -c client1

JOBID ----- 101

STATUS ------ Completed

STORAGEPOLICY ------------- Sp_12

APPTYPE ------- Filesystem

BACKUPSET --------- defaultBackupSet

SUBCLIENT --------- SC_1

INSTANCE -------- <default>

START TIME ---------- 01/01/2004 01:20:55

Back to Top

library

This command lists all of the media libraries under the specified MediaAgent.

Usage:

qlist library [-m mediaagent] [-h]

Description:

This command lists the names of all types of media libraries configured in the specified MediaAgent. If a MediaAgent is not specified, all libraries are listed. When more than one library is found, the libraries are listed one media library per line, and are displayed in the console. No message is displayed when media libraries are not found.

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

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 media libraries configured in the MediaAgent client1.
E:\commandline>qlist library -m client1
maglib1

Back to Top

location

This command lists all of the locations (both transit and stationary) configured in the CommCell.

Usage:

qlist location [-h]

Description:

This command lists all stationary and transit locations configured in the CommCell. Location name and type (stationary/transit) are displayed for each location. When more than one location is found, the locations are listed one location per line, and are displayed in the console. No message is displayed in the console when no locations are configured.

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

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:

List all the locations.
E:\commandline>qlist location
NAME TYPE
stat1 Stationary
trans1 Transit

Back to Top

masterdrivepool

This command lists all of the master drive pools under the specified MediaAgent and media library.

Usage:

qlist masterdrivepool -m mediaagent -l library [-h]

Description:

This command lists the names of all the master drive pools available under the specified MediaAgent and library. When more than one master drive pool is found, the drive pools are listed one master drive pool per line, and are displayed in the console. No message is displayed in the console when master drive pools are not found.

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

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 master drive pools available in the MediaAgent client1 and media library maglib1.
E:\commandline>qlist masterdrivepool -m client1 -l maglib1
MasterPool_Magnetic_33

Back to Top

media

This command displays media used by a given job/library/location/storage policy.

Usage:

qlist media -j jobid [-sp storagepolicy [-spc copy]] -l library [-srp scratchpool] -loc exportlocation -sp storagepolicy [-spc copy][-h]

Description:

This command displays information about all the media on the basis of a given job ID, storage policy, storage policy copy, and library. Barcode, location, library, storage policy name, and copy name are displayed for each media. Since barcodes are not applicable for magnetic libraries, CV_MAGNETIC is displayed if the job uses a magnetic library. If more than one media is used by a job, the media are listed one per line. A message "No media have been allocated for this job" will be displayed in cases where there is no media used by the job.

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

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:

• To get media associated with a job, use qlist media -j jobID[-sp storage policy name [-spc storage policy copy]]
  E:\commandline>qlist media -j 74

• To get media in a library, use qlist media -l library [-srp scratchpool]
  E:\commandline>qlist media -l STK9730 -srp Spares

• To get media in an export location, use qlist media -loc ExportLocation
  E:\commandline>qlist media -loc Shelf A

• To get media in a storage policy, use qlist media -sp storage policy name [-spc storage policy copy]
  E:\commandline>qlist media -sp STK Tape -spc Tape Copy two

Back to Top

mediaagent

This command lists all of the MediaAgents configured in the CommCell.

Usage:

qlist mediaagent [-h]

Description:

This command lists the names of all the MediaAgents configured in the CommCell. When more than one MediaAgent is found, the MediaAgents are listed one MediaAgent per line, and are displayed in the console. No message is displayed in the console when MediaAgents are not found.

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

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:

List all the MediaAgents configured in the CommCell.
E:\commandline>qlist mediaagent
client1

Back to Top

quickmedia

This command lists media required to restore data associated with a client, iDataAgent, backup set, or subclient.

Usage:

qlist quickmedia [-co e|b|c|l|t|p|o|s|r] -c client [-a iDataAgent] [-i instance ] [-b backupset] [-s subclient] [-bf browsefrom] [-bt browseto] [-syp syncprecedence] [-sep selprecedence] [-h]

Description:

This command lists all the media and related information, based on the input provided. The following information is displayed for each media:

1. export location
2. barcode
3. container name
4. library name
5. media type
6. storage policy name
7. copy name
8. subclient name
9. copy precedence number

If more than one media is listed, they are displayed one per line. The message "No media information to display" will be displayed in cases where there is no media.

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

Options:

Column Codes:

Column codes are used to filter the columns that are displayed by the command. Only those columns that are set using the "-co" option are displayed.

By default, b, c, l, p, o, s columns are enabled.

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 media on the client battra.
E:\commandline>qlistquickmedia -c battra
BARCODE CONTAINER LIBRARY STORAGEPOLICY COPYNAME SUBCLIENT
------- --------- ------- ------------- ------------------------
T:\ Dummy battra_t battra_t(battra)-DP(2) Primary Cursors
T:\ Dummy battra_t battra_t(battra)-DP(2) Primary default

Back to Top

replicationpair

This command lists all the replication pairs for a replication set for a client.

Usage:

qlist replicationpair [-c client] [-rsn repset] [-h]

Description:

This command lists all the replication pairs for a replication set for a client.

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

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 replication pairs for repset repset1 in client client1.

E:\commandline>qoperation replicationpair -c client1 -rsn repset1

replicationset

This command lists all the replication sets for a client.

Usage:

qlist replicationset [-c client] [-h]

Description:

This command lists all the replication sets for a client.

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

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 replication sets for client client1.

E:\commandline>qoperation replicationset -c client1

schedule

This command lists weekly and daily schedules for a given day or hour in a week.

Usage:

qlist schedule [-day weekday] [-hour hour] [-h]

Description:

This command lists weekly and daily schedules for a given day or hour in a week. No message is displayed when a schedule is not found. In case of an error, an error code and the error description are displayed in the following format: "schedule: Error errorcode: errordescription"

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
E:\commandline>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

Back to Top

schedulepolicy

This command lists the schedule policies configured in the commcell. It can also list schedule policies associated with a client, iDataAgent, instance or subclient. 

Usage:

qlist schedulepolicy [-c client] [-a iDataAgent] [-i instance] -backupset] [-s subclient] [-h]

Description:

This command lists the schedule policies configured in the commcell. It can also list schedule policies associated with a client, iDataAgent, instance or subclient.  When more than one schedule policy is found, they are listed one schedule policy per line, and are displayed in the console. No message is displayed when schedule policy are not found.

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

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 policy.
E:\commandline>qlist schedulepolicy 
Test11

Test2

Test3

Back to Top

scratchpool

This command lists all the scratchpools under a specified library.

Usage:

qlist scratchpool -l library [-m mediaagent] [-h]

Description:

This command lists the names of all the scratchpools configured in the specified library. The MediaAgent name is optional. When more than one scratchpool is found, they are listed one scratchpools per line, and are displayed in the console. No message is displayed when scratchpools are not found.

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

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:

List all the scratchpools configured in library library1.
E:\commandline>qlist scratchpool -l library1
Scratchpool_1

Back to Top

sp

This command lists all storage policies (of all types) available in the CommCell.

Usage:

qlist sp [-h]

Description:

This command lists the names of all the storage policies available in the CommCell. All types of storage policies (i.e., "iDataAgent Backup" or "Express Recovery Backup" or "Archiver") are listed by this command. When more than one storage policy is found, the policies are listed one Storage Policy per line, and are displayed in the console. No message is displayed in the console when storage policies are not found.

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

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:

List all the storage policies configured in the CommCell.
E:\commandline>qlist sp
policy1

Back to Top

spcopy

This command lists all of the copies (primary and secondary), under the given storage policy.

Usage:

qlist spcopy -sp storagepolicy [-h]

Description:

This command lists the names of all the storage policy copies under the given storage policy. Both primary and secondary copies are returned. When more than one storage policy copy is found, the copies are listed one copy per line, and are displayed in the console. No message is displayed in the console when storage policy copies are not found.

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

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 storage policy copies in the storage policy policy1.
E:\commandline>qlist spcopy -p policy1
Primary
copy1

Back to Top

subclient

This command lists all of the subclients under the given instance or backup set.

Usage:

qlist subclient -c client -a dataagenttype -i instance -b backupset [-h]

Description:

This command lists the names of all the subclients in the specified client, agent, backup set or instance. Backup set names and instance names should be specified for agents that place subclients under the backup set an/or instance level. When more than one subclient is found, the subclients are listed one subclient per line, and are displayed in the console. No message is displayed in the console when subclients are not found.

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

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 Subclients in the client client1, Agent Q_WIN_FS and backup set bs1.
E:\commandline>qlist subclient -c client1 -a Q_WIN_2KFS -b bs1
default
sc1

Back to Top

usergroup

This command lists all the user groups configured in the CommCell.

Usage:

qlist usergroup [-h]

Description:

This command lists all of the user groups configured in the CommCell. Whenever more than one user group is 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 whenever user groups are not found.

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

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:

List all of the user groups configured in the CommCell.

vtp

This command lists all of the VaultTracker policies configured in the CommCell.

Usage:

qlist vtp [-h]

Description:

This command lists the names of all the VaultTracker policies configured. When more than one policy is found, the policies are listed one policy per line, and are displayed in the console. No message is displayed in the console when VaultTracker policies are not found.

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

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:

List all the VaultTracker policies configured.
E:\commandline>qlist vtp
vtp1

Back to Top

qlogin

This command enables you to log on to the given CommServe by supplying a username and password of a CommCell user with sufficient permissions to perform the desired operations.

Usage:

qlogin [-cs CommCell] [-u username] [-p password] [-af ArgumentFilepath][-h]

Description:

qlogin allows a user to log on to a CommServe. By default, if a CommServe name is not specified, this command logs on to the CommServe of the current host. The user name and password can be specified at the command line (specifying the password as an argument is useful only in the case of scripting because an encrypted password is required); or, the user is prompted to enter the user name and password. Encrypted user login information is written into a .qsessions file (qsessions.osuser on Windows and qsessions.osuserId on Unix) in the install directory, which can be used by other commands until a qlogout command is executed. Upon successful completion, qlogin does not display any message in the console.

For more information on cli scripting, see Script Considerations or Writing and Editing Scripts sections in this document.

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

Options:

Command Line

Argument File

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.
  E:\commandline>qlogin -cs server1
  Enter User Name:
  Password:
• 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

Back to Top

qlogout

This command enables logging off a user from a connected CommServe.

Usage:

qlogout [-h]

Description:

qlogout allows a user to log off the 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 of the current host. Upon successful completion, qlogout displays user logged out successfully. The login information is removed from the list in the .qsessions file upon successful logout from the specific CommServe. The .qsessions file is deleted upon successful logout from all the CommServes.

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

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 command executed when you are not logged on to any CommServe.
  E:\commandline>qlogout
  qlogout: Error 0x268: User not logged in

Back to Top

qmedia

This command performs various media related operations.

Usage:

qmedia command <command-options-arguments> [-h]

Supported Commands:

• allowexport
• deletecontents
• export
• load
• markappend
• markbad
• markfull
• preventexport
• verify

allowexport

This command allows you to export a specified media.

Usage:

qmedia allowexport -b barcode [-h]

Description:

This command allows you to export the specified media that is set to "prevent export".

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

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:

Reset flag to allow for exporting the contents of the media with 100101WW barcode.
E:\commandline>qmedia allowexport -b 100101WW

Back to Top

deletecontents

This command deletes the contents of a given media and moves it into the specified scratchpool.

Usage:

qmedia deletecontents -b barcode -srp scratchpool [-h]

Description:

This command deletes the contents of the given media and moves it into the specified scratchpool.

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

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:

Delete  the contents of the media with 100101WW barcode and move to scratchpool Scratchpool_1.
E:\commandline>qmedia deletecontents -b 100101WW -srp Scratchpool_1

Back to Topp

export

This command exports specified media into a given export location.

Usage:

qmedia export -b barcode(s) -el exportlocation [-af argsfile] [-h]

Description:

This command exports specified media into a given export location.

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

Options:

Command Line 

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:

Export multiple specified media with barcodes 100401WW and 100402WW into a given export location Exp_Loc
E:\commandline>qmedia export -b 100401WW,100402WW -el Exp_Loc

Back to Topp

load

This command loads media into a given drive.

Usage:

qmedia load -b barcode -s mediaside -dr drivename -m mediaagent [-h]

Description:

This command loads the given media and the side specified onto the drive name given under the specified MediaAgent.

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

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:

Loads a media and the side specified onto the given drive under the given MediaAgent.
E:\commandline>qmedia load -b 100101WW -s A -dr Drive_1 -m MAgent1

Back to Top

markappend

This command marks specified media as appendable.

Usage:

qmedia markappend -b barcode(s) [-af argsfile] [-h]

Description::

This command marks specified media as appendable.

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

Options:

Command Line

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:

Mark specified media as appendable.
E:\commandline>qmedia markappend -b 100101WW

Back to Top

markbad

This command marks specified media as bad.

Usage:

qmedia markbad -b barcode(s) [-af argsfile] [-h]

Description:

This command marks specified media as bad.

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

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:

Mark specified media as bad.
E:\commandline>qmedia markbad -b 100101WW

Back to Top

markfull

This command marks specified media as full.

Usage:

qmedia markfull -b barcode(s) [-af argsfile] [-h]

Description:

This command marks specified media as full.

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

Options:

Command Line

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:

Mark specified media as full.
E:\commandline>qmedia markfull -b 100101WW

Back to Top

preventexport

This command prevents the media from being exported.

Usage:

qmedia preventexport -b barcode [-et expirytime] [-h]

Description:

This command prevents the media from being exported.

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

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:

Prevent the given media from being exported.
E:\commandline>qmedia preventexport -b 100101WW -et 12/31/2007 00:00

Back to Top

verify

This command verifies the media.

Usage:

qmedia verify -b barcode [-h]

Description:

This command verifies the specified media.

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

Options:

Command Line

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:

Verifies the given media.
E:\commandline>qmedia verify -b 100101WW

Back to Top

qmodify

This command modifies an entity based on the specified command.

Usage:

qmodify command <command-options-arguments> [-h]

Supported Commands:

• clientgroup
• galaxypassword
• globalfilter
• instance
• password
• schedulepolicy
• subclient

clientgroup

This command adds or removes a client to or from a clientgroup.

Usage:

qmodify clientgroup -o add|delete -c client -cg clientgroup [-h]

Description:

This command allows to add or remove a client to or 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 the error description are displayed in the following format: "clientgroup: Error errorcode: errordescription"

Options:

Argument File

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

Back to Top

galaxypassword

This command changes the password of a user for the CommCell Console.

Usage:

qmodify galaxypassword -u username [-p password] [-h]

Description:

This command allows you to change the password of a given 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 console. In case of an error, an error code and the error description are displayed in the following format: "galaxypassword: Error errorcode: errordescription"

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.

Back to Top

globalfilter

This command modifies globalfilter(s) for NetWare, UNIX, or Windows.

Usage:

qmodify globalfilter -o append|overwrite -t subclient type -ff filter file [-h]

Description:

This command allows you to modify globalfilter(s).

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

Options:

Command Line

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 globalfilters
E:\commandline>qmodify globalfilter -o append -t Windows -ff test.txt

Back to Top

instance

This command modifies command line and log storage policies of an Oracle instance.

Usage:

qmodify instance -c client -a dataagenttype -i instance -csp cmdlinestoragepolicy -lsp logstoragepolicy [-af ArgumentFilepath] [-h]

Description:

This command allows you to modify an Oracle instance by changing its command line and log storage policies.

Upon successful completion, qmodify instance displays the message "Modified instance successfully" in the console. In case of an error, an error code and the error description are displayed in the following format: "instance: Error errorcode: errordescription"

Options:

Command Line

Argument File

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:

Modify an instance with the name instance1 under client client1 and Agent Q_ORACLE by changing its command line storage policy to logsp2.
E:\commandline>qmodify instance -c client1 -a Q_ORACLE -i instance1 -csp logsp2

Back to Top

password

This command allows for password administration.

Usage:

qmodify password -c client -a dataagenttype -i instance -b backupset -s subclient [-h]

Description:

This command interactively allows password administration of File System, Oracle, SQL and Exchange Agents.

• For SQL Server iDataAgents, you can change the user account and password used for authentication of the SQL connect string.
• For Windows File System iDataAgents, you can change the user account and password used for permissions for UNC paths.
• For Oracle iDataAgents on Windows, you can change the user account and password used for authentication of the connect string and catalog connect.
• For Oracle iDataAgents on Unix, you can change the user account and password used for authentication of the catalog connect.
• For Exchange iDataAgents, you can change the user account and password when the option is available in the CommCell Console.

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

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.

Back to Top

schedulepolicy

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

Usage:

qmodify schedulepolicy -o add|remove -scp schedulepolicy [-c client] [-a iDataAgent] [-i instance] [-b backupset] [-s subclient] [-h]

Description:

This command associates or dissociates a given schedule from a client, iDataAgent, instance, backup set or subclient. modifies the schedule policy.  In case of an error, an error code and the error description are displayed in the following format: "schedulepolicy: Error errorcode: errordescription"

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 cl1.
E:\commandline>qmodify schedulepolicy -o add -scp1 -c cl1
Associate the entity with the Schedule Policy successfully.

Dissociate a schedule policy scp1 with cl1.
E:\commandline>qmodify schedulepolicy -o remove -scp1 -c cl1
Dissociate the entity with the Schedule Policy successfully.

Back to Top

subclient

This command modifies the content/storage policy/description of a given subclient.

Usage:

qmodify subclient -c client -a dataagenttype -i instance -b backupset -s subclient -sp storagepolicy -f content [-ow overwrite] [-drs datareaders] [-wc y|n] [-af ArgumentFilepath] [-h]

Description:

This command modifies a subclient by changing the assigned storage policy, content, or user-defined description. New content is added to the existing content.

Upon successful completion, qmodify subclient displays the message "Modified subclient successfully" in the console. In case of an error, an error code and the error description are displayed in the following format: "subclient: Error errorcode: errordescription"

Options:

Command Line

Argument File

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:

Modify a subclient with name sc1 under client client1 and  Agent Q_WIN2K_FS and backup set bs1 by changing its storage policy to sp2.
E:\commandline>qmodify subclient -c client1 -a Q_WIN2K_FS -b bs1 -s sc1 -sp sp2

Back to Top

qoperation

This command performs an operation based on the specified command.

Usage:

qoperation command <command-options-arguments> [-h]

Supported Commands:

• adduser
• agedata
• automaticupdate
• auxcopy
• backup
• capture
• execscript
• dock
• drbackup
• find
• jobcontrol
• jobretention
• media
• merge
• move
• register
• replication
• report
• restore
• vaulttracker

adduser

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

Usage:

qoperation adduser -u user -ug group [-h]

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 console. In case of an error, an error code and the error description are displayed in the following format: "adduser: Error errorcode: errordescription"

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:

Add a user user1 to group group1.
E:\commandline>qoperation adduser -u user1 -ug group1

agedata

This command performs a data aging operation, prunes multiple jobs using a text file, and prunes a single job using the command line

Usage: qoperation agedata -delbyjobid -j jobid -sp storagepolicy -spc copy -ft [-cs CommCell][-af ArgumentFilepath][-h]

Description: This command starts a data aging operation when the -delbyjobid option is not specified. The Job ID is returned and displayed in the CommCell Console if the data aging job was successfully initiated by the CommServe.  When the -delbyjobid option is specified, the list of jobs or specified job is pruned based on the storage policy, storage policy copy and the file type. The CommServe name is optional. When the CommServe name is not specified, the default CommCell value of the current CommServe is accepted.

The list of jobs can be provided in a text file. For example:

[jobid]
1123
1124
1156

Using file type (-ft) option Q_LOG will prune only log files for a specified job; using file type option Q_DATA will prune only data files for a specified job; and using file type option Q_DATA_LOG will prune both data files and log files for the specified job.

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

Options:

Command Line

Argument File

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 Data Aging.
E:\commandline>qoperation agedata
175

Start Data Aging for job-based pruning.
E:\commandline>qoperation agedata -delbyjobid -j 23453 -sp StoragePolicy1 -spc Primary -ft Q_LOG
This command will prune Job 23453 for file type "log" from the primary copy of StoragePolicy1.

Back to Top

automaticupdate

This command performs an automatic update operation (including automatic upgrade) on the specified client from the CommServe.

This is not to be confused with the InstallUpdates command, which is used to manually install the updates from the command line in a non-interactive mode from the client computer.  For more information, see Silent Updates.

Usage:

qoperation automaticupdate -c client [-h] -reboot -upgrade

Description:

This command starts an automatic update operation on a specified client, MediaAgent, or CommServe. The Job ID is returned and displayed in the console if the update job was successfully initiated by the CommServe. Automatic upgrade are only applicable to specific client or MediaAgent.

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

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:

Start update on client client1.
E:\commandline>qoperation automaticupdate -c client1
175

Start update on client client2. If necessary, reboot the system after update is installed.
E:\commandline>qoperation automaticupdate -c client2 -reboot
176

Start upgrade on client client3.
E:\commandline>qoperation automaticupdate -c client3 -upgrade
177

Start upgrade on client client4. If necessary, reboot the system after upgrade.
E:\commandline>qoperation automaticupdate -c client4 -upgrade -reboot
178

Back to Top

auxcopy

This command performs an auxiliary copy operation on the specified storage policy and secondary copy.

Usage:

qoperation auxcopy -sp storagepolicy [-spc copy] [-af ArgumentFilepath] [-h]

Description:

This command starts an auxiliary copy job on the specified storage policy and secondary copy. The secondary copy must be created before running auxcopy. The Job ID is returned and displayed in the console if the auxiliary copy job was successfully initiated by the CommServe.

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

Options:

Command Line

Argument File

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 auxcopy for storage policy policy1 and copy copy1.
E:\commandline>qoperation auxcopy -sp policy1 -spc copy1
175

Back to Top

backup

This command performs an immediate backup operation (full, incremental, or differential) on a given subclient.

Usage:

qoperation backup [-cs commserve] -c client -a dataagenttype -i instance -b backupset -s subclient -t Q_FULL|Q_INC|Q_DIFF|Q_SYNTH [-scid subclientId][-af argsfile][-h]

Description:

This command starts an immediate backup operation on the specified subclient. You can perform the backup operation by specifying the subclient ID or the subclient name. When providing the subclient name, you also need to provide the client computer name, agent type, instance name and backup set name to identify the subclient. The instance name and backup set name are not applicable to some agents. The type of backup suggests whether it is a full, incremental, differential, or synthetic backup. The backup command can also accept the arguments from a file using the -af option. This file can accept all the arguments supported through the command line, and it also accepts advanced backup options.

The argument file also supports a data path option. The data path option accepts a list of MediaAgents, libraries, drive pools, and scratch pools. The drive pool and scratch pool should be provided with the name of the library to which the pools belong followed by a slash (/) and then the respective pool name. The data path options are optional and can be used in the argument file as needed.

The Job ID is returned and displayed on the console if the backup job was successfully initiated by the CommServe.

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

NOTES

• Whenever data path parameters are provided but are either invalid or not found, the backup continues taking the data path assigned for the storage policy. QSDK.log displays a message stating that the system could not fetch the data path options from the CommServe database.
• The Advanced Archive Log Options are supported for the Oracle iDataAgent using the argument file. The first argument must specify the type based on which the backup or deletion is to be done. Then, according to the types specified, the values must be provided. If you choose a backup archive log based on the Log Sequence Number (LSN), then either the start LSN or end LSN or both LSNs should be provided.
• Save as Script is also supported for the options discussed in the preceding bullet item.
• Time format follows the command line time format (i.e, [year/mon/date [hr:min:[sec]] or mon/date/year [hr:min:[sec]])
• The subclient ID could be retrieved using the qscript GetSubClients.sql in qoperation execscript command.
• The -scid option cannot be used to backup the subclient of an OnDemand instance of Oracle or Oracle RAC iDataAgent.

Options:

Command Line

Argument File (Options used by all iDataAgents except Oracle)

Options used by the Oracle iDataAgent

Supported Backup Types

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 backup on the subclient sc1 under client client1, agent Q_WIN_FS and backup set bs1.
E:\commandline>qoperation backup -c client1 -a Q_WIN_FS -b bs1 -s sc1 -t Q_FULL
171

NOTES

• Multiple Streams for Oracle Third-Party Command Line Backups - Third-Party command line backups can utilize multiple streams. However, when all streams do not have resources available, the streams which do not have resources will fail. Since each backup stream has a separate job ID in the Job Manager, and the Job Controller window displays a separate job for each process, the streams that have resources will report as successful, while the streams that do not have resources will be placed in a pending state, and will eventually fail if the condition is not corrected. If this problem is encountered, the backup will not be complete; rerun the backup after determining the availability of adequate resources for all the streams. If you cannot determine the availability of resources for all the streams, run the backup with one stream. Keep in mind that single-stream backups will also fail if the required media resource is unavailable.

  Oracle 10g - for third-party command line backups utilizing multiple streams, if resources are not available for any stream, it will be placed in a pending state, and eventually in a failed state. Despite that, when another stream for which resources are available has completed, its resources will then be utilized for the stream that was in the pending/failed state, and the job will complete successfully. (Note that under such circumstances, it is necessary to check the RMAN status of the job to determine that it did complete successfully.) Thus, Oracle 10g backup streams will be automatically serialized when lack of resources makes it impossible for them to run in parallel.

Back to Top

capture

This command captures the client information into a database.

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

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 an 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 an UNC path, then the command line operation will prompt the user for impersonation details. On successful completion, qoperation capture displays the message Capture Successful in the console.

In case of an error, an error code and the error description are displayed in the following format:

capture: Error errorcode: errordescription

Options:

Command Line

Argument File

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:

Capture a client with the name client1, save 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.
E:\commandline>qoperation capture -c client1 -dfn c:\capturedb -dbn db -afn c:\afile

Back to Top

checkready

This command generates a report about the client connectivity in html format.

Usage:

checkready [-cs commserver] -c client [-sm summary] [-dt detail] [-h]

Description:

This command generates a report to show if the client is accessible. It allows to check network for client connectivity. Summary report is the default report displayed. You can use the -dt option with this command for a detailed report.

Options:

Command Line

Example:

Checks if the client is accessible and displays a summary report in html format.
E:\commandline>qoperation checkready -c shr90_2 -sm>"E:\detail.html"

Checks if the client is accessible and displays a detailed report in html format.
E:\commandline>qoperation checkready -c shr90_2 -dt>"E:\detail.html"

Back to Top

dock

This command confirms the registration of a client on a CommServe before or after a decoupled install. It is assumed that this registration has already been completed using either the qoperation register command or the Register a New Client Wizard in the CommCell Console.

Usage:

qoperation dock -c client_display_name [-roaming y/n][-h]

Description:

This command confirms the registration of a client on a CommServe before or after a decoupled install. It is assumed that this registration has already been completed using either the qoperation register command or the appropriate field in the CommCell Console. This registration should be confirmed before any data management jobs are run.

Options:

Command Line

Example:

Confirm registration of client ranger on its associated CommServe.
E:\commandline>qoperation dock -c ranger
Confirmed client registration successfully.

Back to Top

drbackup

This command performs a disaster recovery backup operation.

Usage:

qoperation drbackup -t Q_FULL|Q_DIFF [-af ArgumentFilepath][-h]

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 the error description are displayed in the following format: "drbackup: Error errorcode: errordescription"

Options:

Command Line

Argument File

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.
E:\commandline>qoperation drbackup -t Q_FULL
175

Back to Top

execscript

This command executes the Qscripts available on the CommServe computer.

Usage:

qoperation execscript [-cs commserver] -sn scriptname [-si scriptparam] [-p1 password] [-p2 password] [-p3 password] [-file outFile] [-format outputFormat] [-h]

Description:

This command can be used to execute the QScripts available on the CommServe computer using the QCommand, 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|csv (where .xls is tab separated and .csv is comma separated.) By default, the output is displayed in xls format. Refer QScripts to view the list of available qscripts.

When you provide a file name to redirect the output, if there is any failure in creating the file, the script is executed successfully and the user is intimated of the problem and the output is displayed on the CommCell Console in the specified format. If you do not provide any file name, by default, the output is displayed on the CommCell Console.

Note the following when using the qoperation execscript qcommand:

• The Qscripts are available in the <software_install_folder>\scripts folder on the CommServe computer.

Refer to the readme associated with the respective QScript for information on the available options and parameters that can be used to execute the specific script. The readmes use the following naming convention: readme_<scriptname>.txt For example, the readme associated with GetSubclients.sql script is readme_GetSubclients.txt.

• The GUI Audit Trail Report provides information on the scripts executed by this command. The report must be generated using the Low Severity option to include this information. The report includes details on the name of the script and the input parameters used to execute the scripts.

Options:

Command Line

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

The usage information for the GetSubclients script in the associated readme file (readme_GetSubclients.txt) provides the following information:

qoperation execscript -sn GetSubclients.sql -si client_name

Substituting the client_name with the actual name of the client computer (e.g., purple.company.com) the command would be similar to the following:

E:\commandline>qoperation exescript -sn GetSubclients.sql -si purple.company.com

Back to Top

find

This command allows you to perform a wildcard search of the client backup.

Usage:

qoperation find -af argsfile [-rf resultfile][-h]

Description:

This command allows you to perform a wildcard search of the client backup. Before you run this command, you must first save a restore job as a script from the CommCell Console. When you do this, the appropriate script file and argument (input) file are generated. Thereafter, you must edit the script file to include the appropriate form of the qoperation find command, which includes the name of the argument file, and you must edit the argument file to include the correct wildcard pattern for searching the client backup along with the other options as appropriate. Once you do this, you can run the command. You can have the output either displayed in the command window or saved to a file. For step-by-step instructions on setting up the qoperation find command, see Set up the qoperation find command.

Options:

Command Line

Argument File