RCS-INFO @(#) $Id: README,v 1.20 1998/03/14 16:37:46 marilyn Exp $ ------------------------------------------------------------------------ R E A D M E Product Name: OCS - Operator Communications Software Product Versions: v3_1 Date (mm/dd/yyyy): 03/14/1998 ------------------------------------------------------------------------ ORIGIN ====== Authors Farms & Clustered Systems Group Fermi National Accelerator Laboratory - Mail Station 369 P.O Box 500 Batavia, IL 60510 Internet: ocs_support@fnal.gov Fermilab Standard Government Sponsorship Notice This work was performed at Fermi National Accelerator Laboratory, which is operated by Universities Research Association, Inc., under contract DE-AC02-76CHO3000 with the U.S. Department of Energy. Acknowledgements The authors wish to acknowledge the following people who have added much to this software either directly through development or indirectly through comments and suggestions: Matt Fausey (Fermilab) Dorota Genser (Fermilab) Stephan Lammel (Fermilab) Eric Wicklund (Fermilab) ------------------------------------------------------------------------ TERMS AND CONDITIONS ==================== This software has been made freely available with a request for collaborative input subject to standard Fermitools Terms and Conditions given in full below. ------------------------------------------------------------------------ PRODUCT DESCRIPTION =================== Operator Communications Software (OCS) is a package that performs and manages tape drive allocations, operator-assisted tape mounts and tape drive use statistics. Its logical-to-physical tape device name translation helps not only human communication, but hides many platform-specific idiosyncrasies from users. OCS is most beneficial in a networked environment that has many shared taped drives and an operations staff responsible for mounting the tapes. It has also been quite beneficial for users who share high-level software and need a common interface for tape devices. Currently, OCS supports EXABYTE and DLT tape drives. OCS has the following capabilities: - display the list of available tape drives - allocate a tape drive so no other user may access it - request the operations staff to mount a tape on a drive - verify that the tape was mounted correctly - set the tape drive characteristics appropriately (e.g. density) - request the appropriate device file for reading and/or writing the tape - collect device statistics from a tape drive - rewind and unload a tape - deallocate a tape drive so that someone else can use it - designate that a tape drive is broken - request that a cleaning tape be run through the tape drive - display the list of pending tape mount requests - display a history of mount request and tape drive use statistics Documentation ------------- The following documentation is packaged with each version: FILE FORMAT DESCRIPTION ================= ====== ========================= README ASCII General, Very Basic Overview doc/overview.ps Postscript Feature Overview doc/install.ps Postscript Installation/Administration Guide doc/reference.ps Postscript Reference Guide doc/release_notes ASCII Release Notes doc/xtape.ps Postscript Xtape Manual (Operator's Interface) doc/upgrade_notes ASCII How to upgrade to OCS v3_1 doc/viewgraphs.ps Postscript Viewgraphs In addition, please see the online information at: http://www-hppc.fnal.gov/ocs/ocspage.html Required Hardware and Software ------------------------------ OCS is written in C-language to run on UNIX operating systems and is currently supported on IRIX, AIX, SunOS (Solaris) and OSF1 platforms. The underlying architecture uses SUN RPC for TCP/IP and UDP communication. Version 3_0a requires the Fermi Tape Tools (FTT) product for physical device manipulation and statistics. FTT supports a wide number of tape devices across many operating systems making OCS generably more flexible. Product Installation -------------------- OCS, including source code, is packaged as follows: README - general, very basic overview MANIFEST - list of files Makefile - description file for make env.sh - Bourne shell script used in the Makefile to set appropriate environment for building executables env.csh - C-shell script to set appropriate environment for building executables. (Useful if you're not doing a top level make) version.csh - to create ocs_version function with OCS version and building information linked with libraries and executables (try "ident" or "what" on your executable and then search for OCSID to OCS verion number) doc - directory containing documentation ups - directory of scripts to setup the correct user environment src - directory containing source code lib - directory containing OCS libraries include - directory containing preprocessor include files bin - directory containing OCS executables examples - directory containing some example user programs templates - directory containing templates of scripts that should be customized for each OCS installation and installed on the local system. OCS requires three system daemons to be installed and tape drives added to the system. They are: database server - Manages transactions on a database that contains information on tape drives, hosts, mount requests, operator connections, mount history, tape drive statistics, etc. tape daemon - Coordinates user and operators requests such as mount requests, mount replies, queueing until a tape drive becomes available, etc. device daemon - Handles direct communication to a tape drive. The majority of the FTT dependencies are isolated inside this daemon. Complete installation documentation can be found in the OCS Installation/Administration Guide which is packaged with the OCS product. Running the Software -------------------- OCS functions are available via three separate interfaces: FORTRAN/C library of subroutines Command line tools X Motif tools The features available in each of these interfaces overlap to a great extent. However, since the different interfaces are by their nature geared towards different uses, the functionality is not 100% duplicated across them. The FORTRAN/C subroutines provide the most flexibility and functionality for users requiring multiple mount requests, the command line tools are generally used in shell scripts, and the X interfaces are very useful for monitoring tape drive statistics. Full user documentation can be found in the OCS Reference Guide that is packaged with the OCS product. ------------------------------------------------------------------------ SUPPORT ======= Help with the installation or use of OCS is available by sending mail to ocs_support@fnal.gov which is auto-forwarded to the group in charge of OCS support at Fermilab. This software is furnished by Fermilab on an "as is" basis as a service to the wider community with the goal of stimulating collaborative use and further development. Provision of the software implies no commitment of support by Fermilab. The Fermilab Computing Division is open to discussing other levels of support for use of the software with responsible and committed users and collaborators. Use of the software in experiments at Fermilab will be assured of a level of support as agreed to through the standard Memorandum Of Understanding process. Users may send mail to the mail address given above, with the expectation that it will be read and noted. ------------------------------------------------------------------------ TERMS AND CONDITIONS IN FULL ============================ ------------------------------------------------------------------------ Fermitools Software Legal Information - October 16, 1997 ------------------------------------------------------------------------ COPYRIGHT STATUS: Fermi National Accelerator Laboratory (FNAL) documents are sponsored by the U.S. Department of Energy under Contract No. DE-AC02-76CH03000. Therefore, the U.S. Government retains a non-exclusive, royalty-free license to publish or reproduce these documents or software for U.S. Government purposes. All documents and software available from this server are protected under the U.S. and Foreign Copyright Laws, and FNAL reserves all rights. Terms and Conditions -------------------- When a User distributes or otherwise obtains a software package included in the Fermilab Software Tools Program, the user agrees to abide by the Terms and Conditions of the Program below: o Any redistribution of the software shall be accompanied by this README file. o The User shall acknowledge the origin of the software as set forth below: "This work was performed at Fermi National Accelerator Laboratory, operated by Universities Research Association, Inc., under contract DE-AC02-76CH03000 with the U.S. Department of Energy." o The user is asked to feed back problems, benefits, and/or suggestions about the software to the Fermilab Software Providers and/or Fermitools management. o Any distribution of the software available from this server shall be at no charge except for nominal media and distribution costs. To obtain a license to commercialize any of the software programs available from this server, contact FNAL's Office of Research and Technology Applications, P.O. Box 500, MS-200, Batavia, IL 60510-0500. Indemnification by User of Third Party Claims and Disclaimer of Liability ----------------------------------------------------------------------- The User, his/her directors, officers, employees, and agents hereby release and waive all claims against Universities Research Association, Inc. (URA) operator of Fermi National Accelerator Laboratory, its trustees, overseers, directors, officers, employees, agents, subcontractors, successors and assigns, for any and all liability and damages arising from the reproduction, use or other disposition of the software. The User shall indemnify URA and the U.S. Government for all damages, costs or expenses, including attorney's fees, arising from the utilization of the software, including, but not limited to, the making, using, selling or exporting of products, processes or services derived from the Software. The User agrees to indemnify, hold harmless and defend URA, its trustees, overseers, directors, officers, employees, agents, subcontractors, successors and assigns, against any and all liability, damage, loss, cost, charge, claim, demand, fee or expense of every nature and kind which may at any time hereafter, be sustained by URA by reason of claims of third parties arising out of alleged acts or omissions of the User in the reproduction, use or other disposition of the Software. The User agrees that URA, its trustees, overseers, directors, officers, employees, agents, subcontractors, successors and assigns shall not be liable under any claim, charge, or demand, whether in contract, tort, criminal law, or otherwise, for any and all loss, cost, charge, claim, demand, fee, expense,or damage of every nature and kind arising out of, connected with, resulting from or sustained as a result of the use of the software programs available from this server. In no event shall URA be liable for special, direct, indirect or consequential damages, losses, costs, charges, claims, demands, fees or expenses of any nature or kind. Disclaimer of Warranties ------------------------ The software is provided on an "as is" basis only. URA makes no representations, express or implied. URA MAKES NO REPRESENTATIONS OR WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness of any information, apparatus, product or process disclosed, or represents that the Software will not infringe any privately held patent, copyright, or trademark. The entire risk as to the results and the performance of this software is assumed by the User. Disclaimer of Endorsement ------------------------- Reference herein to any specific commercial products, process, or service by tradename, trademark, manufacturer or otherwise, does not constitute or imply its endorsement, recommendation, or favoring by the United States Government, U.S. Department of Energy or URA. The views and opinions of individuals expressed herein do not necessarily state or reflect those of the United States Government, U.S. Department of Energy or URA and shall not be used for advertising or product endorsement purposes. Liabilities of the Government ----------------------------- This software is provided by URA, independent from its Prime Contract with the U.S. Department of Energy. URA is acting independently from the Government and in its own private capacity and is not acting on behalf of the U.S. Government, nor as its contractor nor its agent. Correspondingly, it is understood and agreed that the U.S. Government has no connection to this software and in no manner whatsoever shall be liable for nor assume any responsibility or obligation for any claim, cost, or damages arising out of or resulting from the use of the software available from this server.