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