Command Reference
VolServ Version September 601356 Rev A
Copyright Notice
Trademark Notice
U.S. Government Rights Restricted
Technical Assistance
READER COMMENT FORM
Page
Command Reference
Contents
Preface
Introduction
Contents
Command Reference
Preface
Preface
601356 Rev A
Command Reference
Preface
Purpose of This Book Who Should Read This Book
Chapter 2 Command Reference - Alphabetical list of VolServ commands
How This Book is Organized
Preface
Convention
Conventions
Example
# remsh nodename -n dd if=/dev \
Preface
Books
Online Books
Contact Publications Department Secured Web Site
Related
Publications
Introduction
Introduction
Command Reference
Roadmap
Topic
Refer To
Introduction
Options Common to all Commands
Parameter
Description
H hostname P priority R retries
Default Values
T timeout
Optional Parameters
Introduction
T timeout V prognum
setenv VSCLIHOST eiffel Or
Command Reference
prompt VSCLIHOST=eiffel prompt export VSCLIHOST bourne shell
Introduction
601356 Rev A
Introduction
Environment Variables
Request Query Media Type Query Media Query
Command Reference
Introduction
601356 Rev A
Command- specific Options
Description
Parameter
Example
vsimport … -b batch1 …
Parameter
Introduction
Description
Example
Description
Parameter
Example
vsdismount …
Parameter
Introduction
Description
Example
Parameter
yydddnnnnn format where y
Description
Example
Parameter
Introduction
Description
Example
mediaID option
Tables
archivename option
batchID
current
MediaClass
mediaclass
mediaclass
mount
manufacturer
lockID
quantity
drivepool
mediaclass
mediaID
Media
request
mount
usage
driveID…
verbose
wait
Directory
CLI Directory Structure
Contents
Introduction
Command Reference
601356 Rev A
Introduction
Introduction
Command Reference
1-24
601356 Rev A
Commands
Command Reference
Command Reference
Command Reference
Roadmap
Topic
Parameters
volserv
Parameters
Commands
Step
Step
Successful VolServ system start-up. Requests
Step 1. vsamlconfig
vsamlconfig
Commands
Parameters
Step
Step 10. Enter Mode ArchiveMode
Step
Step
Commands
vsarchiveqry
T timeout -V prognum
Parameters
Parameters
T timeout
Description
H hostname
Step
Commands
Step
vsarchiveqry shelf1 -ct
vsarchiveqry stage1
Step 2. Output returned
vsarchiveqry BadArchiveName -d
Commands
with the VolServ cancel command. The VolServ cancel
A pending or executing vsarchiveqry request is cancelled
command is run from the command line by sending a SIGQUIT
signal control-\. The request is also aborted by sending the
Commands
vsarchivevary
H hostname -P priority -R retries T timeout -V prognum
Parameters
Parameters
T timeout
Description
H hostname
Step
Commands
Step
Step
vsarchiveqry
Parameters
vsaudit
Commands
Parameters
T timeout
Parameters
Description
Step
Commands
Step
vsaudit shelf1
command is not available from the command line, but is
using the VolServ reprioritize command. The reprioritize
A pending or executing vsaudit request is reprioritized
available to the client through either the API or the RPC
Command Reference
Commands
Command Reference
601356 Rev A
vscheckin mediaid…
vscheckin
Parameters
Descrition
Commands
a archivename
H hostname
vscheckin MED012 MED014 MED023
Step
Step
Step
Commands
vscheckin MED013 -a shelf2
vscheckin MED011 MED014 MED021
Step
Step
vscheckin MED001 MED002 MED093 -a
stage1
Command Reference
Commands
Command Reference
601356 Rev A
Parameters
vscheckout
Description
Commands
t comment
H hostname
Step
MED003,MED004,and MED005 out of the
Step
vscheckout MED003 MED004 MED005 -t
vscheckout MED010 MED011 MED012 MEDa13
Commands
vscheckout MED003 MED004 MED005 MED006 MED007 MED008
Step
Step
VolServ to check MED010, MED011, MED012
vscheckout MED010 MED011 MED012
Command Reference
Commands
Command Reference
601356 Rev A
Parameters
vscleareject
Parameters
Commands
Paramaeter
Description
vscleareject MED017 MED021 MED023
Step
Step
vscleareject MED012 MED013 MEd014 MED051
Commands
vscleareject MED016 MED018 MED020 MED021
vscleareject MED012 MED013 MED014 MED051
Command Reference
Commands
Command Reference
601356 Rev A
H hostname -P priority -R retries T timeout -V prognum
vsconnectqry
Parameters
Parameters
vsconnectqry
Commands
Step
Step
Step
Step
Connect Query Report
Commands
None
Parameters
vsdismount
e errorcount
Commands
Parameters
Parameter
Step
Step
vsdismount MED012 -d
Dismount of Media MED032 from Drive 2 was successful
Step
Commands
Step
H hostname -P priority -R retries T timeout -V prognum
vsdriveqry
Parameters
Parameters
vsdriveqry -a
Commands
Step
Output returned
Step
Step
Commands
Step
vsdriveqry
H hostname -P priority -R retries T timeout -V prognum
vsdrivevary
Parameters
Parameters
Description
Commands
s state
H hostname
vsdrivevary -p drvpoolusr -s off-line
drvpoolusr
vsdrivevary 2 -s diagnostic
Commands
Step
Step
Step
vsdrivevary -p BadPoolName -s diagnostic
Step
Step
Commands
vsexport mediaid… t comment -Ihv
vsexport
Parameters
Parameters
Commands
Parameter
Description
Parameter
T timeout
Description
P priority
Step
Commands
Step
Step
Step 2. Output returned
Commands
vscleareject, vsimport
Parameters
vsimport
Parameters
Commands
Parameter
Description
Description
Parameter
b batch
H hostname
MED018, MED021, MED030, and MED036 into
Commands
vsimport MED003 MED018 MED021 MED030
MED036
Step
Step
Step
Commands
Step
MED018, MED021, MED030, and MED036
Step
Commands
vsexport
Media is considered to be intransit under the following conditions
Parameters
T timeout
Commands
Parameter
Description
Step
Step
Step
Step
Command Reference
Commands
Command Reference
601356 Rev A
vslock
T timeout -V prognum
Commands
Parameters
Parameters
Parameter
T timeout
Description
H hostname
Step
Commands
Step
Step
Lock was unsuccessful Error VOL030 invalid drive pool specified
Error VOL122 not enough available drives in pool
Lock was unsuccessful
vslock -p BadDrivePool -q
Commands
H hostname -P priority -R retries T timeout -V prognum
vsmedclass qry
Parameters
Parameters
T timeout
Commands
Description
H hostname
vsmedclassqry -a
Step
Step
Step
Commands
Successful Media Class Query request with -m
option specified
vsmedclassqry medclasssml
Step
Commands
MediaID MED017
Step
Commands
Step
vsmedclassqry UnknownClass
cancel command. The VolServ cancel command is run from the
A pending vsmedclassqry is cancelled with the VolServ
command line by sending a SIGQUIT signal control-\. The
request also is aborted by sending the SIGINT signal
Commands
vsmedqry
T timeout -V prognum
Parameters
vsmedqry -a
Step
Step
Commands
Media ID
Commands
MED027 , BadMedia , and MED039
Step
Step
required to be located in the same library
A vsmedqry can query any media in the VolServ system. The
media specified in a single Media Query request are not
Commands
vsmedclassqry
H hostname -P priority -R retries T timeout -V prognum
vsmedtype qry
Parameters
Parameters
T timeout
Commands
Parameter
Description
Step
Step
Step
vsmedtypeqry -a
Commands
vsmount
A vsmount request is queued for later processing if
Commands
Parameters
Parameter
Parameters
Description
mediaid …
T timeout
Commands
Parameter
Description
Step
Step
Step
vsmount MED026 -d
Commands
medclasssh1med
vsmount -c medclassmed -d 10 -n medclasssh1med
vsmount MED022 -p drvpoolusr -x 4
vsmount MED034 -p drvpoolmed -x
vsmount MED034 -d
vsmount -c medclassstgmed -p drvpoolmed -n medclassmed
Commands
Mount of Media MED048 onto Drive 3 was successful
vsmount MED023 -d
Step
Step
Step
vsmount BadMedia -d
The vsmount request fails if no specified drive is online
Commands
If a list of media specified in a vsmount request contains media of more than one type, the request fails
Commands
vsmove
H hostname -P priority -R retries T timeout -V prognum
Commands
Parameters
Parameters
Description
Parameter
H hostname
P priority
Commands
MED023, MED044, and MED048 to library
vsmove MED016 MED023 MED044 MED048 -a
stage1 -wv
Step
Step
Step
Step
MEDxyz to the BadArchive library
MED004, MED013, MED028, MED033, and
Commands
vsmove MED003 MED004 MED013 MED028 MED033 MED043 a shelf2
Move of media was unsuccessful
Error VOL107 invalid target archive
Step
Parameters
vsping
Commands
Step
Step
vsping
VolServ is available
Error CMD022 could not send command
Commands
to volume server
Step
H hostname -P priority -R retries -T timeout -V prognum
vspoolcfg
Parameters
Parameters
T timeout
Commands
Description
H hostname
vspoolqry drivepool vspoolqry -a Ihv
vspoolqry
Parameters
T timeout
Commands
Description
H hostname
vspoolqry drvpoolsml
Step
Step
vspoolqry -a
Commands
vspoolqry NoPool
Step
Step
Command Reference
Commands
Command Reference
601356 Rev A
vsqrymount mediaid Ih
vsqrymount
Parameters
T timeout
Commands
Description
H hostname
Step
Step
vsqrymount MED024
Media MED024 can be mounted on the following drives 1Drive 14 2Drive
vsqrymount MED003
Commands
Step
vsmount
Parameters
vsreclassify
Commands
Parameter
Parameters
Description
mediaid …
T timeout
Commands
Parameter
Description
Step
Step
Step
Step
Error VOL024 Media MED013 Media MED017 Media MED020 Media MED032
Commands
Step
Reclassify of 2 of 6 media into class medclasssh2sml was successful
Command Reference
Command Reference
2-142
601356 Rev A
Commands
Parameters
vsrequestqry
T timeout
Commands
Parameter
Description
314402137 or
9314402136 or
Step
Step
Commands
Parameters
vsunlock
T timeout
Commands
Description
H hostname
Step
Step
vsunlock -v 4 8 12 -l
vsunlock 4 8 -l
vsunlock 40 41 42 43 -l
Commands
vsunlock -v 40 41 42 43 -l
vsunlock request
Commands
vswin
Parameters
Step
Command Reference
Command Reference
The display location of vswin must give xhost privileges to
the VolServ host machine for vswin to properly work
Command Reference
Commands
Command Reference
601356 Rev A
Command Reference
Command Reference
2-156
601356 Rev A