Content-type: text/html
<HTML><HEAD><TITLE>Manpage of RARC</TITLE>
</HEAD><BODY>
<H1>RARC</H1>
Section: User Commands (1)<BR>Updated: 07 November 2000<BR><A HREF="#index">Index</A>
<A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB"> </A>
<H2>NAME</H2>
<B>rarc</B> - <B>ra</B> client resource file.
<A NAME="lbAC"> </A>
<H2>SYNOPSIS</H2>
<B>rarc</B>
<A NAME="lbAD"> </A>
<H2>COPYRIGHT</H2>
Copyright (c) 2000 QoSient, LLC All rights reserved.
<A NAME="lbAE"> </A>
<H2>DESCRIPTION</H2>
Ra* clients will open this file if its in the users $HOME directory,
or in the $ARGUSHOME directory, and parse it to set common configuration
options. All of these values will be overriden by options set on the
command line, or in the file specified using the '-F conffile' option.
<P>
Values can be quoted to make string denotation easier, however, the
parser does not require that string values be quoted. To support this,
the parse will remove " (double quote) characters from input strings, so
do not use this character in strings themselves.
<P>
Values specified as "" will be treated as a NULL string, and the parser
will ignore the variable setting.
<P>
<A NAME="lbAF"> </A>
<H2>RA_ARGUS_SERVER</H2>
All ra* clients can attach to a remote server, and collect argus data
in real time. This variable can be a name or a dot notation IP address.
<P>
<B>RA_ARGUS_SERVER=</B>localhost
<P>
<A NAME="lbAG"> </A>
<H2>RA_CISCONETFLOW_SERVER</H2>
<P>
All ra* clients can read Cisco Netflow records directly from Cisco
routers. Specifying this value will alert the ra* client to open
a UDP based socket listening for Cisco Netflow data.
<P>
<B>RA_CISCONETFLOW_SERVER=</B>no
<P>
<A NAME="lbAH"> </A>
<H2>RA_ARGUS_SERVERPORT</H2>
<P>
Whether the remote data source is an Argus Server or a Cisco router,
the port number that will be used to bind to is specified using this
variable. For Argus Servers, the default is 561, the "experimental
monitor" port. For Cisco Netflow records, the default is 9995.
<P>
<B>RA_ARGUS_SERVERPORT=</B>561
<P>
<P>
<P>
<A NAME="lbAI"> </A>
<H2>RA_OUTPUT_FILE</H2>
All ra* clients can support writing output as Argus Records into
a file or stdout. Stdout is specified as '-'.
<P>
<B>RA_OUTPUT_FILE=</B>"filename"
<P>
<A NAME="lbAJ"> </A>
<H2>RA_TIMERANGE</H2>
All ra* clients can support input filtering on a time range. The
format is:
<PRE>
<B>timeSpecification[-timeSpecification]</B>
where the format of a timeSpecification can be:
[[[yy/]mm/]dd.]hh[:mm[:ss]]
[yy/]mm/dd
<B>RA_TIMERANGE=</B>"55/12/04.00:00:01-55/12/04.23:59:59"
<B>RA_TIMERANGE=</B>"12/04-12/05"
</PRE>
<P>
<P>
<A NAME="lbAK"> </A>
<H2>RA_RUN_TIME</H2>
<P>
All ra* clients can support running for a number of seconds,
while attached to a remote source of argus data. This is a type
of polling. The default is zero (0), which means run indefinately.
<P>
<B>RA_RUN_TIME</B>=0
<P>
<P>
<A NAME="lbAL"> </A>
<H2>RA_PRINT_LABELS</H2>
<P>
Most ra* clients are designed to print argus records out in ASCII,
with each client supporting its own output formats. For ra() like
clients, this variable will generate column headers as labels.
The number is the number of lines between repeated header labeling.
Setting this value to zero (0) will cause the labels to be printed
once. If you don't want labels, comment this line out, delete it
or set the value to -1.
<P>
<B>RA_PRINT_LABELS</B>=0
<P>
<P>
<A NAME="lbAM"> </A>
<H2>RA_FIELD_DELIMITER</H2>
<P>
Most ra* clients are designed to print argus records out in ASCII,
with each client supporting its own output formats. For ra() like
clients, this variable can overide the default field delimiter,
which are variable spans of space (' '), to be any character.
The most common are expected to be ' ' for tabs, and ',' for
comma separated fields.
<P>
<B>RA_FIELD_DELIMITER=</B>','
<P>
<P>
<A NAME="lbAN"> </A>
<H2>RA_PRINT_SUMMARY</H2>
<P>
For ra() like clients, this variable will printout summary data
for the client session, at the termination of the program.
<P>
<B>RA_PRINT_SUMMARY=</B>no
<P>
<A NAME="lbAO"> </A>
<H2>RA_PRINT_ARGUSID</H2>
<P>
For ra() like clients, this variable will printout the Argus ID
that generated the flow record.
<P>
<B>RA_PRINT_ARGUSID=</B>no
<P>
<A NAME="lbAP"> </A>
<H2>RA_PRINT_MACADDR</H2>
<P>
For ra() like clients, this variable will printout the MAC
addresses involved in the flow record, if the MAC address
information is available.
<P>
<B>RA_PRINT_MACADDRS=</B>no
<BR>
<P>
<A NAME="lbAQ"> </A>
<H2>RA_PRINT_INDICATORS</H2>
<P>
For ra() like clients, this variable will print the extended
state and protocol indicators.
<P>
<B>RA_PRINT_INDICATORS=</B>yes
<P>
<A NAME="lbAR"> </A>
<H2>RA_PRINT_HOSTNAMES</H2>
<P>
For <B><A HREF="http://localhost/cgi-bin/man/man2html?1+ra">ra</A>(1)</B> like clients, this variable will suppress resolving
hostnames, and print the dot notation IP address, or ':' notation
ethernet address. There is a huge performance impact with
name lookup, so the default is to not resolve hostnames.
<P>
<B>RA_PRINT_HOSTNAMES=</B>no
<P>
When you intend to print hostnames and port service names
rather than the numbers, these variables will help to
avoid truncating of hostnames, and provide pretty printing
with tools such as <B><A HREF="http://localhost/cgi-bin/man/man2html?1+ra">ra</A>(1)</B>, <B><A HREF="http://localhost/cgi-bin/man/man2html?1+ragator">ragator</A>(1)</B> and <B><A HREF="http://localhost/cgi-bin/man/man2html?1+rasort">rasort</A>(1)</B>.
<P>
These values are simple suggestions.
<PRE>
<B>RA_HOST_FIELD_LENGTH=</B>28
<B>RA_PORT_FIELD_LENGTH=</B>10
</PRE>
<P>
<A NAME="lbAS"> </A>
<H2>RA_PRINT_COUNTS</H2>
<P>
For ra() like clients, this variable will include the packet and
byte counts in the output format.
<P>
<B>RA_PRINT_COUNTS=</B>yes
<P>
<A NAME="lbAT"> </A>
<H2>RA_PRINT_RESPONSE_DATA</H2>
<P>
For ra() like clients, this variable will include the response
data that is provided by Argus. This is protocol and state
specific.
<P>
<B>RA_PRINT_RESPONSE_DATA=</B>no
<P>
<A NAME="lbAU"> </A>
<H2>RA_PRINT_UNIX_TIME</H2>
<P>
For ra() like clients, this variable will force the timestamp
to be in Unix time format, which is an integer representing the
number of elapsed seconds since the epoch.
<P>
<B>RA_PRINT_UNIX_TIME</B>=no
<P>
<A NAME="lbAV"> </A>
<H2>RA_TIME_FORMAT</H2>
<P>
For ra() like clients, this variable is used to override the
time format of the timestamp. This string must conform to
the format specified in strftime(). Malformed strings can
generate fatal errors, so be careful with this one.
<P>
<B>RA_TIME_FORMAT=</B>"%y-%m-%d %T"
<P>
<A NAME="lbAW"> </A>
<H2>RA_PRINT_STARTIME</H2>
<P>
For ra() like clients, this variable is used to override the
time format of the timestamp. This determines if the
transaction start time will be displayed or not.
<P>
<B>RA_PRINT_STARTIME=</B>yes
<P>
<A NAME="lbAX"> </A>
<H2>RA_PRINT_LASTIME</H2>
<P>
For ra() like clients, this variable is used to override the
time format of the timestamp. This determines if the
transaction last time will be displayed or not.
<P>
<B>RA_PRINT_LASTIME=</B>no
<P>
<A NAME="lbAY"> </A>
<H2>RA_PRINT_DURATION</H2>
<P>
For ra() like clients, this variable is used to override the
time format of the timestamp. This variable determines if
the transaction duration time will be printed or not.
<P>
<B>RA_PRINT_DURATION=</B>yes
<P>
<A NAME="lbAZ"> </A>
<H2>RA_USEC_PRECISION</H2>
<P>
For ra() like clients, this variable is used to override the
time format of the timestamp. This variable specifies the
number of decimal places that will be printed as the fractional
part of the time. Argus collects usec precision, and so a
maximum value of 6 is supported. To not print the fractional
part, specify the value zero (0).
<P>
<B>RA_USEC_PRECISION=</B>6
<P>
<P>
<A NAME="lbBA"> </A>
<H2>RA_USERDATA_ENCODE</H2>
<P>
Argus can capture user data. When printing out the user data
contents, using tools such as raxml(), the type of encoding
can be specified here. Supported values are "Ascii", or "Encode64".
<P>
<B>RA_USERDATA_ENCODE=</B>Ascii
<P>
<A NAME="lbBB"> </A>
<H2>RA_DEBUG_LEVEL</H2>
<P>
If compiled to support this option, ra* clients are capable
of generating a lot of use [full | less | whatever] debug
information. The default value is zero (0).
<P>
<B>RA_DEBUG_LEVEL=</B>0
<P>
<A NAME="lbBC"> </A>
<H2>RA_FILTER</H2>
<P>
You can provide a filter expression here, if you like.
It should be limited to 2K in length. The default is to
not filter. See <A HREF="http://localhost/cgi-bin/man/man2html?1+ra">ra</A>(1) for the format of the filter expression.
<P>
<B>RA_FILTER=</B>""
<P>
<A NAME="lbBD"> </A>
<H2>SASL SUPPPORT</H2>
When argus is compiled with SASL support, ra* clients may be
required to authenticate to the argus server before the argus
will accept the connection. This variable will allow one to
set the user and authorization id's, if needed. Although
not recommended you can provide a password through the
RA_AUTH_PASS variable. The format for this variable is:
<BR>
<PRE>
<B>RA_USER_AUTH=</B>"user_id/authorization_id"
<B>RA_AUTH_PASS=</B>"password"
</PRE>
<P>
<A NAME="lbBE"> </A>
<H2>SEE ALSO</H2>
<B><A HREF="http://localhost/cgi-bin/man/man2html?1+ra">ra</A></B>(1)
<P>
<P>
<P>
<HR>
<A NAME="index"> </A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">COPYRIGHT</A><DD>
<DT><A HREF="#lbAE">DESCRIPTION</A><DD>
<DT><A HREF="#lbAF">RA_ARGUS_SERVER</A><DD>
<DT><A HREF="#lbAG">RA_CISCONETFLOW_SERVER</A><DD>
<DT><A HREF="#lbAH">RA_ARGUS_SERVERPORT</A><DD>
<DT><A HREF="#lbAI">RA_OUTPUT_FILE</A><DD>
<DT><A HREF="#lbAJ">RA_TIMERANGE</A><DD>
<DT><A HREF="#lbAK">RA_RUN_TIME</A><DD>
<DT><A HREF="#lbAL">RA_PRINT_LABELS</A><DD>
<DT><A HREF="#lbAM">RA_FIELD_DELIMITER</A><DD>
<DT><A HREF="#lbAN">RA_PRINT_SUMMARY</A><DD>
<DT><A HREF="#lbAO">RA_PRINT_ARGUSID</A><DD>
<DT><A HREF="#lbAP">RA_PRINT_MACADDR</A><DD>
<DT><A HREF="#lbAQ">RA_PRINT_INDICATORS</A><DD>
<DT><A HREF="#lbAR">RA_PRINT_HOSTNAMES</A><DD>
<DT><A HREF="#lbAS">RA_PRINT_COUNTS</A><DD>
<DT><A HREF="#lbAT">RA_PRINT_RESPONSE_DATA</A><DD>
<DT><A HREF="#lbAU">RA_PRINT_UNIX_TIME</A><DD>
<DT><A HREF="#lbAV">RA_TIME_FORMAT</A><DD>
<DT><A HREF="#lbAW">RA_PRINT_STARTIME</A><DD>
<DT><A HREF="#lbAX">RA_PRINT_LASTIME</A><DD>
<DT><A HREF="#lbAY">RA_PRINT_DURATION</A><DD>
<DT><A HREF="#lbAZ">RA_USEC_PRECISION</A><DD>
<DT><A HREF="#lbBA">RA_USERDATA_ENCODE</A><DD>
<DT><A HREF="#lbBB">RA_DEBUG_LEVEL</A><DD>
<DT><A HREF="#lbBC">RA_FILTER</A><DD>
<DT><A HREF="#lbBD">SASL SUPPPORT</A><DD>
<DT><A HREF="#lbBE">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 23:40:57 GMT, March 15, 2001
</BODY>
</HTML>
distrib
>
Fedora
>
13
>
i386
>
media
>
os
>
by-pkgid
>
3d5150bad1cfbac98406a6ada6605c44
>
files
>
40
