Content-type: text/html Manpage of SURVEY

SURVEY

Section: Compaq Computer Corporation (8)
Updated: January 2001
Index Return to Main Contents
 

NAME

survey - Compaq Survey Utility  

SYNOPSIS

survey [OPTION] [LEVEL] [TIME] [FILE] [PATH]  

DESCRIPTION

The Compaq Survey Utility is an online information-gathering agent that runs on Compaq servers. It gathers critical hardware and software information from various sources and saves it to a text file. This utility was designed to facilitate the resolution of problems without taking the server off-line, thus maximizing server availability.

You can use the Compaq Survey Utility to perform the following functions:

-View the machine's hardware and software configuration
-Compare historical configurations of the machine
-Capture a new configuration sample

The Compaq Survey Utility is normally configured to run shortly after the OS loads and at specified time intervals. This helps to ensure that the latest information and change history are always recorded and available when needed. You can modify the data-gathering interval by modifying the command line parameters or through the web browser interface.

The Compaq Survey Utility includes a web browser interface (surveywebd) in addition to the command-line interface. The browser interface enables the utility to be configured and the survey output information to be viewed from a local or remote system.

This output information can also be accessed in the /var/compaq/survey directory.

 

SYSTEM REQUIREMENTS

This version of the Compaq Survey Utility has been tested and supported on the Compaq products as outlined in our Operating System Support Matrix and Storage Option Support Matrix linked below. These links will also provide the current linux distributions and versions that Compaq supports.
http://www.compaq.com/products/servers/linux/OSMatrix1.html
http://www.compaq.com/products/servers/linux/OptionsMatrix.html
 

OPTIONS

-v [Level]
Verbosity of output where Level is an integer 1..5. Level 1 is the most filtered level, 5 is the most verbose. The default value is set to 3.
-s mmhhddMMDD
Schedule automatic execution. mmhhddMMDD mm=minute, hh=hour, dd=day, MM=month, DD=Day of Week Use a single * for don't care and all fields must be two digts (02 instead of 2). See example below. NOTE: This command simple adds an entry to your crontab. For more information on crontab type 'man crontab'.
-u
unschedule of survey running NOTE: This command will remove all entries in your crontab that refer to "/opt/compaq/survey/survey"
-c FILE1 [FILE2]
Compare a file to the current output or if two files are specified compare the files without generating a new report
-t
Output to the terminal NOTE: -t and -o cannot be used together.
-o FILE
Specify name of the output file. Default is formed using the current date at: /var/survey/surveyCCYY-MM-DD-HH-mm-ss.txt (CC=Century, YY=Year, MM=Month, DD=Day, HH=Hour, ss=second)
-f
If the output file, specified with the -o option, exists it will be overwritten. NOTE: If no -o option is specified this option is ignored
-w
Starts the daemon that will enable viewing of survey output through the web
-?, -h
display help
 

THEORY OF OPERATION

The Compaq Survey Utility captures data as sessions, each stored in an individual text file. A session is defined as an organized group of data describing the configured state of the system at a specific point in time. The session information is maintained in a file called surveyCCYY-MM-DD-HH-mm-ss.txt (the double letters represent the time when survey was run) located in the /var/compaq/survey.  

WEB INTERFACE

The Compaq Survey Utility allows the viewing of reports from a web browser. Before the browser can be used the Survey web daemon must be started. This can be accomplished in one of two ways.
1) Run survey with the -w option.
ie. /opt/compaq/survey/survey -w
2) Run the Survey Web Daemon directly.
ie. /opt/compaq/survey/surveywebd
The survey reports are viewable from a web browser on http port 2301.
Example URL:
http://127.0.0.1:2301/
 

EXAMPLES

This command will schedule survey to gather data every Wednesday at 12:30 AM.
survey -s 3000**04
This command will force the creation of survey.data with verbosity level 5.
survey -v 5 -of survey.data
This command will compare two previously generated sessions
survey -c survey.data1 survey.data2
 

NOTE

To retrieve certain information the devices must be configured. For example: If there are Compaq IDA controllers installed in the system but the cpqarray.o module is not loaded, the controller information cannot be retrieved.  

FILES

/opt/compaq/survey/survey
/opt/compaq/survey/surveywebd
/opt/compaq/survey/survey.ids
/opt/compaq/foundation/bin/libcpqhmmo.so
 

REPORTING BUGS

Report bugs to <linux.feedback@compaq.com>.

 

COPYRIGHT

Copyright © 2001 Compaq Computer Corporation. All rights reserved.

 

SEE ALSO

The Compaq ROM Driver (crom.o) allows survey to obtain more information, such as the Compaq Integrated Management Log. It is available as part of the health driver package from http://www.compaq.com/linux


 

Index

NAME
SYNOPSIS
DESCRIPTION
SYSTEM REQUIREMENTS
OPTIONS
THEORY OF OPERATION
WEB INTERFACE
EXAMPLES
NOTE
FILES
REPORTING BUGS
COPYRIGHT
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 01:27:57 GMT, January 05, 2001