---
name: "snmp_community_mib"
section: "3erl"
platform: "linux"
package: "erlang-manpages"
version: "1:25.2.3+dfsg-1+deb12u4"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/snmp_community_mib"
---

# snmp\_community\_mib(3erl)

Instrumentation Functions for SNMP-COMMUNITY-MIB

## NAME

snmp\_community\_mib - Instrumentation Functions for SNMP-COMMUNITY-MIB

## DESCRIPTION

The module *snmp\_community\_mib* implements the instrumentation functions for the SNMP-COMMUNITY-MIB, and functions for configuring the database.

The configuration files are described in the SNMP User's Manual.

## EXPORTS

**configure(ConfDir) -\> void()**\

Types:

ConfDir = string()\

This function is called from the supervisor at system start-up.

Inserts all data in the configuration files into the database and destroys all old rows with StorageType *volatile*. The rows created from the configuration file will have StorageType *nonVolatile*.

All *snmp* counters are set to zero.

If an error is found in the configuration file, it is reported using the function *config\_err/2* of the error, report module and the function fails with reason *configuration\_error*.

*ConfDir* is a string which points to the directory where the configuration files are found.

The configuration file read is: *community.conf*.

**reconfigure(ConfDir) -\> void()**\

Types:

ConfDir = string()\

Inserts all data in the configuration files into the database and destroys all old data, including the rows with StorageType *nonVolatile*. The rows created from the configuration file will have StorageType *nonVolatile*.

Thus, the data in the SNMP-COMMUNITY-MIB, after this function has been called, is from the configuration files.

All *snmp* counters are set to zero.

If an error is found in the configuration file, it is reported using the function *config\_err/2* of the error report module, and the function fails with reason *configuration\_error*.

*ConfDir* is a string which points to the directory where the configuration files are found.

The configuration file read is: *community.conf*.

**add\_community(Idx, CommName, SecName, CtxName, TransportTag) -\> Ret**\
 **add\_community(Idx, CommName, SecName, EngineId, CtxName, TransportTag) -\> Ret**\

Types:

Idx = string()\
 CommName = string()\
 SecName = string()\
 EngineId = string()\
 CtxName = string()\
 TransportTag = string()\
 Ret = {ok, Key} \| {error, Reason}\
 Key = term()\
 Reason = term()\

Adds a community to the agent config. Equivalent to one line in the *community.conf* file.

With the *EngineId* argument it is possible to override the configured engine-id (SNMP-FRAMEWORK-MIB).

**delete\_community(Key) -\> Ret**\

Types:

Key = term()\
 Ret = ok \| {error, Reason}\
 Reason = term()\

Delete a community from the agent config.