.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.46.4.
.TH BROCTL "8" "November 2014" "" "System Administration Utilities"
.SH NAME
.B broctl
\- interactive shell for managing Bro installations
.SH SYNOPSIS
.B broctl
<command>

.SH DESCRIPTION
.B broctl
is an interactive interface for managing a Bro installation which allows
you to, e.g., start/stop the monitoring or update its configuration.

Before actually running
.B broctl
you first need to edit the
.B broctl.cfg
,
.B node.cfg
, and
.B networks.cfg
files. In the
.B broctl.cfg
file, you should review the
.B broctl
options and make sure the options are set correctly for your
environment. Next, edit the
.B node.cfg
file and specify the nodes that you will be running. Finally, edit the
.B networks.cfg
file and list each network (see the examples in the file for the format to
use) that is considered local to the monitored environment.
.SH OPTIONS
.TP
.B capstats [<nodes>] [<secs>]
Report interface statistics with capstats
.TP
.B check [<nodes>]
Check configuration before installing it
.TP
.B cleanup [\-\-all] [<nodes>]
Delete working dirs (flush state) on nodes
.TP
.B config
Print broctl configuration
.TP
.B cron [\-\-no\-watch]
Perform jobs intended to run from cron
.TP
.B cron enable|disable|?
Enable/disable "cron" jobs
.TP
.B df [<nodes>]
Print nodes' current disk usage
.TP
.B diag [<nodes>]
Output diagnostics for nodes
.TP
.B exec <shell cmd>
Execute shell command on all hosts
.TP
.B install
Update broctl installation/configuration
.TP
.B netstats [<nodes>]
Print nodes' current packet counters
.TP
.B nodes
Print node configuration
.TP
.B peerstatus [<nodes>]
Print status of nodes' remote connections
.TP
.B print <id> [<nodes>]
Print values of script variable at nodes
.TP
.B process <trace> [<op>] [\-\- <sc>]
Run Bro (with options and scripts) on trace
.TP
.B restart [\-\-clean] [<nodes>]
Stop and then restart processing
.TP
.B scripts [\-c] [<nodes>]
List the Bro scripts the nodes will load
.TP
.B start [<nodes>]
Start processing
.TP
.B status [<nodes>]
Summarize node status
.TP
.B stop [<nodes>]
Stop processing
.TP
.B top [<nodes>]
Show Bro processes ala top
.TP
.B update [<nodes>]
Update configuration of nodes on the fly
.PP
Commands provided by plugins:
.TP
.B ps.bro [<nodes>]
Show Bro processes on nodes' systems
.SH AUTHOR
.B broctl
was written by The Bro Project <info@bro.org>.
.PP
This manual page was written by Raúl Benencia <rul@kalgan.cc> for the
Debian project (but may be used by others).