~ubuntu-branches/ubuntu/wily/broctl/wily

« back to all changes in this revision

Viewing changes to debian/broctl.8

  • Committer: Package Import Robot
  • Author(s): Raúl Benencia
  • Date: 2015-02-06 14:17:40 UTC
  • Revision ID: package-import@ubuntu.com-20150206141740-n7zz27u21qc9alo1
Tags: 1.3-1
Initial release (Closes: #771143)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.46.4.
 
2
.TH BROCTL "8" "November 2014" "" "System Administration Utilities"
 
3
.SH NAME
 
4
.B broctl
 
5
\- interactive shell for managing Bro installations
 
6
.SH SYNOPSIS
 
7
.B broctl
 
8
<command>
 
9
 
 
10
.SH DESCRIPTION
 
11
.B broctl
 
12
is an interactive interface for managing a Bro installation which allows
 
13
you to, e.g., start/stop the monitoring or update its configuration.
 
14
 
 
15
Before actually running
 
16
.B broctl
 
17
you first need to edit the
 
18
.B broctl.cfg
 
19
,
 
20
.B node.cfg
 
21
, and
 
22
.B networks.cfg
 
23
files. In the
 
24
.B broctl.cfg
 
25
file, you should review the
 
26
.B broctl
 
27
options and make sure the options are set correctly for your
 
28
environment. Next, edit the
 
29
.B node.cfg
 
30
file and specify the nodes that you will be running. Finally, edit the
 
31
.B networks.cfg
 
32
file and list each network (see the examples in the file for the format to
 
33
use) that is considered local to the monitored environment.
 
34
.SH OPTIONS
 
35
.TP
 
36
.B capstats [<nodes>] [<secs>]
 
37
Report interface statistics with capstats
 
38
.TP
 
39
.B check [<nodes>]
 
40
Check configuration before installing it
 
41
.TP
 
42
.B cleanup [\-\-all] [<nodes>]
 
43
Delete working dirs (flush state) on nodes
 
44
.TP
 
45
.B config
 
46
Print broctl configuration
 
47
.TP
 
48
.B cron [\-\-no\-watch]
 
49
Perform jobs intended to run from cron
 
50
.TP
 
51
.B cron enable|disable|?
 
52
Enable/disable "cron" jobs
 
53
.TP
 
54
.B df [<nodes>]
 
55
Print nodes' current disk usage
 
56
.TP
 
57
.B diag [<nodes>]
 
58
Output diagnostics for nodes
 
59
.TP
 
60
.B exec <shell cmd>
 
61
Execute shell command on all hosts
 
62
.TP
 
63
.B install
 
64
Update broctl installation/configuration
 
65
.TP
 
66
.B netstats [<nodes>]
 
67
Print nodes' current packet counters
 
68
.TP
 
69
.B nodes
 
70
Print node configuration
 
71
.TP
 
72
.B peerstatus [<nodes>]
 
73
Print status of nodes' remote connections
 
74
.TP
 
75
.B print <id> [<nodes>]
 
76
Print values of script variable at nodes
 
77
.TP
 
78
.B process <trace> [<op>] [\-\- <sc>]
 
79
Run Bro (with options and scripts) on trace
 
80
.TP
 
81
.B restart [\-\-clean] [<nodes>]
 
82
Stop and then restart processing
 
83
.TP
 
84
.B scripts [\-c] [<nodes>]
 
85
List the Bro scripts the nodes will load
 
86
.TP
 
87
.B start [<nodes>]
 
88
Start processing
 
89
.TP
 
90
.B status [<nodes>]
 
91
Summarize node status
 
92
.TP
 
93
.B stop [<nodes>]
 
94
Stop processing
 
95
.TP
 
96
.B top [<nodes>]
 
97
Show Bro processes ala top
 
98
.TP
 
99
.B update [<nodes>]
 
100
Update configuration of nodes on the fly
 
101
.PP
 
102
Commands provided by plugins:
 
103
.TP
 
104
.B ps.bro [<nodes>]
 
105
Show Bro processes on nodes' systems
 
106
.SH AUTHOR
 
107
.B broctl
 
108
was written by The Bro Project <info@bro.org>.
 
109
.PP
 
110
This manual page was written by Raúl Benencia <rul@kalgan.cc> for the
 
111
Debian project (but may be used by others).