ROCON-CHECK(1) General Commands Manual ROCON-CHECK(1)
NAME
rocon-check - cross-check hosts in rocon database with hosts in domain
of responsibility
SYNOPSIS
rocon-check [ -V | --version ] [ -v | --verbose | -d level | --de-
bug=level ] [ -h | --help ] [ -p | --paths ] [ -n | --simulate ] [ -f
file | --config-file=file ] [ --mailto=address ] [ --report-mode=re-
port-mode ]
DESCRIPTION
Rocon-check is intended to answer two questions for a system adminis-
trator:
+o do I have root access to all systems within the domain of my re-
sponsibility?
+o are there any systems which are within the domain of my respon-
sibility but which I am unaware of?
These questions are answered by running rocon-check in server mode and
client mode, respectively.
In server mode, rocon-check tries to ssh(1) to all hosts in a config-
urable list and reports access problems; if it gains access then the
file /tmp/rocon-check.touch has its timestamp updated. Rocon-check is
expected to be called in server mode once daily by cron(8) on one sys-
tem only.
In client mode, rocon-check checks the timestamp of /tmp/rocon-
check.touch and reports if it is too old. Rocon-check is expected to
be called in client mode once daily by cron(8) on all systems.
CONFIGURATION
Rocon-check's configuration file specifies whether the program is to
operate in server mode, client mode or both. The host running ro-
con-check in server mode is referred to as the server. A host running
rocon-check in client mode is referred to as a client.
ROCON_CHECK_SERVER={true|false}
This determines if rocon-check will operation in server mode.
The default is false.
ROCON_CHECK_SERVER_CLIENT_SELECTOR_EXPRESSION=host-selector-expression
This specifies the host selector expression (see rocon(1)) that
will be used to tell the server the names of all the clients.
There is no default and it is an error for ROCON_CHECK_SERVER to
be set to true and for ROCON_CHECK_SERVER_CLIENT_SELECTOR_EX-
PRESSION not to be specified.
ROCON_CHECK_CLIENT={true|false}
This determines if rocon-check will operation in client mode.
The default is true.
OPTIONS
-d level, --debug=level Determines how verbose this program will be.
The message types displayed for the different
values of level are as follows: 0 displays no
messages; 1 displays only errors, 2 displays
errors and warnings; 3 displays errors, warn-
ings and informational messages; higher values
display errors, warnings, informational mes-
sages and various messages intended for debug-
ging. The default is 2.
-h, --help Displays a brief usage message.
-p, --paths Lists the compiled-in paths of various files
and directories that this program uses. -n,
--simulate Some external commands that this
program runs may be displayed rather than ac-
tually executed. BEWARE: different programs
implement different levels of simulation; so
this option may work perfectly; on the other
hand it may do nothing at all!
-v, --verbose Equivalent to -d 3.
-V, --version Prints the program's version number and exits.
-f file, --config-file=file
Specify an alternate configuration file; the
default is /etc/rocon-check.conf.
--mailto=address Specify the addresses to which access issues
are reported via email when the report mode is
set to mail.
--report-mode={mail|stdout}
Specify whether to report access issues via
mail or to standard output.
EXIT STATUS
On success rocon-check returns zero. On failure it returns non-zero and
displays a diagnostic message.
FILES
/etc/rocon-check.conf
Default configuration file; see also OPTIONS above.
ENVIRONMENT VARIABLES
None.
EXAMPLES
Example configuration files should have been included with the distri-
bution of this software.
CAVEATS
Rocon-check relies on a working email configuration.
STANDARDS
This manual page documents version 5.0.4 of rocon-check.
SEE ALSO
rocon(1), rocon-config(1), ssh(1)
AUTHOR
Alexis Huxley <alexishuxley@gmail.com>
COPYRIGHT & DISTRIBUTION POLICY
Copyright (C) 2010-2025 Alexis Huxley
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MER-
CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
675 Mass Ave, Cambridge, MA 02139, USA.
5 Feb 2025 ROCON-CHECK(1)
