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

NAME

6       snmpm_conf - Utility functions for handling the manager config files.
7

DESCRIPTION

9       The  module  snmpm_conf  contains various utility functions to used for
10       manipulating (write/append/read) the config files of the SNMP manager.
11

EXPORTS

13       manager_entry(Tag, Val) -> manager_entry()
14
15              Types:
16
17                 Tag = address | port | engine_id | max_message_size
18                 Val = term()
19                 manager_entry() = term()
20
21              Create an entry for the manager config file, manager.conf.
22
23              The type of Val depends on the value of Tag, see Manager  Infor‐
24              mation for more info.
25
26       write_manager_config(Dir, Conf) -> ok
27       write_manager_config(Dir, Hdr, Conf) -> ok
28
29              Types:
30
31                 Dir = string()
32                 Hdr = string()
33                 Conf = [manager_entry()]
34
35              Write the manager config to the manager config file.
36
37              Dir is the path to the directory where to store the config file.
38
39              Hdr  is  an optional file header (note that this text is written
40              to the file as is).
41
42              See Manager Information for more info.
43
44       append_manager_config(Dir, Conf) -> ok
45
46              Types:
47
48                 Dir = string()
49                 Conf = [manager_entry()]
50
51              Append the config to the current manager config file.
52
53              Dir is the path to the directory where to store the config file.
54
55              See Manager Information for more info.
56
57       read_manager_config(Dir) -> Conf
58
59              Types:
60
61                 Dir = string()
62                 Conf = [manager_entry()]
63
64              Read the current manager config file.
65
66              Dir is the path to the directory where to store the config file.
67
68              See Manager Information for more info.
69
70       users_entry(UserId) -> users_entry()
71       users_entry(UserId, UserMod) -> users_entry()
72       users_entry(UserId, UserMod, UserData) -> users_entry()
73
74              Types:
75
76                 UserId = term()
77                 UserMod = atom()
78                 UserData = term()
79                 standard_entry() = term()
80
81              Create an entry for the manager users config file, users.conf.
82
83              users_entry(UserId) translates to the following call:  users_en‐
84              try(UserId, snmpm_user_default).
85
86              users_entry(UserId,  UserMod)  translates to the following call:
87              users_entry(UserId, UserMod, undefined).
88
89              See Users for more info.
90
91       write_users_config(Dir, Conf) -> ok
92       write_users_config(Dir, Hdr, Conf) -> ok
93
94              Types:
95
96                 Dir = string()
97                 Hdr = string()
98                 Conf = [users_entry()]
99
100              Write the manager users config to the manager users config file.
101
102              Dir is the path to the directory where to store the config file.
103
104              Hdr is an optional file header (note that this text  is  written
105              to the file as is).
106
107              See Users for more info.
108
109       append_users_config(Dir, Conf) -> ok
110
111              Types:
112
113                 Dir = string()
114                 Conf = [users_entry()]
115
116              Append  the  users  config  to  the current manager users config
117              file.
118
119              Dir is the path to the directory where to store the config file.
120
121              See Users for more info.
122
123       read_users_config(Dir) -> Conf
124
125              Types:
126
127                 Dir = string()
128                 Conf = [users_entry()]
129
130              Read the current manager users config file.
131
132              Dir is the path to the directory where to store the config file.
133
134              See Users for more info.
135
136       agents_entry(UserId, TargetName, Comm, Domain, Addr, EngineID, Timeout,
137       MaxMessageSize, Version, SecModel, SecName, SecLevel) -> agents_entry()
138
139              Types:
140
141                 UserId = term()
142                 TargetName = string()
143                 Comm = string()
144                 Domain = transportDomain()
145                 Addr = transportAddress()
146                 EngineID = string()
147                 Timeout = integer()
148                 MaxMessageSize = integer()
149                 Version = v1 | v2 | v3
150                 SecModel = v1 | v2c | usm
151                 SecName = string()
152                 SecLevel = noAuthNoPriv | authNoPriv | authPriv
153                 agents_entry() = term()
154
155              Create an entry for the manager agents config file, agents.conf.
156
157              See Agents for more info.
158
159       write_agents_config(Dir, Conf) -> ok
160       write_agents_config(Dir, Hdr, Conf) -> ok
161
162              Types:
163
164                 Dir = string()
165                 Hdr = string()
166                 Conf = [_entry()]
167
168              Write  the  manager  agents  config to the manager agents config
169              file.
170
171              Dir is the path to the directory where to store the config file.
172
173              Hdr is an optional file header (note that this text  is  written
174              to the file as is).
175
176              See Agents for more info.
177
178       append_agents_config(Dir, Conf) -> ok
179
180              Types:
181
182                 Dir = string()
183                 Conf = [agents_entry()]
184
185              Append  the  agents  config to the current manager agents config
186              file.
187
188              Dir is the path to the directory where to store the config file.
189
190              See Agents for more info.
191
192       read_agents_config(Dir) -> Conf
193
194              Types:
195
196                 Dir = string()
197                 Conf = [agents_entry()]
198
199              Read the current manager agents config file.
200
201              Dir is the path to the directory where to store the config file.
202
203              See Agents for more info.
204
205       usm_entry(EngineID,  UserName,  AuthP,  AuthKey,  PrivP,  PrivKey)   ->
206       usm_entry()
207       usm_entry(EngineID,  UserName, SecName, AuthP, AuthKey, PrivP, PrivKey)
208       -> usm_entry()
209
210              Types:
211
212                 EngineID = string()
213                 UserName = string()
214                 SecName = string()
215                 AuthP = usmNoAuthProtocol | usmHMACMD5AuthProtocol | usmHMAC‐
216                 SHAAuthProtocol   |   usmHMAC128SHA224AuthProtocol   |  usmH‐
217                 MAC192SH256AuthProtocol  |   usmHMAC256SHA384AuthProtocol   |
218                 usmHMAC384SHA512AuthProtocol
219                 AuthKey = [integer()]
220                 PrivP   =   usmNoPrivProtocol   |  usmDESPrivProtocol  |  us‐
221                 mAesCfb128Protocol
222                 PrivKey = [integer()]
223                 usm_entry() = term()
224
225              Create an entry for the  agent  community  config  file,  commu‐
226              nity.conf.
227
228              See Security data for USM for more info.
229
230       write_usm_config(Dir, Conf) -> ok
231       write_usm_config(Dir, Hdr, Conf) -> ok
232
233              Types:
234
235                 Dir = string()
236                 Hdr = string()
237                 Conf = [usm_entry()]
238
239              Write the manager usm config to the manager usm config file.
240
241              Dir is the path to the directory where to store the config file.
242
243              Hdr  is  an optional file header (note that this text is written
244              to the file as is).
245
246              See Security data for USM for more info.
247
248       append_usm_config(Dir, Conf) -> ok
249
250              Types:
251
252                 Dir = string()
253                 Conf = [usm_entry()]
254
255              Append the usm config to the current manager usm config file.
256
257              Dir is the path to the directory where to store the config file.
258
259              See Security data for USM for more info.
260
261       read_usm_config(Dir) -> Conf
262
263              Types:
264
265                 Dir = string()
266                 Conf = [usm_entry()]
267
268              Read the current manager usm config file.
269
270              Dir is the path to the directory where to store the config file.
271
272              See Security data for USM for more info.
273
274
275
276Ericsson AB                        snmp 5.15                     snmpm_conf(3)