argus-clients-radium.conf

   1 #
   2 #  Argus Software
   3 #  Copyright (c) 2000-2007 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 $ARGUSPATH, or $ARGUSHOME, $ARGUSHOME/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 Radium Data from multiple monitors at the
  63 # same time.  The ID is 32 bits long, and so legitimate values are
  64 # 0 - 4294967296 but radium also supports IP addresses as values.
  65 # The configuration allows for you to use host names, however, do
  66 # have some understanding how `hostname` will be resolved by the
  67 # nameserver before commiting to this strategy completely.
  68 #
  69 # Commandline equivalent   -e
  70 #
  71
  72 RADIUM_MONITOR_ID=`hostname`
  73
  74
  75 # If compiled to support this option, Radium is capable of
  76 # generating a lot of debug information.
  77 #
  78 # The default value is zero (0).
  79 #
  80 # Commandline equivalent   -D
  81 #
  82
  83 #RADIUM_DEBUG_LEVEL=0
  84
  85
  86 # Radium will periodically report on a its own health, providing
  87 # interface status, total packet and bytes counts, packet drop
  88 # rates, and flow oriented statistics.
  89 #
  90 # These records can be used as "keep alives" for periods when
  91 # there is no network traffic to be monitored.
  92 #
  93 # The default value is 60 seconds, but a value of 60 seconds is
  94 # very common.
  95 #
  96 # Commandline equivalent   -M
  97 #
  98
  99 RADIUM_MAR_STATUS_INTERVAL=60
 100
 101
 102 #
 103 # Radium can attach to any number of remote argus servers, and
 104 # collect argus data in real time.  The syntax for this variable
 105 # is a hostname or a dot notation IP address, followed by an
 106 # optional port value, separated by a ':'.  If the port is not
 107 # specified, the default value of 561 is used.
 108 #
 109 # Commandline equivalent   -S <host[:port]>
 110 #
 111
 112 #RADIUM_ARGUS_SERVER=amon:12345
 113 #RADIUM_ARGUS_SERVER=thoth:561
 114 #RADIUM_ARGUS_SERVER=apophis:562
 115 #RADIUM_ARGUS_SERVER=otherhost:50000
 116
 117
 118 # You can provide a filter expression here, if you like.
 119 # Radium will filter all input records based on this definition.
 120 # It should be limited to 2K in length.  The default is to
 121 # not filter.
 122 #
 123 # No Commandline equivalent
 124 #
 125
 126 #RADIUM_FILTER=""
 127
 128
 129 # Radium can adjust the timestamps in argus records as it receives
 130 # them, based on the measured time difference between radium()
 131 # and the sources.  The variable takes a threshold value in
 132 # seconds, so you can specify when to make a correction.
 133 #
 134 # No Commandline equivalent
 135 #
 136
 137 #RADIUM_ADJUST_TIME=5
 138
 139
 140 # Radium has filter capabilities that use a filter optimizer.
 141 # If there is a need to not use this filter optimizer,
 142 # you can turn it off here.  The default is to leave it on.
 143 #
 144 # Commandline equivalent   -O
 145 #
 146
 147 #RADIUM_FILTER_OPTIMIZER=yes
 148
 149
 150 # Radium can read Cicso Netflow records directly from Cisco
 151 # routers.  Specifying this value will alert Radium to open
 152 # a UDP based socket listening for data from this name or address.
 153 #
 154 # Commandline equivalent   -C
 155 #
 156
 157 #RADIUM_CISCONETFLOW_PORT=9996
 158
 159
 160 # When argus is compiled with SASL support, radium may be
 161 # required to authenticate to the argus data source before data
 162 # can be received.  This variable will allow one to
 163 # set the user and authorization id's, if needed.  Although
 164 # not recommended you can provide a password through the
 165 # RADIUM_AUTH_PASS variable.  The format for this variable is:
 166 #
 167 # RADIUM_USER_AUTH="user_id/authorization_id"
 168 #
 169 # Commandline equivalent   -U
 170 #
 171
 172 #RADIUM_USER_AUTH=""
 173 #RADIUM_AUTH_PASS=""
 174
 175
 176 # Radium monitors can provide a real-time remote access port
 177 # for other programs to collect Radium data.  This is a TCP based
 178 # port service and the default port number is tcp/561, the
 179 # "experimental monitor" service.  This feature is disabled by
 180 # default, and can be forced off by setting it to zero (0).
 181 #
 182 # When you do want to enable this service, 561 is a good choice,
 183 # as all ra* clients are configured to try this port by default.
 184 #
 185 # Commandline equivalent   -P
 186 #
 187
 188 RADIUM_ACCESS_PORT=561
 189
 190
 191 #
 192 # Radium can write its output to one or a number of files,
 193 # default limit is 64 concurrent files, each with their own
 194 # independant filters.
 195 #
 196 # The format is:
 197 #      RADIUM_OUTPUT_FILE=/full/path/file/name
 198 #      RADIUM_OUTPUT_FILE=/full/path/file/name "filter"
 199 #
 200 # Most sites will have radium write to a file, for reliablity
 201 # and performance.  The example file name used here supports
 202 # the archive program ./support/Archive/argusarchive
 203 # which is  configured to use this file.
 204 #
 205 # Commandline equivalent   -w
 206 #
 207
 208 #RADIUM_OUTPUT_FILE=/var/log/argus/argus.out
 209