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