'\" t .\" ident "$Id: //depot/dev/proactive/explorer3/man/man1m/explorer.1m#11 $" .TH explorer 1M "08/08/2001" Explorer "Sun Data Collector" .SH NAME explorer \- gather system configuration information .SH SYNOPSIS .LP .TS tab(^); r1 l. explorer^\-version explorer^\-help explorer^ ^[ \-h \fI\fR ] ^[ \-d \fI\fR ] ^[ \-l \fI\fR ] ^[ \-e | \-mail ] ^[ \-E \fI\fR | \-myemail \fI\fR ] ^[ \-t \fI\fR | \-target \fI\fR ] ^[ \-r ] ^[ \-R \fI\fR ] ^[ \-k | \-keep ] ^[ \-f \fI\fR ] ^[ \-c \fI\fR ] ^[ \-w \fI\fR ] ^[ \-v | \-verbose ] ^[ \-q | \-quiet ] ^[ \-s \fI\fR ] ^[ \-case \fI\fR ] ^[ \-esc \fI\fR ] ^[ \-sn \fI\fR ] ^[ \-transport \fI\fR ] .TE .SH DESCRIPTION .LP The explorer command gathers extensive system information. The explorer output can be automatically emailed to the explorer database. .SH OPTIONS .LP The following options can be used with explorer: .IP "\-help" Display this information. .IP "\-version" Display explorer revision level. .IP "\-h \f2\f1" Use \f2\f1 for the top directory of the explorer installation. .IP "\-d \f2\f1" Uses \f2\f1 to override default values. See explorer(4) for the format of the defaults file. .IP "\-l \f2\f1" Use \f2\f1 to collect all log messages. .IP "\-e | \-mail" Can be used to automatically email explorer output to the recipients specified in the \fBetc/default/explorer\fR configuration file. .RS .IP "E-mail issue" All e-mail directed to SUN is reverse address checked. If the sender's return address is not a valid, 'reachable' address, the mail is rejected. .RE .IP "\-E \f2\f1 | \-myemail \f2\f1" Automatically email explorer output to \fI\fR of your choice. .IP "\-t \f2\f1 | \-target \f2\f1" Specify an alternate directory to save explorer output. .IP "\-r" Use User email address in \fBetc/default/explorer\fR file for address where receipts of explorer should go. This feature is not currently implemented on the receiving end. .IP "\-R \f2\f1" Use \fI\fR for address where receipts of explorer should go. .IP "\-k | \-keep" Keep old explorer run outputs. Default is to remove old copies and keep the latest. .IP "\-f \f2\f1" Add \fI\fR to list of files to collect, files can be found in the extra/ directory. To collect multiple files, use multiple -f options or seperate with a ','. For example: .IP explorer -f /etc/motd -f /etc/defaultdomain,/etc/nsswitch.conf .IP "\-c \f2\f1" Add output of \fI\fR to what explorer collects, output can be found in the extra/ directory. The command should be the absolute path to the binary to be executed. If options are needed, use quotes to enclose the command. To collect multiple commands, use multiple -c options or seperate with a ','. For example: .IP explorer -c "/usr/bin/lpstat -t" -c "/bin/ls -l /tmp,/bin/ls -l /dev" .IP "\-w \f2\f1" Select the modules to run, comma ',' seperated. 'default' is used if no -w option given. Options to -w can be names of scripts in the tools/ directory, like disks, netinfo, ssp, etc, var. It may also include an alias for a set of tools to run. Aliases currently supported are: default, all, extended, interactive, storage, network, backup, sf15000, starfire, printer and license. Preceding a module or alias with '!' will turn off the running of module. In addition, IPv4 addresses may be masked by using !ipaddr. .IP Interactive modules are used to get information from the user about SAN switches (sanextended), Serengeti System Controllers (scextended) or StorEdge T3s (t3extended). These modules will prompt for the hostname of a SAN switch, T3 or System Controller and the root password. A single carriage return will let the module know that the list of hosts is finished. .IP The interactive modules can be run by default if input files exist that contain the machine and root password. The input files are located in EXP_HOME/etc/ and are saninput.txt, scinput.txt and t3input.txt for SAN switches, System Controllers and T3s respectively. The mode of the file must be such that group and other are unavailable (ls -l mode is -r--------). If the input files do not have the right permissions, no data collection will occur. .RS .IP EXAMPLES .IP "-w disks" Run only the disks module. .IP "-w network,!ipaddr" Run various network modules and mask the IPv4 addresses. .IP "-w storage" Collect storage data and extended data from StorEdge T3s if t3input.txt exists. .IP "-w extended" Collect only extended data from SAN switches, Serengeti System Controllers and StorEdge T3s for hosts in saninput.txt, scinput.txt or t3input.txt .IP "-w default,interactive" Collect default modules and prompt user for extended data collect for SAN switches Serengeti System Controllers and StorEdge T3. .RE .RS .IP NOTE .IP extended collection In order for explorer to collect extended data, the node (SAN switch, System Controller or T3) must be accessible via telnet from the system collecting the data. In addition, to collect all T3 extended data, explorer must be run from a root login shell by using either "su -" or "telnet". .RE .IP "\-v | \-verbose" Display detailed progress while the explorer command is run. .IP "\-q | \-quiet" Supress printing of all log messages. .IP "\-s \f2\f1" Change the mail subject to that specified. Variable expansion will be done on %F (explorer file name), %C (Customer name), %I (Contract ID), %E (explorer ID) and %H (hostid). .IP "\-case \f2\f1" Will add the Radiance Case Number to the README file. .IP "\-esc \f2\f1" Will add the Escalation Number to the README file. .IP "\-sn \f2\f1" Provide the serial number for the machine running explorer. The serial number overrides the defaults file and will only be seen in the README file. .IP "\-transport \f2\f1" The following transport mechanisms are supported: mailto, ftp and file. Multiple transports may be used. In order to use ftp as the transport, the \fI/.netrc\fR file must be configured with the host, user and password .RS .LP "Sample .netrc" machine ftp.gnu.org login anonymous password eng@sun.com .IP "Send to eng@sun.com" explorer -transport mailto:eng@sun.com .IP "Send to tape device /dev/rmt/0" explorer -transport file:/dev/rmt/0 .IP "Send to ftp site" explorer -transport ftp://ftp.gnu.org/pub/incoming .RE .SH REQUIREMENTS .LP \(bu explorer requires root privileges to run. .br \(bu ftp transport requires root login shell (su -). .br \(bu root needs write privileges to the \fI\fR. .br \(bu explorer works on Solaris 2.x only. .SH SUPPORTED HARDWARE AND OPERATING SYSTEMS .LP The following hardware has been tested (uname -p): .LP \(bu sun4m .br \(bu sun4d .br \(bu sun4u .br \(bu i386 .LP The following releases of the Solaris operating system have been tested (uname -r): .LP \(bu 5.3 .br \(bu 5.4 .br \(bu 5.5 .br \(bu 5.5.1 .br \(bu 5.6 .br \(bu 5.7 .br \(bu 5.8 .br .SH "SEE ALSO" explorer(4), explorer(5), netrc(4)