File: snmpa.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 (1172 lines) | stat: -rw-r--r-- 36,821 bytes
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
  <TITLE>snmpa</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>snmpa</H1>
</CENTER>

<H3>MODULE</H3>
<DIV CLASS=REFBODY>
snmpa
</DIV>

<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
 Interface Functions to the SNMP toolkit agent

</DIV>

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

<P>The module <CODE>snmpa</CODE> contains interface functions to the 
SNMP agent.
</DIV>

<H3>Common Data Types</H3>
<DIV CLASS=REFBODY>

<P>The following datatypes are used in the functions below:


<P>
<UL>

<LI>
<CODE>oid() = [byte()]</CODE>
<BR>

</LI>


</UL>

<P>The <CODE>oid()</CODE> type is used to represent an ASN.1 OBJECT
IDENTIFIER.
</DIV>

<H3>EXPORTS</H3>

<P><A NAME="add_agent_caps/2"><STRONG><CODE>add_agent_caps(SysORID, SysORDescr) -&#62; SysORIndex</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>SysORID = oid()</CODE></STRONG><BR>
<STRONG><CODE>SysORDescr = string()</CODE></STRONG><BR>
<STRONG><CODE>SysORIndex = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>This function can be used to add an AGENT-CAPABILITY
         statement to the sysORTable in the agent. The table is
         defined in the SNMPv2-MIB.<A NAME="del_agent_caps"><!-- Empty --></A>
</DIV>

<P><A NAME="del_agent_caps/1"><STRONG><CODE>del_agent_caps(SysORIndex) -&#62; void()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>SysORIndex = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>This function can be used to delete an AGENT-CAPABILITY
         statement to the sysORTable in the agent. This table is
         defined in the SNMPv2-MIB.

        <A NAME="get_agent_caps"><!-- Empty --></A> 

</DIV>

<P><A NAME="get_agent_caps/0"><STRONG><CODE>get_agent_caps() -&#62; [[SysORIndex, SysORID, SysORDescr, SysORUpTime]]</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>SysORIndex = integer()</CODE></STRONG><BR>
<STRONG><CODE>SysORId = oid()</CODE></STRONG><BR>
<STRONG><CODE>SysORDescr = string()</CODE></STRONG><BR>
<STRONG><CODE>SysORUpTime = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Returns all AGENT-CAPABILITY statements in the sysORTable
         in the agent. This table is defined in the SNMPv2-MIB.

        <A NAME="get"><!-- Empty --></A> 

</DIV>

<P><A NAME="get/2"><STRONG><CODE>get(Agent,Vars) -&#62; Values | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="get/3"><STRONG><CODE>get(Agent,Vars,Context) -&#62; Values | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Agent = pid() | atom()</CODE></STRONG><BR>
<STRONG><CODE>Vars = [oid()]</CODE></STRONG><BR>
<STRONG><CODE>Context = string()</CODE></STRONG><BR>
<STRONG><CODE>Values = [term()]</CODE></STRONG><BR>
<STRONG><CODE>Reason = {atom(), oid()}</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Performs a GET operation on the agent. All loaded MIB
         objects are visible in this operation. The agent calls the
         corresponding instrumentation functions just as if it was a
         GET request coming from a manager. 
<P>Note that the request specific parameters (such as 
         <A HREF="#current_request_id">current_request_id</A>) 
         are not accessible for the instrumentation functions if this 
         function is used.

        <A NAME="get_next"><!-- Empty --></A> 

</DIV>

<P><A NAME="get_next/2"><STRONG><CODE>get_next(Agent,Vars) -&#62; Values | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="get_next/3"><STRONG><CODE>get_next(Agent,Vars,Context) -&#62; Values | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Agent = pid() | atom()</CODE></STRONG><BR>
<STRONG><CODE>Vars = [oid()]</CODE></STRONG><BR>
<STRONG><CODE>Context = string()</CODE></STRONG><BR>
<STRONG><CODE>Values = [{oid(), term()}]</CODE></STRONG><BR>
<STRONG><CODE>Reason = {atom(), oid()}</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Performs a GET-NEXT operation on the agent. All loaded MIB
         objects are visible in this operation. The agent calls the
         corresponding instrumentation functions just as if it was a
         GET request coming from a manager. 
<P>Note that the request specific parameters (such as 
         <CODE>snmpa:current_request_id/0</CODE> are not accessible for the 
         instrumentation functions if this function is used.

        <A NAME="get_symbolic_store_db"><!-- Empty --></A> 

</DIV>

<P><A NAME="get_symbolic_store_db/0"><STRONG><CODE>get_symbolic_store_db() -&#62; Db</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Db = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Retrieve the symbolic store database reference. This is used 
         for faster access to the database using the functions: 
         <CODE>int_to_enum/3</CODE>, <CODE>enum_to_int/3</CODE>, <CODE>name_to_oid/2</CODE>, 
         <CODE>oid_to_name/2</CODE>.

        <A NAME="backup"><!-- Empty --></A> 

</DIV>

<P><A NAME="backup/1"><STRONG><CODE>backup(BackupDir) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="backup/2"><STRONG><CODE>backup(Agent, BackupDir) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>BackupDir = string()</CODE></STRONG><BR>
<STRONG><CODE>Agent = pid() | atom()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Backup persistent/permanent data handled by the agent
(such as local-db, mib-data and vacm). 
<P>Data stored by mnesia is not handled. 
<P>BackupDir cannot be identical to DbDir. <A NAME="info"><!-- Empty --></A>
</DIV>

<P><A NAME="info/0"><STRONG><CODE>info() -&#62; [{Key, Value}]</CODE></STRONG></A><BR>
<A NAME="info/1"><STRONG><CODE>info(Agent) -&#62; [{Key, Value}]</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Agent = pid() | atom()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Returns a list (a dictionary) containing information about
         the agent. Information includes loaded MIBs, registered
         subagents, some information about the memory allocation. 
<P>As of version 4.4 the format of the info has been changed. 
To convert the info to the old format, call the 
<A HREF="#old_info_format">old_info_format</A>. <A NAME="old_info_format"><!-- Empty --></A>
</DIV>

<P><A NAME="old_info_format/1"><STRONG><CODE>old_info_format(NewInfo) -&#62; OldInfo</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>OldInfo = NewInfo = [{Key, Value}]</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>As of version 4.4 the format of the info has been changed. 
This function is used to convert to the old (pre-4.4) info 
format. <A NAME="load_mibs"><!-- Empty --></A>
</DIV>

<P><A NAME="load_mibs/1"><STRONG><CODE>load_mibs(Mibs) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="load_mibs/2"><STRONG><CODE>load_mibs(Agent,Mibs) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Agent = pid() | atom()</CODE></STRONG><BR>
<STRONG><CODE>Mibs = [MibName]</CODE></STRONG><BR>
<STRONG><CODE>MibName = string()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Loads <CODE>Mibs</CODE> into an agent. If the agent cannot load
         all MIBs, it will indicate where loading was aborted. The
         <CODE>MibName</CODE> is the name of the Mib, including the path to
         where the compiled mib is found. For example,
        
<PRE>
          Dir = code:priv_dir(my_app) ++ &#34;/mibs/&#34;,
          snmpa:load_mibs(snmp_master_agent, [Dir ++ &#34;MY-MIB&#34;]).
        
</PRE>
<A NAME="unload_mibs"><!-- Empty --></A>
</DIV>

<P><A NAME="unload_mibs/1"><STRONG><CODE>unload_mibs(Mibs) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="unload_mibs/2"><STRONG><CODE>unload_mibs(Agent,Mibs) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Agent = pid() | atom()</CODE></STRONG><BR>
<STRONG><CODE>Mibs = [MibName]</CODE></STRONG><BR>
<STRONG><CODE>MibName = string()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Unloads MIBs into an agent. If it cannot unload all MIBs,
        it will indicate where unloading was aborted.

        <A NAME="which_mibs"><!-- Empty --></A> 

</DIV>

<P><A NAME="which_mibs/0"><STRONG><CODE>which_mibs() -&#62; Mibs</CODE></STRONG></A><BR>
<A NAME="which_mibs/1"><STRONG><CODE>which_mibs(Agent) -&#62; Mibs</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Agent = pid() | atom()</CODE></STRONG><BR>
<STRONG><CODE>Mibs = [{MibName, MibFile}]</CODE></STRONG><BR>
<STRONG><CODE>MibName = atom()</CODE></STRONG><BR>
<STRONG><CODE>MibFile = string()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Retrieve the list of all the mibs loaded into this agent. Default 
         is the master agent. 

        <A NAME="whereis_mib"><!-- Empty --></A> 

</DIV>

<P><A NAME="whereis_mib/1"><STRONG><CODE>whereis_mib(MibName) -&#62; {ok, MibFile} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="whereis_mib/2"><STRONG><CODE>whereis_mib(Agent, MibName) -&#62; {ok, MibFile} | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Agent = pid() | atom()</CODE></STRONG><BR>
<STRONG><CODE>MibName = atom()</CODE></STRONG><BR>
<STRONG><CODE>MibFile = string()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Get the full path to the (compiled) mib-file.

        <A NAME="current_request_id"><!-- Empty --></A> 
        <A NAME="current_context"><!-- Empty --></A> 
        <A NAME="current_community"><!-- Empty --></A> 
        <A NAME="current_address"><!-- Empty --></A> 

</DIV>

<P><A NAME="current_request_id/0"><STRONG><CODE>current_request_id() -&#62; {value, RequestId} | false</CODE></STRONG></A><BR>
<A NAME="current_context/0"><STRONG><CODE>current_context() -&#62; {value, Context} | false</CODE></STRONG></A><BR>
<A NAME="current_community/0"><STRONG><CODE>current_community() -&#62; {value, Community} | false</CODE></STRONG></A><BR>
<A NAME="current_address/0"><STRONG><CODE>current_address() -&#62; {value, Address} | false</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>RequestId = integer()</CODE></STRONG><BR>
<STRONG><CODE>Context = string()</CODE></STRONG><BR>
<STRONG><CODE>Community = string()</CODE></STRONG><BR>
<STRONG><CODE>Address = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Get the request-id, context, community and address of the 
         request currently beeing processed by the agent. 
<P>Note that these functions is intended to be called by the 
         instrumentation functions and <STRONG>only</STRONG> if they are 
         executed in the context of the agent process (e.g. it does 
         not work if called from a spawned process).<A NAME="enum_to_int"><!-- Empty --></A>
</DIV>

<P><A NAME="enum_to_int/2"><STRONG><CODE>enum_to_int(Name,Enum) -&#62; {value, Int} | false</CODE></STRONG></A><BR>
<A NAME="enum_to_int/3"><STRONG><CODE>enum_to_int(Db,Name,Enum) -&#62; {value, Int} | false</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Db = term()</CODE></STRONG><BR>
<STRONG><CODE>Name = atom()</CODE></STRONG><BR>
<STRONG><CODE>Enum = atom()</CODE></STRONG><BR>
<STRONG><CODE>Int = int()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Converts the symbolic value <CODE>Enum</CODE> to the
         corresponding integer of the enumerated object or type
         <CODE>Name</CODE> in a MIB. The MIB must be loaded. 

        
<P><CODE>false</CODE> is returned if the object or type is not
         defined in any loaded MIB, or if it does not define the
         symbolic value as enumerated.

        
<P><CODE>Db</CODE> is a reference to the symbolic store database 
         (retrieved by a call to <CODE>get_symbolic_store_db/0</CODE>).

        <A NAME="int_to_enum"><!-- Empty --></A> 

</DIV>

<P><A NAME="int_to_enum/2"><STRONG><CODE>int_to_enum(Name,Int) -&#62; {value, Enum} | false</CODE></STRONG></A><BR>
<A NAME="int_to_enum/3"><STRONG><CODE>int_to_enum(Db,Name,Int) -&#62; {value, Enum} | false</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Db = term()</CODE></STRONG><BR>
<STRONG><CODE>Name = atom()</CODE></STRONG><BR>
<STRONG><CODE>Int = int()</CODE></STRONG><BR>
<STRONG><CODE>Enum = atom()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Converts the integer <CODE>Int</CODE> to the corresponding
         symbolic value of the enumerated object or type <CODE>Name</CODE> in
         a MIB. The MIB must be loaded. 

        
<P><CODE>false</CODE> is returned if the object or type is not
         defined in any loaded MIB, or if it does not define the
         symbolic value as enumerated.

        
<P><CODE>Db</CODE> is a reference to the symbolic store database 
         (retrieved by a call to <CODE>get_symbolic_store_db/0</CODE>).

        <A NAME="name_to_oid"><!-- Empty --></A> 

</DIV>

<P><A NAME="name_to_oid/1"><STRONG><CODE>name_to_oid(Name) -&#62; {value, oid()} | false</CODE></STRONG></A><BR>
<A NAME="name_to_oid/2"><STRONG><CODE>name_to_oid(Db,Name) -&#62; {value, oid()} | false</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Db = term()</CODE></STRONG><BR>
<STRONG><CODE>Name = atom()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Looks up the OBJECT IDENTIFIER of a MIB object, given the
        symbolic name. Note, the OBJECT IDENTIFIER is given for the
        object, not for an instance. 

        
<P><CODE>false</CODE> is returned if the object is not defined in any
         loaded MIB.

        
<P><CODE>Db</CODE> is a reference to the symbolic store database 
         (retrieved by a call to <CODE>get_symbolic_store_db/0</CODE>).
         
        <A NAME="oid_to_name"><!-- Empty --></A> 

</DIV>

<P><A NAME="oid_to_name/1"><STRONG><CODE>oid_to_name(OID) -&#62; {value, Name} | false</CODE></STRONG></A><BR>
<A NAME="oid_to_name/2"><STRONG><CODE>oid_to_name(Db,OID) -&#62; {value, Name} | false</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Db = term()</CODE></STRONG><BR>
<STRONG><CODE>OID = oid()</CODE></STRONG><BR>
<STRONG><CODE>Name = atom()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Looks up the symbolic name of a MIB object, given OBJECT
        IDENTIFIER. 

        
<P><CODE>false</CODE> is returned if the object is not defined in any
         loaded MIB.

        
<P><CODE>Db</CODE> is a reference to the symbolic store database 
         (retrieved by a call to <CODE>get_symbolic_store_db/0</CODE>).

        <A NAME="which_aliasnames"><!-- Empty --></A> 

</DIV>

<P><A NAME="which_aliasnames/0"><STRONG><CODE>which_aliasnames() -&#62; Result</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Result = [atom()]</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Retrieve all alias-names known to the agent.<A NAME="which_tables"><!-- Empty --></A>
</DIV>

<P><A NAME="which_tables/0"><STRONG><CODE>which_tables() -&#62; Result</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Result = [atom()]</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Retrieve all tables known to the agent.<A NAME="which_variables"><!-- Empty --></A>
</DIV>

<P><A NAME="which_variables/0"><STRONG><CODE>which_variables() -&#62; Result</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Result = [atom()]</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Retrieve all variables known to the agent.<A NAME="log_to_txt"><!-- Empty --></A>
</DIV>

<P><A NAME="log_to_txt/2"><STRONG><CODE>log_to_txt(LogDir, Mibs)</CODE></STRONG></A><BR>
<A NAME="log_to_txt/3"><STRONG><CODE>log_to_txt(LogDir, Mibs, OutFile) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="log_to_txt/4"><STRONG><CODE>log_to_txt(LogDir, Mibs, OutFile, LogName) -&#62; 
        ok | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="log_to_txt/5"><STRONG><CODE>log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile) -&#62; 
        ok | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="log_to_txt/6"><STRONG><CODE>log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start) -&#62; 
        ok | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="log_to_txt/7"><STRONG><CODE>log_to_txt(LogDir, Mibs, OutFile, LogName, LogFile, Start, Stop) 
        -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>LogDir = string()</CODE></STRONG><BR>
<STRONG><CODE>Mibs = [MibName]</CODE></STRONG><BR>
<STRONG><CODE>MibName = string()</CODE></STRONG><BR>
<STRONG><CODE>OutFile = string()</CODE></STRONG><BR>
<STRONG><CODE>LogName = string()</CODE></STRONG><BR>
<STRONG><CODE>LogFile = string()</CODE></STRONG><BR>
<STRONG><CODE>Start = Stop = null | datetime() | {local_time,datetime()} | 
{universal_time,datetime()} </CODE></STRONG><BR>
<STRONG><CODE>Reason = disk_log_open_error() | file_open_error() | term()</CODE></STRONG><BR>
<STRONG><CODE>disk_log_open_error() = {LogName, term()}</CODE></STRONG><BR>
<STRONG><CODE>file_open_error() = {OutFile, term()}</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Converts an Audit Trail Log to a readable text file. 
         <CODE>OutFile</CODE> defaults to &#34;./snmpa_log.txt&#34;. 
         <CODE>LogName</CODE> defaults to &#34;snmpa_log&#34;. 
         <CODE>LogFile</CODE> defaults to &#34;snmpa.log&#34;. 
See <A HREF="snmp.html#log_to_txt">snmp:log_to_txt</A> 
for more info.
</DIV>

<P><A NAME="change_log_size/1"><STRONG><CODE>change_log_size(NewSize) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>NewSize = {MaxBytes, MaxFiles}</CODE></STRONG><BR>
<STRONG><CODE>MaxBytes = integer()</CODE></STRONG><BR>
<STRONG><CODE>MaxFiles = integer()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Changes the log size of the Audit Trail Log. The application must 
         be configured to use the audit trail log function. Please refer to 
         disk_log(3) in Kernel Reference Manual for a description of how to 
         change the log size.

        
<P>The change is permanent, as long as the log is not deleted. 
         That means, the log size is remebered across reboots.

        <A NAME="mib_of"><!-- Empty --></A> 

</DIV>

<P><A NAME="mib_of/1"><STRONG><CODE>mib_of(Oid) -&#62; {ok, MibName} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="mib_of/2"><STRONG><CODE>mib_of(Agent, Oid) -&#62; {ok, MibName} | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Agent = pid() | atom()</CODE></STRONG><BR>
<STRONG><CODE>Oid = oid()</CODE></STRONG><BR>
<STRONG><CODE>MibName = atom()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Finds the mib corresponding to the <CODE>Oid</CODE>. If it is a
variable, the Oid must be 
         &#60;Oid for var&#62;.0 and if it is a table, Oid must be 
         &#60;table&#62;.&#60;entry&#62;.&#60;col&#62;.&#60;any&#62;<A NAME="me_of"><!-- Empty --></A>
</DIV>

<P><A NAME="me_of/1"><STRONG><CODE>me_of(Oid) -&#62; {ok, Me} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="me_of/2"><STRONG><CODE>me_of(Agent, Oid) -&#62; {ok, Me} | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Agent = pid() | atom()</CODE></STRONG><BR>
<STRONG><CODE>Oid = oid()</CODE></STRONG><BR>
<STRONG><CODE>Me = #me{}</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Finds the mib entry corresponding to the <CODE>Oid</CODE>. If it is a
variable, the Oid must be 
         &#60;Oid for var&#62;.0 and if it is a table, Oid must be 
         &#60;table&#62;.&#60;entry&#62;.&#60;col&#62;.&#60;any&#62;<A NAME="register_notification_filter"><!-- Empty --></A>
</DIV>

<P><A NAME="register_notification_filter/3"><STRONG><CODE>register_notification_filter(Id, Mod, Data) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="register_notification_filter/4"><STRONG><CODE>register_notification_filter(Agent, Id, Mod, Data) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="register_notification_filter/4"><STRONG><CODE>register_notification_filter(Id, Mod, Data, Where) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="register_notification_filter/5"><STRONG><CODE>register_notification_filter(Agent, Id, Mod, Data, Where) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Agent = pid() | atom()</CODE></STRONG><BR>
<STRONG><CODE>Id = filter_id()</CODE></STRONG><BR>
<STRONG><CODE>filter_id() = term()</CODE></STRONG><BR>
<STRONG><CODE>Mod = atom()</CODE></STRONG><BR>
<STRONG><CODE>Data = term()</CODE></STRONG><BR>
<STRONG><CODE>Where = filter_position()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>
<STRONG><CODE>filter_position() = first | last | {insert_before, filter_id()} | {insert_after, filter_id()} </CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Registers a notification filter.

        
<P><CODE>Mod</CODE> is a module implementing the 
         <CODE>snmpa_notification_filter</CODE> behaviour.
<P><CODE>Data</CODE> will be passed on to the filter when calling the
         functions of the behaviour.<A NAME="unregister_notification_filter"><!-- Empty --></A>
</DIV>

<P><A NAME="unregister_notification_filter/1"><STRONG><CODE>unregister_notification_filter(Id) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="unregister_notification_filter/2"><STRONG><CODE>unregister_notification_filter(Agent, Id) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Agent = pid() | atom()</CODE></STRONG><BR>
<STRONG><CODE>Id = filter_id()</CODE></STRONG><BR>
<STRONG><CODE>filter_id() = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Unregisters a notification filter.

        <A NAME="which_notification_filter"><!-- Empty --></A>   

</DIV>

<P><A NAME="which_notification_filter/0"><STRONG><CODE>which_notification_filter() -&#62; Filters</CODE></STRONG></A><BR>
<A NAME="which_notification_filter/1"><STRONG><CODE>which_notification_filter(Agent) -&#62; Filters</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Agent = pid() | atom()</CODE></STRONG><BR>
<STRONG><CODE>Filters = [filter_id()]</CODE></STRONG><BR>
<STRONG><CODE>filter_id() = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>List all notification filters in an agent.
</DIV>

<P><A NAME="register_subagent/3"><STRONG><CODE>register_subagent(Agent,SubTreeOid,Subagent) -&#62; ok |
{error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Agent = pid() | atom()</CODE></STRONG><BR>
<STRONG><CODE>SubTreeOid = oid()</CODE></STRONG><BR>
<STRONG><CODE>SubAgent = pid()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Registers a subagent under a subtree of another agent.

        
<P>It is easy to make mistakes when registering subagents and
         this activity should be done carefully. For example, a
         strange behaviour would result from the following
         configuration:
        
<PRE>
snmp_agent:register_subagent(MAPid,[1,2,3,4],SA1),
snmp_agent:register_subagent(SA1,[1,2,3], SA2).
        
</PRE>

<P><CODE>SA2</CODE> will not get requests starting with object
        identifier <CODE>[1,2,3]</CODE> since <CODE>SA1</CODE> does not.


</DIV>

<P><A NAME="unregister_subagent/2"><STRONG><CODE>unregister_subagent(Agent,SubagentOidOrPid) -&#62; ok | {ok,
SubAgentPid} | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Agent = pid() | atom()</CODE></STRONG><BR>
<STRONG><CODE>SubTreeOidorPid = oid() | pid()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Unregisters a subagent. If the second argument is a pid,
        then that subagent will be unregistered from all trees in
        <CODE>Agent</CODE>.

        <A NAME="send_notification"><!-- Empty --></A> 

</DIV>

<P><A NAME="send_notification/3"><STRONG><CODE>send_notification(Agent,Notification,Receiver)</CODE></STRONG></A><BR>
<A NAME="send_notification/4"><STRONG><CODE>send_notification(Agent,Notification,Receiver,Varbinds)</CODE></STRONG></A><BR>
<A NAME="send_notification/5"><STRONG><CODE>send_notification(Agent,Notification,Receiver,
NotifyName,Varbinds)</CODE></STRONG></A><BR>
<A NAME="send_notification/6"><STRONG><CODE>send_notification(Agent,Notification,Receiver,
NotifyName,ContextName,Varbinds) -&#62; void() </CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Agent = pid() | atom()</CODE></STRONG><BR>
<STRONG><CODE>Notification = atom()</CODE></STRONG><BR>
<STRONG><CODE>Receiver = no_receiver | {Tag, Recv}</CODE></STRONG><BR>
<STRONG><CODE>Tag = term()</CODE></STRONG><BR>
<STRONG><CODE>Recv = pid() | atom() | {Mod,Func,Args}</CODE></STRONG><BR>
<STRONG><CODE>Mod = atom()</CODE></STRONG><BR>
<STRONG><CODE>Func = atom()</CODE></STRONG><BR>
<STRONG><CODE>Args = list()</CODE></STRONG><BR>
<STRONG><CODE>NotifyName = string()</CODE></STRONG><BR>
<STRONG><CODE>ContextName = string()</CODE></STRONG><BR>
<STRONG><CODE>Varbinds = [Varbind]</CODE></STRONG><BR>
<STRONG><CODE>Varbind = {Variable, Value} | {Column, RowIndex, Value} |
        {OID, Value}</CODE></STRONG><BR>
<STRONG><CODE>Variable = atom()</CODE></STRONG><BR>
<STRONG><CODE>Column = atom()</CODE></STRONG><BR>
<STRONG><CODE>OID = oid()</CODE></STRONG><BR>
<STRONG><CODE>Value = term()</CODE></STRONG><BR>
<STRONG><CODE>RowIndex = [int()]</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Sends the notification <CODE>Notification</CODE> to the
        management targets defined for <CODE>NotifyName</CODE> in the
        <CODE>snmpNotifyTable</CODE> in SNMP-NOTIFICATION-MIB from the
        specified context. If no <CODE>NotifyName</CODE> is specified (or
        if it is <CODE>&#34;&#34;</CODE>), the notification is sent to all
        management targets. If no <CODE>ContextName</CODE> is specified,
        the default <CODE>&#34;&#34;</CODE> context is used.

        
<P>The parameter <CODE>Receiver</CODE> specifies where information
        about delivery of Inform-Requests should be sent. The agent
        sends Inform-Requests and waits for acknowledgements from the
        managers. If the <CODE>Receiver</CODE> is specified as
        <CODE>no_receiver</CODE>, nothing is sent. Otherwise, it is
        specified as <CODE>{Tag, Recv}</CODE>. The receiver (<CODE>Recv</CODE>)
         gets a message:

        
<P>
<UL>

<LI>
<CODE>{snmp_targets, Tag, Addresses}</CODE>
        
</LI>


</UL>

<P><CODE>Addresses</CODE> is a list of management target addresses.
        If UDP over IP is used, this is a 2-tuple <CODE>{IP,
        UDPport}</CODE>, where <CODE>IP</CODE> is a 4-tuple with the IP
        address, and <CODE>UDPport</CODE> is an integer. The notification
        is sent as an Inform-Request to each target address in
        <CODE>Addresses</CODE>. If there are no targets for which an
        Inform-Request is sent, <CODE>Addresses</CODE> is the empty list
        <CODE>[]</CODE>.

        
<P>For each such <CODE>Address</CODE> is the <CODE>Addresses</CODE> list,
         one of the following two messages is sent to <CODE>Recv</CODE>:

        
<P>
<UL>

<LI>
<CODE>{snmp_notification, Tag, {got_response, Address}}</CODE>
         
</LI>


<LI>
<CODE>{snmp_notification, Tag, {no_response, Address}}</CODE>
        
</LI>


</UL>

<P>The optional argument <CODE>Varbinds</CODE> defines
        values for the objects in the notification. If no value is
        given for an object, the <CODE>Agent</CODE> performs a get-operation
        to retrieve the value.

        
<P><CODE>Varbinds</CODE> is a list of <CODE>Varbind</CODE>, where each
         <CODE>Varbind</CODE> is one of:

        
<P>
<UL>

<LI>
<CODE>{Variable, Value}</CODE>, where <CODE>Variable</CODE> is the
         symbolic name of a scalar variable referred to in the notification
         specification.
         
         
</LI>


<LI>
<CODE>{Column, RowIndex, Value}</CODE>, where <CODE>Column</CODE>
         is the symbolic name of a column variable.
         <CODE>RowIndex</CODE> is a list of indices for the specified
         element. If this is the case, the OBJECT IDENTIFIER sent
         in the notification is the <CODE>RowIndex</CODE> appended to the OBJECT
         IDENTIFIER for the table column. This is the OBJECT
         IDENTIFIER which specifies the element.
         
         
</LI>


<LI>
<CODE>{OID, Value}</CODE>, where <CODE>OID</CODE> is the OBJECT
         IDENTIFIER for an instance of an object, scalar variable,
         or column variable.

        
</LI>


</UL>

<P>For example, to specify that <CODE>sysLocation</CODE> should have the
         value <CODE>&#34;upstairs&#34;</CODE> in the notification, we could use one of:

        
<P>
<UL>

<LI>
<CODE>{sysLocation, &#34;upstairs&#34;}</CODE> or
         
</LI>


<LI>
<CODE>{[1,3,6,1,2,1,1,6,0], &#34;upstairs&#34;}</CODE> or
         
</LI>


<LI>
<CODE>{?sysLocation_instance, &#34;upstairs&#34;}</CODE> (provided
         that the generated <CODE>.hrl</CODE> file is included)
        
</LI>


</UL>

<P>If a variable in the notification is a table element, the
        <CODE>RowIndex</CODE> for the element must be given in the
        <CODE>Varbinds</CODE> list. In this case, the OBJECT IDENTIFIER sent
        in the notification is the OBJECT IDENTIFIER that identifies this
        element. This OBJECT IDENTIFIER could be used in a get
        operation later.

        
<P>This function is asynchronous, and does not return any
        information. If an error occurs, <CODE>user_err/2</CODE> of the error
        report module is called and the notification is discarded.


</DIV>

<P><A NAME="send_trap/3"><STRONG><CODE>send_trap(Agent,Trap,Community)</CODE></STRONG></A><BR>
<A NAME="send_trap/4"><STRONG><CODE>send_trap(Agent,Trap,Community,Varbinds) -&#62; void()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Agent = pid() | atom()</CODE></STRONG><BR>
<STRONG><CODE>Trap = atom()</CODE></STRONG><BR>
<STRONG><CODE>Community = string()</CODE></STRONG><BR>
<STRONG><CODE>Varbinds = [Varbind]</CODE></STRONG><BR>
<STRONG><CODE>Varbind = {Variable, Value} | {Column, RowIndex, Value} |
        {OID, Value}</CODE></STRONG><BR>
<STRONG><CODE>Variable = atom()</CODE></STRONG><BR>
<STRONG><CODE>Column = atom()</CODE></STRONG><BR>
<STRONG><CODE>OID = oid()</CODE></STRONG><BR>
<STRONG><CODE>Value = term()</CODE></STRONG><BR>
<STRONG><CODE>RowIndex = [int()]</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Note! This function is only kept for backwards
        compatibility reasons. Use <CODE>send_notification</CODE> instead.

        
<P>Sends the trap <CODE>Trap</CODE> to the managers defined for
        <CODE>Community</CODE> in the <CODE>intTrapDestTable</CODE> in
        OTP-SNMPEA-MIB. The optional argument <CODE>Varbinds</CODE> defines
        values for the objects in the trap. If no value is given for
        an object, the <CODE>Agent</CODE> performs a get-operation to
        retrieve the value.

        
<P><CODE>Varbinds</CODE> is a list of <CODE>Varbind</CODE>, where each
         <CODE>Varbind</CODE> is one of:

        
<P>
<UL>

<LI>
<CODE>{Variable, Value}</CODE>, where <CODE>Variable</CODE> is the
         symbolic name of a scalar variable referred to in the trap
         specification.
         
         
</LI>


<LI>
<CODE>{Column, RowIndex, Value}</CODE>, where <CODE>Column</CODE>
         is the symbolic name of a column variable.
         <CODE>RowIndex</CODE> is a list of indices for the specified
         element. If this is the case, the OBJECT IDENTIFIER sent
         in the trap is the <CODE>RowIndex</CODE> appended to the OBJECT
         IDENTIFIER for the table column. This is the OBJECT
         IDENTIFIER which specifies the element.
         
         
</LI>


<LI>
<CODE>{OID, Value}</CODE>, where <CODE>OID</CODE> is the OBJECT
         IDENTIFIER for an instance of an object, scalar variable,
         or column variable.

        
</LI>


</UL>

<P>For example, to specify that <CODE>sysLocation</CODE> should have the
         value <CODE>&#34;upstairs&#34;</CODE> in the trap, we could use one of:

        
<P>
<UL>

<LI>
<CODE>{sysLocation, &#34;upstairs&#34;}</CODE> or
         
</LI>


<LI>
<CODE>{[1,3,6,1,2,1,1,6,0], &#34;upstairs&#34;}</CODE> or
         
</LI>


<LI>
<CODE>{?sysLocation_instance, &#34;upstairs&#34;}</CODE> (provided
         that the generated <CODE>.hrl</CODE> file is included)
        
</LI>


</UL>

<P>If a variable in the trap is a table element, the
        <CODE>RowIndex</CODE> for the element must be given in the
        <CODE>Varbinds</CODE> list. In this case, the OBJECT IDENTIFIER sent
        in the trap is the OBJECT IDENTIFIER that identifies this
        element. This OBJECT IDENTIFIER could be used in a get
        operation later.

        
<P>This function is asynchronous, and does not return any
        information. If an error occurs, <CODE>snmp_error:user_err/2</CODE>
        is called and the trap is discarded.


        <A NAME="convert_config"><!-- Empty --></A> 

</DIV>

<P><A NAME="convert_config/1"><STRONG><CODE>convert_config(OldConfig) -&#62; AgentConfig</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>OldConfig = list()</CODE></STRONG><BR>
<STRONG><CODE>AgentConfig = list()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>This off-line utility function can be used to convert
the old snmp application config (pre snmp-4.0) to the 
new snmp agent config (as of snmp-4.0).
<P>For information about the old config (<CODE>OldConfig</CODE>) 
see the OTP R9C documentation.
<P>For information about the current agent config 
(<CODE>AgentConfig</CODE>), see either
the <A HREF="snmp_app.html">SNMP application</A> 
part of the reference manual or the 
<A HREF="snmp_config.html">Configuring the application</A> 
chapter of the SNMP user's guide.<A NAME="verbosity"><!-- Empty --></A>
</DIV>

<P><A NAME="verbosity/2"><STRONG><CODE>verbosity(Ref,Verbosity) -&#62; void()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Ref = pid() | sub_agents | master_agent | net_if | mib_server | 
        symbolic_store | note_store | local_db</CODE></STRONG><BR>
<STRONG><CODE>Verbosity = verbosity() | {subagents, verbosity()}</CODE></STRONG><BR>
<STRONG><CODE>verbosity() = silence | info | log | debug | trace </CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Sets verbosity for the designated process. For the lowest 
        verbosity <CODE>silence</CODE>, nothing is printed. The higher the
        verbosity, the more is printed.


</DIV>

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

<P>calendar(3), erlc(1)


</DIV>

<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
Micael Karlberg - 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>