Debian Codegraph @

support/Config/radium.conf

raw
1 #
2 # Radium Software
3 # Copyright (c) 2000-2024 QoSient, LLC
4 # All rights reserved.
5 #
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2, or (at your option)
9 # any later version.
10 #
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 #
20 # Example radium.conf
21 #
22 # Radium will open this radium.conf if its installed as /etc/radium.conf.
23 # It will also search for this file as radium.conf in directories
24 # specified in $RADIUMPATH, or $RADIUMHOME, $RADIUMHOME/lib,
25 # or $HOME, $HOME/lib, and parse it to set common configuration
26 # options. All values in this file can be overriden by command
27 # line options, or other files of this format that can be read in
28 # using the -F option.
29 #
30 #
31 # Variable Syntax
32 #
33 # Variable assignments must be of the form:
34 #
35 # VARIABLE=
36 #
37 # with no white space between the VARIABLE and the '=' sign.
38 # Quotes are optional for string arguements, but if you want
39 # to embed comments, then quotes are required.
40 #
41 #
42 # Variable Explanations
43 #
44 # Radium is capable of running as a daemon, doing all the right things
45 # that daemons do. When this specific configuration file is used
46 # to configure the system daemon process (/etc/radium.conf) this
47 # variable should be set to "yes".
48 #
49 # The default value is to not run as a daemon.
50 #
51 # This example is to support the ./support/Startup/radium script
52 # which requires that this variable be set to "yes".
53 #
54 # Commandline equivalent -d
55 #
56
57 #RADIUM_DAEMON=yes
58
59
60 # Radium Monitor Data is uniquely identifiable based on the source
61 # identifier that is included in each output record. This is to
62 # allow you to work with Argus Data from multiple monitors at the
63 # same time. The ID is 32 bits long, and supports a number of
64 # formats as legitimate values. Radium supports unsigned ints, IPv4
65 # addresses and 4 bytes strings, as values.
66 #
67 # The formats are discerned from the values provided. Double-quoted
68 # values are treated as strings, and are truncated to 4 characters.
69 # Non-quoted values are tested for whether they are hostnames, and if
70 # not, then they are tested wheter they are numbers.
71 #
72 # The configuration allows for you to use host names, however, do
73 # have some understanding how `hostname` will be resolved by the
74 # nameserver before commiting to this strategy completely.
75 #
76 # For convenience, radium supports the notion of "`hostname`" and
77 # "`hostuuid`" for assigning the probe's id. This is to support
78 # general management of larger deployments, so you can have one
79 # argus.conf file that works for a lot of probes.
80 #
81 # The use of `hostuuid` is targeted at Linux and Apple computers.
82 #
83 # For security, argus does not rely on system programs, like hostname.1.
84 # It implements the logic of hostname itself, so don't try to run
85 # arbitrary programs using this method, because it won't work.
86 #
87 # Commandline equivalent -e
88 #
89 # Srcid's are specified using the notion used for ARGUS_MONITOR_ID, as above.
90
91 #RADIUM_MONITOR_ID=`hostname` // IPv4 address returned
92 #RADIUM_MONITOR_ID=`hostuuid` // UUID returned
93 #RADIUM_MONITOR_ID=10.2.45.3 // IPv4 address
94 #RADIUM_MONITOR_ID=2435 // Number
95 #RADIUM_MONITOR_ID="ra01" // String
96 #RADIUM_MONITOR_ID=uuid:/5E487EDE-B311-5E80-B69F-967E5E6C7A9F
97
98 #RADIUM_MONITOR_ID_INCLUDE_INF=yes // Specify that this radium is the default radium "rad0".
99 #RADIUM_MONITOR_ID_INCLUDE_INF=no // Force that the inf in not included.
100 #RADIUM_MONITOR_ID_INCLUDE_INF="rad8" // Specify the specific inf for this radium.
101
102
103 # If compiled to support this option, Radium is capable of
104 # generating a lot of debug information.
105 #
106 # The default value is zero (0).
107 #
108 # Commandline equivalent -D
109 #
110
111 #RADIUM_DEBUG_LEVEL=0
112
113
114 # Radium will periodically report on a its own health, providing
115 # interface status, total packet and bytes counts, packet drop
116 # rates, and flow oriented statistics.
117 #
118 # These records can be used as "keep alives" for periods when
119 # there is no network traffic to be monitored.
120 #
121 # The default value is 60 seconds, but a value of 60 seconds is
122 # very common.
123 #
124 # Commandline equivalent -M
125 #
126
127 RADIUM_MAR_STATUS_INTERVAL=60
128
129
130 #
131 # Radium can attach to any number of remote argus data sources,
132 # argi or radii. The syntax for this variable is a URI that
133 # specifies the URI schema, with transport, the hostname or a
134 # dot notation IP address, followed by an optional port value,
135 # separated by a ':'. If the URI format is not specified,
136 # the URI schema and transport mechanism are the default, argus://
137 # If the port is not specified, the default value of 561 is used.
138 #
139 # Commandline equivalent -S <argus://host[:port]>
140 # Commandline equivalent -S <argus-tcp://host[:port]>
141 # Commandline equivalent -S <argus-udp://host[:port]>
142 # Commandline equivalent -S <cisco://host[:port]>
143 # Commandline equivalent -S <host[:port]>
144 #
145
146 #RADIUM_ARGUS_SERVER=amon:12345
147 #RADIUM_ARGUS_SERVER=argus://amon:561
148 #RADIUM_ARGUS_SERVER=argus-tcp://thoth
149 #RADIUM_ARGUS_SERVER=argus-udp://apophis:562
150 #RADIUM_ARGUS_SERVER=cisco://192.168.0.4:9699
151
152
153 # You can provide a filter expression here, if you like.
154 # Radium will filter all input records based on this definition.
155 # It should be limited to 2K in length. The default is to
156 # not filter.
157 #
158 # No Commandline equivalent
159 #
160
161 #RADIUM_FILTER=""
162
163
164 # Radium can adjust the timestamps in radium records as it receives
165 # them, based on the measured time difference between radium()
166 # and the sources. The variable takes a threshold value in
167 # seconds, so you can specify when to make a correction.
168 #
169 # No Commandline equivalent
170 #
171
172 #RADIUM_ADJUST_TIME=5
173
174
175 # Radium has filter capabilities that use a filter optimizer.
176 # If there is a need to not use this filter optimizer,
177 # you can turn it off here. The default is to leave it on.
178 #
179 # Commandline equivalent -O
180 #
181
182 #RADIUM_FILTER_OPTIMIZER=yes
183
184
185 # Radium can read Cicso Netflow records directly from Cisco
186 # routers. Specifying this value will alert Radium to open
187 # a UDP based socket listening for data from this name or address.
188 #
189 # Commandline equivalent -C
190 #
191
192 #RADIUM_CISCONETFLOW_PORT=9996
193
194
195 # When radium is compiled with SASL support, radium may be
196 # required to authenticate to the radium data source before data
197 # can be received. This variable will allow one to
198 # set the user and authorization id's, if needed. Although
199 # not recommended you can provide a password through the
200 # RADIUM_AUTH_PASS variable. The format for this variable is:
201 #
202 # RADIUM_USER_AUTH="user_id/authorization_id"
203 #
204 # Commandline equivalent -U
205 #
206
207 #RADIUM_USER_AUTH="user/auth"
208 #RADIUM_AUTH_PASS="password"
209
210
211 # Radium monitors can provide a real-time remote access port
212 # for other programs to collect Radium data. This is a TCP based
213 # port service and the default port number is tcp/561, the
214 # "experimental monitor" service. This feature is disabled by
215 # default, and can be forced off by setting it to zero (0).
216 #
217 # When you do want to enable this service, 561 is a good choice,
218 # as all ra* clients are configured to try this port by default.
219 #
220 # Commandline equivalent -P
221 #
222
223 #RADIUM_ACCESS_PORT=561
224
225
226 # When remote access is enabled (see above), you can specify that Radium
227 # should bind only to a specific IP address. This is useful, for example,
228 # in restricting access to the local host, or binding to a private
229 # interface while capturing from another. The default is to bind to any
230 # IP address.
231 #
232 # Commandline equivalent -B
233 #
234
235 #RADIUM_BIND_IP=127.0.0.1
236
237
238 #
239 # Radium can write its output to one or a number of files,
240 # default limit is 64 concurrent files, each with their own
241 # independant filters.
242 #
243 # The format is:
244 # RADIUM_OUTPUT_FILE=/full/path/file/name
245 # RADIUM_OUTPUT_FILE=/full/path/file/name "filter"
246 #
247 # Most sites will have radium write to a file, for reliablity
248 # and performance. The example file name used here supports
249 # the archive program ./support/Archive/radiumarchive
250 # which is configured to use this file.
251 #
252 # Commandline equivalent -w
253 #
254
255 #RADIUM_OUTPUT_FILE=/var/log/radium/radium.out
256
257
258
259 # Radium can write its output to one or a number of remote hosts.
260 # The default limit is 5 concurrent output streams, each with their
261 # own independant filters.
262 #
263 # The format is:
264 # RADIUM_OUTPUT_STREAM="URI [filter]"
265 # RADIUM_OUTPUT_STREAN="argus-udp://host:port 'tcp and not udp'"
266 #
267 # Most sites will have argus listen() for remote sites to request
268 # argus data, but for some sites and applications sending records without
269 # registration is desired. This option will cause argus to transmit records
270 # that match the optional filter, to the configured targets using UDP as the
271 # transport mechanism.
272 #
273 # Commandline equivalent -w argus-udp://host:port
274 #
275
276 #RADIUM_OUTPUT_STREAM=argus-udp://224.0.23.40:561
277
278
279
280 # Radium can write multiple versions of argus record format.
281 # You can set the default record format version using this variable.
282 # The default value is the compiled ARGUS_VERSION, in this case ... 5.
283 #
284 # Commandline equivalent none
285 #
286
287 RADIUM_OUTPUT_VERSION=3
288
289 # When converting from V5 to V3, the srcid for imported records may need
290 # to be modified. Use this file to make the substitutions.
291 # This file uses the same format as the ARGUS_ALIAS_FILE.
292
293 RADIUM_SRCID_CONVERSION_FILE=/usr/local/argus/srcid.v5.v3.map.txt
294
295
296
297 # Radium supports chroot(2) in order to control the file system that
298 # radium exists in and can access. Generally used when radium is running
299 # with privleges, this limits the negative impacts that radium could
300 # inflict on its host machine.
301 #
302 # This option will cause the output file names to be relative to this
303 # directory, and so consider this when trying to find your output files.
304 #
305 # Commandline equivalent -C
306 #
307
308 #RADIUM_CHROOT_DIR="/tmp"
309
310
311 # Radium can be directed to change its user id using the setuid() system
312 # call. This is can used when radium is started as root, in order to
313 # access privleged resources, but then after the resources are opened,
314 # this directive will cause radium to change its user id value to
315 # a 'lesser' capable account. Recommended when radium is running as a
316 # daemon.
317 #
318 # Commandline equivalent -u
319 #
320
321 #RADIUM_SETUSER_ID=user
322
323
324 # Radium can be directed to change its group id using the setgid() system
325 # call. This is can used when radium is started as root, in order to
326 # access privleged resources, but then after the resources are opened,
327 # this directive can be used to change argu's group id value to
328 # a 'lesser' capable account. Recommended when radium is running as a
329 # daemon.
330 #
331 # Commandline equivalent -g
332 #
333
334 #RADIUM_SETGROUP_ID=group
335
336
337 #
338 # Data transformation/processing is done on the complete set
339 # of input records, and all output from this radium node is
340 # transformed. This makes cataloging and tracking the
341 # transformational nodes a bit easier.
342 #
343 # This example enables data classification/labeling.
344 # This function is enabled with a single radium configuration
345 # keyword RADIUM_CLASSIFIER, and then a ralabel() configuration
346 # file is provided.
347 #
348 # Commandline equivalent none
349
350 #RADIUM_CLASSIFIER_FILE=/usr/local/argus/ralabel.conf
351
352
353 #
354 # Radium can advertise its port availability using Bonjour / mDns
355 # if the system supports it.
356 #
357 # Commandline equivalent -M zeroconf
358
359 #RADIUM_ZEROCONF_REGISTER=yes
360
361 #
362 # Optionally disable SASL authentication for localhost
363 #
364 #RADIUM_AUTH_LOCALHOST=yes