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

NAME

6       snmp_community_mib - Instrumentation Functions for SNMP-COMMUNITY-MIB
7

DESCRIPTION

9       The  module snmp_community_mib implements the instrumentation functions
10       for the SNMP-COMMUNITY-MIB, and functions for configuring the database.
11
12       The configuration files are described in the SNMP User's Manual.
13

EXPORTS

15       configure(ConfDir) -> void()
16
17              Types:
18
19                 ConfDir = string()
20
21              This function is called from the supervisor at system start-up.
22
23              Inserts all data in the configuration files  into  the  database
24              and  destroys  all  old rows with StorageType volatile. The rows
25              created from the configuration file will have  StorageType  non‐
26              Volatile.
27
28              All snmp counters are set to zero.
29
30              If  an  error is found in the configuration file, it is reported
31              using the function config_err/2 of the error, report module  and
32              the function fails with reason configuration_error.
33
34              ConfDir is a string which points to the directory where the con‐
35              figuration files are found.
36
37              The configuration file read is: community.conf.
38
39       reconfigure(ConfDir) -> void()
40
41              Types:
42
43                 ConfDir = string()
44
45              Inserts all data in the configuration files  into  the  database
46              and  destroys  all old data, including the rows with StorageType
47              nonVolatile. The rows created from the configuration  file  will
48              have StorageType nonVolatile.
49
50              Thus,  the  data  in the SNMP-COMMUNITY-MIB, after this function
51              has been called, is from the configuration files.
52
53              All snmp counters are set to zero.
54
55              If an error is found in the configuration file, it  is  reported
56              using  the function config_err/2 of the error report module, and
57              the function fails with reason configuration_error.
58
59              ConfDir is a string which points to the directory where the con‐
60              figuration files are found.
61
62              The configuration file read is: community.conf.
63
64       add_community(Idx, CommName, SecName, CtxName, TransportTag) -> Ret
65       add_community(Idx,  CommName, SecName, EngineId, CtxName, TransportTag)
66       -> Ret
67
68              Types:
69
70                 Idx = string()
71                 CommName = string()
72                 SecName = string()
73                 EngineId = string()
74                 CtxName = string()
75                 TransportTag = string()
76                 Ret = {ok, Key} | {error, Reason}
77                 Key = term()
78                 Reason = term()
79
80              Adds a community to the agent config. Equivalent to one line  in
81              the community.conf file.
82
83              With  the  EngineId argument it is possible to override the con‐
84              figured engine-id (SNMP-FRAMEWORK-MIB).
85
86       delete_community(Key) -> Ret
87
88              Types:
89
90                 Key = term()
91                 Ret = ok | {error, Reason}
92                 Reason = term()
93
94              Delete a community from the agent config.
95
96
97
98Ericsson AB                       snmp 5.4.3             snmp_community_mib(3)
Impressum