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

NAME

6       snmp_view_based_acm_mib  -  Instrumentation  Functions  for  SNMP-VIEW-
7       BASED-ACM-MIB
8

DESCRIPTION

10       The module snmp_view_based_acm_mib implements the instrumentation func‐
11       tions  for  the  SNMP-VIEW-BASED-ACM-MIB, and functions for configuring
12       the database.
13
14       The configuration files are described in the SNMP User's Manual.
15

EXPORTS

17       configure(ConfDir) -> void()
18
19              Types:
20
21                 ConfDir = string()
22
23              This function is called from the supervisor at system start-up.
24
25              Inserts all data in the configuration files  into  the  database
26              and  destroys  all  old rows with StorageType volatile. The rows
27              created from the configuration file will have  StorageType  non‐
28              Volatile.
29
30              All snmp counters are set to zero.
31
32              If  an  error is found in the configuration file, it is reported
33              using the function config_err/2 of the error report module,  and
34              the function fails with the reason configuration_error.
35
36              ConfDir is a string which points to the directory where the con‐
37              figuration files are found.
38
39              The configuration file read is: vacm.conf.
40
41       reconfigure(ConfDir) -> void()
42
43              Types:
44
45                 ConfDir = string()
46
47              Inserts all data in the configuration files  into  the  database
48              and  destroys  all old data, including the rows with StorageType
49              nonVolatile. The rows created from the configuration  file  will
50              have StorageType nonVolatile.
51
52              Thus,  the data in the SNMP-VIEW-BASED-ACM-MIB, after this func‐
53              tion has been called, is the data from the configuration files.
54
55              All snmp counters are set to zero.
56
57              If an error is found in the configuration file, it  is  reported
58              using  the function config_err/2 of the error report module, and
59              the function fails with the reason configuration_error.
60
61              ConfDir is a string which points to the directory where the con‐
62              figuration files are found.
63
64              The configuration file read is: vacm.conf.
65
66       add_sec2group(SecModel, SecName, GroupName) -> Ret
67
68              Types:
69
70                 SecModel = v1 | v2c | usm
71                 SecName = string()
72                 GroupName = string()
73                 Ret = {ok, Key} | {error, Reason}
74                 Key = term()
75                 Reason = term()
76
77              Adds a security to group definition to the agent config. Equiva‐
78              lent to one vacmSecurityToGroup-line in the vacm.conf file.
79
80       delete_sec2group(Key) -> Ret
81
82              Types:
83
84                 Key = term()
85                 Ret = ok | {error, Reason}
86                 Reason = term()
87
88              Delete a security to group definition from the agent config.
89
90       add_access(GroupName, Prefix, SecModel, SecLevel, Match, RV, WV, NV) ->
91       Ret
92
93              Types:
94
95                 GroupName = string()
96                 Prefix = string()
97                 SecModel = v1 | v2c | usm
98                 SecLevel = string()
99                 Match = prefix | exact
100                 RV = string()
101                 WV = string()
102                 NV = string()
103                 Ret = {ok, Key} | {error, Reason}
104                 Key = term()
105                 Reason = term()
106
107              Adds  a access definition to the agent config. Equivalent to one
108              vacmAccess-line in the vacm.conf file.
109
110       delete_access(Key) -> Ret
111
112              Types:
113
114                 Key = term()
115                 Ret = ok | {error, Reason}
116                 Reason = term()
117
118              Delete a access definition from the agent config.
119
120       add_view_tree_fam(ViewIndex, SubTree, Status, Mask) -> Ret
121
122              Types:
123
124                 ViewIndex = integer()
125                 SubTree = oid()
126                 Status = included | excluded
127                 Mask = null | [integer()], where all values are either 0 or 1
128                 Ret = {ok, Key} | {error, Reason}
129                 Key = term()
130                 Reason = term()
131
132              Adds a view tree family definition to the agent config.  Equiva‐
133              lent to one vacmViewTreeFamily-line in the vacm.conf file.
134
135       delete_view_tree_fam(Key) -> Ret
136
137              Types:
138
139                 Key = term()
140                 Ret = ok | {error, Reason}
141                 Reason = term()
142
143              Delete a view tree family definition from the agent config.
144
145
146
147Ericsson AB                       snmp 5.4.3        snmp_view_based_acm_mib(3)