User manual QUANTUM DAS 3.10E INTERFACING GUIDE FOR AML 2EJ

[. . . ] The ADIC Distributed AML Server DAS V3. 10E Interfacing Guide Copyright Notice © Copyright ADIC 2001 The information contained in this document is subject to change without notice. This document contains proprietary information which is protected by copyright. No part of this document may be photocopied, reproduced, or translated to another language without prior written consent of ADIC. ADIC shall not be liable for errors contained herein or for incidental or consequential damages (including lost profits) in connection with the furnishing, performance or use of this material whether based on warranty, contract, or other legal theory. [. . . ] For additional information, refer to aci_eject on page 4-39. struct aci_ei_info { char volser[ACI_VOLSER_LEN]; char media_type[ACI_DRIVE_LEN; int errcode } Figure 4-69 aci_ei_info Structure from aci. h See Table 4-29 for a description of the parameters for the aci_insert2 function call. Table 4-29 Parameters for the aci_insert2 Function Call Description defined the type of media for the insert operation -n -c normal (data cartridges) clean (cleaning cartridges) Parameter insertopt areaname cleanPoolname pnActualCount Logical insert range of the Insert/Eject unit of the AML in the AMS (e. g. I03) Name of the Cleanpool defined in AML (must be NULL, if insertopt= n) Number of inserted volsers and pointer to an array of structure 4-78 DAS ACI Functions 601626-B Table 4-29 Parameters for the aci_insert2 Function Call Description returned information on each volser ejected volser type errcodes volser of the ejected volume media type of the named volser Refer to Media Types on page 2-7 error code derrno Parameter aci_ei_info Return Values · · 0: The call was successful. The external variable d_errno is set to one of the following DAS error codes: · · · · · · · · · · · · · · · · · · · · · · · ERPC EINVALID ENOVOLUME EPROBVOL EAMU EAMUCOMM EROBOTCOMM EDASINT ENOAREA ENOAUTH ERETRYL ECANCELLED EDASINT ENOMATCH ECLEANING ETIMEOUT ESWITCHINPROG ENOPOOL EHICAPINUSE ECOORDINATE EBARCOODE EINVALIDDEV ENOROBOT 21 Dec 2001 aci_insert2 4-79 · · · · · · EDATABASE ENOTSUPPHCMD EAREAEMPTY ENOPOOL EBARCODE EAREAFULL See Figure 4-70 for an example of the aci_insert2 function. /* insert clean volume in the AML system*/ int res, i, pnActualCount; char *cleanPoolname = "CLP01"; char *areaname = "I02" struct aci_ei_info *pstEiInfo[ACI_EI_MAX_RANGE]; res = aci_insert2( "-c", areaname, cleanPoolname, &pnActualCount, pstEiInfo; if( rec ) { aci_perror( "Command failed: " ); } else { printf("Volume insert request successful\n" ); for (i = 0; i < ACI_EI_MAX_RANGE; i++) { if ( *ei_info[i]->volser == '\0' ) break; printf( "volser:%s media type:%s Error:%d\n", ei_info[i]->volser, ei_info[i]->media_type, ei_info[i]->errcode ); } } Figure 4-70 Example of the aci_insert2 Function 4-80 DAS ACI Functions 601626-B aci_inventory The aci_inventory function performs a physical inventory of the AML. See Figure 4-71. #include "aci. h" int aci_inventory( void ) Figure 4-71 aci_inventory Function Call This command instructs the robot to perform a physical inventory of the archive and to update the database. The inventory command is issued to the archive and the function will not wait for the completion of the inventory operation. The aci_list() function may be called to determine whether the inventory command is still active (result for a running inventory is PINV) Attention The inventory function is intended for testing and startup. An error function will be displayed in the AMU log during operation (and not returned to the calling process). The entire database will be overwritten with a symbolic volser "*Ixxxx" if the barcode reader malfunctions. For additional information, refer to aci_qvolsrange on page 4-98, and aci_view on page 4-123. Return Values · · 0: The call was successful. The external variable d_errno is set to one of the following DAS error codes: · · · · · · · · · · · EPC ENOVOLUME EPROBVOL EAMU EAMUCOMM EROBOTCOMM EDASINT ERETRYL EDASINT ETIMEOUT ESWITCHINPROG 21 Dec 2001 aci_inventory 4-81 · · · EHICAPINUSE ECOORDINATE EBARCODE See Figure 4-72 for an example of the aci_inventory function. /* Inventory the AML */ int rc = 0; rc = aci_inventory( ); if( rc ) { aci_perror( "Command failed:" ); } Figure 4-72 Example of the aci_inventory Function aci_killamu The aci_killamu function homes the robots and shuts down all programs running on the AMU PC (including OS/2). See Figure 4-73. #include "aci. h" int aci_killamu(void) Figure 4-73 aci_killamu Function Call The call of this function shuts down the complete AMU-PC. Wait 5 minutes before powering off. Attention Inform all administrators also using the AML system before starting the command. Wait at least 5 minutes following the positive acknowledgment before switching off the power supply to the machine. Switching off the power supply to the AMU PC too soon can lead to loss of data. 4-82 DAS ACI Functions 601626-B Return Values · · 0: The call was successful. The external variable d_errno is set to one of the following DAS error codes: · · · · · · · · ENOTAUTH ERPC EINVALID EDASINT ETIMEOUT EAMUCOMM EHICAPINUSE ESWITCHINPROG See Figure 4-74 for an example of the aci_killamu function. /* Shutdown of the AMU */ int rc = 0; rc = aci_killamu( ); if( rc ) { aci_perror( "Shutdown of AMU PC failed:" ); } Figure 4-74 Example of the aci_killamu Function 21 Dec 2001 aci_killamu 4-83 aci_list The aci_list function lists outstanding requests for a client. See Figure 4-75. #include "aci. h" int aci_list( char *clientname, struct aci_req_entry *request_list[ACI_MAX_REQ_ENTRIES]) Figure 4-75 aci_list Function Call List outstanding requests belonging to the client clientname. Return the requests in the request_list array of aci_req_entry request_list structures. The structure's request types are defined in the header file "aci_das. h". For additional information, refer to aci_cancel on page 4-7. struct aci_req_entry { u_long request_no; u_long individ_no; char clientname[ACI_NAME_LEN]; char req_type[ACI_REQTYPE_LEN + 1]; }; Figure 4-76 Example of the Returned Structure Refer to Table 4-30 for a description of the parameters for the aci_list function call. 4-84 DAS ACI Functions 601626-B Table 4-30 Parameters for the aci_list Function Call Description Name of the client that active request are reported to. Returned information about outstanding commands request_no individ_no clientname req_type DAS command sequence serial number reserved, not used name of the requesting client type of the outstanding command Refer to Table 4-31 Parameter clientnamet aci_req_entry See Table 4-31 for an explanation of the req_types. Table 4-31 req_types BACO EJCL INCL INVT KEEP MOUNT MOVE PINV PRGE SHUT Explanation of the Req_types Explanation switch barcode reading on or off (aci_barcode) eject of cleaning cartridges (aci_ejectclean) insert media from I/O unit with aci_insertgen insert media from I/O with aci_insert keep media from drive (aci_dismount) mount media to a drive (aci_mount) eject media to I/O unit (aci_eject, aci_eject_complete) Complete archive inventory and database update (aci_inventory) Delete a command from the command list (aci_cancel) Shutdown off the complete AMU (aci_killamu) 21 Dec 2001 aci_list 4-85 Return Values · · 0: The call was successful. The external variable d_errno is set to one of the following DAS error codes: · · · · · ERPC EINVALID EDASINT ETIMEOUT ESWITCHINPROG See Figure 4-77 for an example of the aci_list function. /* List outstanding client requests */ int rc, i; char *client = "SomeClient"; struct aci_req_entry *requests[ACI_MAX_REQ_ENTRIES]; if ( rc = aci_list( client, requests ) ) { aci_perror( "Command failed: " ); } else { printf ("List for client %s successful\n", client); for (i=0;(i<ACI_MAX_REQ_ENTRIES)&&(requests[i]>request_no!=0);i++) { printf("client = %s\n\trequest = %u\n\tindivid_no = %ld\n" "\ttype = %s\n", requests[i]->clientname, requests[i]->request_no, requests[i]->individ_no, requests[i]->req_type); } Figure 4-77 Example of the aci_list Function 4-86 DAS ACI Functions 601626-B aci_list2 The aci_list2 function lists executing requests for a client. See Figure 4-78. #include "aci. h" int aci_list2( char *clientname, struct aci_req_entry2 *req_status[]) Figure 4-78 aci_list2 Function Call List executing requests belonging to the client clientname. [. . . ] An array of rectangular bars and spaces in a predetermined pattern (e. g. , UPC symbol. ) A single medium storage location. A shell having two co-planar hubs, designed to hold magnetic recording tape. One or more physical volumes, bound in a transportable package with a human- readable external label. A human interface mechanism for controlling and monitoring system operation. [. . . ]