Sun Data Collector 

DESCRIPTION
  What is explorer?
     Explorer is a support tool used to  collect  pertinent  data
     from a system running Solaris.

  Why use explorer?
     Sun engineers use explorer to describe a system's configura-
     tion or to troubleshoot a problem.

  How does explorer collect the data?
     Explorer is simply a shell script which calls  a  collection
     of  tools  to  get the data.  If selected, explorer will tar
     and compress the data and email it to Sun or to a designated
     recipient.

  What does explorer collect?
     The  explorer  script   calls   scripts   located   in   the
     /opt/SUNWexplo/tools  directory.   Below is a short descrip-
     tion of what each tool does.

          cluster
               This script collects information on Sun Cluster.

          cmdline
               This scripts processes additional output  selected
               on the command line with -f and -c.

          cst
               This scripts  Configuration  and  Service  Tracker
               information.

          disks
               This script collects disk information.

          emc
               This script collects EMC Powerpath information.

          etc
               This script collects configuration files in /etc.

          fcal
               This script collect disk information for  internal
               FCAL drives.

          firelink
               This scripts collects  Sun  Firelink  Interconnect
               information.

          fru
               This script  collects  FRU  information.   Because
               this  script  can run for an extended time on cer-
               tain platforms (like the E15k), this modules  does
               not run by default and must be enabled with the -w
               switch.  For example, explorer -w fru,default

          init
               This script collects init scripts in /etc/rc?.d.

          iplanet
               This script collects configuration information on
               the Sun-ONE iPlanet product line. The iplanet data
               gathering cannot be accomplished without the config
               file present. See the README.iplanet file for more
               information.

          lic
               This script collects license information.

          lp
               This script collects printer information.

          messages
               This script collects messages files in /var/adm.

          nbu
               This script collects NetBackup configuration information.

          nbu_extended
               This script collects extended NetBackup information.

          ndd
               This script collects network information  on  net-
               work device drivers.

          netinfo
               This script collects network information.

          patch
               This script collects patch information.

          photon
               This script collects information for Sun  StorEdge
               A5X00.

          pkg
               This script collects package information.

          sanextended
               This script collects extended SAN switch  informa-
               tion.   If explorer is called with -w interactive,
               this script will loop prompting the user  for  the
               names  and  types for each SAN switch.  Otherwise,
               the script looks for a list  of  switches  in  the
               etc/saninput.txt  file in EXP_HOME.  The format of
               the file is the name of the switch followed by the
               switch  type  (ancor  or brocade) and optionally a
               password and login (brocade switches) on a  single
               line (SWITCH SWITCH-TYPE PASSWORD LOGIN).

          sbu
               This script collects Solstice Backup information.

          scextended
               This script  collects  extended  Serengeti  System
               Controller  information.   If  explorer  is called
               with -w interactive, this script will loop prompt-
               ing  the user for the names and root passwords for
               each SC.  Otherwise, the script looks for  a  list
               of  SCs  in  the etc/scinput.txt file in EXP_HOME.
               The format of the file is the  name  of  the  host
               followed  by  the  root  password on a single line
               (HOST PASSWORD).

          sds
               This script collects Solstice  DiskSuite  informa-
               tion.

          secure
               This script collects data of a secure nature.   It
               does  not  run by default and must be enabled with
               the Customer's approval with -w secure,default

          sf15k-ndd
               This script collects network device driver  infor-
               mation for E15000.

          sf15k-sc
               This script collects System Controller information
               for E15000.

          sonoma
               This script collects information for Sun  StorEdge
               A3X00.

          ssa
               This script collects information for  SPARCstorage
               Arrays.

          ssp
               This script script collects SSP information.

          storedge
               This script collects StorEdge Data Services infor-
               mation.

          stortools
               This script collects STORtools 3.x information.

          sunray
               This scripts collect SunRay server information.

          sysconfig
               This script collects system configuration informa-
               tion.

          t3
               This script collects basic Sun StorEdge T3  infor-
               mation.

          t3extended
               This script  collects  extended  Sun  StorEdge  T3
               information.    If  explorer  is  called  with  -w
               interactive, this script will loop  prompting  the
               user for the names and root passwords for each T3.
               Otherwise, the script looks for a list of  T3s  in
               the  etc/t3input.txt file in EXP_HOME.  The format
               of the file is the name of the  host  followed  by
               the  root  password  on  a single line (HOST PASS-
               WORD).

          u4ft
               This script collects information for Netra FT1800.

          var
               This script collects log and  configuration  files
               in /var.

          vtsst
               This script collects SUNWvtsst log and  configura-
               tion files.

          vxfs
               This script collects Veritas information for VxFS.

          vxvm
               This script collects Veritas information for VxVM.

OUTPUT
  What does the output of explorer look like?
     By default explorer writes output  to  /opt/SUNWexplo/output
     with the following format:

     explorer.<hostid>.<hostname>-<date>

     The following files and directories may be seen:


            cluster/ Cluster data
                cst/ CST data
              disks/ Disk data
                emc/ EMC Powerpath data
                etc/ Files from /etc
              extra/ Files and commands specified on the command line
           firelink/ Sun Firelink Interconnect data
                fru/ FRUid data
               init/ Init scripts
            iplanet/ Sun-ONE iPlanet data
            license/ License data
                 lp/ Printer data
           messages/ Messages from /var/adm
                nbu/ NetBackup data
            netinfo/ Network data
          patch+pkg/ Patch and package data
                sbu/ Solstice Backup data
                 sc/ Serengeti System controller data
          sf15k-ndd/ E15000 network data
           sf15k-sc/ E15000 system controller information
                ssp/ SSP data
             sunray/ Sunray data
          sysconfig/ System configuration data
               u4ft/ FT1800 data
                var/ Log data from /var
              vtsst/ Log data from SUNWvtsst

EXECUTION
  How to run explorer manually.
     By default explorer will collect data  displaying  key  mes-
     sages  with  the output going to /opt/SUNWexplo/output.  See
     explorer(1M) for more information on the  complete  list  of
     options.

     Examples

     Display more messages and change where output goes
          explorer -verbose -target /var/tmp

     Run explorer, emailing output to a Sun engineer
          explorer -myemail eng@Sun.COM

     Log all commands and files collected
          explorer -l /var/tmp/log

  How to run explorer automatically.
     At installation, the option to run explorer weekly is given.
     If  yes was selected, explorer puts an entry in root's cron-
     tab.  This can be changed with the crontab command.

     Example crontab entries

     Monthly at midnight on the first day of the month.
          0 0 1 * * /opt/SUNWexplo/bin/explorer -e -q

     Weekly at midnight on Sunday.
          0 0 * * 0 /opt/SUNWexplo/bin/explorer -e -q

  Collecting extended data
     Explorer will collect extended data for hosts listed in  the
     input  files  etc/scinput.txt  and  etc/t3input.txt.   These
     files have the same format HOSTNAME PASSWORD for  each  host
     to  collect  extended  data  on  a  single line.  SAN switch
     information uses  the  etc/saninput.txt  file  has  has  the
     format  SWITCH  SWITCH-TYPE  PASSWORD  LOGIN.   The LOGIN is
     required  for  Brocade  switches.   The  default  is  admin.
     Alternately,  explorer can interactively prompt the user for
     switches, SCs or T3s  to  collect  extended  data.   In  the
     interactive mode (-w interactive), the extended modules will
     prompt the user for the hostname and root password.

     Example extended data collection (input files)

          Collect storage and extended T3 data
               /opt/SUNWexplo/bin/explorer -w storage

          Collect only Serengeti System Controller data
               /opt/SUNWexplo/bin/explorer -w scextended

          Collect all extended data
               /opt/SUNWexplo/bin/explorer -w extended

     Example extended data collection (no input files)

          Collect all extended data interactively
               /opt/SUNWexplo/bin/explorer -w interactive

     Example input file

          etc/saninput.txt
               # Input file for extended data collection
               # Format is SWITCH SWITCH-TYPE PASSWORD LOGIN
               san-sw1 ancor san-sw2 brocade $witch admin

          etc/scinput.txt
               # Input file for extended data collection
               # Format is HOST PASSWORD
               sunfire-sc0 mypassword
               # sunfire-sc1 has no password
               sunfire-sc1

          etc/t3input.txt
               # Input file for extended data collection
               # Format is HOST PASSWORD
               finance-t3 $money

  Collecting Sun-ONE iPlanet data
    Explorer will collect configuration data for the Sun-ONE
      iPlanet line of products only when explicitly told to.
      Currently, the iPlanet products that explorer will collect
      data from are:

          Application Server 
          Directory Server
          Messaging Server
          Portal Server
          Web Server

      In order to collect iPlanet data, explorer must be provided
    with an iplanet configuration file. This configuration file
      is created with the iplanet_config program. This program will
      walk the user through the creation of the iplanet.config file.
      It is assumed that the individual running the iplanet_config
      program has knowledge of where the iplanet products are installed.
    Once the iplanet.config file has been created, explorer can
      collect the iplanet data.
      Explorer will only collect the iPlanet data if the config file
      exists, and explorer has ben explicitly told to collect the
    data.
      
      Example iPlanet data collection

          /opt/SUNWexplo/bin/explorer -w iplanet
