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

NAME

6       snmp_target_mib - Instrumentation Functions for SNMP-TARGET-MIB
7

DESCRIPTION

9       The module snmp_target_mib implements the instrumentation functions for
10       the SNMP-TARGET-MIB, and functions for configuring the database.
11
12       The configuration files are described in the SNMP User's Manual.
13
14       Legacy API functions add_addr/10 that does not  specify  transport  do‐
15       main, and add_addr/11 that has got separate IpAddr and PortNumber argu‐
16       ments still work as before for backwards compatibility reasons.
17

DATA TYPES

19       See the  data types in snmpa_conf.
20

EXPORTS

22       configure(ConfDir) -> void()
23
24              Types:
25
26                 ConfDir = string()
27
28              This function is called from the supervisor at system start-up.
29
30              Inserts all data in the configuration files  into  the  database
31              and  destroys  all  old rows with StorageType volatile. The rows
32              created from the configuration file will have  StorageType  non‐
33              Volatile.
34
35              All snmp counters are set to zero.
36
37              If  an  error is found in the configuration file, it is reported
38              using the function config_err/2 of the error report module,  and
39              the function fails with the reason configuration_error.
40
41              ConfDir is a string which points to the directory where the con‐
42              figuration files are found.
43
44              The configuration files  read  are:  target_addr.conf  and  tar‐
45              get_params.conf.
46
47       reconfigure(ConfDir) -> void()
48
49              Types:
50
51                 ConfDir = string()
52
53              Inserts  all  data  in the configuration files into the database
54              and destroys all old data, including the rows  with  StorageType
55              nonVolatile.  The  rows created from the configuration file will
56              have StorageType nonVolatile.
57
58              Thus, the data in the SNMP-TARGET-MIB, after this  function  has
59              been called, is the data from the configuration files.
60
61              All snmp counters are set to zero.
62
63              If  an  error is found in the configuration file, it is reported
64              using the function config_err/2 of the , and the function  fails
65              with the reason configuration_error.
66
67              ConfDir is a string which points to the directory where the con‐
68              figuration files are found.
69
70              The configuration files  read  are:  target_addr.conf  and  tar‐
71              get_params.conf.
72
73       set_target_engine_id(TargetAddrName, EngineId) -> boolean()
74
75              Types:
76
77                 TargetAddrName = string()
78                 EngineId = string()
79
80              Changes  the  engine id for a target in the snmpTargetAddrTable.
81              If notifications are sent as Inform requests to  a  target,  its
82              engine id must be set.
83
84       add_addr(Name, Domain, Addr, Timeout, Retry, TagList, Params, EngineId,
85       TMask, MMS) -> Ret
86
87              Types:
88
89                 Name = string()
90                 Domain = transportDomain()
91                 Addr = transportAddress() % Default port is 162
92                 Timeout = integer()
93                 Retry = integer()
94                 TagList = string()
95                 ParamsName = string()
96                 EngineId = string()
97                 TMask = transportAddressMask() % Depends on Domain
98                 MMS = integer()
99                 Ret = {ok, Key} | {error, Reason}
100                 Key = term()
101                 Reason = term()
102
103              Adds a target address definition to the agent config. Equivalent
104              to one line in the target_addr.conf file.
105
106       delete_addr(Key) -> Ret
107
108              Types:
109
110                 Key = term()
111                 Ret = ok | {error, Reason}
112                 Reason = term()
113
114              Delete a target address definition from the agent config.
115
116       add_params(Name, MPModel, SecModel, SecName, SecLevel) -> Ret
117
118              Types:
119
120                 Name = string()
121                 MPModel = v1 | v2c | v3
122                 SecModel = v1 | v2c | usm
123                 SecName = string()
124                 SecLevel = noAuthNoPriv | authNoPriv | authPriv
125                 Ret = {ok, Key} | {error, Reason}
126                 Key = term()
127                 Reason = term()
128
129              Adds  a target parameter definition to the agent config. Equiva‐
130              lent to one line in the target_params.conf file.
131
132       delete_params(Key) -> Ret
133
134              Types:
135
136                 Key = term()
137                 Ret = ok | {error, Reason}
138                 Reason = term()
139
140              Delete a target parameter definition from the agent config.
141
142
143
144Ericsson AB                       snmp 5.13.5               snmp_target_mib(3)
Impressum