System Administration
cancel
Showing results for 
Search instead for 
Did you mean: 

Script to generate a documentation about a RHEL5 server

Yaboto
Super Advisor

Script to generate a documentation about a RHEL5 server


Can anyone give me a script that can generate a documentation about a Linux installation and configuration ?

Thanks
6 REPLIES
Steven E. Protter
Exalted Contributor

Re: Script to generate a documentation about a RHEL5 server

Shalom,

sysreport

Does a fairly good job.

Beyond that, you will need to WRITE a script to go into better detail.

SEP
Steven E Protter
Owner of ISN Corporation
http://isnamerica.com
http://hpuxconsulting.com
Sponsor: http://hpux.ws
Twitter: http://twitter.com/hpuxlinux
Founder http://newdatacloud.com
Patrick Wallek
Honored Contributor

Re: Script to generate a documentation about a RHEL5 server

CFG2HTML is a good multi-platform tool.

I use it on all of my HP-UX and Linux servers.

http://come.to/cfg2html
Matti_Kurkela
Honored Contributor

Re: Script to generate a documentation about a RHEL5 server

The RHEL installer automatically creates the /root/anaconda-ks.cfg file, which documents all the choices made during the OS installation. It is a Kickstart configuration file, so you can use it to install other systems with exactly the same specifications as the original.

(Note: the auto-created anaconda-ks.cfg file will have the partitioning definition lines commented out for safety. Before using the auto-created file for Kickstart installations, verify and uncomment the partitioning definition. Also read RedHat documentation on Kickstart configuration files.)

The configuration report tools like the already-mentioned sysreport and cfg2html are very useful. But the most important documentation is often the one that tells *why* something is configured as it is.

For example, a script-generated configuration report might allow you to see that a specific option on System A has been disabled; but what it cannot tell you is that it was disabled because old systems X, Y and Z will fail to connect to System A if the option is enabled.

If the reason of disabling the option is documented, it makes it easier to see that once the systems X, Y and Z have been upgraded or removed, it would be a good time to re-evaluate enabling that option.

MK
MK
Huc_1
Honored Contributor

Re: Script to generate a documentation about a RHEL5 server

Just an added info

sysreport is now named sosreport. (at least on Fedora)

This Generate debugging information

Package is named sos ( Save our souls)

# yum info sos

Loaded plugins: auto-update-debuginfo, presto, refresh-packagekit
Installed Packages
Name : sos
Arch : noarch
Version : 2.2
Release : 0.fc13
Size : 679 k
Repo : installed
From repo : updates
Summary : A set of tools to gather troubleshooting information from a system
URL : http://fedorahosted.org/sos
License : GPLv2+
Description : Sos is a set of tools that gathers information about system
: hardware and configuration. The information can then be used for
: diagnostic purposes and debugging. Sos is commonly used to help
: support technicians and developers.

Enjoy life.

Jean-Pierre Huc
Smile I will feel the difference
Yaboto
Super Advisor

Re: Script to generate a documentation about a RHEL5 server

With SOSREPORT, can I get the report in a word document format ?
Huc_1
Honored Contributor

Re: Script to generate a documentation about a RHEL5 server

It produces a very complete html report that you can view from a web browser.

Please assign points.

Jean-Pierre Huc
Smile I will feel the difference