ADIC 601355 Rev A User manual

API Guide

VolServ Version 5.0

September 2001

601355 Rev A

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

®

of this document may be reproduced, transmitted, transcribed, stored in a retrieval system,

or translated into any language or computer language in any form or by any means,

electronic, mechanical, magnetic, optical, chemical, manual, or otherwise, without the

express written permission of:

ADIC

10949 East Peakview Ave.

Englewood, CO 80111 USA

Phone: 303-792-9700

FAX: 303-792-2465

U.S. Government Rights Restricted

Use, duplication, or disclosure of either the software or documentation is subject to

restrictions set forth by the U.S. Government in FAR 52.227-19(c)(2) and subparagraph

(c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 52.227-

7013 and/or in similar or following clauses in the FAR, DoD, or NASA FAR Supplement.

Technical Assistance

ADIC Technical Assistance Center:

• In the USA and Canada, call 1-800-827-3822.

• Outside the USA and Canada, call 303-874-0188 or toll-free 00800-9999-3822.

• Send e-mail to: [email protected].

Documentation

Although the material contained herein has been carefully reviewed, ADIC does not

warrant it to be free of errors or omissions. We reserve the right to make corrections,

updates, revisions, or changes to the information contained herein.

• Send e-mail to: [email protected]

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

Is there anything you especially like or dislike about the organization, presentation,

or writing in this manual?_______________________________________________

___________________________________________________________________

Question Circle One

Information was complete. Agree Disagree

Information was easy to find. Agree Disagree

Information was easy to follow. Agree Disagree

Book Title Document Number

Customer Name Telephone

E-mail Address

Company Name

Address

City, State, Zip

READER COMMENT FORM

NOTES

601355 Rev A i

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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . P-5

Getting Started 1

API Directory Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-3

Application Program Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-5

Client Interface Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-7

Unsolicited Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-9

VolServ API Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-10

API Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-12

Naming Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-15

Dispatch Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-19

Global Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-20

API Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-22

Using the API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-24

Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-28

API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-30

API Guide

ii Contents 601355 Rev A

API Functions 2

VS_Archive_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-11

VS_Archive_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-15

VS_Archive_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-25

VS_ArchiveMediaClass_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-32

VS_ArchiveMediaClass_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-36

VS_ArchiveMediaClass_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-41

VS_ArchiveMediaClass_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-49

VS_Command_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-58

VS_Command_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-61

VS_Command_GetErrorFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-65

VS_Command_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-68

VS_Command_GetStatusFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-72

VS_Command_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-82

VS_Component_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-87

VS_Component_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-93

VS_Component_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-96

VS_Component_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-100

VS_Connect_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-107

VS_Connect_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-110

VS_Connect_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-114

VS_Connect_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-118

VS_Criteria_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-123

VS_Criteria_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-129

VS_Criteria_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-136

VS_Criteria_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-142

API Guide

601355 Rev A Contents iii

VS_CriteriaGroup_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-149

VS_CriteriaGroup_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-155

VS_CriteriaGroup_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-161

VS_CriteriaGroup_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-166

VS_Drive_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-173

VS_Drive_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-177

VS_Drive_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-181

VS_Drive_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-187

VS_DrivePool_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-193

VS_DrivePool_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-196

VS_DrivePool_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-199

VS_DrivePool_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-204

VS_Error_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-208

VS_Expression_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-212

VS_Expression_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-218

VS_Expression_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-225

VS_Expression_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-231

VS_Global_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-238

VS_Global_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-243

VS_Initialize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-249

VS_Media_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-253

VS_Media_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-257

VS_Media_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-261

VS_Media_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-267

VS_MediaClass_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-273

VS_MediaClass_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-278

VS_MediaClass_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-283

VS_MediaClass_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-291

API Guide

iv Contents 601355 Rev A

VS_MediaType_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-299

VS_MediaType_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-302

VS_MediaType_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-305

VS_MediaType_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-309

VS_Mount_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-313

VS_Mount_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-318

VS_MediaClass_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-322

VS_Mount_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-330

VS_Notify_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-338

VS_Notify_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-343

VS_Notify_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-348

VS_Notify_Listen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-356

VS_Notify_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-362

VS_Request_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-369

VS_Request_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-372

VS_Request_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-375

VS_Request_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-379

VS_Select . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-383

VS_Status_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-386

VS_Table_AddEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-400

VS_Table_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-407

VS_Table_CreateAdd-Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-414

VS_Table_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-418

VS_Table_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-422

VS_Table_RemoveEntry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-426

VS_Table_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-430

VS_Terminate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-435

VS_TypeCapacity_Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-437

API Guide

601355 Rev A Contents v

VS_TypeCapacity_Destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-441

VS_TypeCapacity_GetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-446

VS_TypeCapacity_SetFields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-453

VSCMD_ArchiveQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-460

VSCMD_ArchiveQuery_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-470

VSCMD_ArchiveVary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-476

VSCMD_ArchiveVary_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-484

VSCMD_Audit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-490

VSCMD_Audit_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-499

VSCMD_Cancel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-505

VSCMD_Cancel_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-514

VSCMD_Checkin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-520

VSCMD_Checkin_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-529

VSCMD_Checkout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-534

VSCMD_Checkout_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-543

VSCMD_ClearEject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-548

VSCMD_ClearEject_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-557

VSCMD_Connect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-563

VSCMD_Connect_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-575

VSCMD_Connect-Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-581

VSCMD_Connect-Query_Set-Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-590

VSCMD_CreateArchiveMediaClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-595

VSCMD_CreateArchiveMediaClass_SetDefaults . . . . . . . . . . . . . . . . . . . . . . .2-609

VSCMD_CreateMedia-Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-619

VSCMD_CreateMedia-Class_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-632

VSCMD_DriveVary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-641

VSCMD_DriveVary_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-652

VSCMD_Export . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-660

API Guide

vi Contents 601355 Rev A

VSCMD_Export_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-669

VSCMD_Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-674

VSCMD_Import_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-684

VSCMD_Intransit-Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-689

VSCMD_Intransit-Query_Set-Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-697

VSCMD_Lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-702

VSCMD_Lock_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-712

VSCMD_MediaClass-Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-717

VSCMD_MediaClass-Query_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-726

VSCMD_MediaQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-731

VSCMD_MediaQuery_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-739

VSCMD_MediaType-Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-744

VSCMD_MediaType-Query_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-753

VSCMD_ModifyMedia . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-759

VSCMD_ModifyMedia_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-769

VSCMD_CreatePool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-776

VSCMD_CreatePool_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-785

VSCMD_DeleteArchiveMediaClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-791

VSCMD_DeleteArchiveMediaClass_SetDefaults . . . . . . . . . . . . . . . . . . . . . . .2-800

VSCMD_DeleteMediaClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-806

VSCMD_DeleteMediaClass_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-814

VSCMD_DeletePool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-819

VSCMD_DeletePool_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-827

VSCMD_Disconnect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-832

VSCMD_Disconnect_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-842

VSCMD_Dismount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-848

VSCMD_Dismount_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-857

VSCMD_DrivePoolQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-863

API Guide

601355 Rev A Contents vii

VSCMD_DrivePoolQuery_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-872

VSCMD_DriveQuery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-878

VSCMD_DriveQuery_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-887

VSCMD_ModifyArchiveMediaClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-893

VSCMD_ModifyArchiveMediaClass_SetDefaults . . . . . . . . . . . . . . . . . . . . . .2-908

VSCMD_ModifyMediaClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-914

VSCMD_ModifyMediaClass_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-927

VSCMD_ModifyPool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-935

VSCMD_ModifyPool_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-945

VSCMD_Mount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-951

VSCMD_Mount_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-967

VSCMD_Move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-975

VSCMD_Move_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-986

VSCMD_MultiMount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-992

VSCMD_MultiMount_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-1003

VSCMD_Ping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-1009

VSCMD_QueryMount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-1013

VSCMD_QueryMount_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-1022

VSCMD_Reclassify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-1027

VSCMD_Reclassify_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-1039

VSCMD_Reprioritize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-1045

VSCMD_Reprioritize_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-1054

VSCMD_Request-Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-1060

VSCMD_RequestQuery_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-1068

VSCMD_Unlock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-1073

VSCMD_Unlock_SetDefaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2-1081

Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-3

Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-3

API Guide

viii Contents 601355 Rev A

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. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .P-5

Online Books . . . . . . . . . . . . . . . . . . . . . . . . . . .P-5

Related Publications . . . . . . . . . . . . . . . . . . . . .P-6

Contact Publications Department. . . . . . . . . .P-6

Secured Web Site. . . . . . . . . . . . . . . . . . . . . . . .P-6

API Guide

P-2 Preface 601355 Rev A

NOTES

API Guide

601355 Rev A Preface P-3

Preface

Purpose of

This Book

This book describes the VolServ application programming

interface (API). The API consists of functions, iterators,

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.

Who Should

Read This

Book

This book is written for programmers who are creating or

modifying an application that requires tight control over data in

the file system managed by VolServ

How This

Book is

Organized

This book contains the following chapters:

Chapter 1: Getting Started — Describes API types and

naming conventions, dispatch routines and global

parameters,.and error handling.

Chapter 2: Functions — Alphabetical list of API function

calls.

Appendix A: Valid Status Fields — A matrix shows which

status fields are valid for each command.

Appendix B: Error Codes.

Appendix C: Mount Example.

API Guide

P-4 Preface 601355 Rev A

Conventions

The conventions used throughout the VolServ technical books

are listed below:

Convention Example

Screen text, file names, program names, and

commands are in Courier font.

Request to add a new volume:

Volume group will be “20”

Volume position will be “A123”.

The root prompt is shown as a number

symbol.

# su root

What you should type in is shown in Courier

bold font.

vsarchiveqry

Site-specific variables are in a Times italics

font.

tar -xvf tapedevicename

A backward slash ( \ ) denotes the input is

continued onto the next line; the printed page

is just not wide enough to accommodate the

line.

#

remsh nodename -n dd if=/dev \

/tapedevicename/bs=20b | tar xvfb \

- 20

(You should type the entire command without

the backward slash.)

Pressing <Return> after each command is

assumed.

A menu name with an arrow refers to a

sequence of menus.

Config-->MediaType-->Redefine

API Guide

601355 Rev A Preface P-5

Preface

Books

The books described below are part of the technical

documentation set, and are shipped on CD along with the

VolServ software:

Online Books

The documentation CD contains VolServ book files and

Adobe

®

Acrobat

®

Reader. The Reader allows you to view and

navigate the online documentation files yet preserves the page

design and graphics from the printed books.

Administrative Tasks

Describes how to perform system

administrative tasks using VolServ

commands.

Command Reference

Contains a list of VolServ commands

Error Messages

Provides corrective action for system log

errors.

Quick Reference Card

Summarizes commands.

Overview

Provides an overview of VolServ. Contains a

glossary.

Installing VolServ

Describes server requirements, installation

instructions, troubleshooting procedures,

and configuration parameters.

Using the VolServ GUI

Describes how to perform system

administrative tasks using the graphical user

interface.

API Guide

Provides a list of API functions.

API Guide

P-6 Preface 601355 Rev A

The publications described in the table below are created and

distributed on an as-needed basis.

Contact

Publications

Department

To make corrections or to comment on VolServ publications,

please contact Software Technical Publications at our e-mail

address: [email protected].

Secured Web

Site

To receive access to the secured site on our home page contain-

ing technical product information (Release Notes, Product

Alerts, Product Bulletins, FAQs), visit http://partners.adic.com/

and follow the password request procedure. In return, ADIC

will send you instructions and a password.

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 Bulletins” Conveys technical information—not problems—to

customers.

Getting Started

1

Getting

Started

API Directory Structure . . . . . . . . . . . . . . . . . . . . . 1-3

Application Program Interface . . . . . . . . . . . . . . . 1-5

Extensible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

Consistent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

Portable. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

Flexible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

Client Interface Summary . . . . . . . . . . . . . . . . . . . 1-7

Unsolicited Communication . . . . . . . . . . . . . . . . . 1-9

VolServ API Integration. . . . . . . . . . . . . . . . . . . . 1-10

API Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12

Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12

Handles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12

Naming Conventions . . . . . . . . . . . . . . . . . . . . . . 1-15

Dispatch Routines . . . . . . . . . . . . . . . . . . . . . . . . . 1-19

Global Parameters. . . . . . . . . . . . . . . . . . . . . . . . . 1-20

Global Variables . . . . . . . . . . . . . . . . . . . . . . . 1-21

API Error Handling . . . . . . . . . . . . . . . . . . . . . . . 1-22

Using the API. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-24

Command Handle . . . . . . . . . . . . . . . . . . . . . 1-24

Command Calls. . . . . . . . . . . . . . . . . . . . . . . . 1-24

Command Defaults. . . . . . . . . . . . . . . . . . . . . 1-25

Command Status. . . . . . . . . . . . . . . . . . . . . . . 1-26

Processing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-28

Asynchronous . . . . . . . . . . . . . . . . . . . . . . . . . 1-28

Synchronous . . . . . . . . . . . . . . . . . . . . . . . . . . 1-29

API Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-30

API Guide

1-2 Getting Started 601355 Rev A

Roadmap

Topic

Refer To

Chapter

Naming conventions.

Global parameters.

Error handling.

1

API functions. 2

Valid staus fields. A

Error codes. B

Mount example. C

ADIC 601355 Rev A User manual

Related papers

Other documents