Command Line Interface - MediaAgent - QCommands

Table of Contents

Available Commands

This topic provides commands that can be used by the MediaAgent.

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

qcreate container

Description

This command creates a container that can be associated with a Vault Tracker policy.

If an error occurs, an error code and description appear: "container: Error errorcode: errordescription"

Usage

qcreate container [-cs <commserve_host_name>] -container <containername> -cap <capacity> [-track <trackingid>] [-desc <description>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

-cs CommServe host name
-container Name for the container
-cap Maximum capacity of the container
-track Container's tracking ID
-desc A description of the container
-tf Read token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures because of the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Create a container with the name box1 with a maximum capacity of 50.

qcreate container -container box1 -cap 50

qcreate iron

Description

This command creates an Iron Mountain customer ID.

If an error occurs, an error code and description appear: "iron: Error errorcode: errordescription"

Usage

qcreate iron [-cs <commserve_host_name>] -iron <ironmountainid> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-cs CommServe host name
-iron Iron Mountain customer ID that you want to create
-tf Read token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures because of the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Create an Iron Mountain customer ID with the value A123.

qcreate iron -iron A123

qcreate location

Description

This command creates an export location that can be associated with a Vault Tracker policy.

If an error occurs, an error code and description appear: "location: Error errorcode: errordescription"

Usage

qcreate location [-cs <commserve_host_name>] -loc <locationname> [-type <stationary | transit>] [-desc <description>][-tf <tokenfile>] [-tk <token>] [-h]

Options

-cs CommServe host name
-loc Name of the export location that you want to create
-type The export location type (stationary or transit)
-desc A description of the export location
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures because of the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Create a location with the name location1 and the type stationary.

qcreate location -loc location1 -type stationary

qcreate shelf

Description

This command creates a shelf used for exported media.

If an error occurs, an error code and description appear: "shelf: Error errorcode: errordescription"

Usage

qcreate shelf [-cs <commserve_host_name>] -shelf <shelfname> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-cs CommServe host name
-shelf Name of the shelf that you want to create
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures because of the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Create a shelf with the name z001.

qcreate shelf -shelf z001

qcreate vtp

Description

This command creates a Vault Tracker policy.

If an error occurs, an error code and description appear: "vtp: Error errorcode: errordescription"

Usage

qcreate vtp [-cs <commserve_host_name>] -vtp <vt_policy_name> [-desc <description>] [-autoack <autoack>] [-dueback <dueback>] -srctype <sourcetype> -srcname <sourcename> [-transit <transitlocation>] -desttype <100 | 200 | 300> -destname <destinationname> [-silocontainer <silocontainer>][-delaytime <delaytime>] [-quittime <quittime>] [-limitcount <nummediatomove>] [-usevms <usevms>] [-sp <sp | ALL>] [-spc <spc | ALL>] [-container <sourcename>] [-cap <capacity>] [-pattern <pattern>][-tf <tokenfile>] [-tk <token>] [-h]

Options

-cs CommServe host name
-vtp Name of the Vault Tracker policy that you want to create
-desc A description of the Vault Tracker policy
-autoack Auto Acknowledge. When this argument is present, Auto Acknowledge is enabled.
-dueback Due Back policy. When this argument is present, Due Back policy is enabled.
-srctype Source location type. 100:Library 200:Location 300:Shelf
-srcname Source location name
-transit Transit location
-desttype Destination type. 100:Library 200:Location 300:Shelf
-destname Destination name
-silocontainer Separate container for Silo. When this argument is present, separate container for Silo is enabled.
-delaytime Export delay minutes
-quittime Minutes until export goes into a Pending state
-limitcount Number of media to move
-usevms Use virtual mail slots. When this argument is present, use virtual mail slots is enabled.
-sp Storage Policy. Enter ALL to select all.
-spc Storage Policy Copy. Enter ALL to select all.
-container Container name
-cap Container capacity
-pattern Container pattern
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures because of the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Create a Vault Tracker policy with the name vtp1, a source type of library, a source name Main, a destination type of location, and destination name Storage.

qcreate vtp -vtp vtp1 -srctype 100 -srcname Main -desttype 200 -destname Storage

qdelete container

Description

This command deletes a container that is associated with a Vault Tracker policy.

If an error occurs, an error code and description appear: "container: Error errorcode: errordescription"

Usage

qdelete container [-cs <commserve_host_name>] -container <container> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-cs CommServe host name
-container Name of the container that you want to delete
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures because of the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Delete a container with the name box1.

qdelete container -container box1

qdelete iron

Description

This command deletes an Iron Mountain customer ID.

When an Iron Mountain customer ID is deleted, a message appears that tells you that the ID was deleted successfully. If an error occurs, an error code and description appear: "iron: Error errorcode: errordescription"

Usage

qdelete iron [-cs <commserve_host_name>] -iron <ironmountainid> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-cs CommServe host name
-iron Name of the Iron Mountain customer ID that you want to delete
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures because of the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Delete an Iron Mountain customer ID with the value A123.

qdelete iron -iron A123

qdelete location

Description

This command deletes an export location for Vault Tracker.

When a location is deleted, a message appears that tells you that the location was deleted successfully. If an error occurs, an error code and description appear: "location: Error errorcode: errordescription"

Usage

qdelete location [-cs <commserve_host_name>] -loc <location> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-cs CommServe host name
-loc Name of the export location that you want to delete
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures because of the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Delete a location with the name location1.

qdelete location -cs commserve_host_name -loc location1

qdelete mediaagent

Description

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

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

Usage

qdelete mediaagent -m <mediaagent> [-y] [-tf <tokenfile>] [-tk <token>] [-h]

Options

-m MediaAgent name
-y Delete without confirmation
-tf Reads token from a file
-tk Token string
-h  Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Delete a MediaAgent with name M_Agent.

E:\commandline>qdelete mediaagent -m M_Agent

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

qdelete shelf

Description

This command deletes a shelf used for exported media.

If an error occurs, an error code and description appear: "shelf: Error errorcode: errordescription"

Usage

qdelete shelf [-cs <commserve_host_name>] -shelf <shelfname> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-cs CommServe host name
-shelf Name of the shelf that you want to delete
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures because of the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Delete a shelf with the name z001.

qdelete shelf -shelf z001

qdrive clean

Description

This command performs a cleaning operation on a given drive.

Upon successful completion, qdrive clean displays the message "Request successful" on the command prompt. In case of an error, an error code and description are displayed as: "Clean: Error errorcode: errordescription"

Usage

qdrive clean -dr <drive> -l <library> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-dr Drive name
-l Library name
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Clean a drive Drive1 in library Library1.

E:\commandline>qdrive clean -dr Drive1 -l library1

qdrive disable

Description

This command disables a drive in a specified library.

Upon successful completion, qdrive disable displays the message "Request successful" on the command prompt. In case of an error, an error code and description are displayed as: "disable: Error errorcode: errordescription"

Usage

qdrive disable -dr <drive> -l <library> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-dr Drive name
-l Library name 
-tf Reads token from a file
-tk Token stringg
-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

Disable a drive Drive1 in library Library1.

E:\commandline>qdrive disable -dr Drive1 -l Library1

qdrive enable

Description

This command enables a drive in a specified library

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

Usage

qdrive enable -dr <drive> -l <library> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-dr Drive name
-l Library name 
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Enable a drive Drive1 in the library Library1.

E:\commandline>qdrive enable -dr Drive1 -l Library1

qdrive reset

Description

This command resets the status of a given drive in a specific library.

Upon successful completion, qdrive reset displays the message "Request successful" on the command prompt. In case of an error, an error code and description are displayed as: "reset: Error errorcode: errordescription"

Usage

qdrive reset -dr <drive> -l <library> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-dr Drive name
-l Library name
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Reset a drive Drive1 for library Library1.

E:\commandline>qdrive reset -dr Drive1 -l Library1

qdrive unload

Description

This command unloads a given drive in a specified library.

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

Usage

qdrive unload -dr <drive> -l <library> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-dr Drive name
-l Library name
-tf Reads token from a file
-tk Token string
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Unloads a drive Drive1 for library Library1.

E:\commandline>qdrive unload -dr Drive1 -l Library1

qdrive stampmedia

Description

This command labels the media associated with a standalone drive.

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

Usage

qdrive stampmedia -dr <drive> -l <library> -b <barcode> [-tf <tokenfile>] [-tk <token>][-h]

Options

-dr Drive name
-l Library name
-b Barcode
-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

Unloads a drive Drive1 for library Library1.

E:\commandline>qdrive stampmedia -dr Drive1 -l Library1 -b Barcode1

qdrive verify

Description

This command checks that the media information on the media loaded in the drive and the media information in the CommServe database match.

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

Usage

qdrive verify -dr <drive> -l <library> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-dr Drive name
-l Library name
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Verify the media in drive Drive1 for library Library1.

E:\commandline>qdrive verify -dr Drive1 -l Library1

Sample output

For media associated with the standalone drive that belongs to the same instance of the CommServe.

Media in library [Library1] drive [Drive1] has Identifier [StdAln_Wed Jul 2A_62] Unique ID [2_BC_StdAln_28], creation time [Tue Aug 21 15:45:32 2012] and belongs to this instance of the CommCell.

For media associated with the standalone drive that belongs to different CommServe instance.

Media in library [StndAln Library 1\ drive [Drive1] has Identifier [StdAln_Fri Sep 1A_57] Unqiue ID [1023922_BC_StdAln_57], creation time [Wed Sep 26 22:16:43 2012], CommCell Id [1023922] and does not belong to this instance of the CommCell.

qinfo media

Description

This command displays information about a given media.

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

Usage

qinfo media -b <barcode> [-desc] [-tf <tokenfile>] [-tk <token>] [-h]

Options

-b Barcode
-desc Displays description provided by the user
-tf Reads token from a file
-tk Token string
-h Displays help

To display the provided user description without other information for the media, include the -desc option when you run the command. Otherwise, all the requested information along with only a partial description will be displayed.

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

qlibrary disable

Description

This command disables a given library.

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

Usage

qlibrary disable -l <library> [-tf <tokenfile>] [-tk <token>] [-h]

Options

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

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Disable a library named Library1.

E:\commandline>qlibrary disable -l Library1

qlibrary discover

Description

This command searches for new media in a given library. If the library is available and discovered, it is moved into the scratch pool and assigned the media type name specified by the user.

Usage

qlibrary discover -l <library> -srp <scratchpool> -mt <mediatype> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-l Library name
-srp Scratch pool name
-mt Media type name
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Discover the media in a library named Library1.

E:\commandline>qlibrary discover -l STK9730 ACSLS -srp spares for 4000 -mt DLTape IV

qlibrary enable

Description

This command enables a given library.

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

Usage

qlibrary enable -l <library> [-tf <tokenfile>] [-tk <token>] [-h]

Options

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

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Enable a library named Libary1.

E:\commandline>qlibrary enable -l Library1

qlibrary fullscan

Description

This command performs a full scan of a given library.

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

Usage

qlibrary fullscan -l <library> [-tf <tokenfile>] [-tk <token>] [-h]

Options

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

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Perform a full scan on a library named Library 1.

E:\commandline>qlibrary fullscan -l Library1

qlibrary import

Description

This command imports media into a specified library. On successful completion, the qlibrary import command displays the following message on the command prompt:

"After all the media have been moved into the slots, the library finishes its initialization without errors. Please use the "qlibrary discover" option to identify the new media."

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

Usage

qlibrary import -l <library> [-tf <tokenfile>] [-tk <token>] [-h]

Options

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

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Import media into given library Library1.

E:\commandline>qlibrary import -l Library1

qlibrary reset

Description

This command resets a given library.

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

Usage

qlibrary reset -l <library> [-tf <tokenfile>] [-tk <token>] [-h]

Options

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

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Reset a library named Library1.

E:\commandline>qlibrary reset -l Library1

qlist drive

Description

This command lists the names of the drives under a specified library. Whenever more than one drive is found, the name of each drive is listed in its own line on the command prompt. No message is displayed whenever drives are not found.

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

Usage

qlist drive -l <library> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-l Media library name
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure. 

Example

List all the drives configured in a library named library1.

E:\commandline>qlist drive -l library1
drive1
drive2

qlist drivepool

Description

This command lists the names of all the drive pools available under the specified MediaAgent, library and master drive pool. Whenever more than one drive pool is found, each drive pool is listed in its own line on the command prompt. No message is displayed whenever drive pools are not found.

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

Usage

qlist drivepool -m <mediaagent> -l <library> -md <masterdrivepool> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-m MediaAgent name
-l Media library name
-md Master drive pool name
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure. 

Example

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

qlist library

Description

This command lists the names of all types of media libraries configured in the specified MediaAgent. If the MediaAgent is not specified, all libraries are listed.

Whenever more than one library is found, each library is listed in its own line on the command prompt. No message is displayed whenever media libraries are not found.

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

Usage

qlist library [-m <mediaagent>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

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

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure. 

Example

List all the media libraries configured in the MediaAgent client1.

E:\commandline>qlist library -m client1
maglib1

qlist location

Description

This command lists all stationary and transit locations configured in the CommCell. Location name and type (stationary/transit) are displayed for each location. Whenever more than one location is found, each location is listed in its own line on the command prompt. No message is displayed whenever locations are not configured.

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

Usage

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

Options

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

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure. 

Example

List all the locations.

E:\commandline>qlist location

NAME   TYPE
-----  -----
stat1  Stationary
trans1 Transit

qlist masterdrivepool

Description

This command lists the names of all the master drive pools available under the specified MediaAgent and library. Whenever more than one master drive pool is found, each drive pool is listed in its own line on the command prompt. No message is displayed whenever master drive pools are not found.

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

Usage

qlist masterdrivepool -m <mediaagent> -l <library> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-m MediaAgent name
-l Media library name
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

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

qlist media

Description

This command displays the following information about all the media used by a given job, storage policy, storage policy copy, and library:

  • Barcode
  • Location
  • Library
  • Storage policy
  • Storage policy copy

Since barcodes are not applicable for disk libraries, CV_MAGNETIC is displayed if the job uses a disk library. Whenever more than one media is used by a job, each media is listed on its own line on the command prompt. The message "No media have been allocated for this job" is displayed whenever media is not used by the job.

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

Usage

qlist media -j <jobid> [-sp <storagepolicy> [-spc <copy>]] -l <library> [-srp <scratchpool>] -loc <exportlocation> -sp <storagepolicy> [-spc <copy>][-tf <tokenfile>] [-tk <token>] [-h]

Options

-j Job ID
-sp Storage policy name
-spc Storage policy copy name
-l Library name
-srp Scratch pool name
-loc Export Location
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

  • To display all the media associated with job 74:

    E:\commandline>qlist media -j 74

  • To display the media in a library named STK9730 and scratch pool Spares:

    E:\commandline>qlist media -l STK9730 -srp Spares

  • To display the media in an export location named Shelf_A:

    E:\commandline>qlist media -loc Shelf_A

  • To display the media in a storage policy named STK_Tape and storage policy copy TapeCopyTwo:

    E:\commandline>qlist media -sp STK_Tape -spc TapeCopyTwo

qlist mediaagent

Description

This command lists the names of all the MediaAgents configured in the CommCell. Whenever more than one MediaAgent is found, each MediaAgent is listed in its own line on the command prompt. No message is displayed whenever MediaAgents are not found.

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

Usage

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

Options

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

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

List all the MediaAgents configured in the CommCell.

E:\commandline>qlist mediaagent
client1

qlist quickmedia

Description

This command lists media required to restore data associated with a client, iDataAgent, backup set, or subclient. The following information is displayed for each media:

  • export location
  • barcode
  • container name
  • library name
  • media type
  • storage policy name
  • copy name
  • subclient name
  • copy precedence number

Whenever more than one media is found, each media is displayed in its own line on the command prompt. The message "No media information to display" is displayed whenever media is not found.

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

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

Options

-co Columns to display. Available columns are e, b, c, l, t, p, o, s, and r.
-c Client computer name
-a Agent type installed on the client computer (see Argument Values - Agent Types)
-i Instance name
-b Backup set name
-s Subclient name
-bf Browse From
-bt Browse To
-syp Synchronous copy precedence
-sep Selective copy precedence
-tf Reads token from a file
-tk Token string
-h Displays help

If -c (client computer name) is the only option specified, then all the media used by backups during the last backup cycle will be displayed, regardless of application types.

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.

b Barcode of the media
c Container
l Library
p Storage policy
o Copy name
s Subclient
e Export location
t Media type
r Copy precedence

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

qlist scratchpool

Description

This command lists the names of all the scratch pools configured under a specified library. The MediaAgent name is optional. Whenever more than one scratch pool is found, each scratch pool is listed in its own line on the command prompt. No message is displayed whenever scratch pools are not found.

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

Usage

qlist scratchpool -l <library> [-m <mediaagent>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

-l Library name
-m MediaAgent Name
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

List all the scratch pools configured in library library1.

E:\commandline>qlist scratchpool -l library1
Scratchpool_1

qlist sp

Description

This command lists the names of all the storage policies available in the CommCell. All types of storage policies (for example, "iDataAgent Backup" or "Archiver") are listed by this command. Whenever more than one storage policy is found, each policy is listed in its own line on the command prompt. No message appears whenever storage policies are not found.

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

Usage

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

Options

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

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure. 

Example

List all the storage policies configured in the CommCell.

qlist sp
policy1

qlist spcopy

Description

This command lists the names of all the storage policy copies, both primary and secondary, under a given storage policy. Whenever more than one storage policy copy is found, each copy is listed in its own line on the command prompt. No message appears if storage policy copies are not found.

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

Usage

qlist spcopy -sp <storagepolicy> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-sp Storage policy name
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

List all the storage policy copies in the storage policy policy1.

qlist spcopy -p policy1
Primary
copy1

qlist vtaction

Description

This command lists the names of all the Vault Tracker actions that are configured in the CommCell. Whenever more than one action is found, each action is listed in its own line at the command prompt. No message appears if Vault Tracker actions are not found.

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

Usage

qlist vtaction [-cs <commserve_host_name>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

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

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 Vault Tracker actions that are configured.

E:\commandline>qlist vtaction
vtaction1
vtaction2

qlist vtp

Description

This command lists the names of all the Vault Tracker policies that are configured in the CommCell. Whenever more than one policy is found, each policy is listed in its own line at the command prompt. No message appears if  Vault Tracker policies are not found.

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

Usage

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

Options

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

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 Vault Tracker policies that are configured.

E:\commandline>qlist vtp
vtp1

qmedia allowexport

Description

This command allows you to export a given media that is set to "prevent export."

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

Usage

qmedia allowexport -b <barcode> [-tf <tokenfile>] [-tk <token>] [-h]

Options

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

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Reset the flag to allow for exporting the contents of the media with barcode 100101WW.

E:\commandline>qmedia allowexport -b 100101WW

qmedia deletecontents

Description

This command deletes the contents of a specified media and moves them into the specified scratch pool.

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

Usage

qmedia deletecontents -b <barcode> -srp <scratchpool> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-b Barcode
-srp Scratch pool
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Delete  the contents of the media with 100101WW barcode and move to scratch pool Scratchpool_1.

E:\commandline>qmedia deletecontents -b 100101WW -srp Scratchpool_1

qmedia export

Description

This command exports the specified media to a given location.

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

Usage

qmedia export -b <barcode(s)> -el <exportlocation> [-af <argsfile>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

-b List of barcodes separated by a comma (,)
-el Export Location name
-tf Reads token from a file
-tk Token string
-v Verify On Media Label (OML) for export
-h Displays help

Argument File

barcodes [string] List of barcodes, written one under the other.

For example

M00001L3

M00002L3

M00003L3

server CommServe host name
exportlocation  Export location
verifyoml Verify On Media Label (OML) for export

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 to location Exp_Loc

E:\commandline>qmedia export -b 100401WW,100402WW -el Exp_Loc

Sample Argument file:

[barcodes]
M00001L
3M00002L3

[server]
server1

[exportlocation]
<location>

[verifyoml]
1

qmedia load

Description

This command loads media into a drive under the specified MediaAgent.

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

Usage

qmedia load -b <barcode> -s <mediaside> -dr <drivename> -m <mediaagent> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-b Barcode
-s Media side name
-dr Drive name
-m MediaAgent name
-tf Reads token from a file
-tk Token string
-hh 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

Loads the media in barcode 100101WW onto the drive Drive_1 under MediaAgent MAgent1.

E:\commandline>qmedia load -b 100101WW -s A -dr Drive_1 -m MAgent1

qmedia markappend

Description

This command marks the specified media as appendable, which allows data to be written to the media.

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

Usage

qmedia markappend -b <barcode(s)> [-af <argsfile>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

-b List of barcodes separated by a comma (,)
-af Input file containing arguments
-tf Reads token from a file
-tk Token string
-h Displays help

Argument File

barcodes [string] List of barcodes separated by a comma.

For example, M00001L3,M00002L3, and so on.

server CommServe host name

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Mark specified media as appendable.

E:\commandline>qmedia markappend -b 100101WW

Sample Argument file:

[barcodes]
M00001L3
M00002L3

[server]
server1

qmedia markbad

Description

This command marks the specified media as bad.

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

Usage

qmedia markbad -b <barcode(s)> [-af <argsfile>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

-b List of barcodes separated by a comma(,)
-af Input file containing arguments
-tf Reads token from a file
-tk Token string
-h Displays help

Argument File

barcodes [string] List of barcodes separated by a comma.

For example, M00001L3,M00002L3, and so on.

server CommServe host name

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Mark specified media as bad.

E:\commandline>qmedia markbad -b 100101WW

qmedia markfull

Description

This command marks the specified media as full.

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

Usage

qmedia markfull -b <barcode(s)> [-af <argsfile>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

-b List of barcodes separated by a comma (,)
-af Input file containing arguments
-tf Reads token from a file
-tk Token string
-h Displays help

Argument File

barcodes [string] List of barcodes separated by a comma.

For example, M00001L3,M00002L3, and so on.

server CommServe host name

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Mark specified media as full.

E:\commandline>qmedia markfull -b 100101WW

Sample Argument file:

[barcodes]
M00001L3,M00002L3

[server]
server1

qmedia preventexport

Description

This command prevents the media from being exported.

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

Usage

qmedia preventexport -b <barcode> [-et <expirytime>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

-b Barcode
-et Expiration date and time in format "mm/dd/yyyy hh:mm[:ss]"

(default: Infinite)

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

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Prevent the given media from being exported.

E:\commandline>qmedia preventexport -b 100101WW -et 12/31/2007 00:00

qmedia verify

Description

This command verifies whether the media information in the CommCell matches the On-Media Label (OML) in the specified media.

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

Usage

qmedia verify -b <barcode> [-tf <tokenfile>] [-tk <token>] [-h]

Options

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

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Verifies the given media.

E:\commandline>qmedia verify -b 100101WW

qmodify container

Description

This command modifies an existing container that is associated with a Vault Tracker policy.

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

Usage

qmodify container [-cs <commserver_host_name>] -container <container> [-newname <newname>] [-cap <capacity>] [-track <trackingid>] [-desc <description>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

-cs CommServe host name
-container Name of the existing container
-newname New name for the container
-cap Maximum capacity of the container
-track Container's tracking ID
-desc A description of the container
-tf Read token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Change the name of a container from box123 to carton123

qmodify container -container box123 -newname carton123

qmodify vtp

Description

This command modifies a Vault Tracker policy.

When a Vault Tracker policy is modified, a message appears that tells you that the policy was modified successfully. If an error occurs, an error code and description appear: "vtp: Error errorcode: errordescription"

Usage

qcreate vtp [-cs <commserve_host_name>] -vtp <vtpolicyname> - newname <newname> [-desc <description>] [-autoack <autoack>] [-dueback <dueback>] [-srctype <sourcetype>] [-srcname <sourcename>] [-transit <transitlocation>] [-desttype <100 | 200 | 300>] [-destname <destinationname>] [-silocontainer <silocontainer>][-delaytime <delaytime>] [-quittime <quittime>] [-limitcount <nummediatomove>] [-usevms <usevms>] [-sp <sp | ALL>] [-spc <spc | ALL>] [-container <sourcename>] [-cap <capacity>] [-pattern <pattern>][-tf <tokenfile>] [-tk <token>] [-h]

Options

-cs CommServe host name
-vtp Name of the existing Vault Tracker policy
-newname New name for the Vault Tracker policy
-desc A description of the Vault Tracker policy
-autoack Auto Acknowledge. When this argument is present, Auto Acknowledge is enabled.
-dueback Due Back policy. When this argument is present, Due Back policy is enabled.
-srctype Source location type. 100:Library 200:Location 300:Shelf
-srcname Source location name
-transit Transit location
-desttype Destination type. 100:Library 200:Location 300:Shelf
-destname Destination name
-silocontainer Separate container for Silo. When this argument is present, separate container for Silo is enabled.
-delaytime Export delay minutes
-quittime Minutes until export goes into a Pending state
-limitcount Number of media to move
-usevms Use virtual mail slots. When this argument is present, use virtual mail slots is enabled.
-sp Storage Policy. Enter ALL to select all.
-spc Storage Policy Copy. Enter ALL to select all.
-container Container name
-cap Container capacity
-pattern Container pattern
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

1 - CLI usage failures because of the use of an unsupported option or missing argument.

2 - Any other failure.

Example

Modify a Vault Tracker policy named vtp1 to the name vtp_shelf, with a source type of shelf.

qmodify vtp -vtp vtp1 -newname vtp_shelf -srctype 300

qoperation auxcopy

Description

This command performs an auxiliary copy operation on the specified storage policy and secondary copy. The secondary copy must be created before running an auxiliary copy.

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

Usage

qoperation auxcopy -sp <storagepolicy> [-spc <copy>] [-af <ArgumentFilepath>] [-tf <tokenfile>] [-tk <token>] [-h]

Options

-sp Storage policy name
-spc Secondary copy name
-af Reads arguments from a file
-tf Reads token from a file
-tk Token string
-h Displays help

Argument File

sp Storage policy name
spcopy Storage policy copy name
priority Job priority
exportlocation Export Location
transitlocation Transit Location
usevms Use VMS Flag (0/1)
mediastatus Media status
startnewmedia Start new media flag (0/1)
alert Alert name
startsuspended Start job in suspended state (0/1)
retryno Number of times to retry the job
retrytime Number of hours to retry the job
jobdescription User-defined comments regarding the job

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Perform an auxiliary copy operation with storage policy policy1 and storage policy copy copy2.

E:\commandline>qoperation auxcopy -sp policy1 -spc copy2
175

qoperation jobretention

Description

This command allows you set retention rules on a given job. The job ID, storage policy, and storage policy copy names must be specified when using this command.

Jobs that are not retained are subject for data aging. Jobs that are retained with a specified retention period will become subject for data aging after the retention period ends. If you retain a job, however, and do not specify the retention period, the job data will never be subject for data aging.

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

Usage

qoperation jobretention -j <jobid> -sp <storagepolicy> -spc <copy> -rtn <true|false> [-rd <infinite or mm/dd/yyyy hh:mm:ss or yyyy/mm/dd hh:mm:ss>]

Options

-j Job ID
-sp Storage policy name
-spc Storage policy copy name
-rtn Job to be retained (true) or not (false)
-rd Date until the job is to be retained. Valid values are:
  • infinite
  • mm/dd/yyyy hh:mm:ss
  • yyyy/mm/dd hh:mm:ss
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Retain a job - with job ID 175, storage policy sp1 and storage policy copy copy1 - indefinitely by setting the retention period to infinite.

qoperation jobretention -j 175 -rtn true - rd infinite -sp sp1 -spc copy1

qoperation media

Description

This command exports one or more media from a library. If there are multiple media, they should be separated by a comma.

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

Usage

qoperation media -o export -b <barcode(s)> -l <library> -el <exportlocation> -m <mediaagent> [-v] [-tf <tokenfile>] [-tk <token>] [-h]

Options

-o Operation to be performed on the media
-b Barcode list (separate each barcode with a comma)
-l Library name
-el Export location name
-m MediaAgent name
-v Verify OML before export (0/1)
-tf Reads token from a file
-tk Token string
-h Displays help

Diagnostics

Possible exit status values are:

0 - Successful completion.

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

2 - Any other failure.

Example

Export media.

E:\commandline>qoperation media -o export -b 127126 -l lib1 -el loc1 -m med1 -v 1

qoperation vaulttracker

Description

This command runs a Vault Tracker policy.

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

Usage

qoperation vaulttracker -vtp <vaulttrackerpolicy> [-tf <tokenfile>] [-tk <token>] [-h]

Options

-vtp Vault Tracker policy name
-tf Reads token from a file
-tk Token string
-h Display 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

Run Vault Tracker policy vtp1.

E:\commandline>qoperation vaulttacker -vtp
vtp1

qoperation vtaction

Description

This command runs a Vault Tracker action.

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

Usage

qoperation vtaction [-cs <commserve_host_name] -vta <vtaction> -cmd <actioncmd> [-b <mediabarcode>] [-container <sourcename>] [-tf <tokenfile>] [-tk token] [-h]

Options

-cs CommServe host name
-vta Vault Tracker action ID
-cmd Action command. Valid commands are abort, suspend, resume, pick, return, reach
-b Media barcode
-container Container name
-tf Reads token from a file
-tk Token string
-h Display 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

Run Vault Tracker action vtaction1 with the command reach.

E:\commandline>qoperation vtaction -vta vtaction1 -cmd reach