scc.pl(1)
NAME
scc - collect and send snapshot-files to server
RELEASE
scc-win 1.10.38
SYNOPSIS
scc [ --file <file> ] [ --list <list> ] [ --netview ]
[ --missing ] [ --min_age <days> ]
[ --delay <delay> ] [ --extra <mod> ] [ --fqdn ] [ --norun ]
[ --from <mail> ] [ --dest <dest> ]
[ --encrypt <key> ]
[ --passwd <pw> ] [ --pki <file> ] [ --prog <prog> ]
[ --smtp <smtp> ] [ --trace ] [ --report <file> ]
[ --timeout <duration> ]
[ --comment <remark> ] [ --help ] [ --version ]
DESCRIPTION
Run the program scc-log and optionally send the resulting files
to the destination.
The security setup of the server receiving the files is very
important. Refer to the documentation of scc-srv for the setup
of the server.
The collection of scc-data from the system is done by means of
modules. Two kinds of modules exist, user and system modules.
The system modules are installed and run by scc. To extend the
reach of the snapshots, user modules can be added to collect
additional data. Refer to scc-collect(1) for more details. To
run all user modules, use the following command-line:
scc --extra "*"
When the --delay option is used, there is a pause of the indicated
number of seconds after each collection. This avoids flooding the
receiving system and eases the collecting system.
Use the --missing option to process repeatedly a number of systems
until the data of all systems has been collected.
The transferred files are tarred, compressed and uuencoded when
sent via email.
Refer to the manual page of scc-log(1) for troubleshooting
when scc seems to "hang".
OPTIONS
--comment <remark> Comment for entry in logbook.
--delay <delay> Delay in seconds between collections in each run.
--encrypt <file> Use public key in <file> in bin directory of scc to encrypt data.
Refer to the documentation of scc-srv for details.
--extra <mod> Execute additional user modules.
--fqdn Determine for each host the fqdn and use this in the filenames.
--file <file> Collect data from all systems in <file>. Each line of
this file contains the name of a system. Empty lines
and comment lines (#) are ignored.
--from <mail> Sender for email. By default <postmaster@domain> is used, where
domain is determined by DNS.
--help Show the syntax of the program.
--list <list> Collect data from all systes in <list>. This is a
comma-separated list of system names.
--missing Collecting data from all systems in a domain can be
difficult as laptops and desktops can be powered off.
Use this option to collect data from those systems that
not yet have been collected. Use other options to specify
which systems to check.
--min_age <days> Minimal age of the local snapshot before collecting data again.
--netview Collect data from all systems resulting from the
command: net view. When the --norun option is also used,
all present data is transferred to scc-srv.
--norun Do not collect new data, send current data for systems specified
by the --list or --file options or all present data when the --netview
option is used.
--passwd <pw> Use <pw> for scp or ftp (optional).
--pki <file> Private key file used by pscp. Located in bin-directory of scc.
--prog <prog> Use <prog> to transfer SCC-data, default value is
mail. Other values are:
cp copy files to fileserver.
ftp use ftp; requires (optional) --passwd option
mail send by mail, requires --smtp option and
optional --from. Refer to data/blat_log.txt for logging.
scp SSH-copy to scc-srv; requires --passwd or --pki
Refer to scc-win(5) for the setup of the communication.
pull local transfer to data\transfer;
transfer is done later by scc-srv.
Implies --delay 0 and ignores --send option.
--dest <dest> Destination to send the files to:
cp directory on fileserver: \server\share
ftp destination: <user>@myserver.com:<dir>
mail destination: <alias>
specify the server by means of the --smtp option
scp destination: <user>@myserver.com:<dir>
--report <file> Log summary of result in <file> in bin-directory of scc.
--smtp <smtp> Use <smtp> as server for transfer by email.
--trace Trace progress of scripts on stdout.
--timeout <duration> Maximum allowed number of seconds for processing each system.
--version Print version info and stop.
ARGUMENTS
None.
RETURN VALUE
Upon completion, the program returns one of the following values:
0 successful completion
1 syntax error
2 runtime error
EXTERNAL INFLUENCES
The names of the files that are sent to the scc-server, must be
known in the server-software also: scc-transfer-data.gz.
Refer to the manual page of scc-srv for the setup of the scc-server.
When the --fqdn option is used, nslookup is called to determine the fqdn.
This program assumes it is called from the bin directory of the SCC software.
COPYRIGHT
scc is free software under the terms of the GNU General Public
License. Copyright (C) 2006-2018 QNH, 2019 Siem Korteweg.
FILES
- data - folder for data files
scc.<hostname>.cur - current SCC-snapshot
scc.<hostname>.html - current SCC-snapshot in HTML-format
scc.<hostname>.log - logbook for changes in SCC-snapshots
scc.<hostname>.log.html - logbook in HTML-format
blat_log.txt - log file for email transfer
When the --fqdn option is used, the DNS-domain is added to <hostname> in
the filenames.
When cp, scp or ftp is used, the file scc.<hostname>.signal is used to
indicate the completed transfer of the scc-data on the server.
- data/transfer - directory for pull
SEE ALSO
scc(1), scc-collect(1), scc-log(1), scc-log2html(1),
scc-plugin(1), scc-snap2html(1), scc-win(4), scc-win(5)
VERSION
$Revision: 6235 $