1BROCTL(8)               System Administration Utilities              BROCTL(8)
2
3
4

NAME

6       broctl - interactive shell for managing Bro installations
7

SYNOPSIS

9       broctl [command]
10
11

DESCRIPTION

13       broctl  is an interactive interface for managing either a standalone or
14       a Bro cluster installation.  If a broctl command is specified  directly
15       on  the  command-line,  then broctl performs the action associated with
16       that command immediately (instead of  running  the  interactive  inter‐
17       face).
18
19       Before  actually  running broctl you first need to edit the broctl.cfg,
20       node.cfg, and networks.cfg files. In the broctl.cfg  file,  you  should
21       review  the  broctl options and make sure the options are set correctly
22       for your environment. Next, edit the  node.cfg  file  and  specify  the
23       nodes that you will be running. Finally, edit the networks.cfg file and
24       list each network that is considered local to the monitored environment
25       (see the examples in the file for the format to use).
26
27       When  running broctl for the first time, you must run the broctl deploy
28       command before running any other commands in order to apply the config‐
29       uration settings.  You must also run broctl deploy each time you change
30       the configuration (including any Bro scripts) or upgrade Bro.
31

OPTIONS

33       capstats [<nodes>] [<secs>]
34              Report interface statistics with capstats
35
36       check [<nodes>]
37              Check configuration before installing it
38
39       cleanup [--all] [<nodes>]
40              Delete working dirs (flush state) on nodes
41
42       config Print broctl configuration
43
44       cron [--no-watch]
45              Perform jobs intended to run from cron
46
47       cron enable|disable|?
48              Enable/disable "cron" jobs
49
50       deploy Check, install, and restart
51
52       df [<nodes>]
53              Print nodes' current disk usage
54
55       diag [<nodes>]
56              Output diagnostics for nodes
57
58       exec <shell cmd>
59              Execute shell command on all hosts
60
61       exit   Exit from the interactive interface
62
63       install
64              Update broctl installation/configuration
65
66       netstats [<nodes>]
67              Print nodes' current packet counters
68
69       nodes  Print node configuration
70
71       peerstatus [<nodes>]
72              Print status of nodes' remote connections
73
74       print <id> [<nodes>]
75              Print values of script variable at nodes
76
77       process <trace> [<op>] [-- <sc>]
78              Run Bro (with options and scripts) on trace
79
80       restart [--clean] [<nodes>]
81              Stop and then restart processing
82
83       scripts [-c] [<nodes>]
84              List the Bro scripts the nodes will load
85
86       start [<nodes>]
87              Start processing
88
89       status [<nodes>]
90              Summarize node status
91
92       stop [<nodes>]
93              Stop processing
94
95       top [<nodes>]
96              Show Bro processes ala top
97
98       update [<nodes>]
99              Update configuration of nodes on the fly
100
101       Commands provided by plugins:
102
103       ps.bro [<nodes>]
104              Show Bro processes on nodes' systems
105

AUTHOR

107       broctl was written by The Bro Project <info@bro.org>.
108
109
110
111                                 November 2014                       BROCTL(8)