home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / getcfgpk.zip / README.1ST < prev   
Text File  |  2000-01-06  |  7KB  |  166 lines
  1. ***************************************************************************
  2. (c) Copyright 1996 International Business Machines Corp.
  3.  
  4. README for GETCFG Data Collection Utility Version 1.5        11/06/97
  5. ***************************************************************************
  6.  
  7.   This readme file contains the latest information available for GETCFG.
  8.   The purpose of this utility is to collect information from a customer's
  9.   system as needed by an OS/2 Support Technician.
  10.  
  11.  
  12. TABLE OF CONTENTS
  13. ***************************************************************************
  14.   Installing GETCFG
  15.   Command-Line Parameters
  16.   CID Capability
  17.   Configurable Collection of Data
  18.   Compression Utility Used
  19.   Sending Files to IBM
  20.   Receiving Notification
  21.   Disclaimer
  22. ***************************************************************************
  23.  
  24.  
  25. INSTALLING GETCFG
  26.  
  27.   The package file GETCFGPK.EXE is a self-extracting executable.  Place
  28.   this file in a new directory (usually called \GETCFG) and type GETCFGPK.
  29.   Next, type INSTALL and follow the prompts to install Getcfg.  A folder
  30.   will be placed on your desktop after the install is completed.
  31.  
  32.  
  33. COMMAND-LINE PARAMETERS
  34.  
  35.   The Getcfg utility can be started one of two ways, manually or by CID.
  36.   The following syntax table shows the parameters that can be used for
  37.   each invocation.
  38.  
  39.                        Manual Program Invocation
  40.  
  41.   Parameter      Options      Meaning                    Example
  42.   ---------      -------      -------                    -------
  43.   /P:            M or S       multi or single processed  GETCFG /P:M
  44.  
  45.   Manually starting GETCFG results in a series of questions that the user
  46.   should answer as accurately as possible. These questions are:
  47.  
  48.       What is your first name?
  49.       What is your last name?
  50.       What is your company name?
  51.       What is your telephone number?
  52.       What is your customer number?
  53.       What is your PMR number?
  54.       What is your machine type?
  55.       How much memory is in machine?
  56.  
  57.   Prior to this, Getcfg obtains the machine name and domain name from the
  58.   customer's IBMLAN.INI file. The customer is able to change it if preferred.
  59.   Once this information is gathered the Getcfg program determines the local
  60.   drive with the most free space. This is where it plans to copy the
  61.   collected files to and zip them up. However, the customer is given the
  62.   option to change the drive, if desired.
  63.  
  64.                        CID Program Invocation
  65.  
  66.   Parameter      Options      Meaning              Example
  67.   ---------      -------      -------              -------
  68.   /T:            path         Target file path     /T:d:\getcfg\1234567.RAM
  69.   /R:            path         Response file path   /R:d:\getcfg\getcfg.rsp
  70.   /L1:           path         Log file path        /L1:d:\1234567.log
  71.  
  72.   CID enablement is a very important features for large customers.  Multiple
  73.   machines across the network can be installed using response files which are
  74.   parsed by Getcfg and used as input that is required for Getcfg data to upload
  75.   correctly. The previous table identifies the parameters required to invoke
  76.   Getcfg.
  77.  
  78.   The target RAM file is specified by the /T: parameter.  All files will be
  79.   stored in this subdirectory.
  80.  
  81. CID CAPABILITY
  82.  
  83.   To use CID, a network administrator must create response-files that are
  84.   appropriate to the required environment.  In order to reduce the amount
  85.   of work involved in this, a sample response-file has been provided with
  86.   GETCFG; this can be used as a template for the info that is needed.
  87.  
  88.   Getcfg does some logging based on the /L1: parameter. Important events
  89.   are logged as well as error messages and return codes. There are special
  90.   return codes for the CID invocation. These return codes are as follows:
  91.  
  92.           Return Code             Meaning
  93.           -----------             -------
  94.           00 00                   Successful program termination
  95.           12 08                   Not enough disk space (for target)
  96.           16 00                   Incorrect Program Invocation
  97.           16 04                   Unexpected Condition
  98.  
  99.   The following table demonstrates how the tags should be assigned in the
  100.   response file and some examples. Getcfg will put this data into the file
  101.   CFG_1_0.DAT which will be used by the Upload Server to determine which
  102.   account to insert the data.
  103.  
  104.           Input Tag                   Meaning / Example
  105.           ---------                   -----------------
  106.           Process=                    Multi or Single Processed
  107.           CustomerNumber=             7 or 8 digit number
  108.           AutoMachineName=            =YES, Get from IBMLAN.INI
  109.           MachineName=                Name if AutoMachineName=NO
  110.           PMRNumber=                  3333x,333
  111.           ContactFirstName=           John
  112.           ContactLastName=            Doe
  113.           ContactPhoneNumber=         333-333-3333
  114.           CompanyName=                IBM
  115.  
  116.   The main response-file is GETCFG.RSP; please study this file.
  117.  
  118.  
  119. CONFIGURABLE COLLECTION OF DATA
  120.  
  121.   You can configure GETCFG to collect (or not to collect) any files
  122.   necessary.  It is recommended to gather all files listed in the default
  123.   GETCFG.LST file the first time you run GETCFG on your machine.  After
  124.   the initial file is stored in our database, only necessary files should
  125.   be subsequently gathered.
  126.  
  127.   Included with Getcfg is a Custom Packager making it easy to edit the
  128.   GETCFG.LST file and add or remove entries.  An icon will appear in
  129.   the Getcfg folder after installation called Getcfg Custom Packager.
  130.  
  131.  
  132. COMPRESSION UTILITY USED
  133.  
  134.   GETCFG compresses data using the SAVERAM2 utility.  The LOADRAM2 utility
  135.   is shipped with the package so customers can uncompress the file created
  136.   by GETCFG.
  137.  
  138.  
  139. SENDING FILES TO IBM
  140.  
  141.   Once the files are zipped they need to be sent to IBM.  They should be
  142.   sent to the FTP site TESTCASE.SOFTWARE.IBM.COM.  Change into the
  143.   ps/toibm/getcfg directory and put the zipped file there.
  144.  
  145.  
  146. RECEIVING NOTIFICATION
  147.  
  148.   Within two hours, you should receive notification that your files were
  149.   successfully uploaded into the Customer Configuration server or that they failed
  150.   to upload.  If it failed to upload, we should still have your RAM file and will
  151.   attempt to correct the problem.  If we do not have the file you sent in any longer
  152.   we will contact you.
  153.  
  154.  
  155. DISCLAIMER
  156.  
  157.   IBM DISCLAIMS ALL WARRANTIES, WHETHER EXPRESSED OR IMPLIED, INCLUDING
  158.   WITHOUT LIMITATION, WARRANTIES OF FITNESS AND MERCHANTABILITY WITH RESPECT
  159.   TO THE INFORMATION IN THIS DOCUMENT. BY FURNISHING THIS DOCUMENT, IBM
  160.   GRANTS NO LICENSES TO ANY RELATED PATENTS OR COPYRIGHTS.
  161.  
  162.   IBM and OS/2 are trademarks of the IBM Corporation.
  163.  
  164.  
  165.  
  166.