File: snmp_config.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 (1303 lines) | stat: -rw-r--r-- 35,097 bytes
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
  <TITLE>Running the application</TITLE>
  <SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
      ALINK="#FF0000">
<CENTER>
<A HREF="http://www.erlang.se"><IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif"></A>
</CENTER>
<A NAME="5"><!-- Empty --></A>
<H2>5 Running the application</H2>

<P>The chapter <STRONG>Running the application</STRONG> describes how the 
application is configured and started.
The topics include:
<P>
<UL>

<LI>
configuration directories and parameters
</LI>


<LI>
modifying the configuration files
</LI>


<LI>
starting the application (agent and/or manager)
</LI>


<LI>
debugging the application (agent and/or manager)
</LI>


</UL>

<P>Refer also to the chapter(s) 
<A HREF="snmp_agent_config_files.html">Definition of Agent 
Configuration Files</A> and 
<A HREF="snmp_manager_config_files.html">Definition of Manager 
Configuration Files</A> which contains more detailed information 
about the agent and manager configuration files.<A NAME="configuration_params"><!-- Empty --></A><A NAME="5.1"><!-- Empty --></A>
<H3>5.1 Configuring the application</H3>

<P>The following two directories must exist in the system
to run the agent:
<P>
<UL>

<LI>
the <STRONG>configuration directory</STRONG> stores all
        configuration files used by the agent (refer to the chapter 
        <A HREF="snmp_agent_config_files.html">Definition of Agent 
         Configuration Files</A> for more information).
</LI>


<LI>
the <STRONG>database directory</STRONG> stores the internal
        database files.
</LI>


</UL>

<P>The following directory must exist in the system
to run the manager:
<P>
<UL>

<LI>
the <STRONG>configuration directory</STRONG> stores all
        configuration files used by the manager (refer to the chapter 
        <A HREF="snmp_manager_config_files.html">Definition of Manager 
         Configuration Files</A> for more information).
</LI>


<LI>
the <STRONG>database directory</STRONG> stores the internal
        database files.
</LI>


</UL>

<P>The agent and manager uses (application) configuration parameters to 
find out where these directories are located. The parameters should be
defined in an Erlang system configuration file. The following
configuration parameters are defined for the SNMP application:
<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 fluched 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 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 a <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 fluched 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, 15000 milli-seconds, 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 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 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 options 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 
         <STRONG>audit trail logging</STRONG>. 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>
<A NAME="5.2"><!-- Empty --></A>
<H3>5.2 Modifying the Configuration Files</H3>

<P>To to start the application (agent and/or manager), the 
configuration files must be modified and there are two ways 
of doing this. Either edit the files manually, or run the 
configuration tool as follows.
<P>If authentication or encryption is used (SNMPv3 only), start
the <CODE>crypto</CODE> application.
<PRE>
1&#62; snmp:config().

Simple SNMP configuration tool (version 4.0)
------------------------------------------------
Note: Non-trivial configurations still has to be
      done manually. IP addresses may be entered 
      as dront.ericsson.se (UNIX only) or
      123.12.13.23
------------------------------------------------

Configure an agent (y/n)? [y] 

Agent system config: 
--------------------
1. Agent process priority (low/normal/high) [normal] 
2. What SNMP version(s) should be used (1,2,3,1&#38;2,1&#38;2&#38;3,2&#38;3)? [3] 1&#38;2&#38;3
3. Configuration directory (absolute path)? [/ldisk/snmp] /ldisk/snmp/agent/conf
4. Config verbosity (silence/info/log/debug/trace)? [silence] 
5. Database directory (absolute path)? [/ldisk/snmp] /ldisk/snmp/agent/db
6. Mib storage type (ets/dets/mnesia)? [ets] 
7. Symbolic store verbosity (silence/info/log/debug/trace)? [silence] 
8. Local DB verbosity (silence/info/log/debug/trace)? [silence] 
9. Local DB repair (true/false/force)? [true] 
10. Local DB auto save (infinity/milli seconds)? [5000] 
11. Error report module? [snmpa_error_logger] 
12. Agent type (master/sub)? [master] 
13. Master-agent verbosity (silence/info/log/debug/trace)? [silence] log
14. Shall the agent re-read the configuration files during startup 
    (and ignore the configuration database) (true/false)? [true] 
15. Multi threaded agent (true/false)? [false] true
16. Check for duplicate mib entries when installing a mib (true/false)? [false] 
17. Check for duplicate trap names when installing a mib (true/false)? [false] 
18. Mib server verbosity (silence/info/log/debug/trace)? [silence] 
19. Note store verbosity (silence/info/log/debug/trace)? [silence] 
20. Note store GC timeout? [30000] 
21. Shall the agent use an audit trail log (y/n)? [n] y
21b. Audit trail log type (write/read_write)? [read_write] 
21c. Where to store the audit trail log? [/ldisk/snmp] /ldisk/snmp/agent/log
21d. Max number of files? [10] 
21e. Max size (in bytes) of each file? [10240] 
21f. Audit trail log repair (true/false/truncate)? [true] 
22. Which network interface module shall be used? [snmpa_net_if] 
23. Network interface verbosity (silence/info/log/debug/trace)? [silence] log
24. Bind the agent IP address (true/false)? [false] 
25. Shall the agents IP address and port be not reusable (true/false)? [false] 
26. Agent request limit (used for flow control) (infinity/pos integer)? [infinity] 32
27. Receive buffer size of the agent (in bytes) (default/pos integer)? [default] 

Agent snmp config: 
------------------
1. System name (sysName standard variable) [bmk's agent] 
2. Engine ID (snmpEngineID standard variable) [bmk's engine] 
3. Max message size? [484] 
4. The UDP port the agent listens to. (standard 161) [4000] 
5. IP address for the agent (only used as id 
   when sending traps) [127.0.0.1] 
6. IP address for the manager (only this manager 
   will have access to the agent, traps are sent 
   to this one) [127.0.0.1] 
7. To what UDP port at the manager should traps 
   be sent (standard 162)? [5000] 
8. Do you want a none- minimum- or semi-secure configuration? 
   Note that if you chose v1 or v2, you won't get any security for these
   requests (none, minimum, semi_des, semi_aes) [minimum] 
making sure crypto server is started...
8b. Give a password of at least length 8. It is used to generate 
    private keys for the configuration:  kalle-anka
9. Current configuration files will now be overwritten. Ok (y/n)? [y] 

- - - - - - - - - - - - -
Info: 1. SecurityName &#34;initial&#34; has noAuthNoPriv read access
         and authenticated write access to the &#34;restricted&#34;
         subtree.
      2. SecurityName &#34;all-rights&#34; has noAuthNoPriv read/write
         access to the &#34;internet&#34; subtree.
      3. Standard traps are sent to the manager.
      4. Community &#34;public&#34; is mapped to security name &#34;initial&#34;.
      5. Community &#34;all-rights&#34; is mapped to security name &#34;all-rights&#34;.
The following agent files were written: agent.conf, community.conf,
standard.conf, target_addr.conf, target_params.conf, 
notify.conf, vacm.conf and usm.conf
- - - - - - - - - - - - -

Configure a manager (y/n)? [y] 

Manager system config: 
----------------------
1. Manager process priority (low/normal/high) [normal] 
2. What SNMP version(s) should be used (1,2,3,1&#38;2,1&#38;2&#38;3,2&#38;3)? [3] 1&#38;2&#38;3
3. Configuration directory (absolute path)? [/ldisk/snmp] /ldisk/snmp/manager/conf
4. Config verbosity (silence/info/log/debug/trace)? [silence] log
5. Database directory (absolute path)? [/ldisk/snmp] /ldisk/snmp/manager/db
6. Database repair (true/false/force)? [true] 
7. Database auto save (infinity/milli seconds)? [5000] 
8. Server verbosity (silence/info/log/debug/trace)? [silence] log
9. Server GC timeout? [30000] 
10. Note store verbosity (silence/info/log/debug/trace)? [silence] 
11. Note store GC timeout? [30000] 
12. Which network interface module shall be used? [snmpm_net_if] 
13. Network interface verbosity (silence/info/log/debug/trace)? [silence] log
14. Bind the manager IP address (true/false)? [false] 
15. Shall the manager IP address and port be not reusable (true/false)? [false] 
16. Receive buffer size of the manager (in bytes) (default/pos integer)? [default] 
17. Shall the manager use an audit trail log (y/n)? [n] y
17b. Where to store the audit trail log? [/ldisk/snmp] /ldisk/snmp/manager/log
17c. Max number of files? [10] 
17d. Max size (in bytes) of each file? [10240] 
17e. Audit trail log repair (true/false/truncate)? [true] 
18. Do you wish to assign a default user [yes] or use
    the default settings [no] (y/n)? [n] 

Manager snmp config: 
--------------------
1. Engine ID (snmpEngineID standard variable) [bmk's engine] 
2. Max message size? [484] 
3. IP address for the manager (only used as id 
   when sending requests) [127.0.0.1] 
4. Port number (standard 162)? [5000] 
5. Configure a user of this manager (y/n)? [y] 
5b. User id? kalle
5c. User callback module? snmpm_user_default
5d. User (callback) data? [undefined] 
5. Configure a user of this manager (y/n)? [y] n
6. Configure an agent handled by this manager (y/n)? [y] 
6b. User id? kalle
6c. Target name? [bmk's agent] 
6d. Version (1/2/3)? [1] 3
6e. Community string ? [public] 
6f. Engine ID (snmpEngineID standard variable) [bmk's engine] 
6g. IP address for the agent [127.0.0.1] 
6h. The UDP port the agent listens to. (standard 161) [4000] 
6i. Retransmission timeout (infinity/pos integer)? [infinity] 
6j. Max message size? [484] 
6k. Security model (any/v1/v2c/usm)? [any] usm
6l. Security name? [&#34;initial&#34;] 
6m. Security level (noAuthNoPriv/authNoPriv/authPriv)? [noAuthNoPriv] authPriv
6. Configure an agent handled by this manager (y/n)? [y] n
7. Configure an usm user handled by this manager (y/n)? [y] 
7a. Engine ID [bmk's engine] 
7b. User name? hobbes
7c. Security name? [hobbes] 
7d. Authentication protocol (no/sha/md5)? [no] sha
7e  Authentication [sha] key (length 0 or 20)? [&#34;&#34;] [1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20]
7d. Priv protocol (no/des/aes)? [no] des
7f  Priv [des] key (length 0 or 16)? [&#34;&#34;] 10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25
7. Configure an usm user handled by this manager (y/n)? [y] n
8. Current configuration files will now be overwritten. Ok (y/n)? [y] 

- - - - - - - - - - - - -
The following manager files were written: manager.conf, agents.conf , users.conf and usm.conf
- - - - - - - - - - - - -

--------------------
Configuration directory for system file (absolute path)? [/ldisk/snmp] 
ok
    
</PRE>
<A NAME="5.3"><!-- Empty --></A>
<H3>5.3 Starting the application</H3>

<P>Start Erlang with the command:
<PRE>
erl -config /tmp/snmp/sys
    
</PRE>

<P>If authentication or encryption is used (SNMPv3 only), start
the <CODE>crypto</CODE> application. If this step is forgotten, the
agent will not start, but report a
<CODE>{config_error,{unsupported_crypto,_}}</CODE> error.
<PRE>
1&#62; <STRONG>application:start(crypto).</STRONG>
ok
    
</PRE>

<PRE>
2&#62; <STRONG>application:start(snmp).</STRONG>
ok
    
</PRE>
<A NAME="verbosity"><!-- Empty --></A><A NAME="5.4"><!-- Empty --></A>
<H3>5.4 Debugging the application</H3>

<P>It is possible to debug every (non-supervisor) process of the 
application (both agent and manager), possibly with the exception 
of the net_if module(s), which could be supplied by a user of the 
application). This is done by calling the 
<CODE>snmpa:verbosity/2</CODE> and <CODE>snmpm:verbosity/2</CODE> function(s) 
and/or using 
<A HREF="#configuration_params">        configuration parameters</A>.
The verbosity itself has several <STRONG>levels</STRONG>: <CODE>silence | info | 
        log | debug | trace</CODE>. For the lowest verbosity <CODE>silence</CODE>, 
nothing is printed. The higher the verbosity, the more is printed.
Default value is always <CODE>silence</CODE>.
<PRE>
3&#62; <STRONG>snmpa:verbosity(master_agent, log).</STRONG>
ok
5&#62; <STRONG>snmpa:verbosity(net_if, log).</STRONG>
ok
6&#62; 
%% Example of output from the agent when a get-next-request arrives:
** SNMP NET-IF LOG: 
   got paket from {147,12,12,12}:5000

** SNMP NET-IF MPD LOG: 
   v1, community: all-rights

** SNMP NET-IF LOG: 
   got pdu from {147,12,12,12}:5000 {pdu, 'get-next-request',
                                          62612569,noError,0,
                                          [{varbind,[1,1],'NULL','NULL',1}]}

** SNMP MASTER-AGENT LOG: 
   apply: snmp_generic,variable_func,[get,{sysDescr,persistent}]

** SNMP MASTER-AGENT LOG: 
   returned: {value,&#34;Erlang SNMP agent&#34;}

** SNMP NET-IF LOG: 
   reply pdu: {pdu,'get-response',62612569,noError,0,
                   [{varbind,[1,3,6,1,2,1,1,1,0],
                             'OCTET STRING',
                             &#34;Erlang SNMP agent&#34;,1}]}

** SNMP NET-IF INFO: time in agent: 19711 mysec
    
</PRE>

<P>Another useful function for debugging is
<CODE>snmpa_local_db:print/0,1,2</CODE>. For example, this function can
show the counters <CODE>snmpInPkts</CODE> and <CODE>snmpOutPkts</CODE>. Enter
the following command:
<PRE>
4&#62; <STRONG>snmpa_local_db:print().</STRONG>
%% A lot of information.
    
</PRE>
<CENTER>
<HR>
<SMALL>
Copyright &copy; 1991-2006
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>