This tool gathers information about the operating system and the IBM HTTP Server installation. It can be used in a variety of circumstances, and is intended to replace the traditional list of instructions for gathering information about the IBM HTTP Server and GSKit versions manually. It will gather the traditional information and more, in order to avoid some requests for additional information.
The ServerDoc tool provided with ihsdiag automates the work of gathering this information. The user runs ServerDoc and provides the IHS installation directory; ServerDoc creates a new directory to hold the required documentation, and stores information in that new directory.
Once the ServerDoc tool has completed, the user should copy any remaining log files and configuration files used by the web server and the plug-in into the new directory, and send in the directory to IBM support.
This tool may be used to gather documentation when there are
problems with the ikeyman
, gsk5cmd
, or
gsk7cmd
programs. Ensure that PATH and JAVA_HOME are set
to the same values when running this tool as they are when
encountering problems with the ikeyman
, gsk5cmd
, or
gsk7cmd
programs.
On Unix and Linux platforms, run the tool as root
to
avoid any permissions problems with reading files or system
information.
ServerDoc is passed in one parameter for gathering this information:
# java -jar ServerDoc.jar DescribeConfig /path/to/IHS
The tool creates a new directory which contains a timestamp in the name, and the information will be saved in that directory.
For this example, IHS is installed in
/usr/IHS20422-PQ85834
and ihsdiag was unpacked into
directory /root/ihsdiag-1.4.1
.
# cd /tmp # java -jar /root/ihsdiag-1.4.1/ServerDoc.jar DescribeConfig /usr/IHS20422-PQ85834 Web server version: 2.0.42.2-PQ85834 Available GSKit version: 5.0.5.92 Available GSKit version: 7.0.3.9 Reports, log files, and configuration files have been saved to directory ServerConfig.200505111519 If you have additional log files or configuration files, copy them there before packing up the directory. Web server log and conf files other than the default will have to be copied manually. WebSphere plug-in conf and log files will have to be copied manually. Hint for packing up the directory: tar -cf ServerConfig.200505111519.tar ServerConfig.200505111519 gzip ServerConfig.200505111519.tar # ls -l ServerConfig.200505111519/ total 4680 -rw-r--r-- 1 root system 1886 May 11 15:19 US_export_policy.jar -rw-r--r-- 1 root system 1613349 May 11 15:19 access_log -rw-r--r-- 1 root system 5389 May 11 15:19 apachectl -rw-r--r-- 1 root system 1278 May 11 15:19 error_log -rw-r--r-- 1 root system 544058 May 11 15:19 httpd -rw-r--r-- 1 root system 29345 May 11 15:19 httpd.conf -rw-r--r-- 1 root system 3373 May 11 15:19 ikeyman -rw-r--r-- 1 root system 2360 May 11 15:19 local_policy.jar -rw-r--r-- 1 root system 169317 May 11 15:19 log -rw-r--r-- 1 root system 285 May 11 15:19 report -rwxr-xr-x 1 root system 20 May 11 15:19 showulimit.sh #
For this example, IHS is installed in C:\IHS-1.3.26
and ihsdiag was unpacked into directory
C:\tmp\ihsdiag-1.4.1
.
C:\>cd c:\tmp C:\tmp>java -jar \tmp\ServerDoc.jar DescribeConfig C:\IHS-1.3.26.2 Web server version: 1.3.26.2-PQ87084 Available GSKit version: 5.0.5.92 Available GSKit version: 7.0.3.6 Reports, log files, and configuration files have been saved to directory ServerConfig.200505111526 If you have additional log files or configuration files, copy them there before packing up the directory. Web server log and conf files other than the default will have to be copied manually. WebSphere plug-in conf and log files will have to be copied manually. Hint for packing up the directory: zip -r ServerConfig.200505111526.zip ServerConfig.200505111526 (or use any other program to create a .zip) C:\tmp>dir ServerConfig.200505111526 Volume in drive C is C_Drive Volume Serial Number is 98E7-6D3C Directory of C:\tmp\ServerConfig.200505111526 05/11/2005 03:26p <DIR> . 05/11/2005 03:26p <DIR> .. 05/11/2005 03:26p 1,209,650 access.log 05/11/2005 03:26p 123,198 error.log 05/11/2005 03:26p 20,975 httpd.conf 05/11/2005 03:26p 49,127 log 05/11/2005 03:26p 286 report 5 File(s) 1,403,236 bytes 2 Dir(s) 20,487,684,096 bytes free C:\tmp>
The next step is to copy any other web server or plug-in configuration files and logs into the new HangDoc directory. Here is a list of files to copy if they are being used:
The last step is to pack up and compress the documentation directory using the commands displayed by the tool (tar and gzip on Unix; zip on Windows). The easiest way is to cut and paste the messages displayed by ServerDoc previously which showed the commands to use.
# tar -cf ServerConfig.200505111519.tar ServerConfig.200505111519 # gzip ServerConfig.200505111519.tar
The resulting file ServerConfig.200505111519.tar.gz is the file to send to IBM support.
C:\tmp>zip -r ServerConfig.200505111526.zip ServerConfig.200505111526 adding: ServerConfig.200505111526/ (92 bytes security) (stored 0%) adding: ServerConfig.200505111526/access.log (92 bytes security) (deflated 99%) adding: ServerConfig.200505111526/error.log (92 bytes security) (deflated 94%) adding: ServerConfig.200505111526/httpd.conf (92 bytes security) (deflated 63%) adding: ServerConfig.200505111526/log (92 bytes security) (deflated 86%) adding: ServerConfig.200505111526/report (92 bytes security) (deflated 28%)
The resulting file ServerConfig.200505111526.zip is the file to send to IBM support.