.TH snmp_community_mib 3erl "snmp 5.13.5" "Ericsson AB" "Erlang Module Definition"
.SH NAME
snmp_community_mib \- Instrumentation Functions for SNMP-COMMUNITY-MIB
.SH DESCRIPTION
.LP
The module \fIsnmp_community_mib\fR\& implements the instrumentation functions for the SNMP-COMMUNITY-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
.LP
Types:

.RS 3
ConfDir = string()
.br
.RE
.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 reason \fIconfiguration_error\fR\&\&.
.LP
\fIConfDir\fR\& is a string which points to the directory where the configuration files are found\&.
.LP
The configuration file read is: \fIcommunity\&.conf\fR\&\&.
.RE

.LP
.B
reconfigure(ConfDir) -> void()
.br
.RS
.LP
Types:

.RS 3
ConfDir = string()
.br
.RE
.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-COMMUNITY-MIB, after this function has been called, is 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 error report module, and the function fails with reason \fIconfiguration_error\fR\&\&.
.LP
\fIConfDir\fR\& is a string which points to the directory where the configuration files are found\&.
.LP
The configuration file read is: \fIcommunity\&.conf\fR\&\&.
.RE

.LP
.B
add_community(Idx, CommName, SecName, CtxName, TransportTag) -> Ret
.br
.B
add_community(Idx, CommName, SecName, EngineId, CtxName, TransportTag) -> Ret
.br
.RS
.LP
Types:

.RS 3
Idx = string()
.br
CommName = string()
.br
SecName = string()
.br
EngineId = string()
.br
CtxName = string()
.br
TransportTag = string()
.br
Ret = {ok, Key} | {error, Reason}
.br
Key = term()
.br
Reason = term()
.br
.RE
.RE
.RS
.LP
Adds a community to the agent config\&. Equivalent to one line in the \fIcommunity\&.conf\fR\& file\&.
.LP
With the \fIEngineId\fR\& argument it is possible to override the configured engine-id (SNMP-FRAMEWORK-MIB)\&.
.RE

.LP
.B
delete_community(Key) -> Ret
.br
.RS
.LP
Types:

.RS 3
Key = term()
.br
Ret = ok | {error, Reason}
.br
Reason = term()
.br
.RE
.RE
.RS
.LP
Delete a community from the agent config\&.
.RE