sys2html

NAME

SYNOPSIS

sys2html -o outdir [user@]hostname...

sys2html [ options ] -o outdir [user@]hostname...

sys2html [ options ] -r [user@]hostname... > data.raw

sys2html -o outdir - < data.raw

sys2html [ -c config_file ] -l

sys2html [ -c config_file ] -p OSID

options ::= [ -m ] [ -n name_resolver ] [ -i info_resolver ] [ -c config_file ] [ -s info_file ]

AVAILABILITY

DESCRIPTION

It includes the collection of cron and at, installed hardware and software, filesystems, dump- and swap-configuration, LVM, network settings, kernel, system enhancements and applications.

The HTML 'System Documentation' report is also suited for viewing using lynx(1) on the command line.

sys2html aims to collect the same information as the well known cfg2html(1m) does, but without the need to install it on the (remote) systems where the configuration is collected.

To connect to the target system SSH (with ssh-exec) is used.

The generation of the HTML 'System Documentation' report is performed and saved on the system where the sys2html is invoked.

OPTIONS

-h

usage message.

-c config_file

specify an alternate configuration collection configuration sys2html.dat(4) file.

-i info_resolver

custom host name to system description resolver. The info_resolver is used to dynamically resolve the system description.

If it cannot return a system description, the system description is looked-up in the sys2html.inf file, if possible.

The info_resolver must be an executable that receives a hostname as argument and returns the system description to stdout, whereas the output can consist of multiple lines.

-l

list currently configured operating systems (OSID) to collect system information from.

-m

force MULTISTEP query mode, where for each configuration row with defined commands an SSH connection to the target system is made in sequence.

-n name_resolver

custom host name to IP address resolver. The name_resolver is used if the IP address cannot be resolved by the system (using getent hosts hostname interally). It must be an executable that receives a hostname as argument and returns the resolved IP address as first field, whereas the fields are white-space separated.

-o outdir

output directory where to save the HTML 'System Documentation' reports.

-p OSID

print collection definition (TITLE, COMMAND) for the given OSID.

-r

print raw data of collected configuration to stdout.

-s info_file

specify an alternate central system information description sys2html.inf(4) file.

-

read from stdin.

data.raw

raw data returned by sys2html not formatted to HTML.

user

user to connect to on the remote system. If no user is specified, this defaults to root.

hostname

space separated list of systems where to remotely collect the system configuration.

ENVIRONMENT

EXIT STATUS

0

no error.

1

cannot write to the outdir directory specified in the -o option.

2

operating system not supported. See osid(3) if you get this error.

3

on command line specified sys2html.cfg or sys2html.inf could not be read.

4

usage displayed.

FILES

etc/sys2html.dat

configuration collection configuration file for sys2html(1m).

etc/sys2html.inf

central system information description file for sys2html(1m).

/etc/cfg2html/systeminfo

local system description file as known from the cfg2html(1m) command.

EXAMPLES

SEE ALSO

NOTES

Most obvious differences to the cfg2html are, that sys2html:

-

collects the system configuration from remote systems,

-

allows to define the elements to be collected on the remote system in a configuration file and

-

is currently configured to collect system information from Linux (OSID: Linux-64) and Dell/EMC Data Domain (OSID: DELLDataDomain) systems.

BUGS

AUTHOR

COPYRIGHT

This is free software; see edrc/doc/COPYING for copying conditions. There is ABSOLUTELY NO WARRANTY; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.