Summary of the content on the page No. 1
Command Reference
VolServ Version 5.0
September 2001
601356 Rev A
Summary of the content on the page No. 2
Trademark Notice AMASS, DataMgr, EMASS, FileServ, and VolServ are either trademarks or registered trademarks of ADIC, Advanced Digital Information Corporation. DAS is a trademark of Grau, an ADIC subsidiary. All other product names and identifications are trademarks or registered trademarks of their respective manufacturers. Copyright Notice ® © 1996-2001 ADIC . All rights reserved. This document is the property of ADIC. No part of this document may be reproduced, transmitted, transcribed, s
Summary of the content on the page No. 3
READER COMMENT FORM ADIC includes this Form in an effort to provide 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 Question Circle One Information was complete. Agree Disagree Information was easy to find. Agree Disagree Information was easy to follow. Agree Disagree Is there anything you especially like or dislike ab
Summary of the content on the page No. 4
NOTES
Summary of the content on the page No. 5
Contents 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 .
Summary of the content on the page No. 6
Command Reference vsconnectqry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-40 vsdismount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-44 vsdriveqry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-48 vsdrivevary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Summary of the content on the page No. 7
Preface Purpose of This Book . . . . . . . . . . . . . . . . . . . . . . .P-3 P Who Should Read This Book. . . . . . . . . . . . . . . . .P-3 How This Book is Organized . . . . . . . . . . . . . . . .P-3 Conventions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .P-4 Books. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .P-5 Preface Online Books . . . . . . . . . . . . . . . . . . . . . . . . . . .P-5 Related Publications . . . . . . . . . . . . . . . . . . . .
Summary of the content on the page No. 8
Command Reference NOTES P-2 Preface 601356 Rev A
Summary of the content on the page No. 9
Preface Command Reference This book alphabetically lists and describes the VolServ Purpose of commands. This Book This book is written for system administrators who uses the Who Should command line to operate VolServ. Read This It assumes the administrator has a strong familiarity with: Book UNIX operating systems. Applications running in their site environment. This book contains the following chapters: How This Book is Chapter 1: Introduction — Describes environment variables and t
Summary of the content on the page No. 10
Command Reference The conventions used throughout the VolServ technical books Conventions are listed below: Convention Example Screen text, file names, program names, and Request to add a new volume: commands are in Courier font. Volume group will be “20” Volume position will be “A123”. The root prompt is shown as a number # su root symbol. What you should type in is shown in Courier vsarchiveqry bold font. Site-specific variables are in a Times italics tar -xvf tapedevicename font. A backward
Summary of the content on the page No. 11
Preface Command Reference The books described below are part of the technical Books documentation set, and are shipped on CD along with the VolServ software: Overview Administrative Tasks Provides an overview of VolServ. Contains a Describes how to perform system glossary. administrative tasks using VolServ commands. Installing VolServ Describes server requirements, installation Command Reference instructions, troubleshooting procedures, Contains a list of VolServ commands and configuration
Summary of the content on the page No. 12
Command Reference The publications described in the table below are created and Related distributed on an as-needed basis. Publications Related Publications Description “Release Notes” For each version of VolServ, the “Release Notes” contain: Summary of enhancements. Describes: - Fixed problems. - Known problems. - Installation and configuration issues. Lists: - Operating system patches. - System requirements. “Product Alerts” Informs customers of technical problems and solutions. “Produc
Summary of the content on the page No. 13
Introduction Options Common to all Commands . . . . . . . . . . 1-3 Optional Parameters. . . . . . . . . . . . . . . . . . . . . 1-4 1 Default Values . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 Environment Variables . . . . . . . . . . . . . . . . . . . . . 1-7 Command-specific Options. . . . . . . . . . . . . . . . . . 1-9 Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16 CLI Directory Stru
Summary of the content on the page No. 14
Command Reference Roadmap Refer To Topic Chapter Introduction. 1 Alphabetical list of commands. 2 1-2 Introduction 601356 Rev A
Summary of the content on the page No. 15
Introduction Command Reference Seven options are available on every command that is supported Options from the command line. These parameters are: Common to all Commands Parameter Description -I Indicates command line options are to be read from stdin. The -I option provides the capability for the client to enter command options on the command line, in a text file, or a combination of both. When the -I option is specified, command options are first read from the command line. VolServ t
Summary of the content on the page No. 16
Command Reference Parameter Description -P priority The execution priority of the entered command. Assignable priority values are Default value is restricted to a range from 1 (highest) to 32 15. (lowest) inclusive. -R retries Number of retries the CLI software attempts if a time-out is returned by the API software. Default value is 3. -T timeout Amount of time (in seconds) the API software waits for status from VolServ before returning Default value is a time-out to the CLI software. T
Summary of the content on the page No. 17
Introduction Command Reference -T (timeout). -V (prognum). If the client does not specify one or more of these options on a command, VolServ uses the appropriate default values specified in the description of the previous options. A client can specify values that override the default values previously specified. To specify an override value, the client must set an environment variable for each common option that is to have an override default. The environment variables and their associate
Summary of the content on the page No. 18
Command Reference prompt VSCLI_HOST=eiffel prompt export VSCLI_HOST (bourne shell) When a client specifies one or more of the -H (hostname), the -P (priority), the -R (retries), the -T (timeout), and the -V (prognum) options on the command line, the values entered on the command line supercedes the VolServ default values and any user-specified default values for the appropriate options. 1-6 Introduction 601356 Rev A
Summary of the content on the page No. 19
Introduction Command Reference The following environment variables provide the capability for Environment the client to specify default values for common options: Variables VSCLI_HOST VSCLI_PRIORITY VSCLI_RETRIES VSCLI_TIMEOUT VSCLI_PROGNUM The environment variable belowcontrols the number of lines per page for report output: VSRPT_PAGE_LENGTH The default page length is 66 lines. If the default page length is not appropriate, a client can execute the appropriate environment varia
Summary of the content on the page No. 20
Command Reference Request Query Media Type Query Media Query 1-8 Introduction 601356 Rev A
