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

NAME

6       snmpm_mpd - Message Processing and Dispatch module for the SNMP manager
7

DESCRIPTION

9       The  module  snmpm_mpd  implements the version independent Message Pro‐
10       cessing and Dispatch functionality in SNMP for the manager. It is  sup‐
11       posed  to  be used from a Network Interface process (Definition of Man‐
12       ager Net if).
13
14       Legacy API function process_msg/7 that  has  got  separate  IpAddr  and
15       PortNumber  arguments still works as before for backwards compatibility
16       reasons.
17

EXPORTS

19       init(Vsns) -> mpd_state()
20
21              Types:
22
23                 Vsns = [Vsn]
24                 Vsn = v1 | v2 | v3
25
26              This function can be called from the net_if process at start-up.
27              The options list defines which versions to use.
28
29              It also initializes some SNMP counters.
30
31       process_msg(Msg,  Domain,  Addr, State, NoteStore, Logger) -> {ok, Vsn,
32       Pdu, PduMS, MsgData} | {discarded, Reason}
33
34              Types:
35
36                 Msg = binary()
37                 Domain = transportDomainUdpIpv4 | transportDomainUdpIpv6
38                 Addr = {inet:ip_address(), inet:port_number()}
39                 State = mpd_state()
40                 NoteStore = pid()
41                 Logger = function()
42                 Vsn = 'version-1' | 'version-2' | 'version-3'
43                 Pdu = #pdu
44                 PduMs = integer()
45                 MsgData = term()
46
47              Processes  an  incoming  message.  Performs  authentication  and
48              decryption  as necessary. The return values should be passed the
49              manager server.
50
51              NoteStore is the pid() of the note-store process.
52
53              Logger is the function used for audit trail logging.
54
55              In the case when the pdu type is report, MsgData is either ok or
56              {error, ReqId, Reason}.
57
58       generate_msg(Vsn,  NoteStore,  Pdu,  MsgData, Logger) -> {ok, Packet} |
59       {discarded, Reason}
60
61              Types:
62
63                 Vsn = 'version-1' | 'version-2' | 'version-3'
64                 NoteStore = pid()
65                 Pdu = #pdu
66                 MsgData = term()
67                 Logger = function()
68                 Packet = binary()
69                 Reason = term()
70
71              Generates a possibly encrypted packet to be sent to the network.
72
73              NoteStore is the pid() of the note-store process.
74
75              MsgData is the message specific data used in the  SNMP  message.
76              In  SNMPv1  and  SNMPv2c,  this  message  data  is the community
77              string. In SNMPv3, it is the context information.
78
79              Logger is the function used for audit trail logging.
80
81       generate_response_msg(Vsn, Pdu, MsgData,  Logger)  ->  {ok,  Packet}  |
82       {discarded, Reason}
83
84              Types:
85
86                 Vsn = 'version-1' | 'version-2' | 'version-3'
87                 Pdu = #pdu
88                 MsgData = term()
89                 Logger = function()
90                 Packet = binary()
91                 Reason = term()
92
93              Generates a possibly encrypted response packet to be sent to the
94              network.
95
96              MsgData is the message specific data used in the  SNMP  message.
97              This value is received from the process_msg function.
98
99
100
101Ericsson AB                        snmp 5.8                       snmpm_mpd(3)