Quantum Command Reference User Manual

Command Reference

VolServ Version 5.2

November 2003

6-01005-01 Rev A

Trademark Notice

AMASS, DataMgr, EMASS, FileServ, and VolServ are either trademarks or registered
trademarks of ADIC, Advanced Digital Information Corporation. DAS is a trademark of
Grau, an ADIC subsidiary. All other product names and identifications are trademarks or
registered trademarks of their respective manufacturers.

Copyright Notice

© 1996-2003 ADIC®. All rights reserved. This document is the property of ADIC. No part
of this document may be reproduced, transmitted, transcribed, stored in a retrieval system,
or translated into any language or computer language in any form or by any means,
electronic, mechanical, magnetic, optical, chemical, manual, or otherwise, without the
express written permission of:

ADIC USA
Tel.: [phone]
Fax: [phone]
ATAC: 1-800-827-3822
http://www.adic.com

ADIC Europe
ZAC des Basses Auges
1, rue Alfred de Vigny
78112 Fourqueux, France
Tel.: [phone]
Fax: [phone]

ADIC Germany Beteiligungs
GmbH, KG
Eschenstraße 3
D-89558 Böhmenkirch, Germany
Tel:[phone]

U.S. Government Rights Restricted

Use, duplication, or disclosure of either the software or documentation is subject to
restrictions set forth by the U.S. Government in FAR 52.227-19(c)(2) and subparagraph
(c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 52.227­7013 and/or in similar or following clauses in the FAR, DoD, or NASA FAR Supplement.

Technical Assistance

ADIC Technical Assistance Center:

• In the USA and Canada, call 1-800-827-3822.

• Outside the USA and Canada, call 303-874-0188 or toll-free 00800-9999-3822.

• Send e-mail to: [e-mail].

Documentation

Although the material contained herein has been carefully reviewed, ADIC does not
warrant it to be free of errors or omissions. We reserve the right to make corrections,
updates, revisions, or changes to the information contained herein.

• Send e-mail to: [e-mail]

READER COMMENT FORM

ADIC includes this Form in an effort to provide the best possible documentation to our
customers. Please take a few moments to mail or FAX your response to:

ADIC USA
Tel.: [phone]
Fax: [phone]
ATAC: 1-800-827-3822
http://www.adic.com

ADIC Europe
ZAC des Basses Auges
1, rue Alfred de Vigny
78112 Fourqueux, France
Tel.: [phone]
Fax: [phone]

ADIC Germany Beteiligungs
GmbH, KG
Eschenstraße 3
D-89558 Böhmenkirch, Germany
Tel:[phone]

Question Circle One

Information was complete. Agree Disagree
Information was easy to find. Agree Disagree
Information was easy to follow. Agree Disagree

Is there anything you especially like or dislike about the organization, presentation,
or writing in this manual?_______________________________________________
___________________________________________________________________
___________________________________________________________________
___________________________________________________________________
___________________________________________________________________

Book Title Document Number
Customer Name Telephone
E-mail Address
Company Name
Address
City, State, Zip

NOTES

Command Reference

Preface

Purpose of This Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-3

Who Should Read This Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-3

How This Book is Organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-3

Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-4

Books . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-5

Introduction 1

Options Common to all Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-3

Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-7

Command-

specific Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-9

CLI Directory Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-22

Command Reference 2

volserv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-3

vsamlconfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-6

vsarchiveqry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-8

vsarchivevary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-14

vsaudit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-18

vscheckin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-23

vscheckout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-29

vscleareject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-35

vsconnectqry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-41

6-01005-01 Rev A Contents i

Command Reference

vsdismount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-45

vsdriveqry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-49

vsdrivevary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-53

vsexport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-59

vsimport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-65

vsintransitqry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-73

vslock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-77

vsmedclassqry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-83

vsmedqry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-92

vsmedtypeqry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-99

vsmount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-103

vsmove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-115

vsping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-122

vspoolcfg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-125

vspoolqry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-127

vsqrymount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-133

vsreclassify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-138

vsrequestqry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-145

vsunlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-149

vswin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-154

ii Contents 6-01005-01 Rev A

Preface

Purpose of This Book . . . . . . . . . . . . . . . . . . . . . . .P-3

Who Should Read This Book. . . . . . . . . . . . . . . . .P-3

How This Book is Organized . . . . . . . . . . . . . . . .P-3

Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .P-4

Books. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .P-5

Online Books . . . . . . . . . . . . . . . . . . . . . . . . . . .P-5

Related Publications . . . . . . . . . . . . . . . . . . . . .P-6

Contact Publications Department. . . . . . . . . .P-6

Secured Web Site. . . . . . . . . . . . . . . . . . . . . . . .P-6

P

Preface

Command Reference

NOTES

P-2 Preface 6-01005-01 Rev A

Command Reference

Preface

Purpose of This Book

Who Should Read This Book

How This Book is Organized

This book alphabetically lists and describes the VolServ
commands.

This book is written for system administrators who uses the
command line to operate VolServ.

It assumes the administrator has a strong familiarity with:

• UNIX operating systems.

• Applications running in their site environment.

This book contains the following chapters:
Chapter 1: Introduction — Describes environment variables

and the command line structure.
Chapter 2: Command Reference — Alphabetical list of

VolServ commands.

6-01005-01 Rev A Preface P-3

Command Reference

Conventions

The conventions used throughout the VolServ technical books
are listed below:

Convention Example

Screen text, file names, program names, and
commands are in Courier font.

The root prompt is shown as a number
symbol.

What you should type in is shown in Courier
bold font.

Site-specific variables are in a Times italics
font.

A backward slash ( \ ) denotes the input is
continued onto the next line; the printed page
is just not wide enough to accommodate the
line.

Pressing <Return> after each command is
assumed.

Request to add a new volume:
Volume group will be “20”
Volume position will be “A123”.

# su root

vsarchiveqry

tar -xvf tapedevicename

#

remsh nodename -n dd if=/dev \

/tapedevicename/bs=20b | tar xvfb \

- 20

(You should type the entire command witho ut
the backward slash.)

A menu name with an arrow refers to a
sequence of menus.

P-4 Preface 6-01005-01 Rev A

Config-->MediaType-->Redefine

Command Reference

Preface

Books

The books described below are part of the technical
documentation set, and are shipped on CD along with the
VolServ software:

Overview

Provides an ov erview of VolServ . Co ntains a
glossary.

Installing VolServ
Describes server requirements, installation
instructions, troubleshooting procedures,
and configuration parameters.

Using the VolServ GUI

Describes how to perform system
administrative tasks using th e graphical user
interface.

API Guide

Provides a list of API functions.

Administrative Tasks

Describes how to perform system
administrative tasks using VolServ
commands.

Command Reference

Contains a list of VolServ commands

Error Messages

Provides corrective action f or system log
errors.

Quick Reference Card

Summarizes commands.

Online Books

The documentation CD contains VolServ book files and
requires the Adobe® Acrobat® Reader to view the

accompanying electronic documentation. The Reader allows
you to view and navigate the electronic documentation files yet
preserves the page design and graphics from the printed books.

6-01005-01 Rev A Preface P-5

Command Reference

Related Publications

Related Publications Description

“Release Notes” For each version of VolServ, the “Release Notes” contain:

“Product Alerts” Informs customers of technical problems and solutions.
“Product Bulletins” Conveys technical information—not problems—to

The publications described in the table below are created and
distributed on an as-needed basis.

• Summary of enhancements.

• Describes:

- Fixed problems.

- Known problems.

- Installation and configuration issues.

•Lists:

- Operating system patches.

- System requirements.

customers.

Contact Publications Department

Secured Web Site

To make corrections or to comment on VolServ publications,
please contact Software Technical Publications at our e-mail
address: [e-mail].

To receive access to the secured site on our home page contain­ing technical product information (Release Notes, Product
Alerts, Product Bulletins, FAQs), visit http://partners.adic.com/
and follow the password request procedure. In return, ADIC
will send you instructions and a password.

P-6 Preface 6-01005-01 Rev A

Options Common to all Commands . . . . . . . . . .1-3

Optional Parameters. . . . . . . . . . . . . . . . . . . . .1-4

Default Values. . . . . . . . . . . . . . . . . . . . . . . . . .1-4

Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

1

Environment Variables . . . . . . . . . . . . . . . . . . . . . 1-7

Command-specific Options. . . . . . . . . . . . . . . . . .1-9

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16

CLI Directory Structure . . . . . . . . . . . . . . . . . . . . 1-22

Introduction

Introduction

Command Reference

Roadmap

Topic

Introduction. 1
Alphabetical list of commands. 2

Refer To

Chapter

1-2 Introduction 6-01005-01 Rev A

Command Reference

Options Common to all Commands

Seven options are av ailable on e very command that is supported
from the command line. These parameters are:

Introduction

Parameter Description

-I Indicates command line options are to be re ad
from stdin. The -I option provides the
capability for the client to enter command
options on the command line, in a te xt file , or a
combination of both. When the -I option is
specified, command options are first read from
the command line. VolServ then reads any
options from stdin.

Example: cat optionfile > vsmount -I -u

-p drvpool2 instructs VolServ to first read
the -u and -p options entered on the
command line and then to read the options
from stdin (the contents of optionfile). If
optionfile contains “-c class1”, the
command, as processed by VolServ, will look
like “vsmount -u -p drvpool2 -c class1”

-h Requests help for the entered comm and. The
Help option returns the usage for the entered
command, a copyright notice, an d the version
number of the CLI software. The Help option
takes precedence over any other option
entered on a command. When the Hel p option
is specified, no command line processing is
performed. An exit code of 0 is returned to the
client when the Help option is specified.

-H hostname Host name of t he VolServ server. The default
host name is the host name of the computer
where the CLI command is issued.

6-01005-01 Rev A Introduction 1-3

Command Reference

Parameter Description

Optional Parameters

-P priority
Default value is

15.

-R retries
Default value is

3.

-T timeout
Default value is

120 seconds.

-V prognum
Default value is

300016.

The execution priority of the entered
command. Assignable priority values are
restricted to a range from 1 (highest) to 32
(lowest) inclusive .

Number of retries the CLI software attempts if
a time-out is returned by the API software.

Amount of time (in seconds) the API software
waits for status from VolServ before returning
a time-out to the CLI software. Total wait time
for a command is (retries plus 1) multiplied by
time-out value.

RPC program number for VolServ.

The following parameters are optional:

• -I (read from stdin).

• -h (help).
Both options needs to be specified only if the client is

requesting the functionality provided by the option.

Default Values

The remaining parameters have default values:

•-H (hostname).

•-P (priority).

•-R (retries).

1-4 Introduction 6-01005-01 Rev A

Command Reference

•-T (timeout).

•-V (prognum).
If the client does not specify one or more of these options on a

command, VolServ uses the appropriate default values specified
in the description of the previous options.

A client can specify values that override the default values
previously specified. To specify an override value, the client
must set an environment variable for each common option that
is to have an override default.

The environment variables and their associated common
options are:

Parameter Environment Variable*

-H hostname VSCLI_HOST

Introduction

-P priority VSCLI_PRIORITY

-R retries VSCLI_RETRIES

-T timeout VSCLI_TIMEOUT

-V prognum VSCLI_PROGNUM

The client runs the UNIX
environment variable.

setenv command to set an

Example The following example sets the default for the -H ( hostname )

option to eiffel and overrides the VolServ default. The
default hostname is the host computer where the command is
issued.

setenv VSCLI_HOST eiffel

Or,

6-01005-01 Rev A Introduction 1-5

Command Reference

prompt VSCLI_HOST=eiffel
prompt export VSCLI_HOST (bourne shell)

When a client specifies one or more of the -H (hostname), the

-P (priority), the -R (retries), the -T (timeout), and the -V
(prognum) options on the command line, the values entered on
the command line supercedes the VolServ default values and
any user-specified default values for the appropriate options.

1-6 Introduction 6-01005-01 Rev A

Command Reference

Environment Variables

The following environment variables provide the capability for
the client to specify default values for common options:

• VSCLI_HOST

• VSCLI_PRIORITY

• VSCLI_RETRIES

• VSCLI_TIMEOUT

• VSCLI_PROGNUM

The environment v ariable belowcontrols the number of lines per
page for report output:

• VSRPT_PAGE_LENGTH
The default page length is 66 lines.

If the default page length is not appropriate, a client can execute
the appropriate environment variable command to set the

VSRPT_PAGE_LENGTH environment variable to the desired

page length. If the VSRPT_PAGE_LENGTH environment v ariable
is set to 0, VolServ generates reports with no page breaks.

Introduction

VolServ uses the user-specified page length when generating
the following reports.

• Archive Query

• Connect Query

• Drive Query

• Intransit Query

• MediaClass Query

• Drive Pool Query

6-01005-01 Rev A Introduction 1-7

Command Reference

• Request Query

• Media Type Query

•Media Query

1-8 Introduction 6-01005-01 Rev A

Command Reference

Command­specific
Options

A matrix that shows which commands support which
command-specific options is included in below

A discussion of how each of these options direct or modify the
processing of individual commands is included with the
command descriptions in this discussion.

Command-specific options are described in the following
outline.

Parameter Description Example

-a Specifies that all items meet
specified criteria that are to be
processed.

Used primarily on query
commands.

-a archivename Specifies the name of the
archive to be referenced by the
command.

Valid archive names may
contain up to 16 alphanumeric
characters, including spaces.
Leading and trailing spaces are
not permitted.

vsdriveqry -a
Instructs VolServ to return

information on all drives known to
the VolServ system.

vsimport … -a archive1 …
Instructs VolServ to import the

specified medium/media into the
archive1 archive.

Introduction

archivename Specifies the name of the

archive to be referenced by the
command.

Valid archive names may
contain up to 16 alphanumeric
characters, including spaces.
Leading and trailing spaces are
not permitted.

6-01005-01 Rev A Introduction 1-9

vsarchivevary archive1 …
Specifies that VolServ is to vary

the state of the archive1
archive.

Command Reference

Parameter Description Example

-b Identifies the batch assigned to
the medium/media being
imported.

-c Indicates that all MediaClass
names associated with the
specified archive are to be
reported.

-c currentmediaclass Identifies the current
MediaClass name of the
medium/media to be
reclassified.

-c mediaclass Identifies the target MediaClass
name of the medium/media
specified on the command.

vsimport … -b batch1 …
Identifies batch1 as the batch

assigned to the medium/media
being imported. The batch
assigned to a medium is
maintained by the VolServ
system.

vsarchiveqry … -c …
Instructs VolServ to return all

MediaClass names associated
with the specified archive .

vsreclassify … -c
MediaClassA …

Indicates to VolServ that the
medium/media specified on the
command are currently
associated with MediaClassA.

vsimport … -c MediaClassB …
Instructs VolServ to associate the

imported medium/media with
MediaClassB.

-d Indicates that all drives
associated with the specified
archive are to be reported.

vsarchiveqry … -d …
Instructs VolServ to return all

drive IDs associated with the
specified archive.

-d driveID Identifies the drive on which the
medium to be dismounted is
currently mounted.

vsdismount … -d 1 …
Indicates to VolServ that the

medium specified to be
dismounted is currently mounted
on drive 1.

1-10 Introduction 6-01005-01 Rev A

Parameter Description Example

Command Reference

driveID… Specifies a list of one or more

drives from which the drives to
satisfy the command are to be
selected.

The number of drives that can
be specified is restricted by the
CLI software. Currently, the
maximum allowed number is 64.

drivepool Specifies the name of the drive

pool being queried.

enterpriseID Specifies the identifier of the

enterprise connection being
queried.

An enterprise ID must be
numeric.

-f Identifies the manufacturer of
the medium/media being
imported.

vsunlock 1 3 …
Instructs V olServ to unlock drive 1

and drive 3.

Introduction

vspoolqry drivepool3

Instructs VolServ to return
information on drive pool3.

vsconnectqry 4
Instructs VolServ to return

information on the 4 connection.

vsimport … -f manufac1 …
Identifies manufac1 as the

manufacturer of the
medium/media being imported.
The manufacturer of a medium is
maintained by the VolServ
system.

-i Indicates, if an inter-archive
move is required, that the
command is to be processed
only if both the source and
destination archives are
attended.

6-01005-01 Rev A Introduction 1-11

vsmount … -i …
Instructs VolServ to perform the

mount if an inter-archive move is
required only if both the source
and destination archives are
attended.

Command Reference

Parameter Description Example

-l lockID Specifies the lock ID assigned
to the drive specified in the
command.

-m Indicates that all media
associated with the specified
archive are to be reported.

mediaclass Specifies the name of the

MediaClass group being
queried.

mediaID Specifies the medium to be

processed by the command.
A valid medium identifier may

contain up to 16 alphanumeric
characters, including spaces.
Leading and trailing spaces are
not permitted.

mediaID… Specifies a list of one or more

media to be processed by the
command.

A valid medium identifier may
contain up to 16 alphanumeric
characters, including spaces.
Leading and trailing spaces are
not permitted.

vsdismount … -l 9 …
Indicates that the drive specified

in the command is reserved for
exclusive use and has been
assigned the lock ID 9.

vsarchiveqry … -m …
Instructs VolServ to return all

media IDs associated with the
specified archive.

vsmedclassqry medclass6…
Instructs VolServ to return

information on medclass6.
vsqrymount medium7

Requests a list of the drives
available to satisfy a mount
request for medium7.

vsexport medium8 medium 9
medium11 medium3 …

Instructs VolServ to export
medium8, medium9, medium11,
and medium3.

The number of media that can
be specified is restricted by the
CLI software. Currently, the
maximum allowed number is 64.

1-12 Introduction 6-01005-01 Rev A

Parameter Description Example

Command Reference

mediatype… Specifies a list of one or more

mediatypes to be processed by
the command.

Valid MediaType names can
contain up to 16 alphanumeric
characters, including spaces.
Leading and trailing spaces are
not permitted.

The number of media types th at
can be specified is restricted by
the CLI software. Currently, the
maximum allowed number is 32.

-n newmediaclass Identifies the target MediaClass
group of the medium/media
specified on the command.

-p drivepool Specifies the name of a drive
pool from which a drive can be
selected to satisfy the
command.

Valid drive pool names may
contain up to 16 alphanumeric
characters, including spaces.
Leading and trailing spaces are
not permitted.

vsmedtypeqry medtypeZ
Instructs VolServ to return

information on medtypeZ.

Introduction

MedClassX …
Instructs VolServ to associate the

specified medium/media with
MedClassX.

vsmount … -p drivepool1 …
Instructs VolServ to mount the

specified medium/media on
drives selected from drive pool
drivepool1.

-q quantity Specifies the number of drives
to be locked.

vslock … -q 3 …
Instructs VolServ to lock three

drives.

6-01005-01 Rev A Introduction 1-13

Command Reference

Parameter Description Example

requestID Specifies VolServ-assigned ID

of the request being queried.
A valid request ID must be

specified in either the

ydddnnnnn format or the
yy:ddd:nnnnn format where y

and yy represent the last
one/two digits of the year, ddd
represents the Julian day, and
nnnnn is a one-up number.

-s compstate Specifies the target state of the
item being varied.

-t Indicates that all media types
associated with the specified
archive are to be reported.

-t comment Provides a comment to be
associated with each media
specified on the command.
V olServ maintains the comment,
if any, associated with each
medium. This comment is
provided on the Eject list (a GUI
display) from the arch ive
console associated with the
archive containing the media.

vsrequestqry 93:131:14796…
Requests status on request

93:131:14796 from VolServ.

vsdrivevary … -s on-line …
Instructs VolServ to vary the

specified drive to the on-line
state.

vsarchiveqry … -t …
Instructs VolServ to return all

media types associated with the
specified archive.

vscheckout … -t “Sending
tocustomer xyz”

Provides the comment “Sending
to customer xyz” to be

associated with each medium
specified in the command.

-u Indicates the command is to be
processed if an inter-archive
move is required whether the
source and destination archives
are attended or unattended.

vsmount … -u …
Instructs VolServ to perform the

mount if an inter-archive move is
required whether the losing and
gaining archives are attended or
unattended.

1-14 Introduction 6-01005-01 Rev A

Parameter Description Example

Command Reference

-v Indicates that verbose output is
requested.

•If -v option is specified on a

command that specifies a list
of items, status is returned on
every item specified in the list,
regardless of the success or
failure of the command
processing on each item.

•If -v option is specified on a

query command, all
applicable information is
returned to the client.

•If -v is not specified on a

command that specifies a list
of items, status is returned on
only those items that were not
successfully processed.

•If -v option is not specified on

a query command, only the
specifically requested
information is returned to the
client.

vscleareject … -v …
Instructs VolServ to return status

on every medium specified in the
command, regardless of whether
the medium is successfully or
unsuccessfully processed. If the

-v option is not specified on the
vscleareject command, status is

returned on only those media that
are not successfully removed
from the Eject list.

vsmedclassqry … -v
Instructs VolServ to return

detailed information for all media
associated with each media class
reported. If the -v option was not
specified on the vsmedclassqry
command, only the IDs of the
media associated with the
reported MediaClass group are
returned to the client.

Introduction

-w Indicates VolServ waits until the
command processing
completes before returning
status to the client.

vsmove … -w …
Instructs VolServ to return status

only after move processing

completes.
If the move requires an
inter-archive move, VolServ
waits until the move completes,
whether the source and
destination archives are
attended or unattended. When
the -w option is not specified,
final status is returned as soon
as move processing begins.

6-01005-01 Rev A Introduction 1-15

Command Reference

Parameter Description Example

-x Specifies a list of one or more
drives to exclude from a
specified drive pool when
selecting drives to satisfy a
command.

The -x option is valid only when
the -p drivepool option is
specified.

Tables

The names of the commands, as entered from the command
line, are listed alphabetically in the first column of the table.
The command-specific options are listed alphabetically across
the top of the table.

• When a command does not support an option, the cell that
represents the intersection of the command and the
command-specific option is shaded. For example, the

vsdismount command does not support the -a

archivename option.

• When a command does support an option, the cell that
represents the intersection of the command and the option
contains an X. For example, the vsdismount command
does support the -d driveID, the -l lockID option, and the
mediaID option.

vsmount …-p
: drvpoolmed -x 1 2 …
Instructs VolServ to exclude

drives 1 and 2 from
consideration when selecting
drives from the drvpoolmed
drive pool to satisfy the mount
request.

1-16 Introduction 6-01005-01 Rev A

Command Reference

-c

current

mediaclass

vsamlconfig

-a (all)-aarchive
name

archivename

X

-b

batchID-c(MediaClass)

vsarchiveqry X X X
vsarchivevary X
vsaudit X
vscheckin X
vscheckout
vscleareject
vsconnectqry
vsdismount
vsdriveqry X
vsdrivevary
vsexport
vsimport X X
vsintransitqry
vslock
vsmedclassqry X
vsmedqry X
vsmedtypeqry X
vsmount
vsmove X
vsping
vspoolqry X
vsqrymount
vsreclassify X
vsrequestqry
vsunlock

Introduction

6-01005-01 Rev A Introduction 1-17

Command Reference

-f

manufacturer

-i

(mount,

attended)

-l

lockID-m(mediaIDs)

mediaclass

vsamlconfig
vsarchiveqry X
vsarchivevary
vsaudit
vscheckin
vscheckout
vscleareject
vsconnectqry
vsdismount X
vsdriveqry
vsdrivevary
vsexport
vsimport X
vsintransitqry
vslock
vsmedclassqry X X
vsmedqry
vsmedtypeqry
vsmount XX
vsmove X
vsping
vspoolqry
vsqrymount
vsreclassify
vsrequestqry
vsunlock X

1-18 Introduction 6-01005-01 Rev A