1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
<TITLE>snmp_target_mib</TITLE>
<SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
<STYLE TYPE="text/css">
<!--
.REFBODY { margin-left: 13mm }
.REFTYPES { margin-left: 8mm }
-->
</STYLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
ALINK="#FF0000">
<!-- refpage -->
<CENTER>
<A HREF="http://www.erlang.se">
<IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif">
</A>
<H1>snmp_target_mib</H1>
</CENTER>
<H3>MODULE</H3>
<DIV CLASS=REFBODY>
snmp_target_mib
</DIV>
<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
Instrumentation Functions for
SNMP-TARGET-MIB
</DIV>
<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>
<P>The module <CODE>snmp_target_mib</CODE> implements the instrumentation
functions for the
SNMP-TARGET-MIB, and functions for configuring the database.
<P>The configuration files are described in the SNMP User's Manual.
</DIV>
<H3>EXPORTS</H3>
<P><A NAME="configure/1"><STRONG><CODE>configure(ConfDir) -> void()</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>ConfDir = string()</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P>This function is called from the supervisor at system
start-up.
<P>Inserts all data in the configuration files into the
database and destroys all old rows with StorageType
<CODE>volatile</CODE>. The rows created from the configuration file
will have StorageType <CODE>nonVolatile</CODE>.
<P>All <CODE>snmp</CODE> counters are set to zero.
<P>If an error is found in the configuration file, it is
reported using the function <CODE>config_err/2</CODE> of the error
report module, and the function fails with the reason
<CODE>configuration_error</CODE>.
<P><CODE>ConfDir</CODE> is a string which points to the directory
where the configuration files are found.
<P>The configuration files read are: <CODE>target_addr.conf</CODE>
and <CODE>target_params.conf</CODE>.
</DIV>
<P><A NAME="reconfigure/1"><STRONG><CODE>reconfigure(ConfDir) -> void()</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>ConfDir = string()</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P>Inserts all data in the configuration files into the
database and destroys all old data, including the rows with
StorageType <CODE>nonVolatile</CODE>. The rows created from the
configuration file will have StorageType <CODE>nonVolatile</CODE>.
<P>Thus, the data in the SNMP-TARGET-MIB, after this
function has been called, is the data from the configuration
files.
<P>All <CODE>snmp</CODE> counters are set to zero.
<P>If an error is found in the configuration file, it is
reported using the function <CODE>config_err/2</CODE> of the ,
and the function fails with the reason <CODE>configuration_error</CODE>.
<P><CODE>ConfDir</CODE> is a string which points to the directory
where the configuration files are found.
<P>The configuration files read are: <CODE>target_addr.conf</CODE>
and <CODE>target_params.conf</CODE>.
</DIV>
<P><A NAME="set_target_engine_id/2"><STRONG><CODE>set_target_engine_id(TargetAddrName, EngineId) -> boolean()</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>TargetAddrName = string()</CODE></STRONG><BR>
<STRONG><CODE>EngineId = string()</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P>Changes the enigne id for a target in the <CODE>snmpTargetAddrTable</CODE>.
If notifications are sent as Inform requests to a target, its
engine id must be set.
<A NAME="add_addr"><!-- Empty --></A>
</DIV>
<P><A NAME="add_addr/10"><STRONG><CODE>add_addr(Name, Ip, Port, Timeout, Retry, TagList, Params, EngineId, TMask, MMS) -> Ret</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Name = string()</CODE></STRONG><BR>
<STRONG><CODE>Ip = [integer()], length 4</CODE></STRONG><BR>
<STRONG><CODE>Port = integer()</CODE></STRONG><BR>
<STRONG><CODE>Timeout = integer()</CODE></STRONG><BR>
<STRONG><CODE>Retry = integer()</CODE></STRONG><BR>
<STRONG><CODE>TagList = string()</CODE></STRONG><BR>
<STRONG><CODE>ParamsName = string()</CODE></STRONG><BR>
<STRONG><CODE>EngineId = string()</CODE></STRONG><BR>
<STRONG><CODE>TMask = string(), length 0 or 6</CODE></STRONG><BR>
<STRONG><CODE>MMS = integer()</CODE></STRONG><BR>
<STRONG><CODE>Ret = {ok, Key} | {error, Reason}</CODE></STRONG><BR>
<STRONG><CODE>Key = term()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P>Adds a target address definition to the agent config.
Equivalent to one line in the <CODE>target_addr.conf</CODE> file.<A NAME="delete_addr"><!-- Empty --></A>
</DIV>
<P><A NAME="delete_addr/1"><STRONG><CODE>delete_addr(Key) -> Ret</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Key = term()</CODE></STRONG><BR>
<STRONG><CODE>Ret = ok | {error, Reason}</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P>Delete a target address definition from the agent config.<A NAME="add_params"><!-- Empty --></A>
</DIV>
<P><A NAME="add_params/5"><STRONG><CODE>add_params(Name, MPModel, SecModel, SecName, SecLevel) -> Ret</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Name = string()</CODE></STRONG><BR>
<STRONG><CODE>MPModel = v1 | v2c | v3</CODE></STRONG><BR>
<STRONG><CODE>SecModel = v1 | v2c | usm</CODE></STRONG><BR>
<STRONG><CODE>SecName = string()</CODE></STRONG><BR>
<STRONG><CODE>SecLevel = noAuthNoPriv | authNoPriv | authPriv</CODE></STRONG><BR>
<STRONG><CODE>Ret = {ok, Key} | {error, Reason}</CODE></STRONG><BR>
<STRONG><CODE>Key = term()</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P>Adds a target parameter definition to the agent config.
Equivalent to one line in the <CODE>target_params.conf</CODE> file.<A NAME="delete_params"><!-- Empty --></A>
</DIV>
<P><A NAME="delete_params/1"><STRONG><CODE>delete_params(Key) -> Ret</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Key = term()</CODE></STRONG><BR>
<STRONG><CODE>Ret = ok | {error, Reason}</CODE></STRONG><BR>
<STRONG><CODE>Reason = term()</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P>Delete a target parameter definition from the agent config.
</DIV>
<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
Martin Bjrklund - support@erlang.ericsson.se<BR>
</DIV>
<CENTER>
<HR>
<SMALL>snmp 4.8.2<BR>
Copyright © 1991-2006
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>
|
