snmpa_conf(3)

📦

version 29.0.6 · 3 versions

🌸 snmpa_conf(3) — Erlang Module Definition 🌸

okay so this is the manual page for snmpa_conf, bestie, and it's literally the glow-up toolkit for your SNMP agent's config files. Erlang module, group-chat energy, let's go. ✨

💖 NAME 💖

snmpa_conf — utility functions for handling the agent config files. that's it, that's the vibe. 🎀

🦋 DESCRIPTION 🦋

so the module snmpa_conf is where all the little helper functions live — the ones you use to manipulate the config files of the SNMP agent. and by "manipulate" we mean write, read, and append. no cap. 💅

✨ DATA TYPES ✨

ngl this section is giving "the lore drop" but it's important so stay with me. 🫶

-opaque agent_entry() — an opaque term that represents an entry in the 'agent' config.
-opaque community_entry() — an opaque term that represents an entry in the 'community' (agent) config.
-opaque context_entry() — an opaque term that represents an entry in the 'context' (agent) config.

extended_transport_address() is defined as:

extended_transport_address() :: {inet:ip_address(), port_info()}.

intAgentTransport() is defined as:

intAgentTransport() ::
          {transportDomain(), transport_address()} |
          {transportDomain(),
           extended_transport_address(),
           snmpa:transport_kind()} |
          {transportDomain(),
           extended_transport_address(),
           transport_opts()} |
          {transportDomain(),
           extended_transport_address(),
           snmpa:transport_kind(),
           transport_opts()}.

ip_address() is defined as:

ip_address() :: inet:ip_address() | snmp_ip_address().

-opaque notify_entry() — an opaque term that represents an entry in the 'notify' (agent) config.

port_info() is defined as:

port_info() :: inet:port_number() | system | range() | ranges().

⚠️ heads up bestie: port number 0 (zero) can't be specified directly — it's used internally ✋ — so don't even try it. instead you use the atom 'system'. periodt. 💀

range() is defined as:

range() :: {Min :: inet:port_number(), Max :: inet:port_number()}.

and the rule is Min < Max. 🎀

ranges() is defined as:

ranges() :: [inet:port_number() | range()].

snmp_ip_address() is defined as:

snmp_ip_address() :: [non_neg_integer()].

-opaque standard_entry() — an opaque term that represents an entry in the 'standard' (agent) config.
-opaque target_addr_entry() — an opaque term that represents an entry in the 'target address' (agent) config.
-opaque target_params_entry() — an opaque term that represents an entry in the 'target parameters' (agent) config.

transportAddress() is defined as:

transportAddress() ::
          transportAddressIPv4() | transportAddressIPv6().

transportAddressIPv4() is defined as:

transportAddressIPv4() ::
          transportAddressIPv4WithPort() |
          transportAddressIPv4WithoutPort().

transportAddressIPv4WithPort() is defined as:

transportAddressIPv4WithPort() ::
          {transportAddressIPv4WithoutPort(), inet:port_number()} |
          [byte()].

okay so the Erlang type language has limitations, bestie 😭 — we literally cannot define this type in full detail. so instead, here's the description. the list variant is 4 bytes for address + 2 bytes for port:

[byte() x 4, byte() x 2]

transportAddressIPv4WithoutPort() is defined as:

transportAddressIPv4WithoutPort() :: inet:ip4_address() | [byte()].

again, Erlang type language limitations, we can't spell it out — so here's the description. the list variant is 4 bytes for address:

[byte() x 4]

transportAddressIPv6() is defined as:

transportAddressIPv6() ::
          transportAddressIPv6WithPort() |
          transportAddressIPv6WithoutPort().

transportAddressIPv6WithPort() is defined as:

transportAddressIPv6WithPort() ::
          {transportAddressIPv6WithoutPort(), inet:port_number()} |
          [word() | inet:port_number()] |
          [word() | byte()] |
          [byte()].

and you guessed it — Erlang type language limitations, so description time. ✨

First list variant: 8 words for address + 1 word for port:

[word() x 8, inet:port_number()]

Second list variant: 8 words for address + 2 bytes for port:

[word() x 8, byte() x 2]

Third list variant: 16 bytes for address + 2 bytes for port:

[byte() x 16, byte() x 2]

transportAddressIPv6WithoutPort() is defined as:

transportAddressIPv6WithoutPort() ::
          inet:ip6_address() | [word()] | [byte()].

once more for the people in the back — Erlang type language limitations, so:

First list variant: 8 words for address:

[word() x 8]

Second list variant: 16 bytes for address:

[byte() x 16]

transportAddressMask() is defined as:

transportAddressMask() :: [] | transportAddressWithPort().

transportAddressWithPort() is defined as:

transportAddressWithPort() ::
          transportAddressIPv4WithPort() |
          transportAddressIPv6WithPort().

transportAddressWithoutPort() is defined as:

transportAddressWithoutPort() ::
          transportAddressIPv4WithoutPort() |
          transportAddressIPv6WithoutPort().

transportDomain() is defined as:

transportDomain() :: snmp:tdomain().

transport_address() is defined as:

transport_address() ::
          {ip_address(), inet:port_number()} | ip_address().

transport_opts() is defined as:

transport_opts() :: list().

-opaque usm_entry() — an opaque term that represents an entry in the 'user based sm' (agent) config.
-opaque vacm_acc_entry() — an opaque term that represents an (access) entry in the 'vacm access' (agent) config.

vacm_entry() is defined as:

vacm_entry() ::
          vacm_s2g_entry() | vacm_acc_entry() | vacm_vtf_entry().

basically an opaque term (well, basically opaque) that represents an entry in the 'view based acm' (agent) config. 💅

-opaque vacm_s2g_entry() — an opaque term that represents a (security to group) entry in the 'vacm security to group' (agent) config.
-opaque vacm_vtf_entry() — an opaque term that represents a (tree family) entry in the 'vacm tree family' (agent) config.

word() is defined as:

word() :: 0..65535.

🔥 FUNCTIONS 🔥

the main characters. let's meet them. 👑

🎀 `agent_entry(Tag, Val) -> AgentEntry`

agent_entry(Tag, Val) -> AgentEntry
                     when
                         Tag ::
                             intAgentTransports | intAgentUDPPort |
                             snmpEngineMaxMessageSize | snmpEngineID,
                         Val :: term(),
                         AgentEntry :: agent_entry().

creates an entry for the agent config file, agent.conf. 🫶

the type of Val depends on the value of Tag, so pay attention bestie:

intAgentTransports: [snmpa_conf:intAgentTransport()] <mandatory>
intAgentUDPPort: inet:port_number() <optional>
snmpEngineMaxMessageSize: snmp_framework_mib:max_message_size() <mandatory>
snmpEngineID: snmp_framework_mib:engine_id() <mandatory>

see Agent Information for more info. ✨