1SNMP(7)                  Erlang Application Definition                 SNMP(7)
2
3
4

NAME

6       SNMP - The SNMP Application
7

DESCRIPTION

9       This  chapter  describes the snmp application in OTP. The SNMP applica‐
10       tion provides the following services:
11
12         * a multilingual extensible SNMP agent
13
14         * a SNMP manager
15
16         * a MIB compiler
17

CONFIGURATION

19       The following configuration parameters are defined for the SNMP  appli‐
20       cation.  Refer  to application(3) for more information about configura‐
21       tion parameters.
22
23       The snmp part of the config file specifying the  configuration  parame‐
24       ters is basically the following tuple:
25
26             {snmp, snmp_components_config()}
27
28
29       A  minimal  config  file for starting a node with both a manager and an
30       agent:
31
32             [{snmp,
33               [{agent, [{db_dir, "/tmp/snmp/agent/db"},
34                         {config, [{dir, "/tmp/snmp/agent/conf"}]}]},
35                {manager, [{config, [{dir, "/tmp/snmp/manager/conf"},
36                                     {db_dir, "/tmp/snmp/manager/db"}]}]}]}
37               ]
38              }
39             ].
40
41
42       Each snmp component has its own set of configuration  parameters,  even
43       though some of the types are common to both components.
44
45             snmp_components_config() -> [snmp_component_config()]
46             snmp_component_config() -> {agent, agent_options()} | {manager, manager_options()}
47             agent_options() = [agent_option()]
48             agent_option() = {restart_type,     restart_type()}     |
49                              {agent_type,       agent_type()}       |
50                              {agent_verbosity,  verbosity()}        |
51                              {discovery,        agent_discovery()}  |
52                              {versions,         versions()}         |
53                              {gb_max_vbs,       gb_max_vbs()}       |
54                              {priority,         priority()}         |
55                              {multi_threaded,   multi_threaded()}   |
56                              {db_dir,           db_dir()}           |
57                              {db_init_error,    db_init_error()}    |
58                              {local_db,         local_db()}         |
59                              {net_if,           agent_net_if()}     |
60                              {mibs,             mibs()}             |
61                              {mib_storage,      mib_storage()}      |
62                              {mib_server,       mib_server()}       |
63                              {audit_trail_log,  audit_trail_log()}  |
64                              {error_report_mod, error_report_mod()} |
65                              {note_store,       note_store()}       |
66                              {symbolic_store,   symbolic_store()}   |
67                              {target_cache,     target_cache()}     |
68                              {config,           agent_config()}
69             manager_options() = [manager_option()]
70             manager_option() = {restart_type,             restart_type()}    |
71                                {net_if,                   manager_net_if()}  |
72                                {server,                   server()}          |
73                                {note_store,               note_store()}      |
74                                {config,                   manager_config()}  |
75                                {inform_request_behaviour, manager_irb()}     |
76                                {mibs,                     manager_mibs()}    |
77                                {priority,                 priority()}        |
78                                {audit_trail_log,          audit_trail_log()} |
79                                {versions,                 versions()}        |
80                                {def_user_mod,             def_user_module()  |
81                                {def_user_data,            def_user_data()}
82
83
84       Agent specific config options and types:
85
86         agent_type() = master | sub <optional>:
87           If  master,  one  master agent is started. Otherwise, no agents are
88           started.
89
90           Default is master.
91
92         agent_discovery() = [agent_discovery_opt()] <optional>:
93           agent_discovery_opt()  =  {terminating,   agent_terminating_discov‐
94           ery_opts()} | {originating, agent_originating_discovery_opts()}
95
96           The terminating options effects discovery initiated by a manager.
97
98           The originating options effects discovery initiated by this agent.
99
100           For defaults see the options in agent_discovery_opt().
101
102         agent_terminating_discovery_opts()    =    [agent_terminating_discov‐
103         ery_opt()] <optional>:
104           agent_terminating_discovery_opt() = {enable, boolean()} |  {stage2,
105           discovery | plain} | {trigger_username, string()}
106
107           These  are  options  effecting  discovery terminating in this agent
108           (i.e. initiated by a manager).
109
110           The default values for the terminating discovery options are:
111
112           * enable: true
113
114           * stage2: discovery
115
116           * trigger_username: ""
117
118         agent_originating_discovery_opts()    =    [agent_originating_discov‐
119         ery_opt()] <optional>:
120           agent_originating_discovery_opt() = {enable, boolean()}
121
122           These are options effecting discovery originating in this agent.
123
124           The default values for the originating discovery options are:
125
126           * enable: true
127
128         multi_threaded() = bool() | extended <optional>:
129           If true (or extended), the agent is multi-threaded, with one thread
130           for each get request.
131
132           The value extended means that a special 'process' is  also  created
133           intended to handle all notifications.
134
135           * true  -  One  worker  dedicated  to 'set-requests' and one (main)
136             worker for all other requests ('get-request' and notifications).
137
138             If the 'main' worker is busy, a temporary process is  spawned  to
139             handle that job ('get-request' or notification).
140
141           * extended  -  One  worker  dedicated to 'set-requests', one worker
142             dedicated to notifications and one (main) worker for all 'get-re‐
143             quests'.
144
145             If  the  'main' worker is busy, a temporary process is spawned to
146             handle that 'get-request'.
147
148     Note:
149         Even with multi-threaded set to extended there is still  a  risk  for
150         'reorder'  when sending inform-requsts, which require a response (and
151         may therefor require resending).
152
153         Also, there is of course no way to guarantee order once  the  package
154         is on the network.
155
156
157           Default is false.
158
159         db_dir() = string() <mandatory>:
160           Defines where the SNMP agent internal db files are stored.
161
162         gb_max_vbs() = pos_integer() | infinity <optional>:
163           Defines  the  maximum  number of varbinds allowed in a Get-BULK re‐
164           sponse.
165
166           Default is 1000.
167
168         local_db() = [local_db_opt()] <optional>:
169           local_db_opt()   =   {repair,   agent_repair()}    |    {auto_save,
170           agent_auto_save()} | {verbosity, verbosity()}
171
172           Defines options specific for the SNMP agent local database.
173
174           For defaults see the options in local_db_opt().
175
176         agent_repair() = false | true | force <optional>:
177           When  starting  snmpa_local_db  it always tries to open an existing
178           database. If false, and some errors occur, a new database  is  cre‐
179           ated instead. If true, an existing file will be repaired. If force,
180           the table will be repaired even if it was properly closed.
181
182           Default is true.
183
184         agent_auto_save() = integer() | infinity <optional>:
185           The auto save interval. The table is flushed to disk  whenever  not
186           accessed for this amount of time.
187
188           Default is 5000.
189
190         agent_net_if() = [agent_net_if_opt()] <optional>:
191           agent_net_if_opt()  = {module, agent_net_if_module()} | {verbosity,
192           verbosity()} | {options, agent_net_if_options()}
193
194           Defines options specific for the SNMP agent network  interface  en‐
195           tity.
196
197           For defaults see the options in agent_net_if_opt().
198
199         agent_net_if_module() = atom() <optional>:
200           Module which handles the network interface part for the SNMP agent.
201           Must implement the snmpa_network_interface behaviour.
202
203           Default is snmpa_net_if.
204
205         agent_net_if_options() = [agent_net_if_option()] <optional>:
206           agent_net_if_option() = {bind_to, bind_to()} | {sndbuf, sndbuf()} |
207           {recbuf,   recbuf()}   |   {no_reuse,   no_reuse()}  |  {req_limit,
208           req_limit()}  |  {filter,  agent_net_if_filter_options()}  |   {ex‐
209           tra_sock_opts,  extra_socket_options()}  |  {inet_backend,  inet  |
210           socket}
211
212           These options are actually specific to the used  module.  The  ones
213           shown here are applicable to the default agent_net_if_module().
214
215     Note:
216         If  the  user  has configured transports with options then those will
217         take precedence over these options. See agent  information  for  more
218         info.
219
220
221           For defaults see the options in agent_net_if_option().
222
223         req_limit() = integer() | infinity <optional>:
224           Max number of simultaneous requests handled by the agent.
225
226           Default is infinity.
227
228         agent_net_if_filter_options()  =  [agent_net_if_filter_option()] <op‐
229         tional>:
230           agent_net_if_filter_option()  =  {module,  agent_net_if_filter_mod‐
231           ule()}
232
233           These  options  are  actually specific to the used module. The ones
234           shown here are applicable to the  default  agent_net_if_filter_mod‐
235           ule().
236
237           For defaults see the options in agent_net_if_filter_option().
238
239         agent_net_if_filter_module() = atom() <optional>:
240           Module which handles the network interface filter part for the SNMP
241           agent. Must implement the snmpa_network_interface_filter behaviour.
242
243           Default is snmpa_net_if_filter.
244
245         agent_mibs() = [string()] <optional>:
246           Specifies a list of MIBs (including path) that defines  which  MIBs
247           are initially loaded into the SNMP master agent.
248
249           Note that the following mibs will always be loaded:
250
251           * version v1: STANDARD-MIB
252
253           * version v2: SNMPv2
254
255           * version v3: SNMPv2, SNMP-FRAMEWORK-MIB and SNMP-MPD-MIB
256
257           Default is [].
258
259         mib_storage() = [mib_storage_opt()] <optional>:
260           mib_storage_opt()  =  {module,  mib_storage_module()}  |  {options,
261           mib_storage_options()}
262
263           This option specifies how basic mib data is stored. This option  is
264           used  by  two  parts of the snmp agent: The mib-server and the sym‐
265           bolic-store.
266
267           Default is [{module, snmpa_mib_storage_ets}].
268
269         mib_storage_module() = snmpa_mib_data_ets | snmpa_mib_data_dets | sn‐
270         mpa_mib_data_mnesia | module():
271           Defines  the mib storage module of the SNMP agent as defined by the
272           snmpa_mib_storage behaviour.
273
274           Several entities (mib-server via the its data module and  the  sym‐
275           bolic-store)  of  the  snmp agent uses this for storage of miscela‐
276           neous mib related data retrieved while loading a mib.
277
278           There are several implementations  provided  with  the  agent:  sn‐
279           mpa_mib_storage_ets,   snmpa_mib_storage_dets  and  snmpa_mib_stor‐
280           age_mnesia.
281
282           Default module is snmpa_mib_storage_ets.
283
284         mib_storage_options() = list() <optional>:
285           This is implementattion depended. That is, it depends on  the  mod‐
286           ule.  For  each module a specific set of options are valid. For the
287           module provided with the app, these options are supported:
288
289           * snmpa_mib_storage_ets:  {dir,  filename()}  |  {action,  keep   |
290             clear}, {checksum, boolean()}
291
292             * dir  -  If present, points to a directory where a file to which
293               all data in the ets table is "synced".
294
295               Also, when a table is opened this file is read, if it exists.
296
297               By default, this will not be used.
298
299             * action - Specifies the  behaviour  when  a  non-empty  file  is
300               found: Keep its content or clear it out.
301
302               Default is keep.
303
304             * checksum - Defines if the file is checksummed or not.
305
306               Default is false.
307
308           * snmpa_mib_storage_dets:  {dir,  filename()}  |  {action,  keep  |
309             clear}, {auto_save, default | pos_integer()} | {repair,  force  |
310             boolean()}
311
312             * dir  -  This  mandatory  option  points to a directory where to
313               place the file of a dets table.
314
315             * action - Specifies the  behaviour  when  a  non-empty  file  is
316               found: Keep its content or clear it out.
317
318               Default is keep.
319
320             * auto_save - Defines the dets auto-save frequency.
321
322               Default is default.
323
324             * repair - Defines the dets repair behaviour.
325
326               Default is false.
327
328           * snmpa_mib_storage_mnesia:   {action,   keep   |  clear},  {nodes,
329             [node()]}
330
331             * action - Specifies the behaviour when a non-empty, already  ex‐
332               isting, table: Keep its content or clear it out.
333
334               Default is keep.
335
336             * nodes  -  A list of node names (or an atom describing a list of
337               nodes) defining where to open the table. Its up to the user  to
338               ensure that mnesia is actually running on the specified nodes.
339
340               The following distinct values are recognised:
341
342               * [] - Translated into a list of the own node: [node()]
343
344               * all - erlang:nodes()
345
346               * visible - erlang:nodes(visible)
347
348               * connected - erlang:nodes(connected)
349
350               * db_nodes - mnesia:system_info(db_nodes)
351
352               Default is the result of the call: erlang:nodes().
353
354         mib_server() = [mib_server_opt()] <optional>:
355           mib_server_opt()   =   {mibentry_override,  mibentry_override()}  |
356           {trapentry_override,  trapentry_override()}  |   {verbosity,   ver‐
357           bosity()}     |     {cache,     mibs_cache()}    |    {data_module,
358           mib_server_data_module()}
359
360           Defines options specific for the SNMP agent mib server.
361
362           For defaults see the options in mib_server_opt().
363
364         mibentry_override() = bool() <optional>:
365           If this value is false, then when loading a mib each mib- entry  is
366           checked  prior to installation of the mib. The purpose of the check
367           is to prevent that the same symbolic mibentry name is used for dif‐
368           ferent oid's.
369
370           Default is false.
371
372         trapentry_override() = bool() <optional>:
373           If  this  value  is  false,  then  when  loading a mib each trap is
374           checked prior to installation of the mib. The purpose of the  check
375           is  to prevent that the same symbolic trap name is used for differ‐
376           ent trap's.
377
378           Default is false.
379
380         mib_server_data_module() = snmpa_mib_data_tttn | module() <optional>:
381           Defines the backend data module of the SNMP agent mib-server as de‐
382           fined by the snmpa_mib_data behaviour.
383
384           At  present only the default module is provided with the agent, sn‐
385           mpa_mib_data_tttn.
386
387           Default module is snmpa_mib_data_tttn.
388
389         mibs_cache() = bool() | mibs_cache_opts() <optional>:
390           Shall the agent utilize the mib server lookup cache or not.
391
392           Default is true (in which case the mibs_cache_opts() default values
393           apply).
394
395         mibs_cache_opts() = [mibs_cache_opt()] <optional>:
396           mibs_cache_opt()   =   {autogc,  mibs_cache_autogc()}  |  {gclimit,
397           mibs_cache_gclimit()} | {age, mibs_cache_age()}
398
399           Defines options specific for the SNMP agent mib server cache.
400
401           For defaults see the options in mibs_cache_opt().
402
403         mibs_cache_autogc() = bool() <optional>:
404           Defines if the mib server shall perform cache gc  automatically  or
405           leave it to the user (see gc_mibs_cache/0,1,2,3).
406
407           Default is true.
408
409         mibs_cache_age() = integer() > 0 <optional>:
410           Defines  how old the entries in the cache will be allowed to become
411           before they are GC'ed (assuming GC is performed). Each entry in the
412           cache is "touched" whenever it is accessed.
413
414           The age is defined in milliseconds.
415
416           Default is 10 timutes.
417
418         mibs_cache_gclimit() = infinity | integer() > 0 <optional>:
419           When  performing a GC, this is the max number of cache entries that
420           will be deleted from the cache.
421
422           The reason why its possible to set a limit, is that if the cache is
423           large,  the  GC  can potentially take a long time, during which the
424           agent is "busy". But on a heavily loaded system, we also  risk  not
425           removing  enough  elements in the cache, instead causing it to grow
426           over time. This is the reason the default value is infinity,  which
427           will ensure that all candidates are removed as soon as possible.
428
429           Default is infinity.
430
431         error_report_mod() = atom() <optional>:
432           Defines an error report module, implementing the snmpa_error_report
433           behaviour. Two modules are provided  with  the  toolkit:  snmpa_er‐
434           ror_logger and snmpa_error_io.
435
436           Default is snmpa_error_logger.
437
438         symbolic_store() = [symbolic_store_opt()]:
439           symbolic_store_opt() = {verbosity, verbosity()}
440
441           Defines options specific for the SNMP agent symbolic store.
442
443           For defaults see the options in symbolic_store_opt().
444
445         target_cache() = [target_cache_opt()]:
446           target_cache_opt() = {verbosity, verbosity()}
447
448           Defines options specific for the SNMP agent target cache.
449
450           For defaults see the options in target_cache_opt().
451
452         agent_config() = [agent_config_opt()] <mandatory>:
453           agent_config_opt()   =  {dir,  agent_config_dir()}  |  {force_load,
454           force_load()} | {verbosity, verbosity()}
455
456           Defines specific config related options for the SNMP agent.
457
458           For defaults see the options in agent_config_opt().
459
460         agent_config_dir = dir() <mandatory>:
461           Defines where the SNMP agent configuration files are stored.
462
463         force_load() = bool() <optional>:
464           If true the configuration files are re-read  during  start-up,  and
465           the  contents of the configuration database ignored. Thus, if true,
466           changes to the configuration database are lost upon reboot  of  the
467           agent.
468
469           Default is false.
470
471       Manager specific config options and types:
472
473         server() = [server_opt()] <optional>:
474           server_opt()  =  {timeout,  server_timeout()}  |  {verbosity,  ver‐
475           bosity()} | {cbproxy, server_cbproxy()} | {netif_sup, server_nis()}
476
477           Specifies the options for the manager server process.
478
479           Default is silence.
480
481         server_timeout() = integer() <optional>:
482           Asynchronous request cleanup time. For every requests, some info is
483           stored  internally,  in order to be able to deliver the reply (when
484           it arrives) to the proper destination. If the reply  arrives,  this
485           info  will be deleted. But if there is no reply (in time), the info
486           has to be deleted after the best before time has been passed.  This
487           cleanup  will  be  performed  at  regular intervals, defined by the
488           server_timeout() time. The information will  have  an  best  before
489           time,  defined  by  the  Expire time given when calling the request
490           function (see async_get, async_get_next and async_set).
491
492           Time in milli-seconds.
493
494           Default is 30000.
495
496         server_cbproxy() = temporary (default) | permanent <optional>:
497           This option specifies how the server will handle callback calls.
498
499           temporary (default):
500             A temporary process will be created for each callback call.
501
502           permanent:
503             With this the server will create a permanent (named) process that
504             in effect serializes all callback calls.
505
506           Default is temporary.
507
508         server_nis() = none (default) | {PingTO, PongTO} <optional>:
509           This  option  specifies if the server should actively supervise the
510           net-if process. Note that this will only work if  the  used  net-if
511           process actually supports the protocol. See snmpm_network_interface
512           behaviour for more info.
513
514           none (default):
515             No active supervision of the net-if process.
516
517           {PingTO :: pos_integer(), PongTO :: pos_integer()}:
518             The PingTO time specifies  the  between  a  successful  ping  (or
519             start) and the time when a ping message is to be sent to the net-
520             if process (basically the time between ping).
521
522             The PongTO time specifies how long time the net-if process has to
523             respond to a ping message, with a pong message. Its starts count‐
524             ing when the ping message has been sent.
525
526             Both times are in milli seconds.
527
528           Default is none.
529
530         manager_config() = [manager_config_opt()] <mandatory>:
531           manager_config_opt() = {dir, manager_config_dir()} | {db_dir,  man‐
532           ager_db_dir()}  |  {db_init_error, db_init_error()} | {repair, man‐
533           ager_repair()} |  {auto_save,  manager_auto_save()}  |  {verbosity,
534           verbosity()}
535
536           Defines specific config related options for the SNMP manager.
537
538           For defaults see the options in manager_config_opt().
539
540         manager_config_dir = dir() <mandatory>:
541           Defines where the SNMP manager configuration files are stored.
542
543         manager_db_dir = dir() <mandatory>:
544           Defines where the SNMP manager store persistent data.
545
546         manager_repair() = false | true | force <optional>:
547           Defines  the  repair option for the persistent database (if and how
548           the table is repaired when opened).
549
550           Default is true.
551
552         manager_auto_save() = integer() | infinity <optional>:
553           The auto save interval. The table is flushed to disk  whenever  not
554           accessed for this amount of time.
555
556           Default is 5000.
557
558         manager_irb() = auto | user | {user, integer()} <optional>:
559           This  option defines how the manager will handle the sending of re‐
560           sponse (acknowledgment) to received inform-requests.
561
562           * auto - The manager will autonomously send  response  (acknowledg‐
563             ment> to inform-request messages.
564
565           * {user,  integer()}  - The manager will send response (acknowledg‐
566             ment) to inform-request messages when the handle_inform  function
567             completes.  The  integer  is the time, in milli-seconds, that the
568             manager will consider the stored inform-request info valid.
569
570           * user - Same as {user, integer()}, except that the  default  time,
571             15 seconds (15000), is used.
572
573           See  snmpm_network_interface,  handle_inform  and definition of the
574           manager net if for more info.
575
576           Default is auto.
577
578         manager_mibs() = [string()] <optional>:
579           Specifies a list of MIBs (including path) and  defines  which  MIBs
580           are initially loaded into the SNMP manager.
581
582           Default is [].
583
584         manager_net_if() = [manager_net_if_opt()] <optional>:
585           manager_net_if_opt()  =  {module,  manager_net_if_module()} | {ver‐
586           bosity, verbosity()} | {options, manager_net_if_options()}
587
588           Defines options specific for the SNMP manager network interface en‐
589           tity.
590
591           For defaults see the options in manager_net_if_opt().
592
593         manager_net_if_options() = [manager_net_if_option()] <optional>:
594           manager_net_if_option() = {bind_to, bind_to()} | {sndbuf, sndbuf()}
595           | {recbuf, recbuf()}  |  {no_reuse,  no_reuse()}  |  {filter,  man‐
596           ager_net_if_filter_options()}  | {extra_sock_opts, extra_socket_op‐
597           tions()} | {inet_backend, inet | socket}
598
599           These options are actually specific to the used  module.  The  ones
600           shown here are applicable to the default manager_net_if_module().
601
602           For defaults see the options in manager_net_if_option().
603
604         manager_net_if_module() = atom() <optional>:
605           The  module  which  handles the network interface part for the SNMP
606           manager. It must implement the snmpm_network_interface behaviour.
607
608           Default is snmpm_net_if.
609
610         manager_net_if_filter_options()  =   [manager_net_if_filter_option()]
611         <optional>:
612           manager_net_if_filter_option()   =   {module,   manager_net_if_fil‐
613           ter_module()}
614
615           These options are actually specific to the used  module.  The  ones
616           shown here are applicable to the default manager_net_if_filter_mod‐
617           ule().
618
619           For defaults see the options in manager_net_if_filter_option().
620
621         manager_net_if_filter_module() = atom() <optional>:
622           Module which handles the network interface filter part for the SNMP
623           manager.  Must  implement the snmpm_network_interface_filter behav‐
624           iour.
625
626           Default is snmpm_net_if_filter.
627
628         def_user_module() = atom() <optional>:
629           The module implementing the default user. See the snmpm_user behav‐
630           iour.
631
632           Default is snmpm_user_default.
633
634         def_user_data() = term() <optional>:
635           Data  for  the default user. Passed to the user module when calling
636           the callback functions.
637
638           Default is undefined.
639
640       Common config types:
641
642         restart_type() = permanent | transient | temporary:
643           See supervisor documentation for more info.
644
645           Default is permanent for the agent and transient for the manager.
646
647         db_init_error() = terminate | create | create_db_and_dir:
648           Defines what to do if the agent or manager is unable to open an ex‐
649           isting  database  file. terminate means that the agent/manager will
650           terminate and create means that the agent/manager will  remove  the
651           faulty  file(s)  and  create  new ones, and create_db_and_dir means
652           that the agent/manager will create the database file along with any
653           missing parent directories for the database file.
654
655           Default is terminate.
656
657         priority() = atom() <optional>:
658           Defines the Erlang priority for all SNMP processes.
659
660           Default is normal.
661
662         versions() = [version()] <optional>:
663           version() = v1 | v2 | v3
664
665           Which SNMP versions shall be accepted/used.
666
667           Default is [v1,v2,v3].
668
669         verbosity() = silence | info | log | debug | trace <optional>:
670           Verbosity for a SNMP process. This specifies now much debug info is
671           printed.
672
673           Default is silence.
674
675         bind_to() = bool() <optional>:
676           If true, net_if binds to the IP address. If false,  net_if  listens
677           on any IP address on the host where it is running.
678
679           Default is false.
680
681         no_reuse() = bool() <optional>:
682           If  true,  net_if  does  not  specify  that the IP and port address
683           should be reusable. If false, the address is set to reusable.
684
685           Default is false.
686
687         recbuf() = integer() <optional>:
688           Receive buffer size.
689
690           Default value is defined by gen_udp.
691
692         sndbuf() = integer() <optional>:
693           Send buffer size.
694
695           Default value is defined by gen_udp.
696
697         extra_socket_options() = list() <optional>:
698           A list of arbitrary socket options.
699
700           This list is not inspected by snmp (other then checking that its  a
701           list).  Its the users responsibility to ensure that these are valid
702           options and does not conflict with the "normal" options.
703
704           Default is [].
705
706         note_store() = [note_store_opt()] <optional>:
707           note_store_opt() = {timeout,  note_store_timeout()}  |  {verbosity,
708           verbosity()}
709
710           Specifies the start-up verbosity for the SNMP note store.
711
712           For defaults see the options in note_store_opt().
713
714         note_store_timeout() = integer() <optional>:
715           Note cleanup time. When storing a note in the note store, each note
716           is given lifetime. Every timeout the note_store process performs  a
717           GC to remove the expired note's. Time in milli-seconds.
718
719           Default is 30000.
720
721         audit_trail_log() = [audit_trail_log_opt()] <optional>:
722           audit_trail_log_opt()  =  {type,  atl_type()}  | {dir, atl_dir()} |
723           {size, atl_size()} | {repair, atl_repair()} | {seqno, atl_seqno()}
724
725           If present, this option specifies the options for the  audit  trail
726           logging.  The  disk_log  module  is used to maintain a wrap log. If
727           present, the dir and size options are mandatory.
728
729           If not present, audit trail logging is not used.
730
731         atl_type() = read | write | read_write <optional>:
732           Specifies what type of an audit trail log should be used.  The  ef‐
733           fect  of  the  type is actually different for the the agent and the
734           manager.
735
736           For the agent:
737
738           * If write is specified, only set requests are logged.
739
740           * If read is specified, only get requests are logged.
741
742           * If read_write, all requests are logged.
743
744           For the manager:
745
746           * If write is specified, only sent messages are logged.
747
748           * If read is specified, only received messages are logged.
749
750           * If read_write, both outgoing and incoming messages are logged.
751
752           Default is read_write.
753
754         atl_dir = dir() <mandatory>:
755           Specifies where the audit trail log should be stored.
756
757           If audit_trail_log specifies that logging should take  place,  this
758           parameter must be defined.
759
760         atl_size() = {integer(), integer()} <mandatory>:
761           Specifies  the  size of the audit trail log. This parameter is sent
762           to disk_log.
763
764           If audit_trail_log specifies that logging should take  place,  this
765           parameter must be defined.
766
767         atl_repair() = true | false | truncate | snmp_repair <optional>:
768           Specifies  if  and  how  the audit trail log shall be repaired when
769           opened. Unless this parameter has the value snmp_repair it is  sent
770           to  disk_log. If, on the other hand, the value is snmp_repair, snmp
771           attempts to handle certain faults on its own. And even if it cannot
772           repair  the  file,  it  does  not truncate it directly, but instead
773           moves it aside for later off-line analysis.
774
775           Default is true.
776
777         atl_seqno() = true | false <optional>:
778           Specifies if the audit trail log entries will  be  (sequence)  num‐
779           bered  or  not.  The range of the sequence numbers are according to
780           RFC 5424, i.e. 1 through 2147483647.
781
782           Default is false.
783

SEE ALSO

785       application(3), disk_log(3)
786
787
788
789Ericsson AB                       snmp 5.10.1                          SNMP(7)
Impressum