File: snmp_agent_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 (705 lines) | stat: -rw-r--r-- 11,393 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 Agent 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="6"><!-- Empty --></A>
<H2>6 Definition of Agent Configuration Files</H2>

<P>All configuration data must be included in configuration files
that are 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, and are used to
initialize the SNMPv2-MIB or STANDARD-MIB, SNMP-FRAMEWORK-MIB,
SNMP-MPD-MIB, SNMP-VIEW-BASED-ACM-MIB, SNMP-COMMUNITY-MIB,
SNMP-USER-BASED-SM-MIB, SNMP-TARGET-MIB and SNMP-NOTIFICATION-MIB
(refer to the <A HREF="snmp_agent_funct_descr.html#management">Management of the Agent
</A> for a description of the MIBs).


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


<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 error report module at start-up.

<A NAME="6.1"><!-- Empty --></A>
<H3>6.1 Agent Information</H3>

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


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


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


<P>
<UL>

<LI>
<CODE>AgentVariable</CODE> is one of the variables is
SNMP-FRAMEWORK-MIB or one of the internal variables
<CODE>intAgentUDPPort</CODE>, which defines which UDP port the agent
listens to, or <CODE>intAgentIpAddress</CODE>, which defines the IP
address of the agent.


</LI>


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


</LI>


</UL>

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


<PRE>
{intAgentUDPPort, 4000}.
{intAgentIpAddress,[141,213,11,24]}.
{snmpEngineID, &#34;mbj's engine&#34;}.
{snmpEngineMaxPacketSize, 484}.
    
</PRE>

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

<A NAME="6.2"><!-- Empty --></A>
<H3>6.2 Contexts</H3>

<P>The context information should be stored in a file called
<CODE>context.conf</CODE>. The default context <CODE>&#34;&#34;</CODE>
need not be present.


<P>Each row defines a context in the agent. This information is
used in the table <CODE>vacmContextTable</CODE> in the
SNMP-VIEW-BASED-ACM-MIB.


<P>Each entry is a term:


<P><CODE>ContextName.</CODE>


<P>
<UL>

<LI>
<CODE>ContextName</CODE> is a string.


</LI>


</UL>
<A NAME="6.3"><!-- Empty --></A>
<H3>6.3 System Information</H3>

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


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


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


<P>
<UL>

<LI>
<CODE>SystemVariable</CODE> is one of the variables in the
system group, or <CODE>snmpEnableAuthenTraps</CODE>.


</LI>


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


</LI>


</UL>

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


<PRE>
{sysDescr, &#34;Erlang SNMP agent&#34;}.
{sysObjectID, [1,2,3]}.
{sysContact, &#34;(mbj,eklas)@erlang.ericsson.se&#34;}.
{sysName, &#34;test&#34;}.
{sysServices, 72}.
{snmpEnableAuthenTraps, enabled}.
    
</PRE>

<P>A value must be provided for all variables, which lack default
values in the MIB.

<A NAME="6.4"><!-- Empty --></A>
<H3>6.4 Communities</H3>

<P>The community information should be stored in a file called
<CODE>community.conf</CODE>. It must be present if the agent is
configured for SNMPv1 or SNMPv2c.


<P>The corresponding table is <CODE>snmpCommunityTable</CODE> in the
SNMP-COMMUNITY-MIB.


<P>Each entry is a term:


<P><CODE>{CommunityIndex, CommunityName, SecurityName, ContextName,
                 TransportTag}.</CODE>


<P>
<UL>

<LI>
<CODE>CommunityIndex</CODE> is a non-empty string.


</LI>


<LI>
<CODE>CommunityName</CODE> is a string.


</LI>


<LI>
<CODE>SecurityName</CODE> is a string.


</LI>


<LI>
<CODE>ContextName</CODE> is a string.


</LI>


<LI>
<CODE>TransportTag</CODE> is a string.


</LI>


</UL>
<A NAME="6.5"><!-- Empty --></A>
<H3>6.5 MIB Views for VACM</H3>

<P>The information about MIB Views for VACM should be stored in a 
file called
<CODE>vacm.conf</CODE>.


<P>The corresponding tables are <CODE>vacmSecurityToGroupTable</CODE>,
<CODE>vacmAccessTable</CODE> and <CODE>vacmViewTreeFamilyTable</CODE> in the
SNMP-VIEW-BASED-ACM-MIB.


<P>Each entry is one of the terms, one entry corresponds to one
row in one of the tables.


<P><CODE>{vacmSecurityToGroup, SecModel, SecName, GroupName}.</CODE>

<P><CODE>{vacmAccess, GroupName, Prefix, SecModel, SecLevel, Match, ReadView, WriteView, NotifyView}.</CODE>

<P><CODE>{vacmViewTreeFamily, ViewIndex, ViewSubtree, ViewStatus, ViewMask}.</CODE>


<P>
<UL>

<LI>
<CODE>SecModel</CODE> is <CODE>any</CODE>, <CODE>v1</CODE>, <CODE>v2c</CODE>, or
<CODE>usm</CODE>.
<BR>

</LI>


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

</LI>


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

</LI>


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

</LI>


<LI>
<CODE>SecLevel</CODE> is <CODE>noAuthNoPriv</CODE>, <CODE>authNoPriv</CODE>,
or <CODE>authPriv</CODE>
<BR>

</LI>


<LI>
<CODE>Match</CODE> is <CODE>prefix</CODE> or <CODE>exact</CODE>.
<BR>

</LI>


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

</LI>


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

</LI>


<LI>
<CODE>NotifyView</CODE> is a string.

<BR>

</LI>


<LI>
<CODE>ViewIndex</CODE> is an integer.
<BR>

</LI>


<LI>
<CODE>ViewSubtree</CODE> is a list of integer.
<BR>

</LI>


<LI>
<CODE>ViewStatus</CODE> is either <CODE>included</CODE> or <CODE>excluded</CODE>

<BR>

</LI>


<LI>
<CODE>ViewMask</CODE> is either <CODE>null</CODE> or a list of ones and
zeros. Ones nominate that an exact match is used for this
sub-identifier. Zeros are wildcards which match any
sub-identifier. If the mask is shorter than the subtree, the
tail is regarded as all ones. <CODE>null</CODE> is shorthand for a
mask with all ones.
<BR>

</LI>


</UL>
<A NAME="6.6"><!-- Empty --></A>
<H3>6.6 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 agent is configured
for SNMPv3.


<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, SecName, Clone, AuthP, AuthKeyC, OwnAuthKeyC,
PrivP, PrivKeyC, OwnPrivKeyC, Public, AuthKey, PrivKey}.</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>Clone</CODE> is <CODE>zeroDotZero</CODE> or a list of integers.
<BR>

</LI>


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

</LI>


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

</LI>


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

</LI>


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

</LI>


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

</LI>


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

</LI>


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

</LI>


<LI>
<CODE>AuthKey</CODE> is a list (of integer). This is the User's secret
localized 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>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>
<A NAME="6.7"><!-- Empty --></A>
<H3>6.7 Notify Definitions</H3>

<P>The information about Notify Definitions should be stored in a
file called
<CODE>notify.conf</CODE>.


<P>The corresponding table is <CODE>snmpNotifyTable</CODE> in the
SNMP-NOTIFICATION-MIB.


<P>Each entry is a term:


<P><CODE>{NotifyName, Tag, Type}.</CODE>


<P>
<UL>

<LI>
<CODE>NotifyName</CODE> is a unique non-empty string.

<BR>

</LI>


<LI>
<CODE>Tag</CODE> is a string.

<BR>

</LI>


<LI>
<CODE>Type</CODE> is <CODE>trap</CODE> or <CODE>inform</CODE>.

<BR>

</LI>


</UL>
<A NAME="target_addr"><!-- Empty --></A><A NAME="6.8"><!-- Empty --></A>
<H3>6.8 Target Address Definitions</H3>

<P>The information about Target Address Definitions should be 
stored in a file called
<CODE>target_addr.conf</CODE>.


<P>The corresponding tables are <CODE>snmpTargetAddrTable</CODE> in the
SNMP-TARGET-MIB and <CODE>snmpTargetAddrExtTable</CODE> in the SNMP-COMMUNITY-MIB.


<P>Each entry is a term:


<P><CODE>{TargetName, Ip, Udp, Timeout, RetryCount, TagList,
ParamsName, EngineId}.</CODE> or<BR>

<CODE>{TargetName, Ip, Udp, Timeout, RetryCount, TagList,
ParamsName, EngineId, TMask, MaxMessageSize}.</CODE>


<P>
<UL>

<LI>
<CODE>TargetName</CODE> is a unique non-empty string.

<BR>

</LI>


<LI>
<CODE>Ip</CODE> is a list of four integers. 

<BR>

</LI>


<LI>
<CODE>Udp</CODE> is an integer.

<BR>

</LI>


<LI>
<CODE>Timeout</CODE> is an integer.

<BR>

</LI>


<LI>
<CODE>RetryCount</CODE> is an integer.

<BR>

</LI>


<LI>
<CODE>TagList</CODE> is a string.

<BR>

</LI>


<LI>
<CODE>ParamsName</CODE> is a string.

<BR>

</LI>


<LI>
<CODE>EngineId</CODE> is a string.

<BR>

</LI>


<LI>
<CODE>TMask</CODE> is a string of size 0, or size 6 (default: []).

<BR>

</LI>


<LI>
<CODE>MaxMessageSize</CODE> is an integer (default: 2048).

<BR>

</LI>


</UL>
<A NAME="target_params"><!-- Empty --></A><A NAME="6.9"><!-- Empty --></A>
<H3>6.9 Target Parameters Definitions</H3>

<P>The information about Target Parameters Definitions should be
stored in a file called
<CODE>target_params.conf</CODE>.


<P>The corresponding table is <CODE>snmpTargetParamsTable</CODE> in the
SNMP-TARGET-MIB.


<P>Each entry is a term:


<P><CODE>{ParamsName, MPModel, SecurityModel, SecurityName, SecurityLevel}.</CODE>


<P>
<UL>

<LI>
<CODE>ParamsName</CODE> is a unique non-empty string.

<BR>

</LI>


<LI>
<CODE>MPModel</CODE> is <CODE>v1</CODE>, <CODE>v2c</CODE> or <CODE>v3</CODE>

<BR>

</LI>


<LI>
<CODE>SecurityModel</CODE> is <CODE>v1</CODE>, <CODE>v2c</CODE>, or <CODE>usm</CODE>.

<BR>

</LI>


<LI>
<CODE>SecurityName</CODE> is a string.

<BR>

</LI>


<LI>
<CODE>SecurityLevel</CODE> is <CODE>noAuthNoPriv</CODE>, <CODE>authNoPriv</CODE>
or <CODE>authPriv</CODE>.

<BR>

</LI>


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