ADIC 601356 Bedienungsanleitung

Command Ref erence V olServ V er sion 5.0 September 2001 601356 Rev A[...]

Trademark Notice AMASS, DataMgr, EMASS, File Serv, and VolServ are either trademarks or registered trademarks of ADIC, Advanced Digital Info rmation Corporation. DAS is a trademark of Grau, an ADIC subsidiary. All other product na mes and identifications are trademarks or registered trademarks of their respective manufacturers. Copyright Notice © [...]

ADIC includes this Form in an effort to pr ovide the best possible documentation to our customers. Please take a few moments to mail or FAX your response to: ADIC Software Documentation 10949 East Peakview Ave. Englewood, CO 80111 FAX: 303-792-2465 E-mail: techdocs @adic.com Is there anything you especially like or dislike about the organization, p[...]

NOTES[...]

601356 Rev A i Contents Preface Purpose of This Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-3 Who Should Read This Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-3 How This Book is Organized . . . . . . . . . . . . . . . . . . . . . . . . . . . . . [...]

Command Reference ii Contents 601356 Rev A vsconnectqry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-40 vsdismount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-44 vsdriveqry . . . . . . . . . . . . . . . . . . . . [...]

Preface P Preface Purpose of This Book . . . . . . . . . . . . . . . . . . . . . . . P-3 Who Should Read This Book . . . . . . . . . . . . . . . . . P-3 How This Book is Organized . . . . . . . . . . . . . . . . P-3 Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-4 Books . . . . . . . . . . . . . . . . . . . . . . . . . [...]

Command Refer ence P-2 Preface 601356 Re v A NO TES[...]

Command Refer ence 601356 Rev A Preface P-3 Preface Purpose of This Book This book alphabetically lists and describes the V olServ commands. Who Should Read This Book This book is written for system administrators who uses the command line to operate V olServ . It assumes the administrator h as a strong familiarity with: • UNIX operating systems.[...]

Command Refer ence P-4 Preface 601356 Re v A Con ventions The con ventions used throughout the V olServ technical books are listed belo w: Con vention Example Screen te xt, file names , progr am names, and commands are in Cou rier f ont. Request to add a new volume: Volume group will be “20” Volume position will be “A123” . The root prompt [...]

Command Refer ence 601356 Rev A Preface P-5 Preface Books The books described belo w ar e part of the technical documentation set, and are shipped on CD along with the V olServ software: Online Books The documentation CD contains V olServ book files and Adobe ® Acrobat ® Reader . The Reader allows you to vie w and navig ate the online documentati[...]

Command Refer ence P-6 Preface 601356 Re v A Related Publications The publications described in th e table belo w are created and distributed on an as-needed basis. Contact Publications Depart ment T o make corrections or to comment on V olServ publications, please contact Software T echnical Publications at our e-mail address: techdocs@adic.com. S[...]

Introduction 1 Intr oduction Options Common to all Commands . . . . . . . . . . 1 -3 Optional Parameters . . . . . . . . . . . . . . . . . . . . . 1-4 Default Values . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 Environment Variables . . . . . . . . . . . . . . . . . . . [...]

Command Refer ence 1-2 Introdu ction 601356 Re v A Roadmap T opic Refer T o Chapter Introductio n. 1 Alphabetical list of commands. 2[...]

Command Refer ence 601356 Rev A Introduction 1-3 Introduction Options Common to all Commands Se ven options are av ailable on e v ery command that is supported from the command line. These parameters are: P arameter Description -I Indicate s command line options are to be read from stdin . The -I option pro vides the capability f or the cli ent to [...]

Command Refer ence 1-4 Introdu ction 601356 Re v A Optional Pa r a m e t e r s The following parameters are optional: • -I (read from stdin) . • -h (help). Both options needs to be specified only if the client is requesting the functionality provided b y the option. Default V alues The remaining parameters ha ve default v alues: •- H (hostnam[...]

Command Refer ence 601356 Rev A Introduction 1-5 Introduction •- T (timeout) . •- V (pr ognum) . If the client does not specify on e or more of these options on a command, V olServ uses the approp riate default v alues specified in the description of the pre vious options. A client can specify v alues that ov erride the default v alues pre viou[...]

Command Refer ence 1-6 Introdu ction 601356 Re v A When a client specif ies one or more of the -H (hostname) , the -P (priority) , the - R (r etries) , the - T (timeout) , and the -V (pr ognum) options on the command line, the values entered on the command line supercedes the V olServ default v alues and any user-specif ied default values for the a[...]

Command Refer ence 601356 Rev A Introduction 1-7 Introduction En vir onment Va r i a b l e s The following en vironment v ariab les prov ide the capability for the client to specify default v a lues for common options: • VSCLI_HOST • VSCLI_PRIORITY • VSCLI_RETRIES • VSCLI_TIMEOUT • VSCLI_PROGNU M The en vironment va riable belowc ontrols [...]

Command Refer ence 1-8 Introdu ction 601356 Re v A • Request Query • Media T ype Query •M e d i a Q u e r y[...]

Command Refer ence 601356 Rev A Introduction 1-9 Introduction Command- specific Options A matrix that sho ws which commands support which command-specif ic options is included in below A discussion of ho w each of these options direct or modify the processing of indi vidual commands is included with the command descriptions in this discussion. Comm[...]

Command Refer ence 1-10 Introdu ction 601356 Re v A -b Identifies the batc h assigne d to the medium/med ia being impor ted. vsimport … -b batch1 … Identifies batch1 as the batch assigned to the medium /m edia being impor ted. The batch assigned to a medium is maintained by the V olSer v system. -c Indicates that all MediaClass names associated[...]

Command Refer ence 601356 Rev A Introduction 1-11 Introduction driveID… Specifies a list of one or more drives from wh ich the drives to satisfy the command are to be selected. The number of drives that can be specified is restricted b y the CLI software. Currently , the maximum allo wed n umber is 64. vsunloc k 1 3 … Instructs V olServ to unlo[...]

Command Refer ence 1-12 Introdu ction 601356 Re v A -l lockID Specifie s the lock ID assigned to the drive spec ified in the command. vsdismount … -l 9 … Indicates that t he drive specified in the comm and is rese r ved f or e xclusive use an d ha s been assigned the loc k ID 9 . -m Indicates th at all media associated with the sp ecified archi[...]

Command Refer ence 601356 Rev A Introduction 1-13 Introduction mediatype … Specifies a list of one or more mediatypes to be pr ocessed by the command. V alid MediaT ype names can contain up to 16 alph anumeric characters, including space s. Leading and tra iling spaces are not per mitted. The numb er of media t ypes th at can be specified is rest[...]

Command Refer ence 1-14 Introdu ction 601356 Re v A requestID Specifies V olSer v- assigned ID of the request b eing queried. A v alid request ID must be specified in either the ydddnnnnn f ormat or the yy:ddd:nnnnn f ormat where y and yy represen t the last one/tw o di gits of the y ear , ddd represents the J ulian da y , and nnnnn is a one-up num[...]

Command Refer ence 601356 Rev A Introduction 1-15 Introduction -v Indicates that verbose output is requested. •I f -v option is spec ified on a command that spe cifies a list of items, status is retur n ed on e very item specified in the list, regardless of the success or f ailure of the command processing on ea ch item. •I f -v option is sp ec[...]

Command Refer ence 1-16 Introdu ction 601356 Re v A Ta b l e s The names of the commands, as entered from the command line, are listed alphabetically in the first column of the table. The command-specific options are listed alphabetically across the top of the table. • When a command does not support an option, the cell that represents the inters[...]

Command Refer ence 601356 Rev A Introduction 1-17 Introduction -a (all) -a ar chive name arch ivename -b batchID -c (MediaClass) -c current mediaclass vsamlconfig X vsarchiveqry X X X vsarchive vary X vsaudit X vscheckin X vscheckout vscleareject vsconnectqr y vsdismount vsdriveqr y X vs d r i veva r y vse xpor t vsimpor t X X vsintransitqry vslock[...]

Command Refer ence 1-18 Introdu ction 601356 Re v A -f manufact urer -i (mount, attended) -l lockID -m (mediaIDs) mediaclass vsamlconfig vsarchiveqry X vs a r c hi veva r y vsaudit vscheckin vscheck out vscleareject vsconnectqr y vsdismount X vsdriveqr y vs d r i veva r y vse xpor t vsimpor t X vsintransitqr y vslock vsmedcla ssqry X X vsmedqry vsm[...]

Command Refer ence 601356 Rev A Introduction 1-19 Introduction mediaID mediaID… mediatype -n new mediac lass -p drivepool -q quantity vsamlconf ig vsarchiv eqr y vsarchive var y vsaudit vscheckin X vscheck out X vscleareject X vsconnectqr y vsdismoun t X vsdriv eqry vsdrive vary X vse xport X vsimport X vsintr ansitqry vsloc k XX vsmedclassqr y v[...]

Command Refer ence 1-20 Introdu ction 601356 Re v A request ID -t (Media T ypes) -t comment -s compstate -u (mount, unattended) -u usage time vsamlconfig vsarchiveqry X vsarchive var y X vsaudit vscheckin vscheck out X vscleareject vsconnectqr y vsdismount X vsdriveqry vsdrive vary X vse xpor t X vsimpor t vsintransitqry vsmedclassqr y vslock vsmed[...]

Command Refer ence 601356 Rev A Introduction 1-21 Introduction -v (verbose) -w (wait) -x driveID… vsamlconfig vsarchiveqry vs a r c hi veva r y vsaudit vscheckin vscheck out vscleareject X vsconnectqry vsdismount vsdriveqry vsdrive var y X vse xpor t X vsimpor t X vsintransitqry X vsmedclassqr y vslock X X vsmedqry vsmedtypeqry vsmount X vsmov e [...]

Command Refer ence 1-22 Introdu ction 601356 Re v A CLI Directory Structure All fi les necessary for command li ne interface to V olServ are contained in the volserv/vscli directory b y default. Ho wev er , the installer may choos e a different directory during ex ecution of the installation script. The vscli subdirectory is alwa ys appended to the[...]

Command Refer ence 601356 Rev A Introduction 1-23 Introduction NO TES[...]

Command Refer ence 1-24 Introdu ction 601356 Re v A NO TES[...]

Commands 2 Command Ref erence volserv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 vsamlconfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6 vsarchiveqry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8 vsarchivevary . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14 vsaudit [...]

Command Refer ence 2-2 Command Reference 601356 Re v A vsunlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-148 vswin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-153 Roadmap T opic Refer T o Chapter Introductio n. 1 Alphabetical list of commands. 2[...]

Command Refer ence 601356 Rev A Command Reference 2-3 Commands v olser v Starts or ends V olServ and activ ates the system log display . Pa r a m e t e r s volserv -s volserv -t | -q volserv [-y] P arameters P arameters Description -s Star ts V olSer v in the single user mode. Only commands run with vswin are run. Client interf ace commands are ref[...]

Command Refer ence 2-4 Command Reference 601356 Re v A Retur n Codes • 0 - Command completed successfully - V olServ started or completed normally . • 1 - Command did not comple te successfully - V olServ did not start or complete as expected. Examples Step 1. Successful V olServ syst em start-up. Requests V olServ to start. Step 2. Output retu[...]

Command Refer ence 601356 Rev A Command Reference 2-5 Commands vsamlconfig Starts the ADIC-GRA U AML (A utomated Media Library) conf iguration script. The follo wing information needs to be known before running the command: • Archi ve name. • Attended Mode or Unattended Mode. • Console location. • AMU host name. • AMU port number . Pa r a[...]

Command Refer ence 2-6 Command Reference 601356 Re v A Step 10. Enter Mode: Ar chiveMode Step 11. Is Ar c hiveMode correct (Y/N [Y]): Step 12. Enter Console Location (termname:0): T erminal Step 13. Is T erminal correct (Y/N [Y]): Step 14. Enter Mode ([A]tte nded,[U]nattended: Ar chiveMode Step 15. Is Ar c hiveMode correct (Y/N [Y]): Step 16. Enter[...]

Command Refer ence 601356 Rev A Command Reference 2-7 Commands vsar chiveqry Queries for information about a specified library . Pa r a m e t e r s vsarchiveqry archivename vsarchiveqry -a [ -cdIhmtv ] [ -H hostname ] [ -P priority ] [ -R retries ] [ -T timeout ] [ -V prognum ] P arameters P arameters Description ar chivename Identifies t he librar[...]

Command Refer ence 2-8 Command Reference 601356 Re v A -v Indicates that all drives, all MediaClass groups , all media, a nd all media types associated with the specified libraries are to be reported. Specifying the -v option is equivalent to specifying the -d , the -c , the -m , and the -t options . - I Command option s are first read from the com[...]

Command Refer ence 601356 Rev A Command Reference 2-9 Commands Retur n Codes •0 - T h e vsarchiveqry command is successfully processed. • -1 - An error is detected by either th e CLI software or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples Ste[...]

Command Refer ence 2-10 Command Reference 60 1356 Rev A Step 1. Successful library query . Requests V olServ to return the dri ves, the media, the MediaClass groups, and the media types ass ociated with the stage1 library . Step 2. Output returned: Action: None MediaType: D2M Archive Capacity: 40 Current Fill Level: 2 Assigned Locations: 2 Auto Che[...]

Command Refer ence 601356 Rev A Command Reference 2-11 Commands Step 1. Unsuccessful library query . Requests V olServ to return the dri ve s associated with the BadArchiveName library . Step 2. Output returned: Notes The vsarchiveqry command does not trigger unsolicited status messages from V olServ . Drive ID(s): 12 Media ID(s): med001med002 med0[...]

Command Refer ence 2-12 Command Reference 60 1356 Rev A A pending or ex ecuting vsarchiveqry request is cancelled with the V olServ cancel command. The V olServ cancel command is run from the comm and line by sending a SIGQUIT signal (control-). The request is also aborted by sending the SIGINT signal (control-c). See Also •v s a r c h i v e v a[...]

Command Refer ence 601356 Rev A Command Reference 2-13 Commands vsar chive v ary V aries the state of a library . The name of the library and the tar get state (online, offline, or diagnostic) must be specified. The return code presented to the client indicates the success or failure of the command. Pa r a m e t e r s vsarchivevary -s state archive[...]

Command Refer ence 2-14 Command Reference 60 1356 Rev A -h Requests help f or the entered command. When the Help option is specified, no command line pr ocessing is perf ormed. An e xit code of 0 is returned to the client wh en the Help option is specified. -H hostname Host name of the V olServ ser ver . The def ault host name is t he host name of [...]

Command Refer ence 601356 Rev A Command Reference 2-15 Commands Retur n Codes •0 - T h e vsarchivevary command is successfully processed. • -1 - An error is detected by either th e CLI software or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples S[...]

Command Refer ence 2-16 Command Reference 60 1356 Rev A V olServ processes commands that interact strictly with the database (for example: Query Mount, Create Dri ve Pool, and Create Archi ve Media Class), re g ardless of the state of the associated archi ve. All components associated with an of flin e or diagnostic library , such as media, dri ves[...]

Command Refer ence 601356 Rev A Command Reference 2-17 Commands vsaudit Performs library in ventory verif ication. • If the specified library is robotically controlled, the robot scans each physical bin location and v erifies that the database is consistent with the actual loc ation of media. Any noted inconsistencies are returned to the client, [...]

Command Refer ence 2-18 Command Reference 60 1356 Rev A P arameters P arameters Description ar chivename Specifies the name o f the archiv e to audit. • V alid archive names ma y contain up to 16 alphanumer ic characte rs, including spaces. • Leading and trailing spaces are not per mitted. - I Command option s are first read from the command li[...]

Command Refer ence 601356 Rev A Command Reference 2-19 Commands Retur n Codes •0 - T h e vsaudit command is successfully processed. • -1 - An error is detected by either th e CLI software or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples Step 1.[...]

Command Refer ence 2-20 Command Reference 60 1356 Rev A Step 2. Output returned: Notes W ith the exceptions of the manual libraries, a pending or ex ecuting vsaudit request is cancelled with the V olServ cancel command. The V olServ can cel command is run from the command line by sending a SIGQ UIT signal (control-). The request also is aborted by[...]

Command Refer ence 601356 Rev A Command Reference 2-21 Commands The total length of time that V olServ waits fo r a command status, in synchronous mode, from V olServ is ( VSID_RETRY_LIMIT plus 1) multiplied by VSID_TIMEOUT_VALUE . Because of the time required for robotic audits, the timeout v alue or retries may need to be increased from the defau[...]

Command Refer ence 2-22 Command Reference 60 1356 Rev A vschec kin Logically checks media into the V olServ system that has been pre viously checked out of the V olServ system. Checkin is a logical operation. Af ter media is logically checked in to the V olServ system, the media is physically entered into a library before becoming a vaila ble for c[...]

Command Refer ence 601356 Rev A Command Reference 2-23 Commands -a ar chivename Specifie s the name of the destinat ion library f or the media to be entered into after they are chec ked in. • V alid librar y names ma y contain up to 16 alphanumer ic characte rs, including spaces. • Leading and trailing spaces are not per mitted. -v Indicates th[...]

Command Refer ence 2-24 Command Reference 60 1356 Rev A Retur n Codes •0 - T h e vscheckin command is successfully processed. • -1 - An error is detected by either the CLI softw are or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples Step 1. Succe[...]

Command Refer ence 601356 Rev A Command Reference 2-25 Commands Step 1. Successful Checkin request with verbose option not specif ied. Requests V olServ to check MED013 into the shelf2 library and to return status on media only if processing for that media failed. Step 2. Output returned: Step 1. Errors with verbose option specif ied. Requests V ol[...]

Command Refer ence 2-26 Command Reference 60 1356 Rev A Step 1. Errors with verbose optio n not specif ied. Requests V olServ to check MED001, MED002, and MED093 into the stage1 library and to return status on media only if processing for that media failed: Step 2. Output returned: Notes Media checked out of one library can be check ed in to anothe[...]

Command Refer ence 601356 Rev A Command Reference 2-27 Commands A pending or ex ecuting vscheckin request is cancelled with the V olServ cancel command. The V olServ cancel command is run from the command line by sending a SIGQ UIT signal (control-). The request also is aborted by sending the SIGINT signal (control-c). See Also • vscheckout[...]

Command Refer ence 2-28 Command Reference 60 1356 Rev A vschec kout Checks media out of the V olServ system. Media that has been checked out is still kno wn by V olServ, but is unav ailable for client allocation. Upon receipt of a vscheckout request, V olServ marks the specif ied media for checkout. If th e specified media is contained in libraries[...]

Command Refer ence 601356 Rev A Command Reference 2-29 Commands -t comment Provide a com ment to be associated with each chec ked-o ut media. This comment is provided on the Eject list (a GUI display) fr om the library console associated with the library containing th e media. -v Indicates that v erbose output is needed. Status is returned on ev er[...]

Command Refer ence 2-30 Command Reference 60 1356 Rev A Retur n Codes •0 - T h e vscheckout command is successfully processed. • -1 - An error is detected by either the CLI softw are or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples Step 1. Succ[...]

Command Refer ence 601356 Rev A Command Reference 2-31 Commands Step 1. Successful Checkout request with ve rbose option not specified. Requests V olServ to check MED003, MED004, MED005, MED006, MED007, and MED008 out of the V olServ system and to return status on media only if processing for that media failed. Step 2. Output returned: Step 1. Erro[...]

Command Refer ence 2-32 Command Reference 60 1356 Rev A Step 1. Errors with verbose optio n not specif ied. Requests V olServ to check MED010, MED011, MED012, and MEDa13 out of the V olServ system and to return status on media onl y if processing for that media failed: Step 2. Output returned: Notes Failure of the vsch eckout request for one or mor[...]

Command Refer ence 601356 Rev A Command Reference 2-33 Commands A pending or ex ecuting vscheckout request is cancelled with the V olServ cancel command. The V olServ cancel command is run from the command line by sending a SIGQ UIT signal (control-). The request is aborte d by sending the SIGINT signal (control-c). See Also • vscheckin, vsclear[...]

Command Refer ence 2-34 Command Reference 60 1356 Rev A vsc leareject Remov es the specified media fr om the library’ s Eject list. Ejects can be generated during processing of the V olServ vscheckout vsexport , vsmount , and vsmove commands. Ejects can also be generated during automigration. The Clear Eject comm and essentially undoes the comple[...]

Command Refer ence 601356 Rev A Command Reference 2-35 Commands P arameters P aramaeter Desc ription mediaid … Specifies the media (up t o 64 pieces) to remov e from the Eject list. • A va lid media identifier ma y contain up to 16 alphan umeric characters , including spaces. • Leading and trailing spaces are not per mitted. -v Indicates that[...]

Command Refer ence 2-36 Command Reference 60 1356 Rev A Retur n Codes •0 - T h e vscleareject command is successfully processed. • -1 - An error is detected by either the CLI softw are or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples Step 1. Su[...]

Command Refer ence 601356 Rev A Command Reference 2-37 Commands Step 1. Successful with verbose option not specifi ed. Requests V olServ to remov e MED016 , MED018 , MED020 , and MED021 from the Eject list and to return status on media onl y if processing for that media failed. Step 2. Output returned: Step 1. Errors with verbose option specif ied.[...]

Command Refer ence 2-38 Command Reference 60 1356 Rev A Step 1. Errors with verbose optio n not specif ied. Requests V olServ to remov e MED012 , MED013 , MED014, and MED051 from the Eject list and to return status on media only if processing for that media failed. Step 2. Output returned: Notes The vscleareject request fails for media if the media[...]

Command Refer ence 601356 Rev A Command Reference 2-39 Commands • vsexport, • vsmount, • vs m ove[...]

Command Refer ence 2-40 Command Reference 60 1356 Rev A vsconnectqry Queries for enterprise connection information. This command provides a list of all client inte rnet addresses that are currently associated with the gi v en enterprise identif ier . Pa r a m e t e r s vsconnectqry enterpriseid [ -Ih ] [ -H hostname ] [ -P priority ] [ -R retries ][...]

Command Refer ence 601356 Rev A Command Reference 2-41 Commands Retur n Codes •0 - T h e vsconnectqry command is successfully processed. • -1 - An error is detected by either th e CLI software or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples St[...]

Command Refer ence 2-42 Command Reference 60 1356 Rev A Step 2. Output returned: Step 1. Unsuccessful enterprise query . Requests V olServ to return a list of the client Internet addresses associated with ente rprise identif ier 13: Step 2. Output returned: Notes The vsconnectqry command is run from either: • Command line. • Or , GUI. ---------[...]

Command Refer ence 601356 Rev A Command Reference 2-43 Commands Ho we ver , only from the GUI can “que ry all” be specif ied to list all enterprises. From the command line, only one enterprise can be specif ied within a single command. This restriction pre vents an y single client from listing the clients of other en terprises being serviced by[...]

Command Refer ence 2-44 Command Reference 60 1356 Rev A vsdismount Dismounts media from a dri ve. • For automated libraries, V olServ checks to see that the media is ejected from the dri v e by the storage subsystem. If the media is not ejected from the dri ve, the vsdismount request fails and V olServ returns a failure status to the client. Ho w[...]

Command Refer ence 601356 Rev A Command Reference 2-45 Commands P arameters P arameter Description mediaid Identifies the me dia to be dismounted. A v alid media identifier may con tain up to 16 alphanumer ic characters, includin g spaces. Leading and trailing spac es are not permitted. -d driveid Identifies t he drive where th e med ia is mounted.[...]

Command Refer ence 2-46 Command Reference 60 1356 Rev A Retur n Codes •0 - T h e vsdismount command is successfully processed. • -1 - An error is detected by either the CLI softw are or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples Step 1. Succ[...]

Command Refer ence 601356 Rev A Command Reference 2-47 Commands Step 1. Unsuccessful dismount reque st. Requests V olServ to dismount MED016 from dri ve 13 . Step 2. Output returned: Step 1. Unsuccessful dismount reque st. Requests V olServ to dismount MED016 from dri ve 9. Step 2. Output returned: Notes The vsdismount command triggers unsolicited [...]

Command Refer ence 2-48 Command Reference 60 1356 Rev A vsdriveqry Queries for information on specified dri ves. Pa r a m e t e r s vsdriveqry driveid … vsdriveqry -a [ -Ih ] [ -H hostname ] [ -P priority ] [ -R retries ] [ -T timeout ] [ -V prognum ] P arameters P arameter Description driveid … Specify a list of one through 64 drives to be que[...]

Command Refer ence 601356 Rev A Command Reference 2-49 Commands Retur n Codes •0 - T h e vsdriveqry command is successfully processed. • -1 - An error is detected by either th e CLI software or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples Step[...]

Command Refer ence 2-50 Command Reference 60 1356 Rev A Step 2. Output returned: ----------------------------------------------- Drive Query Report Mar 10 11:00:32 19941 ----------------------------------------------- Drive ID: 1 ----------------------------------------------- Drive Type: Magnetic Associated Archive: stage1 Current State: Online As[...]

Command Refer ence 601356 Rev A Command Reference 2-51 Commands Step 1. Unsuccessful driv e query . Requests V olServ to return information on dri ve 35. (Dri ve 35 does not exist.) Step 2. Output returned: Notes The vsdriveqry command does not trigge r unsolicited status messages from V olServ . A pending vsdriveqry request is cancelle d with the [...]

Command Refer ence 2-52 Command Reference 60 1356 Rev A vsdrivev ar y Changes the state of a dri ve. A dri ve in the of fline, unav ai lable, or diagnostic state is excluded from V olServ’ s dr iv e selection algorithm. Pa r a m e t e r s vsdrivevary -s state vsdrivevary driv eid vsdrivevary -p drivepool [ -Ihv ] [ -H hostname ] [ -P priority ] [[...]

Command Refer ence 601356 Rev A Command Reference 2-53 Commands -s state Spec ifies the targ et state of the spec ified drives . V alid drive state s are • online (on) • offline (of) • diagnostic (d) -v Indicates that v erbose output is needed. Status is returned on ev er y media specified in the vscheckout command . NO TE : If -v is not spec[...]

Command Refer ence 2-54 Command Reference 60 1356 Rev A Retur n Codes •0 - T h e vsdrivevary command is successfully processed. • -1 - An error is detected by either the CLI softw are or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples Step 1. Suc[...]

Command Refer ence 601356 Rev A Command Reference 2-55 Commands Step 2. Output returned: Step 1. Successful driv e v ary with verbose option not specif ied. Requests V olServ to vary dri ve 2 to the diagnostic state and to return status on a dri ve only if processing for that dri ve fa iled. Step 2. Output returned: Step 1. Errors with verbose opti[...]

Command Refer ence 2-56 Command Reference 60 1356 Rev A Step 2. Output returned: Step 1. Errors with verbose optio n not specif ied. Requests V olServ to v ary dri v es 5, 15, 8, 18, and 11 to the off-line state and to return status on a dri ve only if processing for that dri ve failed. Step 2. Output returned: Step 1. Unsuccessful Dri ve V ary req[...]

Command Refer ence 601356 Rev A Command Reference 2-57 Commands Notes Mounted dri ves that ha ve thei r state changed remain in-use. V arying a dri ve has no impact on cl ient data tran sfer operations in progress and the client recei v es no automatic notif ication of a dri ve state change. Dri ves can be v aried, regardless of whether or not they[...]

Command Refer ence 2-58 Command Reference 60 1356 Rev A vsexport Marks media and related media information for remo val from the V olServ system. If the specif ied media is not ass ociated with a library , the media is logically remov ed from the V olServ system. Ho we ver , if the specif ied media is associated with a library , the media is placed[...]

Command Refer ence 601356 Rev A Command Reference 2-59 Commands P arameters P arameter Description mediaid … Specifies a list of one through 64 media to ex p o r t . • A va lid media identifier ma y contain up to 16 alphan umeric characters , including spaces. • Leading and trailing spaces are not per mitted. -t comment Provide a te xt messag[...]

Command Refer ence 2-60 Command Reference 60 1356 Rev A Retur n Codes •0 - T h e vsexport command is successfully processed. • -1 - An error is detected by either the CLI softw are or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . -P priority Def ault va[...]

Command Refer ence 601356 Rev A Command Reference 2-61 Commands Examples Step 1. Successful export request with v erbose and comment options specified. Re quests to V olServ to place media MED012, MED014, and MED016 on the Eject list with the comment, Media to be shipped off-site , and to return status on e very specif ied media. Step 2. Output ret[...]

Command Refer ence 2-62 Command Reference 60 1356 Rev A Requests to VolServ to place media MED007, MED014, MED021, MED028, MED053, and MED042 on the Eject list with the comment, Media to be shipped off-site , and to return status on every specified media. Step 2. Output returned: Step 1. Errors with verbose option not specif ied and comment option [...]

Command Refer ence 601356 Rev A Command Reference 2-63 Commands Step 2. Output returned: Notes The vsexport command cannot be cancelled. Media can be unmarked for e xport via the Clear Eject request or if the operator fails the eje ct. Media that is marked for ejection from the library system cannot be reallocate d to satisfy a clie nt request, exc[...]

Command Refer ence 2-64 Command Reference 60 1356 Rev A vsimpor t Logically adds media to the V olServ system. Upon receipt of a vsimport request, the specif ied media is added to the V olServ system. If a non-unique media identifier is specif ied, the import for that media fails. The vsimport is a logical operation. Me dia must be physically enter[...]

Command Refer ence 601356 Rev A Command Reference 2-65 Commands P arameters P arameter Description mediaid … Specifies a list of one through 64 media to impor t. • A va lid media identifier ma y contain up to 16 alphan umeric characters , including spaces. • Leading and trailing spaces are not per mitted. - a ar chivename Identifies the libra[...]

Command Refer ence 2-66 Command Reference 60 1356 Rev A -b batch Specifies the manufacturer’ s ba tch that contains th e media to be entered . •I f t h e -b (batch) optio n is specified, the -f (manuf acturer) option must also be specified. •I f t h e -b (batch) op tion is not specified, the -f (manuf acturer) option cannot be specified. -v I[...]

Command Refer ence 601356 Rev A Command Reference 2-67 Commands Retur n Codes •0 - T h e vsimport command is successfully processed. • -1 - An error is detected by either th e CLI software or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples Step 1[...]

Command Refer ence 2-68 Command Reference 60 1356 Rev A Step 2. Output returned: Step 1. Successful Import request with verbose option not specif ied Requests VolServ to import media MED003, MED018, MED021, MED030, and MED036 into the medclasssh1med MediaClass group in the shelf1 library and to return status on media only if processing for that med[...]

Command Refer ence 601356 Rev A Command Reference 2-69 Commands specified media. “MediaMaker ABC” is the manufacturer of these media and these media were part of batch “1001 . ” Step 2. Output returned: Step 1. Errors with verbose option not spe cified Requests VolServ to import media MED003, MED018, MED021, MED030, and MED036 into the medc[...]

Command Refer ence 2-70 Command Reference 60 1356 Rev A Step 2. Output returned: Step 1. Unsuccessful Import request. Requests VolServ to import media MED003, MED018, MED021, MED030, and MED036 into the medclassmed MediaClass group in the BadArchiveName library and to return status on media only if processing for that media failed. Step 2. Output r[...]

Command Refer ence 601356 Rev A Command Reference 2-71 Commands Media identifiers of media bein g imported into manual libraries may contain alphanumeric and special characters including spaces. Ho wev er , spaces cannot be used as leading or trailing characters. If media in a manual library can later be mov ed into an automated library , the media[...]

Command Refer ence 2-72 Command Reference 60 1356 Rev A vsintransitqry Queries for media that are in the intransit state. The query returns a list of media identif iers. Media is considered to be intransit under the follo wing conditions: • It is wa iting to be entered in to a library as a result of vsimport , vsmount , vsmove , vscheckout , or m[...]

Command Refer ence 601356 Rev A Command Reference 2-73 Commands Retur n Codes •0 - T h e vsintransitqry command is successfully processed. • -1 - An error is detected by either th e CLI software or the API software. -h Requests help f or the entered command. When the Help option is specified, no command line processing is perf or med. An e xit [...]

Command Refer ence 2-74 Command Reference 60 1356 Rev A • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples Step 1. Successful intransit query . Requests VolServ to return a list of all media in the intransit state. Step 2. Output returned: Step 1. Unsuccessful intransit [...]

Command Refer ence 601356 Rev A Command Reference 2-75 Commands A pending vsintransitqry request is cancelled with the V olServ cancel command. The V o lServ cancel command is run from the command line by sending a SIGQUIT signal (control-). The request also is aborted by sending the SIGINT signal (control-c). See Also • vsmedqry[...]

Command Refer ence 2-76 Command Reference 60 1356 Rev A vsloc k Obtains exclusi ve use of one or more driv es. The lock identifi er assigned to the locked dri ves is returned to the client. This lock identifier must be used b y clients on subsequent requests (such as vsmount ) for those dri ves. A request to lock a dri ve that is b usy (mounted or [...]

Command Refer ence 601356 Rev A Command Reference 2-77 Commands Pa r a m e t e r s vslock driveid … vslock -p drivepool [ -x driveid ] [-q quantity ] [ -Ih ] [ -H hostname ] [ -P priority ] [ -R retries ] [ -T timeout ] [ -V prognum ] P arameters P arameter Description driveid… Specifies a list of one thro ugh 64 candidate drives to reser ve (l[...]

Command Refer ence 2-78 Command Reference 60 1356 Rev A Retur n Codes •0 - T h e vslock command is successfully processed. • -1 - An error is detected by either the CLI softw are or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . -h Requests help f or the[...]

Command Refer ence 601356 Rev A Command Reference 2-79 Commands Examples Step 1. Successful Lock request that specifies a list of one or more dri ves ( vslock 4 8 12) Step 2. Requests V olServ to lock (r eserve for e xclusi v e use) one of the dri ves 4 , 8 , and 12 . Step 3. Output returned: Step 1. Successful Lock request that specifies a dri ve [...]

Command Refer ence 2-80 Command Reference 60 1356 Rev A Step 2. Output returned: Step 1. Unsuccessful Lock request. Requests VolServ to lock (r eserve for exclusive use) 1 drive from drive pool BadDrivePool. Step 2. Output returned: Notes If a mount request does not specif y a lock identif ier for a locked dri ve, whether the dri ve is a v ailable [...]

Command Refer ence 601356 Rev A Command Reference 2-81 Commands If a vsmount request specif ies a dri ve pool, b ut does not specify a lock identifier , only av ailable unlocked driv es in the specif ied dri ve pool are considered to satisfy th e mount request. If there are no a vailable unlock ed dri ves in the specif ied dri ve pool, the mount re[...]

Command Refer ence 2-82 Command Reference 60 1356 Rev A vsmedc lass qry Queries for the attributes of a specif ied MediaCl ass group or all MediaClass groups. Th e members of the MediaClass group and any additionally requested in formation on each media is returned to the client. Pa r a m e t e r s vsmedclassqry mediaclass vsmedclassqry -a [ -m | -[...]

Command Refer ence 601356 Rev A Command Reference 2-83 Commands Retur n Codes •0 - T h e vsmedclassqry command is successfully processed. -I Command option s are first read from the command line . V olSer v then reads any options cont ain ed in the stdin file. -h Requests help f or the entered command. When the Help option is specified, no comman[...]

Command Refer ence 2-84 Command Reference 60 1356 Rev A • -1 - An error is detected by either the CLI softw are or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples Step 1. Successful MediaClass Query with neither -m nor -v specif ied. Requests VolSe[...]

Command Refer ence 601356 Rev A Command Reference 2-85 Commands Step 1. Successful Media Class Query request with -m option specif ied. Requests VolServ to return detailed media information for every media in the medclasssh1usr MediaClass group. • ² Media Class: medclasssh2med ----------------------------------------------- Media Type: D2M Capac[...]

Command Refer ence 2-86 Command Reference 60 1356 Rev A Step 2. Output returned: Step 1. Successful Media Class Query request with -v option specif ied. Requests VolServ to return detailed media information for every media in the medclasssml MediaClass group. Step 2. Output returned: ----------------------------------------------- Media Class Query[...]

Command Refer ence 601356 Rev A Command Reference 2-87 Commands Media Class: medclasssml ----------------------------------------------- Media Type: D2S Capacity: 20 Current Fill Level: 8 High Mark %: 80% Mountable by Class: Yes Notify Comment: Media exceed high mark RPC Option: No Callback MediaID: MED005 Media Type: D2S Media Class: medclasssml A[...]

Command Refer ence 2-88 Command Reference 60 1356 Rev A MediaID: MED017 Media Type: D2S Media Class: medclasssml Assignment: Allocated Location State: Archive Current Archive: shelf2 Pending Archive: Action State: None Import Date: May 14 09:28:41 1993 Last Access: May 14 09:40:21 1993 Mount Count: 1 Move Count: 1 Manufacturer: Batch: ² ² MediaID[...]

Command Refer ence 601356 Rev A Command Reference 2-89 Commands Step 1. Unsuccessful Media Class Query . Requests VolServ to return information on the UnknownClass MediaClass group. Step 2. Output returned: Notes The vsmedclassqry command does not trigger unsolicited status messages from V olServ . MediaID: MED051 Media Type: D2S Media Class: medcl[...]

Command Refer ence 2-90 Command Reference 60 1356 Rev A A pending vsmedclassqry is cancelled with the V olServ cancel command. The V olServ can cel command is run from the command line by sending a SIGQ UIT signal (control-). The request also is aborted by sending the SIGINT signal (control-c). See Also • vsmedqry[...]

Command Refer ence 601356 Rev A Command Reference 2-91 Commands vsmedqry Queries for the attributes of one or more specif ied media. The v alues of the attributes of the me dia are returned to the client. Pa r a m e t e r s vsmedqry medi aid … vsmedqry -a [ -Ih ] [ -H hostname ] [ -P priority ] [ -R retries ] [ -T timeout ] [ -V prognum ] P arame[...]

Command Refer ence 2-92 Command Reference 60 1356 Rev A Retur n Codes •0 - T h e vsmedqry command is successfully processed. • -1 - An error is detected by either the CLI softw are or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples Step 1. Succes[...]

Command Refer ence 601356 Rev A Command Reference 2-93 Commands Step 2. Output returned: ----------------------------------------------- Media Query Report May 14 10:34:30 19931 ----------------------------------------------- Media ID: MED001 ----------------------------------------------- Media Type: USRTYPE Media Class: medclassstgusr Assignment:[...]

Command Refer ence 2-94 Command Reference 60 1356 Rev A Media ID: MED015 ----------------------------------------------- Media Type: D2M Media Class: medclassmed Assignment: Free Location State: Intransit Current Archive: Pending Archive: shelf1 Action State: Move Import Date: May 13 16:25:39 1993 Last Access: May 13 16:40:53 1993 Mount Count: 0 Mo[...]

Command Refer ence 601356 Rev A Command Reference 2-95 Commands Step 1. Media Query request with errors. Requests VolServ to return information on media MED027 , BadMedia , and MED039. Step 2. Output returned: Media ID: MED039 ----------------------------------------------- Media Type: D2M Media Class: medclassmed Assignment: Allocated Location Sta[...]

Command Refer ence 2-96 Command Reference 60 1356 Rev A Notes A vsmedqry can query an y media in the V olServ system. The media specified in a sing le Media Query request are not required to be located in the same library . Media ID: MED027 ----------------------------------------------- Media Type: D2M Media Class: medclassmed Assignment: Free Loc[...]

Command Refer ence 601356 Rev A Command Reference 2-97 Commands A pending vsmedqry is cancelled with the V olServ cancel command. The V olServ cancel command is run from the command line by sending a SIGQ UIT signal (control-). The request also is aborted by sending the SIGINT signal (control-c). The vsmedqry command does not trigger unsolicited s[...]

Command Refer ence 2-98 Command Reference 60 1356 Rev A vsmedtype qry Queries for the attributes of one or more media types. The v alues of the attributes of the media types are returned to the client. Pa r a m e t e r s vsmedtypeqry media type … vsmedtypeqry -a [ -Ih ] [ -H hostname ] [ -P priority ] [ -R retries ] [ -T timeout ] [ -V prognum ] [...]

Command Refer ence 601356 Rev A Command Reference 2-99 Commands Retur n Codes •0 - T h e vsmedtypeqry command is successfully processed. • -1 - An error is detected by either th e CLI software or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . -h Requests[...]

Command Refer ence 2-100 Command Reference 60 1356 Rev A Examples Step 1. Successful Media T ype Query request. Requests VolServ to return information on every media type known to the VolServ system. Step 2. Output returned: Step 1. Media T ype Query request with errors. vsmedtypeqry -a ----------------------------------------------- Media Type Que[...]

Command Refer ence 601356 Rev A Command Reference 2-101 Commands Notes The vsmedtypeqry command does not trigger unsolicited status messages from V olServ . A pending vsmedtypeqry is cancelled with the V olServ cancel command. The V olServ can cel command is run from the command line by sending a SIGQ UIT signal (control-). The request also is abo[...]

Command Refer ence 2-102 Command Reference 60 1356 Rev A vsmount Mounts media onto a dri ve. When issuing a Mount command, the client can specify one of the follo wing. • Single media. • List of media. • MediaClass group. • And: - Specific dri ve. - Driv e pool. - Driv e pool with the exclusion of dri ves. The vsmount command’ s lock iden[...]

Command Refer ence 601356 Rev A Command Reference 2-103 Commands For manua l libraries, a vsmount notice is sent to the operator console for action. The operator is then responsible for conf irmation to V olServ when th e mount is complete. V olServ returns a return code to the client after the operator action is complete. A vsmount request is queu[...]

Command Refer ence 2-104 Command Reference 60 1356 Rev A P arameters P arameter Description mediaid … Specifies a list of one through 64 media to be mounted. • A va lid media identifier ma y contain up to 16 alphan umeric characters , including spaces. • Leading and trailing spaces are not per mitted. -d driveid Specifies a d rive that can be[...]

Command Refer ence 601356 Rev A Command Reference 2-105 Commands -H hostnam e Host name of the V olSer v ser v er . The default host name is t he host name of the computer where the CLI command is run. -n newmediaclass Specifies t he destination MediaClass g roup f or the reclassification of the m edia selecte d to satisfy the M ount reques t. NO T[...]

Command Refer ence 2-106 Command Reference 60 1356 Rev A Retur n Codes •0 - T h e vsmount command is successfully processed. • -1 - An error is detected by either the CLI softw are or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples Step 1. Succes[...]

Command Refer ence 601356 Rev A Command Reference 2-107 Commands Requests VolServ to mount media from MediaClass medclassmed onto drive 10 and to reclassify the selected media to MediaClass group medclasssh1med. Step 2. Output returned: Step 1. Successful Mount request th at specif ies a specific media and a dri ve pool with an e xclusion driv e li[...]

Command Refer ence 2-108 Command Reference 60 1356 Rev A Step 2. Output returned: Step 1. Successful Mount request wh en all specif ied driv es are in use. Requests VolServ to mount media MED034 onto drive 12. ( MED022 is currently mounted on drive 12 .) Step 2. Output returned: Step 1. Successful Mount request when specified media is in use. Reque[...]

Command Refer ence 601356 Rev A Command Reference 2-109 Commands Step 1. Successful Mount request re classifying the selected media. Requests VolServ to mount any media from MediaClass group medclassstgmed onto any drive in drive pool drvpoolmed, and to change the MediaClass association of the selected media from medclassstgmed to medclassmed . Ste[...]

Command Refer ence 2-110 Command Reference 60 1356 Rev A Step 2. Output returned: Step 1. Unsuccessful Mount request with unkno wn media specif ied. Requests VolServ to mount media BadMedia onto drive 5 . Step 2. Output returned: Notes The time required to satisfy a specific mount request depends on the number of av ailable driv es and pending vsmo[...]

Command Refer ence 601356 Rev A Command Reference 2-111 Commands If a specif ied or selected driv e was pre viously locked and the vsmount request does not specify a lock identif ier , V olServ returns a message to the client that the selected dri ve is lock ed and V olServ is waiting fo r the dri ve to become unlock ed to continue ex ecution of th[...]

Command Refer ence 2-112 Command Reference 60 1356 Rev A If a list of media specified in a vsmount request contains media of more than one type, the request fails. When media or dri ve pairing requires the media be mo ved within a single library system (such as cross-aisle) the mount may take a while to complete . The -i and -u options do NO T appl[...]

Command Refer ence 601356 Rev A Command Reference 2-113 Commands The Mount command triggers unsol icited status messages from V olServ to the client software. Mount requests may requ ire inter- library media mov ement or a Mount request can be queued wa iting for an in-use media or dri ve. The client may want to increase the timeout v alue or the r[...]

Command Refer ence 2-114 Command Reference 60 1356 Rev A vsmo ve Mov es media from one library to another . A client uses the vsmove command to direct the mov ement of media from one library to another . Inter-library media mov ement requires operator inte rvention. The operator must eject the media from their curren t libraries and enter them into[...]

Command Refer ence 601356 Rev A Command Reference 2-115 Commands Pa r a m e t e r s vsmove medi aid vsmove -a archivename [-iIhwv] [ -H hostname ] [ -P priority ] [ -R retries ] [ -T timeout ] [ -V prognum ] P arameters P arameter Description mediaid … Specifies a list of one through 64 media to be mov ed. • A va lid media identifier ma y conta[...]

Command Refer ence 2-116 Command Reference 60 1356 Rev A -w Indicates V olServ waits until the command processing completes be fore returning status to the client. If the mov e requires an inte r- librar y move , V olSer v waits until the mov e completes, whether the source and destin ation libraries are attended or unattended. When the •I f -w o[...]

Command Refer ence 601356 Rev A Command Reference 2-117 Commands Retur n Codes •0 - T h e vsmove command is successfully processed. • -1 - An error is detected by either th e CLI software or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples Step 1.[...]

Command Refer ence 2-118 Command Reference 60 1356 Rev A Step 2. Output returned: Step 1. Successful Mov e request, verbose option not specif ied. Step 2. Requests V olServ to move media MED013, MED016, MED028, and MED028 to library shelf1. Since the -i option is NO T specified, the mov e is to complete whether the losing and gaining libraries are [...]

Command Refer ence 601356 Rev A Command Reference 2-119 Commands Step 3. Output returned: Step 1. Errors with verbose option not spe cified. Requests VolServ to move media MED003, MED004, MED013, MED028, MED033, and MED043 to the shelf2 library. Step 2. Output returned: Step 1. Unsuccessful Move request. Requests VolServ to move media MEDabc and ME[...]

Command Refer ence 2-120 Command Reference 60 1356 Rev A Step 2. Output returned: Notes Mov ement of media is between lib raries, not within libraries. Media that is allocated to a M ov e request is not av ailable for other allocation until the mo ve completes. • If the -w option is not specif ied, status from the Move request indicates only the [...]

Command Refer ence 601356 Rev A Command Reference 2-121 Commands vsping Pings the V olServ system. The vsping command allo ws a user to check the a v ailability of V olServ (in other words, a means for the client systems to “ping” the V olServ system.) If V olServ responds to the vsping , it is assumed by the client that the V olServ client int[...]

Command Refer ence 2-122 Command Reference 60 1356 Rev A Retur n Codes •0 - T h e vsping command is successfully processed. • -1 - An error is detected by either the CLI softw are or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples Step 1. Success[...]

Command Refer ence 601356 Rev A Command Reference 2-123 Commands Step 1. Successful request, V olServ is not av ailable. Requests VolServ to acknowledge receipt of the Ping request. Step 2. Output returned: Notes The client is not required to use vsping before issuing other commands. The vsping command is a relati vely f ast operation. No V olServ [...]

Command Refer ence 2-124 Command Reference 60 1356 Rev A vspoolcfg Configures a specif ied driv epool. Pa r a m e t e r s vspoolcfg -p drivepool vspoolcfg -c driv eid vspoolcfg -d driv eid vspoolcfg -i driv eid vspoolcfg -r driv eid [ -Ih ] [ -H hostname ] [ -P priority ] [ -R retries ] [ -T timeout ] [ -V prognum ] P arameters P arameter Descripti[...]

Command Refer ence 601356 Rev A Command Reference 2-125 Commands -I Command option s are first read from the command line . V olSer v then reads any options cont ain ed in the stdin file. -h Requests help f or the entered command. When the Help option is specified, no command line processing is perf or med. An e xit code of 0 is returned to the cli[...]

Command Refer ence 2-126 Command Reference 60 1356 Rev A vspoolqry Queries for information on a spec ified dri ve pool or on all dri ve pools kno wn to V olServ . The command returns the list of driv es contained in each dri ve pool. Detailed information on each indi vidual driv e is obtained by sp ecifying the -v (verbose) option. Pa r a m e t e r[...]

Command Refer ence 601356 Rev A Command Reference 2-127 Commands Retur n Codes •0 - T h e vspoolqry command is successfully processed. -a Specifies the -a option to request inf or mation on all drive pools kn own to the V olSer v system. -I Command option s are first read from the command line . V olSer v then reads any options cont ain ed in the[...]

Command Refer ence 2-128 Command Reference 60 1356 Rev A • -1 - An error is detected by either the CLI softw are or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples Step 1. Successful Dri ve Pool Quer y request with v erbose option specif ied. Reque[...]

Command Refer ence 601356 Rev A Command Reference 2-129 Commands Step 1. Successful Driv e Pool Quer y request with verbose option not specified. Requests the VolServ to return a list of Drive IDs for every drive pool known to the VolServ system. Step 2. Output returned: Drive ID: 7 Drive Type: Magnetic Associated Archive: tower1 Current State: Onl[...]

Command Refer ence 2-130 Command Reference 60 1356 Rev A Step 1. Unsuccessful Dri v e Pool Query . Requests the VolServ to return a list of drive identifiers for the NoPool drive pool. Step 2. Output returned: Notes The vspoolqry command does not trigge r unsolicited status messages from V olServ . Drive Pool: drvpoolsml ---------------------------[...]

Command Refer ence 601356 Rev A Command Reference 2-131 Commands A pending vspoolqry is cancelled with the V olServ cancel command. The V olServ cancel command is run from the command line by sending a SIGQ UIT signal (control-). The vspoolqry also is aborted by sending the SIGINT signal (control-c). See Also None[...]

Command Refer ence 2-132 Command Reference 60 1356 Rev A vsqrymount Queries for driv es that could be used in a subsequent mount of a specif ied media. The vsqrymount output lists the dri v es in the order of preference, based (in order of relati ve importance) upon their av ailability , proximity to the media, and usage time. Upon receipt of the v[...]

Command Refer ence 601356 Rev A Command Reference 2-133 Commands Retur n Codes •0 - T h e vsqrymount command is successfully processed. • -1 - An error is detected by either th e CLI software or the API software. -I Command option s are first read from the command line . V olSer v then reads any options cont ain ed in the stdin file. -h Request[...]

Command Refer ence 2-134 Command Reference 60 1356 Rev A • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples Step 1. Successful Query Mount request. Requests VolServ to return a list of drives that are candidates to be mounted with MED024 . Step 2. Output returned: Step 1[...]

Command Refer ence 601356 Rev A Command Reference 2-135 Commands Requests VolServ to return a list of drives that are candidates to be mounted with MED003. Step 2. Output returned: Notes The returned list of dri ves are kno wn to be suitable for mounting the specif ied media, b ut those dri v es are not a v ailable if they are currently in use. Dri[...]

Command Refer ence 2-136 Command Reference 60 1356 Rev A The vsqrymount command does not trigger unsolicited status messages from V olServ . A pending vsqrymount request is cancelle d with the V olServ cancel command. The V olServ can cel command is run from the command line by sending a SIGQ UIT signal (control-). The request also is aborted by s[...]

Command Refer ence 601356 Rev A Command Reference 2-137 Commands vsrec lassify Changes the MediaClass name of one or more media. Upon receipt of this request, V olSer v verif i es that each specified media identifier references a me dia of the type supported b y the target MediaClass group. • If all media are of the appropriate media type, V olSe[...]

Command Refer ence 2-138 Command Reference 60 1356 Rev A P arameters P arameter Description mediaid … Specifies a list of one through 64 media to be reclassified. -c curr entmediaclass Specifies the MediaClass group with which the specified media ar e currently associated. • V alid MediaClass names ma y contain up to 16 alphan umeric characters[...]

Command Refer ence 601356 Rev A Command Reference 2-139 Commands Retur n Codes •0 - T h e vsreclassify command is successfully processed. • -1 - An error is detected by either th e CLI software or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . -h Req ues[...]

Command Refer ence 2-140 Command Reference 60 1356 Rev A Examples Step 1. Successful Reclassify request with verbose option specif ied. Requests VolServ to reclassify media MED002, MED023, and MED044 from MediaClass group medclassstgsml to medclasssml and to return status on every specified media. Step 2. Output returned: Step 1. Successful Reclass[...]

Command Refer ence 601356 Rev A Command Reference 2-141 Commands Requests VolServ to reclassify media MED013, MED017, MED020, MED032, MED041, and BadMedia from MediaClass group medclasssml to medclasssh2sml and to return status on every specified media. Step 2. Output returned: Step 1. Errors with verbose option not spe cified. Requests VolServ to [...]

Command Refer ence 2-142 Command Reference 60 1356 Rev A Step 2. Output returned: Step 1. Unsuccessful Reclassify request. Requests VolServ to reclassify the media MED042 from MediaClass group medclassmed to BadClass and to return status on media only if processing on that media was unsuccessful. Step 2. Output returned: Notes The reclassify comman[...]

Command Refer ence 601356 Rev A Command Reference 2-143 Commands The capacity of a library media class is a soft limit. If the capacity of a library media class is exceeded, the entire vsreclassify request is processed unless the capacity of the associated MediaClass group is reached. When the capacity of the library media class is reached, applica[...]

Command Refer ence 2-144 Command Reference 60 1356 Rev A vsrequestqry Queries for information a bout a specified request. The client must specify V olSer v assigned request identif ier of the request being queried. Upon receipt of a vsrequestqry request, V olServ searches its request queue for the specif ied request identifier . If the specif ied r[...]

Command Refer ence 601356 Rev A Command Reference 2-145 Commands Retur n Codes •0 - T h e vsrequestqry command is successfully processed. • -1 - An error is detected by either th e CLI software or the API software. -h Requests help f or the entered command. When the Help option is specified, no command line processing is perf or med. An e xit c[...]

Command Refer ence 2-146 Command Reference 60 1356 Rev A • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples Step 1. Successful Request Query . Requests VolServ to return status on request 93:144:02136 (or 314402136 ) . Step 2. Output returned: Step 1. Unsuccessful Reques[...]

Command Refer ence 601356 Rev A Command Reference 2-147 Commands Notes The client must kno w the request identif ier to be queried. After ex ecution of a request comple tes, a relati v ely short period of time exists where the request sho ws a state of “ complete .” Afterwards, all kno wledge of th e request is removed from the V olServ system [...]

Command Refer ence 2-148 Command Reference 60 1356 Rev A vsunloc k Releases exclusi ve use of one or more dri ves. The list of dri ves to be unlocke d and the assigned lock iden tifie r for those dri ves must be spe cified. A client needing to release a sub set of locked dri ves, locked via a single lock command, can runmultiple unlock requests. Ea[...]

Command Refer ence 601356 Rev A Command Reference 2-149 Commands Retur n Codes •0 - T h e vsunlock command is successfully processed. -I Command option s are first read from the command line . V olSer v then reads any options cont ain ed in the stdin file. -h Requests help f or the entered command. When the Help option is specified, no command li[...]

Command Refer ence 2-150 Command Reference 60 1356 Rev A • -1 - An error is detected by either the CLI softw are or the API software. • >0 - An error is detected by V olServ . The returned exit code corresponds to the error code gi ven by V olServ . Examples Step 1. Successful Unlock request with verbose option specif ied. Requests VolServ t[...]

Command Refer ence 601356 Rev A Command Reference 2-151 Commands Step 1. Unsuccessful Unlock identifier with v erbose option. Requests VolServ to unlock drives 40, 41, 42, and 43 , three of which have an assigned lock identifier of 1719790788 , and to return status on every specified drive. Step 2. Output returned: Step 1. Unsuccessful Unlock ident[...]

Command Refer ence 2-152 Command Reference 60 1356 Rev A Notes The client can releas e a subset of dri ves lock ed by a single vsunlock request. V olServ fails a vsunlock for a dri ve if the lock identif ier specif ied in the unlock reque st does not match the lock identifi er assigned to the driv e. The vsunlock command does not trigge r unsolicit[...]

Command Refer ence 601356 Rev A Command Reference 2-153 Commands vs win Starts the V olServ system admini strator’ s console and brings up the system GUI display . Pa r a m e t e r s vswin -display host # P arameters Retur n Codes • 0 - T erminated normally . • 1 - Error occurred during initialization. Example Step 1. Initialize the V olServ [...]

Command Refer ence 2-154 Command Reference 60 1356 Rev A The display location of vswin must gi ve xhos t pri vileges to the V olServ host machine for vswin to properly work. See Also • volserv (l)[...]

Command Refer ence 601356 Rev A Command Reference 2-155 Commands NO TES[...]

Command Refer ence 2-156 Command Reference 60 1356 Rev A NO TES[...]