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
|
.TH snmp_target_mib 3 "snmp 4.11" "Ericsson AB" "ERLANG MODULE DEFINITION"
.SH MODULE
snmp_target_mib \- Instrumentation Functions for SNMP-TARGET-MIB
.SH DESCRIPTION
.LP
The module \fIsnmp_target_mib\fR implements the instrumentation functions for the SNMP-TARGET-MIB, and functions for configuring the database\&.
.LP
The configuration files are described in the SNMP User\&'s Manual\&.
.SH EXPORTS
.LP
.B
configure(ConfDir) -> void()
.br
.RS
.TP
Types
ConfDir = string()
.br
.RE
.RS
.LP
This function is called from the supervisor at system start-up\&.
.LP
Inserts all data in the configuration files into the database and destroys all old rows with StorageType \fIvolatile\fR\&. The rows created from the configuration file will have StorageType \fInonVolatile\fR\&.
.LP
All \fIsnmp\fR counters are set to zero\&.
.LP
If an error is found in the configuration file, it is reported using the function \fIconfig_err/2\fR of the error report module, and the function fails with the reason \fIconfiguration_error\fR\&.
.LP
\fIConfDir\fR is a string which points to the directory where the configuration files are found\&.
.LP
The configuration files read are: \fItarget_addr\&.conf\fR and \fItarget_params\&.conf\fR\&.
.RE
.LP
.B
reconfigure(ConfDir) -> void()
.br
.RS
.TP
Types
ConfDir = string()
.br
.RE
.RS
.LP
Inserts all data in the configuration files into the database and destroys all old data, including the rows with StorageType \fInonVolatile\fR\&. The rows created from the configuration file will have StorageType \fInonVolatile\fR\&.
.LP
Thus, the data in the SNMP-TARGET-MIB, after this function has been called, is the data from the configuration files\&.
.LP
All \fIsnmp\fR counters are set to zero\&.
.LP
If an error is found in the configuration file, it is reported using the function \fIconfig_err/2\fR of the , and the function fails with the reason \fIconfiguration_error\fR\&.
.LP
\fIConfDir\fR is a string which points to the directory where the configuration files are found\&.
.LP
The configuration files read are: \fItarget_addr\&.conf\fR and \fItarget_params\&.conf\fR\&.
.RE
.LP
.B
set_target_engine_id(TargetAddrName, EngineId) -> boolean()
.br
.RS
.TP
Types
TargetAddrName = string()
.br
EngineId = string()
.br
.RE
.RS
.LP
Changes the engine id for a target in the \fIsnmpTargetAddrTable\fR\&. If notifications are sent as Inform requests to a target, its engine id must be set\&.
.RE
.LP
.B
add_addr(Name, Ip, Port, Timeout, Retry, TagList, Params, EngineId, TMask, MMS) -> Ret
.br
.RS
.TP
Types
Name = string()
.br
Ip = [integer()], length 4
.br
Port = integer()
.br
Timeout = integer()
.br
Retry = integer()
.br
TagList = string()
.br
ParamsName = string()
.br
EngineId = string()
.br
TMask = string(), length 0 or 6
.br
MMS = integer()
.br
Ret = {ok, Key} | {error, Reason}
.br
Key = term()
.br
Reason = term()
.br
.RE
.RS
.LP
Adds a target address definition to the agent config\&. Equivalent to one line in the \fItarget_addr\&.conf\fR file\&.
.RE
.LP
.B
delete_addr(Key) -> Ret
.br
.RS
.TP
Types
Key = term()
.br
Ret = ok | {error, Reason}
.br
Reason = term()
.br
.RE
.RS
.LP
Delete a target address definition from the agent config\&.
.RE
.LP
.B
add_params(Name, MPModel, SecModel, SecName, SecLevel) -> Ret
.br
.RS
.TP
Types
Name = string()
.br
MPModel = v1 | v2c | v3
.br
SecModel = v1 | v2c | usm
.br
SecName = string()
.br
SecLevel = noAuthNoPriv | authNoPriv | authPriv
.br
Ret = {ok, Key} | {error, Reason}
.br
Key = term()
.br
Reason = term()
.br
.RE
.RS
.LP
Adds a target parameter definition to the agent config\&. Equivalent to one line in the \fItarget_params\&.conf\fR file\&.
.RE
.LP
.B
delete_params(Key) -> Ret
.br
.RS
.TP
Types
Key = term()
.br
Ret = ok | {error, Reason}
.br
Reason = term()
.br
.RE
.RS
.LP
Delete a target parameter definition from the agent config\&.
.RE
|
