File: snmp_app.html

package info (click to toggle)
erlang-doc-html 1%3A11.b.2-1
links: PTS
area: main
in suites: etch, etch-m68k
size: 23,284 kB
ctags: 10,724
sloc: erlang: 505; ansic: 323; makefile: 62; perl: 61; sh: 45
file content (1064 lines) | stat: -rw-r--r-- 23,830 bytes
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
  <TITLE>snmp</TITLE>
  <SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
  <STYLE TYPE="text/css">
<!--
    .REFBODY     { margin-left: 13mm }
    .REFTYPES    { margin-left: 8mm }
-->
  </STYLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
      ALINK="#FF0000">
<!-- refpage -->
<CENTER>
<A HREF="http://www.erlang.se">
  <IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif">
</A>
<H1>snmp</H1>
</CENTER>

<H3>APPLICATION</H3>
<DIV CLASS=REFBODY>
snmp
</DIV>

<H3>APPLICATION SUMMARY</H3>
<DIV CLASS=REFBODY>
The SNMP Application
</DIV>

<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>

<P>This chapter describes the <CODE>snmp</CODE>
application in OTP. The SNMP application provides the following
services:

<P>
<UL>

<LI>
a multilingual extensible SNMP agent
<BR>

</LI>


<LI>
a SNMP manager
<BR>

</LI>


<LI>
a MIB compiler
<BR>

</LI>


</UL>

</DIV>

<H3>Configuration</H3>
<DIV CLASS=REFBODY>

<P>The following configuration parameters are defined for the SNMP
application. Refer to application(3) for more information about
configuration parameters.



<P>A minimal config file for starting a node with both a manager 
and an agent:

<PRE>
      [{snmp, 
        [{agent, [{db_dir, &#34;/tmp/snmp/agent/db&#34;},
                  {config, [{dir, &#34;/tmp/snmp/agent/conf&#34;}]}]},
         {manager, [{config, [{dir, &#34;/tmp/snmp/manager/conf&#34;},
                              {db_dir, &#34;/tmp/snmp/manager/db&#34;}]}]}]}
        ]
       }
      ].
    
</PRE>

<P>
<DL>

<DT>
<CODE>agent = [agent_opt()]</CODE>
</DT>

<DD>
        <CODE>agent_opt() = {restart_type, restart_type()} |
{agent_type, agent_type()} | 
         {agent_verbosity, verbosity()} | 
         {versions, versions()} | 
         {priority, priority()} | 
         {multi_threaded, multi_threaded()} | 
         {db_dir, db_dir()} | 
         {db_init_error, db_init_error()} | 
         {local_db, local_db()} | 
         {net_if, agent_net_if()} | 
         {mibs, mibs()} | 
         {mib_storage, mib_storage()} | 
         {mib_server, mib_server()} | 
         {audit_trail_log, audit_trail_log()} | 
         {error_report_mod, error_report_mod()} | 
         {note_store, note_store()} | 
         {symbolic_store, symbolic_store()} | 
         {config, agent_config()}</CODE><BR>

        The SNMP agent specific options.<BR>


</DD>

<DT>
<CODE>manager = [manager_opt()]</CODE>
</DT>

<DD>
        <CODE>manager_opt() = {restart_type, restart_type()} |
{net_if, manager_net_if()} | 
         {server, server()} |
         {note_store, note_store()} |
         {config, manager_config()} | 
         {inform_request_behaviour, manager_irb()} |
         {mibs, manager_mibs()} |
         {priority, priority()} | 
         {audit_trail_log, audit_trail_log()} |
         {versions, versions()} |
         {def_user_module, def_user_module() |
         {def_user_data, def_user_data()}
         </CODE><BR>

        The SNMP manager specific options.<BR>


</DD>

</DL>

<P>Agent specific config options and types:

<P>
<DL>

<DT>
<CODE>agent_type() = master | sub &#60;optional&#62;</CODE>
</DT>

<DD>
        If <CODE>master</CODE>, one master agent is
         started. Otherwise, no agents are started. <BR>

        Default is <CODE>master</CODE>.<BR>


</DD>

<DT>
<CODE>multi_threaded() = bool() &#60;optional&#62;</CODE>
</DT>

<DD>
        If <CODE>true</CODE>, the agent is multi-threaded, with one
         thread for each get request. <BR>

        Default is <CODE>false</CODE>.<BR>


</DD>

<DT>
<CODE>db_dir() = string() &#60;mandatory&#62;</CODE>
</DT>

<DD>
        Defines where the SNMP agent internal db files are stored.<BR>


</DD>

<DT>
<CODE>local_db() = [local_db_opt()] &#60;optional&#62;</CODE>
</DT>

<DD>
        <CODE>local_db_opt() = {repair, agent_repair()} |
         {auto_save, agent_auto_save()} | 
         {verbosity, verbosity()}</CODE><BR>

        Defines options specific for the SNMP agent local database.<BR>

        For defaults see the options in <CODE>local_db_opt()</CODE>.<BR>


</DD>

<DT>
<CODE>agent_repair() = false | true | force &#60;optional&#62;</CODE>
</DT>

<DD>
        When starting snmpa_local_db it always tries to open an
         existing database. If <CODE>false</CODE>, and some errors occur, a new
         database is created instead. If <CODE>true</CODE>, an existing file
         will be repaired. If <CODE>force</CODE>, the table will be repaired
         even if it was properly closed. <BR>

        Default is <CODE>true</CODE>.<BR>


</DD>

<DT>
<CODE>agent_auto_save() = integer() | infinity &#60;optional&#62;</CODE>
</DT>

<DD>
        The auto save interval. The table is flushed to disk
         whenever not accessed for this amount of time.<BR>

        Default is <CODE>5000</CODE>.<BR>


</DD>

<DT>
<CODE>agent_net_if() = [agent_net_if_opt()] &#60;optional&#62;</CODE>
</DT>

<DD>
        <CODE>agent_net_if_opt() = {module, agent_net_if_module()} | 
         {verbosity, verbosity()} | 
         {options, agent_net_if_options()}</CODE><BR>

        Defines options specific for the SNMP agent network interface 
         entity. <BR>

        For defaults see the options in <CODE>agent_net_if_opt()</CODE>.<BR>


</DD>

<DT>
<CODE>agent_net_if_module() = atom() &#60;optional&#62;</CODE>
</DT>

<DD>
        Module which handles the network interface part for the
         SNMP agent. Must implement the 
         <A HREF="snmpa_network_interface.html">snmpa_network_interface
         </A> behaviour.<BR>

        Default is <CODE>snmpa_net_if</CODE>.<BR>


</DD>

<DT>
<CODE>agent_net_if_options() = [agent_net_if_option()] &#60;optional&#62;</CODE>
</DT>

<DD>
        <CODE>agent_net_if_option() = {bind_to, bind_to()} | 
         {sndbuf, sndbuf()} | 
         {recbuf, recbuf()} | 
         {no_reuse, no_reuse()} | 
         {req_limit, req_limit()}</CODE><BR>

        These options are actually specific to the used module.
         The ones shown here are applicable to the default 
         <CODE>agent_net_if_module()</CODE>.<BR>

        For defaults see the options in <CODE>agent_net_if_option()</CODE>.<BR>


</DD>

<DT>
<CODE>req_limit() = integer() | infinity &#60;optional&#62;</CODE>
</DT>

<DD>
        Max number of simultanious requests handled by the agent.<BR>

        Default is <CODE>infinity</CODE>.<BR>


</DD>

<DT>
<CODE>agent_mibs() = [string()] &#60;optional&#62;</CODE>
</DT>

<DD>
        Specifies a list of MIBs (including path) that defines which MIBs
         are initially loaded into the SNMP master agent. <BR>

        Note that the following mibs will allways be loaded:<BR>

        
<UL>

<LI>
         version v1: <CODE>STANDARD-MIB</CODE>
         
</LI>


<LI>
         version v2: <CODE>SNMPv2</CODE>
         
</LI>


<LI>
         version v3: <CODE>SNMPv2</CODE>, <CODE>SNMP-FRAMEWORK-MIB</CODE> 
         and <CODE>SNMP-MPD-MIB</CODE>
         
</LI>


</UL>

        Default is <CODE>[]</CODE>.<BR>


</DD>

<DT>
<CODE>mib_storage() = ets | {ets, Dir} | {ets, Dir, Action} | dets | {dets, Dir} | {dets, Dir, Action} | mnesia | {mnesia, Nodes} | {mnesia, Nodes, Action} &#60;optional&#62;</CODE>
</DT>

<DD>
        Specifies how info retrieved from the mibs will be stored.<BR>

        If <CODE>mib_storage</CODE> is <CODE>{ets, Dir}</CODE>, the table will also be 
stored on file. If <CODE>Dir</CODE> is <CODE>default</CODE>, then <CODE>db_dir</CODE> 
will be used.<BR>

        If <CODE>mib_storage</CODE> is <CODE>dets</CODE> or if <CODE>Dir</CODE> is 
<CODE>default</CODE>, then <CODE>db_dir</CODE> will be used for <CODE>Dir</CODE>.<BR>

        If <CODE>mib_storage</CODE> is <CODE>mnesia</CODE> then <CODE>erlang:nodes()</CODE>
will be used for <CODE>Nodes</CODE>.<BR>

        Default is <CODE>ets</CODE>. <BR>

        <CODE>Dir = default | string()</CODE>. Dir is the directory where the 
files will be stored. If <CODE>default</CODE>, then <CODE>db_dir</CODE> will be 
used.<BR>

        <CODE>Nodes = visible | connected | [node()]</CODE>. 
<CODE>Nodes = visible</CODE> is translated to 
<CODE>erlang:nodes(visible)</CODE>. 
<CODE>Nodes = connected</CODE> is translated to 
<CODE>erlang:nodes(connected)</CODE>. 
If <CODE>Nodes = []</CODE> then the own node is assumed.<BR>

        <CODE>Action = clear | keep</CODE>. Default is <CODE>keep</CODE>.
         <CODE>Action</CODE> is used to specify what shall be done if the 
mnesia/dets table already exist.<BR>


</DD>

<DT>
<CODE>mib_server() = [mib_server_opt()] &#60;optional&#62;</CODE>
</DT>

<DD>
        <CODE>mib_server_opt() = {mibentry_override, mibentry_override()} | 
         {trapentry_override, trapentry_override()} | 
         {verbosity, verbosity()}</CODE><BR>

        Defines options specific for the SNMP agent mib server. <BR>

        For defaults see the options in <CODE>mib_server_opt()</CODE>.<BR>


</DD>

<DT>
<CODE>mibentry_override() = bool() &#60;optional&#62;</CODE>
</DT>

<DD>
        If this value is false, then when loading a mib each mib-
         entry is checked prior to installation of the mib. 
         The perpose of the check is to prevent that the same symbolic 
         mibentry name is used for different oid's.<BR>

        Default is <CODE>false</CODE>.<BR>


</DD>

<DT>
<CODE>trapentry_override() = bool() &#60;optional&#62;</CODE>
</DT>

<DD>
        If this value is false, then when loading a mib each trap
         is checked prior to installation of the mib. 
         The perpose of the check is to prevent that the same symbolic 
         trap name is used for different trap's.<BR>

        Default is <CODE>false</CODE>.<BR>


</DD>

<DT>
<CODE>error_report_mod() = atom() &#60;optional&#62;</CODE>
</DT>

<DD>
        Defines an error report module, implementing the 
         <A HREF="snmpa_error_report.html">snmpa_error_report</A> 
         behaviour. Two modules are provided with the toolkit: 
         <CODE>snmpa_error_logger</CODE> and <CODE>snmpa_error_io</CODE>.<BR>

        Default is <CODE>snmpa_error_logger</CODE>.<BR>


</DD>

<DT>
<CODE>symbolic_store() = [symbolic_store_opt()]</CODE>
</DT>

<DD>
        <CODE>symbolic_store_opt() = {verbosity, verbosity()}</CODE><BR>

        Defines options specific for the SNMP agent symbolic store. <BR>

        For defaults see the options in <CODE>symbolic_store_opt()</CODE>.<BR>


</DD>

<DT>
<CODE>agent_config() = [agent_config_opt()] &#60;mandatory&#62;</CODE>
</DT>

<DD>
        <CODE>agent_config_opt() = {dir, agent_config_dir()} | 
         {force_load, force_load()} | {verbosity, verbosity()}</CODE><BR>

        Defines specific config related options for the SNMP agent. <BR>

        For defaults see the options in <CODE>agent_config_opt()</CODE>.<BR>


</DD>

<DT>
<CODE>agent_config_dir = dir() &#60;mandatory&#62;</CODE>
</DT>

<DD>
        Defines where the SNMP agent configuration files are stored.<BR>


</DD>

<DT>
<CODE>force_load() = bool() &#60;optional&#62;</CODE>
</DT>

<DD>
        If <CODE>true</CODE> the configuration files are re-read
         during startup, and the contents of the configuration 
         database ignored. Thus, if <CODE>true</CODE>, changes to 
         the configuration database are lost upon reboot of the 
         agent. <BR>

        Default is <CODE>false</CODE>.<BR>


</DD>

</DL>

<P>Manager specific config options and types:

<P>
<DL>

<DT>
<CODE>server() = [server_opt()] &#60;optional&#62;</CODE>
</DT>

<DD>
        <CODE>server_opt() = {timeout, server_timeout()} | 
         {verbosity, verbosity()}</CODE><BR>

        Specifies the options for the manager server process.<BR>

        Default is <CODE>silence</CODE>.<BR>


</DD>

<DT>
<CODE>server_timeout() = integer() &#60;optional&#62;</CODE>
</DT>

<DD>
        Asynchroneous request cleanup time. For every requests, 
         some info is stored internally, in order to be able to 
         deliver the reply (when it arrives) to the proper destination.
         If the reply arrives, this info will be deleted. But if
         there is no relpy (in time), the info has to be deleted
         after the <STRONG>best before</STRONG> time has been passed.
         This cleanup will be performed at regular intervals, defined 
         by the <CODE>server_timeout()</CODE> time.
         The information will have an <STRONG>best before</STRONG> time,
         defined by the <CODE>Expire</CODE> time given when calling the
         request function (see <A HREF="snmpm.html#ag">ag</A>,
         <A HREF="snmpm.html#agn">agn</A> and 
         <A HREF="snmpm.html#as">as</A>).<BR>

        Time in milli-seconds.<BR>

        Default is <CODE>30000</CODE>.<BR>


</DD>

<DT>
<CODE>manager_config() = [manager_config_opt()] &#60;mandatory&#62;</CODE>
</DT>

<DD>
        <CODE>manager_config_opt() = {dir, manager_config_dir()} | 
         {db_dir, manager_db_dir()} | 
{db_init_error, db_init_error()} | 
{repair, manager_repair()} | 
         {auto_save, manager_auto_save()} | 
{verbosity, verbosity()}</CODE><BR>

        Defines specific config related options for the SNMP manager. <BR>

        For defaults see the options in <CODE>manager_config_opt()</CODE>.<BR>


</DD>

<DT>
<CODE>manager_config_dir = dir() &#60;mandatory&#62;</CODE>
</DT>

<DD>
        Defines where the SNMP manager configuration files are stored.<BR>


</DD>

<DT>
<CODE>manager_db_dir = dir() &#60;mandatory&#62;</CODE>
</DT>

<DD>
        Defines where the SNMP manager store persistent data.<BR>


</DD>

<DT>
<CODE>manager_repair() = false | true | force &#60;optional&#62;</CODE>
</DT>

<DD>
        Defines the repair option for the persistent database (if 
         and how the table is repaired when opened). <BR>

        Default is <CODE>true</CODE>.<BR>


</DD>

<DT>
<CODE>manager_auto_save() = integer() | infinity &#60;optional&#62;</CODE>
</DT>

<DD>
        The auto save interval. The table is flushed to disk
         whenever not accessed for this amount of time.<BR>

        Default is <CODE>5000</CODE>.<BR>


</DD>

<DT>
<CODE>manager_irb() = auto | user | {user, integer()} &#60;optional&#62;</CODE>
</DT>

<DD>
        This option defines how the manager will handle the sending of 
response (acknowledgement) to received inform-requests. <BR>

         
<UL>

<LI>
         <CODE>auto</CODE> - The manager will autonomously send response
(acknowledgement&#62; to inform-request messages.<BR>

         
</LI>


<LI>
         <CODE>{user, integer()}</CODE> - The manager will send response
(acknowledgement) to inform-request messages when the 
<A HREF="snmpm_user.html#handle_inform">handle_inform</A> 
function completes. The integer is the time, in milli-seconds, 
that the manager will consider the stored inform-request info 
valid.<BR>

         
</LI>


<LI>
         <CODE>user</CODE> - Same as <CODE>{user, integer()}</CODE>, except that 
the default time, 15 seconds (15000), is used.<BR>

         
</LI>


</UL>

        See 
<A HREF="snmpm_network_interface.html">snmpm_network_interface
         </A>, 
<A HREF="snmpm_user.html">handle_inform</A> and 
<A HREF="snmp_manager_netif.html">definition of the manager net if
</A> for more info.<BR>

        Default is <CODE>auto</CODE>.<BR>


</DD>

<DT>
<CODE>manager_mibs() = [string()] &#60;optional&#62;</CODE>
</DT>

<DD>
        Specifies a list of MIBs (including path) and defines which MIBs
         are initially loaded into the SNMP manager. <BR>

        Default is <CODE>[]</CODE>.<BR>


</DD>

<DT>
<CODE>manager_net_if() = [manager_net_if_opt()] &#60;optional&#62;</CODE>
</DT>

<DD>
        <CODE>manager_net_if_opt() = {module, manager_net_if_module()} |
         {verbosity, verbosity()} |
         {options, manager_net_if_options()}
         </CODE><BR>

        Defines options specific for the SNMP manager network interface 
         entity. <BR>

        For defaults see the options in <CODE>manager_net_if_opt()</CODE>.<BR>


</DD>

<DT>
<CODE>manager_net_if_options() = [manager_net_if_option()] &#60;optional&#62;</CODE>
</DT>

<DD>
        <CODE>manager_net_if_option() = {bind_to, bind_to()} |
{sndbuf, sndbuf()} | 
{recbuf, recbuf()} |
         {no_reuse, no_reuse()}
         </CODE><BR>

        These options are actually specific to the used module.
         The ones shown here are applicable to the default 
         <CODE>manager_net_if_module()</CODE>.<BR>

        For defaults see the options in <CODE>manager_net_if_option()</CODE>.<BR>


</DD>

<DT>
<CODE>manager_net_if_module() = atom() &#60;optional&#62;</CODE>
</DT>

<DD>
        Module which handles the network interface part for the
         SNMP manager. Must implement the 
         <A HREF="snmpm_network_interface.html">snmpm_network_interface
         </A> behaviour.<BR>

        Default is <CODE>snmpm_net_if</CODE>.<BR>


</DD>

<DT>
<CODE>def_user_module() = atom() &#60;optional&#62;</CODE>
</DT>

<DD>
        The module implementing the default user. See the 
         <A HREF="snmpm_user.html">snmpm_user
         </A> behaviour.<BR>

        Default is <CODE>snmpm_user_default</CODE>.<BR>


</DD>

<DT>
<CODE>def_user_data() = term() &#60;optional&#62;</CODE>
</DT>

<DD>
        Data for the default user. Passed to the user module when 
         calling the callback functions.<BR>

        Default is <CODE>undefined</CODE>.<BR>


</DD>

</DL>

<P>Common config types:

<P>
<DL>

<DT>
<CODE>restart_type() = permanent | transient | temporary</CODE>
</DT>

<DD>
        See <A HREF="javascript:erlhref('../../../../', 'stdlib', 'supervisor.html#child_spec');">supervisor</A> 
documentaion for more info.<BR>

        Default is <CODE>permanent</CODE> for the agent and <CODE>transient</CODE>
for the manager.<BR>


</DD>

<DT>
<CODE>db_init_error() = terminate | create</CODE>
</DT>

<DD>
        Defines what to do if the agent or manager is unable to open an
existing database file. <CODE>terminate</CODE> means that the
agent/manager will terminate and <CODE>create</CODE> means that the 
agent/manager will remove the faulty file(s) and create new ones.<BR>

        Default is <CODE>terminate</CODE>.<BR>


</DD>

<DT>
<CODE>priority() = atom() &#60;optional&#62;</CODE>
</DT>

<DD>
        Defines the Erlang priority for all SNMP processes.<BR>

        Default is <CODE>normal</CODE>.<BR>


</DD>

<DT>
<CODE>versions() = [version()] &#60;optional&#62;</CODE>
</DT>

<DD>
        <CODE>version() = v1 | v2 | v3</CODE><BR>

        Which SNMP versions shall be accepted/used.<BR>

        Default is <CODE>[v1,v2,v3]</CODE>.<BR>


</DD>

<DT>
<CODE>verbosity() = silence | info | log | debug | trace &#60;optional&#62;</CODE>
</DT>

<DD>
        Verbosity for a SNMP process. This specifies now much debug info
         is printed.<BR>

        Default is <CODE>silence</CODE>.<BR>


</DD>

<DT>
<CODE>bind_to() = bool() &#60;optional&#62;</CODE>
</DT>

<DD>
        If <CODE>true</CODE>, net_if binds to the IP adress.
         If <CODE>false</CODE>, net_if listens on any IP address on the host
         where it is running. <BR>

        Default is <CODE>false</CODE>.<BR>


</DD>

<DT>
<CODE>no_reuse() = bool() &#60;optional&#62;</CODE>
</DT>

<DD>
        If <CODE>true</CODE>, net_if does not specify that the IP
         and port address should be reusable. If <CODE>false</CODE>, 
         the address is set to reusable. <BR>

        Default is <CODE>false</CODE>.<BR>


</DD>

<DT>
<CODE>recbuf() = integer() &#60;optional&#62;</CODE>
</DT>

<DD>
        Receive buffer size. <BR>

        Default value is defined by <CODE>gen_udp</CODE>.<BR>


</DD>

<DT>
<CODE>sndbuf() = integer() &#60;optional&#62;</CODE>
</DT>

<DD>
        Send buffer size. <BR>

        Default value is defined by <CODE>gen_udp</CODE>.<BR>


</DD>

<DT>
<CODE>note_store() = [note_store_opt()] &#60;optional&#62;</CODE>
</DT>

<DD>
        <CODE>note_store_opt() = {timeout, note_store_timeout()} | 
         {verbosity, verbosity()}</CODE><BR>

        Specifies the startup verbosity for the SNMP note store.<BR>

        For defaults see the options in <CODE>note_store_opt()</CODE>.<BR>


</DD>

<DT>
<CODE>note_store_timeout() = integer() &#60;optional&#62;</CODE>
</DT>

<DD>
        Note cleanup time. When storing a note in the note store,
         each note is given lifetime. Every <CODE>timeout</CODE> the note_store
         process performs a GC to remove the expired note's. Time in
         milli-seconds.<BR>

        Default is <CODE>30000</CODE>.<BR>


</DD>

<DT>
<CODE>audit_trail_log() = [audit_trail_log_opt()] &#60;optional&#62;</CODE>
</DT>

<DD>
        <CODE>audit_trail_log_opt() = {type, atl_type()} |
         {dir, atl_dir()} | 
         {size, atl_size()} | 
         {repair, atl_repair()}
         </CODE><BR>

        If present, this option specifies the options for the 
         audit trail logging. The <CODE>disk_log</CODE> module is used 
         to maintain a wrap log. If present, the <CODE>dir</CODE> and 
         <CODE>size</CODE> options are mandatory.<BR>

        If not present, audit trail logging is not used.<BR>


</DD>

<DT>
<CODE>atl_type() = read | write | read_write &#60;optional&#62;</CODE>
</DT>

<DD>
        Specifies what type of an audit trail log should be used. 
         The effect of the type is actually different for the the agent
         and the manager. <BR>

        For the agent:<BR>

        
<UL>

<LI>
         If <CODE>write</CODE> is specified, only set requests are logged. 
         
</LI>


<LI>
         If <CODE>read</CODE> is specified, only get requests are logged. 
         
</LI>


<LI>
         If <CODE>read_write</CODE>, all requests are logged. 
         
</LI>


</UL>

        For the manager:<BR>

        
<UL>

<LI>
         If <CODE>write</CODE> is specified, only sent messages are logged. 
         
</LI>


<LI>
         If <CODE>read</CODE> is specified, only received messages are logged. 
         
</LI>


<LI>
         If <CODE>read_write</CODE>, both outgoing and incomming messages are 
         logged. 
         
</LI>


</UL>

        Default is <CODE>read_write</CODE>.<BR>


</DD>

<DT>
<CODE>atl_dir = dir() &#60;mandatory&#62;</CODE>
</DT>

<DD>
        Specifies where the audit trail log should be stored.<BR>

        If <CODE>audit_trail_log</CODE> specifies that logging should take
         place, this parameter <STRONG>must</STRONG> be defined.<BR>


</DD>

<DT>
<CODE>atl_size() = {integer(), integer()} &#60;mandatory&#62;</CODE>
</DT>

<DD>
        Specifies the size of the audit
         trail log. This parameter is sent to <CODE>disk_log</CODE>. <BR>

        If <CODE>audit_trail_log</CODE> specifies that logging should 
         take place, this parameter <STRONG>must</STRONG> be defined.<BR>


</DD>

<DT>
<CODE>atl_repair() = true | false | truncate | snmp_repair &#60;optional&#62;</CODE>
</DT>

<DD>
        Specifies if and how the audit trail log shall be repaired
         when opened. Unless this parameter has the value <CODE>snmp_repair</CODE>
it is sent to <CODE>disk_log</CODE>. If, on the other hand, the value is
<CODE>snmp_repair</CODE>, snmp attempts to handle certain faults on it's 
own. And even if it cannot repair the file, it does not truncate it 
directly, but instead <STRONG>moves it aside</STRONG> for later off-line 
analysis.<BR>

        Default is <CODE>true</CODE>.<BR>


</DD>

</DL>

</DIV>

<H3>See Also</H3>
<DIV CLASS=REFBODY>

<P>application(3), disk_log(3)
</DIV>

<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
Martin Bjrklund - support@erlang.ericsson.se<BR>

</DIV>
<CENTER>
<HR>
<SMALL>snmp 4.8.2<BR>
Copyright &copy; 1991-2006
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>