File: snmp_manager_config_files.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 (375 lines) | stat: -rw-r--r-- 7,450 bytes
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
  <TITLE>Definition of Manager Configuration Files</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="7"><!-- Empty --></A>
<H2>7 Definition of Manager Configuration Files</H2>

<P>Configuration data may be included in configuration files
that is located in the configuration directory. The name of this
directory is given in the <CODE>config_dir</CODE> configuration
parameter. These files are read at start-up.


<P>The directory where the configuration files are found is given as
a parameter to the manager.


<P>The entry format in all files are Erlang terms, separated by a
'<STRONG>.</STRONG>' and a <STRONG>newline</STRONG>. In the following sections, the
formats of these terms are described. Comments may be specified as
ordinary Erlang comments.


<P>Syntax errors in these files are discovered and reported with the
function <CODE>config_err/2</CODE> of the 
<A HREF="snmpa_error_report.html">error report module</A> 
at start-up.

<A NAME="manager"><!-- Empty --></A><A NAME="7.1"><!-- Empty --></A>
<H3>7.1 Manager Information</H3>

<P>The manager information should be stored in a file called
<CODE>manager.conf</CODE>.


<P>Each entry is a tuple of size two:


<P><CODE>{Variable, Value}.</CODE>


<P>
<UL>

<LI>
        <CODE>Variable</CODE> is one of the following:
        <BR>

<UL>

<LI>
         <CODE>address</CODE> - which defines the IP address of the 
         manager. Default is local host.<BR>

         
</LI>


<LI>
         <CODE>port</CODE> - which defines which UDP port the manager uses
         for communicating with agents. <STRONG>Mandatory</STRONG>.<BR>

         
</LI>


<LI>
         <CODE>engine_id</CODE> - The <CODE>SnmpEngineID</CODE> as defined in 
         SNMP-FRAMEWORK-MIB. <STRONG>Mandatory</STRONG>.<BR>

         
</LI>


<LI>
         <CODE>max_message_size</CODE> - The <CODE>snmpEngineMaxMessageSize</CODE> as
         defined in SNMP-FRAMEWORK-MIB. <STRONG>Mandatory</STRONG>.<BR>

         
</LI>


</UL>



</LI>


<LI>
<CODE>Value</CODE> is the value for the variable.

<BR>

</LI>


</UL>

<P>The following example shows a <CODE>manager.conf</CODE> file: 


<PRE>
{address,          [141,213,11,24]}.
{port,             5000}.
{engine_id,        &#34;mgrEngine&#34;}.
{max_message_size, 484}.
    
</PRE>

<P>The value of <CODE>engine_id</CODE> is a string, which should have a 
very specific structure. See RFC 2271/2571 for details.

<A NAME="users"><!-- Empty --></A><A NAME="7.2"><!-- Empty --></A>
<H3>7.2 Users</H3>

<P>For each <STRONG>manager user</STRONG>, the manager needs some information.
This information is either added in the <CODE>users.conf</CODE> config 
file or by calling the 
<A HREF="snmpm.html#register_user">register_user</A> 
function in runtime.


<P>Each row defines a <STRONG>manager user</STRONG> of the manager. 


<P>Each entry is a tuple of size three:


<P><CODE>{UserId, UserMod, UserData}.</CODE>


<P>
<UL>

<LI>
        <CODE>UserId</CODE> is any term (used to uniquely identify the user).
<BR>

</LI>


<LI>
        <CODE>UserMod</CODE> is the user callback module (atom).
<BR>

</LI>


<LI>
        <CODE>UserData</CODE> is any term (passed on to the user when calling the
         <CODE>UserMod</CODE>.
         
<BR>

</LI>


</UL>
<A NAME="agents"><!-- Empty --></A><A NAME="7.3"><!-- Empty --></A>
<H3>7.3 Agents</H3>

<P>The information needed to handle agents should be stored in a 
file called <CODE>agents.conf</CODE>. It is also possible to add agents
in runtime by calling the 
<A HREF="snmpm.html#register_agent">register_agent</A>.


<P>Each entry is a tuple of size thirteen:


<P><CODE>{UserId, 
        TargetName, Comm, Ip, Port, EngineID, Timeout, 
        MaxMessageSize, Version, SecModel, SecName, SecLevel}.</CODE>


<P>
<UL>

<LI>
        <CODE>UserId</CODE> is the identity of the <STRONG>manager user</STRONG>
         responsible for this agent (term).

<BR>

</LI>


<LI>
        <CODE>TargetName</CODE> is a string.
<BR>

</LI>


<LI>
        <CODE>Comm</CODE> is the community string (string).
<BR>

</LI>


<LI>
        <CODE>Ip</CODE> is the ip address of the agent (a list of four integers).
<BR>

</LI>


<LI>
        <CODE>Port</CODE> is the port number of the agent (integer).
<BR>

</LI>


<LI>
        <CODE>EngineID</CODE> is the engine-id of the agent (string).
<BR>

</LI>


<LI>
        <CODE>Timeout</CODE> is re-transmission timeout 
         (<CODE>infinity</CODE> | integer).
<BR>

</LI>


<LI>
        <CODE>MaxMessageSize</CODE> is the max message size for outgoing messages 
         to this agent (integer).
<BR>

</LI>


<LI>
        <CODE>Version</CODE> is the version (v1 | v2 | v3).
<BR>

</LI>


<LI>
        <CODE>SecModel</CODE> is the security model (any | v1 | v2c | usm).
<BR>

</LI>


<LI>
        <CODE>SecName</CODE> is the security name (string).
<BR>

</LI>


<LI>
        <CODE>SecLevel</CODE> is security level (noAuthNoPriv | authNoPriv | 
         authPriv).
<BR>

</LI>


</UL>
<A NAME="usm_user"><!-- Empty --></A><A NAME="7.4"><!-- Empty --></A>
<H3>7.4 Security data for USM</H3>

<P>The information about Security data for USM should be stored in a 
file called <CODE>usm.conf</CODE>, which must be present if the manager
wishes to use SNMPv3 when commuincating with agents. It is also 
possible to add usm data in runtime by calling the 
<A HREF="snmpm.html#register_usm_user">register_usm_user</A>.


<P>The corresponding table is <CODE>usmUserTable</CODE> in the
SNMP-USER-BASED-SM-MIB.


<P>Each entry is a term:


<P><CODE>{EngineID, UserName, AuthP, AuthKey, PrivP, PrivKey}.</CODE>
<BR>
<CODE>{EngineID, UserName, SecName, AuthP, AuthKey, PrivP, PrivKey}.</CODE>


<P>The first case is when we have the identity-function 
(<CODE>SecName</CODE> = <CODE>UserName</CODE>).


<P>
<UL>

<LI>
        <CODE>EngineID</CODE> is a string.
<BR>

</LI>


<LI>
        <CODE>UserName</CODE> is a string.
<BR>

</LI>


<LI>
        <CODE>SecName</CODE> is a string.
<BR>

</LI>


<LI>
        <CODE>AuthP</CODE> is a <CODE>usmNoAuthProtocol</CODE>,
         <CODE>usmHMACMD5AuthProtocol</CODE>, or <CODE>usmHMACSHAAuthProtocol</CODE>.
<BR>

</LI>


<LI>
        <CODE>AuthKey</CODE> is a list (of integer). This is the User's 
         secretlocalized authentication key. It is not visible in the MIB. 
         The length of this key needs to be 16 if 
         <CODE>usmHMACMD5AuthProtocol</CODE> is used, and 20 if 
         <CODE>usmHMACSHAAuthProtocol</CODE> is used.
<BR>

</LI>


<LI>
        <CODE>PrivP</CODE> is a <CODE>usmNoPrivProtocol</CODE>, 
         <CODE>usmDESPrivProtocol</CODE> or <CODE>usmAesCfb128Protocol</CODE>.
<BR>

</LI>


<LI>
        <CODE>PrivKey</CODE> is a list (of integer). This is the User's secret
         localized encryption key. It is not visible in the MIB. The length
         of this key needs to be 16 if <CODE>usmDESPrivProtocol</CODE> 
or <CODE>usmAesCfb128Protocol</CODE> is used.
<BR>

</LI>


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