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

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

<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
 Interface functions to the SNMP toolkit manager

</DIV>

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

<P>The module <CODE>snmpm</CODE> contains interface functions to the 
SNMP manager. 
</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>


<LI>
        <CODE>snmp_reply() = {error_status(), error_index(), varbinds()}</CODE>
<BR>

</LI>


<LI>
        <CODE>error_status() = noError | atom()</CODE>
<BR>

</LI>


<LI>
        <CODE>error_index() = integer()</CODE>
<BR>

</LI>


<LI>
        <CODE>varbinds() = [varbind()]</CODE>
<BR>

</LI>


</UL>

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

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

</DIV>

<H3>EXPORTS</H3>

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

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

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Monitor the SNMP manager. In case of a crash, the calling 
         (monitoring) process will get a 'DOWN' message (see the erlang 
         module for more info).
        
        <A NAME="demonitor"><!-- Empty --></A> 

</DIV>

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

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

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Turn off monitoring of the SNMP manager.
        
<A NAME="notify_started"><!-- Empty --></A> 

</DIV>

<P><A NAME="notify_started/1"><STRONG><CODE>notify_started(Timeout) -&#62; Pid</CODE></STRONG></A><BR>

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

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Request a notification (message) when the SNMP manager has 
started. 
<P>The <CODE>Timeout</CODE> is the time the request is valid. The 
value has to be greater then zero. 
<P>The <CODE>Pid</CODE> is the process handling the supervision of the 
SNMP manager start. When the manager has started a completion
message will be sent to the client from this process: 
<CODE>{snmpm_started, Pid}</CODE>. If the SNMP manager was not started 
in time, a timeout message will be sent to the client: 
<CODE>{snmpm_start_timeout, Pid}</CODE>. 
<P>A client application that is dependent on the SNMP manager 
will use this function in order to be notified of when the
manager has started. There are two situtations when this 
is useful:
<P>
<UL>

<LI>
 During the start of a system, when a client application 
<STRONG>could</STRONG> start prior to the SNMP manager but is dependent
upon it, and therefor has to wait for it to start.<BR>


</LI>


<LI>
 When the SNMP manager has crashed, the dependent client 
application has to wait for the SNMP manager to be restarted
before it can <STRONG>reconnect</STRONG>.<BR>


</LI>


</UL>

<P>The function returnes the pid() of a handler process, that does
the supervision on behalf of the client application. Note that the 
client application is linked to this handler. 
<P>This function is used in conjuction with the monitor function.<A NAME="cancel_notify_started"><!-- Empty --></A>
</DIV>

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

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

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Cancel a previous request to be notified of SNMP manager start.<A NAME="register_user"><!-- Empty --></A>
</DIV>

<P><A NAME="register_user/3"><STRONG><CODE>register_user(Id, Module, Data) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Id = term()</CODE></STRONG><BR>
<STRONG><CODE>Module = snmpm_user()</CODE></STRONG><BR>
<STRONG><CODE>Data = term()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>
<STRONG><CODE>snmpm_user() = Module implementing the snmpm_user behaviour</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Register the manager entity (=user) responsible for specific 
         agent(s). 
<P><CODE>Module</CODE> is the callback module (snmpm_user behaviour) which 
         will be called whenever something happens (detected 
         agent, incomming reply or incomming trap/notification).
         Note that this could have already been done as a 
         consequence of the node config. (see users.conf).<A NAME="register_user_monitor"><!-- Empty --></A>
</DIV>

<P><A NAME="register_user_monitor/3"><STRONG><CODE>register_user_monitor(Id, Module, Data) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Id = term()</CODE></STRONG><BR>
<STRONG><CODE>Module = snmpm_user()</CODE></STRONG><BR>
<STRONG><CODE>Data = term()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>
<STRONG><CODE>snmpm_user() = Module implementing the snmpm_user behaviour</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Register the monitored manager entity (=user) responsible 
         for specific agent(s). 
<P>The process performing the registration will be monitored. 
         Which means that if that process should die, all agents 
         registered by that user process will be unregistered. All 
         outstanding requsts will be canceled. 
<P><CODE>Module</CODE> is the callback module (snmpm_user behaviour) which 
         will be called whenever something happens (detected 
         agent, incomming reply or incomming trap/notification).
         Note that this could have already been done as a 
         consequence of the node config. (see users.conf).<A NAME="unregister_user"><!-- Empty --></A>
</DIV>

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

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

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Unregister the user.<A NAME="which_users"><!-- Empty --></A>
</DIV>

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

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Users = [UserId]</CODE></STRONG><BR>
<STRONG><CODE>UserId = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Get a list of the identities of all registered users.<A NAME="register_agent"><!-- Empty --></A>
</DIV>

<P><A NAME="register_agent/2"><STRONG><CODE>register_agent(UserId, Addr) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="register_agent/3"><STRONG><CODE>register_agent(UserId, Addr, Port) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="register_agent/3"><STRONG><CODE>register_agent(UserId, Addr, Config) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="register_agent/4"><STRONG><CODE>register_agent(UserId, Addr, Port, Config) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>UserId = term()</CODE></STRONG><BR>
<STRONG><CODE>Addr = ip_address()</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>Config = [agent_config()]</CODE></STRONG><BR>
<STRONG><CODE>agent_config() = {Item, Val}</CODE></STRONG><BR>
<STRONG><CODE>Item = target_name | community | engine_id | timeout | max_message_size | version | sec_model | sec_name | sec_level</CODE></STRONG><BR>
<STRONG><CODE>Val = term()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Explicitly instruct the manager to handle this agent, with
         <CODE>UserId</CODE> as the responsible user.
         Called to instruct the manager that this agent 
         shall be handled. These functions is used when
         the user know's in advance which agents the
         manager shall handle.
         Note that there is an alternate way to do the same thing:
         Add the agent to the manager config files (see agents.conf).
<P>The type of <CODE>Val</CODE> depends on <CODE>Item</CODE>: 
<P><CODE>target_name = string() </CODE>
<BR>
<CODE>community = string() </CODE>
<BR>
<CODE>engine_id = string() </CODE>
<BR>
<CODE>timeout = integer() | snmp_timer()</CODE>
<BR>
<CODE>max_message_size = integer()</CODE>
<BR>
<CODE>version = v1 | v2 | v3 </CODE>
<BR>
<CODE>sec_model = any | v1 | v2c | usm </CODE>
         <BR>
<CODE>sec_name = string() </CODE>
         <BR>
<CODE>sec_level = noAuthNoPriv | authNoPriv | authPriv</CODE>
        
<P>Note that if no <CODE>Port</CODE> is given, the agent default is
         used.<A NAME="unregister_agent"><!-- Empty --></A>
</DIV>

<P><A NAME="unregister_agent/2"><STRONG><CODE>unregister_agent(UserId, Addr) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="unregister_agent/3"><STRONG><CODE>unregister_agent(UserId, Addr, Port) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>UserId = term()</CODE></STRONG><BR>
<STRONG><CODE>Addr = ip_address()</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Unregister the agent.<A NAME="agent_info"><!-- Empty --></A>
</DIV>

<P><A NAME="agent_info/3"><STRONG><CODE>agent_info(Addr, Port, Item) -&#62; {ok, Val} | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Addr = ip_address()</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>Item = atom()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Retrieve agent config.<A NAME="update_agent_info"><!-- Empty --></A>
</DIV>

<P><A NAME="update_agent_info/5"><STRONG><CODE>update_agent_info(UserId, Addr, Port, Item, Val) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>UserId = term()</CODE></STRONG><BR>
<STRONG><CODE>Addr = ip_address()</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>Item = atom()</CODE></STRONG><BR>
<STRONG><CODE>Val = term()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Update agent config.<A NAME="which_agents"><!-- Empty --></A>
</DIV>

<P><A NAME="which_agents/0"><STRONG><CODE>which_agents() -&#62; Agents</CODE></STRONG></A><BR>
<A NAME="which_agents/1"><STRONG><CODE>which_agents(UserId) -&#62; Agents</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>UserId = term()</CODE></STRONG><BR>
<STRONG><CODE>Agents = [{Addr,Port}]</CODE></STRONG><BR>
<STRONG><CODE>Addr = ip_address()</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Get a list of all registered agents or all agents registerd
         by a specific user.<A NAME="register_usm_user"><!-- Empty --></A>
</DIV>

<P><A NAME="register_usm_user/3"><STRONG><CODE>register_usm_user(EngineID, UserName, Conf) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>EngineID = string()</CODE></STRONG><BR>
<STRONG><CODE>UserName = string()</CODE></STRONG><BR>
<STRONG><CODE>Conf = [usm_config()]</CODE></STRONG><BR>
<STRONG><CODE>usm_config() = {Item, Val}</CODE></STRONG><BR>
<STRONG><CODE>Item = sec_name | auth | auth_key | priv | priv_key</CODE></STRONG><BR>
<STRONG><CODE>Val = term()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Explicitly instruct the manager to handle this USM user.
         Note that there is an alternate way to do the same thing:
         Add the usm user to the manager config files (see 
         <A HREF="snmp_manager_config_files.html#usm_user">usm.conf</A>).
<P>The type of <CODE>Val</CODE> depends on <CODE>Item</CODE>: 
<P><CODE>sec_name = string(),</CODE> 
         <BR>
<CODE>auth = usmNoAuthProtocol | usmHMACMD5AuthProtocol | usmHMACSHAAuthProtocoltimeout</CODE>
         <BR>
<CODE>auth_key = [integer()]</CODE> (length 16 if auth = usmHMACMD5AuthProtocol, length 20 if auth = usmHMACSHAAuthProtocol),
         <BR>
<CODE>priv = usmNoPrivProtocol | usmDESPrivProtocol | usmAesCfb128Protocol</CODE>,
         <BR>
<CODE>priv_key = [integer()]</CODE> (length is 16 if priv = usmDESPrivProtocol | usmAesCfb128Protocol).<A NAME="unregister_usm_user"><!-- Empty --></A>
</DIV>

<P><A NAME="unregister_usm_user/2"><STRONG><CODE>unregister_usm_user(EngineID, UserName) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>EngineID = string()</CODE></STRONG><BR>
<STRONG><CODE>UserName = string()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Unregister this USM user.<A NAME="which_usm_users1"><!-- Empty --></A>
</DIV>

<P><A NAME="usm_user_info/3"><STRONG><CODE>usm_user_info(EngineID, UserName, Item) -&#62; {ok, Val} | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>EngineID = string()</CODE></STRONG><BR>
<STRONG><CODE>UsmName = string()</CODE></STRONG><BR>
<STRONG><CODE>Item = sec_name | auth | auth_key | priv | priv_key</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Retrieve usm user config.<A NAME="update_usm_user_info"><!-- Empty --></A>
</DIV>

<P><A NAME="update_usm_user_info/4"><STRONG><CODE>update_usm_user_info(EngineID, UserName, Item, Val) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>EngineID = string()</CODE></STRONG><BR>
<STRONG><CODE>UsmName = string()</CODE></STRONG><BR>
<STRONG><CODE>Item = sec_name | auth | auth_key | priv | priv_key</CODE></STRONG><BR>
<STRONG><CODE>Val = term()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Update usm user config.<A NAME="which_usm_users"><!-- Empty --></A>
</DIV>

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

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>UsmUsers = [{EngineID,UserName}]</CODE></STRONG><BR>
<STRONG><CODE>EngineID = string()</CODE></STRONG><BR>
<STRONG><CODE>UsmName = string()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Get a list of all registered usm users.<A NAME="which_usm_users2"><!-- Empty --></A>
</DIV>

<P><A NAME="which_usm_users/1"><STRONG><CODE>which_usm_users(EngineID) -&#62; UsmUsers</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>UsmUsers = [UserName]</CODE></STRONG><BR>
<STRONG><CODE>UserName = string()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Get a list of all registered usm users with engine-id 
         <CODE>EngineID</CODE>.<A NAME="g"><!-- Empty --></A>
</DIV>

<P><A NAME="g/3"><STRONG><CODE>g(UserId, Addr, Oids) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="g/4"><STRONG><CODE>g(UserId, Addr, Port, Oids) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="g/4"><STRONG><CODE>g(UserId, Addr, ContextName, Oids) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="g/4"><STRONG><CODE>g(UserId, Addr, Oids, Timeout) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="g/5"><STRONG><CODE>g(UserId, Addr, Port, ContextName, Oids) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="g/5"><STRONG><CODE>g(UserId, Addr, Port, Oids, Timeout) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="g/5"><STRONG><CODE>g(UserId, Addr, ContextName, Oids, Timeout) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="g/6"><STRONG><CODE>g(UserId, Addr, Port, ContextName, Oids, Timeout) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="g/7"><STRONG><CODE>g(UserId, Addr, Port, ContextName, Oids, Timeout, ExtraInfo) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>UserId = term()</CODE></STRONG><BR>
<STRONG><CODE>Addr = ip_address()</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>ContextName = string()</CODE></STRONG><BR>
<STRONG><CODE>Oids = [oid()]</CODE></STRONG><BR>
<STRONG><CODE>Timeout = integer()</CODE></STRONG><BR>
<STRONG><CODE>ExtraInfo = term()</CODE></STRONG><BR>
<STRONG><CODE>SnmpReply = snmp_reply()</CODE></STRONG><BR>
<STRONG><CODE>Remaining = integer()</CODE></STRONG><BR>
<STRONG><CODE>Reason = {send_failed, ReqId, R} | {invalid_sec_info, SecInfo, SnmpInfo} | term()</CODE></STRONG><BR>
<STRONG><CODE>R = term()</CODE></STRONG><BR>
<STRONG><CODE>SecInfo = [sec_info()]</CODE></STRONG><BR>
<STRONG><CODE>sec_info() = {sec_tag(), ExpectedValue, ReceivedValue}</CODE></STRONG><BR>
<STRONG><CODE>sec_tag() = atom()</CODE></STRONG><BR>
<STRONG><CODE>ExpectedValue = ReceivedValue = term()</CODE></STRONG><BR>
<STRONG><CODE>SnmpInfo = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Synchronous <CODE>get-request</CODE>. 
<P><CODE>Remaining</CODE> is the remaining time of the given or 
         default timeout time.
<P>When <STRONG>Reason</STRONG> is <STRONG>{send_failed, ...}</STRONG> it means that
         the net_if process failed to send the message. This could happen
         because of any number of reasons, i.e. encoding error. <STRONG>R</STRONG> 
         is the actual reason in this case. 
<P><CODE>ExtraInfo</CODE> is an opaque data structure passed on to
         the net-if process. The net-if process included in this
         application makes no use of this info, so the only use for it
         in such a configuration (when using the built in net-if) would
         be tracing.
<P>For <CODE>SnmpInfo</CODE>, see the user callback function 
         <A HREF="snmpm_user.html#handle_report">handle_report</A>.<A NAME="ag"><!-- Empty --></A>
</DIV>

<P><A NAME="ag/3"><STRONG><CODE>ag(UserId, Addr, Oids) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="ag/4"><STRONG><CODE>ag(UserId, Addr, Port, Oids) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="ag/4"><STRONG><CODE>ag(UserId, Addr, ContextName, Oids) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="ag/4"><STRONG><CODE>ag(UserId, Addr, Oids, Expire) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="ag/5"><STRONG><CODE>ag(UserId, Addr, Port, ContextName, Oids) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="ag/5"><STRONG><CODE>ag(UserId, Addr, Port, Oids, Expire) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="ag/5"><STRONG><CODE>ag(UserId, Addr, ContextName, Oids, Expire) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="ag/6"><STRONG><CODE>ag(UserId, Addr, Port, ContextName, Oids, Expire) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="ag/7"><STRONG><CODE>ag(UserId, Addr, Port, ContextName, Oids, Expire, ExtraInfo) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>UserId = term()</CODE></STRONG><BR>
<STRONG><CODE>Addr = ip_address()</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>ContextName = string()</CODE></STRONG><BR>
<STRONG><CODE>Oids = [oid()]</CODE></STRONG><BR>
<STRONG><CODE>Expire = integer()</CODE></STRONG><BR>
<STRONG><CODE>ExtraInfo = term()</CODE></STRONG><BR>
<STRONG><CODE>ReqId = term()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Asynchronous <CODE>get-request</CODE>.
<P>The reply, if it arrives, will be delivered to the user 
         through a call to the snmpm_user callback function 
         <CODE>handle_pdu</CODE>.
<P>The <CODE>Expire</CODE> time indicates for how long the request is 
         valid (after which the manager is free to delete it).
<P><CODE>ExtraInfo</CODE> is an opaque data structure passed on to
         the net-if process. The net-if process included in this
         application makes no use of this info, so the only use for it
         in such a configuration (when using the built in net-if) would
         be tracing.<A NAME="gn"><!-- Empty --></A>
</DIV>

<P><A NAME="gn/3"><STRONG><CODE>gn(UserId, Addr, Oids) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="gn/4"><STRONG><CODE>gn(UserId, Addr, Port, Oids) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="gn/4"><STRONG><CODE>gn(UserId, Addr, ContextName, Oids) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="gn/4"><STRONG><CODE>gn(UserId, Addr, Oids, Timeout) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="gn/5"><STRONG><CODE>gn(UserId, Addr, Port, ContextName, Oids) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="gn/5"><STRONG><CODE>gn(UserId, Addr, Port, Oids, Timeout) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="gn/5"><STRONG><CODE>gn(UserId, Addr, ContextName, Oids, Timeout) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="gn/6"><STRONG><CODE>gn(UserId, Addr, Port, ContextName, Oids, Timeout) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="gn/7"><STRONG><CODE>gn(UserId, Addr, Port, ContextName, Oids, Timeout, ExtraInfo) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>UserId = term()</CODE></STRONG><BR>
<STRONG><CODE>Addr = ip_address()</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>ContextName = string()</CODE></STRONG><BR>
<STRONG><CODE>Oids = [oid()]</CODE></STRONG><BR>
<STRONG><CODE>Timeout = integer()</CODE></STRONG><BR>
<STRONG><CODE>ExtraInfo = term()</CODE></STRONG><BR>
<STRONG><CODE>SnmpReply = snmp_reply()</CODE></STRONG><BR>
<STRONG><CODE>Remaining = integer()</CODE></STRONG><BR>
<STRONG><CODE>Reason = {send_failed, ReqId, R} | {invalid_sec_info, SecInfo, SnmpInfo} | term()</CODE></STRONG><BR>
<STRONG><CODE>R = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Synchronous <CODE>get-next-request</CODE>. 
<P><CODE>Remaining</CODE> time of the given or default timeout time.
<P>When <STRONG>Reason</STRONG> is <STRONG>{send_failed, ...}</STRONG> it means that
         the net_if process failed to send the message. This could happen
         because of any number of reasons, i.e. encoding error. <STRONG>R</STRONG> 
         is the actual reason in this case. 
<P><CODE>ExtraInfo</CODE> is an opaque data structure passed on to
         the net-if process. The net-if process included in this
         application makes no use of this info, so the only use for it
         in such a configuration (when using the built in net-if) would
         be tracing.<A NAME="agn"><!-- Empty --></A>
</DIV>

<P><A NAME="agn/3"><STRONG><CODE>agn(UserId, Addr, Oids) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="agn/4"><STRONG><CODE>agn(UserId, Addr, Port, Oids) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="agn/4"><STRONG><CODE>agn(UserId, Addr, ContextName, Oids) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="agn/4"><STRONG><CODE>agn(UserId, Addr, Oids, Expire) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="agn/5"><STRONG><CODE>agn(UserId, Addr, Port, ContextName, Oids) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="agn/5"><STRONG><CODE>agn(UserId, Addr, Port, Oids, Expire) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="agn/5"><STRONG><CODE>agn(UserId, Addr, ContextName, Oids, Expire) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="agn/6"><STRONG><CODE>agn(UserId, Addr, Port, ContextName, Oids, Expire) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="agn/7"><STRONG><CODE>agn(UserId, Addr, Port, ContextName, Oids, Expire, ExtraInfo) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>UserId = term()</CODE></STRONG><BR>
<STRONG><CODE>Addr = ip_address()</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>ContextName = string()</CODE></STRONG><BR>
<STRONG><CODE>Oids = [oid()]</CODE></STRONG><BR>
<STRONG><CODE>Expire = integer()</CODE></STRONG><BR>
<STRONG><CODE>ExtraInfo = term()</CODE></STRONG><BR>
<STRONG><CODE>ReqId = integer()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Asynchronous <CODE>get-next-request</CODE>. 
<P>The reply will be delivered to the user through a call
to the snmpm_user callback function <CODE>handle_pdu</CODE>.
<P>The <CODE>Expire</CODE> time indicates for how long the request is 
         valid (after which the manager is free to delete it).<A NAME="s"><!-- Empty --></A>
</DIV>

<P><A NAME="s/3"><STRONG><CODE>s(UserId, Addr, VarsAndVals) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="s/4"><STRONG><CODE>s(UserId, Addr, Port, VarsAndVals) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="s/4"><STRONG><CODE>s(UserId, Addr, ContextName, VarsAndVals) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="s/4"><STRONG><CODE>s(UserId, Addr, VarsAndVals, Timeout) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="s/5"><STRONG><CODE>s(UserId, Addr, Port, ContextName, VarsAndVals) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="s/5"><STRONG><CODE>s(UserId, Addr, Port, VarsAndVals, Timeout) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="s/5"><STRONG><CODE>s(UserId, Addr, ContextName, VarsAndVals, Timeout) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="s/6"><STRONG><CODE>s(UserId, Addr, Port, ContextName, VarsAndVals, Timeout) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="s/7"><STRONG><CODE>s(UserId, Addr, Port, ContextName, VarsAndVals, Timeout, ExtraInfo) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>UserId = term()</CODE></STRONG><BR>
<STRONG><CODE>Addr = ip_address()</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>ContextName = string()</CODE></STRONG><BR>
<STRONG><CODE>VarsAndVals = [var_and_val()]</CODE></STRONG><BR>
<STRONG><CODE>var_and_val() = {oid(), value_type(), value()} | {oid(), value()}</CODE></STRONG><BR>
<STRONG><CODE>value_type() = o ('OBJECT IDENTIFIER') | i ('INTEGER') | u ('Unsigned32') | g ('Unsigned32') | s ('OCTET SRING') | b ('BITS') | ip ('IpAddress') | op ('Opaque') | c32 ('Counter32') | c64 ('Counter64') | tt ('TimeTicks') </CODE></STRONG><BR>
<STRONG><CODE>value() = term() </CODE></STRONG><BR>
<STRONG><CODE>Timeout = integer()</CODE></STRONG><BR>
<STRONG><CODE>ExtraInfo = term()</CODE></STRONG><BR>
<STRONG><CODE>SnmpReply = snmp_reply()</CODE></STRONG><BR>
<STRONG><CODE>Remaining = integer()</CODE></STRONG><BR>
<STRONG><CODE>Reason = {send_failed, ReqId, R} | {invalid_sec_info, SecInfo, SnmpInfo} | term()</CODE></STRONG><BR>
<STRONG><CODE>R = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Synchronous <CODE>set-request</CODE>. 
<P><CODE>Remaining</CODE> time of the given or default timeout time.
<P>When <STRONG>Reason</STRONG> is <STRONG>{send_failed, ...}</STRONG> it means that
         the net_if process failed to send the message. This could happen
         because of any number of reasons, i.e. encoding error. <STRONG>R</STRONG> 
         is the actual reason in this case. 
<P>When <STRONG>var_and_val()</STRONG> is <STRONG>{oid(), value()}</STRONG>, the
         manager makes an educated guess based on the loaded mibs. 
<P><CODE>ExtraInfo</CODE> is an opaque data structure passed on to
         the net-if process. The net-if process included in this
         application makes no use of this info, so the only use for it
         in such a configuration (when using the built in net-if) would
         be tracing.<A NAME="as"><!-- Empty --></A>
</DIV>

<P><A NAME="as/3"><STRONG><CODE>as(UserId, Addr, VarsAndVals) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="as/4"><STRONG><CODE>as(UserId, Addr, Port, VarsAndVals) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="as/4"><STRONG><CODE>as(UserId, Addr, ContextName, VarsAndVals) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="as/4"><STRONG><CODE>as(UserId, Addr, VarsAndVals, Expire) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="as/5"><STRONG><CODE>as(UserId, Addr, Port, ContextName, VarsAndVals) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="as/5"><STRONG><CODE>as(UserId, Addr, Port, VarsAndVals, Expire) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="as/5"><STRONG><CODE>as(UserId, Addr, ContextName, VarsAndVals, Expire) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="as/6"><STRONG><CODE>as(UserId, Addr, Port, ContextName, VarsAndVals, Expire) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="as/7"><STRONG><CODE>as(UserId, Addr, Port, ContextName, VarsAndVals, Expire, ExtraInfo) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>UserId = term()</CODE></STRONG><BR>
<STRONG><CODE>Addr = ip_address()</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>VarsAndVals = [var_and_val()]</CODE></STRONG><BR>
<STRONG><CODE>var_and_val() = {oid(), value_type(), value() | {oid(), value()}</CODE></STRONG><BR>
<STRONG><CODE>value_type() = o ('OBJECT IDENTIFIER') | i ('INTEGER') | u ('Unsigned32') | g ('Unsigned32') | s ('OCTET SRING') | b ('BITS') | ip ('IpAddress') | op ('Opaque') | c32 ('Counter32') | c64 ('Counter64') | tt ('TimeTicks') </CODE></STRONG><BR>
<STRONG><CODE>value() = term() </CODE></STRONG><BR>
<STRONG><CODE>Expire = integer()</CODE></STRONG><BR>
<STRONG><CODE>ExtraInfo = term()</CODE></STRONG><BR>
<STRONG><CODE>ReqId = term()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Asynchronous <CODE>set-request</CODE>. 
<P>The reply will be delivered to the user through a call
to the snmpm_user callback function <CODE>handle_pdu</CODE>.
<P>The <CODE>Expire</CODE> time indicates for how long the request is 
         valid (after which the manager is free to delete it).
<P>When <STRONG>var_and_val()</STRONG> is <STRONG>{oid(), value()}</STRONG>, the
         manager makes an educated guess based on the loaded mibs. 
<P><CODE>ExtraInfo</CODE> is an opaque data structure passed on to
         the net-if process. The net-if process included in this
         application makes no use of this info, so the only use for it
         in such a configuration (when using the built in net-if) would
         be tracing.<A NAME="gb"><!-- Empty --></A>
</DIV>

<P><A NAME="gb/5"><STRONG><CODE>gb(UserId, Addr, NonRep, MaxRep, Oids) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="gb/6"><STRONG><CODE>gb(UserId, Addr, Port, NonRep, MaxRep, Oids) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="gb/6"><STRONG><CODE>gb(UserId, Addr, NonRep, MaxRep, ContextName, Oids) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="gb/6"><STRONG><CODE>gb(UserId, Addr, NonRep, MaxRep, Oids, Timeout) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="gb/7"><STRONG><CODE>gb(UserId, Addr, Port, NonRep, MaxRep, ContextName, Oids) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="gb/7"><STRONG><CODE>gb(UserId, Addr, Port, NonRep, MaxRep, Oids, Timeout) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="gb/7"><STRONG><CODE>gb(UserId, Addr, NonRep, MaxRep, ContextName, Oids, Timeout) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="gb/8"><STRONG><CODE>gb(UserId, Addr, Port, NonRep, MaxRep, ContextName, Oids, Timeout) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="gb/9"><STRONG><CODE>gb(UserId, Addr, Port, NonRep, MaxRep, ContextName, Oids, Timeout, ExtraInfo) -&#62; {ok, SnmpReply, Remaining} | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>UserId = term()</CODE></STRONG><BR>
<STRONG><CODE>Addr = ip_address()</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>NonRep = integer()</CODE></STRONG><BR>
<STRONG><CODE>MaxRep = integer()</CODE></STRONG><BR>
<STRONG><CODE>ContextName = string()</CODE></STRONG><BR>
<STRONG><CODE>Oids = [oid()]</CODE></STRONG><BR>
<STRONG><CODE>Timeout = integer()</CODE></STRONG><BR>
<STRONG><CODE>ExtraInfo = term()</CODE></STRONG><BR>
<STRONG><CODE>SnmpReply = snmp_reply()</CODE></STRONG><BR>
<STRONG><CODE>Remaining = integer()</CODE></STRONG><BR>
<STRONG><CODE>Reason = {send_failed, ReqId, R} | {invalid_sec_info, SecInfo, SnmpInfo} | term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Synchronous <CODE>get-bulk-request</CODE> (See RFC1905).
        
<P><CODE>Remaining</CODE> time of the given or default timeout time.
<P>When <STRONG>Reason</STRONG> is <STRONG>{send_failed, ...}</STRONG> it means that
         the net_if process failed to send the message. This could happen
         because of any number of reasons, i.e. encoding error. <STRONG>R</STRONG> 
         is the actual reason in this case. 
<P><CODE>ExtraInfo</CODE> is an opaque data structure passed on to
         the net-if process. The net-if process included in this
         application makes no use of this info, so the only use for it
         in such a configuration (when using the built in net-if) would
         be tracing.<A NAME="agb"><!-- Empty --></A>
</DIV>

<P><A NAME="agb/5"><STRONG><CODE>agb(UserId, Addr, NonRep, MaxRep, Oids) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="agb/6"><STRONG><CODE>agb(UserId, Addr, Port, NonRep, MaxRep, Oids) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="agb/6"><STRONG><CODE>agb(UserId, Addr, NonRep, MaxRep, ContextName, Oids) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="agb/6"><STRONG><CODE>agb(UserId, Addr, NonRep, MaxRep, Oids, Expire) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="agb/7"><STRONG><CODE>agb(UserId, Addr, Port, NonRep, MaxRep, ContextName, Oids) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="agb/7"><STRONG><CODE>agb(UserId, Addr, Port, NonRep, MaxRep, Oids, Expire) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="agb/7"><STRONG><CODE>agb(UserId, Addr, NonRep, MaxRep, ContextName, Oids, Expire) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="agb/8"><STRONG><CODE>agb(UserId, Addr, Port, NonRep, MaxRep, ContextName, Oids, Expire) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>
<A NAME="agb/9"><STRONG><CODE>agb(UserId, Addr, Port, NonRep, MaxRep, ContextName, Oids, Expire, ExtraInfo) -&#62; {ok, ReqId} | {error, Reason}</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>UserId = term()</CODE></STRONG><BR>
<STRONG><CODE>Addr = ip_address()</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>NonRep = integer()</CODE></STRONG><BR>
<STRONG><CODE>MaxRep = integer()</CODE></STRONG><BR>
<STRONG><CODE>ContextName = string()</CODE></STRONG><BR>
<STRONG><CODE>Oids = [oid()]</CODE></STRONG><BR>
<STRONG><CODE>Expire = integer()</CODE></STRONG><BR>
<STRONG><CODE>ExtraInfo = term()</CODE></STRONG><BR>
<STRONG><CODE>ReqId = integer()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Asynchronous <CODE>get-bulk-request</CODE> (See RFC1905).
        
<P>The reply will be delivered to the user through a call
to the snmpm_user callback function <CODE>handle_pdu</CODE>.
<P>The <CODE>Expire</CODE> time indicates for how long the request is 
         valid (after which the manager is free to delete it).<A NAME="cancel_async_request"><!-- Empty --></A>
</DIV>

<P><A NAME="cancel_async_request/2"><STRONG><CODE>cancel_async_request(UserId, ReqId) -&#62; ok | {error, Reason}</CODE></STRONG></A><BR>

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

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Cancel a preious asynchronous request.<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;./snmpm_log.txt&#34;. 
         <CODE>LogName</CODE> defaults to &#34;snmpm_log&#34;. 
         <CODE>LogFile</CODE> defaults to &#34;snmpm.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="load_mib"><!-- Empty --></A>
</DIV>

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

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Mib = MibName</CODE></STRONG><BR>
<STRONG><CODE>MibName = string()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Load a <CODE>Mib</CODE> into the manager. 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;,
          snmpm:load_mib(Dir ++ &#34;MY-MIB&#34;).
        
</PRE>
<A NAME="unload_mib"><!-- Empty --></A>
</DIV>

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

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Mib = MibName</CODE></STRONG><BR>
<STRONG><CODE>MibName = string()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Unload a <CODE>Mib</CODE> from the manager. 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;,
          snmpm:unload_mib(Dir ++ &#34;MY-MIB&#34;).
        
</PRE>
<A NAME="which_mibs"><!-- Empty --></A>
</DIV>

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

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<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>Get a list of all the mib's loaded into the manager.<A NAME="name_to_oid"><!-- Empty --></A>
</DIV>

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

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

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Transform a aliasname to it's oid.
<P>Note that an aliasname is only unique within the mib, so
         when loading several mib's into a manager, there might be
         several instances of the same aliasname.<A NAME="oid_to_name"><!-- Empty --></A>
</DIV>

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

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

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Transform a oid to it's aliasname.<A NAME="backup"><!-- Empty --></A>
</DIV>

<P><A NAME="backup/1"><STRONG><CODE>backup(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>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Backup persistent/permanent data handled by the manager. 
<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>

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

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>Returns a list (a dictionary) containing information about
         the manager. Information includes statistics counters, 
miscellaneous info about each process (e.g. memory allocation), 
and so on.<A NAME="verbosity"><!-- Empty --></A>
</DIV>

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

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Ref = server | config | net_if | note_store | all</CODE></STRONG><BR>
<STRONG><CODE>Verbosity = 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.<A NAME="format_reason"><!-- Empty --></A>
</DIV>

<P><A NAME="format_reason/1"><STRONG><CODE>format_reason(Reason) -&#62; string()</CODE></STRONG></A><BR>
<A NAME="format_reason/2"><STRONG><CODE>format_reason(Prefix, Reason) -&#62; string()</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>
<STRONG><CODE>Prefix = integer() | string()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P>This utility function is used to create a formatted 
(pretty printable) string of the error reason received
from either:


<P>
<UL>

<LI>
         The <CODE>Reason</CODE> returned value if any of the 
sync/async get/get-next/set/get-bulk
functions returnes <CODE>{error, Reason}</CODE>
<BR>

</LI>


<LI>
         The <CODE>Reason</CODE> parameter in the 
<A HREF="snmpm_user.html#handle_error"> handle_error</A> user callback function.
<BR>

</LI>


</UL>

<P><CODE>Prefix</CODE> should either be an indention string
(e.g. a list of spaces) or a positive integer (wich will be used
to create the indention string of that length).
</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>