snmp_community_mib(3erl)

💖 snmp_community_mib(3erl) — Erlang Module Definition 💖

okay bestie, welcome to the group chat for snmp_community_mib. This is an Erlang Module Definition, and it's giving "instrumentation functions with main character energy" ✨.

🌸 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, plus functions for configuring the database. No cap, that's the whole vibe.

The configuration files are described in the SNMP User's Manual — go read that if you need the lore 📚.

💅 EXPORTS 💅

okay so here's the export menu, bestie. Every function is iconic in its own way 🎀.

✨ configure(ConfDir) -> void()

Types 🧚

ConfDir = string()

This function is called from the supervisor at system start-up. Yes, the supervisor is the one sliding into the group chat first 💬.

It 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 — so they're keeping their receipts, periodt.

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. So if something's off, it's not quiet about it 😭.

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()

This one inserts all data in the configuration files into the database and destroys all old data, including the rows with StorageType nonVolatile. It's a full clean-slate moment, highkey dramatic 💀.

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. Your config files are the main characters now 👑.

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 — two signatures ✨

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 — like adding a whole personality to the config vibes.

With the EngineId argument it is possible to override the configured engine-id (SNMP-FRAMEWORK-MIB). Cute little override moment, iykyk.

✨ delete_community(Key) -> Ret

Types 🧚

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

Delete a community from the agent config. Bye bestie, slay your exit 👋.

---

💖 mwah 💖 — this page is brought to you by Ericsson AB, snmp 5.13.5, and the one and only snmp_community_mib(3erl). The footer doesn't show a date, so we're not inventing one — no cap, bestie 💅.