1snmpa_discovery_handler(3) Erlang Module Definition snmpa_discovery_handler(3)
2
3
4

NAME

6       snmpa_discovery_handler - Behaviour module for the SNMP agent discovery
7       handler.
8

DESCRIPTION

10       This module defines the behaviour of the  agent  discovery  handler.  A
11       snmpa_discovery_handler  compliant  module  must  export  the following
12       functions:
13
14         * stage1_finish/2
15
16       The semantics of them and their exact signatures are explained below.
17

EXPORTS

19       stage1_finish(TargetName, ManagerEngineID, ExtraInfo) -> ignore |  {ok,
20       usm_entry() | [usm_entry()]} | {ok, usm_entry() | [usm_entry()], NewEx‐
21       traInfo}
22
23              Types:
24
25                 TargetName = string()
26                 ManagerEngineID = string()
27                 ExtraInfo = term()
28                 usm_entry() = tuple() compatible with usm.conf
29                 NewExtraInfo = term()
30
31              This function is called at the end of stage 1 of  the  discovery
32              process.  It  should  return  either  the  atom  ignore  or {ok,
33              usm_entry() | [usm_entry()]}. See usm_entry()  and  usm_entry/13
34              for more info.
35
36              If the function returns ignore, then it is assumed that either:
37
38                * The  caller (of the discovery function) will make the needed
39                  updates later.
40
41                * The callback function itself did the updates.
42
43              In either case, the  agent  will  do  nothing,  but  return  the
44              retrieved ManagerEngineID (see discovery for more info) and pos‐
45              sible continue with stage 2 of the discovery process.
46
47              The ExtraInfo argument is passed on from the discovery function.
48
49              This function may return an updated NewExtraInfo  that  will  be
50              used in subsequent calls to the callback functions. Intended for
51              future use.
52
53              The purpose of this function is to  generate  the  usm-  related
54              security  data  needed for usm processing in the agent. Specifi‐
55              cally, updating the usmUserTable.
56
57              When an  usm_entry()  tuple  (or  a  list  of  such  tuples)  is
58              returned,  this  data  is  then added to the usmUserTable by the
59              (master-) agent.
60
61              When an  usm_entry()  tuple  (or  a  list  of  such  tuples)  is
62              returned,  this  data  is  then added to the usmUserTable by the
63              (master-) agent.
64
65          Note:
66              Note that the function does not  check  if  this  entry  already
67              exists.
68
69
70          Note:
71              Note  that  this function is executed in the context of the mas‐
72              ter-agent process.
73
74
75
76
77Ericsson AB                        snmp 5.5         snmpa_discovery_handler(3)
Impressum