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

NAME

6       snmp_user_based_sm_mib - Instrumentation Functions for SNMP-USER-BASED-
7       SM-MIB
8

DESCRIPTION

10       The module snmp_user_based_sm_mib implements the instrumentation  func‐
11       tions for the SNMP-USER-BASED-SM-MIB, and functions for configuring the
12       database.
13
14       Note that authentication has been extended according to RFC 7860 (SNMP-
15       USM-HMAC-SHA2-MIB).
16
17       The configuration files are described in the SNMP User's Manual.
18

EXPORTS

20       configure(ConfDir) -> void()
21
22              Types:
23
24                 ConfDir = string()
25
26              This function is called from the supervisor at system start-up.
27
28              Inserts  all  data  in the configuration files into the database
29              and destroys all old rows with StorageType  volatile.  The  rows
30              created  from  the configuration file will have StorageType non‐
31              Volatile.
32
33              All snmp counters are set to zero.
34
35              If an error is found in the configuration file, it  is  reported
36              using  the function config_err/2 of the error report module, and
37              the function fails with the reason configuration_error.
38
39              ConfDir is a string which points to the directory where the con‐
40              figuration files are found.
41
42              The configuration file read is: usm.conf.
43
44       reconfigure(ConfDir) -> void()
45
46              Types:
47
48                 ConfDir = string()
49
50              Inserts  all  data  in the configuration files into the database
51              and destroys all old data, including the rows  with  StorageType
52              nonVolatile.  The  rows created from the configuration file will
53              have StorageType nonVolatile.
54
55              Thus, the data in the SNMP-USER-BASED-SM-MIB, after  this  func‐
56              tion has been called, is the data from the configuration files.
57
58              All snmp counters are set to zero.
59
60              If  an  error is found in the configuration file, it is reported
61              using the function config_err/2 of the error report module,  and
62              the function fails with the reason configuration_error.
63
64              ConfDir is a string which points to the directory where the con‐
65              figuration files are found.
66
67              The configuration file read is: usm.conf.
68
69       add_user(EngineID, Name, SecName, Clone, AuthP, AuthKeyC,  OwnAuthKeyC,
70       PrivP, PrivKeyC, OwnPrivKeyC, Public, AuthKey, PrivKey) -> Ret
71
72              Types:
73
74                 EngineID = string()
75                 Name = string()
76                 SecName = string()
77                 Clone = zeroDotZero | [integer()]
78                 AuthP = usmNoAuthProtocol | usmHMACMD5AuthProtocol | usmHMAC‐
79                 SHAAuthProtocol  |   usmHMAC128SHA224AuthProtocol   |   usmH‐
80                 MAC192SH256AuthProtocol   |   usmHMAC256SHA384AuthProtocol  |
81                 usmHMAC384SHA512AuthProtocol
82                 AuthKeyC = string()
83                 OwnAuthKeyC = string()
84                 PrivP = usmNoPrivProtocol | usmDESPrivProtocol
85                 PrivKeyC = string()
86                 OwnPrivKeyC = string()
87                 Public = string()
88                 AuthKey = string()
89                 PrivKey = string()
90                 Ret = {ok, Key} | {error, Reason}
91                 Key = term()
92                 Reason = term()
93
94              Adds a USM security data (user) to the agent config.  Equivalent
95              to one line in the usm.conf file.
96
97       delete_user(Key) -> Ret
98
99              Types:
100
101                 Key = term()
102                 Ret = ok | {error, Reason}
103                 Reason = term()
104
105              Delete a USM security data (user) from the agent config.
106
107
108
109Ericsson AB                       snmp 5.13.3        snmp_user_based_sm_mib(3)