CCTRL(8)

NAME
cctrl - customs network control

SYNOPSIS
cctrl [-y[es]] [-q[uiet]] [-port number] [-timeout seconds] [-retry times] [-abort | -ping | -restart | -elect | -debug [r|c|n]+ | -allow address | -deny address | -kill [signal] | -jobs | -stats | -setstats | -v[ersion] | -h[elp]] [-all | ALL | -net number | host | network ] ...

DESCRIPTION

Cctrl is used to control the various customs(8) agents on the local network. Agents may be aborted, restarted, pinged, have their debugging code turned on or off, be instructed to kill their imported jobs, or inquired for version information. The default action is -ping.

The -elect flag forces the customs network of which the given host is a part to elect a new master daemon such that the target host has a high probability of becoming the new master.

For the -debug flag, the following argument is a string of the three letters r (turn on RPC debugging), c (turn on customs-specific debugging) or n (turn debugging off). If none of these is given as the first letter of the next argument, rc is assumed. The debugging output goes to the log file for the agent. RPC debugging is voluminous, dealing with messages sent and received, timeouts taken, etc., while customs-specific debugging deals with the machine's availability, requests from local clients, allocation commands, imported jobs, and so on.

The -allow and -deny options add or remove hosts or networks from the access control list of the customs agent. See the options of the same name in customs(8).

The -kill action sends a signal (SIGTERM by default) to all imported jobs on a given machine. This provides a convenient way to clean out orphaned jobs. The signal may be specified by number or name (e.g., -kill HUP), and is translated to an equivalent signal number on the remote system, in case the signal-to-number mappings differ.

The -jobs option requests a list of currently running jobs from a customs daemon and prints them in a format reminiscent of the ps(1) command.

The -stats option obtains summary statistics about imported jobs to date. These include average availability, total number of jobs, signals delivered and evictions, cpu time in user/system modes, and approximate total real time used by imported jobs. -setstats resets the statistics to zero values.

-v or -version asks the customs daemon to return version information.

-h or -help prints a usage summary.

The -abort, -restart and -kill actions require interactive confirmation. The -y or -yes flag can be used to skip confirmation and proceed as if `y' had been entered.

The -q or -quiet flag suppresses all non-error messages.

The -port option can be used to specify the UDP port used in issuing RPCs to the customs agent. This is useful primarily when calling a host on a non-local customs network. Ports can be specified either numerically or as a symbolic name from services(5).

The -timeout and -retry options specify parameters for the RPC call: how many seconds before a call fails, and how many times to retry the call.

Targets machines of a customs control action are specified either by their host name (from the hosts(5) database), a network name (from the networks(5) database), or an IP address corresponding to a host or network. -all or ALL specifies the local network. Specific hosts are sent an RPC call, for networks a broadcast is issued.

Note that if there are multiple customs partitions on a network, all of them will be affected by a broadcast, so -all and network addresses should be used with great care.

The -net flag generates a local network broadcast as -all, but directed only at customs agents running with the specified network token (an integer).

Multiple host and networks are processed in turn, with actions taken according to the last preceding option flag. If no targets are specified at all the local host is assumed.

Cctrl exits with status 0 if at least one of the hosts specified acknowledges the RPC call, otherwise exit status is 1.

SEE ALSO
customs(8), importquota(8), reginfo(1), pmake(1), logd(8), export(1)

BUGS
Signals should be restricted to jobs owned by a particular user.
Broadcasts using -net currently work only with -ping, -elect, -abort, -restart, -version, -jobs, -stats and -setstats, and are identical to -all otherwise.

AUTHOR
Adam de Boor, adam@bsw.uu.net (...!uunet!bsw!adam).
Bugfixes and enhancements by Andreas Stolcke (stolcke@icsi.berkeley.edu).