Manuals / ADIC / Computer Equipment / Barcode Reader

ADIC 601356 manual CLI Directory Structure, Contents

Models: 601356

1 192

Download 192 pages 39.58 Kb

Page 34

CLI Directory Structure

Command Reference

CLI Directory Structure

All files necessary for command line interface to VolServ are contained in the volserv/vscli directory by default. However, the installer may choose a different directory during execution of the installation script. The vscli subdirectory is always appended to the directory specified by the installer. Refer to Installing VolServ for more information.

The system administrator or clients may use the commands to interface to VolServ. The commands are interfaced to VolServ via the API. For more information, refer to the Command Reference and API Guide.

The default command directory structure is shown in the following figure and described in the table below.

/volserv/vscli

/bin

/man

/util

Directory	Contents

bin	Contains the CLI executables that are invoked
	from the command line by the system
	administrator and the system operator.

man	Contains man pages for each executable in the
	/bin directory.

util	Contains several utilities and associated .README
	files.

1-22

Introduction

601356 Rev A

Image 34

ADIC 601356 manual CLI Directory Structure, Contents

Contents

VolServ Version September 601356 Rev A Command ReferenceU.S. Government Rights Restricted Trademark NoticeCopyright Notice Technical AssistanceREADER COMMENT FORM Page Preface ContentsCommand Reference IntroductionCommand Reference ContentsPreface PrefacePreface Command Reference601356 Rev A How This Book is Organized Chapter 2 Command Reference - Alphabetical list of VolServ commandsPurpose of This Book Who Should Read This Book PrefaceExample ConventionsConvention # remsh nodename -n dd if=/dev \Online Books BooksPreface Publications RelatedContact Publications Department Secured Web Site Introduction IntroductionTopic RoadmapCommand Reference Refer ToParameter Options Common to all CommandsIntroduction DescriptionT timeout Default ValuesH hostname P priority R retries Optional Parameterssetenv VSCLIHOST eiffel Or T timeout V prognumIntroduction Introduction prompt VSCLIHOST=eiffel prompt export VSCLIHOST bourne shellCommand Reference 601356 Rev AEnvironment Variables IntroductionIntroduction Command ReferenceRequest Query Media Type Query Media Query 601356 Rev ACommand- specific Options Example ParameterDescription vsimport … -b batch1 …Description IntroductionParameter ExampleExample ParameterDescription vsdismount …Description IntroductionParameter ExampleDescription yydddnnnnn format where yParameter ExampleDescription IntroductionParameter Examplearchivename option TablesmediaID option MediaClass currentbatchID mediaclassmanufacturer mountmediaclass lockIDmediaclass drivepoolquantity mediaIDmount requestMedia usagewait verbosedriveID… Contents CLI Directory StructureDirectory 601356 Rev A Command ReferenceIntroduction Introduction1-24 Command ReferenceIntroduction 601356 Rev ACommand Reference CommandsRoadmap Command ReferenceCommand Reference TopicParameters volservParameters CommandsSuccessful VolServ system start-up. Requests StepStep Commands vsamlconfigStep 1. vsamlconfig ParametersStep Step 10. Enter Mode ArchiveModeStep StepT timeout -V prognum vsarchiveqryCommands ParametersDescription T timeoutParameters H hostnameStep CommandsStep vsarchiveqry shelf1 -ctStep 2. Output returned vsarchiveqry stage1Commands vsarchiveqry BadArchiveName -dcommand is run from the command line by sending a SIGQUIT A pending or executing vsarchiveqry request is cancelledwith the VolServ cancel command. The VolServ cancel signal control-\. The request is also aborted by sending theH hostname -P priority -R retries T timeout -V prognum vsarchivevaryCommands ParametersDescription T timeoutParameters H hostnameStep CommandsStep Stepvsarchiveqry Commands vsauditParameters Parameters T timeoutParameters DescriptionStep CommandsStep vsaudit shelf1A pending or executing vsaudit request is reprioritized using the VolServ reprioritize command. The reprioritizecommand is not available from the command line, but is available to the client through either the API or the RPCCommand Reference CommandsCommand Reference 601356 Rev AParameters vscheckinvscheckin mediaid… a archivename CommandsDescrition H hostnameStep Stepvscheckin MED012 MED014 MED023 vscheckin MED013 -a shelf2 CommandsStep vscheckin MED011 MED014 MED021vscheckin MED001 MED002 MED093 -a StepStep stage1Command Reference CommandsCommand Reference 601356 Rev Avscheckout Parameterst comment CommandsDescription H hostnameStep MED003,MED004,and MED005 out of theStep vscheckout MED003 MED004 MED005 -tvscheckout MED003 MED004 MED005 MED006 MED007 MED008 Commandsvscheckout MED010 MED011 MED012 MEDa13 VolServ to check MED010, MED011, MED012 StepStep vscheckout MED010 MED011 MED012Command Reference CommandsCommand Reference 601356 Rev Avscleareject ParametersParamaeter CommandsParameters DescriptionStep Stepvscleareject MED017 MED021 MED023 vscleareject MED016 MED018 MED020 MED021 Commandsvscleareject MED012 MED013 MEd014 MED051 vscleareject MED012 MED013 MED014 MED051 Command Reference CommandsCommand Reference 601356 Rev AParameters vsconnectqryH hostname -P priority -R retries T timeout -V prognum ParametersStep Commandsvsconnectqry Step StepStep Connect Query ReportNone Commandsvsdismount ParametersParameters Commandse errorcount Parametervsdismount MED012 -d StepStep Dismount of Media MED032 from Drive 2 was successfulStep CommandsStep Parameters vsdriveqryH hostname -P priority -R retries T timeout -V prognum ParametersStep Commandsvsdriveqry -a Step Output returnedStep CommandsStep vsdriveqryParameters vsdrivevaryH hostname -P priority -R retries T timeout -V prognum Parameterss state CommandsDescription H hostnamedrvpoolusr vsdrivevary -p drvpoolusr -s off-lineStep Commandsvsdrivevary 2 -s diagnostic StepStep vsdrivevary -p BadPoolName -s diagnosticStep StepCommands Parameters vsexportvsexport mediaid… t comment -Ihv Parameter CommandsParameters DescriptionDescription T timeoutParameter P priorityStep CommandsStep StepStep 2. Output returned vscleareject, vsimport Commandsvsimport ParametersParameter CommandsParameters Descriptionb batch ParameterDescription H hostnamevsimport MED003 MED018 MED021 MED030 CommandsMED018, MED021, MED030, and MED036 into MED036Step StepStep Commands Step MED018, MED021, MED030, and MED036Step vsexport CommandsParameters Media is considered to be intransit under the following conditionsParameter CommandsT timeout DescriptionStep StepStep StepCommand Reference CommandsCommand Reference 601356 Rev Avslock Parameters CommandsT timeout -V prognum ParametersDescription T timeoutParameter H hostnameStep CommandsStep StepLock was unsuccessful Error VOL122 not enough available drives in poolLock was unsuccessful Error VOL030 invalid drive pool specified vslock -p BadDrivePool -qCommands Parameters vsmedclass qryH hostname -P priority -R retries T timeout -V prognum ParametersDescription CommandsT timeout H hostnameStep Stepvsmedclassqry -a Successful Media Class Query request with -m CommandsStep option specifiedStep vsmedclassqry medclasssmlCommands MediaID MED017 Step CommandsStep vsmedclassqry UnknownClasscommand line by sending a SIGQUIT signal control-\. The A pending vsmedclassqry is cancelled with the VolServcancel command. The VolServ cancel command is run from the request also is aborted by sending the SIGINT signalT timeout -V prognum vsmedqryCommands ParametersStep vsmedqry -aCommands StepMedia ID Step MED027 , BadMedia , and MED039Commands Stepmedia specified in a single Media Query request are not A vsmedqry can query any media in the VolServ system. Therequired to be located in the same library vsmedclassqry CommandsParameters vsmedtype qryH hostname -P priority -R retries T timeout -V prognum ParametersParameter CommandsT timeout DescriptionStep StepStep vsmedtypeqry -aCommands vsmount Parameters CommandsA vsmount request is queued for later processing if Description ParametersParameter mediaid …Parameter CommandsT timeout DescriptionStep StepStep vsmount MED026 -dvsmount -c medclassmed -d 10 -n medclasssh1med medclasssh1medCommands vsmount MED022 -p drvpoolusr -x 4vsmount MED034 -d vsmount MED034 -p drvpoolmed -xMount of Media MED048 onto Drive 3 was successful Commandsvsmount -c medclassstgmed -p drvpoolmed -n medclassmed vsmount MED023 -dStep StepStep vsmount BadMedia -dCommands The vsmount request fails if no specified drive is onlineIf a list of media specified in a vsmount request contains media of more than one type, the request fails Commands vsmove Parameters CommandsH hostname -P priority -R retries T timeout -V prognum ParametersH hostname ParameterDescription P priorityvsmove MED016 MED023 MED044 MED048 -a MED023, MED044, and MED048 to libraryCommands stage1 -wvStep StepStep StepCommands MED004, MED013, MED028, MED033, andMEDxyz to the BadArchive library vsmove MED003 MED004 MED013 MED028 MED033 MED043 a shelf2Step Error VOL107 invalid target archiveMove of media was unsuccessful Commands vspingParameters vsping StepStep VolServ is availableto volume server CommandsError CMD022 could not send command StepParameters vspoolcfgH hostname -P priority -R retries -T timeout -V prognum ParametersDescription CommandsT timeout H hostnameParameters vspoolqryvspoolqry drivepool vspoolqry -a Ihv Description CommandsT timeout H hostnameStep Stepvspoolqry drvpoolsml Commands vspoolqry -aStep Stepvspoolqry NoPool Command Reference CommandsCommand Reference 601356 Rev AParameters vsqrymountvsqrymount mediaid Ih Description CommandsT timeout H hostnamevsqrymount MED024 StepStep Media MED024 can be mounted on the following drives 1Drive 14 2DriveStep Commandsvsqrymount MED003 vsmount Commands vsreclassifyParameters Description ParametersParameter mediaid …Parameter CommandsT timeout DescriptionStep StepStep StepStep CommandsError VOL024 Media MED013 Media MED017 Media MED020 Media MED032 Reclassify of 2 of 6 media into class medclasssh2sml was successful2-142 Command ReferenceCommand Reference 601356 Rev ACommands vsrequestqry ParametersParameter CommandsT timeout DescriptionStep 9314402136 or314402137 or StepCommands vsunlock ParametersDescription CommandsT timeout H hostnamevsunlock -v 4 8 12 -l StepStep vsunlock 4 8 -lvsunlock -v 40 41 42 43 -l Commandsvsunlock 40 41 42 43 -l vsunlock request Parameters vswinCommands StepThe display location of vswin must give xhost privileges to Command ReferenceCommand Reference the VolServ host machine for vswin to properly workCommand Reference CommandsCommand Reference 601356 Rev A2-156 Command ReferenceCommand Reference 601356 Rev A