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