Summary of the content on the page No. 1
API Guide
VolServ Version 5.0
September 2001
601355 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
API Guide API Functions 2 VS_Archive_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-11 VS_Archive_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-15 VS_Archive_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-25 VS_ArchiveMediaClass_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-32 VS_Archi
Summary of the content on the page No. 7
API Guide VS_CriteriaGroup_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-149 VS_CriteriaGroup_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-155 VS_CriteriaGroup_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-161 VS_CriteriaGroup_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-166 VS_Drive_Create . . . . . . . . . .
Summary of the content on the page No. 8
API Guide VS_MediaType_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-299 VS_MediaType_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-302 VS_MediaType_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-305 VS_MediaType_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-309 VS_Mount_Create . . . . . . . .
Summary of the content on the page No. 9
API Guide VS_TypeCapacity_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-441 VS_TypeCapacity_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-446 VS_TypeCapacity_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-453 VSCMD_ArchiveQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-460 VSCMD_ArchiveQuery_SetDefaults . . . .
Summary of the content on the page No. 10
API Guide VSCMD_Export_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-669 VSCMD_Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-674 VSCMD_Import_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-684 VSCMD_Intransit-Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-689 VSCMD_Intransit-Query_Set-Defaults
Summary of the content on the page No. 11
API Guide VSCMD_DrivePoolQuery_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-872 VSCMD_DriveQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-878 VSCMD_DriveQuery_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-887 VSCMD_ModifyArchiveMediaClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-893 VSCMD_ModifyArchiveMediaClass_SetDefaults . . . . . . . . . . . .
Summary of the content on the page No. 12
API Guide viii Contents 601355 Rev A
Summary of the content on the page No. 13
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. 14
API Guide NOTES P-2 Preface 601355 Rev A
Summary of the content on the page No. 15
Preface API Guide This book describes the VolServ application programming Purpose of interface (API). The API consists of functions, iterators, This Book symbolic names, type definitions, and data structures. Using the API provides the programmer with the ability to directly manipulate VolServ file system metadata and media. This book is written for programmers who are creating or Who Should modifying an application that requires tight control over data in Read This the file system mana
Summary of the content on the page No. 16
API Guide 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 slash (
Summary of the content on the page No. 17
Preface API Guide 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 paramet
Summary of the content on the page No. 18
API Guide 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. “Product Bullet
Summary of the content on the page No. 19
Getting Started API Directory Structure . . . . . . . . . . . . . . . . . . . . . 1-3 Application Program Interface . . . . . . . . . . . . . . . 1-5 1 Extensible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 Consistent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 Portable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 Flexible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 Client Interface Summary . . . . . . . . . . .
Summary of the content on the page No. 20
API Guide Roadmap Refer To Topic Chapter Naming conventions. 1 Global parameters. Error handling. API functions. 2 Valid staus fields. A Error codes. B Mount example. C 1-2 Getting Started 601355 Rev A
