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       The configuration files are described in the SNMP User's Manual.
15

EXPORTS

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