'\" t
.\" ident "$Id: //depot/dev/proactive/explorer3/man/man5/explorer.5#17 $"
.TH explorer 5 "09/27/2001" Explorer "Sun Data Collector"
.SH NAME
explorer \- gather system configuration information
.SH DESCRIPTION
.SS "What is explorer?"
.LP
Explorer is a support tool used to collect pertinent data from a
system running Solaris.
.SS "Why use explorer?"
.LP
Sun engineers use explorer to describe a system's configuration
or to troubleshoot a problem.
.SS "How does explorer collect the data?"
.LP
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.
.SS "What does explorer collect?"
.LP
The explorer script calls scripts located in the
\fB/opt/SUNWexplo/tools\fR directory.  Below is a short
description of what each tool does.
.RS
.IP "cluster"
This script collects information on Sun Cluster.
.IP "cmdline"
This scripts processes additional output selected on the command
line with -f and -c.
.IP "cst"
.br
This scripts Configuration and Service Tracker information.
.IP "disks"
This script collects disk information.
.IP "emc"
.br
This script collects EMC Powerpath information.
.IP "etc"
.br
This script collects configuration files in \fB/etc\fR.
.IP "fcal"
.br
This script collect disk information for internal FCAL drives.
.IP "firelink"
This scripts collects Sun Firelink Interconnect information.
.IP "fru"
.br
This script collects FRU information.  Because this script can run for
an extended time on certain 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
.IP "init"
.br
This script collects init scripts in \fB/etc/rc?.d\fR.
.IP "lic"
.br
This script collects license information.
.IP "lp"
.br
This script collects printer information.
.IP "messages"
This script collects messages files in \fB/var/adm\fR.
.IP "nbu"
.br
This script collects NetBackup information.
.IP "ndd"
.br
This script collects network information on network
device drivers.
.IP "netinfo"
This script collects network information.
.IP "patch"
This script collects patch information.
.IP "photon"
This script collects information for Sun StorEdge A5X00.
.IP "pkg"
.br
This script collects package information.
.IP "sanextended"
This script collects extended SAN switch information.
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).
.IP "sbu"
.br
This script collects Solstice Backup information.
.IP "scextended"
This script collects extended Serengeti System Controller information.
If explorer is called with -w interactive, this script will loop
prompting 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).
.IP "sds"
.br
This script collects Solstice DiskSuite information.
.IP "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
.IP "sf15000-ndd"
This script collects network device driver information for E15000.
.IP "sf15000-sc"
This script collects System Controller information for E15000.
.IP "sonoma"
This script collects information for Sun StorEdge A3X00.
.IP "ssa"
.br
This script collects information for SPARCstorage Arrays.
.IP "ssp"
.br
This script script collects SSP information.
.IP "storedge"
This script collects StorEdge Data Services information.
.IP "stortools"
This script collects STORtools 3.x information.
.IP "sunray"
This scripts collect SunRay server information.
.IP "sysconfig"
This script collects system configuration information.
.IP "t3"
.br
This script collects basic Sun StorEdge T3 information.
.IP "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 PASSWORD).
.IP "u4ft"
.br
This script collects information for Netra FT1800.
.IP "var"
.br
This script collects log and configuration files in \fB/var\fR.
.IP "vtsst"
.br
This script collects SUNWvtsst log and configuration files.
.IP "vxfs"
.br
This script collects Veritas information for VxFS.
.IP "vxvm"
.br
This script collects Veritas information for VxVM.
.RE
.SH OUTPUT
.SS "What does the output of explorer look like?"
.LP
By default explorer writes output to \fB/opt/SUNWexplo/output\fR
with the following format:
.LP
explorer.\fI<hostid>\fR.\fI<hostname>\fR-\fI<date>\fR
.LP
The following files and directories may be seen:
.IP
.TS
tab(^);
r1 l.
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
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
sf15000/^E15000 data
ssp/^SSP data
sunray/^Sunray data
sysconfig/^System configuration data
u4ft/^FT1800 data
var/^Log data from /var
vtsst/^Log data from SUNWvtsst
.TE
.SH EXECUTION
.SS "How to run explorer manually."
.LP
By default explorer will collect data displaying key messages with
the output going to \fB/opt/SUNWexplo/output\fR.  See explorer(1M)
for more information on the complete list of options.
.br
.IP "Examples"
.IP "Display more messages and change where output goes"
explorer -verbose -target /var/tmp
.IP "Run explorer, emailing output to a Sun engineer"
explorer -myemail eng@Sun.COM
.IP "Log all commands and files collected"
explorer -l /var/tmp/log
.SS "How to run explorer automatically."
.LP
At installation, the option to run explorer weekly is given.  If yes was selected,
explorer puts an entry in root's crontab.  This can be changed with the \fBcrontab\fR
command.
.IP "Example crontab entries"
.IP "Monthly at midnight on the first day of the month."
0 0 1 * * /opt/SUNWexplo/bin/explorer -e -q
.IP "Weekly at midnight on Sunday."
0 0 * * 0 /opt/SUNWexplo/bin/explorer -e -q
.SS "Collecting extended data"
.LP
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.
.IP "Example extended data collection (input files)"
.RS
.IP "Collect storage and extended T3 data"
/opt/SUNWexplo/bin/explorer -w storage
.IP "Collect only Serengeti System Controller data"
/opt/SUNWexplo/bin/explorer -w scextended
.IP "Collect all extended data"
/opt/SUNWexplo/bin/explorer -w extended
.RE
.IP "Example extended data collection (no input files)"
.RS
.IP "Collect all extended data interactively"
/opt/SUNWexplo/bin/explorer -w interactive
.RE
.IP "Example input file"
.RS
.IP "etc/saninput.txt"
# Input file for extended data collection
.br
# Format is SWITCH SWITCH-TYPE PASSWORD LOGIN
.br
san-sw1 ancor
san-sw2 brocade $witch admin
.IP "etc/scinput.txt"
# Input file for extended data collection
.br
# Format is HOST PASSWORD
.br
sunfire-sc0 mypassword
.br
# sunfire-sc1 has no password
.br
sunfire-sc1
.IP "etc/t3input.txt"
# Input file for extended data collection
.br
# Format is HOST PASSWORD
.br
finance-t3 $money
.RE
.SH "SEE ALSO"
crontab(1), explorer(1M), explorer(4)